fix(jwt content): change id by userId

README.md

@@ -26,9 +26,13 @@ import { defineConfig } from '@adonisjs/auth'
 import { InferAuthEvents, Authenticators } from '@adonisjs/auth/types'
 import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session'
 import { jwtGuard } from '@maximemrf/adonisjs-jwt/jwt_config'
-import { JwtGuardUser } from '@maximemrf/adonisjs-jwt/types'
+import { JwtGuardUser, BaseJwtContent } from '@maximemrf/adonisjs-jwt/types'
 import User from '#models/user'
 
+interface JwtContent extends BaseJwtContent {
+  email: string
+}
+
 const authConfig = defineConfig({
   // define the default authenticator to jwt
   default: 'jwt',
@@ -49,8 +53,8 @@ const authConfig = defineConfig({
         model: () => import('#models/user'),
       }),
       // content is a function that takes the user and returns the content of the token, it can be optional, by default it returns only the user id
-      content: (user: JwtGuardUser<User>) => ({
-        id: user.getId(),
+      content: (user: JwtGuardUser<User>): JwtContent => ({
+        userId: user.getId(),
         email: user.getOriginal().email,
       }),
     }),

src/define_config.ts

@@ -8,7 +8,7 @@ export function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(
   provider: UserProvider
   tokenExpiresIn?: number | string
   useCookies?: boolean
-  content: <T>(user: JwtGuardUser<T>) => Record<string, any>
+  content: <T>(user: JwtGuardUser<T>) => Record<string | number, any>
 }): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>> {
   return {
     async resolver(_, app) {

src/types.ts

@@ -39,6 +39,10 @@ export interface JwtUserProviderContract<RealUser> {
   findById(identifier: string | number | BigInt): Promise<JwtGuardUser<RealUser> | null>
 }
 
+export type BaseJwtContent = {
+  userId: string | number | BigInt
+}
+
 export type JwtGuardOptions<RealUser extends any = unknown> = {
   secret: string
   expiresIn?: number | string

tests/guard.spec.ts

@@ -1,6 +1,6 @@
 import { test } from '@japa/runner'
 import { JwtGuard } from '../src/jwt.js'
-import { JwtGuardUser } from '../src/types.js'
+import { BaseJwtContent, JwtGuardUser } from '../src/types.js'
 import { HttpContextFactory } from '@adonisjs/core/factories/http'
 import { errors } from '@adonisjs/auth'
 import { JwtAuthFakeUser, JwtFakeUserProvider } from '../factories/main.js'
@@ -43,8 +43,13 @@ test.group('Jwt guard | authenticate', () => {
   test('it should return the content function provided when generating jwt', async ({ assert }) => {
     const ctx = new HttpContextFactory().create()
     const userProvider = new JwtFakeUserProvider()
-    const jwtContentFn = (user: JwtGuardUser<JwtAuthFakeUser>) => ({
-      id: user.getId(),
+
+    interface CustomJwtContent extends BaseJwtContent {
+      otherProperty: string
+    }
+
+    const jwtContentFn = (user: JwtGuardUser<JwtAuthFakeUser>): CustomJwtContent => ({
+      userId: user.getId(),
       otherProperty: 'random',
     })
     const guard = new JwtGuard(ctx, userProvider, {
@@ -66,7 +71,7 @@ test.group('Jwt guard | authenticate', () => {
     assert.exists(tokenResponse.token)
     assert.equal(tokenResponse.expiresIn, '1h')
 
-    assert.equal(decoded.id, content.id)
+    assert.equal(decoded.userId, content.userId)
     assert.equal(decoded.otherProperty, content.otherProperty)
   })