@asgardeo/react 0.3.0 → 0.5.0

package/dist/contexts/Flow/FlowContext.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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.
+ */
+/**
+ * Types of authentication flows/steps that can be displayed.
+ */
+export type FlowStep = {
+    id: string;
+    type: 'signin' | 'signup' | 'organization-signin' | 'forgot-password' | 'reset-password' | 'verify-email' | 'mfa';
+    title: string;
+    subtitle?: string;
+    canGoBack?: boolean;
+    metadata?: Record<string, any>;
+} | null;
+/**
+ * Message types for displaying in authentication flows.
+ */
+export interface FlowMessage {
+    id?: string;
+    type: 'success' | 'error' | 'warning' | 'info';
+    message: string;
+    dismissible?: boolean;
+}
+/**
+ * Context value for managing authentication flow UI state.
+ */
+export interface FlowContextValue {
+    currentStep: FlowStep;
+    setCurrentStep: (step: FlowStep) => void;
+    title: string;
+    setTitle: (title: string) => void;
+    subtitle?: string;
+    setSubtitle: (subtitle?: string) => void;
+    messages: FlowMessage[];
+    addMessage: (message: FlowMessage) => void;
+    removeMessage: (messageId: string) => void;
+    clearMessages: () => void;
+    error: string | null;
+    setError: (error: string | null) => void;
+    isLoading: boolean;
+    setIsLoading: (loading: boolean) => void;
+    showBackButton: boolean;
+    setShowBackButton: (show: boolean) => void;
+    onGoBack?: () => void;
+    setOnGoBack: (callback?: () => void) => void;
+    reset: () => void;
+    navigateToFlow: (flowType: NonNullable<FlowStep>['type'], options?: {
+        title?: string;
+        subtitle?: string;
+        metadata?: Record<string, any>;
+    }) => void;
+}
+/**
+ * Context for managing authentication flow UI state.
+ * This context handles titles, messages, navigation, and loading states
+ * for authentication flows like SignIn, SignUp, organization signin, etc.
+ */
+declare const FlowContext: import("react").Context<FlowContextValue>;
+export default FlowContext;

package/dist/contexts/Flow/FlowProvider.d.ts

@@ -0,0 +1,46 @@
+/**
+ * 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 { FlowStep } from './FlowContext';
+/**
+ * Props for the FlowProvider component.
+ */
+export interface FlowProviderProps {
+    /**
+     * Initial step to start with.
+     */
+    initialStep?: FlowStep;
+    /**
+     * Initial title.
+     */
+    initialTitle?: string;
+    /**
+     * Initial subtitle.
+     */
+    initialSubtitle?: string;
+    /**
+     * Callback when flow type changes.
+     */
+    onFlowChange?: (step: FlowStep) => void;
+}
+/**
+ * Provider component for flow context.
+ * Manages shared UI state for authentication flows including titles, messages, and navigation.
+ */
+declare const FlowProvider: FC<PropsWithChildren<FlowProviderProps>>;
+export default FlowProvider;

package/dist/contexts/Flow/useFlow.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 { FlowContextValue } from './FlowContext';
+/**
+ * Hook to access the flow context.
+ * Must be used within a FlowProvider.
+ *
+ * @example
+ * ```tsx
+ * const MyAuthComponent = () => {
+ *   const { title, setTitle, addMessage, isLoading } = useFlow();
+ *
+ *   const handleSuccess = () => {
+ *     addMessage({
+ *       type: 'success',
+ *       message: 'Authentication successful!'
+ *     });
+ *   };
+ *
+ *   return (
+ *     <div>
+ *       <h1>{title}</h1>
+ *       {isLoading && <p>Loading...</p>}
+ *     </div>
+ *   );
+ * };
+ * ```
+ *
+ * @returns The flow context value
+ * @throws Error if used outside of FlowProvider
+ */
+declare const useFlow: () => FlowContextValue;
+export default useFlow;

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/contexts/I18n/I18nProvider.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { I18nPreferences } from '@asgardeo/browser';
+export interface I18nProviderProps {
+    /**
+     * The i18n preferences from the AsgardeoProvider
+     */
+    preferences?: I18nPreferences;
+}
+/**
+ * I18nProvider component that manages internationalization state and provides
+ * translation functions to child components.
+ */
+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/contexts/Organization/OrganizationContext.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 { Organization } from '@asgardeo/browser';
+import { Context } from 'react';
+/**
+ * Interface for organizations with switch access information.
+ */
+export interface OrganizationWithSwitchAccess extends Organization {
+    /**
+     * Whether the user has switch access to this organization
+     */
+    canSwitch: boolean;
+}
+/**
+ * Props interface of {@link OrganizationContext}
+ */
+export type OrganizationContextProps = {
+    currentOrganization: Organization | null;
+    error: string | null;
+    getOrganizations: () => Promise<Organization[]>;
+    isLoading: boolean;
+    organizations: Organization[] | null;
+    revalidateOrganizations: () => Promise<void>;
+    switchOrganization: (organization: Organization) => Promise<void>;
+    /**
+     * Paginated organizations with switch access information
+     */
+    paginatedOrganizations: OrganizationWithSwitchAccess[];
+    /**
+     * Whether there are more organizations to load
+     */
+    hasMore: boolean;
+    /**
+     * Whether more data is being loaded
+     */
+    isLoadingMore: boolean;
+    /**
+     * Total number of organizations
+     */
+    totalCount: number;
+    /**
+     * Function to fetch more organizations (pagination)
+     */
+    fetchMore: () => Promise<void>;
+    /**
+     * Function to fetch paginated organizations with switch access
+     */
+    fetchPaginatedOrganizations: (config?: {
+        filter?: string;
+        limit?: number;
+        recursive?: boolean;
+        reset?: boolean;
+    }) => Promise<void>;
+};
+/**
+ * Context object for managing organization data and related operations.
+ */
+declare const OrganizationContext: Context<OrganizationContextProps | null>;
+export default OrganizationContext;

package/dist/contexts/Organization/OrganizationProvider.d.ts

@@ -0,0 +1,90 @@
+/**
+ * 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 } from '@asgardeo/browser';
+import { FC, PropsWithChildren } from 'react';
+/**
+ * Props interface of {@link OrganizationProvider}
+ */
+export interface OrganizationProviderProps {
+    /**
+     * Whether to automatically fetch organizations on mount
+     */
+    autoFetch?: boolean;
+    /**
+     * Initial current organization
+     */
+    currentOrganization?: Organization | null;
+    /**
+     * Function to fetch organizations
+     */
+    getOrganizations: () => Promise<Organization[]>;
+    /**
+     * Callback function called when an error occurs
+     */
+    onError?: (error: string) => void;
+    /**
+     * Callback function called when switching organizations
+     */
+    onOrganizationSwitch?: (organization: Organization) => Promise<void>;
+    /**
+     * Initial list of organizations
+     */
+    organizations?: Organization[] | null;
+}
+/**
+ * OrganizationProvider component that manages organization data and provides it through OrganizationContext.
+ *
+ * This provider:
+ * - Fetches organization data from the organizations endpoint
+ * - Manages current organization state
+ * - Provides functions for switching organizations and refreshing data
+ * - Handles loading states and errors
+ * - Accepts a custom getOrganizations function for flexible data fetching
+ *
+ * @example
+ * ```tsx
+ * // Basic usage with auto-fetch (uses internal API)
+ * <OrganizationProvider>
+ *   <App />
+ * </OrganizationProvider>
+ *
+ * // With custom getOrganizations function
+ * <OrganizationProvider getOrganizations={async () => asgardeo.getOrganizations()}>
+ *   <App />
+ * </OrganizationProvider>
+ *
+ * // With custom error handling
+ * <OrganizationProvider onError={(error) => console.error('Organization error:', error)}>
+ *   <App />
+ * </OrganizationProvider>
+ *
+ * // With custom organization switch handler
+ * <OrganizationProvider
+ *   onOrganizationSwitch={(org) => console.log('Switched to:', org.name)}
+ * >
+ *   <App />
+ * </OrganizationProvider>
+ *
+ * // Disable auto-fetch (fetch manually using revalidateOrganizations)
+ * <OrganizationProvider autoFetch={false}>
+ *   <App />
+ * </OrganizationProvider>
+ * ```
+ */
+declare const OrganizationProvider: FC<PropsWithChildren<OrganizationProviderProps>>;
+export default OrganizationProvider;

package/dist/contexts/Organization/useOrganization.d.ts

@@ -0,0 +1,104 @@
+/**
+ * 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 { OrganizationContextProps } from './OrganizationContext';
+/**
+ * Hook to access the Organization context.
+ *
+ * This hook provides access to organization data including:
+ * - List of organizations the user belongs to
+ * - Current organization
+ * - Functions to switch organizations and refresh data
+ * - Function to fetch organizations programmatically
+ * - Loading states and error handling
+ *
+ * @returns {OrganizationContextProps} The organization context value containing all organization-related data and functions
+ * @throws {Error} Throws an error if used outside of OrganizationProvider
+ *
+ * @example
+ * ```tsx
+ * import {useOrganization} from '@asgardeo/react';
+ *
+ * function OrganizationSelector() {
+ *   const {
+ *     organizations,
+ *     currentOrganization,
+ *     switchOrganization,
+ *     revalidateOrganizations,
+ *     getOrganizations,
+ *     isLoading,
+ *     error
+ *   } = useOrganization();
+ *
+ *   if (isLoading) {
+ *     return <div>Loading organizations...</div>;
+ *   }
+ *
+ *   if (error) {
+ *     return <div>Error: {error}</div>;
+ *   }
+ *
+ *   return (
+ *     <div>
+ *       <h2>Current: {currentOrganization?.name}</h2>
+ *       <select
+ *         value={currentOrganization?.id || ''}
+ *         onChange={(e) => {
+ *           const org = organizations?.find(o => o.id === e.target.value);
+ *           if (org) switchOrganization(org);
+ *         }}
+ *       >
+ *         {organizations?.map(org => (
+ *           <option key={org.id} value={org.id}>
+ *             {org.name}
+ *           </option>
+ *         ))}
+ *       </select>
+ *       <button onClick={revalidateOrganizations}>
+ *         Refresh Organizations
+ *       </button>
+ *       <button onClick={async () => {
+ *         const fresh = await getOrganizations();
+ *         console.log('Fresh organizations:', fresh);
+ *       }}>
+ *         Get Organizations Manually
+ *       </button>
+ *     </div>
+ *   );
+ * }
+ *
+ * // Switch to a specific organization
+ * function SwitchOrgButton() {
+ *   const {organizations, switchOrganization} = useOrganization();
+ *
+ *   const handleSwitch = (orgId: string) => {
+ *     const org = organizations?.find(o => o.id === orgId);
+ *     if (org) {
+ *       switchOrganization(org);
+ *     }
+ *   };
+ *
+ *   return (
+ *     <button onClick={() => handleSwitch('org-123')}>
+ *       Switch to Organization
+ *     </button>
+ *   );
+ * }
+ * ```
+ */
+declare const useOrganization: () => OrganizationContextProps;
+export default useOrganization;

package/dist/{theme → contexts/Theme}/ThemeProvider.d.ts

@@ -21,4 +21,5 @@ export interface ThemeProviderProps {
     theme?: RecursivePartial<ThemeConfig>;
     defaultColorScheme?: 'light' | 'dark';
 }
-export declare const ThemeProvider: FC<PropsWithChildren<ThemeProviderProps>>;
+declare const ThemeProvider: FC<PropsWithChildren<ThemeProviderProps>>;
+export default ThemeProvider;

package/dist/{theme → contexts/Theme}/types.d.ts

@@ -16,24 +16,53 @@
  * under the License.
  */
 export interface ThemeColors {
-    primary: string;
-    background: string;
-    surface: string;
+    background: {
+        body: {
+            main: string;
+        };
+        disabled: string;
+        surface: string;
+    };
+    border: string;
+    error: {
+        contrastText: string;
+        main: string;
+    };
+    primary: {
+        contrastText: string;
+        main: string;
+    };
+    secondary: {
+        contrastText: string;
+        main: string;
+    };
+    success: {
+        contrastText: string;
+        main: string;
+    };
     text: {
         primary: string;
         secondary: string;
     };
-    border: string;
+    warning: {
+        contrastText: string;
+        main: string;
+    };
 }
 export interface ThemeConfig {
-    colors: ThemeColors;
-    spacing: {
-        unit: number;
-    };
     borderRadius: {
-        small: string;
+        large: string;
         medium: string;
+        small: string;
+    };
+    colors: ThemeColors;
+    shadows: {
         large: string;
+        medium: string;
+        small: string;
+    };
+    spacing: {
+        unit: number;
     };
 }
 export interface Theme extends ThemeConfig {

package/dist/{theme → contexts/Theme}/useTheme.d.ts

@@ -16,4 +16,5 @@
  * under the License.
  */
 import { ThemeContextValue } from './ThemeContext';
-export declare const useTheme: () => ThemeContextValue;
+declare const useTheme: () => ThemeContextValue;
+export default useTheme;

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

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