Rename flowId in flow execution to executionId

Author: NutharaNR

packages/javascript/src/api/v2/executeEmbeddedSignInFlowV2.ts

@@ -17,7 +17,7 @@
  */
 
 import AsgardeoAPIError from '../../errors/AsgardeoAPIError';
-import {EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2} from '../../models/v2/embedded-flow-v2';
+import { EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2 } from '../../models/v2/embedded-flow-v2';
 import {
   EmbeddedSignInFlowResponse as EmbeddedSignInFlowResponseV2,
   EmbeddedSignInFlowStatus as EmbeddedSignInFlowStatusV2,
@@ -51,7 +51,7 @@ const executeEmbeddedSignInFlowV2 = async ({
   // `verbose: true` is required to get the `meta` field in the response that includes component details.
   // Add verbose:true if:
   // 1. payload contains only applicationId and flowType
-  // 2. payload contains only flowExecId
+  // 2. payload contains only executionId
   const hasOnlyAppIdAndFlowType: boolean =
     typeof cleanPayload === 'object' &&
     cleanPayload !== null &&
@@ -61,11 +61,11 @@ const executeEmbeddedSignInFlowV2 = async ({
   const hasOnlyFlowId: boolean =
     typeof cleanPayload === 'object' &&
     cleanPayload !== null &&
-    'flowExecId' in cleanPayload &&
+    'executionId' in cleanPayload &&
     Object.keys(cleanPayload).length === 1;
 
   const requestPayload: Record<string, unknown> =
-    hasOnlyAppIdAndFlowType || hasOnlyFlowId ? {...cleanPayload, verbose: true} : cleanPayload;
+    hasOnlyAppIdAndFlowType || hasOnlyFlowId ? { ...cleanPayload, verbose: true } : cleanPayload;
 
   const response: Response = await fetch(endpoint, {
     ...requestConfig,

packages/javascript/src/api/v2/executeEmbeddedSignUpFlowV2.ts

@@ -17,7 +17,7 @@
  */
 
 import AsgardeoAPIError from '../../errors/AsgardeoAPIError';
-import {EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2} from '../../models/v2/embedded-flow-v2';
+import { EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2 } from '../../models/v2/embedded-flow-v2';
 import {
   EmbeddedSignUpFlowResponse as EmbeddedSignUpFlowResponseV2,
   EmbeddedSignUpFlowStatus as EmbeddedSignUpFlowStatusV2,
@@ -51,7 +51,7 @@ const executeEmbeddedSignUpFlowV2 = async ({
   // `verbose: true` is required to get the `meta` field in the response that includes component details.
   // Add verbose:true if:
   // 1. payload contains only applicationId and flowType
-  // 2. payload contains only flowExecId
+  // 2. payload contains only executionId
   const hasOnlyAppIdAndFlowType: boolean =
     typeof cleanPayload === 'object' &&
     cleanPayload !== null &&
@@ -61,11 +61,11 @@ const executeEmbeddedSignUpFlowV2 = async ({
   const hasOnlyFlowId: boolean =
     typeof cleanPayload === 'object' &&
     cleanPayload !== null &&
-    'flowExecId' in cleanPayload &&
+    'executionId' in cleanPayload &&
     Object.keys(cleanPayload).length === 1;
 
   const requestPayload: Record<string, unknown> =
-    hasOnlyAppIdAndFlowType || hasOnlyFlowId ? {...cleanPayload, verbose: true} : cleanPayload;
+    hasOnlyAppIdAndFlowType || hasOnlyFlowId ? { ...cleanPayload, verbose: true } : cleanPayload;
 
   const response: Response = await fetch(endpoint, {
     ...requestConfig,

packages/javascript/src/api/v2/executeEmbeddedUserOnboardingFlowV2.ts

@@ -17,8 +17,8 @@
  */
 
 import AsgardeoAPIError from '../../errors/AsgardeoAPIError';
-import {EmbeddedFlowType} from '../../models/embedded-flow';
-import {EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2} from '../../models/v2/embedded-flow-v2';
+import { EmbeddedFlowType } from '../../models/embedded-flow';
+import { EmbeddedFlowExecuteRequestConfig as EmbeddedFlowExecuteRequestConfigV2 } from '../../models/v2/embedded-flow-v2';
 
 /**
  * Response from the user onboarding flow execution.
@@ -47,7 +47,7 @@ export interface EmbeddedUserOnboardingFlowResponse {
   /**
    * Unique identifier for the flow execution.
    */
-  flowExecId: string;
+  executionId: string;
 
   /**
    * Current status of the flow.
@@ -88,7 +88,7 @@ export interface EmbeddedUserOnboardingFlowResponse {
  * const response = await executeEmbeddedUserOnboardingFlowV2({
  *   baseUrl: "https://api.thunder.io",
  *   payload: {
- *     flowExecId: "flow-id-from-url",
+ *     executionId: "flow-id-from-url",
  *     inputs: { inviteToken: "token-from-url" }
  *   }
  * });
@@ -128,17 +128,17 @@ const executeEmbeddedUserOnboardingFlowV2 = async ({
   const hasOnlyFlowId: boolean =
     typeof cleanPayload === 'object' &&
     cleanPayload !== null &&
-    'flowExecId' in cleanPayload &&
+    'executionId' in cleanPayload &&
     Object.keys(cleanPayload).length === 1;
   const hasFlowIdWithInputs: boolean =
     typeof cleanPayload === 'object' &&
     cleanPayload !== null &&
-    'flowExecId' in cleanPayload &&
+    'executionId' in cleanPayload &&
     'inputs' in cleanPayload;
 
   // Add verbose for initial requests and when continuing with inputs
   const requestPayload: Record<string, unknown> =
-    hasOnlyFlowType || hasOnlyFlowId || hasFlowIdWithInputs ? {...cleanPayload, verbose: true} : cleanPayload;
+    hasOnlyFlowType || hasOnlyFlowId || hasFlowIdWithInputs ? { ...cleanPayload, verbose: true } : cleanPayload;
 
   // Ensure flowType is USER_ONBOARDING for initial requests
   if ('flowType' in requestPayload && requestPayload['flowType'] !== EmbeddedFlowType.UserOnboarding) {

packages/javascript/src/models/v2/embedded-signin-flow-v2.ts

@@ -16,7 +16,7 @@
  * under the License.
  */
 
-import {EmbeddedFlowResponseData as EmbeddedFlowResponseDataV2} from './embedded-flow-v2';
+import { EmbeddedFlowResponseData as EmbeddedFlowResponseDataV2 } from './embedded-flow-v2';
 import {
   EmbeddedFlowResponseType as EmbeddedFlowResponseTypeV1,
   EmbeddedFlowType as EmbeddedFlowTypeV1,
@@ -145,7 +145,7 @@ export interface ExtendedEmbeddedSignInFlowResponse {
  * @example
  * ```typescript
  * const response: EmbeddedSignInFlowResponse = {
- *   flowExecId: "flow_12345",
+ *   executionId: "flow_12345",
  *   flowStatus: EmbeddedSignInFlowStatus.Incomplete,
  *   type: EmbeddedSignInFlowType.View,
  *   data: {
@@ -206,7 +206,7 @@ export interface EmbeddedSignInFlowResponse extends ExtendedEmbeddedSignInFlowRe
    * Unique identifier for this specific flow instance.
    * Used to maintain state across multiple API calls during the authentication process.
    */
-  flowExecId: string;
+  executionId: string;
 
   /**
    * Current status of the sign-in flow.
@@ -292,14 +292,14 @@ export type EmbeddedSignInFlowInitiateRequest = {
  * Request payload for executing steps in Asgardeo embedded sign-in flows.
  *
  * This interface defines the structure for subsequent requests after flow initiation.
- * It supports both continuing existing flows (with flowExecId) and submitting user
+ * It supports both continuing existing flows (with executionId) and submitting user
  * input data collected from the rendered components.
  *
  * @example
  * ```typescript
  * // Continue existing flow with user input
  * const stepRequest: EmbeddedSignInFlowRequest = {
- *   flowExecId: "flow_12345",
+ *   executionId: "flow_12345",
  *   action: "action_001",
  *   inputs: {
  *     username: "user@example.com",
@@ -327,7 +327,7 @@ export interface EmbeddedSignInFlowRequest extends Partial<EmbeddedSignInFlowIni
    * Identifier of the flow instance to continue.
    * Required when submitting data for an existing flow.
    */
-  flowExecId?: string;
+  executionId?: string;
 
   /**
    * User input data collected from the form components.

packages/javascript/src/models/v2/embedded-signup-flow-v2.ts

@@ -173,7 +173,7 @@ export interface EmbeddedSignUpFlowResponse extends ExtendedEmbeddedSignUpFlowRe
   /**
    * Unique identifier for this sign-up flow instance.
    */
-  flowExecId: string;
+  executionId: string;
 
   /**
    * Current status of the sign-up flow.
@@ -210,7 +210,7 @@ export type EmbeddedSignUpFlowInitiateRequest = {
  */
 export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowInitiateRequest> {
   action?: string;
-  flowExecId?: string;
+  executionId?: string;
   inputs?: Record<string, any>;
 }
 
@@ -223,7 +223,7 @@ export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowIni
  *
  * **Key Differences from AsgardeoV1:**
  * - Uses `failureReason` instead of `message`/`description` for error details
- * - Maintains flow context with `flowExecId` for tracking failed operations
+ * - Maintains flow context with `executionId` for tracking failed operations
  * - Uses structured `flowStatus` enum instead of generic error codes
  * - Provides empty `data` object for consistency with success responses
  *
@@ -236,7 +236,7 @@ export interface EmbeddedSignUpFlowRequest extends Partial<EmbeddedSignUpFlowIni
  * ```typescript
  * // Typical Asgardeo error response
  * const errorResponse: EmbeddedSignUpFlowErrorResponse = {
- *   flowExecId: "0ccfeaf9-18b3-43a5-bcc1-07d863dcb2c0",
+ *   executionId: "0ccfeaf9-18b3-43a5-bcc1-07d863dcb2c0",
  *   flowStatus: EmbeddedSignUpFlowStatus.Error,
  *   data: {},
  *   failureReason: "User already exists with the provided username."
@@ -277,7 +277,7 @@ export interface EmbeddedSignUpFlowErrorResponse {
    * This ID is used to track the flow state and correlate error responses
    * with the specific sign-up attempt that failed.
    */
-  flowExecId: string;
+  executionId: string;
 
   /**
    * Status of the sign-up flow, which will be `EmbeddedSignUpFlowStatus.Error`

packages/react/src/AsgardeoReactClient.ts

@@ -58,7 +58,7 @@ import getAllOrganizations from './api/getAllOrganizations';
 import getMeOrganizations from './api/getMeOrganizations';
 import getSchemas from './api/getSchemas';
 import getScim2Me from './api/getScim2Me';
-import {AsgardeoReactConfig} from './models/config';
+import { AsgardeoReactConfig } from './models/config';
 
 /**
  * Client for mplementing Asgardeo in React applications.
@@ -172,8 +172,8 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
         baseUrl = configData?.baseUrl;
       }
 
-      const profile: User = await getScim2Me({baseUrl});
-      const schemas: any = await getSchemas({baseUrl});
+      const profile: User = await getScim2Me({ baseUrl });
+      const schemas: any = await getSchemas({ baseUrl });
 
       return generateUserProfile(profile, flattenUserSchema(schemas));
     } catch (error) {
@@ -199,8 +199,8 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
           baseUrl = configData?.baseUrl;
         }
 
-        const profile: User = await getScim2Me({baseUrl, instanceId: this.getInstanceId()});
-        const schemas: any = await getSchemas({baseUrl, instanceId: this.getInstanceId()});
+        const profile: User = await getScim2Me({ baseUrl, instanceId: this.getInstanceId() });
+        const schemas: any = await getSchemas({ baseUrl, instanceId: this.getInstanceId() });
 
         const processedSchemas: any = flattenUserSchema(schemas);
 
@@ -230,11 +230,10 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
         baseUrl = configData?.baseUrl;
       }
 
-      return await getMeOrganizations({baseUrl, instanceId: this.getInstanceId()});
+      return await getMeOrganizations({ baseUrl, instanceId: this.getInstanceId() });
     } catch (error) {
       throw new AsgardeoRuntimeError(
-        `Failed to fetch the user's associated organizations: ${
-          error instanceof Error ? error.message : String(error)
+        `Failed to fetch the user's associated organizations: ${error instanceof Error ? error.message : String(error)
         }`,
         'AsgardeoReactClient-getMyOrganizations-RuntimeError-001',
         'react',
@@ -252,7 +251,7 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
         baseUrl = configData?.baseUrl;
       }
 
-      return await getAllOrganizations({baseUrl, instanceId: this.getInstanceId()});
+      return await getAllOrganizations({ baseUrl, instanceId: this.getInstanceId() });
     } catch (error) {
       throw new AsgardeoRuntimeError(
         `Failed to fetch all organizations: ${error instanceof Error ? error.message : String(error)}`,
@@ -312,7 +311,7 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
           signInRequired: sourceInstanceId === undefined,
         };
 
-        return (await this.asgardeo.exchangeToken(exchangeConfig, () => {})) as TokenResponse | Response;
+        return (await this.asgardeo.exchangeToken(exchangeConfig, () => { })) as TokenResponse | Response;
       } catch (error) {
         throw new AsgardeoRuntimeError(
           `Failed to switch organization: ${error.message || error}`,
@@ -342,7 +341,7 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
 
   override async exchangeToken(config: TokenExchangeRequestConfig): Promise<TokenResponse | Response> {
     return this.withLoading(
-      async () => this.asgardeo.exchangeToken(config, () => {}) as unknown as TokenResponse | Response,
+      async () => this.asgardeo.exchangeToken(config, () => { }) as unknown as TokenResponse | Response,
     );
   }
 
@@ -385,7 +384,7 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
         typeof arg1 === 'object' &&
         arg1 !== null &&
         !isEmpty(arg1) &&
-        ('flowExecId' in arg1 || 'applicationId' in arg1)
+        ('executionId' in arg1 || 'applicationId' in arg1)
       ) {
         const authIdFromUrl: string = new URL(window.location.href).searchParams.get('authId');
         const authIdFromStorage: string = sessionStorage.getItem('asgardeo_auth_id');
@@ -514,7 +513,7 @@ class AsgardeoReactClient<T extends AsgardeoReactConfig = AsgardeoReactConfig> e
         baseUrl,
         payload:
           typeof firstArg === 'object' && 'flowType' in firstArg
-            ? {...(firstArg as EmbeddedFlowExecuteRequestPayload), verbose: true}
+            ? { ...(firstArg as EmbeddedFlowExecuteRequestPayload), verbose: true }
             : (firstArg as EmbeddedFlowExecuteRequestPayload),
       }) as any;
     }

packages/react/src/components/presentation/auth/AcceptInvite/v2/AcceptInvite.tsx

@@ -16,8 +16,8 @@
  * under the License.
  */
 
-import {FC, ReactElement, ReactNode, useMemo} from 'react';
-import BaseAcceptInvite, {BaseAcceptInviteRenderProps, AcceptInviteFlowResponse} from './BaseAcceptInvite';
+import { FC, ReactElement, ReactNode, useMemo } from 'react';
+import BaseAcceptInvite, { BaseAcceptInviteRenderProps, AcceptInviteFlowResponse } from './BaseAcceptInvite';
 
 /**
  * Render props for AcceptInvite (re-exported for convenience).
@@ -49,7 +49,7 @@ export interface AcceptInviteProps {
    * Flow ID from the invite link.
    * If not provided, will be extracted from URL query parameters.
    */
-  flowExecId?: string;
+  executionId?: string;
 
   /**
    * Invite token from the invite link.
@@ -101,14 +101,14 @@ export interface AcceptInviteProps {
 /**
  * Helper to extract query parameters from URL.
  */
-const getUrlParams = (): {flowExecId?: string; inviteToken?: string} => {
+const getUrlParams = (): { executionId?: string; inviteToken?: string } => {
   if (typeof window === 'undefined') {
     return {};
   }
 
   const params: any = new URLSearchParams(window.location.search);
   return {
-    flowExecId: params.get('flowExecId') || undefined,
+    executionId: params.get('executionId') || undefined,
     inviteToken: params.get('inviteToken') || undefined,
   };
 };
@@ -118,7 +118,7 @@ const getUrlParams = (): {flowExecId?: string; inviteToken?: string} => {
  *
  * This component is designed for end users accessing the thunder-gate app via an invite link.
  * It automatically:
- * 1. Extracts flowExecId and inviteToken from URL query parameters
+ * 1. Extracts executionId and inviteToken from URL query parameters
  * 2. Validates the invite token with the backend
  * 3. Displays the password form if token is valid
  * 4. Completes the accept invite when password is set
@@ -127,7 +127,7 @@ const getUrlParams = (): {flowExecId?: string; inviteToken?: string} => {
  * ```tsx
  * import { AcceptInvite } from '@asgardeo/react';
  *
- * // URL: /invite?flowExecId=xxx&inviteToken=yyy
+ * // URL: /invite?executionId=xxx&inviteToken=yyy
  *
  * const AcceptInvitePage = () => {
  *   return (
@@ -153,7 +153,7 @@ const getUrlParams = (): {flowExecId?: string; inviteToken?: string} => {
  */
 const AcceptInvite: FC<AcceptInviteProps> = ({
   baseUrl,
-  flowExecId: flowExecIdProp,
+  executionId: executionIdProp,
   inviteToken: inviteTokenProp,
   onComplete,
   onError,
@@ -167,9 +167,9 @@ const AcceptInvite: FC<AcceptInviteProps> = ({
   showSubtitle = true,
 }: AcceptInviteProps): ReactElement => {
   // Extract from URL if not provided as props
-  const {flowExecId: urlFlowExecId, inviteToken: urlInviteToken} = useMemo(() => getUrlParams(), []);
+  const { executionId: urlexecutionId, inviteToken: urlInviteToken } = useMemo(() => getUrlParams(), []);
 
-  const flowExecId: any = flowExecIdProp || urlFlowExecId;
+  const executionId: any = executionIdProp || urlexecutionId;
   const inviteToken: any = inviteTokenProp || urlInviteToken;
 
   // Determine base URL
@@ -211,7 +211,7 @@ const AcceptInvite: FC<AcceptInviteProps> = ({
 
   return (
     <BaseAcceptInvite
-      flowExecId={flowExecId}
+      executionId={executionId}
       inviteToken={inviteToken}
       onSubmit={handleSubmit}
       onComplete={onComplete}