@formo/analytics 1.37.0 → 1.38.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (42) hide show
  1. package/dist/cjs/src/FormoAnalytics.d.ts +66 -0
  2. package/dist/cjs/src/FormoAnalytics.js +176 -5
  3. package/dist/cjs/src/FormoAnalyticsProvider.d.ts +8 -0
  4. package/dist/cjs/src/FormoAnalyticsProvider.js +42 -32
  5. package/dist/cjs/src/evm/EvmEventTracker.d.ts +38 -10
  6. package/dist/cjs/src/evm/EvmEventTracker.js +182 -0
  7. package/dist/cjs/src/evm/EvmProviderRegistry.js +26 -4
  8. package/dist/cjs/src/evm/EvmRequestTracker.d.ts +40 -10
  9. package/dist/cjs/src/evm/EvmRequestTracker.js +219 -59
  10. package/dist/cjs/src/provider/detection.d.ts +30 -0
  11. package/dist/cjs/src/provider/detection.js +62 -0
  12. package/dist/cjs/src/provider/index.d.ts +1 -1
  13. package/dist/cjs/src/provider/index.js +3 -1
  14. package/dist/cjs/src/types/base.d.ts +23 -0
  15. package/dist/cjs/src/types/provider.d.ts +16 -0
  16. package/dist/cjs/src/types/provider.js +17 -1
  17. package/dist/cjs/src/version.d.ts +1 -1
  18. package/dist/cjs/src/version.js +1 -1
  19. package/dist/cjs/src/wagmi/WagmiEventHandler.d.ts +81 -0
  20. package/dist/cjs/src/wagmi/WagmiEventHandler.js +478 -38
  21. package/dist/esm/src/FormoAnalytics.d.ts +66 -0
  22. package/dist/esm/src/FormoAnalytics.js +176 -5
  23. package/dist/esm/src/FormoAnalyticsProvider.d.ts +8 -0
  24. package/dist/esm/src/FormoAnalyticsProvider.js +40 -31
  25. package/dist/esm/src/evm/EvmEventTracker.d.ts +38 -10
  26. package/dist/esm/src/evm/EvmEventTracker.js +183 -1
  27. package/dist/esm/src/evm/EvmProviderRegistry.js +27 -5
  28. package/dist/esm/src/evm/EvmRequestTracker.d.ts +40 -10
  29. package/dist/esm/src/evm/EvmRequestTracker.js +218 -58
  30. package/dist/esm/src/provider/detection.d.ts +30 -0
  31. package/dist/esm/src/provider/detection.js +60 -0
  32. package/dist/esm/src/provider/index.d.ts +1 -1
  33. package/dist/esm/src/provider/index.js +1 -1
  34. package/dist/esm/src/types/base.d.ts +23 -0
  35. package/dist/esm/src/types/provider.d.ts +16 -0
  36. package/dist/esm/src/types/provider.js +16 -0
  37. package/dist/esm/src/version.d.ts +1 -1
  38. package/dist/esm/src/version.js +1 -1
  39. package/dist/esm/src/wagmi/WagmiEventHandler.d.ts +81 -0
  40. package/dist/esm/src/wagmi/WagmiEventHandler.js +478 -38
  41. package/dist/index.umd.min.js +1 -1
  42. package/package.json +2 -2
@@ -1,3 +1,14 @@
1
+ var __assign = (this && this.__assign) || function () {
2
+ __assign = Object.assign || function(t) {
3
+ for (var s, i = 1, n = arguments.length; i < n; i++) {
4
+ s = arguments[i];
5
+ for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
6
+ t[p] = s[p];
7
+ }
8
+ return t;
9
+ };
10
+ return __assign.apply(this, arguments);
11
+ };
1
12
  var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
13
  function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
14
  return new (P || (P = Promise))(function (resolve, reject) {
@@ -34,11 +45,20 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
34
45
  if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
35
46
  }
36
47
  };
48
+ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
49
+ if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
50
+ if (ar || !(i in from)) {
51
+ if (!ar) ar = Array.prototype.slice.call(from, 0, i);
52
+ ar[i] = from[i];
53
+ }
54
+ }
55
+ return to.concat(ar || Array.prototype.slice.call(from));
56
+ };
37
57
  import { createStore } from "mipd";
38
58
  import { logger } from "../logger";
39
59
  import { parseChainId } from "../utils/chain";
40
60
  import { validateAndChecksumAddress } from "../utils/address";
41
- import { detectInjectedProviderInfo, isValidProvider } from "../provider";
61
+ import { detectInjectedProviderInfo, isValidProvider, DEFAULT_PROVIDER_ICON } from "../provider";
42
62
  /** Why the tracker moved the active slot to another provider. Log copy. */
43
63
  var PROVIDER_SWITCH_REASONS = {
44
64
  ADDRESS_MISMATCH: "Address mismatch indicates wallet switch",
@@ -55,11 +75,71 @@ var PROVIDER_SWITCH_REASONS = {
55
75
  * deciding when a connect has to be reported, when a switch is stale, and
56
76
  * when a provider has stopped being the one we follow.
57
77
  */
78
+ /**
79
+ * A registered provider's current accounts, from its synchronous state.
80
+ *
81
+ * `provider.accounts` first - but a LIVE MetaMask Mobile session over
82
+ * WalletConnect has been observed with `accounts` EMPTY while the session's
83
+ * namespaces held the approved account ("eip155:11155111:0xabc..."), which
84
+ * silently defeated adoption. The namespaces are the session's ground
85
+ * truth, so they are the fallback. Still purely synchronous property
86
+ * reads; nothing goes on the wallet transport.
87
+ */
88
+ function readProviderAccounts(provider) {
89
+ var _a;
90
+ var direct = provider.accounts;
91
+ if (Array.isArray(direct) &&
92
+ direct.length > 0 &&
93
+ direct.every(function (a) { return typeof a === "string"; })) {
94
+ return direct;
95
+ }
96
+ var session = provider.session;
97
+ // eip155 ONLY: a session can also carry Solana or other namespaces, and
98
+ // feeding a non-EVM address into the EVM adoption path would make
99
+ // validation reject it and drop the whole adoption. A session can also
100
+ // authorize DIFFERENT accounts per chain, so entries for the provider's
101
+ // active chain come first - the adopted address should be the one this
102
+ // chain actually authorized.
103
+ var ns = (_a = session === null || session === void 0 ? void 0 : session.namespaces) === null || _a === void 0 ? void 0 : _a.eip155;
104
+ var chainId = provider.chainId;
105
+ var parsed = typeof chainId === "number"
106
+ ? chainId
107
+ : typeof chainId === "string"
108
+ ? parseChainId(chainId)
109
+ : undefined;
110
+ var activePrefix = parsed ? "eip155:".concat(parsed, ":") : undefined;
111
+ var forChain = [];
112
+ var others = [];
113
+ if (Array.isArray(ns === null || ns === void 0 ? void 0 : ns.accounts)) {
114
+ for (var _i = 0, _b = ns.accounts; _i < _b.length; _i++) {
115
+ var entry = _b[_i];
116
+ if (typeof entry !== "string" || !entry.startsWith("eip155:"))
117
+ continue;
118
+ var address = entry.split(":")[2];
119
+ if (!address)
120
+ continue;
121
+ var bucket = activePrefix && entry.startsWith(activePrefix) ? forChain : others;
122
+ if (!bucket.includes(address))
123
+ bucket.push(address);
124
+ }
125
+ }
126
+ var out = __spreadArray(__spreadArray([], forChain, true), others.filter(function (a) { return !forChain.includes(a); }), true);
127
+ return out;
128
+ }
58
129
  var EvmEventTracker = /** @class */ (function () {
59
130
  function EvmEventTracker(wallet, registry, deps) {
60
131
  this.wallet = wallet;
61
132
  this.registry = registry;
62
133
  this.deps = deps;
134
+ /**
135
+ * Providers adopted through `registerProvider` rather than discovered.
136
+ * Announcement-driven cleanup must not touch them: they are never in an
137
+ * announcement list, so "missing from the announcement" is their normal
138
+ * state, not evidence of removal. A Set rather than a WeakSet because
139
+ * suppressed adoptions retry from it; the registry holds these providers
140
+ * strongly anyway, and untrack removes them.
141
+ */
142
+ this.externallyRegistered = new Set();
63
143
  /**
64
144
  * The connect this SDK has already reported for a provider.
65
145
  *
@@ -187,6 +267,103 @@ var EvmEventTracker = /** @class */ (function () {
187
267
  logger.error("Failed to track EIP-6963 providers during initialization:", error);
188
268
  }
189
269
  };
270
+ /**
271
+ * Adopt a provider the page constructed rather than announced.
272
+ *
273
+ * Discovery only ever sees EIP-6963 announcements and `window.ethereum`.
274
+ * A WalletConnect or Ledger provider is a constructed object that does
275
+ * neither, so without this entry point its whole session is invisible -
276
+ * the P-2403 gap. The pipeline from here on is the same one every
277
+ * discovered provider takes: registry, detect event, listeners, request
278
+ * wrapper.
279
+ *
280
+ * A session that already exists at registration is seeded from the
281
+ * provider's SYNCHRONOUS `accounts` state (WalletConnect exposes it), via
282
+ * the same accounts-arrival path a live `accountsChanged` takes. No RPC:
283
+ * nothing analytics-only may go on a wallet's transport, and
284
+ * WalletConnect's serialised relay socket is the very case that rule
285
+ * exists for.
286
+ */
287
+ EvmEventTracker.prototype.adoptExternalProvider = function (detail) {
288
+ var provider = detail.provider;
289
+ // Exempt from announcement-driven cleanup BEFORE tracking: a registered
290
+ // provider is never in an EIP-6963 announcement, so without this the
291
+ // next wallet announcement would untrack it and its events would stop.
292
+ this.externallyRegistered.add(provider);
293
+ this.registry.add(detail);
294
+ this.trackProviders([detail]);
295
+ // Adoption and success both hinge on the wrapper actually installing:
296
+ // reporting success for a provider whose requests stay invisible would
297
+ // recreate the silent loss this API exists to close.
298
+ if (!this.registry.isTracked(provider)) {
299
+ this.externallyRegistered.delete(provider);
300
+ // Tracking got partway: lifecycle listeners may already be attached
301
+ // even though the request wrapper failed. Leaving them would leak
302
+ // callbacks that hold this instance for the life of the page.
303
+ this.untrackProvider(provider);
304
+ logger.warn("adoptExternalProvider: provider could not be tracked");
305
+ return false;
306
+ }
307
+ // A provider that was ALREADY tracked skips the pipeline above, and
308
+ // "tracked" means lifecycle listeners - it says nothing about the
309
+ // request wrapper, which a wallet can have replaced since. Re-verify
310
+ // it on every registration: the call reinstalls a displaced wrapper,
311
+ // rebinds ownership of an intact one, and refuses when it cannot -
312
+ // and success here must mean capture actually works.
313
+ if (!this.deps.registerRequestListeners(provider)) {
314
+ this.externallyRegistered.delete(provider);
315
+ this.untrackProvider(provider);
316
+ logger.warn("adoptExternalProvider: request wrapper could not be ensured");
317
+ return false;
318
+ }
319
+ // Detect with the LIVE name (peer-resolved when a session exists);
320
+ // the stored metadata stays generic so later sessions rename freely.
321
+ void this.detectWallets([
322
+ __assign(__assign({}, detail), { info: __assign(__assign({}, detail.info), this.registry.infoFor(provider)) }),
323
+ ]);
324
+ var accounts = readProviderAccounts(provider);
325
+ if (accounts.length > 0) {
326
+ void this.onAccountsChanged(provider, accounts);
327
+ }
328
+ return true;
329
+ };
330
+ /**
331
+ * Re-run session adoption for every registered external provider.
332
+ *
333
+ * Registration while tracking was suppressed (opt-out, excluded route)
334
+ * reached the adoption path and was refused - and a provider whose
335
+ * session already exists may never emit another accountsChanged, so
336
+ * nothing would ever retry. Called when suppression can have ended
337
+ * (opt-in, page navigation). Idempotent: an already-adopted wallet is
338
+ * deduplicated by the same state and markers as any repeated signal.
339
+ */
340
+ EvmEventTracker.prototype.retryExternalAdoptions = function () {
341
+ var _this = this;
342
+ this.externallyRegistered.forEach(function (provider) {
343
+ // A flagless provider registered BEFORE pairing detected as the
344
+ // generic injected identity; once the session's peer exists, the
345
+ // live identity differs and the corrected detect fires. The
346
+ // session-scoped rdns dedup keeps this from repeating.
347
+ var live = _this.registry.infoFor(provider);
348
+ if (live.rdns === "com.walletconnect") {
349
+ void _this.detectWallets([
350
+ {
351
+ info: {
352
+ name: live.name,
353
+ rdns: live.rdns,
354
+ uuid: "corrected-com-walletconnect",
355
+ icon: DEFAULT_PROVIDER_ICON,
356
+ },
357
+ provider: provider,
358
+ },
359
+ ]);
360
+ }
361
+ var accounts = readProviderAccounts(provider);
362
+ if (accounts.length > 0) {
363
+ void _this.onAccountsChanged(provider, accounts);
364
+ }
365
+ });
366
+ };
190
367
  EvmEventTracker.prototype.registerAccountsChangedListener = function (provider) {
191
368
  var _this = this;
192
369
  logger.info("registerAccountsChangedListener");
@@ -1001,6 +1178,11 @@ var EvmEventTracker = /** @class */ (function () {
1001
1178
  var currentProviderInstances = new Set(current.map(function (detail) { return detail.provider; }));
1002
1179
  for (var _i = 0, _a = this.registry.trackedProviders(); _i < _a.length; _i++) {
1003
1180
  var provider = _a[_i];
1181
+ // A registered external provider is never announced over EIP-6963;
1182
+ // its absence from an announcement list says nothing about it.
1183
+ if (this.externallyRegistered.has(provider)) {
1184
+ continue;
1185
+ }
1004
1186
  if (!currentProviderInstances.has(provider)) {
1005
1187
  logger.info("Cleaning up unavailable provider: ".concat(provider.constructor.name));
1006
1188
  this.untrackProvider(provider);
@@ -45,7 +45,7 @@ var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
45
45
  };
46
46
  import { logger } from "../logger";
47
47
  import { validateAndChecksumAddress } from "../utils/address";
48
- import { detectInjectedProviderInfo } from "../provider";
48
+ import { detectInjectedProviderInfo, readWalletConnectPeer } from "../provider";
49
49
  import { WRAPPED_REQUEST_SYMBOL, WRAPPED_REQUEST_REF_SYMBOL, } from "../types";
50
50
  /**
51
51
  * Which EVM wallets exist, and what is known about each.
@@ -140,11 +140,33 @@ var EvmProviderRegistry = /** @class */ (function () {
140
140
  */
141
141
  EvmProviderRegistry.prototype.infoFor = function (provider) {
142
142
  var announced = this.details.find(function (p) { return p.provider === provider; });
143
- if (announced) {
144
- return { name: announced.info.name, rdns: announced.info.rdns };
143
+ var info = announced
144
+ ? { name: announced.info.name, rdns: announced.info.rdns }
145
+ : (function () {
146
+ var injected = detectInjectedProviderInfo(provider);
147
+ return { name: injected.name, rdns: injected.rdns };
148
+ })();
149
+ // WalletConnect names the TRANSPORT; the session's peer names the
150
+ // wallet. Resolved live, per read: a session established after the
151
+ // provider was registered still gets its signer's name onto every
152
+ // event from then on. Only GENERIC names are replaced - a caller who
153
+ // registered an explicit display name keeps it. "Injected Provider"
154
+ // is included because a flagless WalletConnect-compatible provider
155
+ // registered BEFORE its session exists detects as nothing at all;
156
+ // the peer appearing later is itself the proof of what it was, so
157
+ // the rdns upgrades with it.
158
+ if (info.name === "WalletConnect" || info.name === "Injected Provider") {
159
+ var peer = readWalletConnectPeer(provider);
160
+ if (peer === null || peer === void 0 ? void 0 : peer.name) {
161
+ return {
162
+ name: peer.name,
163
+ rdns: info.rdns === "io.injected.provider"
164
+ ? "com.walletconnect"
165
+ : info.rdns,
166
+ };
167
+ }
145
168
  }
146
- var injected = detectInjectedProviderInfo(provider);
147
- return { name: injected.name, rdns: injected.rdns };
169
+ return info;
148
170
  };
149
171
  // ── listener bookkeeping ─────────────────────────────────────────────────
150
172
  EvmProviderRegistry.prototype.addListener = function (provider, event, listener) {
@@ -5,6 +5,13 @@ import { AutocaptureEventType } from "../tracking/TrackingPolicy";
5
5
  /** What the request tracker needs from the SDK that owns it. */
6
6
  export interface EvmRequestTrackerDeps {
7
7
  isAutocaptureEnabled(eventType: AutocaptureEventType): boolean;
8
+ /**
9
+ * Hybrid-capture dedup: true when a PENDING wagmi mutation already covers
10
+ * this request, so the mutation handler owns the capture. TanStack sets a
11
+ * mutation pending BEFORE its mutationFn issues the wallet call, so a
12
+ * hook-driven request always matches; an imperative one never does.
13
+ */
14
+ shouldSkipRequestCapture?(method: string, params: unknown[]): boolean;
8
15
  signature(params: {
9
16
  status: SignatureStatus;
10
17
  chainId?: ChainID;
@@ -23,16 +30,6 @@ export interface EvmRequestTrackerDeps {
23
30
  function_args?: Record<string, unknown>;
24
31
  }, properties?: IFormoEventProperties): Promise<void>;
25
32
  }
26
- /**
27
- * Autocapture for signatures and transactions, by wrapping a provider's
28
- * `request`.
29
- *
30
- * The wrapper is deliberately thin: it observes the call the dapp was already
31
- * making and never issues one of its own. That rule is why the chain a
32
- * request ran on is read from `eth_chainId` calls the app makes, rather than
33
- * probed - an SDK-issued lookup on a serialising transport can wedge the
34
- * user's wallet, which is never an acceptable price for a label.
35
- */
36
33
  export declare class EvmRequestTracker {
37
34
  private readonly wallet;
38
35
  private readonly registry;
@@ -50,6 +47,8 @@ export declare class EvmRequestTracker {
50
47
  constructor(wallet: WalletStateStore, registry: EvmProviderRegistry, deps: EvmRequestTrackerDeps);
51
48
  /** Stop every poll in flight. Terminal, like the event queue's close(). */
52
49
  cleanup(): void;
50
+ /** Providers whose owner list includes this instance; pruned on cleanup. */
51
+ private wrappedProviders;
53
52
  /** Re-arm a poll, unless this tracker has been torn down. */
54
53
  private schedulePoll;
55
54
  /**
@@ -58,7 +57,38 @@ export declare class EvmRequestTracker {
58
57
  * never retry it, and every signature and transaction from that wallet
59
58
  * would be missed for the rest of the session.
60
59
  */
60
+ /** Monotonic creation stamp; owner precedence is decided by it. */
61
+ private static nextCreationSeq;
62
+ readonly creationSeq: number;
63
+ /**
64
+ * Put this tracker into an owner list at its CREATION-ORDER position.
65
+ * Registration can arrive out of order - an older instance's async wrap
66
+ * kick may resolve after a newer instance's - and dispatch picks from
67
+ * the END of the list, so append-on-registration would let resolution
68
+ * order decide which instance owns capture. Creation order is what the
69
+ * newest-live contract promises.
70
+ */
71
+ private insertBySeniority;
61
72
  registerRequestListeners(provider: EIP1193Provider): boolean;
73
+ /** Install the wrapper function onto the provider; separated so the
74
+ * routing shim above stays small. */
75
+ private installWrappedRequest;
76
+ /**
77
+ * The wrapper body proper: everything a request observation does, run
78
+ * against THIS instance's registry, wallet state, and event queue. Kept
79
+ * as a method so a surviving wrapper installed by a previous SDK
80
+ * instance can hand calls to the current one.
81
+ */
82
+ private dispatchWrappedRequest;
83
+ /**
84
+ * Wallet attribution for request-derived events.
85
+ *
86
+ * Live per read through the registry, so a WalletConnect session names
87
+ * its actual signer ("MetaMask Wallet", "Ledger Live") - the live-test
88
+ * rows had provider_name EMPTY on every signature and transaction, which
89
+ * made per-wallet activity unanswerable in the warehouse.
90
+ */
91
+ private attributionFor;
62
92
  private buildSignatureEventPayload;
63
93
  private buildTransactionEventPayload;
64
94
  /**