@metamask/connect-multichain 0.2.0 → 0.2.1

package/dist/src/multichain/utils/analytics.d.ts

@@ -0,0 +1,39 @@
+import type { InvokeMethodOptions, MultichainOptions, PlatformType, StoreClient } from '../../domain';
+/**
+ * Checks if an error represents a user rejection.
+ *
+ * @param error - The error object to check
+ * @returns True if the error indicates a user rejection, false otherwise
+ */
+export declare function isRejectionError(error: unknown): boolean;
+/**
+ * Gets base analytics properties that are common across all events.
+ *
+ * @param options - Multichain options containing dapp and analytics config
+ * @param storage - Storage client for getting anonymous ID
+ * @returns Base analytics properties
+ */
+export declare function getBaseAnalyticsProperties(options: MultichainOptions, storage: StoreClient): Promise<{
+    mmconnect_version: string;
+    dapp_id: string;
+    platform: PlatformType;
+    integration_type: string;
+    anon_id: string;
+}>;
+/**
+ * Gets analytics properties specific to wallet action events.
+ *
+ * @param options - Multichain options containing dapp and analytics config
+ * @param storage - Storage client for getting anonymous ID
+ * @param invokeOptions - The invoke method options containing method and scope
+ * @returns Wallet action analytics properties
+ */
+export declare function getWalletActionAnalyticsProperties(options: MultichainOptions, storage: StoreClient, invokeOptions: InvokeMethodOptions): Promise<{
+    mmconnect_version: string;
+    dapp_id: string;
+    method: string;
+    integration_type: string;
+    caip_chain_id: string;
+    anon_id: string;
+}>;
+//# sourceMappingURL=analytics.d.ts.map

package/dist/src/multichain/utils/analytics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../../../src/multichain/utils/analytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EAEZ,WAAW,EACZ,MAAM,cAAc,CAAC;AAGtB;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAiBxD;AAED;;;;;;GAMG;AACH,wBAAsB,0BAA0B,CAC9C,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,WAAW,GACnB,OAAO,CAAC;IACT,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,YAAY,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC,CAgBD;AAED;;;;;;;GAOG;AACH,wBAAsB,kCAAkC,CACtD,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,WAAW,EACpB,aAAa,EAAE,mBAAmB,GACjC,OAAO,CAAC;IACT,iBAAiB,EAAE,MAAM,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC,CAgBD"}

package/dist/src/multichain/utils/analytics.js

@@ -0,0 +1,83 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/* eslint-disable @typescript-eslint/naming-convention */
+import { getDappId } from '.';
+import { getPlatformType, getVersion, TransportType } from '../../domain';
+/**
+ * Checks if an error represents a user rejection.
+ *
+ * @param error - The error object to check
+ * @returns True if the error indicates a user rejection, false otherwise
+ */
+export function isRejectionError(error) {
+    var _a, _b;
+    if (typeof error !== 'object' || error === null) {
+        return false;
+    }
+    const errorObj = error;
+    const errorCode = errorObj.code;
+    const errorMessage = (_b = (_a = errorObj.message) === null || _a === void 0 ? void 0 : _a.toLowerCase()) !== null && _b !== void 0 ? _b : '';
+    return (errorCode === 4001 || // User rejected request (common EIP-1193 code)
+        errorCode === 4100 || // Unauthorized (common rejection code)
+        errorMessage.includes('reject') ||
+        errorMessage.includes('denied') ||
+        errorMessage.includes('cancel') ||
+        errorMessage.includes('user'));
+}
+/**
+ * Gets base analytics properties that are common across all events.
+ *
+ * @param options - Multichain options containing dapp and analytics config
+ * @param storage - Storage client for getting anonymous ID
+ * @returns Base analytics properties
+ */
+export function getBaseAnalyticsProperties(options, storage) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const version = getVersion();
+        const dappId = getDappId(options.dapp);
+        const platform = getPlatformType();
+        const anonId = yield storage.getAnonId();
+        const integrationType = (_b = (_a = options.analytics) === null || _a === void 0 ? void 0 : _a.integrationType) !== null && _b !== void 0 ? _b : TransportType.UNKNOWN;
+        return {
+            mmconnect_version: version,
+            dapp_id: dappId,
+            platform,
+            integration_type: integrationType,
+            anon_id: anonId,
+        };
+    });
+}
+/**
+ * Gets analytics properties specific to wallet action events.
+ *
+ * @param options - Multichain options containing dapp and analytics config
+ * @param storage - Storage client for getting anonymous ID
+ * @param invokeOptions - The invoke method options containing method and scope
+ * @returns Wallet action analytics properties
+ */
+export function getWalletActionAnalyticsProperties(options, storage, invokeOptions) {
+    return __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const version = getVersion();
+        const dappId = getDappId(options.dapp);
+        const anonId = yield storage.getAnonId();
+        const integrationType = (_b = (_a = options.analytics) === null || _a === void 0 ? void 0 : _a.integrationType) !== null && _b !== void 0 ? _b : 'unknown';
+        return {
+            mmconnect_version: version,
+            dapp_id: dappId,
+            method: invokeOptions.request.method,
+            integration_type: integrationType,
+            caip_chain_id: invokeOptions.scope,
+            anon_id: anonId,
+        };
+    });
+}
+//# sourceMappingURL=analytics.js.map

package/dist/src/multichain/utils/analytics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../../../src/multichain/utils/analytics.ts"],"names":[],"mappings":";;;;;;;;;AAAA,yDAAyD;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,GAAG,CAAC;AAQ9B,OAAO,EAAE,eAAe,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,cAAc,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;;IAC7C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,QAAQ,GAAG,KAA4C,CAAC;IAC9D,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC;IAChC,MAAM,YAAY,GAAG,MAAA,MAAA,QAAQ,CAAC,OAAO,0CAAE,WAAW,EAAE,mCAAI,EAAE,CAAC;IAE3D,OAAO,CACL,SAAS,KAAK,IAAI,IAAI,+CAA+C;QACrE,SAAS,KAAK,IAAI,IAAI,uCAAuC;QAC7D,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC/B,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC/B,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAC/B,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,CAC9B,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,0BAA0B,CAC9C,OAA0B,EAC1B,OAAoB;;;QAQpB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,eAAe,EAAE,CAAC;QACnC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,eAAe,GACnB,MAAA,MAAC,OAAO,CAAC,SAAwD,0CAC7D,eAAe,mCAAI,aAAa,CAAC,OAAO,CAAC;QAE/C,OAAO;YACL,iBAAiB,EAAE,OAAO;YAC1B,OAAO,EAAE,MAAM;YACf,QAAQ;YACR,gBAAgB,EAAE,eAAe;YACjC,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;CAAA;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,kCAAkC,CACtD,OAA0B,EAC1B,OAAoB,EACpB,aAAkC;;;QASlC,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;QAC7B,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACvC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC;QACzC,MAAM,eAAe,GACnB,MAAA,MAAC,OAAO,CAAC,SAAwD,0CAC7D,eAAe,mCAAI,SAAS,CAAC;QAEnC,OAAO;YACL,iBAAiB,EAAE,OAAO;YAC1B,OAAO,EAAE,MAAM;YACf,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,MAAM;YACpC,gBAAgB,EAAE,eAAe;YACjC,aAAa,EAAE,aAAa,CAAC,KAAK;YAClC,OAAO,EAAE,MAAM;SAChB,CAAC;IACJ,CAAC;CAAA"}

package/dist/types/connect-multichain.d.ts

@@ -603,6 +603,30 @@ declare abstract class Modal<Options, Data extends DataType = DataType> {
     set data(data: Data);
 }
 
+/**
+ * Checks if an error represents a user rejection.
+ *
+ * @param error - The error object to check
+ * @returns True if the error indicates a user rejection, false otherwise
+ */
+declare function isRejectionError(error: unknown): boolean;
+/**
+ * Gets analytics properties specific to wallet action events.
+ *
+ * @param options - Multichain options containing dapp and analytics config
+ * @param storage - Storage client for getting anonymous ID
+ * @param invokeOptions - The invoke method options containing method and scope
+ * @returns Wallet action analytics properties
+ */
+declare function getWalletActionAnalyticsProperties(options: MultichainOptions, storage: StoreClient, invokeOptions: InvokeMethodOptions): Promise<{
+    mmconnect_version: string;
+    dapp_id: string;
+    method: string;
+    integration_type: string;
+    caip_chain_id: string;
+    anon_id: string;
+}>;
+
 /**
  * Returns the version of the Multichain SDK.
  *
@@ -612,4 +636,4 @@ declare function getVersion(): string;
 
 declare const createMetamaskConnect: CreateMultichainFN;
 
-export { type ConnectionRequest, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, 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, type SDKState, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, createLogger, createMetamaskConnect, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isSecure };
+export { type ConnectionRequest, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, 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, type SDKState, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, createLogger, createMetamaskConnect, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/connect-multichain",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Multichain package for MetaMask Connect",
   "keywords": [
     "MetaMask",
@@ -66,7 +66,7 @@
     "test:watch": "vitest watch"
   },
   "dependencies": {
-    "@metamask/analytics": "^0.1.1",
+    "@metamask/analytics": "^0.2.0",
     "@metamask/mobile-wallet-protocol-core": "^0.3.0",
     "@metamask/mobile-wallet-protocol-dapp-client": "^0.2.1",
     "@metamask/multichain-api-client": "^0.8.1",