@maximemrf/adonisjs-jwt 0.2.1 → 0.3.0

package/README.md

@@ -1,4 +1,14 @@
-# AdonisJS Jwt Auth
+<p align="center">
+  <img src="https://maximemax.sirv.com/npm_package_maxime_jwt.png" alt="@maximemrf/adonisjs-jwt">
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@maximemrf/adonisjs-jwt"><img src="https://img.shields.io/npm/dm/@maximemrf/adonisjs-jwt.svg?style=flat-square" alt="Download"></a>
+  <a href="https://www.npmjs.com/package/@maximemrf/adonisjs-jwt"><img src="https://img.shields.io/npm/v/@maximemrf/adonisjs-jwt.svg?style=flat-square" alt="Version"></a>
+  <a href="https://www.npmjs.com/package/@maximemrf/adonisjs-jwt"><img src="https://img.shields.io/npm/last-update/@maximemrf/adonisjs-jwt.svg?style=flat-square" alt="NPM Last Update"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/@maximemrf/adonisjs-jwt.svg?style=flat-square" alt="License"></a>
+</p>
+
 > AdonisJS package to authenticate users using JWT tokens.
 
 ## Prerequisites
@@ -26,9 +36,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,10 +63,12 @@ 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(),
-        email: user.getOriginal().email,
-      }),
+      content: <T>(user: JwtGuardUser<T>): JwtContent => {
+        return {
+          userId: user.getId(),
+          email: (user.getOriginal() as User).email,
+        }
+      },
     }),
   },
 })

package/build/src/define_config.d.ts

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

@@ -27,21 +27,25 @@ export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unkno
     /**
      * Reference to the currently authenticated user
      */
-    user?: UserProvider[typeof symbols.PROVIDER_REAL_USER];
+    user?: UserProvider[typeof symbols.PROVIDER_REAL_USER] & {
+        currentToken: string;
+    };
     /**
      * Generate a JWT token for a given user.
      */
     generate(user: UserProvider[typeof symbols.PROVIDER_REAL_USER]): Promise<import("@adonisjs/core/http").Response | {
         type: string;
         token: string;
-        expiresIn: string | number | undefined;
+        expiresIn: number | import("ms").StringValue | undefined;
     }>;
     /**
      * Authenticate the current HTTP request and return
      * the user instance if there is a valid JWT token
      * or throw an exception
      */
-    authenticate(): Promise<UserProvider[typeof symbols.PROVIDER_REAL_USER]>;
+    authenticate(): Promise<UserProvider[typeof symbols.PROVIDER_REAL_USER] & {
+        currentToken: string;
+    }>;
     /**
      * Same as authenticate, but does not throw an exception
      */
@@ -49,7 +53,9 @@ export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unkno
     /**
      * Returns the authenticated user or throws an error
      */
-    getUserOrFail(): UserProvider[typeof symbols.PROVIDER_REAL_USER];
+    getUserOrFail(): UserProvider[typeof symbols.PROVIDER_REAL_USER] & {
+        currentToken: string;
+    };
     /**
      * This method is called by Japa during testing when "loginAs"
      * method is used to login the user.

package/build/src/jwt.js

@@ -1,4 +1,4 @@
-import { symbols, errors } from '@adonisjs/auth';
+import { errors } from '@adonisjs/auth';
 import jwt from 'jsonwebtoken';
 export class JwtGuard {
     #ctx;
@@ -126,6 +126,7 @@ export class JwtGuard {
         }
         this.isAuthenticated = true;
         this.user = providerUser.getOriginal();
+        this.user.currentToken = token;
         return this.getUserOrFail();
     }
     /**

package/build/src/types.d.ts

@@ -1,4 +1,5 @@
 import { symbols } from '@adonisjs/auth';
+import type { StringValue } from 'ms';
 /**
  * The bridge between the User provider and the
  * Guard
@@ -22,7 +23,7 @@ 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;
+    [symbols.PROVIDER_REAL_USER]?: RealUser;
     /**
      * Create a user object that acts as an adapter between
      * the guard and real user value.
@@ -33,9 +34,12 @@ 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;
+    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.2.1",
+  "version": "0.3.0",
   "engines": {
     "node": ">=20.6.0"
   },
@@ -21,7 +21,7 @@
     "clean": "del-cli build",
     "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
     "typecheck": "tsc --noEmit",
-    "lint": "eslint . --ext=.ts",
+    "lint": "eslint .",
     "format": "prettier --write .",
     "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts",
     "pretest": "npm run lint",
@@ -34,34 +34,35 @@
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.2.3",
-    "@adonisjs/auth": "^9.1.1",
-    "@adonisjs/core": "^6.3.1",
-    "@adonisjs/eslint-config": "^1.3.0",
-    "@adonisjs/lucid": "^20.5.1",
-    "@adonisjs/prettier-config": "^1.3.0",
-    "@adonisjs/tsconfig": "^1.3.0",
-    "@japa/assert": "^2.1.0",
-    "@japa/runner": "^3.1.1",
-    "@swc/core": "^1.4.6",
-    "@types/node": "^20.11.25",
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/auth": "^9.4.0",
+    "@adonisjs/core": "^6.17.2",
+    "@adonisjs/eslint-config": "^2.0.0",
+    "@adonisjs/lucid": "^21.0.0",
+    "@adonisjs/prettier-config": "^1.4.4",
+    "@adonisjs/tsconfig": "^1.4.0",
+    "@japa/assert": "^4.0.1",
+    "@japa/runner": "^4.2.0",
+    "@swc/core": "1.11.24",
+    "@types/node": "^22.15.18",
     "c8": "^9.1.0",
     "copyfiles": "^2.4.1",
     "del-cli": "^5.1.0",
-    "eslint": "^8.57.0",
+    "eslint": "^9.26.0",
     "luxon": "^3.4.4",
     "np": "^10.0.0",
-    "prettier": "^3.2.5",
+    "prettier": "^3.5.3",
     "timekeeper": "^2.3.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.4.2"
+    "typescript": "~5.8"
   },
   "dependencies": {
     "@types/jsonwebtoken": "^9.0.6",
-    "jsonwebtoken": "^9.0.2"
+    "jsonwebtoken": "^9.0.2",
+    "ms": "^2.1.3"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.2.0"
+    "@adonisjs/core": "^6.15.0"
   },
   "author": "MaximeMRF",
   "license": "MIT",