piral-adal/lib/setup.d.ts

Plugin to integrate AAD authentication in Piral.

import { Account } from 'msal';
/**
 * Available configuration options for the ADAL plugin.
 */
export interface AdalConfig {
    /**
     * The id of the client. Required for the setup of MSAL.
     */
    clientId: string;
    /**
     * The isser of the token. Should be an URL containing the tenant.
     * By default set to Microsoft's default tenant.
     */
    authority?: string;
    /**
     * The redirect Uri to use. By default the origin with /auth
     * is used.
     */
    redirectUri?: string;
    /**
     * The scopes to be used. By default uses only the 'User.Read' scope.
     */
    scopes?: Array<string>;
    /**
     * Restricts token sharing such that other integrations, e.g., with
     * fetch would need to be done manually.
     * Otherwise, the client is responsive to the `before-fetch` event.
     */
    restrict?: boolean;
    /**
     * Determines the cache location.
     */
    cacheLocation?: 'localStorage' | 'sessionStorage';
    /**
     * If true MSAL will store the auth request state required for validation
     * of the auth flows in the browser cookies.
     * @default false
     */
    storeAuthStateInCookie?: boolean;
    /**
     * Determines the system specific options. Usually not needed.
     * For more details see the MSAL.js documentation.
     */
    system?: any;
    /**
     * Determines the framework specific options. Usually not needed.
     * For more details see the MSAL.js documentation.
     */
    framework?: any;
    /**
     * Determines whether or not the authority should be validated.
     */
    validateAuthority?: boolean;
    /**
     * Additional metadata to hand over.
     */
    authorityMetadata?: string;
    /**
     * A list of known authorities to respect.
     */
    knownAuthorities?: Array<string>;
    /**
     * Optionally decides where to redirect to in the logout case.
     */
    postLogoutRedirectUri?: string;
    /**
     * Determines if the URL for the login request should be navigated to.
     */
    navigateToLoginRequestUrl?: boolean;
}
export interface AdalRequest {
    /**
     * Sets the headers of the request.
     * @param headers Headers or a promise to headers.
     */
    setHeaders(headers: any): void;
}
export interface AdalClient {
    /**
     * Performs a login.
     */
    login(): void;
    /**
     * Performs a logout.
     */
    logout(): void;
    /**
     * Retrieves the current account.
     */
    account(): Account;
    /**
     * Gets a token.
     */
    token(): Promise<string>;
    /**
     * Extends the headers of the provided request.
     */
    extendHeaders(req: AdalRequest): void;
}
/**
 * Sets up a new client wrapping the MSAL API.
 * @param config The configuration for the client.
 */
export declare function setupAdalClient(config: AdalConfig): AdalClient;