@metamask/connect-multichain 0.14.0 → 0.15.0

package/dist/browser/umd/connect-multichain.d.ts

@@ -406,6 +406,19 @@ type ConnectionRequest = {
 type ConnectVersions = {
     'connect-multichain': string;
 } & Partial<Record<'connect-evm' | 'connect-solana', string>>;
+type AnalyticsOptions = {
+    /**
+     * Whether to enable analytics tracking. Defaults to `true` when omitted.
+     * Set to `false` to disable all analytics event collection.
+     */
+    enabled?: boolean;
+    /**
+     * Identifies the integration surface that instantiated the SDK (e.g. `'direct'`,
+     * `'wagmi'`). Recorded as the `integration_types` global analytics property.
+     * Defaults to `'direct'` when omitted or empty.
+     */
+    integrationType?: string;
+};
 /**
  * Constructor options for creating a Multichain SDK instance.
  *
@@ -422,9 +435,7 @@ type MultichainOptions = {
         supportedNetworks: RpcUrlsMap;
     };
     /** Analytics configuration */
-    analytics?: {
-        integrationType: string;
-    };
+    analytics?: AnalyticsOptions;
     /** Storage client for persisting SDK data */
     storage: StoreClient;
     /** UI configuration options */
@@ -464,6 +475,7 @@ type MultiChainFNOptions = Omit<MultichainOptions, 'storage' | 'ui'> & {
  * with an existing singleton.
  */
 type MergeableMultichainOptions = Omit<MultichainOptions, 'dapp' | 'analytics' | 'storage' | 'api' | 'ui' | 'transport' | 'versions'> & {
+    analytics?: AnalyticsOptions;
     api?: MultichainOptions['api'];
     ui?: Pick<MultichainOptions['ui'], 'headless' | 'preferExtension' | 'showInstallModal'>;
     transport?: Pick<NonNullable<MultichainOptions['transport']>, 'extensionId'>;
@@ -553,7 +565,7 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
     constructor(options: MultichainOptions);
     /**
      * Merges the given options into the current instance options.
-     * Only the mergeable keys are updated (api.supportedNetworks, versions, ui.*, mobile.*, transport.extensionId, debug).
+     * Only the mergeable keys are updated (api.supportedNetworks, analytics, versions, ui.*, mobile.*, transport.extensionId, debug).
      * The main thing to note is that the value for `dapp` is not merged as it does not make sense for
      * subsequent calls to `createMultichainClient` to have a different `dapp` value.
      * Used when createMultichainClient is called with an existing singleton.
@@ -757,4 +769,4 @@ declare function getVersion(): string;
 
 declare const createMultichainClient: CreateMultichainFN;
 
-export { type ConnectVersions, type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type FailureReason, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, type MergeableMultichainOptions, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, classifyFailureReason, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };
+export { type AnalyticsOptions, type ConnectVersions, type ConnectionRequest, type ConnectionStatus, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type FailureReason, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, type MergeableMultichainOptions, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, classifyFailureReason, createLogger, createMultichainClient, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };

package/dist/browser/umd/connect-multichain.js

@@ -493,7 +493,7 @@ var init_multichain = __esm({
       }
       /**
        * Merges the given options into the current instance options.
-       * Only the mergeable keys are updated (api.supportedNetworks, versions, ui.*, mobile.*, transport.extensionId, debug).
+       * Only the mergeable keys are updated (api.supportedNetworks, analytics, versions, ui.*, mobile.*, transport.extensionId, debug).
        * The main thing to note is that the value for `dapp` is not merged as it does not make sense for
        * subsequent calls to `createMultichainClient` to have a different `dapp` value.
        * Used when createMultichainClient is called with an existing singleton.
@@ -501,23 +501,28 @@ var init_multichain = __esm({
        * @param partial - Options to merge/overwrite onto the current instance
        */
       mergeOptions(partial) {
-        var _a3, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o;
+        var _a3, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q;
         const opts = this.options;
+        const analytics3 = __spreadValues(__spreadValues({}, opts.analytics), (_a3 = partial.analytics) != null ? _a3 : {});
+        if (((_b = opts.analytics) == null ? void 0 : _b.enabled) === false) {
+          analytics3.enabled = false;
+        }
         this.options = __spreadProps(__spreadValues({}, opts), {
           api: __spreadProps(__spreadValues({}, opts.api), {
-            supportedNetworks: __spreadValues(__spreadValues({}, opts.api.supportedNetworks), (_b = (_a3 = partial.api) == null ? void 0 : _a3.supportedNetworks) != null ? _b : {})
+            supportedNetworks: __spreadValues(__spreadValues({}, opts.api.supportedNetworks), (_d = (_c = partial.api) == null ? void 0 : _c.supportedNetworks) != null ? _d : {})
           }),
-          versions: __spreadValues(__spreadValues({}, opts.versions), (_c = partial.versions) != null ? _c : {}),
+          versions: __spreadValues(__spreadValues({}, opts.versions), (_e = partial.versions) != null ? _e : {}),
+          analytics: __spreadValues({}, analytics3),
           ui: __spreadProps(__spreadValues({}, opts.ui), {
-            headless: (_e = (_d = partial.ui) == null ? void 0 : _d.headless) != null ? _e : opts.ui.headless,
-            preferExtension: (_g = (_f = partial.ui) == null ? void 0 : _f.preferExtension) != null ? _g : opts.ui.preferExtension,
-            showInstallModal: (_i = (_h = partial.ui) == null ? void 0 : _h.showInstallModal) != null ? _i : opts.ui.showInstallModal
+            headless: (_g = (_f = partial.ui) == null ? void 0 : _f.headless) != null ? _g : opts.ui.headless,
+            preferExtension: (_i = (_h = partial.ui) == null ? void 0 : _h.preferExtension) != null ? _i : opts.ui.preferExtension,
+            showInstallModal: (_k = (_j = partial.ui) == null ? void 0 : _j.showInstallModal) != null ? _k : opts.ui.showInstallModal
           }),
-          mobile: __spreadValues(__spreadValues({}, opts.mobile), (_j = partial.mobile) != null ? _j : {}),
-          transport: __spreadProps(__spreadValues({}, (_k = opts.transport) != null ? _k : {}), {
-            extensionId: (_n = (_l = partial.transport) == null ? void 0 : _l.extensionId) != null ? _n : (_m = opts.transport) == null ? void 0 : _m.extensionId
+          mobile: __spreadValues(__spreadValues({}, opts.mobile), (_l = partial.mobile) != null ? _l : {}),
+          transport: __spreadProps(__spreadValues({}, (_m = opts.transport) != null ? _m : {}), {
+            extensionId: (_p = (_n = partial.transport) == null ? void 0 : _n.extensionId) != null ? _p : (_o = opts.transport) == null ? void 0 : _o.extensionId
           }),
-          debug: (_o = partial.debug) != null ? _o : opts.debug
+          debug: (_q = partial.debug) != null ? _q : opts.debug
         });
       }
     };
@@ -2345,6 +2350,17 @@ var import_analytics2 = require("@metamask/analytics");
 init_domain();
 init_utils2();
 init_analytics();
+function toRPCInvokeMethodErr(error) {
+  var _a3;
+  if (error instanceof RPCInvokeMethodErr) {
+    return error;
+  }
+  const castError = error;
+  return new RPCInvokeMethodErr(
+    (_a3 = castError.message) != null ? _a3 : "Unknown error",
+    castError.code
+  );
+}
 var _RequestRouter_instances, withAnalyticsTracking_fn, trackWalletActionRequested_fn, trackWalletActionSucceeded_fn, trackWalletActionFailed_fn, trackWalletActionRejected_fn;
 var RequestRouter = class {
   constructor(transport, rpcClient, config, transportType) {
@@ -2451,6 +2467,13 @@ _RequestRouter_instances = new WeakSet();
 withAnalyticsTracking_fn = function(options, execute) {
   return __async(this, null, function* () {
     var _a3;
+    if (((_a3 = this.config.analytics) == null ? void 0 : _a3.enabled) === false) {
+      try {
+        return yield execute();
+      } catch (error) {
+        throw toRPCInvokeMethodErr(error);
+      }
+    }
     yield __privateMethod(this, _RequestRouter_instances, trackWalletActionRequested_fn).call(this, options);
     try {
       const result = yield execute();
@@ -2463,14 +2486,7 @@ withAnalyticsTracking_fn = function(options, execute) {
       } else {
         yield __privateMethod(this, _RequestRouter_instances, trackWalletActionFailed_fn).call(this, options, error);
       }
-      if (error instanceof RPCInvokeMethodErr) {
-        throw error;
-      }
-      const castError = error;
-      throw new RPCInvokeMethodErr(
-        (_a3 = castError.message) != null ? _a3 : "Unknown error",
-        castError.code
-      );
+      throw toRPCInvokeMethodErr(error);
     }
   });
 };
@@ -2929,26 +2945,65 @@ walletInvokeMethod_fn = function(request) {
 init_utils2();
 var logger2 = createLogger("metamask-sdk:core");
 var SINGLETON_KEY = "__METAMASK_CONNECT_MULTICHAIN_SINGLETON__";
+function normalizeAnalyticsOptions(analyticsOptions) {
+  var _a3;
+  return __spreadProps(__spreadValues({}, analyticsOptions != null ? analyticsOptions : {}), {
+    enabled: (_a3 = analyticsOptions == null ? void 0 : analyticsOptions.enabled) != null ? _a3 : true,
+    // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing
+    integrationType: (analyticsOptions == null ? void 0 : analyticsOptions.integrationType) || "direct"
+  });
+}
+function isAnalyticsEnabled(options) {
+  var _a3;
+  return ((_a3 = options.analytics) == null ? void 0 : _a3.enabled) !== false;
+}
+function setupAnalyticsGlobals(options, storage, setAnonId) {
+  return __async(this, null, function* () {
+    var _a3, _b;
+    if (!isAnalyticsEnabled(options)) {
+      setAnonId == null ? void 0 : setAnonId(void 0);
+      import_analytics4.analytics.disable();
+      return;
+    }
+    const platform = getPlatformType();
+    const isBrowser = platform === "in-app-browser" /* MetaMaskMobileWebview */ || platform === "web-desktop" /* DesktopWeb */ || platform === "web-mobile" /* MobileWeb */;
+    const isReactNative2 = platform === "react-native" /* ReactNative */;
+    if (!isBrowser && !isReactNative2) {
+      return;
+    }
+    const dappId = getDappId(options.dapp);
+    const anonId = yield storage.getAnonId();
+    setAnonId == null ? void 0 : setAnonId(anonId);
+    const { integrationType } = (_a3 = options.analytics) != null ? _a3 : {
+      integrationType: ""
+    };
+    import_analytics4.analytics.setGlobalProperty("mmconnect_versions", (_b = options.versions) != null ? _b : {});
+    import_analytics4.analytics.setGlobalProperty("dapp_id", dappId);
+    import_analytics4.analytics.setGlobalProperty("anon_id", anonId);
+    import_analytics4.analytics.setGlobalProperty("platform", platform);
+    if (integrationType) {
+      import_analytics4.analytics.setGlobalProperty("integration_types", [integrationType]);
+    }
+    import_analytics4.analytics.enable();
+  });
+}
 var _a2, _provider, _providerTransportWrapper, _transport2, _dappClient, _beforeUnloadListener, _transportType, _listener, _anonId, _sdkInfo, _MetaMaskConnectMultichain_instances, setupAnalytics_fn, onTransportNotification_fn, getStoredTransport_fn, setupTransport_fn, buildConnectionMetadata_fn, init_fn2, createDappClient_fn, setupMWP_fn, onBeforeUnload_fn, createBeforeUnloadListener_fn, renderInstallModalAsync_fn, showInstallModal_fn, headlessConnect_fn, setupDefaultTransport_fn, deeplinkConnect_fn, handleConnection_fn, getCaipSession_fn, openConnectDeeplinkIfNeeded_fn;
 var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends MultichainCore {
   constructor(options) {
-    var _a3, _b, _c, _d, _e, _f;
+    var _a3, _b, _c, _d;
     const withDappMetadata = setupDappMetadata(options);
-    const integrationType = ((_a3 = options.analytics) == null ? void 0 : _a3.integrationType) || "direct";
     const allOptions = __spreadProps(__spreadValues({}, withDappMetadata), {
       ui: __spreadProps(__spreadValues({}, withDappMetadata.ui), {
-        preferExtension: (_b = withDappMetadata.ui.preferExtension) != null ? _b : true,
-        showInstallModal: (_c = withDappMetadata.ui.showInstallModal) != null ? _c : false,
-        headless: (_d = withDappMetadata.ui.headless) != null ? _d : false
-      }),
-      analytics: __spreadProps(__spreadValues({}, (_e = options.analytics) != null ? _e : {}), {
-        integrationType
+        preferExtension: (_a3 = withDappMetadata.ui.preferExtension) != null ? _a3 : true,
+        showInstallModal: (_b = withDappMetadata.ui.showInstallModal) != null ? _b : false,
+        headless: (_c = withDappMetadata.ui.headless) != null ? _c : false
       }),
+      analytics: normalizeAnalyticsOptions(options.analytics),
       versions: __spreadValues({
         // typeof guard needed: Metro (React Native) bundles TS source directly,
         // bypassing the tsup build that substitutes __PACKAGE_VERSION__.
-        "connect-multichain": false ? "unknown" : "0.14.0"
-      }, (_f = options.versions) != null ? _f : {})
+        "connect-multichain": false ? "unknown" : "0.15.0"
+      }, (_d = options.versions) != null ? _d : {})
     });
     super(allOptions);
     __privateAdd(this, _MetaMaskConnectMultichain_instances);
@@ -3004,25 +3059,22 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
   // Creates a singleton instance of MetaMaskConnectMultichain.
   // If the singleton already exists, it merges the incoming options with the
   // existing singleton options for the following keys: `api.supportedNetworks`,
-  // `versions`, `ui.*`, `mobile.*`, `transport.extensionId`, `debug`. Take note
-  // that the value for `dapp` is not merged as it does not make sense for
-  // subsequent calls to `createMultichainClient` to have a different `dapp` value.
+  // `analytics`, `versions`, `ui.*`, `mobile.*`, `transport.extensionId`,
+  // `debug`. Take note that the value for `dapp` is not merged as it does not
+  // make sense for subsequent calls to `createMultichainClient` to have a
+  // different `dapp` value.
   static create(options) {
     return __async(this, null, function* () {
-      var _a3, _b;
+      var _a3;
       const globalObject = getGlobalObject();
       const existing = globalObject[SINGLETON_KEY];
       if (existing) {
         const instance = yield existing;
         instance.mergeOptions(options);
-        import_analytics4.analytics.setGlobalProperty(
-          "mmconnect_versions",
-          (_a3 = instance.options.versions) != null ? _a3 : {}
-        );
-        if ((_b = options.analytics) == null ? void 0 : _b.integrationType) {
-          import_analytics4.analytics.setGlobalProperty("integration_types", [
-            options.analytics.integrationType
-          ]);
+        if (instance instanceof _MetaMaskConnectMultichain) {
+          yield __privateMethod(_a3 = instance, _MetaMaskConnectMultichain_instances, setupAnalytics_fn).call(_a3);
+        } else {
+          yield setupAnalyticsGlobals(instance.options, instance.storage);
         }
         if (options.debug) {
           enableDebug("metamask-sdk:*");
@@ -3072,21 +3124,23 @@ var _MetaMaskConnectMultichain = class _MetaMaskConnectMultichain extends Multic
       } else {
         transportType = "mwp" /* MWP */;
       }
-      try {
-        const baseProps = yield getBaseAnalyticsProperties(
-          this.options,
-          this.storage
-        );
-        const dappConfiguredChains = Object.keys(
-          this.options.api.supportedNetworks
-        );
-        import_analytics4.analytics.track("mmconnect_connection_initiated", __spreadProps(__spreadValues({}, baseProps), {
-          transport_type: transportType,
-          dapp_configured_chains: dappConfiguredChains,
-          dapp_requested_chains: scopes
-        }));
-      } catch (error) {
-        logger2("Error tracking connection_initiated event", error);
+      if (isAnalyticsEnabled(this.options)) {
+        try {
+          const baseProps = yield getBaseAnalyticsProperties(
+            this.options,
+            this.storage
+          );
+          const dappConfiguredChains = Object.keys(
+            this.options.api.supportedNetworks
+          );
+          import_analytics4.analytics.track("mmconnect_connection_initiated", __spreadProps(__spreadValues({}, baseProps), {
+            transport_type: transportType,
+            dapp_configured_chains: dappConfiguredChains,
+            dapp_requested_chains: scopes
+          }));
+        } catch (error) {
+          logger2("Error tracking connection_initiated event", error);
+        }
       }
       const sessionData = yield __privateMethod(this, _MetaMaskConnectMultichain_instances, getCaipSession_fn).call(this);
       const { mergedScopes, mergedCaipAccountIds, mergedSessionProperties } = mergeRequestedSessionWithExisting(
@@ -3229,30 +3283,9 @@ _sdkInfo = new WeakMap();
 _MetaMaskConnectMultichain_instances = new WeakSet();
 setupAnalytics_fn = function() {
   return __async(this, null, function* () {
-    var _a3, _b;
-    const platform = getPlatformType();
-    const isBrowser = platform === "in-app-browser" /* MetaMaskMobileWebview */ || platform === "web-desktop" /* DesktopWeb */ || platform === "web-mobile" /* MobileWeb */;
-    const isReactNative2 = platform === "react-native" /* ReactNative */;
-    if (!isBrowser && !isReactNative2) {
-      return;
-    }
-    const dappId = getDappId(this.options.dapp);
-    const anonId = yield this.storage.getAnonId();
-    __privateSet(this, _anonId, anonId);
-    const { integrationType } = (_a3 = this.options.analytics) != null ? _a3 : {
-      integrationType: ""
-    };
-    import_analytics4.analytics.setGlobalProperty(
-      "mmconnect_versions",
-      (_b = this.options.versions) != null ? _b : {}
-    );
-    import_analytics4.analytics.setGlobalProperty("dapp_id", dappId);
-    import_analytics4.analytics.setGlobalProperty("anon_id", anonId);
-    import_analytics4.analytics.setGlobalProperty("platform", platform);
-    if (integrationType) {
-      import_analytics4.analytics.setGlobalProperty("integration_types", [integrationType]);
-    }
-    import_analytics4.analytics.enable();
+    yield setupAnalyticsGlobals(this.options, this.storage, (anonId) => {
+      __privateSet(this, _anonId, anonId);
+    });
   });
 };
 onTransportNotification_fn = function(payload) {
@@ -3341,7 +3374,7 @@ buildConnectionMetadata_fn = function() {
     dapp: this.options.dapp,
     sdk: { version: getVersion(), platform: getPlatformType() }
   };
-  if (__privateGet(this, _anonId)) {
+  if (isAnalyticsEnabled(this.options) && __privateGet(this, _anonId)) {
     metadata.analytics = { remote_session_id: __privateGet(this, _anonId) };
   }
   return metadata;
@@ -3623,38 +3656,42 @@ handleConnection_fn = function(promise, scopes, transportType) {
     this.status = "connecting";
     return promise.then(() => __async(this, null, function* () {
       this.status = "connected";
-      try {
-        const baseProps = yield getBaseAnalyticsProperties(
-          this.options,
-          this.storage
-        );
-        import_analytics4.analytics.track("mmconnect_connection_established", __spreadProps(__spreadValues({}, baseProps), {
-          transport_type: transportType,
-          user_permissioned_chains: scopes
-        }));
-      } catch (error) {
-        logger2("Error tracking connection_established event", error);
+      if (isAnalyticsEnabled(this.options)) {
+        try {
+          const baseProps = yield getBaseAnalyticsProperties(
+            this.options,
+            this.storage
+          );
+          import_analytics4.analytics.track("mmconnect_connection_established", __spreadProps(__spreadValues({}, baseProps), {
+            transport_type: transportType,
+            user_permissioned_chains: scopes
+          }));
+        } catch (error) {
+          logger2("Error tracking connection_established event", error);
+        }
       }
       return void 0;
     })).catch((error) => __async(this, null, function* () {
       this.status = "disconnected";
-      try {
-        const baseProps = yield getBaseAnalyticsProperties(
-          this.options,
-          this.storage
-        );
-        const isRejection = isRejectionError(error);
-        if (isRejection) {
-          import_analytics4.analytics.track("mmconnect_connection_rejected", __spreadProps(__spreadValues({}, baseProps), {
-            transport_type: transportType
-          }));
-        } else {
-          import_analytics4.analytics.track("mmconnect_connection_failed", __spreadValues(__spreadProps(__spreadValues({}, baseProps), {
-            transport_type: transportType
-          }), extractErrorDiagnostics(error)));
+      if (isAnalyticsEnabled(this.options)) {
+        try {
+          const baseProps = yield getBaseAnalyticsProperties(
+            this.options,
+            this.storage
+          );
+          const isRejection = isRejectionError(error);
+          if (isRejection) {
+            import_analytics4.analytics.track("mmconnect_connection_rejected", __spreadProps(__spreadValues({}, baseProps), {
+              transport_type: transportType
+            }));
+          } else {
+            import_analytics4.analytics.track("mmconnect_connection_failed", __spreadValues(__spreadProps(__spreadValues({}, baseProps), {
+              transport_type: transportType
+            }), extractErrorDiagnostics(error)));
+          }
+        } catch (e) {
+          logger2("Error tracking connection failed/rejected event", error);
         }
-      } catch (e) {
-        logger2("Error tracking connection failed/rejected event", error);
       }
       throw error;
     }));