@adonisjs/auth 9.0.0-9 → 9.0.0

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

@@ -1,58 +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 { Token } from '../../core/token.js';
-/**
- * Remember me token represents a remember me token created
- * for a peristed login flow.
- */
-export class RememberMeToken extends Token {
-    userId;
-    series;
-    value;
-    hash;
-    /**
-     * Static name for the token to uniquely identify a
-     * bucket of tokens
-     */
-    type = 'remember_me_token';
-    constructor(
-    /**
-     * Reference to the user id for whom the token
-     * is generated
-     */
-    userId, 
-    /**
-     * Series is a random number stored inside the database as it is
-     */
-    series, 
-    /**
-     * Value is a random number only available at the time of issuing
-     * the token. Afterwards, the value is undefined.
-     */
-    value, 
-    /**
-     * Hash reference to the token hash
-     */
-    hash) {
-        super(series, value, hash);
-        this.userId = userId;
-        this.series = series;
-        this.value = value;
-        this.hash = hash;
-    }
-    /**
-     * Create remember me token instance for a user
-     */
-    static create(userId, expiry, size) {
-        const { series, value, hash } = this.seed(size);
-        const token = new RememberMeToken(userId, series, value, hash);
-        token.setExpiry(expiry);
-        return token;
-    }
-}

package/build/src/guards/session/token_providers/main.d.ts

@@ -1,33 +0,0 @@
-import { RememberMeToken } from '../token.js';
-import type { RememberMeProviderContract } from '../types.js';
-import { DatabaseTokenProvider } from '../../../core/token_providers/database.js';
-/**
- * Remember me token provider to persist tokens inside the database
- * using db query builder.
- */
-export declare class DatabaseRememberTokenProvider extends DatabaseTokenProvider<RememberMeToken> implements RememberMeProviderContract {
-    /**
-     * Prepares a token from the database result
-     */
-    protected prepareToken(dbRow: {
-        series: string;
-        user_id: string | number;
-        type: string;
-        token: string;
-        created_at: Date;
-        updated_at: Date;
-        expires_at: Date | null;
-    }): RememberMeToken;
-    /**
-     * Converts the remember me token into a database row
-     */
-    protected parseToken(token: RememberMeToken): {
-        series: string;
-        user_id: string | number;
-        type: string;
-        token: string;
-        created_at: Date;
-        updated_at: Date;
-        expires_at: Date | null;
-    };
-}

package/build/src/guards/session/token_providers/main.js

@@ -1,42 +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 { RememberMeToken } from '../token.js';
-import { DatabaseTokenProvider } from '../../../core/token_providers/database.js';
-/**
- * Remember me token provider to persist tokens inside the database
- * using db query builder.
- */
-export class DatabaseRememberTokenProvider extends DatabaseTokenProvider {
-    /**
-     * Prepares a token from the database result
-     */
-    prepareToken(dbRow) {
-        const token = new RememberMeToken(dbRow.user_id, dbRow.series, undefined, dbRow.token);
-        if (dbRow.expires_at) {
-            token.expiresAt = dbRow.expires_at;
-        }
-        token.createdAt = dbRow.created_at;
-        token.updatedAt = dbRow.updated_at;
-        return token;
-    }
-    /**
-     * Converts the remember me token into a database row
-     */
-    parseToken(token) {
-        return {
-            series: token.series,
-            user_id: token.userId,
-            type: token.type,
-            token: token.hash,
-            created_at: token.createdAt,
-            updated_at: token.updatedAt,
-            expires_at: token.expiresAt,
-        };
-    }
-}

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

@@ -1,104 +0,0 @@
-import type { Exception } from '@poppinss/utils';
-import type { RememberMeToken } from './token.js';
-import type { UserProviderContract, TokenProviderContract, DatabaseTokenProviderOptions } from '../../core/types.js';
-/**
- * The SessionUserProvider is used to lookup a user for session based authentication.
- */
-export interface SessionUserProviderContract<RealUser> extends UserProviderContract<RealUser> {
-}
-/**
- * The RememberMeProviderContract is used to persist and lookup tokens for
- * session based authentication with remember me option.
- */
-export interface RememberMeProviderContract extends TokenProviderContract<RememberMeToken> {
-}
-/**
- * Config accepted by the session guard
- */
-export type SessionGuardConfig = {
-    /**
-     * The expiry for the remember me cookie.
-     *
-     * Defaults to "5 years"
-     */
-    rememberMeTokenAge?: string | number;
-};
-/**
- * Events emitted by the session guard
- */
-export type SessionGuardEvents<User> = {
-    /**
-     * The event is emitted when the user credentials
-     * have been verified successfully.
-     */
-    'session_auth:credentials_verified': {
-        guardName: string;
-        uid: string;
-        user: User;
-    };
-    /**
-     * The event is emitted when unable to login the
-     * user.
-     */
-    'session_auth:login_failed': {
-        guardName: string;
-        error: Exception;
-        user: User | null;
-    };
-    /**
-     * The event is emitted when login is attempted for
-     * a given user.
-     */
-    'session_auth:login_attempted': {
-        guardName: string;
-        user: User;
-    };
-    /**
-     * The event is emitted when user has been logged in
-     * successfully
-     */
-    'session_auth:login_succeeded': {
-        guardName: string;
-        user: User;
-        sessionId: string;
-        rememberMeToken?: RememberMeToken;
-    };
-    /**
-     * Attempting to authenticate the user
-     */
-    'session_auth:authentication_attempted': {
-        guardName: string;
-        sessionId: string;
-    };
-    /**
-     * Authentication was successful
-     */
-    'session_auth:authentication_succeeded': {
-        guardName: string;
-        user: User;
-        sessionId: string;
-        rememberMeToken?: RememberMeToken;
-    };
-    /**
-     * Authentication failed
-     */
-    'session_auth:authentication_failed': {
-        guardName: string;
-        error: Exception;
-        sessionId: string;
-    };
-    /**
-     * The event is emitted when user has been logged out
-     * sucessfully
-     */
-    'session_auth:logged_out': {
-        guardName: string;
-        user: User | null;
-        sessionId: string;
-    };
-};
-/**
- * Options accepted by the database implementation of the
- * RememberMeProvider
- */
-export type DatabaseRememberMeProviderOptions = DatabaseTokenProviderOptions;

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

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

package/build/stubs/main.d.ts

@@ -1 +0,0 @@
-export declare const stubsRoot: string;

package/build/stubs/main.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 { getDirname } from '@poppinss/utils';
-export const stubsRoot = getDirname(import.meta.url);

package/build/stubs/middleware/auth_middleware.stub

@@ -1,30 +0,0 @@
-{{#var middlewareName = generators.middlewareName(entity.name)}}
-{{#var middlewareFileName = generators.middlewareFileName(entity.name)}}
-{{{
-  exports({ to: app.middlewarePath(entity.path, middlewareFileName) })
-}}}
-import type { HttpContext } from '@adonisjs/core/http'
-import type { NextFn } from '@adonisjs/core/types/http'
-import type { Authenticators } from '@adonisjs/auth/types'
-
-/**
- * Auth middleware is used authenticate HTTP requests and deny
- * access to unauthenticated users.
- */
-export default class {{ middlewareName }} {
-  /**
-   * The URL to redirect to, when authentication fails
-   */
-  redirectTo = '/login'
-
-  async handle(
-    ctx: HttpContext,
-    next: NextFn,
-    options: {
-      guards?: (keyof Authenticators)[]
-    } = {}
-  ) {
-    await ctx.auth.authenticateUsing(options.guards, { loginRoute: this.redirectTo })
-    return next()
-  }
-}

package/build/stubs/middleware/guest_middleware.stub

@@ -1,36 +0,0 @@
-{{#var middlewareName = generators.middlewareName(entity.name)}}
-{{#var middlewareFileName = generators.middlewareFileName(entity.name)}}
-{{{
-  exports({ to: app.middlewarePath(entity.path, middlewareFileName) })
-}}}
-import type { HttpContext } from '@adonisjs/core/http'
-import type { NextFn } from '@adonisjs/core/types/http'
-import type { Authenticators } from '@adonisjs/auth/types'
-
-/**
- * Guest middleware is used to deny access to routes that should
- * be accessed by unauthenticated users.
- *
- * For example, the login page should not be accessible if the user
- * is already logged-in
- */
-export default class {{ middlewareName }} {
-  /**
-   * The URL to redirect to when user is logged-in
-   */
-  redirectTo = '/'
-
-  async handle(
-    ctx: HttpContext,
-    next: NextFn,
-    options: { guards?: (keyof Authenticators)[] } = {}
-  ) {
-    for (let guard of options.guards || [ctx.auth.defaultGuard]) {
-      if (await ctx.auth.use(guard).check()) {
-        return ctx.response.redirect(this.redirectTo, true)
-      }
-    }
-
-    return next()
-  }
-}