@asgardeo/javascript 0.7.1 → 0.7.3

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

@@ -36,26 +36,26 @@ import { EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV1
  * @experimental This API may change in future versions
  */
 export declare enum EmbeddedFlowComponentType {
-    /** Standard text input field for user data entry */
-    TextInput = "TEXT_INPUT",
-    /** Password input field with masking for sensitive data */
-    PasswordInput = "PASSWORD_INPUT",
+    /** Interactive action component (buttons, links) for user interactions */
+    Action = "ACTION",
+    /** Container block component that groups other components */
+    Block = "BLOCK",
+    /** Divider component for visual separation of content */
+    Divider = "DIVIDER",
     /** Email input field with validation for email addresses. */
     EmailInput = "EMAIL_INPUT",
     /** One-time password input field for multi-factor authentication */
     OtpInput = "OTP_INPUT",
+    /** Password input field with masking for sensitive data */
+    PasswordInput = "PASSWORD_INPUT",
     /** Phone number input field with country code support */
     PhoneInput = "PHONE_INPUT",
+    /** Select/dropdown input component for single choice selection */
+    Select = "SELECT",
     /** Text display component for labels, headings, and messages */
     Text = "TEXT",
-    /** Interactive action component (buttons, links) for user interactions */
-    Action = "ACTION",
-    /** Container block component that groups other components */
-    Block = "BLOCK",
-    /** Divider component for visual separation of content */
-    Divider = "DIVIDER",
-    /** Select/dropdown input component for single choice selection */
-    Select = "SELECT"
+    /** Standard text input field for user data entry */
+    TextInput = "TEXT_INPUT"
 }
 /**
  * Action variant types for buttons and interactive elements.
@@ -63,24 +63,24 @@ export declare enum EmbeddedFlowComponentType {
  * @experimental This API may change in future versions
  */
 export declare enum EmbeddedFlowActionVariant {
-    /** Primary action button with highest visual emphasis */
-    Primary = "PRIMARY",
-    /** Secondary action button with moderate visual emphasis */
-    Secondary = "SECONDARY",
-    /** Tertiary action button with minimal visual emphasis */
-    Tertiary = "TERTIARY",
     /** Danger action button for destructive operations */
     Danger = "DANGER",
-    /** Success action button for positive confirmations */
-    Success = "SUCCESS",
     /** Info action button for informational purposes */
     Info = "INFO",
-    /** Warning action button for cautionary actions */
-    Warning = "WARNING",
     /** Link-styled action button */
     Link = "LINK",
+    /** Primary action button with highest visual emphasis */
+    Primary = "PRIMARY",
+    /** Secondary action button with moderate visual emphasis */
+    Secondary = "SECONDARY",
     /** Social media action button (e.g., Google, Facebook) */
-    Social = "SOCIAL"
+    Social = "SOCIAL",
+    /** 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.
@@ -88,6 +88,14 @@ export declare enum EmbeddedFlowActionVariant {
  * @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 */
@@ -100,20 +108,12 @@ export declare enum EmbeddedFlowTextVariant {
     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",
-    /** Primary body text for main content */
-    Body1 = "BODY_1",
-    /** Secondary body text for supplementary content */
-    Body2 = "BODY_2",
-    /** Small caption text for annotations and descriptions */
-    Caption = "CAPTION",
-    /** Overline text for labels and categories */
-    Overline = "OVERLINE",
-    /** Text styled for button labels */
-    ButtonText = "BUTTON_TEXT"
+    Subtitle2 = "SUBTITLE_2"
 }
 /**
  * Event types for action components.
@@ -121,18 +121,18 @@ export declare enum EmbeddedFlowTextVariant {
  * @experimental This API may change in future versions
  */
 export declare enum EmbeddedFlowEventType {
-    /** Trigger an action or event */
-    Trigger = "TRIGGER",
-    /** Submit form data to the server */
-    Submit = "SUBMIT",
-    /** Navigate to a different flow step or page */
-    Navigate = "NAVIGATE",
+    /** 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",
-    /** Navigate back to the previous step */
-    Back = "BACK"
+    /** Submit form data to the server */
+    Submit = "SUBMIT",
+    /** Trigger an action or event */
+    Trigger = "TRIGGER"
 }
 /**
  * Enhanced component interface for embedded flow components.
@@ -159,54 +159,54 @@ export declare enum EmbeddedFlowEventType {
  */
 export interface EmbeddedFlowComponent {
     /**
-     * Unique identifier for the component
+     * Nested child components for container components like Block.
      */
-    id: string;
+    components?: EmbeddedFlowComponent[];
     /**
-     * Reference identifier for the component (e.g., field name, action ref)
+     * Event type for action components that defines the interaction behavior.
+     * Only relevant for Action components.
      */
-    ref?: string;
+    eventType?: EmbeddedFlowEventType | string;
     /**
-     * Component type that determines rendering behavior
+     * Unique identifier for the component
      */
-    type: EmbeddedFlowComponentType | string;
+    id: string;
     /**
      * Display label for the component (e.g., field label, button text).
      * Supports internationalization and may contain template strings.
      */
     label?: string;
+    /**
+     * Options for SELECT components.
+     * Each option can be a string value or an object with value and label.
+     */
+    options?: Array<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;
+    /**
+     * 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;
-    /**
-     * Event type for action components that defines the interaction behavior.
-     * Only relevant for Action components.
-     */
-    eventType?: EmbeddedFlowEventType | string;
-    /**
-     * Nested child components for container components like Block.
-     */
-    components?: EmbeddedFlowComponent[];
-    /**
-     * Options for SELECT components.
-     * Each option can be a string value or an object with value and label.
-     */
-    options?: Array<string | {
-        value: string;
-        label: string;
-    }>;
 }
 /**
  * Response data structure for embedded flow API.
@@ -267,30 +267,35 @@ export interface EmbeddedFlowComponent {
  */
 export interface EmbeddedFlowResponseData {
     /**
-     * Legacy input definitions for backward compatibility.
+     * Legacy action definitions for backward compatibility.
      * @deprecated Use meta.components for new implementations
      */
-    inputs?: {
-        /** Reference identifier for the input */
+    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;
-        /** Field identifier used in form submission */
-        identifier: string;
-        /** Input type (TEXT_INPUT, PASSWORD_INPUT, etc.) */
-        type: string;
-        /** Whether this input is required for form submission */
-        required: boolean;
     }[];
     /**
-     * Legacy action definitions for backward compatibility.
+     * 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
      */
-    actions?: {
-        /** Reference identifier for the action */
+    inputs?: {
+        /** Field identifier used in form submission */
+        identifier: string;
+        /** Reference identifier for the input */
         ref: string;
-        /** Next flow node to navigate to (optional) */
-        nextNode?: string;
-        /** Event type for the action (SUBMIT, ACTIVATE, etc.) */
-        eventType?: 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.
@@ -308,11 +313,6 @@ export interface EmbeddedFlowResponseData {
      * Optional redirect URL for flow completion or external authentication.
      */
     redirectURL?: 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>;
 }
 /**
  * Extended request configuration for Asgardeo V2 embedded flow operations.

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

@@ -15,8 +15,8 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { EmbeddedFlowResponseType as EmbeddedFlowResponseTypeV1, EmbeddedFlowType as EmbeddedFlowTypeV1 } from '../embedded-flow';
 import { EmbeddedFlowResponseData as EmbeddedFlowResponseDataV2 } from './embedded-flow-v2';
+import { EmbeddedFlowResponseType as EmbeddedFlowResponseTypeV1, EmbeddedFlowType as EmbeddedFlowTypeV1 } from '../embedded-flow';
 /**
  * Status enumeration for Asgardeo embedded sign-in flow operations.
  *
@@ -50,14 +50,6 @@ export declare enum EmbeddedSignInFlowStatus {
      * assertion data in the response.
      */
     Complete = "COMPLETE",
-    /**
-     * Sign-in flow requires additional user input.
-     *
-     * More authentication steps are needed. The response will contain
-     * components in data.meta.components that should be rendered to
-     * collect additional user input (e.g., MFA, password, etc.).
-     */
-    Incomplete = "INCOMPLETE",
     /**
      * Sign-in flow encountered an error.
      *
@@ -65,7 +57,15 @@ export declare enum EmbeddedSignInFlowStatus {
      * or other issues. Check error details in the response and handle
      * appropriately (retry, show error message, etc.).
      */
-    Error = "ERROR"
+    Error = "ERROR",
+    /**
+     * Sign-in flow requires additional user input.
+     *
+     * More authentication steps are needed. The response will contain
+     * components in data.meta.components that should be rendered to
+     * collect additional user input (e.g., MFA, password, etc.).
+     */
+    Incomplete = "INCOMPLETE"
 }
 /**
  * Type enumeration for Asgardeo embedded sign-in flow responses.
@@ -155,26 +155,6 @@ export interface ExtendedEmbeddedSignInFlowResponse {
  * @experimental This interface is part of the new Asgardeo platform
  */
 export interface EmbeddedSignInFlowResponse extends ExtendedEmbeddedSignInFlowResponse {
-    /**
-     * Unique identifier for this specific flow instance.
-     * Used to maintain state across multiple API calls during the authentication process.
-     */
-    flowId: string;
-    /**
-     * Optional reason for flow failure in case of an error.
-     * Provides additional context when flowStatus is set to ERROR.
-     */
-    failureReason?: string;
-    /**
-     * Current status of the sign-in flow.
-     * Determines the next action required by the client application.
-     */
-    flowStatus: EmbeddedSignInFlowStatus;
-    /**
-     * Type of response indicating how to handle the returned data.
-     * Affects both UI rendering and navigation logic.
-     */
-    type: EmbeddedSignInFlowType;
     /**
      * Core response data containing UI components and flow metadata.
      * Includes both modern meta.components structure and legacy fields for compatibility.
@@ -185,10 +165,10 @@ export interface EmbeddedSignInFlowResponse extends ExtendedEmbeddedSignInFlowRe
          * @deprecated Use data.meta.components for new implementations
          */
         actions?: {
-            /** Action type identifier */
-            type: EmbeddedFlowResponseTypeV1;
             /** Unique action identifier */
             id: string;
+            /** Action type identifier */
+            type: EmbeddedFlowResponseTypeV1;
         }[];
         /**
          * Legacy input field definitions for backward compatibility.
@@ -197,12 +177,32 @@ export interface EmbeddedSignInFlowResponse extends ExtendedEmbeddedSignInFlowRe
         inputs?: {
             /** Field name identifier */
             name: string;
-            /** Input field type */
-            type: string;
             /** Whether the field is required */
             required: boolean;
+            /** Input field type */
+            type: string;
         }[];
     };
+    /**
+     * Optional reason for flow failure in case of an error.
+     * Provides additional context when flowStatus is set to ERROR.
+     */
+    failureReason?: string;
+    /**
+     * Unique identifier for this specific flow instance.
+     * Used to maintain state across multiple API calls during the authentication process.
+     */
+    flowId: string;
+    /**
+     * Current status of the sign-in flow.
+     * Determines the next action required by the client application.
+     */
+    flowStatus: EmbeddedSignInFlowStatus;
+    /**
+     * Type of response indicating how to handle the returned data.
+     * Affects both UI rendering and navigation logic.
+     */
+    type: EmbeddedSignInFlowType;
 }
 /**
  * Response structure for completed Asgardeo embedded sign-in flows.
@@ -297,16 +297,16 @@ export type EmbeddedSignInFlowInitiateRequest = {
  * @experimental This interface is part of the new Asgardeo platform
  */
 export interface EmbeddedSignInFlowRequest extends Partial<EmbeddedSignInFlowInitiateRequest> {
-    /**
-     * Identifier of the flow instance to continue.
-     * Required when submitting data for an existing flow.
-     */
-    flowId?: string;
     /**
      * Identifier of the specific action being triggered.
      * Corresponds to action components in the UI (e.g., submit button, social login).
      */
     action?: string;
+    /**
+     * Identifier of the flow instance to continue.
+     * Required when submitting data for an existing flow.
+     */
+    flowId?: string;
     /**
      * User input data collected from the form components.
      * Keys should match the component identifiers from the response.

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

@@ -51,14 +51,6 @@ export declare enum EmbeddedSignUpFlowStatus {
      * data in the response for next steps.
      */
     Complete = "COMPLETE",
-    /**
-     * Sign-up flow requires additional user input.
-     *
-     * More registration steps are needed. The response will contain
-     * components in data.meta.components that should be rendered to
-     * collect additional user information (e.g., profile data, verification).
-     */
-    Incomplete = "INCOMPLETE",
     /**
      * Sign-up flow encountered an error and cannot proceed.
      *
@@ -69,7 +61,15 @@ export declare enum EmbeddedSignUpFlowStatus {
      *
      * @see {@link EmbeddedSignUpFlowErrorResponse} for error response structure
      */
-    Error = "ERROR"
+    Error = "ERROR",
+    /**
+     * Sign-up flow requires additional user input.
+     *
+     * More registration steps are needed. The response will contain
+     * components in data.meta.components that should be rendered to
+     * collect additional user information (e.g., profile data, verification).
+     */
+    Incomplete = "INCOMPLETE"
 }
 /**
  * Type enumeration for Asgardeo embedded sign-up flow responses.
@@ -130,24 +130,6 @@ export interface ExtendedEmbeddedSignUpFlowResponse {
  * @see {@link EmbeddedSignUpFlowStatus} for available flow statuses
  */
 export interface EmbeddedSignUpFlowResponse extends ExtendedEmbeddedSignUpFlowResponse {
-    /**
-     * Unique identifier for this sign-up flow instance.
-     */
-    flowId: string;
-    /**
-     * Optional reason for flow failure in case of an error.
-     * Provides additional context when flowStatus is set to ERROR.
-     */
-    failureReason?: string;
-    /**
-     * Current status of the sign-up flow.
-     * Determines whether more input is needed or the flow is complete.
-     */
-    flowStatus: EmbeddedSignUpFlowStatus;
-    /**
-     * Type of response, indicating the expected user interaction.
-     */
-    type: EmbeddedSignUpFlowType;
     /**
      * Flow data containing form inputs and available actions.
      * This is transformed to component-driven format by the React transformer.
@@ -157,18 +139,36 @@ export interface EmbeddedSignUpFlowResponse extends ExtendedEmbeddedSignUpFlowRe
          * Available actions the user can take (e.g., form submission, social sign-up).
          */
         actions?: {
-            type: EmbeddedFlowResponseTypeV1;
             id: string;
+            type: EmbeddedFlowResponseTypeV1;
         }[];
         /**
          * Input fields required for the current step of the sign-up flow.
          */
         inputs?: {
             name: string;
-            type: string;
             required: boolean;
+            type: string;
         }[];
     };
+    /**
+     * Optional reason for flow failure in case of an error.
+     * Provides additional context when flowStatus is set to ERROR.
+     */
+    failureReason?: string;
+    /**
+     * Unique identifier for this sign-up flow instance.
+     */
+    flowId: string;
+    /**
+     * Current status of the sign-up flow.
+     * Determines whether more input is needed or the flow is complete.
+     */
+    flowStatus: EmbeddedSignUpFlowStatus;
+    /**
+     * Type of response, indicating the expected user interaction.
+     */
+    type: EmbeddedSignUpFlowType;
 }
 /**
  * Response structure for the new Asgardeo embedded sign-up flow when the flow is complete.
@@ -190,8 +190,8 @@ export type EmbeddedSignUpFlowInitiateRequest = {
  * @experimental
  */
 export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowInitiateRequest> {
-    flowId?: string;
     action?: string;
+    flowId?: string;
     inputs?: Record<string, any>;
 }
 /**
@@ -231,18 +231,6 @@ export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowIni
  * @see {@link EmbeddedSignUpFlowResponse} for the corresponding success response structure
  */
 export interface EmbeddedSignUpFlowErrorResponse {
-    /**
-     * Unique identifier for the sign-up flow instance.
-     * This ID is used to track the flow state and correlate error responses
-     * with the specific sign-up attempt that failed.
-     */
-    flowId: string;
-    /**
-     * Status of the sign-up flow, which will be `EmbeddedSignUpFlowStatus.Error`
-     * for error responses. This field is used by error detection logic to
-     * identify failed flow responses.
-     */
-    flowStatus: EmbeddedSignUpFlowStatus;
     /**
      * Additional response data, typically empty for error responses.
      * Maintained for structural consistency with successful flow responses
@@ -262,4 +250,16 @@ export interface EmbeddedSignUpFlowErrorResponse {
      * that helps users understand and resolve the issue.
      */
     failureReason: string;
+    /**
+     * Unique identifier for the sign-up flow instance.
+     * This ID is used to track the flow state and correlate error responses
+     * with the specific sign-up attempt that failed.
+     */
+    flowId: string;
+    /**
+     * Status of the sign-up flow, which will be `EmbeddedSignUpFlowStatus.Error`
+     * for error responses. This field is used by error detection logic to
+     * identify failed flow responses.
+     */
+    flowStatus: EmbeddedSignUpFlowStatus;
 }