feat(auth0-fastify): add Custom Token Exchange support#77
Conversation
Expose loginWithCustomTokenExchange and customTokenExchange on auth0Client via the upgraded auth0-server-js ServerClient. Re-export the associated option and result types so consumers have full type coverage without importing from the underlying package directly.
📝 WalkthroughWalkthroughThree new type names ( ChangesCustom Token Exchange types and tests
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@packages/auth0-fastify/src/index.ts`:
- Line 18: The export statement on line 18 attempts to re-export
LoginWithCustomTokenExchangeOptions, LoginWithCustomTokenExchangeResult, and
CustomTokenExchangeOptions from `@auth0/auth0-server-js`, but these types do not
exist in version 1.4.0, causing a TS2305 compilation error. Remove these three
non-existent type names from the export statement, keeping only DomainResolver
which is valid, or alternatively verify that the `@auth0/auth0-server-js`
dependency has been upgraded to a version that includes these types and update
the lockfile accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 0167da36-77cd-469b-a8e5-196cfbb38f93
📒 Files selected for processing (2)
packages/auth0-fastify/src/index.spec.tspackages/auth0-fastify/src/index.ts
|
|
||
| export * from './types.js'; | ||
| export type { DomainResolver } from '@auth0/auth0-server-js'; | ||
| export type { DomainResolver, LoginWithCustomTokenExchangeOptions, LoginWithCustomTokenExchangeResult, CustomTokenExchangeOptions } from '@auth0/auth0-server-js'; |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Check the current state of the file at line 18
cat -n packages/auth0-fastify/src/index.ts | head -30Repository: auth0/auth0-fastify
Length of output: 1685
🏁 Script executed:
# Check the package.json to see the dependency version
cat packages/auth0-fastify/package.json | grep -A 5 -B 5 "`@auth0/auth0-server-js`"Repository: auth0/auth0-fastify
Length of output: 323
🏁 Script executed:
# Search for LoginWithCustomTokenExchangeOptions in the codebase to understand usage
rg "LoginWithCustomTokenExchangeOptions" -n --type tsRepository: auth0/auth0-fastify
Length of output: 265
🏁 Script executed:
# Check if node_modules exists and explore the auth0-server-js package
if [ -d "node_modules/@auth0/auth0-server-js" ]; then
echo "=== Package exports from package.json ==="
cat node_modules/@auth0/auth0-server-js/package.json | grep -A 20 '"exports"'
echo ""
echo "=== Checking index.d.ts for type exports ==="
ls -la node_modules/@auth0/auth0-server-js/*.d.ts 2>/dev/null | head -5
echo ""
if [ -f "node_modules/@auth0/auth0-server-js/dist/index.d.ts" ]; then
grep -E "(LoginWithCustomTokenExchange|CustomTokenExchangeOptions)" node_modules/@auth0/auth0-server-js/dist/index.d.ts
fi
else
echo "node_modules not available, checking lockfile"
fiRepository: auth0/auth0-fastify
Length of output: 109
🏁 Script executed:
# Also check if there's a lockfile that pins the version
if [ -f "pnpm-lock.yaml" ]; then
echo "=== pnpm-lock.yaml version info ==="
grep -A 5 "`@auth0/auth0-server-js`" pnpm-lock.yaml | head -20
elif [ -f "package-lock.json" ]; then
echo "=== package-lock.json version info ==="
jq '.dependencies["`@auth0/auth0-server-js`"]' package-lock.json 2>/dev/null || grep -A 5 "`@auth0/auth0-server-js`" package-lock.json | head -10
elif [ -f "yarn.lock" ]; then
echo "=== yarn.lock version info ==="
grep -A 5 "`@auth0/auth0-server-js`" yarn.lock | head -10
fiRepository: auth0/auth0-fastify
Length of output: 45
🏁 Script executed:
# Search for where these types might be defined in the repo itself
rg "LoginWithCustomTokenExchangeOptions|LoginWithCustomTokenExchangeResult|CustomTokenExchangeOptions" --type ts -B 2 -A 2Repository: auth0/auth0-fastify
Length of output: 501
🏁 Script executed:
# Look for CI configuration that might show build errors
find . -name ".github" -o -name ".gitlab-ci.yml" -o -name ".circleci" 2>/dev/null | head -10Repository: auth0/auth0-fastify
Length of output: 73
🏁 Script executed:
# Check if there are any recent git commits or comments about this change
git log --oneline -n 20 -- packages/auth0-fastify/src/index.ts 2>/dev/null | head -20Repository: auth0/auth0-fastify
Length of output: 126
🏁 Script executed:
# Check the auth0-fastify-api package to see if it has similar structure
cat -n packages/auth0-fastify-api/src/index.ts 2>/dev/null | head -30Repository: auth0/auth0-fastify
Length of output: 953
🌐 Web query:
@auth0/auth0-server-js 1.4.0 exports LoginWithCustomTokenExchangeOptions
💡 Result:
The @auth0/auth0-server-js library (version 1.4.0) does not export a type or interface named LoginWithCustomTokenExchangeOptions. While a similarly named type, LoginWithCustomTokenExchangeOptions, exists in the auth0-server-python SDK [1][2], the @auth0/auth0-server-js package is a distinct library [3][4] designed for different runtime environments. Documentation and type definitions for @auth0/auth0-server-js [4][5] do not reference a LoginWithCustomTokenExchangeOptions export. For contexts requiring custom token exchange (RFC 8693) in JavaScript or TypeScript, developers typically use other Auth0 SDKs like @auth0/auth0-spa-js [6][7] or the Node.js Auth0 SDK [8], which contain relevant types and methods for custom token exchange. If you are working with @auth0/auth0-server-js, ensure you are using the appropriate methods for your intended authentication flow, as this SDK is primarily built as a low-level foundation for other framework-specific authentication libraries [5].
Citations:
- 1: https://github.com/auth0/auth0-server-python
- 2: https://github.com/auth0/auth0-server-python/blob/main/examples/CustomTokenExchange.md
- 3: https://registry.npmjs.org/@auth0/auth0-server-js
- 4: https://github.com/auth0/auth0-auth-js/tree/main/packages/auth0-server-js
- 5: https://github.com/auth0/auth0-auth-js/blob/main/packages/auth0-server-js/README.md
- 6: https://auth0.github.io/auth0-spa-js/classes/Auth0Client.html
- 7: https://auth0.github.io/auth0-spa-js/types/CustomTokenExchangeOptions.html
- 8: https://auth0.github.io/node-auth0/types/auth.SDK.CustomTokenExchangeOptions.html
🏁 Script executed:
# Check the recent commit to see what was actually changed
git show 6f53bb0 --statRepository: auth0/auth0-fastify
Length of output: 5202
🏁 Script executed:
# Look at the full diff of that commit for the index.ts changes
git show 6f53bb0 -- packages/auth0-fastify/src/index.tsRepository: auth0/auth0-fastify
Length of output: 15510
Remove invalid type re-exports or verify they exist in @auth0/auth0-server-js.
Line 18 attempts to re-export LoginWithCustomTokenExchangeOptions, LoginWithCustomTokenExchangeResult, and CustomTokenExchangeOptions from @auth0/auth0-server-js version 1.4.0, but these types do not exist in that package. This will cause a TS2305 compilation error. Either remove these non-existent types from the re-export list, or confirm the dependency version includes them and update the lockfile accordingly.
🧰 Tools
🪛 GitHub Actions: Build and Test / 0_Build Package (20).txt
[error] 18-18: TypeScript compilation failed (tsup/DTS). TS2305: Module "@auth0/auth0-server-js" has no exported member "LoginWithCustomTokenExchangeOptions".
🪛 GitHub Actions: Build and Test / Build Package (20)
[error] 18-18: TypeScript compilation error TS2305: Module "@auth0/auth0-server-js" has no exported member "LoginWithCustomTokenExchangeOptions".
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@packages/auth0-fastify/src/index.ts` at line 18, The export statement on line
18 attempts to re-export LoginWithCustomTokenExchangeOptions,
LoginWithCustomTokenExchangeResult, and CustomTokenExchangeOptions from
`@auth0/auth0-server-js`, but these types do not exist in version 1.4.0, causing a
TS2305 compilation error. Remove these three non-existent type names from the
export statement, keeping only DomainResolver which is valid, or alternatively
verify that the `@auth0/auth0-server-js` dependency has been upgraded to a version
that includes these types and update the lockfile accordingly.
Source: Pipeline failures
|
Duplicate of #78, closing this one out. |
1 participant
Description
Expose
loginWithCustomTokenExchangeandcustomTokenExchangeon auth0Client via the upgraded auth0-server-js ServerClient. Re-export the associated option and result types so consumers have full type coverage without importing from the underlying package directly.Testing
Checklist
Summary by CodeRabbit
New Features
Tests