@thunderid/javascript 0.0.1

package/dist/models/v2/embedded-flow-v2.d.ts

@@ -0,0 +1,494 @@
+/**
+ * Copyright (c) 2025, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV1 } from '../embedded-flow';
+/**
+ * Component types supported by the ThunderID embedded flow API.
+ *
+ * These types define the different UI components that can be rendered
+ * as part of the embedded authentication flows. Each type corresponds
+ * to a specific UI element with its own behavior and properties.
+ *
+ * @example
+ * ```typescript
+ * // Check component type to render appropriate UI
+ * if (component.type === EmbeddedFlowComponentType.TextInput) {
+ *   // Render text input field
+ * } else if (component.type === EmbeddedFlowComponentType.Action) {
+ *   // Render button/action
+ * }
+ * ```
+ *
+ * @experimental This API may change in future versions
+ */
+export declare enum EmbeddedFlowComponentType {
+    /** Interactive action component (buttons, links) for user interactions */
+    Action = "ACTION",
+    /** Container block component that groups other components */
+    Block = "BLOCK",
+    /** Consent component for displaying consent purposes and attributes */
+    Consent = "CONSENT",
+    /** Copyable text display component that shows text with a copy-to-clipboard action */
+    CopyableText = "COPYABLE_TEXT",
+    /** Divider component for visual separation of content */
+    Divider = "DIVIDER",
+    /** Email input field with validation for email addresses. */
+    EmailInput = "EMAIL_INPUT",
+    /** Icon display component for rendering named vector icons */
+    Icon = "ICON",
+    /** Image display component for logos and illustrations */
+    Image = "IMAGE",
+    /** One-time password input field for multi-factor authentication */
+    OtpInput = "OTP_INPUT",
+    /** Organization unit tree picker for selecting an OU */
+    OuSelect = "OU_SELECT",
+    /** Password input field with masking for sensitive data */
+    PasswordInput = "PASSWORD_INPUT",
+    /** Phone number input field with country code support */
+    PhoneInput = "PHONE_INPUT",
+    /** Rich text display component that renders formatted HTML content */
+    RichText = "RICH_TEXT",
+    /** Select/dropdown input component for single choice selection */
+    Select = "SELECT",
+    /** Stack layout component for arranging children in a row or column */
+    Stack = "STACK",
+    /** Text display component for labels, headings, and messages */
+    Text = "TEXT",
+    /** Standard text input field for user data entry */
+    TextInput = "TEXT_INPUT",
+    /** Timer component for displaying a countdown */
+    Timer = "TIMER"
+}
+/**
+ * Action variant types for buttons and interactive elements.
+ *
+ * @experimental This API may change in future versions
+ */
+export declare enum EmbeddedFlowActionVariant {
+    /** Danger action button for destructive operations */
+    Danger = "DANGER",
+    /** Info action button for informational purposes */
+    Info = "INFO",
+    /** Link-styled action button */
+    Link = "LINK",
+    /** Outlined action button for secondary emphasis */
+    Outlined = "OUTLINED",
+    /** Primary action button with highest visual emphasis */
+    Primary = "PRIMARY",
+    /** Secondary action button with moderate visual emphasis */
+    Secondary = "SECONDARY",
+    /** Success action button for positive confirmations */
+    Success = "SUCCESS",
+    /** Tertiary action button with minimal visual emphasis */
+    Tertiary = "TERTIARY",
+    /** Warning action button for cautionary actions */
+    Warning = "WARNING"
+}
+/**
+ * Text variant types for typography components.
+ *
+ * @experimental This API may change in future versions
+ */
+export declare enum EmbeddedFlowTextVariant {
+    /** Primary body text for main content */
+    Body1 = "BODY_1",
+    /** Secondary body text for supplementary content */
+    Body2 = "BODY_2",
+    /** Text styled for button labels */
+    ButtonText = "BUTTON_TEXT",
+    /** Small caption text for annotations and descriptions */
+    Caption = "CAPTION",
+    /** Largest heading level for main titles */
+    Heading1 = "HEADING_1",
+    /** Second level heading for major sections */
+    Heading2 = "HEADING_2",
+    /** Third level heading for subsections */
+    Heading3 = "HEADING_3",
+    /** Fourth level heading for minor sections */
+    Heading4 = "HEADING_4",
+    /** Fifth level heading for detailed sections */
+    Heading5 = "HEADING_5",
+    /** Smallest heading level for fine-grained sections */
+    Heading6 = "HEADING_6",
+    /** Overline text for labels and categories */
+    Overline = "OVERLINE",
+    /** Primary subtitle text with larger emphasis */
+    Subtitle1 = "SUBTITLE_1",
+    /** Secondary subtitle text with moderate emphasis */
+    Subtitle2 = "SUBTITLE_2"
+}
+/**
+ * Event types for action components.
+ *
+ * @experimental This API may change in future versions
+ */
+export declare enum EmbeddedFlowEventType {
+    /** Navigate back to the previous step */
+    Back = "BACK",
+    /** Cancel the current operation */
+    Cancel = "CANCEL",
+    /** Navigate to a different flow step or page */
+    Navigate = "NAVIGATE",
+    /** Reset form fields to initial state */
+    Reset = "RESET",
+    /** Submit form data to the server */
+    Submit = "SUBMIT",
+    /** Trigger an action or event */
+    Trigger = "TRIGGER"
+}
+/**
+ * Enhanced component interface for embedded flow components.
+ *
+ * This interface provides better support for modern form handling and user experience.
+ * It includes properties for labels, placeholders, and required field validation
+ * that are directly provided by the API response.
+ *
+ * @example
+ * ```typescript
+ * const component: EmbeddedFlowComponent = {
+ *   id: 'username_field',
+ *   type: EmbeddedFlowComponentType.TextInput,
+ *   label: 'Username',
+ *   placeholder: 'Enter your username',
+ *   required: true,
+ *   variant: 'TEXT',
+ *   eventType: 'SUBMIT',
+ *   components: []
+ * };
+ * ```
+ *
+ * @experimental This interface may change in future versions
+ */
+export interface EmbeddedFlowComponent {
+    /**
+     * Alignment of children along the cross axis (for Stack components).
+     */
+    align?: string;
+    /**
+     * Alternative text for Image components.
+     */
+    alt?: string;
+    /**
+     * Icon color, CSS color value (for Icon components).
+     */
+    color?: string;
+    /**
+     * Nested child components for container components like Block and Stack.
+     */
+    components?: EmbeddedFlowComponent[];
+    /**
+     * Layout direction for Stack components ('row' | 'column').
+     */
+    direction?: string;
+    /**
+     * Icon to render at the end of an Action button (URL string).
+     */
+    endIcon?: string;
+    /**
+     * Event type for action components that defines the interaction behavior.
+     * Only relevant for Action components.
+     */
+    eventType?: EmbeddedFlowEventType | string;
+    /**
+     * Gap between children in Stack components (number, maps to spacing units).
+     */
+    gap?: number;
+    /**
+     * Height of the component (for Image components, can be string with units or number for pixels).
+     * The value depends on the component type (e.g., for Image components).
+     */
+    height?: string | number;
+    /**
+     * Unique identifier for the component
+     */
+    id: string;
+    /**
+     * Number of items across the main axis (for Stack grid-like layouts).
+     */
+    items?: string | number;
+    /**
+     * Justification of children along the main axis (for Stack components).
+     */
+    justify?: string;
+    /**
+     * Display label for the component (e.g., field label, button text).
+     * Supports internationalization and may contain template strings.
+     */
+    label?: string;
+    /**
+     * Icon name for Icon components (e.g., lucide-react icon names like 'ArrowLeftRight').
+     */
+    name?: string;
+    /**
+     * Options for SELECT components.
+     * Each option can be a string value or an object with value and label.
+     */
+    options?: (string | {
+        label: string;
+        value: string;
+    })[];
+    /**
+     * Placeholder text for input components.
+     * Provides helpful hints to users about expected input format.
+     */
+    placeholder?: string;
+    /**
+     * Reference identifier for the component (e.g., field name, action ref)
+     */
+    ref?: string;
+    /**
+     * Indicates whether this component represents a required field.
+     * Used for form validation and UI indicators.
+     */
+    required?: boolean;
+    /**
+     * Icon size in pixels (for Icon components).
+     */
+    size?: number;
+    /**
+     * Data source key for dynamic components (e.g., COPYABLE_TEXT).
+     * References a key in additionalData whose value is resolved at render time.
+     */
+    source?: string;
+    /**
+     * Image source URL (for Image components).
+     */
+    src?: string;
+    /**
+     * Icon to render at the start of an Action button (URL string).
+     */
+    startIcon?: string;
+    /**
+     * Component type that determines rendering behavior
+     */
+    type: EmbeddedFlowComponentType | string;
+    /**
+     * Component variant that affects visual styling and behavior.
+     * The value depends on the component type (e.g., button variants, text variants).
+     */
+    variant?: EmbeddedFlowActionVariant | EmbeddedFlowTextVariant | string;
+    /**
+     * Width of the component (for Image components, can be string with units or number for pixels).
+     * The value depends on the component type (e.g., for Image components).
+     */
+    width?: string | number;
+}
+/**
+ * Response data structure for embedded flow API.
+ *
+ * This interface defines the structure of data returned by the API,
+ * which includes both legacy input/action arrays for backward compatibility
+ * and the new meta.components structure for modern component-driven UIs.
+ *
+ * The key improvement is the meta.components field, which provides
+ * a rich component tree with proper labels, placeholders, and hierarchy
+ * that can be directly rendered without additional transformation.
+ *
+ * @example
+ * ```typescript
+ * const response: EmbeddedFlowResponseData = {
+ *   // Legacy format (for backward compatibility)
+ *   inputs: [
+ *     { ref: 'input_001', identifier: 'username', type: 'TEXT_INPUT', required: true }
+ *   ],
+ *   actions: [
+ *     { ref: 'action_001', nextNode: 'basic_auth', eventType: 'SUBMIT' }
+ *   ],
+ *   // Modern format (recommended)
+ *   meta: {
+ *     components: [
+ *       {
+ *         id: 'text_001',
+ *         type: 'TEXT',
+ *         label: '{{ t(signin:heading.label) }}',
+ *         variant: 'HEADING_1'
+ *       },
+ *       {
+ *         id: 'block_001',
+ *         type: 'BLOCK',
+ *         components: [
+ *           {
+ *             id: 'input_001',
+ *             type: 'TEXT_INPUT',
+ *             label: '{{ t(signin:fields.username.label) }}',
+ *             placeholder: '{{ t(signin:fields.username.placeholder) }}',
+ *             required: true
+ *           },
+ *           {
+ *             id: 'action_001',
+ *             type: 'ACTION',
+ *             label: '{{ t(signin:buttons.submit.label) }}',
+ *             variant: 'PRIMARY',
+ *             eventType: 'ACTIVATE'
+ *           }
+ *         ]
+ *       }
+ *     ]
+ *   }
+ * };
+ * ```
+ *
+ * @experimental This structure may change in future versions
+ */
+export interface EmbeddedFlowResponseData {
+    /**
+     * Legacy action definitions for backward compatibility.
+     * @deprecated Use meta.components for new implementations
+     */
+    actions?: {
+        /** Event type for the action (SUBMIT, ACTIVATE, etc.) */
+        eventType?: string;
+        /** Next flow node to navigate to (optional) */
+        nextNode?: string;
+        /** Reference identifier for the action */
+        ref: string;
+    }[];
+    /**
+     * Additional data dictionary for dynamic flow response properties.
+     * Can be used to pass custom data like passkey challenges, server alerts, etc.
+     */
+    additionalData?: Record<string, any>;
+    /**
+     * Legacy input definitions for backward compatibility.
+     * @deprecated Use meta.components for new implementations
+     */
+    inputs?: {
+        /** Field identifier used in form submission */
+        identifier: string;
+        /** Reference identifier for the input */
+        ref: string;
+        /** Whether this input is required for form submission */
+        required: boolean;
+        /** Input type (TEXT_INPUT, PASSWORD_INPUT, etc.) */
+        type: string;
+    }[];
+    /**
+     * Modern component-driven metadata structure.
+     * This contains the complete UI component tree with proper
+     * hierarchy, labels, and configuration that can be directly rendered.
+     *
+     * **This is the primary data source for implementations.**
+     * The legacy inputs/actions arrays are maintained only for backward compatibility.
+     */
+    meta?: {
+        /** Array of components that define the complete UI structure */
+        components: EmbeddedFlowComponent[];
+    };
+    /**
+     * Optional redirect URL for flow completion or external authentication.
+     */
+    redirectURL?: string;
+}
+/**
+ * Individual consent attribute/element decision.
+ *
+ * @experimental This interface may change in future versions
+ */
+export interface ConsentAttributeElement {
+    /** Whether the user approved collection of this attribute */
+    approved: boolean;
+    /** The name of the attribute being consented */
+    name: string;
+}
+/**
+ * Consent decision for a single purpose.
+ *
+ * @experimental This interface may change in future versions
+ */
+export interface ConsentPurposeDecision {
+    /** Whether the user approved this purpose */
+    approved: boolean;
+    /** Per-attribute decisions for this purpose */
+    elements: ConsentAttributeElement[];
+    /** The name of the consent purpose */
+    purposeName: string;
+}
+/**
+ * Full consent decisions structure sent to the backend when user submits the consent form.
+ *
+ * @experimental This interface may change in future versions
+ */
+export interface ConsentDecisions {
+    /** Array of per-purpose decisions */
+    purposes: ConsentPurposeDecision[];
+}
+/**
+ * Single consent purpose data returned by the backend in additionalData.consent_prompt.
+ *
+ * @experimental This interface may change in future versions
+ */
+export interface ConsentPurposeData {
+    /** Optional human-readable description of the purpose */
+    description?: string;
+    /** Attributes that are always required and cannot be declined */
+    essential: string[];
+    /** Attributes that the user can optionally decline */
+    optional: string[];
+    /** Unique identifier for the purpose */
+    purposeId: string;
+    /** Human-readable purpose name */
+    purposeName?: string;
+}
+/**
+ * Consent prompt data structure stored in additionalData.consent_prompt.
+ *
+ * @experimental This interface may change in future versions
+ */
+export interface ConsentPromptData {
+    /** Array of consent purposes requiring user review */
+    purposes: ConsentPurposeData[];
+}
+/**
+ * Extended request configuration for ThunderID V2 embedded flow operations.
+ *
+ * This interface extends the base request configuration with V2-specific
+ * properties required for the enhanced embedded flow API. The authId parameter
+ * is particularly important for the V2 OAuth2 flow completion process.
+ *
+ * @template T The type of the payload data being sent with the request
+ *
+ * @example
+ * ```typescript
+ * const config: EmbeddedFlowExecuteRequestConfigV2 = {
+ *   baseUrl: 'https://api.asgardeo.io/t/myorg',
+ *   payload: {
+ *     flowType: 'AUTHENTICATION',
+ *     inputs: { username: 'user@example.com' }
+ *   },
+ *   authId: 'auth_12345', // V2-specific for OAuth completion
+ *   headers: {
+ *     'Authorization': 'Bearer token'
+ *   }
+ * };
+ * ```
+ *
+ * @experimental This configuration is part of the new ThunderID V2 platform
+ */
+export interface EmbeddedFlowExecuteRequestConfig<T = any> extends EmbeddedFlowExecuteRequestConfigV1<T> {
+    /**
+     * Authentication ID used for OAuth2 flow completion in V2 API.
+     *
+     * When the embedded flow completes successfully and returns an assertion,
+     * this authId is used to complete the OAuth2 authorization flow by calling
+     * the `/oauth2/auth/callback` endpoint. This enables seamless transition from
+     * embedded flow to traditional OAuth2 flow completion.
+     *
+     * @example "auth_abc123def456"
+     */
+    authId?: string;
+}
+//# sourceMappingURL=embedded-flow-v2.d.ts.map

package/dist/models/v2/embedded-flow-v2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedded-flow-v2.d.ts","sourceRoot":"","sources":["../../../src/models/v2/embedded-flow-v2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAC,gCAAgC,IAAI,kCAAkC,EAAC,MAAM,kBAAkB,CAAC;AAExG;;;;;;;;;;;;;;;;;;GAkBG;AACH,oBAAY,yBAAyB;IACnC,0EAA0E;IAC1E,MAAM,WAAW;IAEjB,6DAA6D;IAC7D,KAAK,UAAU;IAEf,uEAAuE;IACvE,OAAO,YAAY;IAEnB,sFAAsF;IACtF,YAAY,kBAAkB;IAE9B,yDAAyD;IACzD,OAAO,YAAY;IAEnB,6DAA6D;IAC7D,UAAU,gBAAgB;IAE1B,8DAA8D;IAC9D,IAAI,SAAS;IAEb,0DAA0D;IAC1D,KAAK,UAAU;IAEf,oEAAoE;IACpE,QAAQ,cAAc;IAEtB,wDAAwD;IACxD,QAAQ,cAAc;IAEtB,2DAA2D;IAC3D,aAAa,mBAAmB;IAEhC,yDAAyD;IACzD,UAAU,gBAAgB;IAE1B,sEAAsE;IACtE,QAAQ,cAAc;IAEtB,kEAAkE;IAClE,MAAM,WAAW;IAEjB,uEAAuE;IACvE,KAAK,UAAU;IAEf,gEAAgE;IAChE,IAAI,SAAS;IAEb,oDAAoD;IACpD,SAAS,eAAe;IAExB,iDAAiD;IACjD,KAAK,UAAU;CAChB;AAED;;;;GAIG;AACH,oBAAY,yBAAyB;IACnC,sDAAsD;IACtD,MAAM,WAAW;IAEjB,oDAAoD;IACpD,IAAI,SAAS;IAEb,gCAAgC;IAChC,IAAI,SAAS;IAEb,oDAAoD;IACpD,QAAQ,aAAa;IAErB,yDAAyD;IACzD,OAAO,YAAY;IAEnB,4DAA4D;IAC5D,SAAS,cAAc;IAEvB,uDAAuD;IACvD,OAAO,YAAY;IAEnB,0DAA0D;IAC1D,QAAQ,aAAa;IAErB,mDAAmD;IACnD,OAAO,YAAY;CACpB;AAED;;;;GAIG;AACH,oBAAY,uBAAuB;IACjC,yCAAyC;IACzC,KAAK,WAAW;IAEhB,oDAAoD;IACpD,KAAK,WAAW;IAEhB,oCAAoC;IACpC,UAAU,gBAAgB;IAE1B,0DAA0D;IAC1D,OAAO,YAAY;IAEnB,4CAA4C;IAC5C,QAAQ,cAAc;IAEtB,8CAA8C;IAC9C,QAAQ,cAAc;IAEtB,0CAA0C;IAC1C,QAAQ,cAAc;IAEtB,8CAA8C;IAC9C,QAAQ,cAAc;IAEtB,gDAAgD;IAChD,QAAQ,cAAc;IAEtB,uDAAuD;IACvD,QAAQ,cAAc;IAEtB,8CAA8C;IAC9C,QAAQ,aAAa;IAErB,iDAAiD;IACjD,SAAS,eAAe;IAExB,qDAAqD;IACrD,SAAS,eAAe;CACzB;AAED;;;;GAIG;AACH,oBAAY,qBAAqB;IAC/B,yCAAyC;IACzC,IAAI,SAAS;IAEb,mCAAmC;IACnC,MAAM,WAAW;IAEjB,gDAAgD;IAChD,QAAQ,aAAa;IAErB,yCAAyC;IACzC,KAAK,UAAU;IAEf,qCAAqC;IACrC,MAAM,WAAW;IAEjB,iCAAiC;IACjC,OAAO,YAAY;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,qBAAqB,GAAG,MAAM,CAAC;IAE3C;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAExB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,MAAM,GAAG;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,CAAC,EAAE,CAAC;IAEtD;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,yBAAyB,GAAG,MAAM,CAAC;IAEzC;;;OAGG;IACH,OAAO,CAAC,EAAE,yBAAyB,GAAG,uBAAuB,GAAG,MAAM,CAAC;IAEvE;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwDG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE;QACR,yDAAyD;QACzD,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,+CAA+C;QAC/C,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,0CAA0C;QAC1C,GAAG,EAAE,MAAM,CAAC;KACb,EAAE,CAAC;IAEJ;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAErC;;;OAGG;IACH,MAAM,CAAC,EAAE;QACP,+CAA+C;QAC/C,UAAU,EAAE,MAAM,CAAC;QACnB,yCAAyC;QACzC,GAAG,EAAE,MAAM,CAAC;QACZ,yDAAyD;QACzD,QAAQ,EAAE,OAAO,CAAC;QAClB,oDAAoD;QACpD,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;IAEJ;;;;;;;OAOG;IACH,IAAI,CAAC,EAAE;QACL,gEAAgE;QAChE,UAAU,EAAE,qBAAqB,EAAE,CAAC;KACrC,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,6DAA6D;IAC7D,QAAQ,EAAE,OAAO,CAAC;IAClB,gDAAgD;IAChD,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,6CAA6C;IAC7C,QAAQ,EAAE,OAAO,CAAC;IAClB,+CAA+C;IAC/C,QAAQ,EAAE,uBAAuB,EAAE,CAAC;IACpC,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qCAAqC;IACrC,QAAQ,EAAE,sBAAsB,EAAE,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,yDAAyD;IACzD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iEAAiE;IACjE,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,sDAAsD;IACtD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,wCAAwC;IACxC,SAAS,EAAE,MAAM,CAAC;IAClB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,sDAAsD;IACtD,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,gCAAgC,CAAC,CAAC,GAAG,GAAG,CAAE,SAAQ,kCAAkC,CAAC,CAAC,CAAC;IACtG;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/dist/models/v2/embedded-recovery-flow-v2.d.ts

@@ -0,0 +1,143 @@
+/**
+ * Copyright (c) 2026, WSO2 LLC. (https://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you under the Apache License,
+ * Version 2.0 (the "License"); you may not use this file except
+ * in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { EmbeddedFlowType } from '../embedded-flow';
+/**
+ * Status enumeration for the embedded recovery flow operations.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export declare enum EmbeddedRecoveryFlowStatus {
+    /**
+     * Recovery flow completed successfully.
+     */
+    Complete = "COMPLETE",
+    /**
+     * Recovery flow encountered an error and cannot proceed.
+     *
+     * @see {@link EmbeddedRecoveryFlowErrorResponse} for error response structure
+     */
+    Error = "ERROR",
+    /**
+     * Recovery flow requires additional user input.
+     */
+    Incomplete = "INCOMPLETE"
+}
+/**
+ * Type enumeration for embedded recovery flow responses.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export declare enum EmbeddedRecoveryFlowType {
+    /**
+     * Response requires external redirection.
+     */
+    Redirection = "REDIRECTION",
+    /**
+     * Response contains view components for rendering.
+     */
+    View = "VIEW"
+}
+/**
+ * Response structure for the embedded recovery flow.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export interface EmbeddedRecoveryFlowResponse {
+    /**
+     * Per-step challenge token for replay protection.
+     * Must be included in the next request to continue this flow.
+     */
+    challengeToken?: string;
+    /**
+     * Flow data containing UI components for the current step.
+     */
+    data: {
+        /**
+         * Additional data from the flow step.
+         */
+        additionalData?: Record<string, any>;
+        /**
+         * UI components to render for the current step.
+         */
+        components?: any[];
+        /**
+         * Redirect URL if type is REDIRECTION.
+         */
+        redirectURL?: string;
+    };
+    /**
+     * Unique identifier for this recovery flow execution.
+     */
+    executionId: string;
+    /**
+     * Optional reason for failure when flowStatus is ERROR.
+     */
+    failureReason?: string;
+    /**
+     * Current status of the recovery flow.
+     */
+    flowStatus: EmbeddedRecoveryFlowStatus;
+    /**
+     * Type of response, indicating the expected user interaction.
+     */
+    type: EmbeddedRecoveryFlowType;
+}
+/**
+ * Request payload for initiating the embedded recovery flow.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export interface EmbeddedRecoveryFlowInitiateRequest {
+    applicationId?: string;
+    flowType: EmbeddedFlowType.Recovery;
+}
+/**
+ * Request payload for executing steps in the embedded recovery flow.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export interface EmbeddedRecoveryFlowRequest extends Partial<EmbeddedRecoveryFlowInitiateRequest> {
+    action?: string;
+    challengeToken?: string;
+    executionId?: string;
+    inputs?: Record<string, any>;
+}
+/**
+ * Error response structure for the embedded recovery flow.
+ *
+ * @experimental Part of the new ThunderID API
+ */
+export interface EmbeddedRecoveryFlowErrorResponse {
+    /**
+     * Additional response data, typically empty for error responses.
+     */
+    data: Record<string, any>;
+    /**
+     * Unique identifier for the recovery flow instance that failed.
+     */
+    executionId: string;
+    /**
+     * Human-readable explanation of why the recovery operation failed.
+     */
+    failureReason: string;
+    /**
+     * Status of the recovery flow — always ERROR for this interface.
+     */
+    flowStatus: EmbeddedRecoveryFlowStatus;
+}
+//# sourceMappingURL=embedded-recovery-flow-v2.d.ts.map

package/dist/models/v2/embedded-recovery-flow-v2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedded-recovery-flow-v2.d.ts","sourceRoot":"","sources":["../../../src/models/v2/embedded-recovery-flow-v2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,OAAO,EAAC,gBAAgB,EAAC,MAAM,kBAAkB,CAAC;AAElD;;;;GAIG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,QAAQ,aAAa;IAErB;;;;OAIG;IACH,KAAK,UAAU;IAEf;;OAEG;IACH,UAAU,eAAe;CAC1B;AAED;;;;GAIG;AACH,oBAAY,wBAAwB;IAClC;;OAEG;IACH,WAAW,gBAAgB;IAE3B;;OAEG;IACH,IAAI,SAAS;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE;QACJ;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAErC;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;IAEvC;;OAEG;IACH,IAAI,EAAE,wBAAwB,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,CAAC;CACrC;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,OAAO,CAAC,mCAAmC,CAAC;IAC/F,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,iCAAiC;IAChD;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE1B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,EAAE,0BAA0B,CAAC;CACxC"}