@sikka/hawa 0.23.8-next → 0.23.9-next

package/dist/blocks/auth/index.d.mts

@@ -0,0 +1,202 @@
+import { FC } from 'react';
+import { D as DirectionType } from '../../commonTypes-MxCJyrHv.mjs';
+import { L as LoginFormTextsTypes, R as RegisterFormTextsTypes, a as ThirdPartyAuthTextsTypes, N as NewPasswordTextsTypes, b as ResetPasswordTextsTypes } from '../../textTypes-559CaoOV.mjs';
+
+type LoginFormTypes = {
+    /** Object containing text labels used throughout the form. */
+    texts?: LoginFormTextsTypes;
+    /** If true, only logos are displayed in third-party auth buttons.   */
+    logosOnly?: boolean;
+    /** Direction of text and UI elements, either left-to-right or right-to-left.   */
+    direction?: DirectionType;
+    /** If true, an error alert is displayed at the top of the form.   */
+    showError?: boolean;
+    /** Title text of error alert.   */
+    errorTitle?: string;
+    /** Description text of error alert.   */
+    errorText?: string;
+    /** Login identifier type user will use to log in.   */
+    loginType?: "email" | "username" | "phone" | "link";
+    /** If true, the reset password option is hidden.   */
+    withoutResetPassword?: boolean;
+    /** If true, the register option is hidden.   */
+    allowRegister?: boolean;
+    /** If true, a loading spinner is displayed within the main form submit button.   */
+    isLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Google login button.   */
+    isGoogleLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Twitter login button.   */
+    isTwitterLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Github login button.   */
+    isGithubLoading?: boolean;
+    /** If true, Google login option is displayed.   */
+    viaGoogle?: boolean;
+    /** If true, Github login option is displayed.   */
+    viaGithub?: boolean;
+    /** If true, Twitter login option is displayed.   */
+    viaTwitter?: boolean;
+    /** Function to handle form submission.   */
+    onLogin?: (e: any) => void;
+    /** Function to route user to the register page.   */
+    onRouteToRegister?: () => void;
+    /** Function to handle forgotten password case.   */
+    onForgotPassword?: () => void;
+    /** Function to handle Google login.   */
+    onGoogleLogin?: () => void;
+    /** Function to handle Github login.   */
+    onGithubLogin?: () => void;
+    /** Function to handle Twitter login.   */
+    onTwitterLogin?: () => void;
+    /** Additional buttons to add under the login button */
+    additionalButtons?: any;
+    /** The allowed length of the password input field */
+    passwordLength?: number;
+};
+declare const LoginForm: FC<LoginFormTypes>;
+
+type SelectOptionProps = {
+    value: any;
+    label: any;
+};
+
+type RegisterFormTypes = {
+    /** Object containing text labels used throughout the form. */
+    texts?: RegisterFormTextsTypes;
+    /** Direction of text and layout, either 'rtl' (right-to-left) or 'ltr' (left-to-right). */
+    direction?: DirectionType;
+    /** Determines whether to display logos only or with text in the social media registration section. */
+    logosOnly?: boolean;
+    /** Enables registration via Google when set to true. */
+    viaGoogle?: boolean;
+    /** Enables registration via Github when set to true. */
+    viaGithub?: boolean;
+    /** Enables registration via Twitter when set to true. */
+    viaTwitter?: boolean;
+    /** Determines whether to show the referral code field. */
+    showRefCode?: boolean;
+    /** Determines whether to show the user source selection. */
+    showUserSource?: boolean;
+    /** Determines whether to show the terms acceptance checkbox. */
+    showTermsOption?: boolean;
+    /** Determines whether to show the newsletter subscription checkbox. */
+    showNewsletterOption?: boolean;
+    /** Callback function triggered on form submission. */
+    onRegister: (e: any) => void;
+    /** Callback function triggered to route to the login page. */
+    onRouteToLogin?: () => void;
+    /** Callback function triggered to handle registration via Google. */
+    onGoogleRegister?: () => void;
+    /** Callback function triggered to handle registration via Github. */
+    onGithubRegister?: () => void;
+    /** Callback function triggered to handle registration via Twitter. */
+    onTwitterRegister?: () => void;
+    /** Callback function triggered to route to the Terms of Service page. */
+    onRouteToTOS?: () => void;
+    /** Determines whether to show an error alert. */
+    showError?: boolean;
+    /** Title for the error alert. */
+    errorTitle?: any;
+    /** Text for the error alert. */
+    errorText?: any;
+    /** Array containing the fields to be included in the form. */
+    registerFields?: string[];
+    /** Indicates whether the form submission is in progress. */
+    isLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Google login button.   */
+    isGoogleLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Twitter login button.   */
+    isTwitterLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Github login button.   */
+    isGithubLoading?: boolean;
+    /** The options of "How did you learn about us?" select field.   */
+    userReferenceOptions?: SelectOptionProps[];
+    /** To add more custom buttons under the register button.   */
+    additionalButtons?: any;
+    /** To add more custom input fields   */
+    additionalInputs?: any;
+};
+declare const RegisterForm: FC<RegisterFormTypes>;
+
+type AppLandingTextsTypes = ThirdPartyAuthTextsTypes & {
+    newUserText?: string;
+    createAccount?: string;
+};
+type AppLandingTypes = {
+    texts?: AppLandingTextsTypes;
+    viaGoogle?: boolean;
+    viaTwitter?: boolean;
+    viaGithub?: boolean;
+    viaMicrosoft?: boolean;
+    viaEmail?: boolean;
+    viaPhone?: boolean;
+    viaApple?: boolean;
+    allowRegister?: boolean;
+    size?: "small" | "normal" | "full";
+    direction?: DirectionType;
+    handleRouteToRegister?: () => void;
+    handleGoogle?: () => void;
+    handleTwitter?: () => void;
+    handleApple?: () => void;
+    handleMicrosoft?: () => void;
+    handleGithub?: () => void;
+    handleEmail?: () => void;
+    handlePhone?: () => void;
+};
+declare const AppLanding: FC<AppLandingTypes>;
+
+type CheckEmailBlocks = {
+    handleResend?: () => void;
+    texts?: {
+        checkEmail: string;
+        resendEmail: string;
+        pleaseVerify: string;
+    };
+};
+declare const CheckEmail: FC<CheckEmailBlocks>;
+
+type NewPasswordTypes = {
+    handleNewPassword: (e: any) => void;
+    handleRouteToRegister: () => void;
+    direction?: DirectionType;
+    headless?: boolean;
+    allowRegister?: boolean;
+    passwordChanged: any;
+    texts: NewPasswordTextsTypes;
+};
+declare const NewPasswordForm: FC<NewPasswordTypes>;
+
+type ResetPasswordType = {
+    handleResetPassword: (e: any) => void;
+    handleRouteToRegister: () => void;
+    sent: any;
+    headless?: boolean;
+    allowRegister?: boolean;
+    direction?: DirectionType;
+    texts?: ResetPasswordTextsTypes;
+};
+declare const ResetPasswordForm: FC<ResetPasswordType>;
+
+type TConfirmation = {
+    texts?: {
+        checkYourPhone?: string;
+        weSentCode?: string;
+        didntGetCode?: string;
+        resendCode?: string;
+        resendCodeTimer?: string;
+        codeRequiredText?: string;
+        codeTooShort?: string;
+        confirm?: string;
+        cancel?: string;
+        seconds?: string;
+    };
+    showError?: any;
+    errorTitle?: any;
+    errorText?: any;
+    phoneNumber?: string;
+    confirmLoading?: boolean;
+    handleConfirm?: any;
+    handleResend?: any;
+};
+declare const CodeConfirmation: FC<TConfirmation>;
+
+export { AppLanding, CheckEmail, CodeConfirmation, LoginForm, NewPasswordForm, RegisterForm, ResetPasswordForm };

package/dist/blocks/auth/index.d.ts

@@ -0,0 +1,202 @@
+import { FC } from 'react';
+import { D as DirectionType } from '../../commonTypes-MxCJyrHv.js';
+import { L as LoginFormTextsTypes, R as RegisterFormTextsTypes, a as ThirdPartyAuthTextsTypes, N as NewPasswordTextsTypes, b as ResetPasswordTextsTypes } from '../../textTypes-559CaoOV.js';
+
+type LoginFormTypes = {
+    /** Object containing text labels used throughout the form. */
+    texts?: LoginFormTextsTypes;
+    /** If true, only logos are displayed in third-party auth buttons.   */
+    logosOnly?: boolean;
+    /** Direction of text and UI elements, either left-to-right or right-to-left.   */
+    direction?: DirectionType;
+    /** If true, an error alert is displayed at the top of the form.   */
+    showError?: boolean;
+    /** Title text of error alert.   */
+    errorTitle?: string;
+    /** Description text of error alert.   */
+    errorText?: string;
+    /** Login identifier type user will use to log in.   */
+    loginType?: "email" | "username" | "phone" | "link";
+    /** If true, the reset password option is hidden.   */
+    withoutResetPassword?: boolean;
+    /** If true, the register option is hidden.   */
+    allowRegister?: boolean;
+    /** If true, a loading spinner is displayed within the main form submit button.   */
+    isLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Google login button.   */
+    isGoogleLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Twitter login button.   */
+    isTwitterLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Github login button.   */
+    isGithubLoading?: boolean;
+    /** If true, Google login option is displayed.   */
+    viaGoogle?: boolean;
+    /** If true, Github login option is displayed.   */
+    viaGithub?: boolean;
+    /** If true, Twitter login option is displayed.   */
+    viaTwitter?: boolean;
+    /** Function to handle form submission.   */
+    onLogin?: (e: any) => void;
+    /** Function to route user to the register page.   */
+    onRouteToRegister?: () => void;
+    /** Function to handle forgotten password case.   */
+    onForgotPassword?: () => void;
+    /** Function to handle Google login.   */
+    onGoogleLogin?: () => void;
+    /** Function to handle Github login.   */
+    onGithubLogin?: () => void;
+    /** Function to handle Twitter login.   */
+    onTwitterLogin?: () => void;
+    /** Additional buttons to add under the login button */
+    additionalButtons?: any;
+    /** The allowed length of the password input field */
+    passwordLength?: number;
+};
+declare const LoginForm: FC<LoginFormTypes>;
+
+type SelectOptionProps = {
+    value: any;
+    label: any;
+};
+
+type RegisterFormTypes = {
+    /** Object containing text labels used throughout the form. */
+    texts?: RegisterFormTextsTypes;
+    /** Direction of text and layout, either 'rtl' (right-to-left) or 'ltr' (left-to-right). */
+    direction?: DirectionType;
+    /** Determines whether to display logos only or with text in the social media registration section. */
+    logosOnly?: boolean;
+    /** Enables registration via Google when set to true. */
+    viaGoogle?: boolean;
+    /** Enables registration via Github when set to true. */
+    viaGithub?: boolean;
+    /** Enables registration via Twitter when set to true. */
+    viaTwitter?: boolean;
+    /** Determines whether to show the referral code field. */
+    showRefCode?: boolean;
+    /** Determines whether to show the user source selection. */
+    showUserSource?: boolean;
+    /** Determines whether to show the terms acceptance checkbox. */
+    showTermsOption?: boolean;
+    /** Determines whether to show the newsletter subscription checkbox. */
+    showNewsletterOption?: boolean;
+    /** Callback function triggered on form submission. */
+    onRegister: (e: any) => void;
+    /** Callback function triggered to route to the login page. */
+    onRouteToLogin?: () => void;
+    /** Callback function triggered to handle registration via Google. */
+    onGoogleRegister?: () => void;
+    /** Callback function triggered to handle registration via Github. */
+    onGithubRegister?: () => void;
+    /** Callback function triggered to handle registration via Twitter. */
+    onTwitterRegister?: () => void;
+    /** Callback function triggered to route to the Terms of Service page. */
+    onRouteToTOS?: () => void;
+    /** Determines whether to show an error alert. */
+    showError?: boolean;
+    /** Title for the error alert. */
+    errorTitle?: any;
+    /** Text for the error alert. */
+    errorText?: any;
+    /** Array containing the fields to be included in the form. */
+    registerFields?: string[];
+    /** Indicates whether the form submission is in progress. */
+    isLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Google login button.   */
+    isGoogleLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Twitter login button.   */
+    isTwitterLoading?: boolean;
+    /** If true, a loading spinner is displayed within the Github login button.   */
+    isGithubLoading?: boolean;
+    /** The options of "How did you learn about us?" select field.   */
+    userReferenceOptions?: SelectOptionProps[];
+    /** To add more custom buttons under the register button.   */
+    additionalButtons?: any;
+    /** To add more custom input fields   */
+    additionalInputs?: any;
+};
+declare const RegisterForm: FC<RegisterFormTypes>;
+
+type AppLandingTextsTypes = ThirdPartyAuthTextsTypes & {
+    newUserText?: string;
+    createAccount?: string;
+};
+type AppLandingTypes = {
+    texts?: AppLandingTextsTypes;
+    viaGoogle?: boolean;
+    viaTwitter?: boolean;
+    viaGithub?: boolean;
+    viaMicrosoft?: boolean;
+    viaEmail?: boolean;
+    viaPhone?: boolean;
+    viaApple?: boolean;
+    allowRegister?: boolean;
+    size?: "small" | "normal" | "full";
+    direction?: DirectionType;
+    handleRouteToRegister?: () => void;
+    handleGoogle?: () => void;
+    handleTwitter?: () => void;
+    handleApple?: () => void;
+    handleMicrosoft?: () => void;
+    handleGithub?: () => void;
+    handleEmail?: () => void;
+    handlePhone?: () => void;
+};
+declare const AppLanding: FC<AppLandingTypes>;
+
+type CheckEmailBlocks = {
+    handleResend?: () => void;
+    texts?: {
+        checkEmail: string;
+        resendEmail: string;
+        pleaseVerify: string;
+    };
+};
+declare const CheckEmail: FC<CheckEmailBlocks>;
+
+type NewPasswordTypes = {
+    handleNewPassword: (e: any) => void;
+    handleRouteToRegister: () => void;
+    direction?: DirectionType;
+    headless?: boolean;
+    allowRegister?: boolean;
+    passwordChanged: any;
+    texts: NewPasswordTextsTypes;
+};
+declare const NewPasswordForm: FC<NewPasswordTypes>;
+
+type ResetPasswordType = {
+    handleResetPassword: (e: any) => void;
+    handleRouteToRegister: () => void;
+    sent: any;
+    headless?: boolean;
+    allowRegister?: boolean;
+    direction?: DirectionType;
+    texts?: ResetPasswordTextsTypes;
+};
+declare const ResetPasswordForm: FC<ResetPasswordType>;
+
+type TConfirmation = {
+    texts?: {
+        checkYourPhone?: string;
+        weSentCode?: string;
+        didntGetCode?: string;
+        resendCode?: string;
+        resendCodeTimer?: string;
+        codeRequiredText?: string;
+        codeTooShort?: string;
+        confirm?: string;
+        cancel?: string;
+        seconds?: string;
+    };
+    showError?: any;
+    errorTitle?: any;
+    errorText?: any;
+    phoneNumber?: string;
+    confirmLoading?: boolean;
+    handleConfirm?: any;
+    handleResend?: any;
+};
+declare const CodeConfirmation: FC<TConfirmation>;
+
+export { AppLanding, CheckEmail, CodeConfirmation, LoginForm, NewPasswordForm, RegisterForm, ResetPasswordForm };