docs: pre-release documentation and metadata sweep - #110
Merged
Conversation
Correct the release-notes summary for the adapter usage docs changeset, which still listed the removed issuer option and would have told adopters to add and remove issuer in the same release. Fix the requireRole JSDoc example, which called requireAuth() with no arguments (does not compile, throws at construction), left its code fence unclosed, and carried a stray comment marker. In the README, align the Quick Start startup log with its listen port, add the resolveClientIp option to the createSeamlessAuthServer options block, and reference the real webAuthn/login/finish route in the end-to-end flow. Declare keywords on both packages for npm discoverability.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
A repo-wide documentation sweep against current
main(827b4ed) ahead of the release. An audit cross-checked every doc surface (both READMEs, root README, AGENTS/SECURITY/CONTRIBUTING, all JSDoc, pending changesets, and package.json metadata) against the actual code. The good news: the recent breaking changes (DELETE-only logout, POST OTP-generate,POST /magic-link, removal ofuser.suband theissueroption, the namedcreateSeamlessAuthServerexport, the(req, opts)getSeamlessUsersignature, and cookie security driven by options notNODE_ENV) are all already reflected correctly in the primary README. This PR fixes the exceptions.Fixes
Release-notes contradiction (the reason this matters most).
.changeset/adapter-usage-docs.mdstill claimed the Quick Start "passes every required option (cookieSecret,serviceSecret,issuer,audience)."issuerwas removed in a parallel PR whose changeset ships in the same release. Compiled notes would have told adopters to addissuer(this changeset) and delete it (the removal changeset) at once. Corrected toauthServerUrl, cookieSecret, serviceSecret, audience.requireRoleJSDoc would not compile.packages/express/src/middleware/requireRole.tshad@examplecode callingrequireAuth()with no arguments, which is a TS error and throws at construction (viaassertSecretStrength). This is the example surfaced on hover/IntelliSense. It also had a stray*and an unclosed ```ts fence that bled the example into the@paramdocs. Fixed to construct a guard and closed the fence.README corrections.
http://localhost:3000while callingapp.listen(5000, ...). Now both say 5000.createSeamlessAuthServeroptions block omittedresolveClientIp, a real supported option (documented in prose but missing from the canonical type listing). Added./auth/webAuthn/finish, which is not a route. Corrected to/auth/webAuthn/login/finish.Metadata. Neither published package declared
keywords. Added to both for npm discoverability.Not changed (deliberately)
SeamlessAuthUser.phoneis typedstringwhile the upstream/meshape andSeamlessUserusestring | null. The docs correctly mirror the code, so this is a code inconsistency, not a doc one. It is already tracked in chore: post-release follow-ups from the pre-release audit #101.requireAuth()references in the architecture diagram and flow prose name the function rather than demonstrate a call, so they are left as-is.Checks
No em dashes. Changeset included (patch, both packages).