@salte-auth/salte-auth/dist/declarations/src/base/core/provider.d.ts

Authentication for the modern web!

import { Shared } from './shared';
import { Interceptors, Logger, URL, Dedupe } from '../../utils';
export declare class Provider extends Shared {
    protected logger: Logger;
    constructor(config: Provider.Config);
    /**
     * Determines if validation is enabled for the given key.
     * @param key - the key to determine whether validation is enabled for
     * @returns whether validation is enabled for the key.
     */
    protected validation(key: string): boolean;
    /**
     * The unique name of the provider
     */
    get $name(): string;
    /**
     * Returns a scoped key for storage.
     * @param key - The storage key.
     *
     * @example auth0.key('hello') // 'salte.auth.provider.auth0.hello'
     */
    protected get key(): string;
    protected url: typeof URL.url;
    dedupe: Dedupe.Function;
    /**
     * Returns the logout url for the provider.
     */
    get logout(): string;
}
export interface Provider {
    /**
     * The unique name of the provider
     */
    name: string;
    /**
     * Returns the login url for the provider.
     */
    login: string;
    /**
     * An internal login command to `salte-auth` that enables enhancing the login with common parameters.
     */
    $login(options?: object): string;
    validate(options: object | void): void;
    /**
     * Checks for errors returned from the provider.
     */
    $validate(options: object): void;
    /**
     * Reinitializes the ID and Access Tokens of the given provider.
     */
    sync(): void;
    /**
     * Invoked when Salte Auth is initialized
     */
    connected?(): void;
    /**
     * Invoked when an endpoint is marked as secured.
     * @returns true if the endpoint is already secured, otherwise it returns a url to secure the endpoint.
     */
    secure?(request?: Interceptors.XHR.ExtendedXMLHttpRequest | Request): Promise<'login' | boolean>;
    on(name: 'login', listener: (error?: Error, data?: any) => void): void;
    on(name: 'logout', listener: (error?: Error) => void): void;
}
export interface Provider {
    config: Provider.Config;
}
export declare namespace Provider {
    interface Config extends Shared.Config {
        /**
         * The name associated with your provider
         */
        name?: string;
        /**
         * The url of the designated provider.
         */
        url?: string;
        /**
         * Used to disable certain security validations if your provider doesn't support them.
         *
         * @defaultValue true
         */
        validation?: ValidationOptions | boolean;
        /**
         * The routes to secure for this provider.
         */
        routes?: (string | RegExp)[] | boolean;
        /**
         * The endpoints to secure for this provider.
         */
        endpoints?: (string | RegExp)[];
        /**
         * Determines the level of verbosity of the logs.
         *
         * @defaultValue 'warn'
         */
        level?: ('error' | 'warn' | 'info' | 'trace');
        /**
         * Add extra parameters to the given authentication request.
         */
        queryParams?: (type: 'login' | 'logout') => {
            [key: string]: any;
        };
    }
    interface ValidationOptions {
        [key: string]: boolean;
    }
}