@formo/analytics 1.25.0 → 1.27.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Formo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -17,12 +17,14 @@
 
 ## Installation
 
-The Formo Web SDK is a Javascript library that allows you to track user event data from your website and app. 
+The Formo Web SDK is a Javascript library that allows you to track user event data from your website and app.
 
 You can install Formo on:
-- [Websites](https://docs.formo.so/install#website)
-- [React apps](https://docs.formo.so/install#react)
-- [Next.js apps](https://docs.formo.so/install#next-js-app-router)
+- [Wagmi](https://docs.formo.so/install#wagmi) (recommended)
+- [HTML Snippet](https://docs.formo.so/install#html-snippet)
+- [React](https://docs.formo.so/install#react)
+- [Next.js app router](https://docs.formo.so/install#next-js-app-router)
+- [Next.js pages router](https://docs.formo.so/install#next-js-pages-router)
 
 ## Configuration
 

package/dist/cjs/src/FormoAnalytics.d.ts

@@ -24,6 +24,16 @@ export declare class FormoAnalytics implements IFormoAnalytics {
     private _injectedProviderDetail?;
     private _processingAccountsChanged;
     private _seenProviders;
+    /**
+     * Wagmi event handler for tracking wallet events via Wagmi v2
+     * Only initialized when options.wagmi is provided
+     */
+    private wagmiHandler?;
+    /**
+     * Flag indicating if Wagmi mode is enabled
+     * When true, EIP-1193 provider wrapping is skipped
+     */
+    private isWagmiMode;
     config: Config;
     currentChainId?: ChainID;
     currentAddress?: Address;
@@ -34,12 +44,6 @@ export declare class FormoAnalytics implements IFormoAnalytics {
      * @returns true if there's a provider mismatch, false otherwise
      */
     private isProviderMismatch;
-    /**
-     * Check if a provider is in a valid state for switching
-     * @param provider The provider to validate
-     * @returns true if the provider is in a valid state
-     */
-    private isProviderInValidState;
     private constructor();
     static init(writeKey: string, options?: Options): Promise<FormoAnalytics>;
     /**
@@ -57,6 +61,12 @@ export declare class FormoAnalytics implements IFormoAnalytics {
      * @returns {void}
      */
     reset(): void;
+    /**
+     * Clean up resources and event listeners
+     * Call this when destroying the analytics instance
+     * @returns {void}
+     */
+    cleanup(): void;
     /**
      * Emits a connect wallet event.
      * @param {ChainID} params.chainId
@@ -129,7 +139,7 @@ export declare class FormoAnalytics implements IFormoAnalytics {
      * @param {(...args: unknown[]) => void} callback
      * @returns {Promise<void>}
      */
-    transaction({ status, chainId, address, data, to, value, transactionHash, }: {
+    transaction({ status, chainId, address, data, to, value, transactionHash, function_name, function_args, }: {
         status: TransactionStatus;
         chainId: ChainID;
         address: Address;
@@ -137,6 +147,8 @@ export declare class FormoAnalytics implements IFormoAnalytics {
         to?: string;
         value?: string;
         transactionHash?: string;
+        function_name?: string;
+        function_args?: Record<string, unknown>;
     }, properties?: IFormoEventProperties, context?: IFormoEventContext, callback?: (...args: unknown[]) => void): Promise<void>;
     /**
      * Emits an identify event with current wallet address and provider info.
@@ -193,7 +205,13 @@ export declare class FormoAnalytics implements IFormoAnalytics {
      * @returns {boolean} True if the user has opted out
      */
     hasOptedOutTracking(): boolean;
-    private trackProvider;
+    /**
+     * Track an EIP-1193 provider by wrapping its request method and adding event listeners
+     * Note: This is only used in non-Wagmi mode. When Wagmi is enabled, all tracking
+     * happens through Wagmi's connector system instead of EIP-1193/EIP-6963.
+     * @param provider The EIP-1193 provider to track
+     */
+    private trackEIP1193Provider;
     private trackProviders;
     private addProviderListener;
     private registerAccountsChangedListener;
@@ -229,19 +247,13 @@ export declare class FormoAnalytics implements IFormoAnalytics {
      * @param eventType The wallet event type to check
      * @returns {boolean} True if the event type should be autocaptured
      */
-    private isAutocaptureEnabled;
+    isAutocaptureEnabled(eventType: "connect" | "disconnect" | "signature" | "transaction" | "chain"): boolean;
     /**
      * Get provider information for a given provider
      * @param provider The provider to get info for
      * @returns Provider information
      */
     private getProviderInfo;
-    /**
-     * Attempts to detect information about an injected provider
-     * @param provider The injected provider to analyze
-     * @returns Provider information with fallback values
-     */
-    private detectInjectedProviderInfo;
     private getProviders;
     get providers(): readonly EIP6963ProviderDetail[];
     private detectWallets;