Skip to content

Document RefreshResult and export it - #765

Draft
Nicolapps wants to merge 1 commit into
rebootfrom
nicolas/refresh-result-docs
Draft

Nicolapps wants to merge 1 commit into
rebootfrom
nicolas/refresh-result-docs

Conversation

@Nicolapps

@Nicolapps Nicolapps commented Oct 21, 2026 •

Copy link
Copy Markdown
Member

RefreshResult appears in several public signatures (RefreshSessionFn, ServerAuthSession.refresh()), but no entry point exported it, so the API reference had no entry for it.

This exports the type from @convex-dev/auth and @convex-dev/auth/ssr, next to RefreshSessionFn, which was already exported. A TSDoc describes both outcomes:

  • { kind: "rotated", tokens }: store the new access token and refresh token.
  • { kind: "noSession" }: clear the stored session and treat the user as signed out.

RefreshSessionFn now links to it instead of to the unexported vRefreshResult.

Tracking: N-8 (Notion)

RefreshResult appears in several public signatures, but no entry point
exported it, thus the API reference had no entry for it. Export the type
from @convex-dev/auth and @convex-dev/auth/ssr, next to RefreshSessionFn,
with a TSDoc that describes both outcomes, and link RefreshSessionFn to it
instead of to the unexported vRefreshResult.
@vercel

vercel Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
auth-v2 Ready Ready Preview Oct 21, 2026 12:35am UTC
1 Skipped Deployment
Project Deployment Actions Updated
convex-auth-docs Ignored Ignored Oct 21, 2026 12:35am UTC

Request Review

Copy link
Copy Markdown
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 3 files

Re-trigger cubic

This branch was successfully deployed

1 active deployment
Preview – auth-v2 — fb194cab Deployed Oct 21, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant