Repository navigation
Conversation
- Render type aliases declared as Infer<typeof validator> with the type TypeScript resolves, so result types such as SignInResult and TokenBundle list their fields instead of the unexported validator. - Export the UserCallbacks, CreateUserFn and OnSignInFn types from @convex-dev/auth/server, so the attachUserCallbacks docs link to them. - Export AuthClientConfigBase from @convex-dev/auth/browser and describe the mode and authApi fields in the AuthClientConfig TSDoc. - Remove the empty Customizing providers page, which was not in the sidebar but still showed up in llms-full.txt.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
This branch was successfully deployed
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.
Test agents found several holes in the generated API reference:
UserCallbackshad no page, though everyattachUserCallbackspoints to it. TypeDoc only documents exported types, andUserCallbacks,CreateUserFnandOnSignInFnwere not exported from any entry point.AuthClientConfigrendered asAuthClientConfigBase & object | AuthClientConfigBase & object, with none of its fields, becauseAuthClientConfigBasewas not exported.SignInResult,SignUpResult,ChangePasswordResultandTokenBundlerendered asInfer<typeof signInResult>. TypeDoc prints a type alias as written, and the validator isn't exported.llms-full.txt.Changes:
Infer<...>with@useDeclaredType, so TypeDoc renders the resolved type with its fields. This fixes all 59 such aliases at once and removes about 60 TypeDoc warnings.@convex-dev/auth/serverexports theUserCallbacks,CreateUserFnandOnSignInFntypes.@convex-dev/auth/browserexportsAuthClientConfigBase, and theAuthClientConfigTSDoc now names themodeandauthApifields and links to the shared ones. These are type-only exports of types that public signatures already use.bindProvider, which is internal, so there is nothing public to document yet.RefreshResultis handled separately (N-8).pnpm lint,pnpm typecheck,pnpm check:declarationsand the docs build pass.Tracking: Z-5 (Notion)