@asgardeo/javascript 0.3.0 → 0.5.0

package/dist/api/v2/executeEmbeddedUserOnboardingFlowV2.d.ts

@@ -0,0 +1,88 @@
+/**
+ * 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 EmbeddedFlowExecuteRequestConfigV2 } from '../../models/v2/embedded-flow-v2';
+/**
+ * Response from the user onboarding flow execution.
+ */
+export interface EmbeddedUserOnboardingFlowResponse {
+    /**
+     * Unique identifier for the flow execution.
+     */
+    flowId: string;
+    /**
+     * Current status of the flow.
+     */
+    flowStatus: 'INCOMPLETE' | 'COMPLETE' | 'ERROR';
+    /**
+     * Type of the current step in the flow.
+     */
+    type?: 'VIEW' | 'REDIRECTION';
+    /**
+     * Data for the current step including components and additional data.
+     */
+    data?: {
+        /**
+         * UI components to render for the current step.
+         */
+        components?: any[];
+        /**
+         * Additional data from the flow step (e.g., inviteLink).
+         */
+        additionalData?: Record<string, string>;
+    };
+    /**
+     * Reason for failure if flowStatus is ERROR.
+     */
+    failureReason?: string;
+}
+/**
+ * Executes an embedded user onboarding flow by sending a request to the flow execution endpoint.
+ *
+ * This function handles both:
+ * - Admin flow: Initiates onboarding, collects user details, generates invite link
+ * - End-user flow: Validates invite token and allows password setting
+ *
+ * @param requestConfig - Request configuration object containing URL, payload, and optional auth token.
+ * @returns A promise that resolves with the flow execution response.
+ * @throws AsgardeoAPIError when the request fails or URL is invalid.
+ *
+ * @example
+ * ```typescript
+ * // Admin initiating user onboarding (requires auth token)
+ * const response = await executeEmbeddedUserOnboardingFlowV2({
+ *   baseUrl: "https://api.thunder.io",
+ *   payload: {
+ *     flowType: "USER_ONBOARDING"
+ *   },
+ *   headers: {
+ *     Authorization: `Bearer ${accessToken}`
+ *   }
+ * });
+ *
+ * // End-user accepting invite (no auth required)
+ * const response = await executeEmbeddedUserOnboardingFlowV2({
+ *   baseUrl: "https://api.thunder.io",
+ *   payload: {
+ *     flowId: "flow-id-from-url",
+ *     inputs: { inviteToken: "token-from-url" }
+ *   }
+ * });
+ * ```
+ */
+declare const executeEmbeddedUserOnboardingFlowV2: ({ url, baseUrl, payload, ...requestConfig }: EmbeddedFlowExecuteRequestConfigV2) => Promise<EmbeddedUserOnboardingFlowResponse>;
+export default executeEmbeddedUserOnboardingFlowV2;

package/dist/cjs/index.js

@@ -75,6 +75,7 @@ __export(index_exports, {
   executeEmbeddedSignInFlowV2: () => executeEmbeddedSignInFlowV2_default,
   executeEmbeddedSignUpFlow: () => executeEmbeddedSignUpFlow_default,
   executeEmbeddedSignUpFlowV2: () => executeEmbeddedSignUpFlowV2_default,
+  executeEmbeddedUserOnboardingFlowV2: () => executeEmbeddedUserOnboardingFlowV2_default,
   extractPkceStorageKeyFromState: () => extractPkceStorageKeyFromState_default,
   extractUserClaimsFromIdToken: () => extractUserClaimsFromIdToken_default,
   flattenUserSchema: () => flattenUserSchema_default,
@@ -2166,6 +2167,7 @@ var executeEmbeddedSignInFlow_default = executeEmbeddedSignInFlow;
 var EmbeddedFlowType = /* @__PURE__ */ ((EmbeddedFlowType2) => {
   EmbeddedFlowType2["Authentication"] = "AUTHENTICATION";
   EmbeddedFlowType2["Registration"] = "REGISTRATION";
+  EmbeddedFlowType2["UserOnboarding"] = "USER_ONBOARDING";
   return EmbeddedFlowType2;
 })(EmbeddedFlowType || {});
 var EmbeddedFlowStatus = /* @__PURE__ */ ((EmbeddedFlowStatus2) => {
@@ -3171,6 +3173,56 @@ var executeEmbeddedSignUpFlowV2 = async ({
 };
 var executeEmbeddedSignUpFlowV2_default = executeEmbeddedSignUpFlowV2;
 
+// src/api/v2/executeEmbeddedUserOnboardingFlowV2.ts
+var executeEmbeddedUserOnboardingFlowV2 = async ({
+  url,
+  baseUrl,
+  payload,
+  ...requestConfig
+}) => {
+  if (!payload) {
+    throw new AsgardeoAPIError(
+      "User onboarding payload is required",
+      "executeEmbeddedUserOnboardingFlow-ValidationError-002",
+      "javascript",
+      400,
+      "If a user onboarding payload is not provided, the request cannot be constructed correctly."
+    );
+  }
+  const endpoint = url ?? `${baseUrl}/flow/execute`;
+  const cleanPayload = typeof payload === "object" && payload !== null ? Object.fromEntries(Object.entries(payload).filter(([key]) => key !== "verbose")) : payload;
+  const hasOnlyFlowType = typeof cleanPayload === "object" && cleanPayload !== null && "flowType" in cleanPayload && Object.keys(cleanPayload).length === 1;
+  const hasOnlyFlowId = typeof cleanPayload === "object" && cleanPayload !== null && "flowId" in cleanPayload && Object.keys(cleanPayload).length === 1;
+  const hasFlowIdWithInputs = typeof cleanPayload === "object" && cleanPayload !== null && "flowId" in cleanPayload && "inputs" in cleanPayload;
+  const requestPayload = hasOnlyFlowType || hasOnlyFlowId || hasFlowIdWithInputs ? { ...cleanPayload, verbose: true } : cleanPayload;
+  if ("flowType" in requestPayload && requestPayload["flowType"] !== "USER_ONBOARDING" /* UserOnboarding */) {
+    requestPayload["flowType"] = "USER_ONBOARDING" /* UserOnboarding */;
+  }
+  const response = await fetch(endpoint, {
+    ...requestConfig,
+    method: requestConfig.method || "POST",
+    headers: {
+      "Content-Type": "application/json",
+      Accept: "application/json",
+      ...requestConfig.headers
+    },
+    body: JSON.stringify(requestPayload)
+  });
+  if (!response.ok) {
+    const errorText = await response.text();
+    throw new AsgardeoAPIError(
+      `User onboarding request failed: ${errorText}`,
+      "executeEmbeddedUserOnboardingFlow-ResponseError-001",
+      "javascript",
+      response.status,
+      response.statusText
+    );
+  }
+  const flowResponse = await response.json();
+  return flowResponse;
+};
+var executeEmbeddedUserOnboardingFlowV2_default = executeEmbeddedUserOnboardingFlowV2;
+
 // src/constants/ApplicationNativeAuthenticationConstants.ts
 var ApplicationNativeAuthenticationConstants = {
   SupportedAuthenticators: {
@@ -4828,6 +4880,7 @@ var transformBrandingPreferenceToTheme_default = transformBrandingPreferenceToTh
   executeEmbeddedSignInFlowV2,
   executeEmbeddedSignUpFlow,
   executeEmbeddedSignUpFlowV2,
+  executeEmbeddedUserOnboardingFlowV2,
   extractPkceStorageKeyFromState,
   extractUserClaimsFromIdToken,
   flattenUserSchema,