@asgardeo/javascript 0.7.3 → 0.8.0

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

@@ -0,0 +1,55 @@
+/**
+ * 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`, `type`, `id`,
+ *                 and optional `language` / `namespace` filters.
+ * @returns A promise that resolves to the {@link FlowMetadataResponse}.
+ *
+ * @throws {AsgardeoAPIError} When required parameters are missing or 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 Asgardeo V2 platform API
+ */
+declare const getFlowMetaV2: ({ url, baseUrl, type, id, language, namespace, ...requestConfig }: GetFlowMetaRequestConfig) => Promise<FlowMetadataResponse>;
+export default getFlowMetaV2;

package/dist/cjs/index.js

@@ -48,6 +48,7 @@ __export(index_exports, {
   EmbeddedSignUpFlowStatusV2: () => EmbeddedSignUpFlowStatus,
   EmbeddedSignUpFlowTypeV2: () => EmbeddedSignUpFlowType,
   FieldType: () => FieldType,
+  FlowMetaType: () => FlowMetaType,
   FlowMode: () => FlowMode,
   IsomorphicCrypto: () => IsomorphicCrypto,
   OIDCRequestConstants: () => OIDCRequestConstants_default,
@@ -85,6 +86,7 @@ __export(index_exports, {
   get: () => get_default,
   getAllOrganizations: () => getAllOrganizations_default,
   getBrandingPreference: () => getBrandingPreference_default,
+  getFlowMetaV2: () => getFlowMetaV2_default,
   getLatestStateParam: () => getLatestStateParam_default,
   getMeOrganizations: () => getMeOrganizations_default,
   getOrganization: () => getOrganization_default,
@@ -1146,7 +1148,7 @@ var _AsgardeoAuthClient = class _AsgardeoAuthClient {
     } else {
       this.instanceIdValue += 1;
     }
-    if (instanceID) {
+    if (instanceID !== void 0) {
       this.instanceIdValue = instanceID;
     }
     if (!clientId) {
@@ -3248,6 +3250,65 @@ var executeEmbeddedUserOnboardingFlowV2 = async ({
 };
 var executeEmbeddedUserOnboardingFlowV2_default = executeEmbeddedUserOnboardingFlowV2;
 
+// src/api/v2/getFlowMetaV2.ts
+var getFlowMetaV2 = async ({
+  url,
+  baseUrl,
+  type,
+  id,
+  language,
+  namespace,
+  ...requestConfig
+}) => {
+  if (!type) {
+    throw new AsgardeoAPIError(
+      'The "type" parameter is required',
+      "getFlowMetaV2-ValidationError-001",
+      "javascript",
+      400,
+      'The "type" query parameter must be either "APP" or "OU".'
+    );
+  }
+  if (!id) {
+    throw new AsgardeoAPIError(
+      'The "id" parameter is required',
+      "getFlowMetaV2-ValidationError-002",
+      "javascript",
+      400,
+      'The "id" query parameter must be a valid UUID of the target application or organization unit.'
+    );
+  }
+  const queryParams = new URLSearchParams({
+    id,
+    type,
+    ...language ? { language } : {},
+    ...namespace ? { namespace } : {}
+  });
+  const baseEndpoint = url ?? `${baseUrl}/flow/meta`;
+  const endpoint = `${baseEndpoint}?${queryParams.toString()}`;
+  const response = await fetch(endpoint, {
+    ...requestConfig,
+    headers: {
+      Accept: "application/json",
+      ...requestConfig.headers
+    },
+    method: "GET"
+  });
+  if (!response.ok) {
+    const errorText = await response.text();
+    throw new AsgardeoAPIError(
+      `Flow metadata request failed: ${errorText}`,
+      "getFlowMetaV2-ResponseError-001",
+      "javascript",
+      response.status,
+      response.statusText
+    );
+  }
+  const flowMetadata = await response.json();
+  return flowMetadata;
+};
+var getFlowMetaV2_default = getFlowMetaV2;
+
 // src/constants/ApplicationNativeAuthenticationConstants.ts
 var ApplicationNativeAuthenticationConstants = {
   SupportedAuthenticators: {
@@ -3364,6 +3425,13 @@ var EmbeddedFlowEventType = /* @__PURE__ */ ((EmbeddedFlowEventType2) => {
   return EmbeddedFlowEventType2;
 })(EmbeddedFlowEventType || {});
 
+// src/models/v2/flow-meta-v2.ts
+var FlowMetaType = /* @__PURE__ */ ((FlowMetaType2) => {
+  FlowMetaType2["App"] = "APP";
+  FlowMetaType2["Ou"] = "OU";
+  return FlowMetaType2;
+})(FlowMetaType || {});
+
 // src/models/flow.ts
 var FlowMode = /* @__PURE__ */ ((FlowMode2) => {
   FlowMode2["Embedded"] = "DIRECT";
@@ -4858,6 +4926,7 @@ var transformBrandingPreferenceToTheme_default = transformBrandingPreferenceToTh
   EmbeddedSignUpFlowStatusV2,
   EmbeddedSignUpFlowTypeV2,
   FieldType,
+  FlowMetaType,
   FlowMode,
   IsomorphicCrypto,
   OIDCRequestConstants,
@@ -4895,6 +4964,7 @@ var transformBrandingPreferenceToTheme_default = transformBrandingPreferenceToTh
   get,
   getAllOrganizations,
   getBrandingPreference,
+  getFlowMetaV2,
   getLatestStateParam,
   getMeOrganizations,
   getOrganization,