@maximemrf/adonisjs-jwt 0.7.0 → 0.8.0-alpha.0

package/README.md

@@ -79,6 +79,11 @@ const authConfig = defineConfig({
       refreshTokenExpiresIn: '7d',
       // ability to separate cookie usage for refresh token
       useCookiesForRefreshToken: true,
+      // ability to configure the cookies options
+      cookie: {
+        httpOnly: true,
+        secure: true,
+      },
       // limit the abilities of the refresh token
       refreshTokenAbilities: ['refresh_token'],
       // 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
@@ -116,6 +121,19 @@ 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.
 
+You can also pass options to the cookies. Note that `maxAge` and `expires` are omitted from the options because they are automatically handled by the package based on the token validity (`tokenExpiresIn` and `refreshTokenExpiresIn`).
+By default, `httpOnly: true` and `secure: true` are enforced for better security, but you can override them using the `cookie` object configuration.
+
+```typescript
+cookie: {
+  httpOnly: true, // Default
+  secure: true,   // Default
+  path: '/',
+  sameSite: 'lax',
+  // maxAge and expires cannot be set here
+}
+```
+
 ## JWKS
 
 You can use JWKS to verify the token by setting the `jwks` option in the guard configuration.

package/build/src/define_config.d.ts

@@ -1,10 +1,10 @@
-import { GuardConfigProvider } from '@adonisjs/auth/types';
+import type { GuardConfigProvider } from '@adonisjs/auth/types';
 import type { HttpContext } from '@adonisjs/core/http';
-import { JwtGuardUser, JwtUserProviderContract } from './types.js';
+import type { JwtGuardUser, JwtUserProviderContract, JwtCookieOptions } from './types.js';
 import { JwtGuard } from './jwt.js';
 import type { StringValue } from 'ms';
-import { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
-import { Options } from 'jwks-rsa';
+import type { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
+import type { Options } from 'jwks-rsa';
 export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(config: {
     provider: UserProvider;
     refreshTokenUserProvider?: AccessTokensUserProviderContract<unknown>;
@@ -17,4 +17,5 @@ export declare function jwtGuard<UserProvider extends JwtUserProviderContract<un
     secret?: string;
     content: <T>(user: JwtGuardUser<T>) => Record<string | number, any>;
     jwks?: Options;
+    cookie?: JwtCookieOptions;
 }): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>>;

package/build/src/define_config.js

@@ -14,6 +14,7 @@ export function jwtGuard(config) {
                 refreshTokenAbilities: config.refreshTokenAbilities,
                 content: config.content,
                 jwks: config.jwks,
+                cookie: config.cookie,
             };
             return (ctx) => new JwtGuard(ctx, config.provider, options);
         },

package/build/src/jwks.d.ts

@@ -1,4 +1,4 @@
-import { Options, JwksClient } from 'jwks-rsa';
+import { type Options, JwksClient } from 'jwks-rsa';
 export declare class JwksManager {
     private client;
     constructor(options: Options);

package/build/src/jwt.d.ts

@@ -1,8 +1,8 @@
 import { symbols } from '@adonisjs/auth';
-import { AuthClientResponse, GuardContract } from '@adonisjs/auth/types';
+import type { AuthClientResponse, GuardContract } from '@adonisjs/auth/types';
 import type { HttpContext } from '@adonisjs/core/http';
 import type { StringValue } from 'ms';
-import { JwtUserProviderContract, JwtGuardOptions } from './types.js';
+import type { 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/jwt.js

@@ -10,6 +10,7 @@ export class JwtGuard {
     #tokenName;
     #refreshTokenName = 'refreshToken';
     #jwksManager;
+    #cookieOptions;
     constructor(ctx, userProvider, option) {
         this.#ctx = ctx;
         this.#userProvider = userProvider;
@@ -19,6 +20,11 @@ export class JwtGuard {
             this.#options.content = (user) => ({ userId: user.getId() });
         this.#tokenName = this.#options.tokenName ?? 'token';
         this.#jwksManager = this.#options.jwks ? new JwksManager(this.#options.jwks) : undefined;
+        this.#cookieOptions = {
+            httpOnly: true,
+            secure: true,
+            ...this.#options.cookie,
+        };
     }
     /**
      * A unique name for the guard driver
@@ -64,12 +70,14 @@ export class JwtGuard {
         }
         if (this.#options.useCookies) {
             this.#ctx.response.cookie(`${this.#tokenName}`, token, {
-                httpOnly: true,
+                ...this.#cookieOptions,
+                maxAge: this.#options.expiresIn,
             });
         }
         if (this.#options.useCookiesForRefreshToken && refreshToken) {
             this.#ctx.response.cookie(`${this.#refreshTokenName}`, refreshToken, {
-                httpOnly: true,
+                ...this.#cookieOptions,
+                maxAge: this.#options.refreshTokenExpiresIn,
             });
         }
         return {
@@ -94,17 +102,10 @@ export class JwtGuard {
             return this.getUserOrFail();
         }
         this.authenticationAttempted = true;
-        const cookieHeader = this.#ctx.request.request.headers.cookie;
-        let token;
         /**
-         * If cookies are enabled, then read the token from the cookies
+         * Try to read the token from the cookies.
          */
-        if (cookieHeader) {
-            const regex = new RegExp(`${this.#tokenName}=([^;]*)`);
-            token =
-                this.#ctx.request.cookie(`${this.#tokenName}`) ??
-                    (this.#ctx.request.request.headers.cookie.match(regex) || [])[1];
-        }
+        let token = this.#ctx.request.cookie(`${this.#tokenName}`);
         /**
          * If token is missing on cookies, then try to read it from the header authorization
          */

package/build/src/types.d.ts

@@ -1,7 +1,9 @@
-import { symbols } from '@adonisjs/auth';
+import { type symbols } from '@adonisjs/auth';
 import type { StringValue } from 'ms';
-import { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
-import { Options } from 'jwks-rsa';
+import type { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
+import type { Options } from 'jwks-rsa';
+import type { CookieOptions } from '@adonisjs/core/types/http';
+export type JwtCookieOptions = Omit<Partial<CookieOptions>, 'maxAge' | 'expires'>;
 /**
  * The bridge between the User provider and the
  * Guard
@@ -49,5 +51,6 @@ export type JwtGuardOptions<RealUser extends any = unknown> = {
     useCookies?: boolean;
     useCookiesForRefreshToken?: boolean;
     refreshTokenAbilities?: string[];
+    cookie?: JwtCookieOptions;
     content?: (user: JwtGuardUser<RealUser>) => Record<string, any>;
 };

package/build/src/types.js

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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maximemrf/adonisjs-jwt",
   "description": "Adonisjs v6 package for authentication with jwt token",
-  "version": "0.7.0",
+  "version": "0.8.0-alpha.0",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -17,13 +17,18 @@
     "./types": "./build/src/types.js",
     "./jwt_config": "./build/src/define_config.js"
   },
+  "imports": {
+    "#generated/*": "./.adonisjs/server/*.js",
+    "#transformers/*": "./app/transformers/*.js",
+    "#database/*": "./database/*.js"
+  },
   "scripts": {
     "clean": "del-cli build",
     "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
     "typecheck": "tsc --noEmit",
     "lint": "eslint .",
     "format": "prettier --write .",
-    "quick:test": "node --import=ts-node-maintained/register/esm --enable-source-maps --experimental-import-meta-resolve bin/test.ts --force-exit",
+    "quick:test": "node --import=@poppinss/ts-exec --enable-source-maps bin/test.ts --force-exit",
     "pretest": "npm run lint",
     "test": "c8 npm run quick:test",
     "prebuild": "npm run lint && npm run clean",
@@ -34,31 +39,31 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.8.2",
-    "@adonisjs/auth": "^9.5.1",
-    "@adonisjs/core": "^6.19.3",
-    "@adonisjs/eslint-config": "^2.1.2",
-    "@adonisjs/lucid": "^21.8.2",
+    "@adonisjs/assembler": "^8.0.0",
+    "@adonisjs/auth": "^10.0.0",
+    "@adonisjs/core": "^7.0.1",
+    "@adonisjs/eslint-config": "^3.0.0",
+    "@adonisjs/lucid": "^22.0.0",
     "@adonisjs/prettier-config": "^1.4.5",
-    "@adonisjs/tsconfig": "^1.4.1",
+    "@adonisjs/tsconfig": "^2.0.0",
     "@japa/assert": "^4.2.0",
     "@japa/file-system": "^3.0.0",
     "@japa/runner": "^5.3.0",
-    "@types/nock": "^10.0.3",
-    "@swc/core": "^1.15.10",
+    "@poppinss/ts-exec": "^1.4.4",
+    "@types/nock": "^11.1.0",
     "@types/node": "^22.15.18",
     "c8": "^10.1.3",
     "copyfiles": "^2.4.1",
     "del-cli": "^7.0.0",
-    "eslint": "^9.39.2",
+    "eslint": "^9.39.3",
     "luxon": "^3.7.2",
-    "nock": "^14.0.10",
-    "np": "^11.0.1",
+    "nock": "^14.0.11",
+    "np": "^11.0.2",
     "prettier": "^3.8.1",
     "sqlite3": "^5.1.7",
     "timekeeper": "^2.3.1",
-    "ts-node-maintained": "^10.9.6",
-    "typescript": "~5.9.3"
+    "typescript": "~5.9.3",
+    "youch": "^4.1.0"
   },
   "dependencies": {
     "@types/jsonwebtoken": "^9.0.10",
@@ -67,7 +72,7 @@
     "ms": "^2.1.3"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.15.0"
+    "@adonisjs/core": "^7.0.1"
   },
   "author": "MaximeMRF",
   "license": "MIT",
@@ -75,7 +80,10 @@
     "adonisjs",
     "adonis",
     "jwt",
-    "authentication"
+    "authentication",
+    "jwks",
+    "refresh token",
+    "cookies"
   ],
   "eslintConfig": {
     "extends": "@adonisjs/eslint-config/package"
@@ -100,4 +108,4 @@
       "tests/**"
     ]
   }
-}
+}