@adonisjs/auth 9.0.0-5 → 9.0.0-6

package/build/src/auth/auth_manager.d.ts

@@ -1,6 +1,7 @@
 import type { HttpContext } from '@adonisjs/core/http';
 import type { GuardFactory } from './types.js';
 import { Authenticator } from './authenticator.js';
+import { AuthenticatorClient } from './authenticator_client.js';
 /**
  * Auth manager exposes the API to register and manage authentication
  * guards from the config
@@ -19,4 +20,8 @@ export declare class AuthManager<KnownGuards extends Record<string, GuardFactory
      * Create an authenticator for a given HTTP request
      */
     createAuthenticator(ctx: HttpContext): Authenticator<KnownGuards>;
+    /**
+     * Creates an instance of the authenticator client
+     */
+    createAuthenticatorClient(): AuthenticatorClient<KnownGuards>;
 }

package/build/src/auth/auth_manager.js

@@ -7,6 +7,7 @@
  * file that was distributed with this source code.
  */
 import { Authenticator } from './authenticator.js';
+import { AuthenticatorClient } from './authenticator_client.js';
 /**
  * Auth manager exposes the API to register and manage authentication
  * guards from the config
@@ -31,4 +32,10 @@ export class AuthManager {
     createAuthenticator(ctx) {
         return new Authenticator(ctx, this.#config);
     }
+    /**
+     * Creates an instance of the authenticator client
+     */
+    createAuthenticatorClient() {
+        return new AuthenticatorClient(this.#config);
+    }
 }

package/build/src/auth/authenticator_client.d.ts

@@ -0,0 +1,23 @@
+import type { GuardFactory } from './types.js';
+/**
+ * Authenticator client is used to create guard instances for
+ * testing. It passes a fake HTTPContext to the guards, so
+ * make sure to not call server side APIs that might be
+ * relying on a real HTTPContext instance
+ */
+export declare class AuthenticatorClient<KnownGuards extends Record<string, GuardFactory>> {
+    #private;
+    /**
+     * Name of the default guard
+     */
+    get defaultGuard(): keyof KnownGuards;
+    constructor(config: {
+        default: keyof KnownGuards;
+        guards: KnownGuards;
+    });
+    /**
+     * Returns an instance of a known guard. Guards instances are
+     * cached during the lifecycle of an HTTP request.
+     */
+    use<Guard extends keyof KnownGuards>(guard?: Guard): ReturnType<KnownGuards[Guard]>;
+}

package/build/src/auth/authenticator_client.js

@@ -0,0 +1,59 @@
+/*
+ * @adonisjs/auth
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import debug from './debug.js';
+import { HttpContextFactory } from '@adonisjs/core/factories/http';
+/**
+ * Authenticator client is used to create guard instances for
+ * testing. It passes a fake HTTPContext to the guards, so
+ * make sure to not call server side APIs that might be
+ * relying on a real HTTPContext instance
+ */
+export class AuthenticatorClient {
+    /**
+     * Registered guards
+     */
+    #config;
+    /**
+     * Cache of guards
+     */
+    #guardsCache = {};
+    /**
+     * Name of the default guard
+     */
+    get defaultGuard() {
+        return this.#config.default;
+    }
+    constructor(config) {
+        this.#config = config;
+        debug('creating authenticator client. config %O', this.#config);
+    }
+    /**
+     * Returns an instance of a known guard. Guards instances are
+     * cached during the lifecycle of an HTTP request.
+     */
+    use(guard) {
+        const guardToUse = guard || this.#config.default;
+        /**
+         * Use cached copy if exists
+         */
+        const cachedGuard = this.#guardsCache[guardToUse];
+        if (cachedGuard) {
+            debug('using guard from cache. name: "%s"', guardToUse);
+            return cachedGuard;
+        }
+        const guardFactory = this.#config.guards[guardToUse];
+        /**
+         * Construct guard and cache it
+         */
+        debug('creating guard. name: "%s"', guardToUse);
+        const guardInstance = guardFactory(new HttpContextFactory().create());
+        this.#guardsCache[guardToUse] = guardInstance;
+        return guardInstance;
+    }
+}

package/build/src/auth/plugins/japa/api_client.d.ts

@@ -0,0 +1,31 @@
+import type { ApplicationService } from '@adonisjs/core/types';
+import type { Authenticators, GuardContract, GuardFactory } from '../../types.js';
+declare module '@japa/api-client' {
+    interface ApiRequest {
+        authData: {
+            guard: string;
+            user: unknown;
+        };
+        /**
+         * Login a user using the default authentication
+         * guard when making an API call
+         */
+        loginAs(user: {
+            [K in keyof Authenticators]: Authenticators[K] extends GuardFactory ? ReturnType<Authenticators[K]> extends GuardContract<infer A> ? A : never : never;
+        }): this;
+        /**
+         * Define the authentication guard for login
+         */
+        withGuard<K extends keyof Authenticators, Self extends ApiRequest>(this: Self, guard: K): {
+            /**
+             * Login a user using a specific auth guard
+             */
+            loginAs(user: Authenticators[K] extends GuardFactory ? ReturnType<Authenticators[K]> extends GuardContract<infer A> ? A : never : never): Self;
+        };
+    }
+}
+/**
+ * Auth API client to authenticate users when making
+ * HTTP requests using the Japa API client
+ */
+export declare const authApiClient: (app: ApplicationService) => void;

package/build/src/auth/plugins/japa/api_client.js

@@ -0,0 +1,56 @@
+/*
+ * @adonisjs/auth
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/// <reference types="@adonisjs/session/plugins/api_client" />
+import { ApiClient, ApiRequest } from '@japa/api-client';
+/**
+ * Auth API client to authenticate users when making
+ * HTTP requests using the Japa API client
+ */
+export const authApiClient = (app) => {
+    ApiRequest.macro('loginAs', function (user) {
+        this.authData = {
+            guard: '__default__',
+            user: user,
+        };
+        return this;
+    });
+    ApiRequest.macro('withGuard', function (guard) {
+        return {
+            loginAs: (user) => {
+                this.authData = {
+                    guard,
+                    user: user,
+                };
+                return this;
+            },
+        };
+    });
+    /**
+     * Hook into the request and login the user
+     */
+    ApiClient.setup(async (request) => {
+        const auth = await app.container.make('auth.manager');
+        const authData = request['authData'];
+        if (!authData) {
+            return;
+        }
+        const client = auth.createAuthenticatorClient();
+        const guard = authData.guard === '__default__' ? client.use() : client.use(authData.guard);
+        const requestData = await guard.authenticateAsClient(authData.user);
+        if (requestData.headers) {
+            request.headers(requestData.headers);
+        }
+        if (requestData.session) {
+            request.withSession(requestData.session);
+        }
+        if (requestData.cookies) {
+            request.cookies(requestData.cookies);
+        }
+    });
+};

package/build/src/auth/types.d.ts

@@ -2,6 +2,14 @@ import type { HttpContext } from '@adonisjs/core/http';
 import type { ApplicationService, ConfigProvider } from '@adonisjs/core/types';
 import type { AuthManager } from './auth_manager.js';
 import type { GUARD_KNOWN_EVENTS } from './symbols.js';
+/**
+ * The client response for authentication.
+ */
+export interface AuthClientResponse {
+    headers?: Record<string, any>;
+    cookies?: Record<string, any>;
+    session?: Record<string, any>;
+}
 /**
  * A set of properties a guard must implement.
  */
@@ -30,6 +38,12 @@ export interface GuardContract<User> {
      * exception
      */
     check(): Promise<boolean>;
+    /**
+     * The method is used to authenticate the user as
+     * client. This method should return cookies,
+     * headers, or session state.
+     */
+    authenticateAsClient(user: User): Promise<AuthClientResponse>;
     /**
      * Authenticates the current request and throws
      * an exception if the request is not authenticated.

package/build/src/guards/session/guard.d.ts

@@ -113,4 +113,11 @@ export declare class SessionGuard<UserProvider extends SessionUserProviderContra
      * Logout user and revoke remember me token (if any)
      */
     logout(): Promise<void>;
+    /**
+     * Returns the session state for the user to be
+     * logged-in as a client
+     */
+    authenticateAsClient(user: UserProvider[typeof PROVIDER_REAL_USER]): Promise<{
+        session: Record<string, string | number>;
+    }>;
 }

package/build/src/guards/session/guard.js

@@ -491,4 +491,18 @@ export class SessionGuard {
         debug('session_auth: deleting remember me token');
         await this.#rememberMeTokenProvider.deleteTokenBySeries(decodedToken.series);
     }
+    /**
+     * Returns the session state for the user to be
+     * logged-in as a client
+     */
+    async authenticateAsClient(user) {
+        const providerUser = await this.#userProvider.createUserForGuard(user);
+        const userId = providerUser.getId();
+        debug('session_guard: returning client session for user id "%s"', userId);
+        return {
+            session: {
+                [this.sessionKeyName]: userId,
+            },
+        };
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adonisjs/auth",
-  "version": "9.0.0-5",
+  "version": "9.0.0-6",
   "description": "Official authentication provider for Adonis framework",
   "type": "module",
   "main": "build/index.js",
@@ -22,6 +22,7 @@
     ".": "./build/index.js",
     "./types": "./build/src/auth/types.js",
     "./auth_provider": "./build/providers/auth_provider.js",
+    "./plugins/api_client": "./build/src/auth/plugins/japa/api_client.js",
     "./services/main": "./build/services/auth.js",
     "./core/token": "./build/src/core/token.js",
     "./core/guard_user": "./build/src/core/guard_user.js",
@@ -74,6 +75,7 @@
     "@adonisjs/tsconfig": "^1.1.8",
     "@commitlint/cli": "^18.0.0",
     "@commitlint/config-conventional": "^18.0.0",
+    "@japa/api-client": "^2.0.0",
     "@japa/assert": "^2.0.0",
     "@japa/expect-type": "^2.0.0",
     "@japa/file-system": "^2.0.0",
@@ -132,9 +134,10 @@
     "@poppinss/utils": "^6.5.0"
   },
   "peerDependencies": {
-    "@adonisjs/core": "^6.1.5-30",
+    "@adonisjs/core": "^6.1.5-31",
     "@adonisjs/lucid": "^19.0.0-3",
-    "@adonisjs/session": "^7.0.0-13"
+    "@adonisjs/session": "^7.0.0-13",
+    "@japa/api-client": "^2.0.0"
   },
   "peerDependenciesMeta": {
     "@adonisjs/lucid": {
@@ -142,6 +145,9 @@
     },
     "@adonisjs/session": {
       "optional": true
+    },
+    "@japa/api-client": {
+      "optional": true
     }
   }
 }