@thunderid/javascript 0.0.1

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

@@ -0,0 +1,89 @@
+/**
+ * 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 {
+    /**
+     * Data for the current step including components and additional data.
+     */
+    data?: {
+        /**
+         * Additional data from the flow step (e.g., inviteLink).
+         */
+        additionalData?: Record<string, string>;
+        /**
+         * UI components to render for the current step.
+         */
+        components?: any[];
+    };
+    /**
+     * Unique identifier for the flow execution.
+     */
+    executionId: string;
+    /**
+     * Reason for failure if flowStatus is ERROR.
+     */
+    failureReason?: string;
+    /**
+     * Current status of the flow.
+     */
+    flowStatus: 'INCOMPLETE' | 'COMPLETE' | 'ERROR';
+    /**
+     * Type of the current step in the flow.
+     */
+    type?: 'VIEW' | 'REDIRECTION';
+}
+/**
+ * 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 ThunderIDAPIError 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: {
+ *     executionId: "flow-id-from-url",
+ *     inputs: { inviteToken: "token-from-url" }
+ *   }
+ * });
+ * ```
+ */
+declare const executeEmbeddedUserOnboardingFlowV2: ({ url, baseUrl, payload, ...requestConfig }: EmbeddedFlowExecuteRequestConfigV2) => Promise<EmbeddedUserOnboardingFlowResponse>;
+export default executeEmbeddedUserOnboardingFlowV2;
+//# sourceMappingURL=executeEmbeddedUserOnboardingFlowV2.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"executeEmbeddedUserOnboardingFlowV2.d.ts","sourceRoot":"","sources":["../../../src/api/v2/executeEmbeddedUserOnboardingFlowV2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAIH,OAAO,EAAC,gCAAgC,IAAI,kCAAkC,EAAC,MAAM,kCAAkC,CAAC;AAExH;;GAEG;AACH,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,IAAI,CAAC,EAAE;QACL;;WAEG;QACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAExC;;WAEG;QACH,UAAU,CAAC,EAAE,GAAG,EAAE,CAAC;KACpB,CAAC;IAEF;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,YAAY,GAAG,UAAU,GAAG,OAAO,CAAC;IAEhD;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,QAAA,MAAM,mCAAmC,GAAU,6CAKhD,kCAAkC,KAAG,OAAO,CAAC,kCAAkC,CAyEjF,CAAC;AAEF,eAAe,mCAAmC,CAAC"}

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

@@ -0,0 +1,56 @@
+/**
+ * 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 { FlowMetadataResponse, GetFlowMetaRequestConfig } from '../../models/v2/flow-meta-v2';
+/**
+ * Fetches aggregated flow metadata from the `GET /flow/meta` endpoint.
+ *
+ * The response includes:
+ * - Application or OU details depending on the `type` parameter
+ * - Resolved design configuration (theme and layout)
+ * - i18n translations filtered by `language` and `namespace`
+ * - Registration flow enablement status
+ *
+ * @param config - Request configuration including `baseUrl`/`url`, and optional
+ *                 `type`, `id`, `language`, and `namespace` filters. When `type`
+ *                 and `id` are omitted the server returns i18n-only metadata.
+ * @returns A promise that resolves to the {@link FlowMetadataResponse}.
+ *
+ * @throws {ThunderIDAPIError} When the server returns a non-OK response.
+ *
+ * @example
+ * ```typescript
+ * import getFlowMetaV2 from './api/v2/getFlowMetaV2';
+ * import { FlowMetaType } from './models/v2/flow-meta-v2';
+ *
+ * const meta = await getFlowMetaV2({
+ *   baseUrl: 'https://localhost:8090',
+ *   type: FlowMetaType.App,
+ *   id: '60a9b38b-6eba-9f9e-55f9-267067de4680',
+ *   language: 'en',
+ *   namespace: 'auth',
+ * });
+ *
+ * console.log(meta.application?.name);
+ * console.log(meta.i18n.translations);
+ * ```
+ *
+ * @experimental This function targets the ThunderID V2 platform API
+ */
+declare const getFlowMetaV2: ({ url, baseUrl, type, id, language, namespace, ...requestConfig }: GetFlowMetaRequestConfig) => Promise<FlowMetadataResponse>;
+export default getFlowMetaV2;
+//# sourceMappingURL=getFlowMetaV2.d.ts.map

package/dist/api/v2/getFlowMetaV2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getFlowMetaV2.d.ts","sourceRoot":"","sources":["../../../src/api/v2/getFlowMetaV2.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAGH,OAAO,EAAC,oBAAoB,EAAE,wBAAwB,EAAC,MAAM,8BAA8B,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,QAAA,MAAM,aAAa,GAAU,mEAQ1B,wBAAwB,KAAG,OAAO,CAAC,oBAAoB,CAoCzD,CAAC;AAEF,eAAe,aAAa,CAAC"}

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

@@ -0,0 +1,43 @@
+/**
+ * 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 { GetOrganizationUnitChildrenConfig, OrganizationUnitListResponse } from '../../models/v2/organization-unit';
+/**
+ * Retrieves the child organization units of a given parent OU.
+ *
+ * @param config - Request configuration including `baseUrl`/`url`, `organizationUnitId`,
+ *                 and optional `limit`/`offset` pagination parameters.
+ * @returns A promise that resolves with the paginated list of child organization units.
+ *
+ * @throws {ThunderIDAPIError} When the server returns a non-OK response.
+ *
+ * @example
+ * ```typescript
+ * const children = await getOrganizationUnitChildren({
+ *   baseUrl: 'https://localhost:8090',
+ *   organizationUnitId: '0d5e071b-d3d3-475d-b3c6-1a20ee2fa9b1',
+ *   limit: 10,
+ *   offset: 0,
+ * });
+ * console.log(children.organizationUnits);
+ * ```
+ *
+ * @experimental This function targets the ThunderID V2 platform API
+ */
+declare const getOrganizationUnitChildren: ({ url, baseUrl, organizationUnitId, limit, offset, ...requestConfig }: GetOrganizationUnitChildrenConfig) => Promise<OrganizationUnitListResponse>;
+export default getOrganizationUnitChildren;
+//# sourceMappingURL=getOrganizationUnitChildren.d.ts.map

package/dist/api/v2/getOrganizationUnitChildren.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getOrganizationUnitChildren.d.ts","sourceRoot":"","sources":["../../../src/api/v2/getOrganizationUnitChildren.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAGH,OAAO,EAAC,iCAAiC,EAAE,4BAA4B,EAAC,MAAM,mCAAmC,CAAC;AAElH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,QAAA,MAAM,2BAA2B,GAAU,uEAOxC,iCAAiC,KAAG,OAAO,CAAC,4BAA4B,CA2C1E,CAAC;AAEF,eAAe,2BAA2B,CAAC"}