@adonisjs/auth 8.2.2 → 9.0.0-0

package/build/src/Tokens/OpaqueToken/index.d.ts

@@ -1,46 +0,0 @@
-import { DateTime } from 'luxon';
-import { OpaqueTokenContract } from '@ioc:Adonis/Addons/Auth';
-/**
- * Opaque token represents a persisted token generated for a given user
- *
- * Calling `opaqueToken.toJSON()` will give you an object, that you can send back
- * as response to share the token with the client.
- */
-export declare class OpaqueToken implements OpaqueTokenContract<any> {
-    name: string;
-    token: string;
-    user: any;
-    /**
-     * The type of the token. Always set to bearer
-     */
-    type: "bearer";
-    /**
-     * The datetime in which the token will expire
-     */
-    expiresAt?: DateTime;
-    /**
-     * Time left until token gets expired
-     */
-    expiresIn?: number;
-    /**
-     * Any meta data attached to the token
-     */
-    meta: any;
-    /**
-     * Hash of the token saved inside the database. Make sure to never share
-     * this with the client
-     */
-    tokenHash: string;
-    constructor(name: string, // Name associated with the token
-    token: string, // The raw token value. Only available for the first time
-    user: any);
-    /**
-     * Shareable version of the token
-     */
-    toJSON(): {
-        expires_in?: number | undefined;
-        expires_at?: string | undefined;
-        type: "bearer";
-        token: string;
-    };
-}

package/build/src/Tokens/OpaqueToken/index.js

@@ -1,43 +0,0 @@
-"use strict";
-/*
- * @adonisjs/auth
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpaqueToken = void 0;
-/**
- * Opaque token represents a persisted token generated for a given user
- *
- * Calling `opaqueToken.toJSON()` will give you an object, that you can send back
- * as response to share the token with the client.
- */
-class OpaqueToken {
-    constructor(name, // Name associated with the token
-    token, // The raw token value. Only available for the first time
-    user // The user for which the token is generated
-    ) {
-        this.name = name;
-        this.token = token;
-        this.user = user;
-        /**
-         * The type of the token. Always set to bearer
-         */
-        this.type = 'bearer';
-    }
-    /**
-     * Shareable version of the token
-     */
-    toJSON() {
-        return {
-            type: this.type,
-            token: this.token,
-            ...(this.expiresAt ? { expires_at: this.expiresAt.toISO() || undefined } : {}),
-            ...(this.expiresIn ? { expires_in: this.expiresIn } : {}),
-        };
-    }
-}
-exports.OpaqueToken = OpaqueToken;

package/build/src/Tokens/ProviderToken/index.d.ts

@@ -1,23 +0,0 @@
-import { DateTime } from 'luxon';
-import { ProviderTokenContract } from '@ioc:Adonis/Addons/Auth';
-/**
- * Token returned and accepted by the token providers
- */
-export declare class ProviderToken implements ProviderTokenContract {
-    name: string;
-    tokenHash: string;
-    userId: string | number;
-    type: string;
-    /**
-     * Expiry date
-     */
-    expiresAt?: DateTime;
-    /**
-     * All other token details
-     */
-    meta?: any;
-    constructor(name: string, // Name associated with the token
-    tokenHash: string, // The hash to persist
-    userId: string | number, // The user for which the token is generated
-    type: string);
-}

package/build/src/Tokens/ProviderToken/index.js

@@ -1,27 +0,0 @@
-"use strict";
-/*
- * @adonisjs/auth
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProviderToken = void 0;
-/**
- * Token returned and accepted by the token providers
- */
-class ProviderToken {
-    constructor(name, // Name associated with the token
-    tokenHash, // The hash to persist
-    userId, // The user for which the token is generated
-    type // The type of the token.
-    ) {
-        this.name = name;
-        this.tokenHash = tokenHash;
-        this.userId = userId;
-        this.type = type;
-    }
-}
-exports.ProviderToken = ProviderToken;

package/build/src/UserProviders/Database/User.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="@adonisjs/hash/build/adonis-typings" />
-import type { HashContract } from '@ioc:Adonis/Core/Hash';
-import type { ProviderUserContract, DatabaseProviderRow, DatabaseProviderConfig } from '@ioc:Adonis/Addons/Auth';
-/**
- * Database user works a bridge between the provider and the guard
- */
-export declare class DatabaseUser implements ProviderUserContract<DatabaseProviderRow> {
-    user: DatabaseProviderRow | null;
-    private config;
-    private hash;
-    constructor(user: DatabaseProviderRow | null, config: DatabaseProviderConfig, hash: HashContract);
-    /**
-     * Returns the value of the user id
-     */
-    getId(): any;
-    /**
-     * Verifies the user password
-     */
-    verifyPassword(plainPassword: string): Promise<boolean>;
-    /**
-     * Returns the user remember me token or null
-     */
-    getRememberMeToken(): string | null;
-    /**
-     * Updates user remember me token
-     */
-    setRememberMeToken(token: string): void;
-}

package/build/src/UserProviders/Database/User.js

@@ -1,74 +0,0 @@
-"use strict";
-/*
- * @adonisjs/auth
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * 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;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseUser = void 0;
-const utils_1 = require("@poppinss/utils");
-const standalone_1 = require("@adonisjs/core/build/standalone");
-/**
- * Database user works a bridge between the provider and the guard
- */
-let DatabaseUser = class DatabaseUser {
-    constructor(user, config, hash) {
-        this.user = user;
-        this.config = config;
-        this.hash = hash;
-    }
-    /**
-     * Returns the value of the user id
-     */
-    getId() {
-        return this.user ? this.user[this.config.identifierKey] : null;
-    }
-    /**
-     * Verifies the user password
-     */
-    async verifyPassword(plainPassword) {
-        if (!this.user) {
-            throw new utils_1.Exception('Cannot "verifyPassword" for non-existing user');
-        }
-        /**
-         * Ensure user has password
-         */
-        if (!this.user.password) {
-            throw new utils_1.Exception('Auth user object must have a password in order to call "verifyPassword"');
-        }
-        const hasher = this.config.hashDriver ? this.hash.use(this.config.hashDriver) : this.hash;
-        return hasher.verify(this.user.password, plainPassword);
-    }
-    /**
-     * Returns the user remember me token or null
-     */
-    getRememberMeToken() {
-        return this.user ? this.user.remember_me_token || null : null;
-    }
-    /**
-     * Updates user remember me token
-     */
-    setRememberMeToken(token) {
-        if (!this.user) {
-            throw new utils_1.Exception('Cannot set "rememberMeToken" on non-existing user');
-        }
-        this.user.remember_me_token = token;
-    }
-};
-DatabaseUser = __decorate([
-    (0, standalone_1.inject)([null, null, 'Adonis/Core/Hash']),
-    __metadata("design:paramtypes", [Object, Object, Object])
-], DatabaseUser);
-exports.DatabaseUser = DatabaseUser;

package/build/src/UserProviders/Database/index.d.ts

@@ -1,75 +0,0 @@
-/// <reference types="@adonisjs/application/build/adonis-typings/application" />
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { DatabaseContract, QueryClientContract } from '@ioc:Adonis/Lucid/Database';
-import { DatabaseProviderRow, ProviderUserContract, DatabaseProviderConfig, DatabaseProviderContract } from '@ioc:Adonis/Addons/Auth';
-/**
- * Database provider to lookup users inside the database
- */
-export declare class DatabaseProvider implements DatabaseProviderContract<DatabaseProviderRow> {
-    private application;
-    private config;
-    private db;
-    /**
-     * Hooks reference
-     */
-    private hooks;
-    /**
-     * Custom connection or query client
-     */
-    private connection?;
-    /**
-     * Name of the remember_me_token column
-     */
-    private rememberMeColumn;
-    constructor(application: ApplicationContract, config: DatabaseProviderConfig, db: DatabaseContract);
-    /**
-     * Returns the query client for invoking queries
-     */
-    private getQueryClient;
-    /**
-     * Returns the query builder instance for the users table
-     */
-    private getUserQueryBuilder;
-    /**
-     * Ensure "user.id" is always present
-     */
-    private ensureUserHasId;
-    /**
-     * Executes the query to find the user, calls the registered hooks
-     * and wraps the result inside [[ProviderUserContract]]
-     */
-    private findUser;
-    /**
-     * Returns an instance of provider user
-     */
-    getUserFor(user: any): Promise<ProviderUserContract<DatabaseProviderRow>>;
-    /**
-     * Define custom connection
-     */
-    setConnection(connection: string | QueryClientContract): this;
-    /**
-     * Define before hooks. Check interface for exact type information
-     */
-    before(event: 'findUser', callback: (query: any) => Promise<void>): this;
-    /**
-     * Define after hooks. Check interface for exact type information
-     */
-    after(event: 'findUser', callback: (...args: any[]) => Promise<void>): this;
-    /**
-     * Returns the user row using the primary key
-     */
-    findById(id: string | number): Promise<ProviderUserContract<DatabaseProviderRow>>;
-    /**
-     * Returns a user from their remember me token
-     */
-    findByRememberMeToken(id: number | string, token: string): Promise<ProviderUserContract<DatabaseProviderRow>>;
-    /**
-     * Returns the user row by searching the uidValue against
-     * their defined uids.
-     */
-    findByUid(uidValue: string): Promise<ProviderUserContract<DatabaseProviderRow>>;
-    /**
-     * Updates the user remember me token
-     */
-    updateRememberMeToken(user: ProviderUserContract<DatabaseProviderRow>): Promise<void>;
-}

package/build/src/UserProviders/Database/index.js

@@ -1,141 +0,0 @@
-"use strict";
-/*
- * @adonisjs/auth
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatabaseProvider = void 0;
-const hooks_1 = require("@poppinss/hooks");
-const utils_1 = require("@poppinss/utils");
-const User_1 = require("./User");
-/**
- * Database provider to lookup users inside the database
- */
-class DatabaseProvider {
-    constructor(application, config, db) {
-        this.application = application;
-        this.config = config;
-        this.db = db;
-        /**
-         * Hooks reference
-         */
-        this.hooks = new hooks_1.Hooks();
-        /**
-         * Name of the remember_me_token column
-         */
-        this.rememberMeColumn = 'remember_me_token';
-    }
-    /**
-     * Returns the query client for invoking queries
-     */
-    getQueryClient() {
-        if (!this.connection) {
-            return this.db.connection(this.config.connection);
-        }
-        return typeof this.connection === 'string'
-            ? this.db.connection(this.connection)
-            : this.connection;
-    }
-    /**
-     * Returns the query builder instance for the users table
-     */
-    getUserQueryBuilder() {
-        return this.getQueryClient().from(this.config.usersTable);
-    }
-    /**
-     * Ensure "user.id" is always present
-     */
-    ensureUserHasId(user) {
-        /**
-         * Ignore when user is null
-         */
-        if (!user) {
-            return;
-        }
-        if (!user[this.config.identifierKey]) {
-            throw new utils_1.Exception(`Auth database provider expects "${this.config.usersTable}.${this.config.identifierKey}" to always exist`);
-        }
-    }
-    /**
-     * Executes the query to find the user, calls the registered hooks
-     * and wraps the result inside [[ProviderUserContract]]
-     */
-    async findUser(query) {
-        await this.hooks.exec('before', 'findUser', query);
-        const user = await query.first();
-        if (user) {
-            await this.hooks.exec('after', 'findUser', user);
-        }
-        return this.getUserFor(user);
-    }
-    /**
-     * Returns an instance of provider user
-     */
-    async getUserFor(user) {
-        this.ensureUserHasId(user);
-        const UserBuilder = this.config.user ? (0, utils_1.esmResolver)(await this.config.user()) : User_1.DatabaseUser;
-        return this.application.container.makeAsync(UserBuilder, [user, this.config]);
-    }
-    /**
-     * Define custom connection
-     */
-    setConnection(connection) {
-        this.connection = connection;
-        return this;
-    }
-    /**
-     * Define before hooks. Check interface for exact type information
-     */
-    before(event, callback) {
-        this.hooks.add('before', event, callback);
-        return this;
-    }
-    /**
-     * Define after hooks. Check interface for exact type information
-     */
-    after(event, callback) {
-        this.hooks.add('after', event, callback);
-        return this;
-    }
-    /**
-     * Returns the user row using the primary key
-     */
-    async findById(id) {
-        const query = this.getUserQueryBuilder();
-        return this.findUser(query.where(this.config.identifierKey, id));
-    }
-    /**
-     * Returns a user from their remember me token
-     */
-    async findByRememberMeToken(id, token) {
-        const query = this.getUserQueryBuilder()
-            .where(this.rememberMeColumn, token)
-            .where(this.config.identifierKey, id);
-        return this.findUser(query);
-    }
-    /**
-     * Returns the user row by searching the uidValue against
-     * their defined uids.
-     */
-    async findByUid(uidValue) {
-        const query = this.getUserQueryBuilder();
-        this.config.uids.forEach((uid) => query.orWhere(uid, uidValue));
-        return this.findUser(query);
-    }
-    /**
-     * Updates the user remember me token
-     */
-    async updateRememberMeToken(user) {
-        this.ensureUserHasId(user);
-        await this.getUserQueryBuilder()
-            .where(this.config.identifierKey, user[this.config.identifierKey])
-            .update({
-            remember_me_token: user.getRememberMeToken(),
-        });
-    }
-}
-exports.DatabaseProvider = DatabaseProvider;

package/build/src/UserProviders/Lucid/User.d.ts

@@ -1,28 +0,0 @@
-/// <reference types="@adonisjs/hash/build/adonis-typings" />
-import type { HashContract } from '@ioc:Adonis/Core/Hash';
-import type { LucidProviderModel, ProviderUserContract, LucidProviderConfig } from '@ioc:Adonis/Addons/Auth';
-/**
- * Lucid works works a bridge between the provider and the guard
- */
-export declare class LucidUser<User extends LucidProviderModel> implements ProviderUserContract<InstanceType<User>> {
-    user: InstanceType<User> | null;
-    private config;
-    private hash;
-    constructor(user: InstanceType<User> | null, config: LucidProviderConfig<User>, hash: HashContract);
-    /**
-     * Returns the value of the user id
-     */
-    getId(): any;
-    /**
-     * Verifies the user password
-     */
-    verifyPassword(plainPassword: string): Promise<boolean>;
-    /**
-     * Returns the user remember me token or null
-     */
-    getRememberMeToken(): string | null;
-    /**
-     * Updates user remember me token
-     */
-    setRememberMeToken(token: string): void;
-}

package/build/src/UserProviders/Lucid/User.js

@@ -1,74 +0,0 @@
-"use strict";
-/*
- * @adonisjs/auth
- *
- * (c) Harminder Virk <virk@adonisjs.com>
- *
- * 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;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LucidUser = void 0;
-const utils_1 = require("@poppinss/utils");
-const standalone_1 = require("@adonisjs/core/build/standalone");
-/**
- * Lucid works works a bridge between the provider and the guard
- */
-let LucidUser = class LucidUser {
-    constructor(user, config, hash) {
-        this.user = user;
-        this.config = config;
-        this.hash = hash;
-    }
-    /**
-     * Returns the value of the user id
-     */
-    getId() {
-        return this.user ? this.user[this.config.identifierKey] : null;
-    }
-    /**
-     * Verifies the user password
-     */
-    async verifyPassword(plainPassword) {
-        if (!this.user) {
-            throw new utils_1.Exception('Cannot "verifyPassword" for non-existing user');
-        }
-        /**
-         * Ensure user has password
-         */
-        if (!this.user.password) {
-            throw new utils_1.Exception('Auth user object must have a password in order to call "verifyPassword"');
-        }
-        const hasher = this.config.hashDriver ? this.hash.use(this.config.hashDriver) : this.hash;
-        return hasher.verify(this.user.password, plainPassword);
-    }
-    /**
-     * Returns the user remember me token or null
-     */
-    getRememberMeToken() {
-        return this.user ? this.user.rememberMeToken || null : null;
-    }
-    /**
-     * Updates user remember me token
-     */
-    setRememberMeToken(token) {
-        if (!this.user) {
-            throw new utils_1.Exception('Cannot set "rememberMeToken" on non-existing user');
-        }
-        this.user.rememberMeToken = token;
-    }
-};
-LucidUser = __decorate([
-    (0, standalone_1.inject)([null, null, 'Adonis/Core/Hash']),
-    __metadata("design:paramtypes", [Object, Object, Object])
-], LucidUser);
-exports.LucidUser = LucidUser;

package/build/src/UserProviders/Lucid/index.d.ts

@@ -1,72 +0,0 @@
-/// <reference types="@adonisjs/application/build/adonis-typings/application" />
-import { ApplicationContract } from '@ioc:Adonis/Core/Application';
-import { QueryClientContract } from '@ioc:Adonis/Lucid/Database';
-import { LucidProviderModel, LucidProviderConfig, ProviderUserContract, LucidProviderContract } from '@ioc:Adonis/Addons/Auth';
-/**
- * Lucid provider uses Lucid models to lookup a users
- */
-export declare class LucidProvider implements LucidProviderContract<LucidProviderModel> {
-    private application;
-    private config;
-    /**
-     * Hooks reference
-     */
-    private hooks;
-    /**
-     * Custom connection or query client
-     */
-    private connection?;
-    constructor(application: ApplicationContract, config: LucidProviderConfig<LucidProviderModel>);
-    /**
-     * The models options for constructing a query
-     */
-    private getModelOptions;
-    /**
-     * Returns the auth model
-     */
-    private getModel;
-    /**
-     * Returns query instance for the user model
-     */
-    private getModelQuery;
-    /**
-     * Executes the query to find the user, calls the registered hooks
-     * and wraps the result inside [[ProviderUserContract]]
-     */
-    private findUser;
-    /**
-     * Returns an instance of the [[ProviderUser]] by wrapping lucid model
-     * inside it
-     */
-    getUserFor(user: InstanceType<LucidProviderModel> | null): Promise<any>;
-    /**
-     * Define custom connection
-     */
-    setConnection(connection: string | QueryClientContract): this;
-    /**
-     * Define before hooks. Check interface for exact type information
-     */
-    before(event: 'findUser', callback: (query: any) => Promise<void>): this;
-    /**
-     * Define after hooks. Check interface for exact type information
-     */
-    after(event: 'findUser', callback: (...args: any[]) => Promise<void>): this;
-    /**
-     * Returns a user instance using the primary key value
-     */
-    findById(id: string | number): Promise<any>;
-    /**
-     * Returns a user instance using a specific token type and value
-     */
-    findByRememberMeToken(id: string | number, value: string): Promise<any>;
-    /**
-     * Returns the user instance by searching the uidValue against
-     * their defined uids.
-     */
-    findByUid(uidValue: string): Promise<any>;
-    /**
-     * Updates the user remember me token. The guard must called `setRememberMeToken`
-     * before invoking this method.
-     */
-    updateRememberMeToken(providerUser: ProviderUserContract<InstanceType<LucidProviderModel>>): Promise<void>;
-}