@auth0/auth0-spa-js 2.18.3 → 2.19.1

package/dist/typings/mfa/MfaContextManager.d.ts

@@ -1,79 +1,79 @@
-import { MfaRequirements } from '../errors';
-/**
- * Represents the stored context for an MFA flow
- */
-export interface MfaContext {
-    /** The OAuth scope for the original token request */
-    scope?: string;
-    /** The API audience for the original token request */
-    audience?: string;
-    /** MFA requirements from the mfa_required error (camelCase for TypeScript conventions) */
-    mfaRequirements?: MfaRequirements;
-    /** Timestamp when the context was created */
-    createdAt: number;
-}
-/**
- * Manages MFA authentication contexts keyed by MFA token.
- *
- * When an mfa_required error occurs, the SDK stores the original request's
- * scope and audience. When the user later provides an MFA token for verification,
- * the SDK retrieves the matching context to complete the token exchange.
- *
- * This enables concurrent MFA flows without state conflicts.
- *
- * @example
- * ```typescript
- * const manager = new MfaContextManager();
- *
- * // Store context when mfa_required error occurs
- * manager.set('mfaTokenAbc', { scope: 'openid profile', audience: 'https://api.example.com' });
- *
- * // Retrieve context when user completes MFA
- * const context = manager.get('mfaTokenAbc');
- * // { scope: 'openid profile', audience: 'https://api.example.com', createdAt: ... }
- *
- * // Remove after successful verification
- * manager.remove('mfaTokenAbc');
- * ```
- */
-export declare class MfaContextManager {
-    private contexts;
-    private readonly ttlMs;
-    /**
-     * Creates a new MfaContextManager
-     * @param ttlMs - Time-to-live for contexts in milliseconds (default: 10 minutes)
-     */
-    constructor(ttlMs?: number);
-    /**
-     * Stores an MFA context keyed by the MFA token.
-     * Runs cleanup to remove expired entries before storing.
-     *
-     * @param mfaToken - The MFA token from the mfa_required error
-     * @param context - The scope and audience from the original request
-     */
-    set(mfaToken: string, context: Omit<MfaContext, 'createdAt'>): void;
-    /**
-     * Retrieves the MFA context for a given token.
-     * Returns undefined if the token is not found or has expired.
-     *
-     * @param mfaToken - The MFA token to look up
-     * @returns The stored context, or undefined if not found/expired
-     */
-    get(mfaToken: string): MfaContext | undefined;
-    /**
-     * Removes an MFA context.
-     * Should be called after successful MFA verification.
-     *
-     * @param mfaToken - The MFA token to remove
-     */
-    remove(mfaToken: string): void;
-    /**
-     * Removes all expired contexts from the Map.
-     * Called automatically on every `set` operation.
-     */
-    private cleanup;
-    /**
-     * Returns the number of stored contexts
-     */
-    get size(): number;
-}
+import { MfaRequirements } from '../errors';
+/**
+ * Represents the stored context for an MFA flow
+ */
+export interface MfaContext {
+    /** The OAuth scope for the original token request */
+    scope?: string;
+    /** The API audience for the original token request */
+    audience?: string;
+    /** MFA requirements from the mfa_required error (camelCase for TypeScript conventions) */
+    mfaRequirements?: MfaRequirements;
+    /** Timestamp when the context was created */
+    createdAt: number;
+}
+/**
+ * Manages MFA authentication contexts keyed by MFA token.
+ *
+ * When an mfa_required error occurs, the SDK stores the original request's
+ * scope and audience. When the user later provides an MFA token for verification,
+ * the SDK retrieves the matching context to complete the token exchange.
+ *
+ * This enables concurrent MFA flows without state conflicts.
+ *
+ * @example
+ * ```typescript
+ * const manager = new MfaContextManager();
+ *
+ * // Store context when mfa_required error occurs
+ * manager.set('mfaTokenAbc', { scope: 'openid profile', audience: 'https://api.example.com' });
+ *
+ * // Retrieve context when user completes MFA
+ * const context = manager.get('mfaTokenAbc');
+ * // { scope: 'openid profile', audience: 'https://api.example.com', createdAt: ... }
+ *
+ * // Remove after successful verification
+ * manager.remove('mfaTokenAbc');
+ * ```
+ */
+export declare class MfaContextManager {
+    private contexts;
+    private readonly ttlMs;
+    /**
+     * Creates a new MfaContextManager
+     * @param ttlMs - Time-to-live for contexts in milliseconds (default: 10 minutes)
+     */
+    constructor(ttlMs?: number);
+    /**
+     * Stores an MFA context keyed by the MFA token.
+     * Runs cleanup to remove expired entries before storing.
+     *
+     * @param mfaToken - The MFA token from the mfa_required error
+     * @param context - The scope and audience from the original request
+     */
+    set(mfaToken: string, context: Omit<MfaContext, 'createdAt'>): void;
+    /**
+     * Retrieves the MFA context for a given token.
+     * Returns undefined if the token is not found or has expired.
+     *
+     * @param mfaToken - The MFA token to look up
+     * @returns The stored context, or undefined if not found/expired
+     */
+    get(mfaToken: string): MfaContext | undefined;
+    /**
+     * Removes an MFA context.
+     * Should be called after successful MFA verification.
+     *
+     * @param mfaToken - The MFA token to remove
+     */
+    remove(mfaToken: string): void;
+    /**
+     * Removes all expired contexts from the Map.
+     * Called automatically on every `set` operation.
+     */
+    private cleanup;
+    /**
+     * Returns the number of stored contexts
+     */
+    get size(): number;
+}

package/dist/typings/mfa/constants.d.ts

@@ -1,23 +1,23 @@
-import type { MfaFactorType, OobChannel } from './types';
-/**
- * Mapping configuration for a factor type
- */
-export interface FactorMapping {
-    authenticatorTypes: ['otp'] | ['oob'];
-    oobChannels?: OobChannel[];
-}
-/**
- * Maps MFA factor types to auth-js enrollment parameters
- */
-export declare const FACTOR_MAPPING: Record<MfaFactorType, FactorMapping>;
-/**
- * MFA grant type constants for verification
- */
-export declare const MfaGrantTypes: {
-    /** Grant type for OTP (TOTP) verification */
-    readonly OTP: "http://auth0.com/oauth/grant-type/mfa-otp";
-    /** Grant type for OOB (SMS, Email, Push) verification */
-    readonly OOB: "http://auth0.com/oauth/grant-type/mfa-oob";
-    /** Grant type for recovery code verification */
-    readonly RECOVERY_CODE: "http://auth0.com/oauth/grant-type/mfa-recovery-code";
-};
+import type { MfaFactorType, OobChannel } from './types';
+/**
+ * Mapping configuration for a factor type
+ */
+export interface FactorMapping {
+    authenticatorTypes: ['otp'] | ['oob'];
+    oobChannels?: OobChannel[];
+}
+/**
+ * Maps MFA factor types to auth-js enrollment parameters
+ */
+export declare const FACTOR_MAPPING: Record<MfaFactorType, FactorMapping>;
+/**
+ * MFA grant type constants for verification
+ */
+export declare const MfaGrantTypes: {
+    /** Grant type for OTP (TOTP) verification */
+    readonly OTP: "http://auth0.com/oauth/grant-type/mfa-otp";
+    /** Grant type for OOB (SMS, Email, Push) verification */
+    readonly OOB: "http://auth0.com/oauth/grant-type/mfa-oob";
+    /** Grant type for recovery code verification */
+    readonly RECOVERY_CODE: "http://auth0.com/oauth/grant-type/mfa-recovery-code";
+};

package/dist/typings/mfa/errors.d.ts

@@ -1,117 +1,117 @@
-import { MfaApiErrorResponse } from '@auth0/auth0-auth-js';
-import { GenericError } from '../errors';
-/**
- * Base class for MFA-related errors in auth0-spa-js.
- * Extends GenericError for unified error hierarchy across the SDK.
- */
-export declare class MfaError extends GenericError {
-    constructor(error: string, error_description: string);
-    static fromPayload({ error, error_description }: {
-        error: string;
-        error_description: string;
-    }): MfaError;
-}
-/**
- * Error thrown when listing MFA authenticators fails.
- *
- * @example
- * ```typescript
- * try {
- *   const authenticators = await mfa.getAuthenticators();
- * } catch (error) {
- *   if (error instanceof MfaListAuthenticatorsError) {
- *     console.log(error.error); // 'access_denied'
- *     console.log(error.error_description); // 'Unauthorized'
- *   }
- * }
- * ```
- */
-export declare class MfaListAuthenticatorsError extends MfaError {
-    constructor(error: string, error_description: string);
-}
-/**
- * Error thrown when enrolling an MFA authenticator fails.
- *
- * @example
- * ```typescript
- * try {
- *   const enrollment = await mfa.enroll({
- *     authenticator_types: ['otp']
- *   });
- * } catch (error) {
- *   if (error instanceof MfaEnrollmentError) {
- *     console.log(error.error); // 'invalid_phone_number'
- *     console.log(error.error_description); // 'Invalid phone number format'
- *   }
- * }
- * ```
- */
-export declare class MfaEnrollmentError extends MfaError {
-    constructor(error: string, error_description: string);
-}
-/**
- * Error thrown when initiating an MFA challenge fails.
- *
- * @example
- * ```typescript
- * try {
- *   const challenge = await mfa.challenge({
- *     mfaToken: mfaToken,
- *     challengeType: 'otp',
- *     authenticatorId: 'otp|dev_123'
- *   });
- * } catch (error) {
- *   if (error instanceof MfaChallengeError) {
- *     console.log(error.error); // 'too_many_attempts'
- *     console.log(error.error_description); // 'Rate limit exceeded'
- *   }
- * }
- * ```
- */
-export declare class MfaChallengeError extends MfaError {
-    constructor(error: string, error_description: string);
-}
-/**
- * Error thrown when verifying an MFA challenge fails.
- *
- * @example
- * ```typescript
- * try {
- *   const tokens = await mfa.verify({
- *     mfaToken: mfaToken,
- *     grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
- *     otp: '123456'
- *   });
- * } catch (error) {
- *   if (error instanceof MfaVerifyError) {
- *     console.log(error.error); // 'invalid_otp' or 'context_not_found'
- *     console.log(error.error_description); // Error details
- *   }
- * }
- * ```
- */
-export declare class MfaVerifyError extends MfaError {
-    constructor(error: string, error_description: string);
-}
-/**
- * Error thrown when getting enrollment factors fails.
- *
- * @example
- * ```typescript
- * try {
- *   const factors = await mfa.getEnrollmentFactors(mfaToken);
- * } catch (error) {
- *   if (error instanceof MfaEnrollmentFactorsError) {
- *     console.log(error.error); // 'mfa_context_not_found'
- *     console.log(error.error_description); // 'MFA context not found...'
- *   }
- * }
- * ```
- */
-export declare class MfaEnrollmentFactorsError extends MfaError {
-    constructor(error: string, error_description: string);
-}
-/**
- * Re-export MfaApiErrorResponse type for convenience
- */
-export type { MfaApiErrorResponse };
+import { MfaApiErrorResponse } from '@auth0/auth0-auth-js';
+import { GenericError } from '../errors';
+/**
+ * Base class for MFA-related errors in auth0-spa-js.
+ * Extends GenericError for unified error hierarchy across the SDK.
+ */
+export declare class MfaError extends GenericError {
+    constructor(error: string, error_description: string);
+    static fromPayload({ error, error_description }: {
+        error: string;
+        error_description: string;
+    }): MfaError;
+}
+/**
+ * Error thrown when listing MFA authenticators fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const authenticators = await mfa.getAuthenticators();
+ * } catch (error) {
+ *   if (error instanceof MfaListAuthenticatorsError) {
+ *     console.log(error.error); // 'access_denied'
+ *     console.log(error.error_description); // 'Unauthorized'
+ *   }
+ * }
+ * ```
+ */
+export declare class MfaListAuthenticatorsError extends MfaError {
+    constructor(error: string, error_description: string);
+}
+/**
+ * Error thrown when enrolling an MFA authenticator fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const enrollment = await mfa.enroll({
+ *     authenticator_types: ['otp']
+ *   });
+ * } catch (error) {
+ *   if (error instanceof MfaEnrollmentError) {
+ *     console.log(error.error); // 'invalid_phone_number'
+ *     console.log(error.error_description); // 'Invalid phone number format'
+ *   }
+ * }
+ * ```
+ */
+export declare class MfaEnrollmentError extends MfaError {
+    constructor(error: string, error_description: string);
+}
+/**
+ * Error thrown when initiating an MFA challenge fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const challenge = await mfa.challenge({
+ *     mfaToken: mfaToken,
+ *     challengeType: 'otp',
+ *     authenticatorId: 'otp|dev_123'
+ *   });
+ * } catch (error) {
+ *   if (error instanceof MfaChallengeError) {
+ *     console.log(error.error); // 'too_many_attempts'
+ *     console.log(error.error_description); // 'Rate limit exceeded'
+ *   }
+ * }
+ * ```
+ */
+export declare class MfaChallengeError extends MfaError {
+    constructor(error: string, error_description: string);
+}
+/**
+ * Error thrown when verifying an MFA challenge fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const tokens = await mfa.verify({
+ *     mfaToken: mfaToken,
+ *     grant_type: 'http://auth0.com/oauth/grant-type/mfa-otp',
+ *     otp: '123456'
+ *   });
+ * } catch (error) {
+ *   if (error instanceof MfaVerifyError) {
+ *     console.log(error.error); // 'invalid_otp' or 'context_not_found'
+ *     console.log(error.error_description); // Error details
+ *   }
+ * }
+ * ```
+ */
+export declare class MfaVerifyError extends MfaError {
+    constructor(error: string, error_description: string);
+}
+/**
+ * Error thrown when getting enrollment factors fails.
+ *
+ * @example
+ * ```typescript
+ * try {
+ *   const factors = await mfa.getEnrollmentFactors(mfaToken);
+ * } catch (error) {
+ *   if (error instanceof MfaEnrollmentFactorsError) {
+ *     console.log(error.error); // 'mfa_context_not_found'
+ *     console.log(error.error_description); // 'MFA context not found...'
+ *   }
+ * }
+ * ```
+ */
+export declare class MfaEnrollmentFactorsError extends MfaError {
+    constructor(error: string, error_description: string);
+}
+/**
+ * Re-export MfaApiErrorResponse type for convenience
+ */
+export type { MfaApiErrorResponse };

package/dist/typings/mfa/index.d.ts

@@ -1,4 +1,4 @@
-export { MfaApiClient } from './MfaApiClient';
-export { MfaContextManager } from './MfaContextManager';
-export type { MfaContext } from './MfaContextManager';
-export type { Authenticator, AuthenticatorType, OobChannel, MfaFactorType, EnrollBaseParams, EnrollParams, EnrollOtpParams, EnrollSmsParams, EnrollVoiceParams, EnrollEmailParams, EnrollPushParams, EnrollmentResponse, OtpEnrollmentResponse, OobEnrollmentResponse, ChallengeAuthenticatorParams, ChallengeResponse, VerifyParams, MfaGrantType, EnrollmentFactor } from './types';
+export { MfaApiClient } from './MfaApiClient';
+export { MfaContextManager } from './MfaContextManager';
+export type { MfaContext } from './MfaContextManager';
+export type { Authenticator, AuthenticatorType, OobChannel, MfaFactorType, EnrollBaseParams, EnrollParams, EnrollOtpParams, EnrollSmsParams, EnrollVoiceParams, EnrollEmailParams, EnrollPushParams, EnrollmentResponse, OtpEnrollmentResponse, OobEnrollmentResponse, ChallengeAuthenticatorParams, ChallengeResponse, VerifyParams, MfaGrantType, EnrollmentFactor } from './types';