@adonisjs/auth 9.0.0-8 → 9.0.0

package/build/factories/lucid_user_provider.d.ts

@@ -1,28 +0,0 @@
-import { BaseModel } from '@adonisjs/lucid/orm';
-import { PROVIDER_REAL_USER } from '../src/auth/symbols.js';
-import { BaseLucidUserProvider } from '../src/core/user_providers/lucid.js';
-import type { LucidAuthenticatable, LucidUserProviderOptions } from '../src/core/types.js';
-export declare class FactoryUser extends BaseModel {
-    static table: string;
-    static createWithDefaults(attributes?: {
-        email?: string;
-        password?: string | null;
-        username?: string;
-    }): Promise<FactoryUser>;
-    id: number;
-    username: string;
-    email: string;
-    password: string | null;
-    verifyPasswordForAuth(plainTextPassword: string): Promise<boolean>;
-}
-export declare class TestLucidUserProvider<UserModel extends LucidAuthenticatable> extends BaseLucidUserProvider<UserModel> {
-    [PROVIDER_REAL_USER]: InstanceType<UserModel>;
-}
-/**
- * Creates an instance of the LucidUserProvider with sane
- * defaults for testing
- */
-export declare class LucidUserProviderFactory {
-    createForModel<Model extends LucidAuthenticatable>(options: LucidUserProviderOptions<Model>): TestLucidUserProvider<Model>;
-    create(): TestLucidUserProvider<typeof FactoryUser>;
-}

package/build/factories/lucid_user_provider.js

@@ -1,68 +0,0 @@
-/*
- * @adonisjs/auth
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-import { Hash } from '@adonisjs/core/hash';
-import { BaseModel, column } from '@adonisjs/lucid/orm';
-import { Scrypt } from '@adonisjs/core/hash/drivers/scrypt';
-import { PROVIDER_REAL_USER } from '../src/auth/symbols.js';
-import { BaseLucidUserProvider } from '../src/core/user_providers/lucid.js';
-export class FactoryUser extends BaseModel {
-    static table = 'users';
-    static createWithDefaults(attributes) {
-        return this.create({
-            email: 'foo@bar.com',
-            username: 'foo',
-            password: 'secret',
-            ...attributes,
-        });
-    }
-    async verifyPasswordForAuth(plainTextPassword) {
-        return new Hash(new Scrypt({})).verify(this.password, plainTextPassword);
-    }
-}
-__decorate([
-    column()
-], FactoryUser.prototype, "id", void 0);
-__decorate([
-    column()
-], FactoryUser.prototype, "username", void 0);
-__decorate([
-    column()
-], FactoryUser.prototype, "email", void 0);
-__decorate([
-    column()
-], FactoryUser.prototype, "password", void 0);
-export class TestLucidUserProvider extends BaseLucidUserProvider {
-}
-/**
- * Creates an instance of the LucidUserProvider with sane
- * defaults for testing
- */
-export class LucidUserProviderFactory {
-    createForModel(options) {
-        return new TestLucidUserProvider({
-            ...options,
-        });
-    }
-    create() {
-        return this.createForModel({
-            model: async () => {
-                return {
-                    default: FactoryUser,
-                };
-            },
-            uids: ['email', 'username'],
-        });
-    }
-}

package/build/factories/main.d.ts

@@ -1,4 +0,0 @@
-export { SessionGuardFactory } from './session_guard_factory.js';
-export { DatabaseUserProviderFactory, TestDatabaseUserProvider } from './database_user_provider.js';
-export { FactoryUser, LucidUserProviderFactory, TestLucidUserProvider, } from './lucid_user_provider.js';
-export { TestToken, TestDatabaseTokenProvider, DatabaseTokenProviderFactory, } from './database_token_factory.js';

package/build/factories/main.js

@@ -1,12 +0,0 @@
-/*
- * @adonisjs/auth
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-export { SessionGuardFactory } from './session_guard_factory.js';
-export { DatabaseUserProviderFactory, TestDatabaseUserProvider } from './database_user_provider.js';
-export { FactoryUser, LucidUserProviderFactory, TestLucidUserProvider, } from './lucid_user_provider.js';
-export { TestToken, TestDatabaseTokenProvider, DatabaseTokenProviderFactory, } from './database_token_factory.js';

package/build/factories/session_guard_factory.d.ts

@@ -1,13 +0,0 @@
-import type { HttpContext } from '@adonisjs/core/http';
-import { SessionGuard } from '../src/guards/session/guard.js';
-import type { SessionGuardConfig, SessionUserProviderContract } from '../src/guards/session/types.js';
-import { FactoryUser, TestLucidUserProvider } from './lucid_user_provider.js';
-/**
- * Exposes the API to create a session guard for testing. Under
- * the hood configures Lucid models for looking up users
- */
-export declare class SessionGuardFactory {
-    #private;
-    merge(config: SessionGuardConfig): this;
-    create<UserProvider extends SessionUserProviderContract<unknown> = TestLucidUserProvider<typeof FactoryUser>>(ctx: HttpContext, provider?: UserProvider): SessionGuard<TestLucidUserProvider<typeof FactoryUser> | UserProvider>;
-}

package/build/factories/session_guard_factory.js

@@ -1,24 +0,0 @@
-/*
- * @adonisjs/auth
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { SessionGuard } from '../src/guards/session/guard.js';
-import { LucidUserProviderFactory, } from './lucid_user_provider.js';
-/**
- * Exposes the API to create a session guard for testing. Under
- * the hood configures Lucid models for looking up users
- */
-export class SessionGuardFactory {
-    #config = { rememberMeTokenAge: '5y' };
-    merge(config) {
-        this.#config = config;
-        return this;
-    }
-    create(ctx, provider) {
-        return new SessionGuard('web', this.#config, ctx, provider || new LucidUserProviderFactory().create());
-    }
-}

package/build/src/auth/auth_manager.js

@@ -1,41 +0,0 @@
-/*
- * @adonisjs/auth
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * 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
- */
-export class AuthManager {
-    /**
-     * Registered guards
-     */
-    #config;
-    /**
-     * Name of the default guard
-     */
-    get defaultGuard() {
-        return this.#config.default;
-    }
-    constructor(config) {
-        this.#config = config;
-    }
-    /**
-     * Create an authenticator for a given HTTP request
-     */
-    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.d.ts

@@ -1,63 +0,0 @@
-import type { HttpContext } from '@adonisjs/core/http';
-import type { GuardFactory } from './types.js';
-/**
- * Authenticator is an HTTP request specific implementation for using
- * guards to login users and authenticate requests.
- */
-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
-     */
-    get isAuthenticated(): boolean;
-    /**
-     * Reference to the currently authenticated user
-     */
-    get user(): {
-        [K in keyof KnownGuards]: ReturnType<KnownGuards[K]>['user'];
-    }[keyof KnownGuards];
-    /**
-     * Whether or not the authentication has been attempted
-     * during the current request
-     */
-    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 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, "AuthenticationException" will be raised.
-     */
-    authenticateUsing(guards?: (keyof KnownGuards)[], options?: {
-        loginRoute?: string;
-    }): Promise<boolean>;
-}

package/build/src/auth/authenticator.js

@@ -1,129 +0,0 @@
-/*
- * @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 { AuthenticationException } from './errors.js';
-/**
- * Authenticator is an HTTP request specific implementation for using
- * guards to login users and authenticate requests.
- */
-export class Authenticator {
-    /**
-     * Name of the guard using which the request has
-     * been authenticated
-     */
-    #authenticatedViaGuard;
-    /**
-     * Reference to HTTP context
-     */
-    #ctx;
-    /**
-     * Registered guards
-     */
-    #config;
-    /**
-     * Cache of guards created during the HTTP request
-     */
-    #guardsCache = {};
-    /**
-     * Name of the default guard
-     */
-    get defaultGuard() {
-        return this.#config.default;
-    }
-    /**
-     * Reference to the guard using which the current
-     * request has been authenticated.
-     */
-    get authenticatedViaGuard() {
-        return this.#authenticatedViaGuard;
-    }
-    /**
-     * A boolean to know if the current request has
-     * been authenticated
-     */
-    get isAuthenticated() {
-        return this.use(this.#authenticatedViaGuard || this.defaultGuard).isAuthenticated;
-    }
-    /**
-     * Reference to the currently authenticated user
-     */
-    get user() {
-        return this.use(this.#authenticatedViaGuard || this.defaultGuard).user;
-    }
-    /**
-     * Whether or not the authentication has been attempted
-     * during the current request
-     */
-    get authenticationAttempted() {
-        return this.use(this.#authenticatedViaGuard || this.defaultGuard).authenticationAttempted;
-    }
-    constructor(ctx, config) {
-        this.#ctx = ctx;
-        this.#config = config;
-        debug('creating authenticator. config %O', this.#config);
-    }
-    /**
-     * Returns an instance of the logged-in user or throws an
-     * exception
-     */
-    getUserOrFail() {
-        return this.use(this.#authenticatedViaGuard || this.defaultGuard).getUserOrFail();
-    }
-    /**
-     * 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(this.#ctx);
-        this.#guardsCache[guardToUse] = guardInstance;
-        return guardInstance;
-    }
-    /**
-     * 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, "AuthenticationException" will be raised.
-     */
-    async authenticateUsing(guards, options) {
-        const guardsToUse = guards || [this.defaultGuard];
-        let lastUsedGuardDriver;
-        for (let guardName of guardsToUse) {
-            debug('attempting to authenticate using guard "%s"', guardName);
-            const guard = this.use(guardName);
-            lastUsedGuardDriver = guard.driverName;
-            if (await guard.check()) {
-                this.#authenticatedViaGuard = guardName;
-                return true;
-            }
-        }
-        throw new AuthenticationException('Unauthorized access', {
-            code: 'E_UNAUTHORIZED_ACCESS',
-            guardDriverName: lastUsedGuardDriver,
-            redirectTo: options?.loginRoute,
-        });
-    }
-}

package/build/src/auth/authenticator_client.js

@@ -1,59 +0,0 @@
-/*
- * @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/debug.js

@@ -1,10 +0,0 @@
-/*
- * @adonisjs/auth
- *
- * (c) AdonisJS
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-import { debuglog } from 'node:util';
-export default debuglog('adonisjs:auth');

package/build/src/auth/define_config.js

@@ -1,54 +0,0 @@
-/*
- * @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/lucid/database_provider" />
-import { configProvider } from '@adonisjs/core';
-/**
- * Define configuration for the auth package. The function returns
- * a config provider that is invoked inside the auth service
- * provider
- */
-export function defineConfig(config) {
-    return configProvider.create(async (app) => {
-        const guardsList = Object.keys(config.guards);
-        const guards = {};
-        for (let guardName of guardsList) {
-            const guard = config.guards[guardName];
-            if (typeof guard === 'function') {
-                guards[guardName] = guard;
-            }
-            else {
-                guards[guardName] = await guard.resolver(guardName, app);
-            }
-        }
-        return {
-            default: config.default,
-            guards: guards,
-        };
-    });
-}
-/**
- * Providers helper to configure user providers for
- * finding users for authentication
- */
-export const providers = {
-    db(config) {
-        return configProvider.create(async (app) => {
-            const db = await app.container.make('lucid.db');
-            const hasher = await app.container.make('hash');
-            const { DatabaseUserProvider } = await import('./user_providers/main.js');
-            return new DatabaseUserProvider(db, hasher.use(), config);
-        });
-    },
-    lucid(config) {
-        return configProvider.create(async () => {
-            const { LucidUserProvider } = await import('./user_providers/main.js');
-            return new LucidUserProvider(config);
-        });
-    },
-};

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

@@ -1,90 +0,0 @@
-import { Exception } from '@poppinss/utils';
-import { HttpContext } from '@adonisjs/core/http';
-/**
- * Authentication exception is raised when an attempt is
- * made to authenticate an HTTP request
- */
-export declare class AuthenticationException extends Exception {
-    static status?: number | undefined;
-    static code?: string | undefined;
-    /**
-     * Raises authentication exception when session guard
-     * is unable to authenticate the request
-     */
-    static E_INVALID_AUTH_SESSION(): AuthenticationException;
-    /**
-     * Raises authentication exception when session guard
-     * is unable to authenticate the request
-     */
-    static E_INVALID_BASIC_AUTH_CREDENTIALS(): AuthenticationException;
-    guardDriverName: string;
-    redirectTo?: string;
-    identifier: string;
-    constructor(message: string, options: ErrorOptions & {
-        guardDriverName: string;
-        redirectTo?: string;
-        code?: string;
-        status?: number;
-    });
-    /**
-     * Returns the message to be sent in the HTTP response.
-     * Feel free to override this method and return a custom
-     * response.
-     */
-    getResponseMessage(error: AuthenticationException, ctx: HttpContext): string;
-    /**
-     * A collection of authentication exception
-     * 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: AuthenticationException, ctx: HttpContext) => Promise<void> | void>;
-    /**
-     * Self handles the auth exception and converts it to an
-     * HTTP response
-     */
-    handle(error: AuthenticationException, ctx: HttpContext): Promise<void>;
-}
-/**
- * Invalid credentials exception is raised when unable
- * to verify user credentials during login
- */
-export declare class InvalidCredentialsException extends Exception {
-    static message: string;
-    static code: string;
-    static status?: number | undefined;
-    static E_INVALID_CREDENTIALS(guardDriverName: string): InvalidCredentialsException;
-    guardDriverName: string;
-    identifier: string;
-    constructor(message: string, options: ErrorOptions & {
-        guardDriverName: string;
-        code?: string;
-        status?: number;
-    });
-    /**
-     * Returns the message to be sent in the HTTP response.
-     * Feel free to override this method and return a custom
-     * response.
-     */
-    getResponseMessage(error: InvalidCredentialsException, ctx: HttpContext): string;
-    /**
-     * A collection of authentication exception
-     * 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: InvalidCredentialsException, ctx: HttpContext) => Promise<void> | void>;
-    /**
-     * Self handles the auth exception and converts it to an
-     * HTTP response
-     */
-    handle(error: InvalidCredentialsException, ctx: HttpContext): Promise<void>;
-}