@asgardeo/react 0.2.4 → 0.4.0

package/dist/components/actions/SignInButton/BaseSignInButton.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 { ButtonHTMLAttributes, ForwardRefExoticComponent, ReactNode, RefAttributes } from 'react';
+import { WithPreferences } from '@asgardeo/browser';
+/**
+ * Common props shared by all {@link BaseSignInButton} components.
+ */
+export interface CommonBaseSignInButtonProps {
+    /**
+     * Function to initiate the sign-in process
+     */
+    signIn: () => Promise<void>;
+    /**
+     * Loading state during sign-in process
+     */
+    isLoading?: boolean;
+}
+/**
+ * Props passed to the render function of {@link BaseSignInButton}
+ */
+export type BaseSignInButtonRenderProps = CommonBaseSignInButtonProps;
+/**
+ * Props interface of {@link BaseSignInButton}
+ */
+export interface BaseSignInButtonProps extends Partial<CommonBaseSignInButtonProps>, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'>, WithPreferences {
+    /**
+     * Render prop function that receives sign-in props, or traditional ReactNode children
+     */
+    children?: ((props: BaseSignInButtonRenderProps) => ReactNode) | ReactNode;
+}
+/**
+ * Base SignInButton component that supports both render props and traditional props patterns.
+ *
+ * @example Using render props
+ * ```tsx
+ * <BaseSignInButton>
+ *   {({signIn, isLoading}) => (
+ *     <button onClick={signIn} disabled={isLoading}>
+ *       {isLoading ? 'Signing in...' : 'Sign In'}
+ *     </button>
+ *   )}
+ * </BaseSignInButton>
+ * ```
+ *
+ * @example Using traditional props
+ * ```tsx
+ * <BaseSignInButton className="custom-button">Sign In</BaseSignInButton>
+ * ```
+ */
+declare const BaseSignInButton: ForwardRefExoticComponent<BaseSignInButtonProps & RefAttributes<HTMLButtonElement>>;
+export default BaseSignInButton;

package/dist/components/actions/SignInButton/SignInButton.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { ForwardRefExoticComponent, RefAttributes } from 'react';
+import { BaseSignInButtonProps } from './BaseSignInButton';
+/**
+ * Props interface of {@link SignInButton}
+ */
+export type SignInButtonProps = BaseSignInButtonProps;
+/**
+ * SignInButton component that supports both render props and traditional props patterns.
+ *
+ * @remarks This component is only supported in browser based React applications (CSR).
+ *
+ * @example Using render props
+ * ```tsx
+ * <SignInButton>
+ *   {({signIn, isLoading}) => (
+ *     <button onClick={signIn} disabled={isLoading}>
+ *       {isLoading ? 'Signing in...' : 'Sign In'}
+ *     </button>
+ *   )}
+ * </SignInButton>
+ * ```
+ *
+ * @example Using traditional props
+ * ```tsx
+ * <SignInButton className="custom-button">Sign In</SignInButton>
+ * ```
+ *
+ * @example Using component-level preferences
+ * ```tsx
+ * <SignInButton
+ *   preferences={{
+ *     i18n: {
+ *       bundles: {
+ *         'en-US': {
+ *           translations: {
+ *             'buttons.signIn': 'Custom Sign In Text'
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }}
+ * >
+ *   Custom Sign In
+ * </SignInButton>
+ * ```
+ */
+declare const SignInButton: ForwardRefExoticComponent<SignInButtonProps & RefAttributes<HTMLButtonElement>>;
+export default SignInButton;

package/dist/components/actions/SignOutButton/BaseSignOutButton.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 { ForwardRefExoticComponent, ButtonHTMLAttributes, ReactNode, RefAttributes } from 'react';
+import { WithPreferences } from '@asgardeo/browser';
+/**
+ * Common props shared by all {@link BaseSignOutButton} components.
+ */
+export interface CommonBaseSignOutButtonProps {
+    /**
+     * Function to initiate the sign-out process
+     */
+    signOut: () => Promise<void>;
+    /**
+     * Loading state during sign-out process
+     */
+    isLoading?: boolean;
+}
+/**
+ * Props passed to the render function of {@link BaseSignOutButton}
+ */
+export type BaseSignOutButtonRenderProps = CommonBaseSignOutButtonProps;
+/**
+ * Props interface of {@link BaseSignOutButton}
+ */
+export interface BaseSignOutButtonProps extends Partial<CommonBaseSignOutButtonProps>, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'>, WithPreferences {
+    /**
+     * Render prop function that receives sign-out props, or traditional ReactNode children
+     */
+    children?: ((props: BaseSignOutButtonRenderProps) => ReactNode) | ReactNode;
+}
+/**
+ * Base SignOutButton component that supports both render props and traditional props patterns.
+ *
+ * @example Using render props
+ * ```tsx
+ * <BaseSignOutButton>
+ *   {({signOut, isLoading}) => (
+ *     <button onClick={signOut} disabled={isLoading}>
+ *       {isLoading ? 'Signing out...' : 'Sign Out'}
+ *     </button>
+ *   )}
+ * </BaseSignOutButton>
+ * ```
+ *
+ * @example Using traditional props
+ * ```tsx
+ * <BaseSignOutButton className="custom-button">Sign Out</BaseSignOutButton>
+ * ```
+ */
+declare const BaseSignOutButton: ForwardRefExoticComponent<BaseSignOutButtonProps & RefAttributes<HTMLButtonElement>>;
+export default BaseSignOutButton;

package/dist/components/actions/SignOutButton/SignOutButton.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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 { ForwardRefExoticComponent, RefAttributes } from 'react';
+import { BaseSignOutButtonProps } from './BaseSignOutButton';
+/**
+ * Props interface of {@link SignOutButton}
+ */
+export type SignOutButtonProps = BaseSignOutButtonProps;
+/**
+ * SignOutButton component that supports both render props and traditional props patterns.
+ *
+ * @remarks This component is only supported in browser based React applications (CSR).
+ *
+ * @example Using render props pattern
+ * ```tsx
+ * <SignOutButton>
+ *   {({signOut, isLoading}) => (
+ *     <button onClick={signOut} disabled={isLoading}>
+ *       {isLoading ? 'Signing out...' : 'Sign Out'}
+ *     </button>
+ *   )}
+ * </SignOutButton>
+ * ```
+ *
+ * @example Using traditional props pattern
+ * ```tsx
+ * <SignOutButton className="custom-button">Sign Out</SignOutButton>
+ * ```
+ *
+ * @example Using component-level preferences
+ * ```tsx
+ * <SignOutButton
+ *   preferences={{
+ *     i18n: {
+ *       bundles: {
+ *         'en-US': {
+ *           translations: {
+ *             'buttons.signOut': 'Custom Sign Out Text'
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }}
+ * >
+ *   Custom Sign Out
+ * </SignOutButton>
+ * ```
+ */
+declare const SignOutButton: ForwardRefExoticComponent<SignOutButtonProps & RefAttributes<HTMLButtonElement>>;
+export default SignOutButton;

package/dist/components/actions/SignUpButton/BaseSignUpButton.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 { ForwardRefExoticComponent, ButtonHTMLAttributes, ReactNode, RefAttributes } from 'react';
+import { WithPreferences } from '@asgardeo/browser';
+/**
+ * Common props shared by all {@link BaseSignUpButton} components.
+ */
+export interface CommonBaseSignUpButtonProps {
+    /**
+     * Function to initiate the sign-up process
+     */
+    signUp?: () => Promise<void>;
+    /**
+     * Loading state during sign-up process
+     */
+    isLoading?: boolean;
+}
+/**
+ * Props passed to the render function of {@link BaseSignUpButton}
+ */
+export type BaseSignUpButtonRenderProps = CommonBaseSignUpButtonProps;
+/**
+ * Props interface of {@link BaseSignUpButton}
+ */
+export interface BaseSignUpButtonProps extends CommonBaseSignUpButtonProps, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'>, WithPreferences {
+    /**
+     * Render prop function that receives sign-up props, or traditional ReactNode children
+     */
+    children?: ((props: BaseSignUpButtonRenderProps) => ReactNode) | ReactNode;
+}
+/**
+ * Base SignUpButton component that supports both render props and traditional props patterns.
+ *
+ * @example Using render props
+ * ```tsx
+ * <BaseSignUpButton>
+ *   {({ signUp, isLoading }) => (
+ *     <button onClick={signUp} disabled={isLoading}>
+ *       {isLoading ? 'Creating account...' : 'Create Account'}
+ *     </button>
+ *   )}
+ * </BaseSignUpButton>
+ * ```
+ *
+ * @example Using traditional props
+ * ```tsx
+ * <BaseSignUpButton className="custom-button">Create Account</BaseSignUpButton>
+ * ```
+ */
+declare const BaseSignUpButton: ForwardRefExoticComponent<BaseSignUpButtonProps & RefAttributes<HTMLButtonElement>>;
+export default BaseSignUpButton;

package/dist/components/actions/SignUpButton/SignUpButton.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 { ForwardRefExoticComponent, RefAttributes } from 'react';
+import { BaseSignUpButtonProps } from './BaseSignUpButton';
+/**
+ * Props interface of {@link SignUpButton}
+ */
+export type SignUpButtonProps = BaseSignUpButtonProps;
+/**
+ * SignUpButton component that supports both render props and traditional props patterns.
+ * It redirects the user to the Asgardeo sign-up page configured for the application.
+ *
+ * @remarks This component is only supported in browser based React applications (CSR).
+ *
+ * @example Using render props pattern
+ * ```tsx
+ * <SignUpButton>
+ *   {({ signUp, isLoading }) => (
+ *     <button onClick={signUp} disabled={isLoading}>
+ *       {isLoading ? 'Creating Account...' : 'Create Account'}
+ *     </button>
+ *   )}
+ * </SignUpButton>
+ * ```
+ *
+ * @example Using traditional props pattern
+ * ```tsx
+ * <SignUpButton className="custom-button">Create Account</SignUpButton>
+ * ```
+ *
+ * @example Using component-level preferences
+ * ```tsx
+ * <SignUpButton
+ *   preferences={{
+ *     i18n: {
+ *       bundles: {
+ *         'en-US': {
+ *           translations: {
+ *             'buttons.signUp': 'Custom Sign Up Text'
+ *           }
+ *         }
+ *       }
+ *     }
+ *   }}
+ * >
+ *   Custom Sign Up
+ * </SignUpButton>
+ * ```
+ */
+declare const SignUpButton: ForwardRefExoticComponent<SignUpButtonProps & RefAttributes<HTMLButtonElement>>;
+export default SignUpButton;

package/dist/components/control/SignedIn.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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, PropsWithChildren, ReactNode } from 'react';
+/**
+ * Props for the SignedIn component.
+ */
+export interface SignedInProps {
+    /**
+     * Content to show when the user is not signed in.
+     */
+    fallback?: ReactNode;
+}
+/**
+ * A component that only renders its children when the user is signed in.
+ *
+ * @example
+ * ```tsx
+ * import { SignedIn } from '@asgardeo/auth-react';
+ *
+ * const App = () => {
+ *   return (
+ *     <SignedIn fallback={<p>Please sign in to continue</p>}>
+ *       <p>Welcome! You are signed in.</p>
+ *     </SignedIn>
+ *   );
+ * }
+ * ```
+ */
+declare const SignedIn: FC<PropsWithChildren<SignedInProps>>;
+export default SignedIn;

package/dist/components/control/SignedOut.d.ts

@@ -0,0 +1,45 @@
+/**
+ * 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, PropsWithChildren, ReactNode } from 'react';
+/**
+ * Props for the SignedOut component.
+ */
+export interface SignedOutProps {
+    /**
+     * Content to show when the user is signed in.
+     */
+    fallback?: ReactNode;
+}
+/**
+ * A component that only renders its children when the user is signed out.
+ *
+ * @example
+ * ```tsx
+ * import { SignedOut } from '@asgardeo/auth-react';
+ *
+ * const App = () => {
+ *   return (
+ *     <SignedOut fallback={<p>You are already signed in</p>}>
+ *       <p>Please sign in to continue</p>
+ *     </SignedOut>
+ *   );
+ * }
+ * ```
+ */
+declare const SignedOut: FC<PropsWithChildren<SignedOutProps>>;
+export default SignedOut;

package/dist/components/factories/FieldFactory.d.ts

@@ -0,0 +1,107 @@
+/**
+ * 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, ReactElement } from 'react';
+import { SelectOption } from '../primitives/Select/Select';
+import { FieldType } from '@asgardeo/browser';
+/**
+ * Interface for field configuration.
+ */
+export interface FieldConfig {
+    name: string;
+    /**
+     * The field type based on ApplicationNativeAuthenticationAuthenticatorParamType.
+     */
+    type: FieldType;
+    /**
+     * Display name for the field.
+     */
+    label: string;
+    /**
+     * Whether the field is required.
+     */
+    required: boolean;
+    /**
+     * Current value of the field.
+     */
+    value: string;
+    /**
+     * Callback function when the field value changes.
+     */
+    onChange: (value: string) => void;
+    /**
+     * Whether the field is disabled.
+     */
+    disabled?: boolean;
+    /**
+     * Error message to display.
+     */
+    error?: string;
+    /**
+     * Additional CSS class name.
+     */
+    className?: string;
+    /**
+     * Additional options for multi-valued fields.
+     */
+    options?: SelectOption[];
+    /**
+     * Whether the field has been touched/interacted with by the user.
+     */
+    touched?: boolean;
+    /**
+     * Placeholder text for the field.
+     */
+    placeholder?: string;
+}
+/**
+ * Utility function to parse multi-valued string into array
+ */
+export declare const parseMultiValuedString: (value: string) => string[];
+/**
+ * Utility function to format array into multi-valued string
+ */
+export declare const formatMultiValuedString: (values: string[]) => string;
+/**
+ * Utility function to validate field values based on type
+ */
+export declare const validateFieldValue: (value: string, type: FieldType, required?: boolean, touched?: boolean) => string | null;
+/**
+ * Factory function to create form fields based on the ApplicationNativeAuthenticationAuthenticatorParamType.
+ *
+ * @param config - The field configuration
+ * @returns The appropriate React component for the field type
+ *
+ * @example
+ * ```tsx
+ * const field = createField({
+ *   param: 'username',
+ *   type: ApplicationNativeAuthenticationAuthenticatorParamType.String,
+ *   label: 'Username',
+ *   confidential: false,
+ *   required: true,
+ *   value: '',
+ *   onChange: (value) => console.log(value)
+ * });
+ * ```
+ */
+export declare const createField: (config: FieldConfig) => ReactElement;
+/**
+ * React component wrapper for the field factory.
+ */
+export declare const FieldFactory: FC<FieldConfig>;
+export default FieldFactory;