@web3auth/modal 11.0.0-beta.0 → 11.0.0-beta.1

package/dist/lib.cjs/types/modalManager.d.ts

@@ -1,6 +1,6 @@
-import { type Connection, type IWeb3AuthCoreOptions, IWeb3AuthState, LoginModeType, type ProjectConfig, Web3AuthNoModal } from "@web3auth/no-modal";
+import { type Connection, type IConnector, type IWeb3AuthCoreOptions, IWeb3AuthState, type LinkAccountParams, type LinkAccountResult, type LinkedAccountInfo, LoginModeType, type ProjectConfig, type WALLET_CONNECTOR_TYPE, Web3AuthNoModal } from "@web3auth/no-modal";
 import { type ConnectorsModalConfig, type IWeb3AuthModal } from "./interface";
-import { LoginModal, type UIConfig } from "./ui";
+import { ACCOUNT_LINKING_INTENT, type AccountLinkingState, LoginModal, type UIConfig } from "./ui";
 export interface Web3AuthOptions extends IWeb3AuthCoreOptions {
     /**
      * Config for configuring modal ui display properties
@@ -16,12 +16,29 @@ export declare class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal
     loginMode: LoginModeType;
     readonly options: Web3AuthOptions;
     private modalConfig;
+    private removeAccountLinkingConnectorListeners;
+    private removeAccountLinkingResetOnCloseListener;
+    private accountLinkingPickerResolver;
+    private removeAccountLinkingPickerCloseListener;
     constructor(options: Web3AuthOptions, initialState?: Partial<IWeb3AuthState>);
     init(options?: {
         signal?: AbortSignal;
     }): Promise<void>;
     connect(): Promise<Connection | null>;
     acceptConsent(): Promise<void>;
+    switchAccount(account: LinkedAccountInfo): Promise<void>;
+    linkAccount(params?: LinkAccountParams): Promise<LinkAccountResult>;
+    protected startAccountLinkingModalSession(params: {
+        connectorName: WALLET_CONNECTOR_TYPE | string;
+        transportConnectorName?: WALLET_CONNECTOR_TYPE | string;
+        chainId: string;
+        intent: (typeof ACCOUNT_LINKING_INTENT)[keyof typeof ACCOUNT_LINKING_INTENT];
+    }): void;
+    protected updateAccountLinkingModalSession(accountLinking: Partial<AccountLinkingState>): void;
+    protected resetAccountLinkingModalSession(): void;
+    protected formatAccountLinkingErrorMessage(error: unknown): string | undefined;
+    protected prepareAccountLinkingConnector(connectorName: WALLET_CONNECTOR_TYPE | string, chainId: string): Promise<IConnector<unknown>>;
+    protected prepareAccountSwitchConnector(connectorName: WALLET_CONNECTOR_TYPE | string, chainId: string, projectConfig?: ProjectConfig): Promise<IConnector<unknown>>;
     protected initUIConfig(projectConfig: ProjectConfig): void;
     protected getInitializationTrackData(): Record<string, unknown>;
     private filterWalletRegistry;
@@ -39,5 +56,26 @@ export declare class Web3Auth extends Web3AuthNoModal implements IWeb3AuthModal
     private onAcceptConsent;
     private onDeclineConsent;
     private getChainNamespaces;
+    private switchToWalletConnectV2Account;
+    /**
+     * Runs a link/switch action for WalletConnect v2, racing connector.connect()
+     * against a modal-close promise to cancel and clean up the WC session if the
+     * user closes the modal during QR scanning.
+     * For synchronous connectors use {@link runNonWalletConnectAccountAction}.
+     */
+    private runWalletConnectV2AccountAction;
+    private linkAccountWithChosenConnector;
+    private pickWalletForAccountLinking;
+    /**
+     * Runs a link/switch action for synchronous connectors (injected wallets, already-connected).
+     * Shows the connecting loader, forwards AUTHORIZING events to the modal, and
+     * resolves/rejects the loader on completion.
+     * For WalletConnect v2 use {@link runWalletConnectV2AccountAction}.
+     */
+    private runNonWalletConnectAccountAction;
+    private subscribeToAccountLinkingConnectorEvents;
+    private clearAccountLinkingConnectorListeners;
+    private installAccountLinkingResetOnCloseListener;
+    private clearAccountLinkingResetOnCloseListener;
     private getCombinedConnectionId;
 }

package/dist/lib.cjs/types/react/hooks/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./useWallets";
 export * from "./useWeb3Auth";
 export * from "./useWeb3AuthConnect";
 export type { IUseAuthTokenInfo, IUseChain, IUseCheckout, IUseEnableMFA, IUseFunding, IUseManageMFA, IUseReceive, IUseSwap, IUseSwitchChain, IUseWalletConnectScanner, IUseWalletUI, IUseWeb3AuthDisconnect, IUseWeb3AuthUser, } from "@web3auth/no-modal/react";

package/dist/lib.cjs/types/react/hooks/useWallets.d.ts

@@ -0,0 +1,2 @@
+export type { IUseWallets } from "@web3auth/no-modal/react";
+export { useWallets } from "@web3auth/no-modal/react";

package/dist/lib.cjs/types/ui/containers/AccountLinking/AccountLinking.d.ts

@@ -0,0 +1,6 @@
+import { type ExternalButton } from "../../interfaces";
+interface AccountLinkingProps {
+    allExternalWallets: ExternalButton[];
+}
+declare function AccountLinking(props: AccountLinkingProps): import("react/jsx-runtime").JSX.Element;
+export default AccountLinking;

package/dist/lib.cjs/types/ui/containers/AccountLinking/index.d.ts

@@ -0,0 +1 @@
+export { default } from "./AccountLinking";

package/dist/lib.cjs/types/ui/containers/ConnectWallet/ConnectWalletHeader/ConnectWalletHeader.type.d.ts

@@ -5,4 +5,5 @@ export interface ConnectWalletHeaderProps {
     currentPage: string;
     selectedButton: ExternalButton;
     hideBackButton?: boolean;
+    isLinking?: boolean;
 }

package/dist/lib.cjs/types/ui/containers/Root/Root.d.ts

@@ -1,3 +1,3 @@
-import { RootProps } from "./Root.type";
+import type { RootProps } from "./Root.type";
 declare function Root(props: RootProps): import("react/jsx-runtime").JSX.Element;
 export default Root;

package/dist/lib.cjs/types/ui/interfaces.d.ts

@@ -45,14 +45,6 @@ export interface UIConfig extends CoreUIConfig, LoginModalConfig {
      */
     hideSuccessScreen?: boolean;
     connectorListener: SafeEventEmitter<Web3AuthNoModalEvents>;
-    /**
-     * Config for consent required.
-     *
-     * @defaultValue `undefined`
-     */
-    consentConfig?: {
-        required: boolean;
-    };
 }
 export type ModalLoginParams = Pick<AuthLoginParams, "authConnection" | "authConnectionId" | "groupedAuthConnectionId" | "loginHint" | "extraLoginOptions"> & {
     name: string;
@@ -104,6 +96,48 @@ export declare const MODAL_STATUS: {
     readonly CONSENT_REQUIRING: "consent_requiring";
 };
 export type ModalStatusType = (typeof MODAL_STATUS)[keyof typeof MODAL_STATUS];
+export declare const ACCOUNT_LINKING_STATUS: {
+    readonly IDLE: "idle";
+    readonly INITIALIZING: "initializing";
+    readonly AWAITING_CONNECTION: "awaiting_connection";
+    readonly WALLET_CONNECTED: "wallet_connected";
+    readonly LINKING: "linking";
+    readonly ERRORED: "errored";
+    readonly COMPLETED: "completed";
+};
+export type AccountLinkingStatusType = (typeof ACCOUNT_LINKING_STATUS)[keyof typeof ACCOUNT_LINKING_STATUS];
+export declare const ACCOUNT_LINKING_INTENT: {
+    readonly LINK: "link";
+    readonly SWITCH: "switch";
+};
+export type AccountLinkingIntentType = (typeof ACCOUNT_LINKING_INTENT)[keyof typeof ACCOUNT_LINKING_INTENT];
+export interface AccountLinkingState {
+    active: boolean;
+    /**
+     * True when the modal is showing the wallet picker for `linkAccount()` called
+     * without a `connectorName`. The user's selection in the ConnectWallet UI will
+     * be routed to the linking flow instead of the regular login flow.
+     */
+    pickerActive: boolean;
+    /**
+     * The name of the wallet to be linked to.
+     */
+    connectorName: WALLET_CONNECTOR_TYPE | string | null;
+    /**
+     * The underlying actual connector that is used to connect to the target account.
+     * This is different from the connectorName coz except for Metamask, others wallet can be used to connect with injectedEvmConnector/solanaStandardWalletConnector if installed.
+     * Otherwise, will fallback to the wallet-connect connector.
+     *
+     * This is useful when we want to rehydrate the linked account, using this transport connector to connect back to the target account.
+     **/
+    transportConnectorName: WALLET_CONNECTOR_TYPE | string | null;
+    chainId: string | null;
+    intent: AccountLinkingIntentType;
+    status: AccountLinkingStatusType;
+    walletConnectUri?: string;
+    errorMessage: string;
+}
+export declare const DEFAULT_ACCOUNT_LINKING_STATE: AccountLinkingState;
 export interface ModalState {
     status: ModalStatusType;
     modalVisibility: boolean;
@@ -117,6 +151,7 @@ export interface ModalState {
     showExternalWalletsOnly: boolean;
     walletConnectUri: string;
     metamaskConnectUri: string;
+    accountLinking: AccountLinkingState;
     socialLoginsConfig: SocialLoginsConfig;
     externalWalletsConfig: Record<string, BaseConnectorConfig>;
 }

package/dist/lib.cjs/types/ui/loginModal.d.ts

@@ -1,6 +1,6 @@
 import "./css/index.css";
-import { type BaseConnectorConfig, type LoginMethodConfig } from "@web3auth/no-modal";
-import { browser, LoginModalCallbacks, LoginModalProps, os, platform, UIConfig } from "./interfaces";
+import { type BaseConnectorConfig, type LoginMethodConfig, type WALLET_CONNECTOR_TYPE } from "@web3auth/no-modal";
+import { ACCOUNT_LINKING_INTENT, type AccountLinkingState, browser, LoginModalCallbacks, LoginModalProps, os, platform, UIConfig } from "./interfaces";
 export declare class LoginModal {
     private uiConfig;
     private stateEmitter;
@@ -8,6 +8,7 @@ export declare class LoginModal {
     private externalWalletsConfig;
     private analytics;
     private modalStatus;
+    private accountLinkingState;
     constructor(uiConfig: LoginModalProps, callbacks: LoginModalCallbacks);
     get consentRequired(): boolean;
     get isDark(): boolean;
@@ -23,6 +24,30 @@ export declare class LoginModal {
         externalWalletsVisibility: boolean;
         showExternalWalletsOnly: boolean;
     }) => void;
+    startAccountLinkingSession: (params: {
+        connectorName: WALLET_CONNECTOR_TYPE | string;
+        transportConnectorName?: WALLET_CONNECTOR_TYPE | string;
+        chainId: string;
+        intent?: (typeof ACCOUNT_LINKING_INTENT)[keyof typeof ACCOUNT_LINKING_INTENT];
+    }) => void;
+    updateAccountLinkingState: (accountLinking: Partial<AccountLinkingState>) => void;
+    resetAccountLinkingSession: () => void;
+    hasActiveAccountLinkingSession: () => boolean;
+    startAccountLinkingPicker: (params: {
+        chainId: string;
+    }) => void;
+    endAccountLinkingPicker: () => void;
+    startConnectingLoader: (params: {
+        connector: WALLET_CONNECTOR_TYPE | string;
+        connectorName: string;
+    }) => void;
+    markLoaderAuthorizing: () => void;
+    endConnectingLoader: (params: {
+        success: boolean;
+        errorMessage?: string;
+        successMessage?: string;
+        skipSuccessScreen?: boolean;
+    }) => void;
     open: () => void;
     closeModal: () => void;
     initExternalWalletContainer: () => void;

package/dist/lib.cjs/types/ui/utils.d.ts

@@ -5,7 +5,7 @@ import { browser, mobileOs, platform, ValidatePhoneNumberApiResponse } from "./i
 export declare function cn(...inputs: ClassValue[]): string;
 export declare const getBrowserExtensionUrl: (browserType: browser, walletId: string) => string;
 export declare const getMobileInstallLink: (os: mobileOs, appId: string) => string;
-export declare const getOsName: (os: mobileOs) => "iOS" | "Android" | "";
+export declare const getOsName: (os: mobileOs) => "" | "iOS" | "Android";
 export declare const getBrowserName: (browserType: browser) => string;
 export declare const getIcons: (icon: string) => string;
 export declare function validateImageUrl(url: string): Promise<boolean>;

package/dist/lib.cjs/types/vue/composables/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./useWallets";
 export * from "./useWeb3Auth";
 export * from "./useWeb3AuthConnect";
 export type { IUseAuthTokenInfo, IUseChain, IUseCheckout, IUseEnableMFA, IUseFunding, IUseManageMFA, IUseReceive, IUseSwap, IUseSwitchChain, IUseWalletConnectScanner, IUseWalletUI, IUseWeb3AuthDisconnect, IUseWeb3AuthUser, } from "@web3auth/no-modal/vue";

package/dist/lib.cjs/types/vue/composables/useWallets.d.ts

@@ -0,0 +1,2 @@
+export type { IUseWallets } from "@web3auth/no-modal/vue";
+export { useWallets } from "@web3auth/no-modal/vue";

package/dist/lib.esm/packages/modal/src/account-linking/index.js

@@ -0,0 +1 @@
+export * from '@web3auth/no-modal/account-linking';

package/dist/lib.esm/packages/modal/src/account-linking/react.js

@@ -0,0 +1 @@
+export { makeAccountLinkingRequest, makeAccountUnlinkingRequest, useLinkAccount, useSwitchAccount } from '@web3auth/no-modal/account-linking/react';

package/dist/lib.esm/packages/modal/src/account-linking/vue.js

@@ -0,0 +1 @@
+export { makeAccountLinkingRequest, makeAccountUnlinkingRequest, useLinkAccount, useSwitchAccount } from '@web3auth/no-modal/account-linking/vue';

package/dist/lib.esm/packages/modal/src/config.js

@@ -1,6 +1,6 @@
 import { EVM_CONNECTORS } from '@web3auth/no-modal';
 
-const version = "11.0.0-beta.0";
+const version = "11.0.0-beta.1";
 const defaultConnectorsModalConfig = {
   hideWalletDiscovery: false,
   connectors: {