@web3auth/modal/dist/lib.cjs/types/ui/interfaces.d.ts

Multi chain wallet aggregator for web3Auth

import type { AUTH_CONNECTION_TYPE, BUILD_ENV_TYPE, EMAIL_FLOW_TYPE, ExtraLoginOptions, LANGUAGES, SafeEventEmitter, THEME_MODE_TYPE, WEB3AUTH_NETWORK_TYPE } from "@web3auth/auth";
import { type Analytics, type AuthLoginParams, type BaseConnectorConfig, type ChainNamespaceType, type ConnectorInitialAuthenticationModeType, type LoginMethodConfig, type LoginModalConfig, type UIConfig as CoreUIConfig, type WALLET_CONNECTOR_TYPE, type WalletRegistry, type WalletRegistryItem, type Web3AuthNoModalEvents } from "@web3auth/no-modal";
export interface UIConfig extends CoreUIConfig, LoginModalConfig {
    /**
     * ID of the element to embed the widget into
     */
    targetId?: string;
    /**
     * order of how login methods are shown
     *
     * @defaultValue `["google", "facebook", "twitter", "reddit", "discord", "twitch", "apple", "line", "github", "kakao", "linkedin", "wechat", "email_passwordless"]`
     */
    loginMethodsOrder?: string[];
    /**
     * Z-index of the modal and iframe
     * @defaultValue 99998
     */
    modalZIndex?: string;
    /**
     * Whether to show errors on Web3Auth modal.
     *
     * @defaultValue `true`
     */
    displayErrorsOnModal?: boolean;
    /**
     * number of columns to display the Social Login buttons
     *
     * @defaultValue `3`
     */
    loginGridCol?: 2 | 3;
    /**
     * Decides which button will be the focus of the modal
     * For `socialLogin` the social icon will be colored
     * For other options like `emailLogin` and `externalLogin` the respective buttons will be converted into a primary button
     *
     * @defaultValue `socialLogin`
     */
    primaryButton?: "externalLogin" | "socialLogin" | "emailLogin";
    connectorListener: SafeEventEmitter<Web3AuthNoModalEvents>;
}
export type ModalLoginParams = Pick<AuthLoginParams, "authConnection" | "authConnectionId" | "groupedAuthConnectionId" | "loginHint" | "extraLoginOptions"> & {
    name: string;
};
export interface LoginModalProps extends UIConfig {
    initialAuthenticationMode: ConnectorInitialAuthenticationModeType;
    chainNamespaces: ChainNamespaceType[];
    walletRegistry: WalletRegistry;
    web3authClientId: string;
    web3authNetwork: WEB3AUTH_NETWORK_TYPE;
    authBuildEnv: BUILD_ENV_TYPE;
    analytics: Analytics;
}
export interface LoginModalCallbacks {
    onInitExternalWallets: (params: {
        externalWalletsInitialized: boolean;
    }) => Promise<void>;
    onSocialLogin: (params: {
        connector: WALLET_CONNECTOR_TYPE;
        loginParams: ModalLoginParams;
    }) => Promise<void>;
    onExternalWalletLogin: (params: {
        connector: WALLET_CONNECTOR_TYPE | string;
        loginParams: {
            chainNamespace: ChainNamespaceType;
        };
    }) => Promise<void>;
    onModalVisibility: (visibility: boolean) => Promise<void>;
    onMobileVerifyConnect: (params: {
        connector: WALLET_CONNECTOR_TYPE;
    }) => Promise<void>;
}
export declare const LOGIN_MODAL_EVENTS: {
    readonly MODAL_VISIBILITY: "MODAL_VISIBILITY";
};
export type SocialLoginsConfig = {
    loginMethodsOrder: string[];
    loginMethods: LoginMethodConfig;
    connector: WALLET_CONNECTOR_TYPE;
    uiConfig: Omit<UIConfig, "connectorListener">;
};
export declare const MODAL_STATUS: {
    readonly INITIALIZED: "initialized";
    readonly CONNECTED: "connected";
    readonly CONNECTING: "connecting";
    readonly ERRORED: "errored";
    readonly AUTHORIZING: "authorizing";
    readonly AUTHORIZED: "authorized";
};
export type ModalStatusType = (typeof MODAL_STATUS)[keyof typeof MODAL_STATUS];
export interface ModalState {
    status: ModalStatusType;
    externalWalletsInitialized: boolean;
    hasExternalWallets: boolean;
    externalWalletsVisibility: boolean;
    modalVisibility: boolean;
    modalVisibilityDelayed: boolean;
    postLoadingMessage: string;
    walletConnectUri: string;
    metamaskConnectUri: string;
    socialLoginsConfig: SocialLoginsConfig;
    externalWalletsConfig: Record<string, BaseConnectorConfig>;
    detailedLoaderConnector: string;
    detailedLoaderConnectorName: string;
    showExternalWalletsOnly: boolean;
    currentPage?: string;
    web3authClientId: string;
    web3authNetwork: WEB3AUTH_NETWORK_TYPE;
    authBuildEnv: BUILD_ENV_TYPE;
}
export type SocialLoginEventType = {
    connector: WALLET_CONNECTOR_TYPE;
    loginParams: ModalLoginParams;
};
export type ExternalWalletEventType = {
    connector: WALLET_CONNECTOR_TYPE | string;
    chainNamespace?: ChainNamespaceType;
};
export type StateEmitterEvents = {
    STATE_UPDATED: (state: Partial<ModalState>) => void;
    MOUNTED: () => void;
};
export type ExternalButton = {
    name: string;
    displayName?: string;
    href?: string;
    icon?: string;
    isInstalled?: boolean;
    hasInjectedWallet: boolean;
    hasWalletConnect: boolean;
    hasInstallLinks: boolean;
    walletRegistryItem?: WalletRegistryItem;
    imgExtension?: string;
    chainNamespaces?: ChainNamespaceType[];
};
export type os = "iOS" | "Android";
export type platform = "mobile" | "desktop" | "tablet";
export type browser = "chrome" | "firefox" | "edge" | "safari" | "brave";
export type mobileOs = "ios" | "android";
export type rowType = {
    method: string;
    isDark: boolean;
    isPrimaryBtn: boolean;
    name: string;
    connector: SocialLoginsConfig["connector"];
    loginParams: {
        authConnection: AUTH_CONNECTION_TYPE;
        name: string;
        login_hint: string;
        authConnectionId?: string;
        groupedAuthConnectionId?: string;
        extraLoginOptions?: ExtraLoginOptions;
    };
    order: number;
};
export type PasswordlessHandlerParams = {
    authConnection: AUTH_CONNECTION_TYPE;
    web3authClientId: string;
    loginHint: string;
    network: string;
    authBuildEnv?: BUILD_ENV_TYPE;
    uiConfig?: Omit<UIConfig, "connectorListener">;
};
export interface WhiteLabelParams {
    name?: string;
    url?: string;
    language?: keyof typeof LANGUAGES;
    theme?: Record<string, string>;
    logo?: string;
    mode?: THEME_MODE_TYPE;
}
export interface CodeInitiateRequestBodyParams {
    client_id: string;
    connection: "email" | "sms";
    login_hint: string;
    web3auth_client_id: string;
    tracking_id?: string;
    whitelabel?: WhiteLabelParams;
    version?: string;
    network?: string;
    flow_type?: EMAIL_FLOW_TYPE;
    captcha_token?: string;
}
export interface CodeVerifyRequestBodyParams {
    client_id: string;
    login_hint: string;
    code: string;
    connection: "email" | "sms";
    tracking_id: string;
    version?: string;
    network?: string;
    flow_type?: EMAIL_FLOW_TYPE;
}
export type IStartResponse = {
    success?: boolean;
    error?: string;
    data?: {
        trackingId: string;
    };
};
export type IVerifyResponse = {
    success?: boolean;
    error?: string;
    data?: {
        id_token: string;
    };
};
export type LogoAlignmentType = UIConfig["logoAlignment"];
export type BorderRadiusType = UIConfig["borderRadiusType"];
export type ButtonRadiusType = UIConfig["buttonRadiusType"];
export declare enum TOAST_TYPE {
    SUCCESS = "success",
    ERROR = "error",
    WARNING = "warning",
    INFO = "info"
}
export type ToastType = (typeof TOAST_TYPE)[keyof typeof TOAST_TYPE];
export interface ValidatePhoneNumberApiResponse {
    success: boolean;
    parsed_number: string;
    country_flag: string;
}