@asgardeo/react 0.2.3 → 0.3.0

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

@@ -0,0 +1,49 @@
+/**
+ * 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 { BaseUserProfileProps } from './BaseUserProfile';
+/**
+ * Props for the UserProfile component.
+ * Extends BaseUserProfileProps but makes the user prop optional since it will be obtained from useAsgardeo
+ */
+export type UserProfileProps = Omit<BaseUserProfileProps, 'user'>;
+/**
+ * UserProfile component displays the authenticated user's profile information in a
+ * structured and styled format. It shows user details such as display name, email,
+ * username, and other available profile information from Asgardeo.
+ *
+ * This component is the React-specific implementation that uses the BaseUserProfile
+ * and automatically retrieves the user data from Asgardeo context if not provided.
+ *
+ * @example
+ * ```tsx
+ * // Basic usage - will use user from Asgardeo context
+ * <UserProfile />
+ *
+ * // With explicit user data
+ * <UserProfile user={specificUser} />
+ *
+ * // With card layout and custom fallback
+ * <UserProfile
+ *   cardLayout={true}
+ *   fallback={<div>Please sign in to view your profile</div>}
+ * />
+ * ```
+ */
+declare const UserProfile: FC<UserProfileProps>;
+export default UserProfile;

package/dist/{cjs/types/components/SignIn/SignIn.d.ts → components/primitives/Avatar/Avatar.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,16 +16,27 @@
  * under the License.
  */
 import { FC } from 'react';
-import { SignInProps } from '../../models/sign-in';
-import './sign-in.scss';
-/**
- * This component provides the sign-in functionality.
- *
- * @param {SignInProps} props - Props injected to the component.
- * @param {BrandingProps} props.brandingProps - Branding related props.
- * @param {boolean} props.showSignUp - Show sign-up.
- *
- * @returns {ReactElement} - React element.
- */
-declare const SignIn: FC<SignInProps>;
-export default SignIn;
+export interface AvatarProps {
+    /**
+     * The URL of the avatar image
+     */
+    imageUrl?: string;
+    /**
+     * Alternative text for the avatar image
+     */
+    alt?: string;
+    /**
+     * The size of the avatar in pixels
+     */
+    size?: number;
+    /**
+     * The name to use for generating initials when no image is provided
+     */
+    name?: string;
+    /**
+     * Optional className for the avatar
+     */
+    className?: string;
+}
+export declare const Avatar: FC<AvatarProps>;
+export default Avatar;

package/dist/{esm/types/models/use-on.d.ts → components/primitives/Checkbox/Checkbox.d.ts}

@@ -15,17 +15,28 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-export declare enum Hooks {
-    SignIn = 0,
-    SignOut = 1
-}
-export interface UseOnProps {
+import { FC, InputHTMLAttributes } from 'react';
+export interface CheckboxProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'className' | 'type'> {
+    /**
+     * Label text to display next to the checkbox
+     */
+    label?: string;
+    /**
+     * Error message to display below the checkbox
+     */
+    error?: string;
+    /**
+     * Additional CSS class names
+     */
+    className?: string;
     /**
-     * The callback to be executed when the event is triggered.
+     * Whether the field is required
      */
-    callback: (response?: any) => void | Promise<void>;
+    required?: boolean;
     /**
-     * The event to listen to.
+     * Helper text to display below the checkbox
      */
-    event: Hooks;
+    helperText?: string;
 }
+export declare const Checkbox: FC<CheckboxProps>;
+export default Checkbox;

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

@@ -0,0 +1,50 @@
+/**
+ * Copyright (c) 2024, 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, InputHTMLAttributes } from 'react';
+export interface DatePickerProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'className' | 'type'> {
+    /**
+     * Label text to display above the input
+     */
+    label?: string;
+    /**
+     * Error message to display below the input
+     */
+    error?: string;
+    /**
+     * Additional CSS class names
+     */
+    className?: string;
+    /**
+     * Whether the field is required
+     */
+    required?: boolean;
+    /**
+     * Whether the field is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Helper text to display below the input
+     */
+    helperText?: string;
+    /**
+     * Custom date format for the regex pattern
+     */
+    dateFormat?: string;
+}
+export declare const DatePicker: FC<DatePickerProps>;
+export default DatePicker;

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

@@ -0,0 +1,59 @@
+/**
+ * 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, ReactNode } from 'react';
+interface PopoverHeaderProps {
+    children?: ReactNode;
+}
+declare const PopoverHeader: FC<PopoverHeaderProps>;
+interface PopoverContentProps {
+    children: ReactNode;
+}
+declare const PopoverContent: FC<PopoverContentProps>;
+export interface PopoverProps {
+    /**
+     * Whether the popover is open
+     */
+    isOpen: boolean;
+    /**
+     * The content to display inside the popover
+     */
+    children: ReactNode;
+    /**
+     * Callback when the popover should close
+     */
+    onClose: () => void;
+    /**
+     * Optional custom class name for the popover container
+     */
+    className?: string;
+    /**
+     * The HTML element ID where the portal should be mounted
+     */
+    portalId?: string;
+    /**
+     * The display mode of the popover
+     * 'modal' - shows overlay and centers content
+     * 'dropdown' - no overlay, content positioned relative to trigger
+     */
+    mode?: 'modal' | 'dropdown';
+}
+export declare const Popover: FC<PopoverProps> & {
+    Header: typeof PopoverHeader;
+    Content: typeof PopoverContent;
+};
+export default Popover;

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

@@ -0,0 +1,60 @@
+/**
+ * Copyright (c) 2024, 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, SelectHTMLAttributes } from 'react';
+export interface SelectOption {
+    /**
+     * The value that will be submitted with the form
+     */
+    value: string;
+    /**
+     * The text that will be displayed in the select
+     */
+    label: string;
+}
+export interface SelectProps extends Omit<SelectHTMLAttributes<HTMLSelectElement>, 'className'> {
+    /**
+     * Label text to display above the select
+     */
+    label?: string;
+    /**
+     * Error message to display below the select
+     */
+    error?: string;
+    /**
+     * Additional CSS class names
+     */
+    className?: string;
+    /**
+     * Whether the field is required
+     */
+    required?: boolean;
+    /**
+     * Whether the field is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Helper text to display below the select
+     */
+    helperText?: string;
+    /**
+     * The options to display in the select
+     */
+    options: SelectOption[];
+}
+export declare const Select: FC<SelectProps>;
+export default Select;

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

@@ -0,0 +1,46 @@
+/**
+ * Copyright (c) 2024, 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, InputHTMLAttributes } from 'react';
+export interface TextFieldProps extends Omit<InputHTMLAttributes<HTMLInputElement>, 'className'> {
+    /**
+     * Label text to display above the input
+     */
+    label?: string;
+    /**
+     * Error message to display below the input
+     */
+    error?: string;
+    /**
+     * Additional CSS class names
+     */
+    className?: string;
+    /**
+     * Whether the field is required
+     */
+    required?: boolean;
+    /**
+     * Whether the field is disabled
+     */
+    disabled?: boolean;
+    /**
+     * Helper text to display below the input
+     */
+    helperText?: string;
+}
+export declare const TextField: FC<TextFieldProps>;
+export default TextField;

package/dist/contexts/AsgardeoContext.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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';
+/**
+ * Props interface of {@link AsgardeoContext}
+ */
+export type AsgardeoContextProps = {
+    /**
+     * Flag indicating whether the SDK is working in the background.
+     */
+    isLoading: boolean;
+    /**
+     * Flag indicating whether the user is signed in or not.
+     */
+    isSignedIn: boolean;
+    /**
+     * Sign-in function to initiate the authentication process.
+     * @remark This is the programmatic version of the `SignInButton` component.
+     * TODO: Fix the types.
+     */
+    signIn: any;
+    /**
+     * Sign-out function to terminate the authentication session.
+     * @remark This is the programmatic version of the `SignOutButton` component.
+     * FIXME: Fix the types.
+     */
+    signOut: any;
+    /**
+     * Sign-up function to initiate the registration process.
+     * @remark This is the programmatic version of the `SignUpButton` component.
+     * FIXME: Fix the types.
+     */
+    signUp: any;
+    user: any;
+    baseUrl: string;
+};
+/**
+ * Context object for managing the Authentication flow builder core context.
+ */
+declare const AsgardeoContext: Context<AsgardeoContextProps | null>;
+export default AsgardeoContext;

package/dist/{cjs/types/contexts/i18n-context.d.ts → hooks/useAsgardeo.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,7 +15,6 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Context } from 'react';
-import { I18n } from '../models/i18n';
-declare const I18nContext: Context<I18n>;
-export default I18nContext;
+import { AsgardeoContextProps } from '../contexts/AsgardeoContext';
+declare const useAsgardeo: () => AsgardeoContextProps;
+export default useAsgardeo;

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;