@auth0/auth0-spa-js/dist/typings/cache/shared.d.ts

Auth0 SDK for Single Page Applications using Authorization Code Grant Flow with PKCE

import { IdToken, User } from '../global';
export declare const CACHE_KEY_PREFIX = "@@auth0spajs@@";
export declare const CACHE_KEY_ID_TOKEN_SUFFIX = "@@user@@";
export type CacheKeyData = {
    audience?: string;
    scope?: string;
    clientId: string;
};
export declare class CacheKey {
    prefix: string;
    suffix?: string | undefined;
    clientId: string;
    scope?: string;
    audience?: string;
    constructor(data: CacheKeyData, prefix?: string, suffix?: string | undefined);
    /**
     * Converts this `CacheKey` instance into a string for use in a cache
     * @returns A string representation of the key
     */
    toKey(): string;
    /**
     * Converts a cache key string into a `CacheKey` instance.
     * @param key The key to convert
     * @returns An instance of `CacheKey`
     */
    static fromKey(key: string): CacheKey;
    /**
     * Utility function to build a `CacheKey` instance from a cache entry
     * @param entry The entry
     * @returns An instance of `CacheKey`
     */
    static fromCacheEntry(entry: CacheEntry): CacheKey;
}
export interface DecodedToken {
    claims: IdToken;
    user: User;
}
export interface IdTokenEntry {
    id_token: string;
    decodedToken: DecodedToken;
}
export type CacheEntry = {
    id_token?: string;
    token_type?: string;
    access_token: string;
    expires_in: number;
    decodedToken?: DecodedToken;
    audience: string;
    scope: string;
    client_id: string;
    refresh_token?: string;
    oauthTokenScope?: string;
};
export type WrappedCacheEntry = {
    body: Partial<CacheEntry>;
    expiresAt: number;
};
export type KeyManifestEntry = {
    keys: string[];
};
export type Cacheable = WrappedCacheEntry | KeyManifestEntry;
export type MaybePromise<T> = Promise<T> | T;
export interface ICache {
    set<T = Cacheable>(key: string, entry: T): MaybePromise<void>;
    get<T = Cacheable>(key: string): MaybePromise<T | undefined>;
    remove(key: string): MaybePromise<void>;
    allKeys?(): MaybePromise<string[]>;
}