@asgardeo/react 0.2.4 → 0.4.0

package/dist/components/presentation/SignIn/BaseSignIn.d.ts

@@ -0,0 +1,125 @@
+/**
+ * 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 { ApplicationNativeAuthenticationInitiateResponse, ApplicationNativeAuthenticationHandleResponse } from '@asgardeo/browser';
+import { FC } from 'react';
+/**
+ * Props for the BaseSignIn component.
+ */
+export interface BaseSignInProps {
+    /**
+     * Function to initialize authentication flow.
+     * @returns Promise resolving to the initial authentication response.
+     */
+    onInitialize: () => Promise<ApplicationNativeAuthenticationInitiateResponse>;
+    /**
+     * Function to handle authentication steps.
+     * @param payload - The authentication payload.
+     * @returns Promise resolving to the authentication response.
+     */
+    onSubmit: (flow: {
+        requestConfig?: {
+            method: string;
+            url: string;
+        };
+        payload: {
+            flowId: string;
+            selectedAuthenticator: {
+                authenticatorId: string;
+                params: Record<string, string>;
+            };
+        };
+    }) => Promise<ApplicationNativeAuthenticationHandleResponse>;
+    /**
+     * Callback function called when authentication is successful.
+     * @param authData - The authentication data returned upon successful completion.
+     */
+    onSuccess?: (authData: Record<string, any>) => void;
+    /**
+     * Callback function called when authentication fails.
+     * @param error - The error that occurred during authentication.
+     */
+    onError?: (error: Error) => void;
+    /**
+     * Callback function called when authentication flow status changes.
+     * @param response - The current authentication response.
+     */
+    onFlowChange?: (response: ApplicationNativeAuthenticationInitiateResponse | ApplicationNativeAuthenticationHandleResponse) => void;
+    /**
+     * Custom CSS class name for the form container.
+     */
+    className?: string;
+    /**
+     * Custom CSS class name for form inputs.
+     */
+    inputClassName?: string;
+    /**
+     * Custom CSS class name for the submit button.
+     */
+    buttonClassName?: string;
+    /**
+     * Custom CSS class name for error messages.
+     */
+    errorClassName?: string;
+    /**
+     * Custom CSS class name for info messages.
+     */
+    messageClassName?: string;
+    /**
+     * Size variant for the component.
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Theme variant for the component.
+     */
+    variant?: 'default' | 'outlined' | 'filled';
+    afterSignInUrl?: string;
+}
+/**
+ * Base SignIn component that provides native authentication flow.
+ * This component handles both the presentation layer and authentication flow logic.
+ * It accepts API functions as props to maintain framework independence.
+ *
+ * @example
+ * ```tsx
+ * import { BaseSignIn } from '@asgardeo/react';
+ *
+ * const MySignIn = () => {
+ *   return (
+ *     <BaseSignIn
+ *       onInitialize={async () => {
+ *         // Your API call to initialize authentication
+ *         return await initializeAuth();
+ *       }}
+ *       onSubmit={async (payload) => {
+ *         // Your API call to handle authentication
+ *         return await handleAuth(payload);
+ *       }}
+ *       onSuccess={(authData) => {
+ *         console.log('Success:', authData);
+ *       }}
+ *       onError={(error) => {
+ *         console.error('Error:', error);
+ *       }}
+ *       className="max-w-md mx-auto"
+ *     />
+ *   );
+ * };
+ * ```
+ */
+declare const BaseSignIn: FC<BaseSignInProps>;
+export default BaseSignIn;

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

@@ -0,0 +1,62 @@
+/**
+ * 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';
+/**
+ * Props for the SignIn component.
+ */
+export interface SignInProps {
+    /**
+     * Additional CSS class names for customization.
+     */
+    className?: string;
+    /**
+     * Size variant for the component.
+     */
+    size?: 'small' | 'medium' | 'large';
+    /**
+     * Theme variant for the component.
+     */
+    variant?: 'default' | 'outlined' | 'filled';
+}
+/**
+ * A styled SignIn component that provides native authentication flow with pre-built styling.
+ * This component handles the API calls for authentication and delegates UI logic to BaseSignIn.
+ *
+ * @example
+ * ```tsx
+ * import { SignIn } from '@asgardeo/react';
+ *
+ * const App = () => {
+ *   return (
+ *     <SignIn
+ *       onSuccess={(authData) => {
+ *         console.log('Authentication successful:', authData);
+ *         // Handle successful authentication (e.g., redirect, store tokens)
+ *       }}
+ *       onError={(error) => {
+ *         console.error('Authentication failed:', error);
+ *       }}
+ *       size="medium"
+ *       variant="outlined"
+ *     />
+ *   );
+ * };
+ * ```
+ */
+declare const SignIn: FC<SignInProps>;
+export default SignIn;

package/dist/{esm/types/hooks/use-config.d.ts → components/presentation/SignIn/options/EmailOtp.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,9 +15,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import UseConfig from '../models/use-config';
+import { FC } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
 /**
- * Custom hook to access the authentication configuration from the AsgardeoProviderContext.
- * @returns An object containing the authentication configuration.
+ * Email OTP Sign-In Option Component.
+ * Handles email-based OTP authentication.
  */
-export declare const useConfig: () => UseConfig;
+declare const EmailOtp: FC<BaseSignInOptionProps>;
+export default EmailOtp;

package/dist/components/presentation/SignIn/options/FacebookButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Facebook Sign-In Button Component.
+ * Handles authentication with Facebook identity provider.
+ */
+declare const FacebookButton: FC<BaseSignInOptionProps>;
+export default FacebookButton;

package/dist/components/presentation/SignIn/options/GitHubButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * GitHub Sign-In Button Component.
+ * Handles authentication with GitHub identity provider.
+ */
+declare const GitHubButton: FC<BaseSignInOptionProps>;
+export default GitHubButton;

package/dist/components/presentation/SignIn/options/GoogleButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Google Sign-In Button Component.
+ * Handles authentication with Google identity provider.
+ */
+declare const GoogleButton: FC<BaseSignInOptionProps>;
+export default GoogleButton;

package/dist/components/presentation/SignIn/options/IdentifierFirst.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Identifier First Sign-In Option Component.
+ * Handles identifier-first authentication flow (username first, then password).
+ */
+declare const IdentifierFirst: FC<BaseSignInOptionProps>;
+export default IdentifierFirst;

package/dist/components/presentation/SignIn/options/LinkedInButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * LinkedIn Sign-In Button Component.
+ * Handles authentication with LinkedIn identity provider.
+ */
+declare const LinkedInButton: FC<BaseSignInOptionProps>;
+export default LinkedInButton;

package/dist/{esm/types/components/SignIn/fragments/SmsOtp.d.ts → components/presentation/SignIn/options/MicrosoftButton.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,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { PropsWithChildren, ReactElement } from 'react';
-import EmailOtpProps from '../../../models/email-otp-props';
-declare const SmsOtp: ({ alert, brandingProps, authenticator, children, handleAuthenticate, }: PropsWithChildren<EmailOtpProps>) => ReactElement;
-export default SmsOtp;
+import { FC } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Microsoft Sign-In Button Component.
+ * Handles authentication with Microsoft identity provider.
+ */
+declare const MicrosoftButton: FC<BaseSignInOptionProps>;
+export default MicrosoftButton;

package/dist/components/presentation/SignIn/options/MultiOptionButton.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Multi Option Button Component.
+ * Renders authenticators as selectable buttons for multi-option prompts.
+ * Used when authenticators don't require immediate user input but need to be selected first.
+ */
+declare const MultiOptionButton: FC<BaseSignInOptionProps>;
+export default MultiOptionButton;

package/dist/components/presentation/SignIn/options/SignInOptionFactory.d.ts

@@ -0,0 +1,76 @@
+/**
+ * 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 { ApplicationNativeAuthenticationAuthenticator, WithPreferences } from '@asgardeo/browser';
+import { ReactElement } from 'react';
+/**
+ * Base props that all sign-in option components share.
+ */
+export interface BaseSignInOptionProps extends WithPreferences {
+    /**
+     * The authenticator configuration.
+     */
+    authenticator: ApplicationNativeAuthenticationAuthenticator;
+    /**
+     * Current form values.
+     */
+    formValues: Record<string, string>;
+    /**
+     * Touched state for form fields.
+     */
+    touchedFields: Record<string, boolean>;
+    /**
+     * Whether the component is in loading state.
+     */
+    isLoading: boolean;
+    /**
+     * Error message to display.
+     */
+    error?: string | null;
+    /**
+     * Callback function called when input values change.
+     */
+    onInputChange: (param: string, value: string) => void;
+    /**
+     * Callback function called when the option is submitted.
+     */
+    onSubmit: (authenticator: ApplicationNativeAuthenticationAuthenticator, formData?: Record<string, string>) => void;
+    /**
+     * Custom CSS class name for form inputs.
+     */
+    inputClassName?: string;
+    /**
+     * Custom CSS class name for the submit button.
+     */
+    buttonClassName?: string;
+    /**
+     * Text for the submit button.
+     */
+    submitButtonText?: string;
+}
+/**
+ * Creates the appropriate sign-in option component based on the authenticator's ID.
+ */
+export declare const createSignInOption: (props: BaseSignInOptionProps) => ReactElement;
+/**
+ * Convenience function that creates the appropriate sign-in option component from an authenticator.
+ */
+export declare const createSignInOptionFromAuthenticator: (authenticator: ApplicationNativeAuthenticationAuthenticator, formValues: Record<string, string>, touchedFields: Record<string, boolean>, isLoading: boolean, onInputChange: (param: string, value: string) => void, onSubmit: (authenticator: ApplicationNativeAuthenticationAuthenticator, formData?: Record<string, string>) => void, options?: {
+    inputClassName?: string;
+    buttonClassName?: string;
+    error?: string | null;
+}) => ReactElement;

package/dist/{esm/types/components/SignOutButton/SignOutButton.d.ts → components/presentation/SignIn/options/SignInWithEthereumButton.d.ts}

@@ -1,5 +1,5 @@
 /**
- * Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com). All Rights Reserved.
+ * 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,13 +15,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { ReactElement } from 'react';
+import { FC } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
 /**
- * SignOutButton component.
- *
- * This component renders a sign out button. When clicked, it triggers the sign out process.
- *
- * @returns {ReactElement} Rendered SignOutButton component.
+ * Sign In With Ethereum Button Component.
+ * Handles authentication with Sign In With Ethereum identity provider.
  */
-declare const SignOutButton: () => ReactElement;
-export default SignOutButton;
+declare const SignInWithEthereumButton: FC<BaseSignInOptionProps>;
+export default SignInWithEthereumButton;

package/dist/{esm/types/contexts/branding-preference-context.d.ts → components/presentation/SignIn/options/SmsOtp.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,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Branding } from '@asgardeo/js';
-import { Context } from 'react';
-declare const BrandingPreferenceContext: Context<Branding>;
-export default BrandingPreferenceContext;
+import { FC } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * SMS OTP Sign-In Option Component.
+ * Handles SMS-based OTP authentication.
+ */
+declare const SmsOtp: FC<BaseSignInOptionProps>;
+export default SmsOtp;

package/dist/components/presentation/SignIn/options/SocialButton.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Social Login Sign-In Option Component.
+ * Handles authentication with external identity providers (Google, GitHub, etc.).
+ */
+declare const SocialLogin: FC<BaseSignInOptionProps>;
+export default SocialLogin;

package/dist/{esm/types/contexts/asgardeo-context.d.ts → components/presentation/SignIn/options/Totp.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,11 @@
  * specific language governing permissions and limitations
  * under the License.
  */
-import { Context } from 'react';
-import AuthContext from '../models/auth-context';
-declare const AsgardeoContext: Context<AuthContext>;
-export default AsgardeoContext;
+import { FC } from 'react';
+import { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * TOTP Sign-In Option Component.
+ * Handles Time-based One-Time Password (TOTP) authentication.
+ */
+declare const Totp: FC<BaseSignInOptionProps>;
+export default Totp;

package/dist/components/presentation/SignIn/options/UsernamePassword.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { BaseSignInOptionProps } from './SignInOptionFactory';
+/**
+ * Username Password Sign-In Option Component.
+ * Handles traditional username and password authentication.
+ */
+declare const UsernamePassword: FC<BaseSignInOptionProps>;
+export default UsernamePassword;