@web3auth/modal 3.3.0 → 4.0.0

package/dist/types/interface.d.ts

@@ -1,4 +1,4 @@
-import type { BaseAdapterConfig, ChainNamespaceType, LoginMethodConfig, WALLET_ADAPTER_TYPE } from "@web3auth/base";
+import type { BaseAdapterConfig, ChainNamespaceType, IWeb3Auth, LoginMethodConfig, SafeEventEmitterProvider, WALLET_ADAPTER_TYPE } from "@web3auth/base";
 export interface ModalConfig extends BaseAdapterConfig {
     loginMethods?: LoginMethodConfig;
 }
@@ -6,3 +6,9 @@ export interface AdaptersModalConfig {
     chainNamespace: ChainNamespaceType;
     adapters?: Record<WALLET_ADAPTER_TYPE, ModalConfig>;
 }
+export interface IWeb3AuthModal extends IWeb3Auth {
+    initModal(params?: {
+        modalConfig?: Record<WALLET_ADAPTER_TYPE, ModalConfig>;
+    }): Promise<void>;
+    connect(): Promise<SafeEventEmitterProvider | null>;
+}

package/dist/types/modalManager.d.ts

@@ -1,36 +1,7 @@
 import { SafeEventEmitterProvider, WALLET_ADAPTER_TYPE } from "@web3auth/base";
 import { Web3AuthCore, Web3AuthCoreOptions } from "@web3auth/core";
-import { LoginModal } from "@web3auth/ui";
-import { ModalConfig } from "./interface";
-export interface UIConfig {
-    /**
-     * Logo for your app.
-     */
-    appLogo?: string;
-    /**
-     * theme for the modal
-     *
-     * @defaultValue `light`
-     */
-    theme?: "light" | "dark";
-    /**
-     * order of how login methods are shown
-     *
-     * @defaultValue `["google", "facebook", "twitter", "reddit", "discord", "twitch", "apple", "line", "github", "kakao", "linkedin", "weibo", "wechat", "email_passwordless"]`
-     */
-    loginMethodsOrder?: string[];
-    /**
-     * language which will be used by web3auth. app will use browser language if not specified. if language is not supported it will use "en"
-     * en: english
-     * de: german
-     * ja: japanese
-     * ko: korean
-     * zh: mandarin
-     * es: spanish
-     *
-     */
-    defaultLanguage?: string;
-}
+import { LoginModal, UIConfig } from "@web3auth/ui";
+import { IWeb3AuthModal, ModalConfig } from "./interface";
 export interface Web3AuthOptions extends Web3AuthCoreOptions {
     /**
      * web3auth instance provides different adapters for different type of usages. If you are dapp and want to
@@ -44,15 +15,9 @@ export interface Web3AuthOptions extends Web3AuthCoreOptions {
     /**
      * Config for configuring modal ui display properties
      */
-    uiConfig?: UIConfig;
-    /**
-     * Whether to show errors on Web3Auth modal.
-     *
-     * @defaultValue `true`
-     */
-    displayErrorsOnModal?: boolean;
+    uiConfig?: Omit<UIConfig, "adapterListener">;
 }
-export declare class Web3Auth extends Web3AuthCore {
+export declare class Web3Auth extends Web3AuthCore implements IWeb3AuthModal {
     loginModal: LoginModal;
     readonly options: Web3AuthOptions;
     private modalConfig;

package/dist/types/utils.d.ts

@@ -5,5 +5,6 @@ export declare const languageMap: {
     ko: string;
     zh: string;
     es: string;
+    fr: string;
 };
 export declare const getUserLanguage: (defaultLanguage: string | undefined) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@web3auth/modal",
-  "version": "3.3.0",
+  "version": "4.0.0",
   "homepage": "https://github.com/Web3Auth/Web3Auth#readme",
   "license": "ISC",
   "main": "dist/modal.cjs.js",
@@ -19,22 +19,24 @@
     "pre-commit": "lint-staged --cwd ."
   },
   "dependencies": {
-    "@web3auth/base": "^3.3.0",
-    "@web3auth/core": "^3.3.0",
-    "@web3auth/metamask-adapter": "^3.3.0",
-    "@web3auth/openlogin-adapter": "^3.3.0",
-    "@web3auth/phantom-adapter": "^3.3.0",
-    "@web3auth/torus-evm-adapter": "^3.3.0",
-    "@web3auth/torus-solana-adapter": "^3.3.0",
-    "@web3auth/ui": "^3.3.0",
-    "@web3auth/wallet-connect-v1-adapter": "^3.3.0"
+    "@web3auth/base": "^4.0.0",
+    "@web3auth/core": "^4.0.0",
+    "@web3auth/metamask-adapter": "^4.0.0",
+    "@web3auth/openlogin-adapter": "^4.0.0",
+    "@web3auth/phantom-adapter": "^4.0.0",
+    "@web3auth/torus-evm-adapter": "^4.0.0",
+    "@web3auth/torus-solana-adapter": "^4.0.0",
+    "@web3auth/ui": "^4.0.0",
+    "@web3auth/wallet-connect-v1-adapter": "^4.0.0"
   },
   "devDependencies": {
     "@svgr/webpack": "^6.5.1",
+    "@toruslabs/isomorphic-style-loader": "^5.3.3",
     "@toruslabs/openlogin": "^2.10.0",
     "css-loader": "^6.7.2",
-    "isomorphic-style-loader": "^5.3.2",
+    "postcss-prefix-selector": "^1.16.0",
     "style-loader": "^3.3.1",
+    "tailwindcss": "^3.2.4",
     "url-loader": "^4.1.1"
   },
   "peerDependencies": {
@@ -61,5 +63,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6e76c018f9e240a6ed4dcbfc5b87bed52a58b338"
+  "gitHead": "44f016a57d3984c417df2c4e5ccefb0ad9220835"
 }

package/src/default.ts

@@ -1,6 +1,7 @@
 import type { OpenLoginOptions } from "@toruslabs/openlogin";
 import { CHAIN_NAMESPACES, CustomChainConfig, getChainConfig, IAdapter, WALLET_ADAPTER_TYPE, WALLET_ADAPTERS } from "@web3auth/base";
 
+// warning: this function is not compatible with "OTHER" chainnamespace.
 export const getDefaultAdapterModule = async (params: {
   name: WALLET_ADAPTER_TYPE;
   clientId: string;
@@ -35,10 +36,11 @@ export const getDefaultAdapterModule = async (params: {
     return adapter;
   } else if (name === WALLET_ADAPTERS.OPENLOGIN) {
     const { OpenloginAdapter, getOpenloginDefaultOptions } = await import("@web3auth/openlogin-adapter");
-    const defaultOptions = getOpenloginDefaultOptions(customChainConfig.chainNamespace, customChainConfig?.chainId);
+    const defaultOptions = getOpenloginDefaultOptions();
     const adapter = new OpenloginAdapter({
       ...defaultOptions,
-      chainConfig: { ...(defaultOptions.chainConfig || {}), ...finalChainConfig },
+      clientId,
+      chainConfig: { ...finalChainConfig },
       adapterSettings: { ...(defaultOptions.adapterSettings as OpenLoginOptions), clientId },
     });
     return adapter;

package/src/interface.ts

@@ -1,4 +1,11 @@
-import type { BaseAdapterConfig, ChainNamespaceType, LoginMethodConfig, WALLET_ADAPTER_TYPE } from "@web3auth/base";
+import type {
+  BaseAdapterConfig,
+  ChainNamespaceType,
+  IWeb3Auth,
+  LoginMethodConfig,
+  SafeEventEmitterProvider,
+  WALLET_ADAPTER_TYPE,
+} from "@web3auth/base";
 export interface ModalConfig extends BaseAdapterConfig {
   loginMethods?: LoginMethodConfig;
 }
@@ -7,3 +14,8 @@ export interface AdaptersModalConfig {
   chainNamespace: ChainNamespaceType;
   adapters?: Record<WALLET_ADAPTER_TYPE, ModalConfig>;
 }
+
+export interface IWeb3AuthModal extends IWeb3Auth {
+  initModal(params?: { modalConfig?: Record<WALLET_ADAPTER_TYPE, ModalConfig> }): Promise<void>;
+  connect(): Promise<SafeEventEmitterProvider | null>;
+}

package/src/modalManager.ts

@@ -12,7 +12,7 @@ import {
   WALLET_ADAPTERS,
 } from "@web3auth/base";
 import { Web3AuthCore, Web3AuthCoreOptions } from "@web3auth/core";
-import { getAdapterSocialLogins, LOGIN_MODAL_EVENTS, LoginModal, OPENLOGIN_PROVIDERS } from "@web3auth/ui";
+import { getAdapterSocialLogins, LOGIN_MODAL_EVENTS, LoginModal, OPENLOGIN_PROVIDERS, UIConfig } from "@web3auth/ui";
 
 import {
   defaultEvmDappModalConfig,
@@ -22,41 +22,9 @@ import {
   defaultSolanaWalletModalConfig,
 } from "./config";
 import { getDefaultAdapterModule } from "./default";
-import { AdaptersModalConfig, ModalConfig } from "./interface";
+import { AdaptersModalConfig, IWeb3AuthModal, ModalConfig } from "./interface";
 import { getUserLanguage } from "./utils";
 
-export interface UIConfig {
-  /**
-   * Logo for your app.
-   */
-  appLogo?: string;
-
-  /**
-   * theme for the modal
-   *
-   * @defaultValue `light`
-   */
-  theme?: "light" | "dark";
-
-  /**
-   * order of how login methods are shown
-   *
-   * @defaultValue `["google", "facebook", "twitter", "reddit", "discord", "twitch", "apple", "line", "github", "kakao", "linkedin", "weibo", "wechat", "email_passwordless"]`
-   */
-  loginMethodsOrder?: string[];
-
-  /**
-   * language which will be used by web3auth. app will use browser language if not specified. if language is not supported it will use "en"
-   * en: english
-   * de: german
-   * ja: japanese
-   * ko: korean
-   * zh: mandarin
-   * es: spanish
-   *
-   */
-  defaultLanguage?: string;
-}
 export interface Web3AuthOptions extends Web3AuthCoreOptions {
   /**
    * web3auth instance provides different adapters for different type of usages. If you are dapp and want to
@@ -70,16 +38,9 @@ export interface Web3AuthOptions extends Web3AuthCoreOptions {
   /**
    * Config for configuring modal ui display properties
    */
-  uiConfig?: UIConfig;
-
-  /**
-   * Whether to show errors on Web3Auth modal.
-   *
-   * @defaultValue `true`
-   */
-  displayErrorsOnModal?: boolean;
+  uiConfig?: Omit<UIConfig, "adapterListener">;
 }
-export class Web3Auth extends Web3AuthCore {
+export class Web3Auth extends Web3AuthCore implements IWeb3AuthModal {
   public loginModal: LoginModal;
 
   readonly options: Web3AuthOptions;
@@ -117,11 +78,12 @@ export class Web3Auth extends Web3AuthCore {
 
     this.loginModal = new LoginModal({
       theme: this.options.uiConfig?.theme,
+      appName: this.options.uiConfig?.appName || "blockchain",
       appLogo: this.options.uiConfig?.appLogo || "",
-      version: "",
       adapterListener: this,
-      displayErrorsOnModal: this.options.displayErrorsOnModal,
+      displayErrorsOnModal: this.options.uiConfig?.displayErrorsOnModal,
       defaultLanguage,
+      modalZIndex: this.options.uiConfig?.modalZIndex || "99998",
     });
     this.subscribeToLoginModalEvents();
   }
@@ -170,7 +132,11 @@ export class Web3Auth extends Web3AuthCore {
         if (!this.modalConfig.adapters?.[adapterName].showOnModal) return;
         // add client id to adapter, same web3auth client id can be used in adapter.
         // this id is being overridden if user is also passing client id in adapter's constructor.
-        this.walletAdapters[adapterName].setAdapterSettings({ clientId: this.options.clientId, sessionTime: this.options.sessionTime });
+        this.walletAdapters[adapterName].setAdapterSettings({
+          clientId: this.options.clientId,
+          sessionTime: this.options.sessionTime,
+          web3AuthNetwork: this.options.web3AuthNetwork,
+        });
 
         // if adapter doesn't have any chainConfig then we will set the chainConfig based of passed chainNamespace
         // and chainNamespace.
@@ -179,7 +145,7 @@ export class Web3Auth extends Web3AuthCore {
             ...getChainConfig(providedChainConfig.chainNamespace, this.coreOptions.chainConfig?.chainId),
             ...this.coreOptions.chainConfig,
           } as CustomChainConfig;
-          this.walletAdapters[adapterName].setChainConfig(chainConfig);
+          this.walletAdapters[adapterName].setAdapterSettings({ chainConfig });
         }
 
         return adapterName;

package/src/utils.ts

@@ -9,6 +9,7 @@ export const languageMap = {
   ko: "korean",
   zh: "mandarin",
   es: "spanish",
+  fr: "french",
 };
 
 export const getUserLanguage = (defaultLanguage: string | undefined) => {