@maximemrf/adonisjs-jwt 0.2.0 → 0.2.2

package/README.md

@@ -26,7 +26,12 @@ 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
@@ -48,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,
       }),
     }),

package/build/src/define_config.d.ts

@@ -1,9 +1,10 @@
 import { GuardConfigProvider } from '@adonisjs/auth/types';
 import type { HttpContext } from '@adonisjs/core/http';
-import { JwtGuard, JwtGuardUser, JwtUserProviderContract } from './jwt.js';
+import { JwtGuardUser, JwtUserProviderContract } from './types.js';
+import { JwtGuard } from './jwt.js';
 export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(config: {
     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>>;

package/build/src/jwt.d.ts

@@ -1,46 +1,7 @@
 import { symbols } from '@adonisjs/auth';
 import { AuthClientResponse, GuardContract } from '@adonisjs/auth/types';
 import type { HttpContext } from '@adonisjs/core/http';
-/**
- * The bridge between the User provider and the
- * Guard
- */
-export type JwtGuardUser<RealUser> = {
-    /**
-     * Returns the unique ID of the user
-     */
-    getId(): string | number | BigInt;
-    /**
-     * Returns the original user object
-     */
-    getOriginal(): RealUser;
-};
-/**
- * The interface for the UserProvider accepted by the
- * JWT guard.
- */
-export interface JwtUserProviderContract<RealUser> {
-    /**
-     * A property the guard implementation can use to infer
-     * the data type of the actual user (aka RealUser)
-     */
-    [symbols.PROVIDER_REAL_USER]: RealUser;
-    /**
-     * Create a user object that acts as an adapter between
-     * the guard and real user value.
-     */
-    createUserForGuard(user: RealUser): Promise<JwtGuardUser<RealUser>>;
-    /**
-     * Find a user by their id.
-     */
-    findById(identifier: string | number | BigInt): Promise<JwtGuardUser<RealUser> | null>;
-}
-export type JwtGuardOptions<RealUser extends any = unknown> = {
-    secret: string;
-    expiresIn?: number | string;
-    useCookies?: boolean;
-    content?: (user: JwtGuardUser<RealUser>) => Record<string, any>;
-};
+import { JwtUserProviderContract, JwtGuardOptions } from './types.js';
 export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unknown>> implements GuardContract<UserProvider[typeof symbols.PROVIDER_REAL_USER]> {
     #private;
     constructor(ctx: HttpContext, userProvider: UserProvider, option: JwtGuardOptions<UserProvider[typeof symbols.PROVIDER_REAL_USER]>);

package/build/src/types.d.ts

@@ -0,0 +1,44 @@
+import { symbols } from '@adonisjs/auth';
+/**
+ * The bridge between the User provider and the
+ * Guard
+ */
+export type JwtGuardUser<RealUser> = {
+    /**
+     * Returns the unique ID of the user
+     */
+    getId(): string | number | BigInt;
+    /**
+     * Returns the original user object
+     */
+    getOriginal(): RealUser;
+};
+/**
+ * The interface for the UserProvider accepted by the
+ * JWT guard.
+ */
+export interface JwtUserProviderContract<RealUser> {
+    /**
+     * A property the guard implementation can use to infer
+     * the data type of the actual user (aka RealUser)
+     */
+    [symbols.PROVIDER_REAL_USER]: RealUser;
+    /**
+     * Create a user object that acts as an adapter between
+     * the guard and real user value.
+     */
+    createUserForGuard(user: RealUser): Promise<JwtGuardUser<RealUser>>;
+    /**
+     * Find a user by their id.
+     */
+    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;
+    useCookies?: boolean;
+    content?: (user: JwtGuardUser<RealUser>) => Record<string, any>;
+};

package/build/src/types.js

@@ -0,0 +1 @@
+import { symbols } from '@adonisjs/auth';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maximemrf/adonisjs-jwt",
   "description": "Adonisjs v6 package for authentication with jwt token",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -56,6 +56,10 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.4.2"
   },
+  "dependencies": {
+    "@types/jsonwebtoken": "^9.0.6",
+    "jsonwebtoken": "^9.0.2"
+  },
   "peerDependencies": {
     "@adonisjs/core": "^6.2.0"
   },
@@ -67,6 +71,10 @@
     "jwt",
     "authentication"
   ],
+  "eslintConfig": {
+    "extends": "@adonisjs/eslint-config/package"
+  },
+  "prettier": "@adonisjs/prettier-config",
   "publishConfig": {
     "access": "public",
     "tag": "latest"
@@ -85,13 +93,5 @@
     "exclude": [
       "tests/**"
     ]
-  },
-  "eslintConfig": {
-    "extends": "@adonisjs/eslint-config/package"
-  },
-  "prettier": "@adonisjs/prettier-config",
-  "dependencies": {
-    "@types/jsonwebtoken": "^9.0.6",
-    "jsonwebtoken": "^9.0.2"
   }
 }