@asgardeo/react 0.3.0 → 0.5.0

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

@@ -15,19 +15,20 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { WithPreferences } from '@asgardeo/browser';
 import { ButtonHTMLAttributes, ForwardRefExoticComponent, ReactNode, RefAttributes } from 'react';
 /**
  * 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;
+    /**
+     * Function to initiate the sign-in process
+     */
+    signIn: () => Promise<void>;
 }
 /**
  * Props passed to the render function of {@link BaseSignInButton}
@@ -36,7 +37,7 @@ export type BaseSignInButtonRenderProps = CommonBaseSignInButtonProps;
 /**
  * Props interface of {@link BaseSignInButton}
  */
-export interface BaseSignInButtonProps extends CommonBaseSignInButtonProps, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'> {
+export interface BaseSignInButtonProps extends Partial<CommonBaseSignInButtonProps>, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'>, WithPreferences {
     /**
      * Render prop function that receives sign-in props, or traditional ReactNode children
      */
@@ -48,7 +49,7 @@ export interface BaseSignInButtonProps extends CommonBaseSignInButtonProps, Omit
  * @example Using render props
  * ```tsx
  * <BaseSignInButton>
- *   {({ signIn, isLoading }) => (
+ *   {({signIn, isLoading}) => (
  *     <button onClick={signIn} disabled={isLoading}>
  *       {isLoading ? 'Signing in...' : 'Sign In'}
  *     </button>

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

@@ -29,8 +29,8 @@ export type SignInButtonProps = BaseSignInButtonProps;
  * @example Using render props
  * ```tsx
  * <SignInButton>
- *   {({ handleSignIn, isLoading }) => (
- *     <button onClick={handleSignIn} disabled={isLoading}>
+ *   {({signIn, isLoading}) => (
+ *     <button onClick={signIn} disabled={isLoading}>
  *       {isLoading ? 'Signing in...' : 'Sign In'}
  *     </button>
  *   )}
@@ -41,6 +41,25 @@ export type SignInButtonProps = BaseSignInButtonProps;
  * ```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

@@ -15,19 +15,20 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { WithPreferences } from '@asgardeo/browser';
 import { ForwardRefExoticComponent, ButtonHTMLAttributes, ReactNode, RefAttributes } from 'react';
 /**
  * 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;
+    /**
+     * Function to initiate the sign-out process
+     */
+    signOut: () => Promise<void>;
 }
 /**
  * Props passed to the render function of {@link BaseSignOutButton}
@@ -36,7 +37,7 @@ export type BaseSignOutButtonRenderProps = CommonBaseSignOutButtonProps;
 /**
  * Props interface of {@link BaseSignOutButton}
  */
-export interface BaseSignOutButtonProps extends CommonBaseSignOutButtonProps, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'> {
+export interface BaseSignOutButtonProps extends Partial<CommonBaseSignOutButtonProps>, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'>, WithPreferences {
     /**
      * Render prop function that receives sign-out props, or traditional ReactNode children
      */
@@ -48,7 +49,7 @@ export interface BaseSignOutButtonProps extends CommonBaseSignOutButtonProps, Om
  * @example Using render props
  * ```tsx
  * <BaseSignOutButton>
- *   {({ signOut, isLoading }) => (
+ *   {({signOut, isLoading}) => (
  *     <button onClick={signOut} disabled={isLoading}>
  *       {isLoading ? 'Signing out...' : 'Sign Out'}
  *     </button>

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

@@ -24,10 +24,12 @@ 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 }) => (
+ *   {({signOut, isLoading}) => (
  *     <button onClick={signOut} disabled={isLoading}>
  *       {isLoading ? 'Signing out...' : 'Sign Out'}
  *     </button>
@@ -39,6 +41,25 @@ export type SignOutButtonProps = BaseSignOutButtonProps;
  * ```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

@@ -15,19 +15,20 @@
  * specific language governing permissions and limitations
  * under the License.
  */
+import { WithPreferences } from '@asgardeo/browser';
 import { ForwardRefExoticComponent, ButtonHTMLAttributes, ReactNode, RefAttributes } from 'react';
 /**
  * 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;
+    /**
+     * Function to initiate the sign-up process
+     */
+    signUp?: () => Promise<void>;
 }
 /**
  * Props passed to the render function of {@link BaseSignUpButton}
@@ -36,7 +37,7 @@ export type BaseSignUpButtonRenderProps = CommonBaseSignUpButtonProps;
 /**
  * Props interface of {@link BaseSignUpButton}
  */
-export interface BaseSignUpButtonProps extends CommonBaseSignUpButtonProps, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'> {
+export interface BaseSignUpButtonProps extends CommonBaseSignUpButtonProps, Omit<ButtonHTMLAttributes<HTMLButtonElement>, 'children'>, WithPreferences {
     /**
      * Render prop function that receives sign-up props, or traditional ReactNode children
      */

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

@@ -25,6 +25,8 @@ 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>
@@ -40,6 +42,25 @@ export type SignUpButtonProps = BaseSignUpButtonProps;
  * ```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/AsgardeoLoading.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 Loading component.
+ */
+export interface AsgardeoLoadingProps {
+    /**
+     * Content to show when the user is not signed in.
+     */
+    fallback?: ReactNode;
+}
+/**
+ * A component that only renders its children when the Asgardeo is loading.
+ *
+ * @example
+ * ```tsx
+ * import { AsgardeoLoading } from '@asgardeo/auth-react';
+ *
+ * const App = () => {
+ *   return (
+ *     <AsgardeoLoading fallback={<p>Finished Loading...</p>}>
+ *       <p>Loading...</p>
+ *     </AsgardeoLoading>
+ *   );
+ * }
+ * ```
+ */
+declare const AsgardeoLoading: FC<PropsWithChildren<AsgardeoLoadingProps>>;
+export default AsgardeoLoading;

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 EmbeddedSignInFlowAuthenticatorParamType.
+     */
+    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 EmbeddedSignInFlowAuthenticatorParamType.
+ *
+ * @param config - The field configuration
+ * @returns The appropriate React component for the field type
+ *
+ * @example
+ * ```tsx
+ * const field = createField({
+ *   param: 'username',
+ *   type: EmbeddedSignInFlowAuthenticatorParamType.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;

package/dist/components/presentation/CreateOrganization/BaseCreateOrganization.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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 { CSSProperties, FC, ReactNode } from 'react';
+import { CreateOrganizationPayload } from '../../../api/scim2/createOrganization';
+/**
+ * Interface for organization form data.
+ */
+export interface OrganizationFormData {
+    description: string;
+    handle: string;
+    name: string;
+}
+/**
+ * Props interface for the BaseCreateOrganization component.
+ */
+export interface BaseCreateOrganizationProps {
+    cardLayout?: boolean;
+    className?: string;
+    defaultParentId?: string;
+    error?: string | null;
+    initialValues?: Partial<OrganizationFormData>;
+    loading?: boolean;
+    mode?: 'inline' | 'popup';
+    onCancel?: () => void;
+    onOpenChange?: (open: boolean) => void;
+    onSubmit?: (payload: CreateOrganizationPayload) => void | Promise<void>;
+    onSuccess?: (organization: any) => void;
+    open?: boolean;
+    renderAdditionalFields?: () => ReactNode;
+    style?: CSSProperties;
+    title?: string;
+}
+/**
+ * BaseCreateOrganization component provides the core functionality for creating organizations.
+ * This component serves as the base for framework-specific implementations.
+ */
+export declare const BaseCreateOrganization: FC<BaseCreateOrganizationProps>;
+export default BaseCreateOrganization;

package/dist/components/presentation/CreateOrganization/CreateOrganization.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 { BaseCreateOrganizationProps } from './BaseCreateOrganization';
+import { CreateOrganizationPayload } from '../../../api/scim2/createOrganization';
+/**
+ * Props interface for the CreateOrganization component.
+ */
+export interface CreateOrganizationProps extends Omit<BaseCreateOrganizationProps, 'onSubmit' | 'loading' | 'error'> {
+    /**
+     * Fallback element to render when the user is not signed in.
+     */
+    fallback?: ReactElement;
+    /**
+     * Custom organization creation handler (will use default API if not provided).
+     */
+    onCreateOrganization?: (payload: CreateOrganizationPayload) => Promise<any>;
+}
+/**
+ * CreateOrganization component that provides organization creation functionality.
+ * This component automatically integrates with the Asgardeo and Organization contexts.
+ *
+ * @example
+ * ```tsx
+ * import { CreateOrganization } from '@asgardeo/react';
+ *
+ * // Basic usage - uses default API and contexts
+ * <CreateOrganization
+ *   onSuccess={(org) => console.log('Created:', org)}
+ *   onCancel={() => navigate('/organizations')}
+ * />
+ *
+ * // With custom organization creation handler
+ * <CreateOrganization
+ *   onCreateOrganization={async (payload) => {
+ *     const result = await myCustomAPI.createOrganization(payload);
+ *     return result;
+ *   }}
+ *   onSuccess={(org) => {
+ *     console.log('Organization created:', org.name);
+ *     // Custom success logic here
+ *   }}
+ * />
+ *
+ * // With fallback for unauthenticated users
+ * <CreateOrganization
+ *   fallback={<div>Please sign in to create an organization</div>}
+ * />
+ * ```
+ */
+export declare const CreateOrganization: FC<CreateOrganizationProps>;
+export default CreateOrganization;

package/dist/components/presentation/Organization/BaseOrganization.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 { Organization as IOrganization } from '@asgardeo/browser';
+import { FC, ReactNode } from 'react';
+/**
+ * Props for the BaseOrganization component.
+ */
+export interface BaseOrganizationProps {
+    /**
+     * Render prop that takes the organization object and returns a ReactNode.
+     * @param organization - The organization object from Asgardeo.
+     * @returns A ReactNode to render.
+     */
+    children: (organization: IOrganization | null) => ReactNode;
+    /**
+     * Optional element to render when no organization is provided.
+     */
+    fallback?: ReactNode;
+    /**
+     * The organization object to display. If not provided, the component will render the fallback.
+     */
+    organization: IOrganization | null;
+}
+/**
+ * Base Organization component that provides the core functionality for displaying organization information.
+ * This component takes an organization 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
+ * an organization object available. For React applications, use the Organization component which
+ * automatically retrieves the current organization from Organization context.
+ *
+ * @example
+ * ```tsx
+ * import { BaseOrganization } from '@asgardeo/auth-react';
+ *
+ * const MyComponent = ({ organization }) => {
+ *   return (
+ *     <BaseOrganization organization={organization} fallback={<p>No organization data</p>}>
+ *       {(org) => (
+ *         <div>
+ *           <h1>Organization: {org.name}</h1>
+ *           <p>ID: {org.id}</p>
+ *         </div>
+ *       )}
+ *     </BaseOrganization>
+ *   );
+ * }
+ * ```
+ */
+declare const BaseOrganization: FC<BaseOrganizationProps>;
+export default BaseOrganization;

package/dist/components/presentation/Organization/Organization.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 { Organization as IOrganization } from '@asgardeo/browser';
+import { FC, ReactNode } from 'react';
+import { BaseOrganizationProps } from './BaseOrganization';
+/**
+ * Props for the Organization component.
+ * Extends BaseOrganizationProps but makes the organization prop optional since it will be obtained from useOrganization
+ */
+export interface OrganizationProps extends Omit<BaseOrganizationProps, 'organization'> {
+    /**
+     * Render prop that takes the organization object and returns a ReactNode.
+     * @param organization - The current organization object from Organization context.
+     * @returns A ReactNode to render.
+     */
+    children: (organization: IOrganization | null) => ReactNode;
+    /**
+     * Optional element to render when no organization is selected.
+     */
+    fallback?: ReactNode;
+}
+/**
+ * A component that uses render props to expose the current organization object.
+ * This component automatically retrieves the current organization from Organization context.
+ *
+ * @remarks This component is only supported in browser based React applications (CSR).
+ *
+ * @example
+ * ```tsx
+ * import { Organization } from '@asgardeo/auth-react';
+ *
+ * const App = () => {
+ *   return (
+ *     <Organization fallback={<p>No organization selected</p>}>
+ *       {(organization) => (
+ *         <div>
+ *           <h1>Current Organization: {organization.name}!</h1>
+ *           <p>ID: {organization.id}</p>
+ *           <p>Role: {organization.role}</p>
+ *           {organization.memberCount && (
+ *             <p>Members: {organization.memberCount}</p>
+ *           )}
+ *         </div>
+ *       )}
+ *     </Organization>
+ *   );
+ * }
+ * ```
+ */
+declare const Organization: FC<OrganizationProps>;
+export default Organization;