@maximemrf/adonisjs-jwt 0.3.0 → 0.5.0

package/README.md

@@ -38,6 +38,7 @@ import { sessionGuard, sessionUserProvider } from '@adonisjs/auth/session'
 import { jwtGuard } from '@maximemrf/adonisjs-jwt/jwt_config'
 import { JwtGuardUser, BaseJwtContent } from '@maximemrf/adonisjs-jwt/types'
 import User from '#models/user'
+import env from '#start/env'
 
 interface JwtContent extends BaseJwtContent {
   email: string
@@ -55,10 +56,16 @@ const authConfig = defineConfig({
     }),
     // add the jwt guard
     jwt: jwtGuard({
+      // tokenName is the name of the token passed as cookie, it can be optional, by default it is 'token'
+      tokenName: 'custom-name',
       // tokenExpiresIn can be a string or a number, it can be optional
       tokenExpiresIn: '1h',
       // if you want to use cookies for the authentication instead of the bearer token (optional)
       useCookies: true,
+      // secret is the secret used to sign the token, it can be optional, by default it uses the application key
+      // you can use a env variable like JWT_SECRET or set it directly with a string
+      // if you don't have specific needs, please discard this option
+      secret: env.get('JWT_SECRET'),
       provider: sessionUserProvider({
         model: () => import('#models/user'),
       }),
@@ -74,6 +81,12 @@ const authConfig = defineConfig({
 })
 ```
 
+`tokenName` is the name of the token passed as a cookie, it can be optional, by default it is `token`.
+
+```typescript
+tokenName: 'custom-name'
+```
+
 `tokenExpiresIn` is the time before the token expires it can be a string or a number and it can be optional.
 
 ```typescript
@@ -91,7 +104,7 @@ useCookies: true
 
 If you just want to use jwt with the bearer token no need to set `useCookies` to `false` you can just remove it.
 
-## Usage
+## Authentication
 
 To make a protected route, you have to use the `auth` middleware with the `jwt` guard.
 

package/build/src/define_config.d.ts

@@ -5,7 +5,9 @@ import { JwtGuard } from './jwt.js';
 import type { StringValue } from 'ms';
 export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(config: {
     provider: UserProvider;
+    tokenName?: string;
     tokenExpiresIn?: number | StringValue;
     useCookies?: boolean;
+    secret?: string;
     content: <T>(user: JwtGuardUser<T>) => Record<string | number, any>;
 }): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>>;

package/build/src/define_config.js

@@ -4,7 +4,8 @@ export function jwtGuard(config) {
         async resolver(_, app) {
             const appKey = app.config.get('app.appKey').release();
             const options = {
-                secret: appKey,
+                secret: config.secret ?? appKey,
+                tokenName: config.tokenName,
                 expiresIn: config.tokenExpiresIn,
                 useCookies: config.useCookies,
                 content: config.content,

package/build/src/jwt.js

@@ -4,12 +4,14 @@ export class JwtGuard {
     #ctx;
     #userProvider;
     #options;
+    #tokenName;
     constructor(ctx, userProvider, option) {
         this.#ctx = ctx;
         this.#userProvider = userProvider;
         this.#options = option;
         if (!this.#options.content)
             this.#options.content = (user) => ({ userId: user.getId() });
+        this.#tokenName = this.#options.tokenName ?? 'token';
     }
     /**
      * A unique name for the guard driver
@@ -40,7 +42,7 @@ export class JwtGuard {
             }
             : {});
         if (this.#options.useCookies) {
-            return this.#ctx.response.cookie('token', token, {
+            return this.#ctx.response.cookie(`${this.#tokenName}`, token, {
                 httpOnly: true,
             });
         }
@@ -70,9 +72,10 @@ export class JwtGuard {
          * If cookies are enabled, then read the token from the cookies
          */
         if (cookieHeader) {
+            const regex = new RegExp(`${this.#tokenName}=([^;]*)`);
             token =
-                this.#ctx.request.cookie('token') ??
-                    (this.#ctx.request.request.headers.cookie.match(/token=(.*?)(;|$)/) || [])[1];
+                this.#ctx.request.cookie(`${this.#tokenName}`) ??
+                    (this.#ctx.request.request.headers.cookie.match(regex) || [])[1];
         }
         /**
          * If token is missing on cookies, then try to read it from the header authorization

package/build/src/types.d.ts

@@ -39,6 +39,7 @@ export type BaseJwtContent = {
 };
 export type JwtGuardOptions<RealUser extends any = unknown> = {
     secret: string;
+    tokenName?: string;
     expiresIn?: number | StringValue;
     useCookies?: boolean;
     content?: (user: JwtGuardUser<RealUser>) => Record<string, any>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maximemrf/adonisjs-jwt",
   "description": "Adonisjs v6 package for authentication with jwt token",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -23,7 +23,7 @@
     "typecheck": "tsc --noEmit",
     "lint": "eslint .",
     "format": "prettier --write .",
-    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
+    "quick:test": "node --import=ts-node-maintained/register/esm --enable-source-maps --experimental-import-meta-resolve bin/test.ts --force-exit",
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
@@ -53,7 +53,7 @@
     "np": "^10.0.0",
     "prettier": "^3.5.3",
     "timekeeper": "^2.3.1",
-    "ts-node": "^10.9.2",
+    "ts-node-maintained": "^10.9.5",
     "typescript": "~5.8"
   },
   "dependencies": {