@asgardeo/react 0.3.0 → 0.4.0

package/dist/components/presentation/SignIn/options/MultiOptionButton.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Multi Option Button Component.
+ * Renders authenticators as selectable buttons for multi-option prompts.
+ * Used when authenticators don't require immediate user input but need to be selected first.
+ */
+declare const MultiOptionButton: FC<BaseSignInOptionProps>;
+export default MultiOptionButton;

package/dist/components/presentation/SignIn/options/SignInOptionFactory.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { ApplicationNativeAuthenticationAuthenticator, WithPreferences } from '@asgardeo/browser';
+import { ReactElement } from 'react';
+/**
+ * Base props that all sign-in option components share.
+ */
+export interface BaseSignInOptionProps extends WithPreferences {
+    /**
+     * The authenticator configuration.
+     */
+    authenticator: ApplicationNativeAuthenticationAuthenticator;
+    /**
+     * Current form values.
+     */
+    formValues: Record<string, string>;
+    /**
+     * Touched state for form fields.
+     */
+    touchedFields: Record<string, boolean>;
+    /**
+     * Whether the component is in loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Error message to display.
+     */
+    error?: string | null;
+    /**
+     * Callback function called when input values change.
+     */
+    onInputChange: (param: string, value: string) => void;
+    /**
+     * Callback function called when the option is submitted.
+     */
+    onSubmit: (authenticator: ApplicationNativeAuthenticationAuthenticator, formData?: Record<string, string>) => void;
+    /**
+     * Custom CSS class name for form inputs.
+     */
+    inputClassName?: string;
+    /**
+     * Custom CSS class name for the submit button.
+     */
+    buttonClassName?: string;
+    /**
+     * Text for the submit button.
+     */
+    submitButtonText?: string;
+}
+/**
+ * Creates the appropriate sign-in option component based on the authenticator's ID.
+ */
+export declare const createSignInOption: (props: BaseSignInOptionProps) => ReactElement;
+/**
+ * Convenience function that creates the appropriate sign-in option component from an authenticator.
+ */
+export declare const createSignInOptionFromAuthenticator: (authenticator: ApplicationNativeAuthenticationAuthenticator, formValues: Record<string, string>, touchedFields: Record<string, boolean>, isLoading: boolean, onInputChange: (param: string, value: string) => void, onSubmit: (authenticator: ApplicationNativeAuthenticationAuthenticator, formData?: Record<string, string>) => void, options?: {
+    inputClassName?: string;
+    buttonClassName?: string;
+    error?: string | null;
+}) => ReactElement;

package/dist/components/presentation/SignIn/options/SignInWithEthereumButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Sign In With Ethereum Button Component.
+ * Handles authentication with Sign In With Ethereum identity provider.
+ */
+declare const SignInWithEthereumButton: FC<BaseSignInOptionProps>;
+export default SignInWithEthereumButton;

package/dist/components/presentation/SignIn/options/SmsOtp.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * SMS OTP Sign-In Option Component.
+ * Handles SMS-based OTP authentication.
+ */
+declare const SmsOtp: FC<BaseSignInOptionProps>;
+export default SmsOtp;

package/dist/components/presentation/SignIn/options/SocialButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Social Login Sign-In Option Component.
+ * Handles authentication with external identity providers (Google, GitHub, etc.).
+ */
+declare const SocialLogin: FC<BaseSignInOptionProps>;
+export default SocialLogin;

package/dist/components/presentation/SignIn/options/Totp.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * TOTP Sign-In Option Component.
+ * Handles Time-based One-Time Password (TOTP) authentication.
+ */
+declare const Totp: FC<BaseSignInOptionProps>;
+export default Totp;

package/dist/components/presentation/SignIn/options/UsernamePassword.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Username Password Sign-In Option Component.
+ * Handles traditional username and password authentication.
+ */
+declare const UsernamePassword: FC<BaseSignInOptionProps>;
+export default UsernamePassword;

package/dist/components/presentation/SignIn/types.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 { ApplicationNativeAuthenticationAuthenticator, ApplicationNativeAuthenticationAuthenticatorParamType } from '@asgardeo/browser';
+/**
+ * Interface for form field state.
+ */
+export interface FormField {
+    param: string;
+    type: ApplicationNativeAuthenticationAuthenticatorParamType;
+    displayName: string;
+    confidential: boolean;
+    required: boolean;
+    value: string;
+}
+/**
+ * Base props that all authenticator components share.
+ */
+export interface BaseAuthenticatorProps {
+    /**
+     * The authenticator configuration.
+     */
+    authenticator: ApplicationNativeAuthenticationAuthenticator;
+    /**
+     * Current form values.
+     */
+    formValues: Record<string, string>;
+    /**
+     * Whether the component is in loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Error message to display.
+     */
+    error?: string | null;
+    /**
+     * Callback function called when input values change.
+     */
+    onInputChange: (param: string, value: string) => void;
+    /**
+     * Callback function called when the authenticator is submitted.
+     */
+    onSubmit: (authenticator: ApplicationNativeAuthenticationAuthenticator, formData?: Record<string, string>) => void;
+    /**
+     * Custom CSS class name for form inputs.
+     */
+    inputClassName?: string;
+    /**
+     * Custom CSS class name for the submit button.
+     */
+    buttonClassName?: string;
+    /**
+     * Text for the submit button.
+     */
+    submitButtonText?: string;
+}
+/**
+ * Props for authenticator selector component.
+ */
+export interface AuthenticatorSelectorProps {
+    /**
+     * Available authenticators for selection.
+     */
+    authenticators: ApplicationNativeAuthenticationAuthenticator[];
+    /**
+     * Current form values.
+     */
+    formValues: Record<string, string>;
+    /**
+     * Whether the component is in loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Error message to display.
+     */
+    error?: string | null;
+    /**
+     * Messages to display to the user.
+     */
+    messages: Array<{
+        type: string;
+        message: string;
+    }>;
+    /**
+     * Callback function called when input values change.
+     */
+    onInputChange: (param: string, value: string) => void;
+    /**
+     * Callback function called when an authenticator is selected.
+     */
+    onAuthenticatorSelection: (authenticator: ApplicationNativeAuthenticationAuthenticator, formData?: Record<string, string>) => void;
+    /**
+     * Custom CSS class names.
+     */
+    inputClassName?: string;
+    buttonClassName?: string;
+    errorClassName?: string;
+    messageClassName?: string;
+    /**
+     * Text for the submit button.
+     */
+    submitButtonText?: string;
+}
+/**
+ * Style configuration for authenticators.
+ */
+export interface AuthenticatorStyle {
+    variant: 'solid' | 'outline';
+    color: string;
+}

package/dist/components/presentation/User/BaseUser.d.ts

@@ -0,0 +1,66 @@
+/**
+ * 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 { User as IUser } from '@asgardeo/browser';
+import { FC, ReactNode } from 'react';
+/**
+ * Props for the BaseUser component.
+ */
+export interface BaseUserProps {
+    /**
+     * The user object to display. If not provided, the component will render the fallback.
+     */
+    user: IUser | null;
+    /**
+     * Render prop that takes the user object and returns a ReactNode.
+     * @param user - The authenticated user object from Asgardeo.
+     * @returns A ReactNode to render.
+     */
+    children: (user: IUser | null) => ReactNode;
+    /**
+     * Optional element to render when no user is provided.
+     */
+    fallback?: ReactNode;
+}
+/**
+ * Base User component that provides the core functionality for displaying user information.
+ * This component takes a user object as a prop and uses render props to expose it.
+ *
+ * @remarks This is the base component that can be used in any context where you have
+ * a user object available. For React applications, use the User component which
+ * automatically retrieves the user from Asgardeo context.
+ *
+ * @example
+ * ```tsx
+ * import { BaseUser } from '@asgardeo/auth-react';
+ *
+ * const MyComponent = ({ user }) => {
+ *   return (
+ *     <BaseUser user={user} fallback={<p>No user data</p>}>
+ *       {(user) => (
+ *         <div>
+ *           <h1>Welcome, {user.displayName}!</h1>
+ *           <p>Email: {user.email}</p>
+ *         </div>
+ *       )}
+ *     </BaseUser>
+ *   );
+ * }
+ * ```
+ */
+declare const BaseUser: FC<BaseUserProps>;
+export default BaseUser;

package/dist/components/presentation/{User.d.ts → User/User.d.ts}

@@ -15,18 +15,20 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { User as AsgardeoUser } from '@asgardeo/browser';
+import { User as IUser } from '@asgardeo/browser';
 import { FC, ReactNode } from 'react';
+import { BaseUserProps } from './BaseUser';
 /**
  * Props for the User component.
+ * Extends BaseUserProps but makes the user prop optional since it will be obtained from useAsgardeo
  */
-export interface UserProps {
+export interface UserProps extends Omit<BaseUserProps, 'user'> {
     /**
      * Render prop that takes the user object and returns a ReactNode.
      * @param user - The authenticated user object from Asgardeo.
      * @returns A ReactNode to render.
      */
-    children: (user: AsgardeoUser | null) => ReactNode;
+    children: (user: IUser | null) => ReactNode;
     /**
      * Optional element to render when no user is signed in.
      */
@@ -34,10 +36,13 @@ export interface UserProps {
 }
 /**
  * A component that uses render props to expose the authenticated user object.
+ * This component automatically retrieves the user from Asgardeo context.
+ *
+ * @remarks This component is only supported in browser based React applications (CSR).
  *
  * @example
  * ```tsx
- * import { User } from '@asgardeo/auth-react';
+ * import { IUser } from '@asgardeo/auth-react';
  *
  * const App = () => {
  *   return (

package/dist/components/presentation/UserDropdown/BaseUserDropdown.d.ts

@@ -46,7 +46,7 @@ export interface BaseUserDropdownProps {
     /**
      * Show user's display name next to avatar in the trigger button
      */
-    showTriggerLable?: boolean;
+    showTriggerLabel?: boolean;
     /**
      * Show dropdown header with user information
      */

package/dist/components/presentation/UserProfile/BaseUserProfile.d.ts

@@ -16,13 +16,34 @@
  * under the License.
  */
 import { FC, ReactElement } from 'react';
+import { User } from '@asgardeo/browser';
+interface ExtendedFlatSchema {
+    schemaId?: string;
+    path?: string;
+}
+interface Schema extends ExtendedFlatSchema {
+    caseExact?: boolean;
+    description?: string;
+    displayName?: string;
+    displayOrder?: string;
+    multiValued?: boolean;
+    mutability?: string;
+    name?: string;
+    required?: boolean;
+    returned?: string;
+    type?: string;
+    uniqueness?: string;
+    value?: any;
+    subAttributes?: Schema[];
+}
 export interface BaseUserProfileProps {
     fallback?: ReactElement;
     className?: string;
     cardLayout?: boolean;
-    user: any;
+    profile?: User;
+    flattenedProfile?: User;
+    schemas?: Schema[];
     mode?: 'inline' | 'popup';
-    portalId?: string;
     title?: string;
     attributeMapping?: {
         picture?: string | string[];

package/dist/components/primitives/Alert/Alert.d.ts

@@ -0,0 +1,74 @@
+/**
+ * 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 { HTMLAttributes, ReactNode, RefAttributes, ForwardRefExoticComponent } from 'react';
+export type AlertVariant = 'success' | 'error' | 'warning' | 'info';
+export interface AlertProps extends HTMLAttributes<HTMLDivElement> {
+    /**
+     * The visual variant of the alert that determines color scheme and icon
+     */
+    variant?: AlertVariant;
+    /**
+     * Whether to show the default icon for the variant
+     */
+    showIcon?: boolean;
+    /**
+     * Alert content
+     */
+    children?: ReactNode;
+}
+export interface AlertTitleProps extends HTMLAttributes<HTMLHeadingElement> {
+    /**
+     * Title content
+     */
+    children?: ReactNode;
+}
+export interface AlertDescriptionProps extends HTMLAttributes<HTMLParagraphElement> {
+    /**
+     * Description content
+     */
+    children?: ReactNode;
+}
+/**
+ * Alert component that displays important information with different severity levels.
+ *
+ * @example
+ * ```tsx
+ * <Alert variant="success" showIcon>
+ *   <Alert.Title>Success! Your changes have been saved</Alert.Title>
+ *   <Alert.Description>
+ *     This is an alert with icon, title and description.
+ *   </Alert.Description>
+ * </Alert>
+ * ```
+ */
+declare const Alert: ForwardRefExoticComponent<AlertProps & RefAttributes<HTMLDivElement>>;
+/**
+ * Alert title component.
+ */
+declare const AlertTitle: ForwardRefExoticComponent<AlertTitleProps & RefAttributes<HTMLHeadingElement>>;
+/**
+ * Alert description component.
+ */
+declare const AlertDescription: ForwardRefExoticComponent<AlertDescriptionProps & RefAttributes<HTMLParagraphElement>>;
+export interface AlertComponent extends ForwardRefExoticComponent<AlertProps & RefAttributes<HTMLDivElement>> {
+    Title: typeof AlertTitle;
+    Description: typeof AlertDescription;
+}
+declare const _default: AlertComponent;
+export default _default;
+export { Alert, AlertTitle, AlertDescription };

package/dist/components/primitives/Button/Button.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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 { ButtonHTMLAttributes } from 'react';
+export type ButtonColor = 'primary' | 'secondary' | 'tertiary' | string;
+export type ButtonVariant = 'solid' | 'outline' | 'text';
+export type ButtonSize = 'small' | 'medium' | 'large';
+export interface ButtonProps extends Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'color'> {
+    /**
+     * The button color that determines the color scheme
+     */
+    color?: ButtonColor;
+    /**
+     * The button variant that determines the visual style
+     */
+    variant?: ButtonVariant;
+    /**
+     * The size of the button
+     */
+    size?: ButtonSize;
+    /**
+     * Whether the button should take the full width of its container
+     */
+    fullWidth?: boolean;
+    /**
+     * Whether the button is in a loading state
+     */
+    loading?: boolean;
+    /**
+     * Icon to display before the button text
+     */
+    startIcon?: React.ReactNode;
+    /**
+     * Icon to display after the button text
+     */
+    endIcon?: React.ReactNode;
+}
+/**
+ * Button component with multiple variants and types.
+ *
+ * @example
+ * ```tsx
+ * // Primary solid button
+ * <Button color="primary" variant="solid">
+ *   Click me
+ * </Button>
+ *
+ * // Secondary outline button
+ * <Button color="secondary" variant="outline" size="large">
+ *   Cancel
+ * </Button>
+ *
+ * // Text button with loading state
+ * <Button color="tertiary" variant="text" loading>
+ *   Loading...
+ * </Button>
+ *
+ * // Button with icons
+ * <Button
+ *   color="primary"
+ *   startIcon={<Icon />}
+ *   endIcon={<Arrow />}
+ * >
+ *   Save and Continue
+ * </Button>
+ * ```
+ */
+declare const Button: import("react").ForwardRefExoticComponent<ButtonProps & import("react").RefAttributes<HTMLButtonElement>>;
+export default Button;