feat: Add useAccessToken and useTokenClaims hooks #63
Conversation
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
nicknisi
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds new hooks to manage access tokens and extract token claims, while updating exports and type imports for better type management.
- Added useAccessToken for token management with automatic refresh and error handling.
- Added useTokenClaims to extract token claims in a type-safe manner.
- Updated index exports and refined type imports in state.ts.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/state.ts | Changed the import of the User type to a type-only import for improved dependency usage. |
| src/index.ts | Exported the new hooks useAccessToken and useTokenClaims. |
| src/accessToken.ts | Added new hooks for access token handling including refresh logic and token claims parsing. |
| package.json | Updated the @workos-inc/authkit-js dependency version to 0.12.0. |
cmatheson
requested changes
May 28, 2025
| * | ||
| * @returns An object containing the access token, loading state, error state, and a refresh function. | ||
| */ | ||
| export function useAccessToken() { |
There was a problem hiding this comment.
the traditional way to get claims in authkit-react is via the useAuth hook. i think we should just extend that to support custom claims instead of bolting on a new hook.
There was a problem hiding this comment.
So, I was looking to bring closer parity to authkit-nextjs, having the same hooks in workos/authkit-nextjs#258 plus having a cleaner separation of concerns.
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.
Note
This is dependent on workos/authkit-js#87.
This pull request introduces new functionality for managing access tokens with automatic refresh and token claims extraction, alongside minor improvements to type imports and exports. The most significant changes include the addition of the
useAccessTokenanduseTokenClaimshooks, updates to thesrc/index.tsexports, and a refinement in type usage for theUserinterface.New functionality for access tokens:
src/accessToken.ts: Added theuseAccessTokenhook to manage access tokens with automatic refresh and error handling. It includes a reducer for token state management and utility functions for token parsing and refresh logic.src/accessToken.ts: Added theuseTokenClaimshook to extract claims from access tokens, enabling developers to access custom claims in a type-safe manner.Updates to exports:
src/index.ts: Exported the newly addeduseAccessTokenanduseTokenClaimshooks to make them available for use in other parts of the application.Type improvements:
src/state.ts: Changed the import of theUsertype from a regular import to atypeimport for better type-only dependency management.