@adonisjs/auth 9.0.0-8 → 9.0.0

package/build/services/auth.js

@@ -1,17 +1,12 @@
-/*
- * @adonisjs/auth
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import app from '@adonisjs/core/services/app';
-let auth;
-/**
- * Returns a singleton instance of the Auth manager class
- */
+import "../chunk-CZCFTIBB.js";
+
+// services/auth.ts
+import app from "@adonisjs/core/services/app";
+var auth;
 await app.booted(async () => {
-    auth = await app.container.make('auth.manager');
+  auth = await app.container.make("auth.manager");
 });
-export { auth as default };
+export {
+  auth as default
+};
+//# sourceMappingURL=auth.js.map

package/build/services/auth.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../services/auth.ts"],"sourcesContent":["/*\n * @adonisjs/auth\n *\n * (c) AdonisJS\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\nimport app from '@adonisjs/core/services/app'\nimport { AuthService } from '../src/types.js'\n\nlet auth: AuthService\n\n/**\n * Returns a singleton instance of the Auth manager class\n */\nawait app.booted(async () => {\n  auth = await app.container.make('auth.manager')\n})\n\nexport { auth as default }\n"],"mappings":";;;AASA,OAAO,SAAS;AAGhB,IAAI;AAKJ,MAAM,IAAI,OAAO,YAAY;AAC3B,SAAO,MAAM,IAAI,UAAU,KAAK,cAAc;AAChD,CAAC;","names":[]}

package/build/src/{auth/auth_manager.d.ts → auth_manager.d.ts}

@@ -7,7 +7,10 @@ import { AuthenticatorClient } from './authenticator_client.js';
  * guards from the config
  */
 export declare class AuthManager<KnownGuards extends Record<string, GuardFactory>> {
-    #private;
+    config: {
+        default: keyof KnownGuards;
+        guards: KnownGuards;
+    };
     /**
      * Name of the default guard
      */
@@ -17,11 +20,13 @@ export declare class AuthManager<KnownGuards extends Record<string, GuardFactory
         guards: KnownGuards;
     });
     /**
-     * Create an authenticator for a given HTTP request
+     * Create an authenticator for a given HTTP request. The authenticator
+     * is used to authenticated in incoming HTTP request
      */
     createAuthenticator(ctx: HttpContext): Authenticator<KnownGuards>;
     /**
-     * Creates an instance of the authenticator client
+     * Creates an instance of the authenticator client. The client is
+     * used to setup authentication state during testing.
      */
     createAuthenticatorClient(): AuthenticatorClient<KnownGuards>;
 }

package/build/src/authenticator.d.ts

@@ -0,0 +1,81 @@
+import type { HttpContext } from '@adonisjs/core/http';
+import type { GuardFactory } from './types.js';
+/**
+ * Authenticator is used to authenticate incoming HTTP requests
+ * using one or more known guards.
+ */
+export declare class Authenticator<KnownGuards extends Record<string, GuardFactory>> {
+    #private;
+    /**
+     * Name of the default guard
+     */
+    get defaultGuard(): keyof KnownGuards;
+    /**
+     * Reference to the guard using which the current
+     * request has been authenticated.
+     */
+    get authenticatedViaGuard(): keyof KnownGuards | undefined;
+    /**
+     * A boolean to know if the current request has been authenticated. The
+     * property returns false when "authenticate" or "authenticateUsing"
+     * methods are not used.
+     */
+    get isAuthenticated(): boolean;
+    /**
+     * Reference to the currently authenticated user. The property returns
+     * undefined when "authenticate" or "authenticateUsing" methods are
+     * not used.
+     */
+    get user(): {
+        [K in keyof KnownGuards]: ReturnType<KnownGuards[K]>['user'];
+    }[keyof KnownGuards];
+    /**
+     * Whether or not the authentication has been attempted during
+     * the current request. The property returns false when the
+     * "authenticate" or "authenticateUsing" methods are not
+     * used.
+     */
+    get authenticationAttempted(): boolean;
+    constructor(ctx: HttpContext, config: {
+        default: keyof KnownGuards;
+        guards: KnownGuards;
+    });
+    /**
+     * Returns an instance of the logged-in user or throws an
+     * exception
+     */
+    getUserOrFail(): {
+        [K in keyof KnownGuards]: ReturnType<ReturnType<KnownGuards[K]>['getUserOrFail']>;
+    }[keyof 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]>;
+    /**
+     * Authenticate current request using the default guard. Calling this
+     * method multiple times triggers multiple authentication with the
+     * guard.
+     */
+    authenticate(): Promise<{ [K in keyof KnownGuards]: ReturnType<ReturnType<KnownGuards[K]>["getUserOrFail"]>; }[keyof KnownGuards]>;
+    /**
+     * Silently attempt to authenticate the request using the default
+     * guard. Calling this method multiple times triggers multiple
+     * authentication with the guard.
+     */
+    check(): Promise<boolean>;
+    /**
+     * Authenticate the request using all of the mentioned guards
+     * or the default guard.
+     *
+     * The authentication process will stop after any of the mentioned
+     * guards is able to authenticate the request successfully.
+     *
+     * Otherwise, "E_UNAUTHORIZED_ACCESS" will be raised.
+     */
+    authenticateUsing(guards?: (keyof KnownGuards)[], options?: {
+        loginRoute?: string;
+    }): Promise<{
+        [K in keyof KnownGuards]: ReturnType<ReturnType<KnownGuards[K]>['getUserOrFail']>;
+    }[keyof KnownGuards]>;
+}

package/build/src/{auth/authenticator_client.d.ts → authenticator_client.d.ts}

@@ -1,9 +1,9 @@
 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
+ * 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;

package/build/src/{auth/define_config.d.ts → define_config.d.ts}

@@ -1,7 +1,5 @@
 import type { ConfigProvider } from '@adonisjs/core/types';
 import type { GuardConfigProvider, GuardFactory } from './types.js';
-import type { LucidUserProvider, DatabaseUserProvider } from './user_providers/main.js';
-import type { LucidAuthenticatable, LucidUserProviderOptions, DatabaseUserProviderOptions } from '../core/types.js';
 /**
  * Config resolved by the "defineConfig" method
  */
@@ -20,11 +18,3 @@ export declare function defineConfig<KnownGuards extends Record<string, GuardFac
     default: keyof KnownGuards;
     guards: KnownGuards;
 }): ConfigProvider<ResolvedAuthConfig<KnownGuards>>;
-/**
- * Providers helper to configure user providers for
- * finding users for authentication
- */
-export declare const providers: {
-    db: <RealUser extends Record<string, any>>(config: DatabaseUserProviderOptions<RealUser>) => ConfigProvider<DatabaseUserProvider<RealUser>>;
-    lucid: <RealUser extends LucidAuthenticatable>(config: LucidUserProviderOptions<RealUser>) => ConfigProvider<LucidUserProvider<RealUser>>;
-};

package/build/src/errors.d.ts

@@ -0,0 +1,105 @@
+/// <reference types="node" resolution-mode="require"/>
+import type { HttpContext } from '@adonisjs/core/http';
+/**
+ * The "E_UNAUTHORIZED_ACCESS" exception is raised when unable to
+ * authenticate an incoming HTTP request.
+ *
+ * The "error.guardDriverName" can be used to know the driver which
+ * raised the error.
+ */
+export declare const E_UNAUTHORIZED_ACCESS: {
+    new (message: string, options: {
+        redirectTo?: string;
+        guardDriverName: string;
+    }): {
+        /**
+         * Endpoint to redirect to. Only used by "session" driver
+         * renderer
+         */
+        redirectTo?: string | undefined;
+        /**
+         * Translation identifier. Can be customized
+         */
+        identifier: string;
+        /**
+         * The guard name reference that raised the exception. It allows
+         * us to customize the logic of handling the exception.
+         */
+        guardDriverName: string;
+        /**
+         * A collection of renderers to render the exception to a
+         * response.
+         *
+         * The collection is a key-value pair, where the key is
+         * the guard driver name and value is a factory function
+         * to respond to the request.
+         */
+        renderers: Record<string, (message: string, error: any, ctx: HttpContext) => Promise<void> | void>;
+        /**
+         * Returns the message to be sent in the HTTP response.
+         * Feel free to override this method and return a custom
+         * response.
+         */
+        getResponseMessage(error: any, ctx: HttpContext): string;
+        /**
+         * Converts exception to an HTTP response
+         */
+        handle(error: any, ctx: HttpContext): Promise<void>;
+        name: string;
+        help?: string | undefined;
+        code?: string | undefined;
+        status: number;
+        toString(): string;
+        readonly [Symbol.toStringTag]: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+    status: number;
+    code: string;
+    help?: string | undefined;
+    message?: string | undefined;
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};
+/**
+ * Exception is raised when user credentials are invalid
+ */
+export declare const E_INVALID_CREDENTIALS: {
+    new (message?: string | undefined, options?: (ErrorOptions & {
+        code?: string | undefined;
+        status?: number | undefined;
+    }) | undefined): {
+        /**
+         * Translation identifier. Can be customized
+         */
+        identifier: string;
+        /**
+         * Returns the message to be sent in the HTTP response.
+         * Feel free to override this method and return a custom
+         * response.
+         */
+        getResponseMessage(error: any, ctx: HttpContext): string;
+        /**
+         * Converts exception to an HTTP response
+         */
+        handle(error: any, ctx: HttpContext): Promise<void>;
+        name: string;
+        help?: string | undefined;
+        code?: string | undefined;
+        status: number;
+        toString(): string;
+        readonly [Symbol.toStringTag]: string;
+        message: string;
+        stack?: string | undefined;
+        cause?: unknown;
+    };
+    status: number;
+    code: string;
+    help?: string | undefined;
+    message?: string | undefined;
+    captureStackTrace(targetObject: object, constructorOpt?: Function | undefined): void;
+    prepareStackTrace?: ((err: Error, stackTraces: NodeJS.CallSite[]) => any) | undefined;
+    stackTraceLimit: number;
+};

package/build/src/{auth/middleware → middleware}/initialize_auth_middleware.d.ts

@@ -1,6 +1,7 @@
-import auth from '@adonisjs/auth/services/main';
 import type { HttpContext } from '@adonisjs/core/http';
 import type { NextFn } from '@adonisjs/core/types/http';
+import type { Authenticator } from '../authenticator.js';
+import type { Authenticators, GuardFactory } from '../types.js';
 /**
  * The "InitializeAuthMiddleware" is used to create a request
  * specific authenticator instance for every HTTP request.
@@ -13,6 +14,6 @@ export default class InitializeAuthMiddleware {
 }
 declare module '@adonisjs/core/http' {
     interface HttpContext {
-        auth: ReturnType<(typeof auth)['createAuthenticator']>;
+        auth: Authenticator<Authenticators extends Record<string, GuardFactory> ? Authenticators : never>;
     }
 }

package/build/src/middleware/initialize_auth_middleware.js

@@ -0,0 +1,17 @@
+import "../../chunk-CZCFTIBB.js";
+
+// src/middleware/initialize_auth_middleware.ts
+var InitializeAuthMiddleware = class {
+  async handle(ctx, next) {
+    const auth = await ctx.containerResolver.make("auth.manager");
+    ctx.auth = auth.createAuthenticator(ctx);
+    if ("view" in ctx) {
+      ctx.view.share({ auth: ctx.auth });
+    }
+    return next();
+  }
+};
+export {
+  InitializeAuthMiddleware as default
+};
+//# sourceMappingURL=initialize_auth_middleware.js.map

package/build/src/middleware/initialize_auth_middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/middleware/initialize_auth_middleware.ts"],"sourcesContent":["/// <reference types=\"@adonisjs/core/providers/edge_provider\" />\n\nimport type { HttpContext } from '@adonisjs/core/http'\nimport type { NextFn } from '@adonisjs/core/types/http'\n\nimport type { Authenticator } from '../authenticator.js'\nimport type { Authenticators, GuardFactory } from '../types.js'\n\n/**\n * The \"InitializeAuthMiddleware\" is used to create a request\n * specific authenticator instance for every HTTP request.\n *\n * This middleware does not protect routes from unauthenticated\n * users. Please use the \"auth\" middleware for that.\n */\nexport default class InitializeAuthMiddleware {\n  async handle(ctx: HttpContext, next: NextFn) {\n    const auth = await ctx.containerResolver.make('auth.manager')\n\n    /**\n     * Initialize the authenticator for the current HTTP\n     * request\n     */\n    ctx.auth = auth.createAuthenticator(ctx)\n\n    /**\n     * Sharing authenticator with templates\n     */\n    if ('view' in ctx) {\n      ctx.view.share({ auth: ctx.auth })\n    }\n\n    return next()\n  }\n}\n\ndeclare module '@adonisjs/core/http' {\n  export interface HttpContext {\n    auth: Authenticator<\n      Authenticators extends Record<string, GuardFactory> ? Authenticators : never\n    >\n  }\n}\n"],"mappings":";;;AAeA,IAAqB,2BAArB,MAA8C;AAAA,EAC5C,MAAM,OAAO,KAAkB,MAAc;AAC3C,UAAM,OAAO,MAAM,IAAI,kBAAkB,KAAK,cAAc;AAM5D,QAAI,OAAO,KAAK,oBAAoB,GAAG;AAKvC,QAAI,UAAU,KAAK;AACjB,UAAI,KAAK,MAAM,EAAE,MAAM,IAAI,KAAK,CAAC;AAAA,IACnC;AAEA,WAAO,KAAK;AAAA,EACd;AACF;","names":[]}

package/build/src/mixins/with_auth_finder.d.ts

@@ -0,0 +1,156 @@
+import type { Hash } from '@adonisjs/core/hash';
+import type { NormalizeConstructor } from '@adonisjs/core/types/helpers';
+/**
+ * Mixing to add user lookup and password verification methods
+ * on a model.
+ *
+ * Under the hood, this mixin defines following methods and hooks
+ *
+ * - beforeSave hook to hash user password
+ * - findForAuth method to find a user during authentication
+ * - verifyCredentials method to verify user credentials and prevent
+ *   timing attacks.
+ */
+export declare function withAuthFinder(hash: Hash, options: {
+    uids: string[];
+    passwordColumnName: string;
+}): <Model extends NormalizeConstructor<import("@adonisjs/lucid/types/model").LucidModel>>(superclass: Model) => {
+    new (...args: any[]): {
+        $attributes: import("@adonisjs/lucid/types/model").ModelObject;
+        $extras: import("@adonisjs/lucid/types/model").ModelObject;
+        $original: import("@adonisjs/lucid/types/model").ModelObject;
+        $preloaded: {
+            [relation: string]: import("@adonisjs/lucid/types/model").LucidRow | import("@adonisjs/lucid/types/model").LucidRow[];
+        };
+        $columns: undefined;
+        $sideloaded: import("@adonisjs/lucid/types/model").ModelObject;
+        $primaryKeyValue?: string | number | undefined;
+        $isPersisted: boolean;
+        $isNew: boolean;
+        $isLocal: boolean;
+        $dirty: import("@adonisjs/lucid/types/model").ModelObject;
+        $isDirty: boolean;
+        $isDeleted: boolean;
+        $options?: import("@adonisjs/lucid/types/model").ModelOptions | undefined;
+        $trx?: import("@adonisjs/lucid/types/database").TransactionClientContract | undefined;
+        $setOptionsAndTrx(options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined): void;
+        useTransaction(trx: import("@adonisjs/lucid/types/database").TransactionClientContract): any;
+        useConnection(connection: string): any;
+        $getQueryFor(action: "insert", client: import("@adonisjs/lucid/types/database").QueryClientContract): import("@adonisjs/lucid/types/querybuilder").InsertQueryBuilderContract<unknown[]>;
+        $getQueryFor(action: "delete" | "refresh" | "update", client: import("@adonisjs/lucid/types/database").QueryClientContract): import("@adonisjs/lucid/types/model").ModelQueryBuilderContract<import("@adonisjs/lucid/types/model").LucidModel, import("@adonisjs/lucid/types/model").LucidRow>;
+        $setAttribute(key: string, value: any): void;
+        $getAttribute(key: string): any;
+        $getAttributeFromCache(key: string, callback: (value: any) => any): any;
+        $hasRelated(key: string): boolean;
+        $setRelated(key: string, result: import("@adonisjs/lucid/types/querybuilder").OneOrMany<import("@adonisjs/lucid/types/model").LucidRow> | null): void;
+        $pushRelated(key: string, result: import("@adonisjs/lucid/types/querybuilder").OneOrMany<import("@adonisjs/lucid/types/model").LucidRow> | null): void;
+        $getRelated(key: string, defaultValue?: any): import("@adonisjs/lucid/types/querybuilder").OneOrMany<import("@adonisjs/lucid/types/model").LucidRow> | null | undefined;
+        $consumeAdapterResult(adapterResult: import("@adonisjs/lucid/types/model").ModelObject, sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined): void;
+        $hydrateOriginals(): void;
+        fill(value: Partial<{}>, allowExtraProperties?: boolean | undefined): any;
+        merge(value: Partial<{}>, allowExtraProperties?: boolean | undefined): any;
+        enableForceUpdate(): any;
+        save(): Promise<any>;
+        delete(): Promise<void>;
+        refresh(): Promise<any>;
+        load: import("@adonisjs/lucid/types/model").LucidRowPreload<any>;
+        preload: import("@adonisjs/lucid/types/model").LucidRowPreload<any>;
+        loadAggregate: <Self extends any, Name extends import("@adonisjs/lucid/types/relations").ExtractModelRelations<Self>, RelatedBuilder = Self[Name] extends import("@adonisjs/lucid/types/relations").ModelRelations<import("@adonisjs/lucid/types/model").LucidModel, import("@adonisjs/lucid/types/model").LucidModel> ? Self[Name]["subQuery"] : never>(name: Name, callback: (builder: RelatedBuilder) => void) => import("@adonisjs/lucid/types/model").LazyLoadAggregatesContract<Self>;
+        loadCount: <Self_1 extends any, Name_1 extends import("@adonisjs/lucid/types/relations").ExtractModelRelations<Self_1>, RelatedBuilder_1 = Self_1[Name_1] extends import("@adonisjs/lucid/types/relations").ModelRelations<import("@adonisjs/lucid/types/model").LucidModel, import("@adonisjs/lucid/types/model").LucidModel> ? Self_1[Name_1]["subQuery"] : never>(name: Name_1, callback?: ((builder: RelatedBuilder_1) => void) | undefined) => import("@adonisjs/lucid/types/model").LazyLoadAggregatesContract<Self_1>;
+        serializeAttributes(fields?: import("@adonisjs/lucid/types/model").CherryPickFields | undefined, raw?: boolean | undefined): import("@adonisjs/lucid/types/model").ModelObject;
+        serializeComputed(fields?: import("@adonisjs/lucid/types/model").CherryPickFields | undefined): import("@adonisjs/lucid/types/model").ModelObject;
+        serializeRelations(fields: undefined, raw: true): {
+            [key: string]: import("@adonisjs/lucid/types/model").LucidRow | import("@adonisjs/lucid/types/model").LucidRow[];
+        };
+        serializeRelations(cherryPick: {
+            [relation: string]: import("@adonisjs/lucid/types/model").CherryPick;
+        } | undefined, raw: false | undefined): import("@adonisjs/lucid/types/model").ModelObject;
+        serializeRelations(cherryPick?: {
+            [relation: string]: import("@adonisjs/lucid/types/model").CherryPick;
+        } | undefined, raw?: boolean | undefined): import("@adonisjs/lucid/types/model").ModelObject;
+        serialize(cherryPick?: import("@adonisjs/lucid/types/model").CherryPick | undefined): import("@adonisjs/lucid/types/model").ModelObject;
+        toObject(): import("@adonisjs/lucid/types/model").ModelObject;
+        toJSON(): import("@adonisjs/lucid/types/model").ModelObject;
+        related<Name_2 extends undefined>(relation: Name_2): any[Name_2] extends import("@adonisjs/lucid/types/relations").ModelRelations<import("@adonisjs/lucid/types/model").LucidModel, import("@adonisjs/lucid/types/model").LucidModel> ? any[Name_2]["client"] : never;
+    };
+    /**
+     * Hook to verify user password when creating or updating
+     * the user model.
+     */
+    hashPassword<T extends any & Model>(this: T, user: InstanceType<T>): Promise<void>;
+    /**
+     * Finds the user for authentication via "verifyCredentials".
+     * Feel free to override this method customize the user
+     * lookup behavior.
+     */
+    findForAuth<T_1 extends any & Model>(this: T_1, uids: string[], value: string): Promise<InstanceType<T_1> | null>;
+    /**
+     * Find a user by uid and verify their password. This method is
+     * safe from timing attacks.
+     */
+    verifyCredentials<T_2 extends any & Model>(this: T_2, uid: string, password: string): Promise<InstanceType<T_2>>;
+    readonly booted: boolean;
+    find: <T_3 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_3, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_3> | null>;
+    $columnsDefinitions: Map<string, import("@adonisjs/lucid/types/model").ModelColumnOptions>;
+    $relationsDefinitions: Map<string, import("@adonisjs/lucid/types/relations").RelationshipsContract>;
+    $computedDefinitions: Map<string, import("@adonisjs/lucid/types/model").ComputedOptions>;
+    primaryKey: string;
+    connection?: string | undefined;
+    namingStrategy: import("@adonisjs/lucid/types/model").NamingStrategyContract;
+    table: string;
+    selfAssignPrimaryKey: boolean;
+    $adapter: import("@adonisjs/lucid/types/model").AdapterContract;
+    useAdapter: (adapter: import("@adonisjs/lucid/types/model").AdapterContract) => void;
+    $hooks: import("@poppinss/hooks").default<any>;
+    $keys: {
+        attributesToColumns: import("@adonisjs/lucid/types/model").ModelKeysContract;
+        attributesToSerialized: import("@adonisjs/lucid/types/model").ModelKeysContract;
+        columnsToAttributes: import("@adonisjs/lucid/types/model").ModelKeysContract;
+        columnsToSerialized: import("@adonisjs/lucid/types/model").ModelKeysContract;
+        serializedToColumns: import("@adonisjs/lucid/types/model").ModelKeysContract;
+        serializedToAttributes: import("@adonisjs/lucid/types/model").ModelKeysContract;
+    };
+    $createFromAdapterResult: <T_4 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_4, result?: import("@adonisjs/lucid/types/model").ModelObject | undefined, sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => InstanceType<T_4> | null;
+    $createMultipleFromAdapterResult: <T_5 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_5, results: import("@adonisjs/lucid/types/model").ModelObject[], sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => InstanceType<T_5>[];
+    $addColumn: (name: string, options: Partial<import("@adonisjs/lucid/types/model").ColumnOptions>) => import("@adonisjs/lucid/types/model").ColumnOptions;
+    $hasColumn: (name: string) => boolean;
+    $getColumn: (name: string) => import("@adonisjs/lucid/types/model").ModelColumnOptions | undefined;
+    $addComputed: (name: string, options: Partial<import("@adonisjs/lucid/types/model").ComputedOptions>) => import("@adonisjs/lucid/types/model").ComputedOptions;
+    $hasComputed: (name: string) => boolean;
+    $getComputed: (name: string) => import("@adonisjs/lucid/types/model").ComputedOptions | undefined;
+    $addRelation: (name: string, type: "hasOne" | "hasMany" | "belongsTo" | "manyToMany" | "hasManyThrough", relatedModel: () => import("@adonisjs/lucid/types/model").LucidModel, options: import("@adonisjs/lucid/types/model").ModelRelationOptions) => void;
+    $hasRelation: (name: string) => boolean;
+    $getRelation: {
+        <Model_1 extends import("@adonisjs/lucid/types/model").LucidModel, Name_3 extends import("@adonisjs/lucid/types/relations").ExtractModelRelations<InstanceType<Model_1>>>(this: Model_1, name: Name_3): InstanceType<Model_1>[Name_3] extends import("@adonisjs/lucid/types/relations").ModelRelations<import("@adonisjs/lucid/types/model").LucidModel, import("@adonisjs/lucid/types/model").LucidModel> ? InstanceType<Model_1>[Name_3]["client"]["relation"] : import("@adonisjs/lucid/types/relations").RelationshipsContract;
+        <Model_2 extends import("@adonisjs/lucid/types/model").LucidModel>(this: Model_2, name: string): import("@adonisjs/lucid/types/relations").RelationshipsContract;
+    };
+    $defineProperty: <Model_3 extends import("@adonisjs/lucid/types/model").LucidModel, Prop extends keyof Model_3>(this: Model_3, propertyName: Prop, defaultValue: Model_3[Prop], strategy: "inherit" | "define" | ((value: Model_3[Prop]) => Model_3[Prop])) => void;
+    boot: () => void;
+    before: {
+        <Model_4 extends import("@adonisjs/lucid/types/model").LucidModel, Event_1 extends "find" | "fetch">(this: Model_4, event: Event_1, handler: import("@adonisjs/lucid/types/model").HooksHandler<import("@adonisjs/lucid/types/model").ModelQueryBuilderContract<Model_4, InstanceType<Model_4>>, Event_1>): void;
+        <Model_5 extends import("@adonisjs/lucid/types/model").LucidModel>(this: Model_5, event: "paginate", handler: import("@adonisjs/lucid/types/model").HooksHandler<[import("@adonisjs/lucid/types/model").ModelQueryBuilderContract<Model_5, InstanceType<Model_5>>, import("@adonisjs/lucid/types/model").ModelQueryBuilderContract<Model_5, InstanceType<Model_5>>], "paginate">): void;
+        <Model_6 extends import("@adonisjs/lucid/types/model").LucidModel, Event_2 extends import("@adonisjs/lucid/types/model").EventsList>(this: Model_6, event: Event_2, handler: import("@adonisjs/lucid/types/model").HooksHandler<InstanceType<Model_6>, Event_2>): void;
+    };
+    after: {
+        <Model_7 extends import("@adonisjs/lucid/types/model").LucidModel>(this: Model_7, event: "fetch", handler: import("@adonisjs/lucid/types/model").HooksHandler<InstanceType<Model_7>[], "fetch">): void;
+        <Model_8 extends import("@adonisjs/lucid/types/model").LucidModel>(this: Model_8, event: "paginate", handler: import("@adonisjs/lucid/types/model").HooksHandler<import("@adonisjs/lucid/types/model").ModelPaginatorContract<InstanceType<Model_8>>, "paginate">): void;
+        <Model_9 extends import("@adonisjs/lucid/types/model").LucidModel, Event_3 extends import("@adonisjs/lucid/types/model").EventsList>(this: Model_9, event: Event_3, handler: import("@adonisjs/lucid/types/model").HooksHandler<InstanceType<Model_9>, Event_3>): void;
+    };
+    create: <T_6 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_6, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_6>>>, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_6>>;
+    createMany: <T_7 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_7, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_7>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_7>[]>;
+    findOrFail: <T_8 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_8, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_8>>;
+    findBy: <T_9 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_9, key: string, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_9> | null>;
+    findByOrFail: <T_10 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_10, key: string, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_10>>;
+    first: <T_11 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_11, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_11> | null>;
+    firstOrFail: <T_12 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_12, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_12>>;
+    findMany: <T_13 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_13, value: any[], options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_13>[]>;
+    firstOrNew: <T_14 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_14, searchPayload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_14>>>, savePayload?: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_14>>> | undefined, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_14>>;
+    firstOrCreate: <T_15 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_15, searchPayload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_15>>>, savePayload?: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_15>>> | undefined, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_15>>;
+    updateOrCreate: <T_16 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_16, searchPayload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_16>>>, updatePayload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_16>>>, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_16>>;
+    fetchOrNewUpMany: <T_17 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_17, predicate: keyof import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_17>> | (keyof import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_17>>)[], payload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_17>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_17>[]>;
+    fetchOrCreateMany: <T_18 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_18, predicate: keyof import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_18>> | (keyof import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_18>>)[], payload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_18>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_18>[]>;
+    updateOrCreateMany: <T_19 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_19, predicate: keyof import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_19>> | (keyof import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_19>>)[], payload: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_19>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_19>[]>;
+    all: <T_20 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_20, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_20>[]>;
+    query: <Model_10 extends import("@adonisjs/lucid/types/model").LucidModel, Result = InstanceType<Model_10>>(this: Model_10, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => import("@adonisjs/lucid/types/model").ModelQueryBuilderContract<Model_10, Result>;
+    truncate: (cascade?: boolean | undefined) => Promise<void>;
+} & Model;

package/build/src/{auth/plugins → plugins}/japa/api_client.d.ts

@@ -4,16 +4,16 @@ import type { Authenticators, GuardContract, GuardFactory } from '../../types.js
 declare module '@japa/api-client' {
     interface ApiRequest {
         authData: {
-            guard: string;
-            user: unknown;
+            guard: keyof Authenticators | '__default__';
+            args: [unknown, ...any[]];
         };
         /**
-         * Login a user using the default authentication
-         * guard when making an API call
+         * 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;
+        loginAs(...args: {
+            [K in keyof Authenticators]: Authenticators[K] extends GuardFactory ? ReturnType<Authenticators[K]> extends GuardContract<unknown> ? Parameters<ReturnType<Authenticators[K]>['authenticateAsClient']> : never : never;
+        }[keyof Authenticators]): this;
         /**
          * Define the authentication guard for login
          */
@@ -21,7 +21,7 @@ declare module '@japa/api-client' {
             /**
              * 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;
+            loginAs(...args: ReturnType<Authenticators[K]> extends GuardContract<any> ? Parameters<ReturnType<Authenticators[K]>['authenticateAsClient']> : never): Self;
         };
     }
 }

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

@@ -0,0 +1,59 @@
+import {
+  debug_default
+} from "../../../chunk-3HZHOWKL.js";
+import "../../../chunk-CZCFTIBB.js";
+
+// src/plugins/japa/api_client.ts
+import { ApiClient, ApiRequest } from "@japa/api-client";
+var authApiClient = (app) => {
+  const pluginFn = function() {
+    debug_default("installing auth api client plugin");
+    ApiRequest.macro("loginAs", function(user, ...args) {
+      this.authData = {
+        guard: "__default__",
+        args: [user, ...args]
+      };
+      return this;
+    });
+    ApiRequest.macro("withGuard", function(guard) {
+      return {
+        loginAs: (...args) => {
+          this.authData = {
+            guard,
+            args
+          };
+          return this;
+        }
+      };
+    });
+    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.args
+      );
+      if (requestData.headers) {
+        debug_default("defining headers with api client request %O", requestData.headers);
+        request.headers(requestData.headers);
+      }
+      if (requestData.session) {
+        debug_default("defining session with api client request %O", requestData.session);
+        request.withSession(requestData.session);
+      }
+      if (requestData.cookies) {
+        debug_default("defining session with api client request %O", requestData.session);
+        request.cookies(requestData.cookies);
+      }
+    });
+  };
+  return pluginFn;
+};
+export {
+  authApiClient
+};
+//# sourceMappingURL=api_client.js.map

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

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/plugins/japa/api_client.ts"],"sourcesContent":["/*\n * @adonisjs/auth\n *\n * (c) AdonisJS\n *\n * For the full copyright and license information, please view the LICENSE\n * file that was distributed with this source code.\n */\n\n/// <reference types=\"@adonisjs/session/plugins/api_client\" />\n\nimport type { PluginFn } from '@japa/runner/types'\nimport { ApiClient, ApiRequest } from '@japa/api-client'\nimport type { ApplicationService } from '@adonisjs/core/types'\n\nimport debug from '../../debug.js'\nimport type { Authenticators, GuardContract, GuardFactory } from '../../types.js'\n\ndeclare module '@japa/api-client' {\n  export interface ApiRequest {\n    authData: {\n      guard: keyof Authenticators | '__default__'\n      args: [unknown, ...any[]]\n    }\n\n    /**\n     * Login a user using the default authentication guard\n     * when making an API call\n     */\n    loginAs(\n      ...args: {\n        [K in keyof Authenticators]: Authenticators[K] extends GuardFactory\n          ? ReturnType<Authenticators[K]> extends GuardContract<unknown>\n            ? Parameters<ReturnType<Authenticators[K]>['authenticateAsClient']>\n            : never\n          : never\n      }[keyof Authenticators]\n    ): this\n\n    /**\n     * Define the authentication guard for login\n     */\n    withGuard<K extends keyof Authenticators, Self extends ApiRequest>(\n      this: Self,\n      guard: K\n    ): {\n      /**\n       * Login a user using a specific auth guard\n       */\n      loginAs(\n        ...args: ReturnType<Authenticators[K]> extends GuardContract<any>\n          ? Parameters<ReturnType<Authenticators[K]>['authenticateAsClient']>\n          : never\n      ): Self\n    }\n  }\n}\n\n/**\n * Auth API client to authenticate users when making\n * HTTP requests using the Japa API client\n */\nexport const authApiClient = (app: ApplicationService) => {\n  const pluginFn: PluginFn = function () {\n    debug('installing auth api client plugin')\n\n    /**\n     * Login a user using the default authentication guard\n     * when making an API call\n     */\n    ApiRequest.macro('loginAs', function (this: ApiRequest, user, ...args: any[]) {\n      this.authData = {\n        guard: '__default__',\n        args: [user, ...args],\n      }\n      return this\n    })\n\n    /**\n     * Define the authentication guard for login\n     */\n    ApiRequest.macro('withGuard', function <\n      K extends keyof Authenticators,\n      Self extends ApiRequest,\n    >(this: Self, guard: K) {\n      return {\n        loginAs: (...args) => {\n          this.authData = {\n            guard,\n            args: args,\n          }\n          return this\n        },\n      }\n    })\n\n    /**\n     * Hook into the request and login the user\n     */\n    ApiClient.setup(async (request) => {\n      const auth = await app.container.make('auth.manager')\n      const authData = request['authData']\n      if (!authData) {\n        return\n      }\n\n      const client = auth.createAuthenticatorClient()\n      const guard = authData.guard === '__default__' ? client.use() : client.use(authData.guard)\n      const requestData = await (guard as GuardContract<unknown>).authenticateAsClient(\n        ...authData.args\n      )\n\n      /* c8 ignore next 13 */\n      if (requestData.headers) {\n        debug('defining headers with api client request %O', requestData.headers)\n        request.headers(requestData.headers)\n      }\n      if (requestData.session) {\n        debug('defining session with api client request %O', requestData.session)\n        request.withSession(requestData.session)\n      }\n      if (requestData.cookies) {\n        debug('defining session with api client request %O', requestData.session)\n        request.cookies(requestData.cookies)\n      }\n    })\n  }\n\n  return pluginFn\n}\n"],"mappings":";;;;;;AAYA,SAAS,WAAW,kBAAkB;AAkD/B,IAAM,gBAAgB,CAAC,QAA4B;AACxD,QAAM,WAAqB,WAAY;AACrC,kBAAM,mCAAmC;AAMzC,eAAW,MAAM,WAAW,SAA4B,SAAS,MAAa;AAC5E,WAAK,WAAW;AAAA,QACd,OAAO;AAAA,QACP,MAAM,CAAC,MAAM,GAAG,IAAI;AAAA,MACtB;AACA,aAAO;AAAA,IACT,CAAC;AAKD,eAAW,MAAM,aAAa,SAGhB,OAAU;AACtB,aAAO;AAAA,QACL,SAAS,IAAI,SAAS;AACpB,eAAK,WAAW;AAAA,YACd;AAAA,YACA;AAAA,UACF;AACA,iBAAO;AAAA,QACT;AAAA,MACF;AAAA,IACF,CAAC;AAKD,cAAU,MAAM,OAAO,YAAY;AACjC,YAAM,OAAO,MAAM,IAAI,UAAU,KAAK,cAAc;AACpD,YAAM,WAAW,QAAQ,UAAU;AACnC,UAAI,CAAC,UAAU;AACb;AAAA,MACF;AAEA,YAAM,SAAS,KAAK,0BAA0B;AAC9C,YAAM,QAAQ,SAAS,UAAU,gBAAgB,OAAO,IAAI,IAAI,OAAO,IAAI,SAAS,KAAK;AACzF,YAAM,cAAc,MAAO,MAAiC;AAAA,QAC1D,GAAG,SAAS;AAAA,MACd;AAGA,UAAI,YAAY,SAAS;AACvB,sBAAM,+CAA+C,YAAY,OAAO;AACxE,gBAAQ,QAAQ,YAAY,OAAO;AAAA,MACrC;AACA,UAAI,YAAY,SAAS;AACvB,sBAAM,+CAA+C,YAAY,OAAO;AACxE,gBAAQ,YAAY,YAAY,OAAO;AAAA,MACzC;AACA,UAAI,YAAY,SAAS;AACvB,sBAAM,+CAA+C,YAAY,OAAO;AACxE,gBAAQ,QAAQ,YAAY,OAAO;AAAA,MACrC;AAAA,IACF,CAAC;AAAA,EACH;AAEA,SAAO;AACT;","names":[]}

package/build/src/{auth/plugins → plugins}/japa/browser_client.d.ts

@@ -4,13 +4,12 @@ import type { Authenticators, GuardContract, GuardFactory } from '../../types.js
 declare module 'playwright' {
     interface BrowserContext {
         /**
-         * Login a user using the default authentication
-         * guard when using the browser context to
-         * make page visits
+         * Login a user using the default authentication guard when
+         * using the browser context to make page visits
          */
-        loginAs(user: {
-            [K in keyof Authenticators]: Authenticators[K] extends GuardFactory ? ReturnType<Authenticators[K]> extends GuardContract<infer A> ? A : never : never;
-        }): Promise<void>;
+        loginAs(...args: {
+            [K in keyof Authenticators]: Authenticators[K] extends GuardFactory ? ReturnType<Authenticators[K]> extends GuardContract<unknown> ? Parameters<ReturnType<Authenticators[K]>['authenticateAsClient']> : never : never;
+        }[keyof Authenticators]): Promise<void>;
         /**
          * Define the authentication guard for login
          */
@@ -18,8 +17,12 @@ declare module 'playwright' {
             /**
              * Login a user using a specific auth guard
              */
-            loginAs(user: Authenticators[K] extends GuardFactory ? ReturnType<Authenticators[K]> extends GuardContract<infer A> ? A : never : never): Promise<void>;
+            loginAs(...args: ReturnType<Authenticators[K]> extends GuardContract<unknown> ? Parameters<ReturnType<Authenticators[K]>['authenticateAsClient']> : never): Promise<void>;
         };
     }
 }
+/**
+ * Browser API client to authenticate users when making
+ * HTTP requests using the Japa Browser client.
+ */
 export declare const authBrowserClient: (app: ApplicationService) => PluginFn;