@asgardeo/react 0.6.31 → 0.8.0

package/dist/components/presentation/auth/AcceptInvite/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+export { default as AcceptInvite } from './v2/AcceptInvite';
+export type { AcceptInviteProps, AcceptInviteRenderProps } from './v2/AcceptInvite';
+export { default as BaseAcceptInvite } from './v2/BaseAcceptInvite';
+export type { BaseAcceptInviteProps, BaseAcceptInviteRenderProps, AcceptInviteFlowResponse, } from './v2/BaseAcceptInvite';

package/dist/components/presentation/auth/AcceptInvite/v2/AcceptInvite.d.ts

@@ -0,0 +1,124 @@
+/**
+ * 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 { FC, ReactNode } from 'react';
+import { BaseAcceptInviteRenderProps, AcceptInviteFlowResponse } from './BaseAcceptInvite';
+/**
+ * Render props for AcceptInvite (re-exported for convenience).
+ */
+export type AcceptInviteRenderProps = BaseAcceptInviteRenderProps;
+/**
+ * Props for the AcceptInvite component.
+ */
+export interface AcceptInviteProps {
+    /**
+     * Base URL for the Thunder API server.
+     * If not provided, will try to read from window location.
+     */
+    baseUrl?: string;
+    /**
+     * Flow ID from the invite link.
+     * If not provided, will be extracted from URL query parameters.
+     */
+    flowId?: string;
+    /**
+     * Invite token from the invite link.
+     * If not provided, will be extracted from URL query parameters.
+     */
+    inviteToken?: string;
+    /**
+     * Callback when the flow completes successfully.
+     */
+    onComplete?: () => void;
+    /**
+     * Callback when an error occurs.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback when the flow state changes.
+     */
+    onFlowChange?: (response: AcceptInviteFlowResponse) => void;
+    /**
+     * Callback to navigate to sign in page.
+     */
+    onGoToSignIn?: () => void;
+    /**
+     * Custom CSS class name.
+     */
+    className?: string;
+    /**
+     * Render props function for custom UI.
+     * If not provided, default UI will be rendered by the SDK.
+     */
+    children?: (props: AcceptInviteRenderProps) => ReactNode;
+    /**
+     * Size variant for the component.
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Theme variant for the component card.
+     */
+    variant?: 'outlined' | 'elevated';
+    /**
+     * Whether to show the title.
+     */
+    showTitle?: boolean;
+    /**
+     * Whether to show the subtitle.
+     */
+    showSubtitle?: boolean;
+}
+/**
+ * AcceptInvite component for end-users to accept an invite and set their password.
+ *
+ * This component is designed for end users accessing the thunder-gate app via an invite link.
+ * It automatically:
+ * 1. Extracts flowId 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
+ *
+ * @example
+ * ```tsx
+ * import { AcceptInvite } from '@asgardeo/react';
+ *
+ * // URL: /invite?flowId=xxx&inviteToken=yyy
+ *
+ * const AcceptInvitePage = () => {
+ *   return (
+ *     <AcceptInvite
+ *       baseUrl="https://api.thunder.io"
+ *       onComplete={() => navigate('/signin')}
+ *       onError={(error) => console.error(error)}
+ *     >
+ *       {({ values, components, isLoading, isComplete, isValidatingToken, isTokenInvalid, error, handleInputChange, handleSubmit }) => (
+ *         <div>
+ *           {isValidatingToken && <p>Validating your invite...</p>}
+ *           {isTokenInvalid && <p>Invalid or expired invite link</p>}
+ *           {isComplete && <p>Registration complete! You can now sign in.</p>}
+ *           {!isComplete && !isValidatingToken && !isTokenInvalid && (
+ *             // Render password form based on components
+ *           )}
+ *         </div>
+ *       )}
+ *     </AcceptInvite>
+ *   );
+ * };
+ * ```
+ */
+declare const AcceptInvite: FC<AcceptInviteProps>;
+export default AcceptInvite;

package/dist/components/presentation/auth/AcceptInvite/v2/BaseAcceptInvite.d.ts

@@ -0,0 +1,192 @@
+/**
+ * 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 { FC, ReactNode } from 'react';
+import { CardProps } from '../../../../primitives/Card/Card';
+/**
+ * Flow response structure from the backend.
+ */
+export interface AcceptInviteFlowResponse {
+    flowId: string;
+    flowStatus: 'INCOMPLETE' | 'COMPLETE' | 'ERROR';
+    type?: 'VIEW' | 'REDIRECTION';
+    data?: {
+        components?: any[];
+        meta?: {
+            components?: any[];
+        };
+        additionalData?: Record<string, string>;
+    };
+    failureReason?: string;
+}
+/**
+ * Render props for custom UI rendering of AcceptInvite.
+ */
+export interface BaseAcceptInviteRenderProps {
+    /**
+     * Form values for the current step.
+     */
+    values: Record<string, string>;
+    /**
+     * Field validation errors.
+     */
+    fieldErrors: Record<string, string>;
+    /**
+     * API error (if any).
+     */
+    error?: Error | null;
+    /**
+     * Touched fields.
+     */
+    touched: Record<string, boolean>;
+    /**
+     * Loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Flow components from the current step.
+     */
+    components: any[];
+    /**
+     * Current flow ID from URL.
+     */
+    flowId?: string;
+    /**
+     * Invite token from URL.
+     */
+    inviteToken?: string;
+    /**
+     * Function to handle input changes.
+     */
+    handleInputChange: (name: string, value: string) => void;
+    /**
+     * Function to handle input blur.
+     */
+    handleInputBlur: (name: string) => void;
+    /**
+     * Function to handle form submission.
+     */
+    handleSubmit: (component: any, data?: Record<string, any>) => Promise<void>;
+    /**
+     * Whether the flow has completed successfully.
+     */
+    isComplete: boolean;
+    /**
+     * Whether the invite token is being validated.
+     */
+    isValidatingToken: boolean;
+    /**
+     * Whether the token validation failed.
+     */
+    isTokenInvalid: boolean;
+    /**
+     * Title for the current step.
+     */
+    title?: string;
+    /**
+     * Subtitle for the current step.
+     */
+    subtitle?: string;
+    /**
+     * Whether the form is valid.
+     */
+    isValid: boolean;
+    /**
+     * Navigate to sign in page.
+     */
+    goToSignIn?: () => void;
+    /**
+     * Title from the password screen (for use in completion screen).
+     */
+    completionTitle?: string;
+}
+/**
+ * Props for the BaseAcceptInvite component.
+ */
+export interface BaseAcceptInviteProps {
+    /**
+     * Flow ID from the invite link URL.
+     */
+    flowId?: string;
+    /**
+     * Invite token from the invite link URL.
+     */
+    inviteToken?: string;
+    /**
+     * Callback when the flow completes successfully.
+     */
+    onComplete?: () => void;
+    /**
+     * Callback when an error occurs.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback when the flow state changes.
+     */
+    onFlowChange?: (response: AcceptInviteFlowResponse) => void;
+    /**
+     * Function to submit flow step data.
+     * This makes a request to the flow/execute endpoint.
+     */
+    onSubmit: (payload: Record<string, any>) => Promise<AcceptInviteFlowResponse>;
+    /**
+     * Callback to navigate to sign in page.
+     */
+    onGoToSignIn?: () => void;
+    /**
+     * Custom CSS class name.
+     */
+    className?: string;
+    /**
+     * Render props function for custom UI.
+     * If not provided, default UI will be rendered.
+     */
+    children?: (props: BaseAcceptInviteRenderProps) => ReactNode;
+    /**
+     * Size variant for the component.
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Theme variant for the component.
+     */
+    variant?: CardProps['variant'];
+    /**
+     * Whether to show the title.
+     */
+    showTitle?: boolean;
+    /**
+     * Whether to show the subtitle.
+     */
+    showSubtitle?: boolean;
+}
+/**
+ * Base component for accept invite flow (end-user).
+ * Handles the flow logic for validating an invite token and setting a password.
+ *
+ * When no children are provided, renders a default UI with:
+ * - Loading spinner during token validation
+ * - Error alerts for invalid/expired tokens
+ * - Password form with validation
+ * - Success state with sign-in redirect
+ *
+ * Flow steps handled:
+ * 1. Validate invite token (automatic on mount)
+ * 2. Password input
+ * 3. Flow completion
+ */
+declare const BaseAcceptInvite: FC<BaseAcceptInviteProps>;
+export default BaseAcceptInvite;

package/dist/components/presentation/auth/AcceptInvite/v2/BaseAcceptInvite.styles.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 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 { Theme } from '@asgardeo/browser';
+/**
+ * Creates styles for the BaseAcceptInvite component
+ * @param theme - The theme object containing design tokens
+ * @param colorScheme - The current color scheme (used for memoization)
+ * @returns Object containing CSS class names for component styling
+ */
+declare const useStyles: (theme: Theme, colorScheme: string) => {
+    card: string;
+    header: string;
+    title: string;
+    subtitle: string;
+};
+export default useStyles;

package/dist/components/presentation/auth/AuthOptionFactory.d.ts

@@ -40,3 +40,15 @@ export declare const renderSignUpComponents: (components: EmbeddedFlowComponent[
     size?: "small" | "medium" | "large";
     variant?: any;
 }) => ReactElement[];
+/**
+ * Processes an array of components and renders them as React elements for invite user.
+ * This is used by both InviteUser and AcceptInvite components.
+ */
+export declare const renderInviteUserComponents: (components: EmbeddedFlowComponent[], formValues: Record<string, string>, touchedFields: Record<string, boolean>, formErrors: Record<string, string>, isLoading: boolean, isFormValid: boolean, onInputChange: (name: string, value: string) => void, options?: {
+    buttonClassName?: string;
+    inputClassName?: string;
+    onInputBlur?: (name: string) => void;
+    onSubmit?: (component: EmbeddedFlowComponent, data?: Record<string, any>, skipValidation?: boolean) => void;
+    size?: "small" | "medium" | "large";
+    variant?: any;
+}) => ReactElement[];

package/dist/components/presentation/auth/InviteUser/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 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.
+ */
+export { default as InviteUser } from './v2/InviteUser';
+export type { InviteUserProps, InviteUserRenderProps } from './v2/InviteUser';
+export { default as BaseInviteUser } from './v2/BaseInviteUser';
+export type { BaseInviteUserProps, BaseInviteUserRenderProps, InviteUserFlowResponse, } from './v2/BaseInviteUser';

package/dist/components/presentation/auth/InviteUser/v2/BaseInviteUser.d.ts

@@ -0,0 +1,185 @@
+/**
+ * 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 { FC, ReactNode } from 'react';
+import { CardProps } from '../../../../primitives/Card/Card';
+/**
+ * Flow response structure from the backend.
+ */
+export interface InviteUserFlowResponse {
+    flowId: string;
+    flowStatus: 'INCOMPLETE' | 'COMPLETE' | 'ERROR';
+    type?: 'VIEW' | 'REDIRECTION';
+    data?: {
+        components?: any[];
+        meta?: {
+            components?: any[];
+        };
+        additionalData?: Record<string, string>;
+    };
+    failureReason?: string;
+}
+/**
+ * Render props for custom UI rendering of InviteUser.
+ */
+export interface BaseInviteUserRenderProps {
+    /**
+     * Form values for the current step.
+     */
+    values: Record<string, string>;
+    /**
+     * Field validation errors.
+     */
+    fieldErrors: Record<string, string>;
+    /**
+     * API error (if any).
+     */
+    error?: Error | null;
+    /**
+     * Touched fields.
+     */
+    touched: Record<string, boolean>;
+    /**
+     * Loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Flow components from the current step.
+     */
+    components: any[];
+    /**
+     * Generated invite link (available after user provisioning).
+     */
+    inviteLink?: string;
+    /**
+     * Current flow ID.
+     */
+    flowId?: string;
+    /**
+     * Function to handle input changes.
+     */
+    handleInputChange: (name: string, value: string) => void;
+    /**
+     * Function to handle input blur.
+     */
+    handleInputBlur: (name: string) => void;
+    /**
+     * Function to handle form submission.
+     */
+    handleSubmit: (component: any, data?: Record<string, any>) => Promise<void>;
+    /**
+     * Whether the invite link has been generated (admin flow complete).
+     */
+    isInviteGenerated: boolean;
+    /**
+     * Title for the current step.
+     */
+    title?: string;
+    /**
+     * Subtitle for the current step.
+     */
+    subtitle?: string;
+    /**
+     * Whether the form is valid.
+     */
+    isValid: boolean;
+    /**
+     * Copy invite link to clipboard.
+     */
+    copyInviteLink: () => Promise<void>;
+    /**
+     * Whether the invite link was copied.
+     */
+    inviteLinkCopied: boolean;
+    /**
+     * Reset the flow to invite another user.
+     */
+    resetFlow: () => void;
+}
+/**
+ * Props for the BaseInviteUser component.
+ */
+export interface BaseInviteUserProps {
+    /**
+     * Callback when the invite link is generated successfully.
+     */
+    onInviteLinkGenerated?: (inviteLink: string, flowId: string) => void;
+    /**
+     * Callback when an error occurs.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback when the flow state changes.
+     */
+    onFlowChange?: (response: InviteUserFlowResponse) => void;
+    /**
+     * Function to initialize the invite user flow.
+     * This should make an authenticated request to the flow/execute endpoint.
+     */
+    onInitialize: (payload: Record<string, any>) => Promise<InviteUserFlowResponse>;
+    /**
+     * Function to submit flow step data.
+     * This should make an authenticated request to the flow/execute endpoint.
+     */
+    onSubmit: (payload: Record<string, any>) => Promise<InviteUserFlowResponse>;
+    /**
+     * Custom CSS class name.
+     */
+    className?: string;
+    /**
+     * Render props function for custom UI.
+     * If not provided, default UI will be rendered.
+     */
+    children?: (props: BaseInviteUserRenderProps) => ReactNode;
+    /**
+     * Whether the SDK is initialized.
+     */
+    isInitialized?: boolean;
+    /**
+     * Size variant for the component.
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Theme variant for the component.
+     */
+    variant?: CardProps['variant'];
+    /**
+     * Whether to show the title.
+     */
+    showTitle?: boolean;
+    /**
+     * Whether to show the subtitle.
+     */
+    showSubtitle?: boolean;
+}
+/**
+ * Base component for invite user flow.
+ * Handles the flow logic for creating a user and generating an invite link.
+ *
+ * When no children are provided, renders a default UI with:
+ * - Loading spinner during initialization
+ * - Error alerts for failures
+ * - Flow components (user type selection, user details form)
+ * - Invite link display with copy functionality
+ *
+ * Flow steps handled:
+ * 1. User type selection (if multiple types available)
+ * 2. User details input (username, email)
+ * 3. Invite link generation
+ */
+declare const BaseInviteUser: FC<BaseInviteUserProps>;
+export default BaseInviteUser;

package/dist/components/presentation/auth/InviteUser/v2/BaseInviteUser.styles.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 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 { Theme } from '@asgardeo/browser';
+/**
+ * Creates styles for the BaseInviteUser component
+ * @param theme - The theme object containing design tokens
+ * @param colorScheme - The current color scheme (used for memoization)
+ * @returns Object containing CSS class names for component styling
+ */
+declare const useStyles: (theme: Theme, colorScheme: string) => {
+    card: string;
+    header: string;
+    title: string;
+    subtitle: string;
+};
+export default useStyles;