@maximemrf/adonisjs-jwt 1.0.0-rc.1 → 1.0.0-rc.2

package/build/configure.js

@@ -10,7 +10,7 @@
 | Flags: --refresh-tokens / --no-refresh-tokens to skip the question.
 |
 */
-import { existsSync, readdirSync } from 'node:fs';
+import { appendFileSync, existsSync, readdirSync } from 'node:fs';
 import { stubsRoot } from './stubs/main.js';
 const DOCS_URL = 'https://maximemrf.github.io/adonisjs-jwt';
 const MIGRATION_SUFFIX = '_create_jwt_refresh_tokens_table.ts';
@@ -127,11 +127,17 @@ async function createMigration(command, codemods) {
             .skipped('the migration already exists');
         return;
     }
-    await codemods.makeUsingStub(stubsRoot, 'migration.stub', {
+    const output = await codemods.makeUsingStub(stubsRoot, 'migration.stub', {
         entity: {
             filename: `${Date.now()}${MIGRATION_SUFFIX}`,
         },
     });
+    /**
+     * The stub renderer trims the final newline, which prettier reports
+     */
+    if (output.status !== 'skipped' && !output.contents.endsWith('\n')) {
+        appendFileSync(output.destination, '\n');
+    }
 }
 function getSourceFile(project, path) {
     return project.getSourceFile(path) ?? project.addSourceFileAtPath(path);

package/build/src/define_config.d.ts

@@ -6,9 +6,9 @@ import { JwtGuard } from './guard.js';
 import type { StringValue } from 'ms';
 import type { AccessTokensUserProviderContract } from '@adonisjs/auth/types/access_tokens';
 import type { Options } from 'jwks-rsa';
-export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>>(config: {
+export declare function jwtGuard<UserProvider extends JwtUserProviderContract<unknown>, RefreshTokenUserProvider extends AccessTokensUserProviderContract<unknown> | undefined = undefined>(config: {
     provider: UserProvider;
-    refreshTokenUserProvider?: AccessTokensUserProviderContract<unknown>;
+    refreshTokenUserProvider?: RefreshTokenUserProvider;
     tokenName?: string;
     refreshTokenName?: string;
     tokenExpiresIn?: number | StringValue;
@@ -29,4 +29,4 @@ export declare function jwtGuard<UserProvider extends JwtUserProviderContract<un
     clockTolerance?: number;
     getUserId?: JwtGetUserId;
     verifyPayload?: JwtVerifyPayload;
-}): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider>>;
+}): GuardConfigProvider<(ctx: HttpContext) => JwtGuard<UserProvider, [RefreshTokenUserProvider] extends [undefined] ? false : true>>;

package/build/src/guard.d.ts

@@ -2,7 +2,7 @@ import { symbols } from '@adonisjs/auth';
 import type { AuthClientResponse, GuardContract } from '@adonisjs/auth/types';
 import type { HttpContext } from '@adonisjs/core/http';
 import { type JwtUserProviderContract, type JwtGuardOptions, type JwtGenerateResult } from './types.js';
-export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unknown>> implements GuardContract<UserProvider[typeof symbols.PROVIDER_REAL_USER]> {
+export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unknown>, WithRefreshToken extends boolean = boolean> implements GuardContract<UserProvider[typeof symbols.PROVIDER_REAL_USER]> {
     #private;
     constructor(ctx: HttpContext, userProvider: UserProvider, option: JwtGuardOptions<UserProvider[typeof symbols.PROVIDER_REAL_USER]>);
     /**
@@ -33,7 +33,7 @@ export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unkno
     /**
      * Generate a JWT token for a given user.
      */
-    generate(user: UserProvider[typeof symbols.PROVIDER_REAL_USER]): Promise<JwtGenerateResult>;
+    generate(user: UserProvider[typeof symbols.PROVIDER_REAL_USER]): Promise<JwtGenerateResult<WithRefreshToken>>;
     /**
      * Authenticate the current HTTP request and return
      * the user instance if there is a valid JWT token
@@ -42,7 +42,7 @@ export declare class JwtGuard<UserProvider extends JwtUserProviderContract<unkno
     authenticate(): Promise<UserProvider[typeof symbols.PROVIDER_REAL_USER] & {
         currentToken: string;
     }>;
-    generateWithRefreshToken(refreshToken?: string): Promise<JwtGenerateResult>;
+    generateWithRefreshToken(refreshToken?: string): Promise<JwtGenerateResult<true>>;
     /**
      * Revoke the refresh token
      */

package/build/src/guard.js

@@ -244,6 +244,9 @@ export class JwtGuard {
         this.isAuthenticated = true;
         this.user = user;
         this.user.currentToken = result.token;
+        /**
+         * The guard has a refresh token provider, so `generate()` issued a refresh token
+         */
         return result;
     }
     async #findRefreshToken() {

package/build/src/types.d.ts

@@ -56,13 +56,19 @@ export declare const ALLOWED_ASYMMETRIC_ALGORITHMS: readonly ["RS256", "RS384",
 export type JwtAsymmetricAlgorithm = (typeof ALLOWED_ASYMMETRIC_ALGORITHMS)[number];
 export declare const ALLOWED_JWKS_ALGORITHMS: readonly ["RS256", "RS384", "RS512", "ES256", "ES384", "ES512", "PS256", "PS384", "PS512"];
 export type JwtJwksAlgorithm = (typeof ALLOWED_JWKS_ALGORITHMS)[number];
-export type JwtGenerateResult = {
+/**
+ * `refreshToken` is a string when the guard has a `refreshTokenUserProvider`
+ */
+export type JwtGenerateResult<WithRefreshToken extends boolean = boolean> = {
     type: string;
     token: string;
     expiresIn?: number | StringValue;
-    refreshToken?: string;
     refreshTokenExpiresIn?: number | StringValue;
-};
+} & ([WithRefreshToken] extends [true] ? {
+    refreshToken: string;
+} : {
+    refreshToken?: string;
+});
 export type JwtGuardOptions<RealUser extends any = unknown> = {
     /**
      * Driver resolved by `jwtGuard()`. Not part of the public API: custom

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@maximemrf/adonisjs-jwt",
   "description": "AdonisJS package for authentication with JWT tokens",
-  "version": "1.0.0-rc.1",
+  "version": "1.0.0-rc.2",
   "engines": {
     "node": ">=24.0.0"
   },