@auth0/auth0-spa-js 2.19.0 → 2.19.1

package/dist/typings/errors.d.ts

@@ -1,96 +1,96 @@
-/**
- * MFA requirements from an mfa_required error response
- */
-export interface MfaRequirements {
-    /** Required enrollment types */
-    enroll?: Array<{
-        type: string;
-    }>;
-    /** Required challenge types */
-    challenge?: Array<{
-        type: string;
-    }>;
-}
-/**
- * Thrown when network requests to the Auth server fail.
- */
-export declare class GenericError extends Error {
-    error: string;
-    error_description: string;
-    constructor(error: string, error_description: string);
-    static fromPayload({ error, error_description }: {
-        error: string;
-        error_description: string;
-    }): GenericError;
-}
-/**
- * Thrown when handling the redirect callback fails, will be one of Auth0's
- * Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
- */
-export declare class AuthenticationError extends GenericError {
-    state: string;
-    appState: any;
-    constructor(error: string, error_description: string, state: string, appState?: any);
-}
-/**
- * Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's
- * Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
- */
-export declare class ConnectError extends GenericError {
-    connection: string;
-    state: string;
-    appState: any;
-    constructor(error: string, error_description: string, connection: string, state: string, appState?: any);
-}
-/**
- * Thrown when silent auth times out (usually due to a configuration issue) or
- * when network requests to the Auth server timeout.
- */
-export declare class TimeoutError extends GenericError {
-    constructor();
-}
-/**
- * Error thrown when the login popup times out (if the user does not complete auth)
- */
-export declare class PopupTimeoutError extends TimeoutError {
-    popup: Window;
-    constructor(popup: Window);
-}
-export declare class PopupCancelledError extends GenericError {
-    popup: Window;
-    constructor(popup: Window);
-}
-export declare class PopupOpenError extends GenericError {
-    constructor();
-}
-/**
- * Error thrown when the token exchange results in a `mfa_required` error
- */
-export declare class MfaRequiredError extends GenericError {
-    mfa_token: string;
-    mfa_requirements: MfaRequirements;
-    constructor(error: string, error_description: string, mfa_token: string, mfa_requirements: MfaRequirements);
-}
-/**
- * Error thrown when there is no refresh token to use
- */
-export declare class MissingRefreshTokenError extends GenericError {
-    audience: string;
-    scope: string;
-    constructor(audience: string, scope: string);
-}
-/**
- * Error thrown when there are missing scopes after refreshing a token
- */
-export declare class MissingScopesError extends GenericError {
-    audience: string;
-    scope: string;
-    constructor(audience: string, scope: string);
-}
-/**
- * Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.
- */
-export declare class UseDpopNonceError extends GenericError {
-    newDpopNonce: string | undefined;
-    constructor(newDpopNonce: string | undefined);
-}
+/**
+ * MFA requirements from an mfa_required error response
+ */
+export interface MfaRequirements {
+    /** Required enrollment types */
+    enroll?: Array<{
+        type: string;
+    }>;
+    /** Required challenge types */
+    challenge?: Array<{
+        type: string;
+    }>;
+}
+/**
+ * Thrown when network requests to the Auth server fail.
+ */
+export declare class GenericError extends Error {
+    error: string;
+    error_description: string;
+    constructor(error: string, error_description: string);
+    static fromPayload({ error, error_description }: {
+        error: string;
+        error_description: string;
+    }): GenericError;
+}
+/**
+ * Thrown when handling the redirect callback fails, will be one of Auth0's
+ * Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
+ */
+export declare class AuthenticationError extends GenericError {
+    state: string;
+    appState: any;
+    constructor(error: string, error_description: string, state: string, appState?: any);
+}
+/**
+ * Thrown when handling the redirect callback for the connect flow fails, will be one of Auth0's
+ * Authentication API's Standard Error Responses: https://auth0.com/docs/api/authentication?javascript#standard-error-responses
+ */
+export declare class ConnectError extends GenericError {
+    connection: string;
+    state: string;
+    appState: any;
+    constructor(error: string, error_description: string, connection: string, state: string, appState?: any);
+}
+/**
+ * Thrown when silent auth times out (usually due to a configuration issue) or
+ * when network requests to the Auth server timeout.
+ */
+export declare class TimeoutError extends GenericError {
+    constructor();
+}
+/**
+ * Error thrown when the login popup times out (if the user does not complete auth)
+ */
+export declare class PopupTimeoutError extends TimeoutError {
+    popup: Window;
+    constructor(popup: Window);
+}
+export declare class PopupCancelledError extends GenericError {
+    popup: Window;
+    constructor(popup: Window);
+}
+export declare class PopupOpenError extends GenericError {
+    constructor();
+}
+/**
+ * Error thrown when the token exchange results in a `mfa_required` error
+ */
+export declare class MfaRequiredError extends GenericError {
+    mfa_token: string;
+    mfa_requirements: MfaRequirements;
+    constructor(error: string, error_description: string, mfa_token: string, mfa_requirements: MfaRequirements);
+}
+/**
+ * Error thrown when there is no refresh token to use
+ */
+export declare class MissingRefreshTokenError extends GenericError {
+    audience: string;
+    scope: string;
+    constructor(audience: string, scope: string);
+}
+/**
+ * Error thrown when there are missing scopes after refreshing a token
+ */
+export declare class MissingScopesError extends GenericError {
+    audience: string;
+    scope: string;
+    constructor(audience: string, scope: string);
+}
+/**
+ * Error thrown when the wrong DPoP nonce is used and a potential subsequent retry wasn't able to fix it.
+ */
+export declare class UseDpopNonceError extends GenericError {
+    newDpopNonce: string | undefined;
+    constructor(newDpopNonce: string | undefined);
+}

package/dist/typings/fetcher.d.ts

@@ -1,54 +1,54 @@
-import { GetTokenSilentlyVerboseResponse } from './global';
-export type ResponseHeaders = Record<string, string | null | undefined> | [string, string][] | {
-    get(name: string): string | null | undefined;
-};
-export type CustomFetchMinimalOutput = {
-    status: number;
-    headers: ResponseHeaders;
-};
-export type CustomFetchImpl<TOutput extends CustomFetchMinimalOutput> = (req: Request) => Promise<TOutput>;
-export type AuthParams = {
-    scope?: string[];
-    audience?: string;
-};
-type AccessTokenFactory = (authParams?: AuthParams) => Promise<string | GetTokenSilentlyVerboseResponse>;
-export type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
-    getAccessToken?: AccessTokenFactory;
-    baseUrl?: string;
-    fetch?: CustomFetchImpl<TOutput>;
-    dpopNonceId?: string;
-};
-export type FetcherHooks = {
-    isDpopEnabled: () => boolean;
-    getAccessToken: AccessTokenFactory;
-    getDpopNonce: () => Promise<string | undefined>;
-    setDpopNonce: (nonce: string) => Promise<void>;
-    generateDpopProof: (params: {
-        url: string;
-        method: string;
-        nonce?: string;
-        accessToken: string;
-    }) => Promise<string>;
-};
-export type FetchWithAuthCallbacks<TOutput> = {
-    onUseDpopNonceError?(): Promise<TOutput>;
-};
-export declare class Fetcher<TOutput extends CustomFetchMinimalOutput> {
-    protected readonly config: Omit<FetcherConfig<TOutput>, 'fetch'> & Required<Pick<FetcherConfig<TOutput>, 'fetch'>>;
-    protected readonly hooks: FetcherHooks;
-    constructor(config: FetcherConfig<TOutput>, hooks: FetcherHooks);
-    protected isAbsoluteUrl(url: string): boolean;
-    protected buildUrl(baseUrl: string | undefined, url: string | undefined): string;
-    protected getAccessToken(authParams?: AuthParams): Promise<string | GetTokenSilentlyVerboseResponse>;
-    protected extractUrl(info: RequestInfo | URL): string;
-    protected buildBaseRequest(info: RequestInfo | URL, init: RequestInit | undefined): Request;
-    protected setAuthorizationHeader(request: Request, accessToken: string, tokenType?: string): void;
-    protected setDpopProofHeader(request: Request, accessToken: string): Promise<void>;
-    protected prepareRequest(request: Request, authParams?: AuthParams): Promise<void>;
-    protected getHeader(headers: ResponseHeaders, name: string): string;
-    protected hasUseDpopNonceError(response: TOutput): boolean;
-    protected handleResponse(response: TOutput, callbacks: FetchWithAuthCallbacks<TOutput>): Promise<TOutput>;
-    protected internalFetchWithAuth(info: RequestInfo | URL, init: RequestInit | undefined, callbacks: FetchWithAuthCallbacks<TOutput>, authParams?: AuthParams): Promise<TOutput>;
-    fetchWithAuth(info: RequestInfo | URL, init?: RequestInit, authParams?: AuthParams): Promise<TOutput>;
-}
-export {};
+import { GetTokenSilentlyVerboseResponse } from './global';
+export type ResponseHeaders = Record<string, string | null | undefined> | [string, string][] | {
+    get(name: string): string | null | undefined;
+};
+export type CustomFetchMinimalOutput = {
+    status: number;
+    headers: ResponseHeaders;
+};
+export type CustomFetchImpl<TOutput extends CustomFetchMinimalOutput> = (req: Request) => Promise<TOutput>;
+export type AuthParams = {
+    scope?: string[];
+    audience?: string;
+};
+type AccessTokenFactory = (authParams?: AuthParams) => Promise<string | GetTokenSilentlyVerboseResponse>;
+export type FetcherConfig<TOutput extends CustomFetchMinimalOutput> = {
+    getAccessToken?: AccessTokenFactory;
+    baseUrl?: string;
+    fetch?: CustomFetchImpl<TOutput>;
+    dpopNonceId?: string;
+};
+export type FetcherHooks = {
+    isDpopEnabled: () => boolean;
+    getAccessToken: AccessTokenFactory;
+    getDpopNonce: () => Promise<string | undefined>;
+    setDpopNonce: (nonce: string) => Promise<void>;
+    generateDpopProof: (params: {
+        url: string;
+        method: string;
+        nonce?: string;
+        accessToken: string;
+    }) => Promise<string>;
+};
+export type FetchWithAuthCallbacks<TOutput> = {
+    onUseDpopNonceError?(): Promise<TOutput>;
+};
+export declare class Fetcher<TOutput extends CustomFetchMinimalOutput> {
+    protected readonly config: Omit<FetcherConfig<TOutput>, 'fetch'> & Required<Pick<FetcherConfig<TOutput>, 'fetch'>>;
+    protected readonly hooks: FetcherHooks;
+    constructor(config: FetcherConfig<TOutput>, hooks: FetcherHooks);
+    protected isAbsoluteUrl(url: string): boolean;
+    protected buildUrl(baseUrl: string | undefined, url: string | undefined): string;
+    protected getAccessToken(authParams?: AuthParams): Promise<string | GetTokenSilentlyVerboseResponse>;
+    protected extractUrl(info: RequestInfo | URL): string;
+    protected buildBaseRequest(info: RequestInfo | URL, init: RequestInit | undefined): Request;
+    protected setAuthorizationHeader(request: Request, accessToken: string, tokenType?: string): void;
+    protected setDpopProofHeader(request: Request, accessToken: string): Promise<void>;
+    protected prepareRequest(request: Request, authParams?: AuthParams): Promise<void>;
+    protected getHeader(headers: ResponseHeaders, name: string): string;
+    protected hasUseDpopNonceError(response: TOutput): boolean;
+    protected handleResponse(response: TOutput, callbacks: FetchWithAuthCallbacks<TOutput>): Promise<TOutput>;
+    protected internalFetchWithAuth(info: RequestInfo | URL, init: RequestInit | undefined, callbacks: FetchWithAuthCallbacks<TOutput>, authParams?: AuthParams): Promise<TOutput>;
+    fetchWithAuth(info: RequestInfo | URL, init?: RequestInit, authParams?: AuthParams): Promise<TOutput>;
+}
+export {};