@asgardeo/react 0.2.4 → 0.4.0

package/dist/contexts/I18n/I18nContext.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 { I18nBundle } from '@asgardeo/browser';
+export interface I18nContextValue {
+    /**
+     * The current language code (e.g., 'en-US', 'fr-FR')
+     */
+    currentLanguage: string;
+    /**
+     * The fallback language code
+     */
+    fallbackLanguage: string;
+    /**
+     * All available i18n bundles (default + user provided)
+     */
+    bundles: Record<string, I18nBundle>;
+    /**
+     * Function to change the current language
+     */
+    setLanguage: (language: string) => void;
+    /**
+     * Function to get a translation by key with optional parameters
+     */
+    t: (key: string, params?: Record<string, string | number>) => string;
+}
+declare const I18nContext: import("react").Context<I18nContextValue>;
+export default I18nContext;

package/dist/{esm/types/components/SignedIn/SignedIn.d.ts → contexts/I18n/I18nProvider.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ * 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
@@ -16,14 +16,16 @@
  * under the License.
  */
 import { FC, PropsWithChildren } from 'react';
-import SignedProps from '../../models/signed-props';
+import { I18nPreferences } from '@asgardeo/browser';
+export interface I18nProviderProps {
+    /**
+     * The i18n preferences from the AsgardeoProvider
+     */
+    preferences?: I18nPreferences;
+}
 /**
- * This component renders its children if the user is signed out.
- *
- * @param {PropsWithChildren<SignedProps>} props - Props injected to the component.
- * @param {ReactElement} props.fallback - Fallback element to render.
- *
- * @return {JSX.Element}
+ * I18nProvider component that manages internationalization state and provides
+ * translation functions to child components.
  */
-declare const SignedIn: FC<PropsWithChildren<SignedProps>>;
-export default SignedIn;
+declare const I18nProvider: FC<PropsWithChildren<I18nProviderProps>>;
+export default I18nProvider;

package/dist/contexts/I18n/useI18n.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 { I18nContextValue } from './I18nContext';
+/**
+ * Hook for accessing the I18n context directly.
+ * Provides access to the full i18n context including bundles and all utilities.
+ *
+ * @returns The complete I18n context value
+ * @throws Error if used outside of I18nProvider context
+ */
+declare const useI18n: () => I18nContextValue;
+export default useI18n;

package/dist/{esm/types/models/asgardeo-provider-props.d.ts → contexts/Theme/ThemeContext.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ * 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
@@ -15,10 +15,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { BrandingProps, Store, UIAuthConfig } from '@asgardeo/js';
-interface AsgardeoProviderProps {
-    branding?: BrandingProps;
-    config: UIAuthConfig;
-    store?: Store;
+import { Theme } from '@asgardeo/browser';
+export interface ThemeContextValue {
+    theme: Theme;
+    colorScheme: 'light' | 'dark';
+    toggleTheme: () => void;
 }
-export default AsgardeoProviderProps;
+declare const ThemeContext: import("react").Context<ThemeContextValue>;
+export default ThemeContext;

package/dist/{esm/types/models/branding-preference-provider-props.d.ts → contexts/Theme/ThemeProvider.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ * 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
@@ -15,8 +15,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { BrandingProps } from '@asgardeo/js';
-interface BrandingPreferenceProviderProps {
-    branding?: BrandingProps;
+import { FC, PropsWithChildren } from 'react';
+import { ThemeConfig, RecursivePartial } from '@asgardeo/browser';
+export interface ThemeProviderProps {
+    theme?: RecursivePartial<ThemeConfig>;
+    defaultColorScheme?: 'light' | 'dark';
 }
-export default BrandingPreferenceProviderProps;
+declare const ThemeProvider: FC<PropsWithChildren<ThemeProviderProps>>;
+export default ThemeProvider;

package/dist/{esm/types/models/use-on.d.ts → contexts/Theme/types.d.ts}

@@ -15,17 +15,27 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-export declare enum Hooks {
-    SignIn = 0,
-    SignOut = 1
+export interface ThemeColors {
+    primary: string;
+    background: string;
+    surface: string;
+    text: {
+        primary: string;
+        secondary: string;
+    };
+    border: string;
 }
-export interface UseOnProps {
-    /**
-     * The callback to be executed when the event is triggered.
-     */
-    callback: (response?: any) => void | Promise<void>;
-    /**
-     * The event to listen to.
-     */
-    event: Hooks;
+export interface ThemeConfig {
+    colors: ThemeColors;
+    spacing: {
+        unit: number;
+    };
+    borderRadius: {
+        small: string;
+        medium: string;
+        large: string;
+    };
+}
+export interface Theme extends ThemeConfig {
+    cssVariables: Record<string, string>;
 }

package/dist/{esm/types/models/signed-props.d.ts → contexts/Theme/useTheme.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ * 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
@@ -15,8 +15,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ReactElement } from 'react';
-interface SignedProps {
-    fallback?: ReactElement;
-}
-export default SignedProps;
+import { ThemeContextValue } from './ThemeContext';
+declare const useTheme: () => ThemeContextValue;
+export default useTheme;

package/dist/contexts/User/UserContext.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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 { Context } from 'react';
+import { User, Schema } from '@asgardeo/browser';
+/**
+ * Props interface of {@link UserContext}
+ */
+export type UserContextProps = {
+    profile: User | null;
+    schemas: Schema[] | null;
+    flattenedProfile: User | null;
+};
+/**
+ * Context object for managing user profile data and related operations.
+ */
+declare const UserContext: Context<UserContextProps | null>;
+export default UserContext;

package/dist/contexts/User/UserProvider.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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 } from 'react';
+import { UserProfile } from '@asgardeo/browser';
+/**
+ * Props interface of {@link UserProvider}
+ */
+export interface UserProviderProps {
+    profile: UserProfile;
+}
+/**
+ * UserProvider component that manages user profile data and provides it through UserContext.
+ *
+ * This provider:
+ * - Fetches user profile data from the ME endpoint
+ * - Retrieves SCIM2 schemas for profile structure
+ * - Generates both nested and flattened user profiles
+ * - Provides functions for refreshing and updating user data
+ * - Handles loading states and errors
+ *
+ * @example
+ * ```tsx
+ * // Basic usage
+ * <UserProvider>
+ *   <App />
+ * </UserProvider>
+ *
+ * // With custom error handling
+ * <UserProvider onError={(error) => console.error('User error:', error)}>
+ *   <App />
+ * </UserProvider>
+ *
+ * // Disable auto-fetch (fetch manually using refreshUser)
+ * <UserProvider autoFetch={false}>
+ *   <App />
+ * </UserProvider>
+ * ```
+ */
+declare const UserProvider: FC<PropsWithChildren<UserProviderProps>>;
+export default UserProvider;

package/dist/contexts/User/useUser.d.ts

@@ -0,0 +1,94 @@
+/**
+ * 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 { UserContextProps } from './UserContext';
+/**
+ * Hook to access the User context.
+ *
+ * This hook provides access to user profile data including:
+ * - Raw profile API response
+ * - SCIM2 schemas
+ * - Nested user object
+ * - Flattened user profile
+ * - Functions to refresh and update user data
+ * - Loading states and error handling
+ *
+ * @returns {UserContextProps} The user context value containing all user-related data and functions
+ * @throws {Error} Throws an error if used outside of UserProvider
+ *
+ * @example
+ * ```tsx
+ * import {useUser} from '@asgardeo/react';
+ *
+ * function ProfileComponent() {
+ *   const {
+ *     isLoading,
+ *     profile,
+ *     schemas,
+ *     user,
+ *     flattenedUser,
+ *     refreshUser,
+ *     updateUser,
+ *     error
+ *   } = useUser();
+ *
+ *   if (isLoading) {
+ *     return <div>Loading user data...</div>;
+ *   }
+ *
+ *   if (error) {
+ *     return <div>Error: {error.message}</div>;
+ *   }
+ *
+ *   return (
+ *     <div>
+ *       <h1>Welcome {user?.name?.givenName}!</h1>
+ *       <p>Email: {flattenedUser?.emails}</p>
+ *       <button onClick={refreshUser}>Refresh Profile</button>
+ *     </div>
+ *   );
+ * }
+ *
+ * // Access specific user properties
+ * function UserEmail() {
+ *   const {flattenedUser} = useUser();
+ *   return <span>{flattenedUser?.emails?.[0]}</span>;
+ * }
+ *
+ * // Update user profile
+ * function EditProfile() {
+ *   const {updateUser, user} = useUser();
+ *
+ *   const handleUpdate = async () => {
+ *     try {
+ *       await updateUser({
+ *         name: {
+ *           givenName: 'John',
+ *           familyName: 'Doe'
+ *         }
+ *       });
+ *     } catch (error) {
+ *       console.error('Update failed:', error);
+ *     }
+ *   };
+ *
+ *   return <button onClick={handleUpdate}>Update Name</button>;
+ * }
+ * ```
+ */
+declare const useUser: () => UserContextProps;
+export default useUser;

package/dist/hooks/useBrowserUrl.d.ts

@@ -0,0 +1,47 @@
+/**
+ * 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.
+ */
+/**
+ * Interface for the useBrowserUrl hook return value.
+ */
+export interface UseBrowserUrl {
+    /**
+     * Checks if the current URL contains authentication parameters.
+     *
+     * @param url - The URL object to check for authentication parameters
+     * @param afterSignInUrl - The URL where the authorization server should redirect after authentication
+     * @returns True if the URL contains authentication parameters and matches the afterSignInUrl, or if it contains an error parameter
+     */
+    hasAuthParams: (url: URL, afterSignInUrl: string) => boolean;
+}
+/**
+ * Hook that provides utilities for handling browser URLs in authentication flows.
+ *
+ * @returns An object containing URL utility functions
+ *
+ * @example
+ * ```tsx
+ * const { hasAuthParams } = useBrowserUrl();
+ * const url = new URL(window.location.href);
+ *
+ * if (hasAuthParams(url, "/after-signin")) {
+ *   // Handle authentication callback
+ * }
+ * ```
+ */
+declare const useBrowserUrl: () => UseBrowserUrl;
+export default useBrowserUrl;

package/dist/hooks/useForm.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.
+ */
+/**
+ * Generic form field configuration
+ */
+export interface FormField {
+    name: string;
+    required?: boolean;
+    initialValue?: string;
+    validator?: (value: string) => string | null;
+}
+/**
+ * Form validation result
+ */
+export interface ValidationResult {
+    isValid: boolean;
+    errors: Record<string, string>;
+}
+/**
+ * Configuration for the useForm hook
+ */
+export interface UseFormConfig<T extends Record<string, string>> {
+    /**
+     * Initial form values
+     */
+    initialValues?: Partial<T>;
+    /**
+     * Form field definitions
+     */
+    fields?: FormField[];
+    /**
+     * Global form validator function
+     */
+    validator?: (values: T) => Record<string, string>;
+    /**
+     * Whether to validate on change (default: false)
+     */
+    validateOnChange?: boolean;
+    /**
+     * Whether to validate on blur (default: true)
+     */
+    validateOnBlur?: boolean;
+    /**
+     * Custom required field validation message
+     */
+    requiredMessage?: string;
+}
+/**
+ * Return type for the useForm hook
+ */
+export interface UseFormReturn<T extends Record<string, string>> {
+    /**
+     * Current form values
+     */
+    values: T;
+    /**
+     * Fields that have been touched by the user
+     */
+    touched: Record<keyof T, boolean>;
+    /**
+     * Current validation errors
+     */
+    errors: Record<keyof T, string>;
+    /**
+     * Whether the form is currently valid
+     */
+    isValid: boolean;
+    /**
+     * Whether the form has been submitted
+     */
+    isSubmitted: boolean;
+    /**
+     * Set a single field value
+     */
+    setValue: (name: keyof T, value: string) => void;
+    /**
+     * Set multiple field values
+     */
+    setValues: (values: Partial<T>) => void;
+    /**
+     * Mark a field as touched
+     */
+    setTouched: (name: keyof T, touched?: boolean) => void;
+    /**
+     * Mark multiple fields as touched
+     */
+    setTouchedFields: (touched: Partial<Record<keyof T, boolean>>) => void;
+    /**
+     * Mark all fields as touched
+     */
+    touchAllFields: () => void;
+    /**
+     * Set a field error
+     */
+    setError: (name: keyof T, error: string) => void;
+    /**
+     * Set multiple field errors
+     */
+    setErrors: (errors: Partial<Record<keyof T, string>>) => void;
+    /**
+     * Clear all errors
+     */
+    clearErrors: () => void;
+    /**
+     * Validate a single field
+     */
+    validateField: (name: keyof T) => string | null;
+    /**
+     * Validate all fields
+     */
+    validateForm: () => ValidationResult;
+    /**
+     * Reset the form to initial values
+     */
+    reset: () => void;
+    /**
+     * Handle form submission
+     */
+    handleSubmit: (onSubmit: (values: T) => void | Promise<void>) => (e?: React.FormEvent) => Promise<void>;
+    /**
+     * Get field props for easy integration with form components
+     */
+    getFieldProps: (name: keyof T) => {
+        name: keyof T;
+        value: string;
+        onChange: (value: string) => void;
+        onBlur: () => void;
+        error: string | undefined;
+        touched: boolean;
+        required: boolean;
+    };
+}
+/**
+ * Generic form hook that provides comprehensive form state management and validation.
+ *
+ * @template T - The type of form values (must extend Record<string, string>)
+ * @param config - Configuration options for the form
+ * @returns Form state and methods
+ *
+ * @example
+ * ```tsx
+ * interface LoginForm {
+ *   username: string;
+ *   password: string;
+ * }
+ *
+ * const {
+ *   values,
+ *   touched,
+ *   errors,
+ *   isValid,
+ *   setValue,
+ *   handleSubmit,
+ *   getFieldProps
+ * } = useForm<LoginForm>({
+ *   initialValues: { username: '', password: '' },
+ *   fields: [
+ *     { name: 'username', required: true },
+ *     { name: 'password', required: true }
+ *   ]
+ * });
+ *
+ * const onSubmit = handleSubmit((values) => {
+ *   console.log('Form submitted:', values);
+ * });
+ *
+ * return (
+ *   <form onSubmit={onSubmit}>
+ *     <input {...getFieldProps('username')} />
+ *     <input {...getFieldProps('password')} type="password" />
+ *     <button type="submit" disabled={!isValid}>Submit</button>
+ *   </form>
+ * );
+ * ```
+ */
+export declare const useForm: <T extends Record<string, string>>(config?: UseFormConfig<T>) => UseFormReturn<T>;
+export default useForm;

package/dist/hooks/useTranslation.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { I18nPreferences } from '@asgardeo/browser';
+export interface UseTranslation {
+    /**
+     * Translation function that returns a translated string for the given key
+     */
+    t: (key: string, params?: Record<string, string | number>) => string;
+    /**
+     * The current language code
+     */
+    currentLanguage: string;
+    /**
+     * Function to change the current language
+     */
+    setLanguage: (language: string) => void;
+    /**
+     * All available language codes
+     */
+    availableLanguages: string[];
+}
+export interface UseTranslationWithPreferences extends UseTranslation {
+    /**
+     * Enhanced translation function that merges component-level preferences
+     */
+    t: (key: string, params?: Record<string, string | number>) => string;
+}
+/**
+ * Hook for accessing translation functions and language management.
+ * Must be used within an I18nProvider context.
+ *
+ * @param componentPreferences - Optional component-level i18n preferences to merge with global ones
+ * @returns An object containing translation function and language management utilities
+ * @throws Error if used outside of I18nProvider context
+ */
+declare const useTranslation: (componentPreferences?: I18nPreferences) => UseTranslationWithPreferences;
+export default useTranslation;