@asgardeo/react 0.6.17 → 0.6.18

package/dist/models/adapters.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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 { EmbeddedFlowComponent, WithPreferences } from '@asgardeo/browser';
+/**
+ * Props shared by all adapter components.
+ */
+export interface AdapterProps extends WithPreferences {
+    /**
+     * Custom CSS class name for buttons.
+     */
+    buttonClassName?: string;
+    /**
+     * The component configuration from the flow response.
+     */
+    component: EmbeddedFlowComponent;
+    /**
+     * Form validation errors.
+     */
+    formErrors: Record<string, string>;
+    /**
+     * Current form values.
+     */
+    formValues: Record<string, string>;
+    /**
+     * Custom CSS class name for form inputs.
+     */
+    inputClassName?: string;
+    /**
+     * Whether the form is valid.
+     */
+    isFormValid: boolean;
+    /**
+     * Whether the component is in loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Callback function called when input values change.
+     */
+    onInputChange: (name: string, value: string) => void;
+    onSubmit?: (component: EmbeddedFlowComponent, data?: Record<string, any>) => void;
+    /**
+     * Component size variant.
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Touched state for form fields.
+     */
+    touchedFields: Record<string, boolean>;
+    /**
+     * Component theme variant.
+     */
+    variant?: any;
+}

package/dist/utils/v2/flowTransformer.d.ts

@@ -0,0 +1,111 @@
+/**
+ * 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.
+ */
+/**
+ * @fileoverview Shared flow response transformer utilities for v2 embedded flows.
+ *
+ * This module provides reusable transformation functions for normalizing embedded flow
+ * responses from Asgardeo APIs. It handles both successful responses with component
+ * extraction and error responses with proper error message extraction.
+ *
+ * Key features:
+ * - Component extraction from flow meta structure
+ * - Translation string resolution in components
+ * - Error response detection and message extraction
+ * - Configurable error handling (throw vs return errors)
+ *
+ * Usage:
+ * ```typescript
+ * import { normalizeFlowResponse } from '../../../utils/v2/flowTransformer';
+ *
+ * const { flowId, components } = normalizeFlowResponse(apiResponse, t, {
+ *   defaultErrorKey: 'components.signIn.errors.generic'
+ * });
+ * ```
+ *
+ * This transformer is used by both SignIn and SignUp v2 components to ensure
+ * consistent response handling across all embedded flows.
+ */
+import { EmbeddedFlowComponentV2 as EmbeddedFlowComponent } from '@asgardeo/browser';
+import { UseTranslation } from '../../hooks/useTranslation';
+/**
+ * Generic flow error response interface that covers common error structure
+ */
+export interface FlowErrorResponse {
+    flowId: string;
+    flowStatus: 'ERROR';
+    failureReason?: string;
+}
+/**
+ * Configuration options for flow transformation
+ */
+export interface FlowTransformOptions {
+    /**
+     * Whether to throw errors or return them as normalized response
+     * @default true
+     */
+    throwOnError?: boolean;
+    /**
+     * Default error message key for translation fallback
+     * @default 'errors.flow.generic'
+     */
+    defaultErrorKey?: string;
+}
+/**
+ * Transform and resolve translations in components from flow response.
+ * This function extracts components from the response meta structure and resolves
+ * any translation strings within them.
+ *
+ * @param response - The flow response object containing components in meta structure
+ * @param t - Translation function from useTranslation hook
+ * @returns Array of flow components with resolved translations
+ */
+export declare const transformComponents: (response: any, t: UseTranslation["t"]) => EmbeddedFlowComponent[];
+/**
+ * Extract error message from flow error response.
+ * Supports any flow error response that follows the standard structure.
+ *
+ * @param error - The error response object
+ * @param t - Translation function for fallback messages
+ * @param defaultErrorKey - Default translation key for generic errors
+ * @returns Extracted error message or fallback
+ */
+export declare const extractErrorMessage: (error: FlowErrorResponse | any, t: UseTranslation["t"], defaultErrorKey?: string) => string;
+/**
+ * Check if a response is an error response and extract the error message.
+ * This function identifies error responses by checking for ERROR status and failure reasons.
+ *
+ * @param response - The flow response to check
+ * @param t - Translation function for error messages
+ * @param defaultErrorKey - Default translation key for generic errors
+ * @returns Error message string if response is an error, null otherwise
+ */
+export declare const checkForErrorResponse: (response: any, t: UseTranslation["t"], defaultErrorKey?: string) => string | null;
+/**
+ * Generic flow response normalizer that handles both success and error responses.
+ * This is the main transformer function that should be used by all flow components.
+ *
+ * @param response - The raw flow response from the API
+ * @param t - Translation function from useTranslation hook
+ * @param options - Configuration options for transformation behavior
+ * @returns Normalized flow response with flowId and transformed components
+ * @throws {any} The original response if it's an error and throwOnError is true
+ */
+export declare const normalizeFlowResponse: (response: any, t: UseTranslation["t"], options?: FlowTransformOptions) => {
+    flowId: string;
+    components: EmbeddedFlowComponent[];
+};

package/dist/utils/v2/getAuthComponentHeadings.d.ts

@@ -0,0 +1,69 @@
+/**
+ * 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 { EmbeddedFlowComponentV2 as EmbeddedFlowComponent } from '@asgardeo/browser';
+/**
+ * Result of heading extraction from flow components
+ */
+export interface HeadingExtractionResult {
+    heading: EmbeddedFlowComponent | null;
+    subheading: EmbeddedFlowComponent | null;
+}
+/**
+ * Complete result of authentication component heading extraction
+ */
+export interface AuthComponentHeadingsResult {
+    title: string;
+    subtitle: string;
+    componentsWithoutHeadings: EmbeddedFlowComponent[];
+    headingComponents: HeadingExtractionResult;
+}
+/**
+ * Extracts heading and subheading components from authentication flow components
+ * and provides resolved title/subtitle text with fallback logic.
+ *
+ * This utility helps maintain consistent heading extraction across authentication
+ * components (SignIn, SignUp, etc.) by identifying heading components within the
+ * flow structure and providing clean fallback behavior.
+ *
+ * @param components - Array of flow components to search
+ * @param flowTitle - Title from flow context (highest priority)
+ * @param flowSubtitle - Subtitle from flow context (highest priority)
+ * @param defaultTitle - Default title fallback (lowest priority)
+ * @param defaultSubtitle - Default subtitle fallback (lowest priority)
+ * @returns Object with resolved title and subtitle text, plus filtered components
+ *
+ * @example
+ * ```typescript
+ * const result = getAuthComponentHeadings(
+ *   components,
+ *   flowTitle,
+ *   flowSubtitle,
+ *   t('signin.heading'),
+ *   t('signin.subheading')
+ * );
+ *
+ * // Use resolved titles
+ * <Card.Title>{result.title}</Card.Title>
+ * <Typography>{result.subtitle}</Typography>
+ *
+ * // Render filtered components (without headings)
+ * renderComponents(result.componentsWithoutHeadings);
+ * ```
+ */
+declare const getAuthComponentHeadings: (components: EmbeddedFlowComponent[], flowTitle?: string, flowSubtitle?: string, defaultTitle?: string, defaultSubtitle?: string) => AuthComponentHeadingsResult;
+export default getAuthComponentHeadings;

package/dist/utils/v2/resolveTranslation.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { UseTranslation } from '../../hooks/useTranslation';
+/**
+ * Resolves a translation string using the provided translation function.
+ * If the text is not a translation string, returns the original text.
+ * @param text - The text to resolve (could be a translation string or regular text)
+ * @param t - The translation function from useTranslation
+ * @returns The resolved text
+ */
+export declare const resolveTranslation: (text: string | undefined, t: UseTranslation["t"]) => string;
+export default resolveTranslation;

package/dist/utils/v2/resolveTranslationsInArray.d.ts

@@ -0,0 +1,27 @@
+/**
+ * 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 { UseTranslation } from '../../hooks/useTranslation';
+/**
+ * Recursively resolves translation strings in an array of objects.
+ * @param items - Array of objects to process
+ * @param t - The translation function from useTranslation
+ * @param properties - Array of property names to resolve (optional)
+ * @returns A new array with resolved translations
+ */
+declare const resolveTranslationsInArray: <T extends Record<string, any>>(items: T[], t: UseTranslation["t"], properties?: string[]) => T[];
+export default resolveTranslationsInArray;

package/dist/{components/presentation/SignIn/component-driven/transformer.d.ts → utils/v2/resolveTranslationsInObject.d.ts}

@@ -15,16 +15,13 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { EmbeddedFlowComponent } from '@asgardeo/browser';
-import { UseTranslation } from '../../../../hooks/useTranslation';
+import { UseTranslation } from '../../hooks/useTranslation';
 /**
- * Transform simple flow response to component-driven format
+ * Resolves translation strings in an object's properties.
+ * @param obj - The object to process
+ * @param t - The translation function from useTranslation
+ * @param properties - Array of property names to resolve (optional, defaults to common properties)
+ * @returns A new object with resolved translations
  */
-export declare const transformSimpleToComponentDriven: (response: any, t: UseTranslation["t"]) => EmbeddedFlowComponent[];
-/**
- * Generic transformer that handles both simple and component-driven responses
- */
-export declare const normalizeFlowResponse: (response: any, t: UseTranslation["t"]) => {
-    flowId: string;
-    components: EmbeddedFlowComponent[];
-};
+export declare const resolveTranslationsInObject: <T extends Record<string, any>>(obj: T, t: UseTranslation["t"], properties?: string[]) => T;
+export default resolveTranslationsInObject;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asgardeo/react",
-  "version": "0.6.17",
+  "version": "0.6.18",
   "description": "React implementation of Asgardeo JavaScript SDK.",
   "keywords": [
     "asgardeo",
@@ -59,8 +59,8 @@
     "esbuild": "0.25.9",
     "react-dom": "19.1.4",
     "tslib": "2.8.1",
-    "@asgardeo/i18n": "0.3.7",
-    "@asgardeo/browser": "0.1.34"
+    "@asgardeo/i18n": "0.3.8",
+    "@asgardeo/browser": "0.1.35"
   },
   "publishConfig": {
     "access": "public"

package/dist/components/presentation/SignUp/transformer.d.ts

@@ -1,104 +0,0 @@
-/**
- * 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 { EmbeddedFlowComponent, EmbeddedSignUpFlowErrorResponseV2, EmbeddedFlowExecuteErrorResponse } from '@asgardeo/browser';
-import { UseTranslation } from '../../../hooks/useTranslation';
-/**
- * Transform simple flow response to component-driven format
- */
-export declare const transformSimpleToComponentDriven: (response: any, t: UseTranslation["t"]) => EmbeddedFlowComponent[];
-/**
- * Extract error message from various error response formats.
- *
- * This function supports multiple error formats from different versions of Asgardeo APIs:
- * - **AsgardeoV2 format**: Uses `failureReason` field from responses with `flowStatus: "ERROR"`
- * - **AsgardeoV1 format**: Uses `description` or `message` fields from responses with error `code`
- * - **AsgardeoAPIError**: Parses JSON from error messages to extract detailed error information
- * - **Standard Error objects**: Falls back to the `message` property
- * - **String errors**: Returns the string as-is
- *
- * @param error - The error object, which can be:
- *   - AsgardeoV2 error response: `{ flowStatus: "ERROR", failureReason: string, ... }`
- *   - AsgardeoV1 error response: `{ code: string, message?: string, description?: string, ... }`
- *   - AsgardeoAPIError instance with JSON message
- *   - Standard Error object
- *   - String error message
- * @param t - Translation function for fallback error messages
- * @returns Localized error message extracted from the error object
- *
- * @example
- * ```typescript
- * // AsgardeoV2 error
- * const v2Error = { flowStatus: "ERROR", failureReason: "User already exists" };
- * const message = extractErrorMessage(v2Error, t); // "User already exists"
- *
- * // AsgardeoV1 error
- * const v1Error = { code: "FEE-60005", description: "Error while provisioning user" };
- * const message = extractErrorMessage(v1Error, t); // "Error while provisioning user"
- *
- * // AsgardeoAPIError
- * const apiError = new AsgardeoAPIError('{"failureReason": "Invalid credentials"}');
- * const message = extractErrorMessage(apiError, t); // "Invalid credentials"
- * ```
- */
-export declare const extractErrorMessage: (error: EmbeddedSignUpFlowErrorResponseV2 | EmbeddedFlowExecuteErrorResponse, t: UseTranslation["t"]) => string;
-/**
- * Check if a response is an error response and extract the error message.
- *
- * This function serves as a guard to identify error responses from successful responses
- * in both AsgardeoV1 and AsgardeoV2 API formats. It's particularly useful for flow
- * normalization where error responses should be handled differently from success responses.
- *
- * **Supported Error Response Formats:**
- * - **AsgardeoV2**: Responses with `flowStatus: "ERROR"` and `failureReason`
- * - **AsgardeoV1**: Responses with error `code` and `message`/`description` fields
- *
- * @param response - The API response object to check for error indicators
- * @param t - Translation function for extracting localized error messages
- * @returns `null` if the response is not an error, or the extracted error message string if it is an error
- *
- * @example
- * ```typescript
- * // Success response
- * const successResponse = { flowStatus: "INCOMPLETE", data: { components: [] } };
- * const error = checkForErrorResponse(successResponse, t); // null
- *
- * // AsgardeoV2 error response
- * const v2ErrorResponse = {
- *   flowStatus: "ERROR",
- *   failureReason: "User already exists with the provided username."
- * };
- * const error = checkForErrorResponse(v2ErrorResponse, t); // "User already exists with the provided username."
- *
- * // AsgardeoV1 error response
- * const v1ErrorResponse = {
- *   code: "FEE-60005",
- *   message: "Error while provisioning user.",
- *   description: "Error occurred while provisioning user in the request of flow id: ac57315c-6ca6-49dc-8664-fcdcff354f46"
- * };
- * const error = checkForErrorResponse(v1ErrorResponse, t); // "Error occurred while provisioning user in the request of flow id: ac57315c-6ca6-49dc-8664-fcdcff354f46"
- * ```
- */
-export declare const checkForErrorResponse: (response: any, t: UseTranslation["t"]) => string | null;
-/**
- * Generic transformer that handles both simple and component-driven responses
- * Also handles AsgardeoV2 error responses that should be thrown as errors
- */
-export declare const normalizeFlowResponse: (response: any, t: UseTranslation["t"]) => {
-    flowId: string;
-    components: EmbeddedFlowComponent[];
-};