@paperbits/common/user/authenticator.ts

Paperbits common components.

import { AccessToken } from "./accessToken";

export interface Authenticator {
    /**
     * Returns access token for current session.
     */
    getAccessToken(): Promise<string>;

    /**
     * Sets new token for the session.
     * @param accessToken {string} Access token in SharedAccessSignature or Bearer token format.
     */
    setAccessToken(accessToken: string): Promise<void>;

    /**
     * Parses specified access token.
     * @param accessToken 
     */
    parseAccessToken?(accessToken: string): AccessToken;

    /**
     * Clears access token from current session.
     */
    clearAccessToken(): Promise<void>;

    /**
     * Checks if current user is signed in.
     */
    isAuthenticated(): Promise<boolean>;
}