@glideidentity/web-client-sdk 4.4.8-beta.1 → 4.4.8-beta.3

package/dist/core/phone-auth/api-types.d.ts

@@ -386,16 +386,30 @@ export declare function isLinkData(data: any): data is LinkData;
  * Check if response is an error
  */
 export declare function isErrorResponse(response: any): response is ErrorResponse;
+/**
+ * Execution mode for authentication flow
+ */
+export type ExecutionMode = 'standard' | 'extended';
 /**
  * Options for invokeSecurePrompt to control UI behavior
  */
 export interface InvokeOptions {
     /**
-     * If true, returns raw data without showing any UI
-     * If false/undefined, shows appropriate UI (modal/button)
+     * Prevents SDK from showing its own UI components.
+     * Only affects Desktop strategy (shows modal by default).
+     * Link/TS43 never show SDK UI, so this has no effect on them.
+     *
      * @default false
      */
-    headless?: boolean;
+    preventDefaultUI?: boolean;
+    /**
+     * Controls the response type:
+     * - 'standard': Returns credential when complete (Promise<AuthCredential>)
+     * - 'extended': Returns control methods + credential promise
+     *
+     * @default 'standard'
+     */
+    executionMode?: ExecutionMode;
     /**
      * UI theme to use for modals and components
      * @default 'dark'
@@ -420,7 +434,7 @@ export interface InvokeOptions {
         error?: any;
     }) => void;
     /**
-     * Options for customizing the modal UI (only used when headless=false)
+     * Options for customizing the modal UI (only used when preventDefaultUI=false)
      * Simplified to only include commonly used options
      */
     modalOptions?: {
@@ -440,7 +454,7 @@ export interface InvokeOptions {
         closeOnEscape?: boolean;
     };
     /**
-     * Callback functions for UI events (only used when headless=false)
+     * Callback functions for UI events (only used when preventDefaultUI=false)
      */
     callbacks?: {
         /** Called when modal is opened */
@@ -454,35 +468,106 @@ export interface InvokeOptions {
         /** Called on error */
         onError?: (error: Error) => void;
     };
-}
-/**
- * Result returned in headless mode
- */
-export interface HeadlessResult {
-    /** The authentication strategy being used */
-    strategy: AuthenticationStrategy;
-    /** For Link strategy: the URL to open */
-    url?: string;
-    /** For Desktop strategy: the QR code data */
-    qrCode?: string;
-    /** For TS43: the credential request data */
-    credentialRequest?: any;
     /**
-     * Promise that resolves when authentication completes
-     * - For Link/Desktop: polls for completion
-     * - For TS43: not used (trigger returns credential directly)
+     * Custom polling endpoint for Desktop/Link strategies
+     * Overrides the SDK configured endpoint and backend-provided status URL
+     * Useful for testing or using a proxy endpoint
+     * @example '/api/phone-auth/status' or 'https://custom-polling.example.com/status'
+     */
+    pollingEndpoint?: string;
+    /**
+     * Custom polling interval in milliseconds
+     * @default 2000 (2 seconds)
      */
-    pollingPromise?: Promise<any>;
+    pollingInterval?: number;
     /**
-     * Function to trigger authentication action
-     * - For Link: opens App Clip URL (can be called multiple times)
-     * - For TS43: invokes Digital Credentials API (returns credential)
-     * - For Desktop: not used (QR code is shown)
+     * Maximum number of polling attempts before timeout
+     * @default 30 (1 minute with 2s interval)
      */
-    trigger?: (() => void) | (() => Promise<any>);
+    maxPollingAttempts?: number;
+}
+/**
+ * Authentication credential result
+ */
+export interface AuthCredential {
+    /** Authentication credential token */
+    credential: string;
+    /** Phone number if available */
+    phone_number?: PhoneNumber;
     /** Session information */
     session: SessionInfo;
+    /** Whether authentication was successful */
+    authenticated: boolean;
 }
+/**
+ * Base interface for extended mode responses
+ */
+export interface ExtendedResponse {
+    /** Authentication strategy */
+    strategy: AuthenticationStrategy;
+    /** Session information */
+    session: SessionInfo;
+    /** Promise that resolves to the credential */
+    credential: Promise<AuthCredential>;
+    /** Cancel the authentication flow */
+    cancel: () => void;
+}
+/**
+ * Extended response for Desktop strategy
+ */
+export interface DesktopExtendedResponse extends ExtendedResponse {
+    strategy: 'desktop';
+    /** QR code data for custom UI */
+    qr_code_data: {
+        /** iOS QR code image */
+        ios_qr_image?: string;
+        /** Android QR code image */
+        android_qr_image?: string;
+        /** Generic QR code image */
+        qr_code?: string;
+        /** Challenge pattern */
+        challenge?: any;
+    };
+    /** Start or restart polling */
+    start_polling: () => Promise<AuthCredential>;
+    /** Stop polling */
+    stop_polling: () => void;
+    /** Whether currently polling */
+    is_polling: boolean;
+    /** Modal reference if UI was shown */
+    modal_ref?: any;
+}
+/**
+ * Extended response for Link strategy
+ */
+export interface LinkExtendedResponse extends ExtendedResponse {
+    strategy: 'link';
+    /** Additional data for Link strategy */
+    data: {
+        /** App URL that was opened */
+        app_url: string;
+    };
+    /** Re-open the app link */
+    trigger: () => void;
+    /** Start or restart polling */
+    start_polling?: () => Promise<AuthCredential>;
+    /** Stop polling */
+    stop_polling?: () => void;
+    /** Whether currently polling */
+    is_polling?: boolean;
+}
+/**
+ * Extended response for TS43 strategy
+ */
+export interface TS43ExtendedResponse extends ExtendedResponse {
+    strategy: 'ts43';
+    /** Re-trigger credential request */
+    trigger: () => Promise<void>;
+}
+/**
+ * Combined type for all extended responses
+ */
+export type AnyExtendedResponse = DesktopExtendedResponse | LinkExtendedResponse | TS43ExtendedResponse;
 declare const _default: {
     USE_CASE: {
         readonly GET_PHONE_NUMBER: "GetPhoneNumber";

package/dist/core/phone-auth/client.d.ts

@@ -1,4 +1,4 @@
-import type { PrepareResponse, GetPhoneNumberResponse, VerifyPhoneNumberResponse, SecureCredentialResponse, SessionInfo, InvokeOptions, HeadlessResult } from './api-types';
+import type { PrepareResponse, GetPhoneNumberResponse, VerifyPhoneNumberResponse, SecureCredentialResponse, SessionInfo, InvokeOptions, AuthCredential, AnyExtendedResponse } from './api-types';
 import type { AuthConfig, PhoneAuthOptions, PhoneAuthResult } from './types';
 import type { DesktopAuthOptions } from './strategies/desktop';
 export declare class PhoneAuthClient {
@@ -86,25 +86,27 @@ export declare class PhoneAuthClient {
      * });
      * ```
      *
-     * @example Headless Mode (returns data)
+     * @example Extended Mode (returns control methods)
      * ```typescript
-     * // Get raw data without showing UI
+     * // Get control methods for custom implementation
      * const result = await phoneAuth.invokeSecurePrompt(prepareResult, {
-     *   headless: true
+     *   executionMode: 'extended',
+     *   preventDefaultUI: true  // Desktop: no modal
      * });
      *
-     * if (result.strategy === 'link') {
-     *   // Open URL yourself
-     *   window.open(result.url);
-     *   await result.pollingPromise; // Wait for completion
+     * if (result.strategy === 'desktop') {
+     *   // Show custom QR UI
+     *   showCustomQR(result.qr_code_data);
+     *   // Start polling
+     *   await result.start_polling();
      * }
      * ```
      *
      * @param prepareResponse - Response from prepare() with strategy and data
-     * @param options - Control UI behavior or enable headless mode
-     * @returns Credential or HeadlessResult based on mode
+     * @param options - Control UI behavior and response type
+     * @returns Credential or ExtendedResponse based on executionMode
      */
-    invokeSecurePrompt(prepareResponse: PrepareResponse, options?: InvokeOptions | DesktopAuthOptions): Promise<SecureCredentialResponse['vp_token'] | HeadlessResult>;
+    invokeSecurePrompt(prepareResponse: PrepareResponse, options?: InvokeOptions | DesktopAuthOptions): Promise<AuthCredential | SecureCredentialResponse['vp_token'] | AnyExtendedResponse>;
     /**
      * Step 3A: Get phone number from credential
      *