@formo/analytics 1.11.13 → 1.11.14-alpha.2

package/CONTRIBUTING.md

@@ -0,0 +1,43 @@
+# Development Guide
+
+If you want to contribute or run a local version of the Formo Analytics SDK, follow these steps:
+
+1. Build the SDK Locally
+
+Run the following command to build both CommonJS and ESM versions of the SDK:
+
+```jsx
+yarn build-cjs && yarn build-esm && yarn webpack --mode=production
+```
+
+or if you're using NPM:
+
+```jsx
+npm run build
+```
+
+2. Authenticate with NPM
+
+To publish a new version of the package, log in to your NPM account:
+
+```jsx
+npm login
+```
+
+or:
+
+```jsx
+npm adduser
+```
+
+3. Publish the Package
+
+Run the following command to publish the package to NPM:
+
+```jsx
+npm version prerelease --preid alpha 
+OR
+npm version
+
+npm run publish
+```

package/README.md

@@ -1,255 +1,8 @@
-# Installation Guide
+# Formo Analytics SDK
 
-## Option 1 - tracking code
+The Formo Analytics SDK is a Javascript library that allows you to track and analyze user interactions on your dapp.
 
----
+## Installation
 
-Add the following to your page:
+Please visit Formo's [Developer Docs](https://docs.formo.so) for detailed guides and installation instructions.
 
-```html
-<script>
-  const script = document.createElement('script');
-  const apiKey = 'YOUR_API_KEY';
-
-  script.src = 'https://unpkg.com/@formo/analytics';
-  script.onload = function () {
-    FormoAnalytics.init(apiKey)
-      .then((sdkInstance) => {
-        window.formo = sdkInstance;
-
-        // Call the public `page` method to track a page hit
-        window.formo.page();
-      })
-      .catch((error) => {
-        console.error('Error initializing FormoAnalytics:', error);
-      });
-  };
-  document.head.appendChild(script);
-</script>
-```
-
-## Option 2 - using npm package
-
----
-
-### React Application
-
-**1. Install the SDK**
-Install the Formo Analytics SDK using Yarn or NPM:
-
-```jsx
-yarn add @formo/analytics
-```
-
-or
-
-```jsx
-npm install @formo/analytics --save
-```
-
-**2. Set up FormoAnalyticsProvider in Your Application**
-
-Wrap your entire React application in the `FormoAnalyticsProvider` provided by the SDK.
-
-```jsx 
-//App.tsx (or App.js)
-import React from 'react';
-import ReactDOM from 'react-dom/client';
-import { FormoAnalyticsProvider } from '@formo/analytics';
-import App from './App';
-
-const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
-
-root.render(
-  <React.StrictMode>
-    <FormoAnalyticsProvider apiKey="YOUR_API_KEY">
-      <App />
-    </FormoAnalyticsProvider>
-  </React.StrictMode>
-);
-```
-
-**3. Tracking Events**
-
-You can use the `useFormoAnalytics` hook from the SDK to track user interactions.
-
-Example: Tracking a Custom Event
-
-```jsx
-import React, { useEffect } from 'react';
-import { useFormoAnalytics } from '@formo/analytics';
-
-const HomePage = () => {
-  const analytics = useFormoAnalytics();
-
-  useEffect(() => {
-    // Track a custom event
-    analytics.track('custom_event', { key: 'value' });
-  }, [analytics]);
-
-  return <div>Welcome to the Home Page!</div>;
-};
-
-export default HomePage;
-```
-
-**4. Folder Structure Example**
-
-```
-/src
- ├── /components
- │    └── HomePage.tsx
- ├── /App.tsx
- └── /index.tsx (or index.js)
-```
-
----
-
-### Next.js Application
-
-**1. Install the npm package:**
-
-Install `@formo/analytics` via yarn or npm:
-
-```jsx
-yarn add @formo/analytics
-```
-
-or
-
-```jsx
-npm install @formo/analytics --save
-```
-
-**2. Set up the `FormoAnalyticsProvider` in your application:**
-
-```jsx
-// AnalyticsProvider.tsx
-
-'use client';
-
-import { FormoAnalytics, FormoAnalyticsProvider } from '@formo/analytics';
-import React, { FC, useEffect } from 'react';
-
-type FormoAnalyticsProviderProps = {
-  apiKey: string,
-  children: React.ReactNode,
-};
-
-// The provider component
-export const AnalyticsProvider: FC<FormoAnalyticsProviderProps> = ({
-  apiKey,
-  children,
-}) => {
-  return (
-    <FormoAnalyticsProvider apiKey={apiKey}>
-      {children}
-    </FormoAnalyticsProvider>
-  );
-};
-
-export default AnalyticsProvider;
-```
-
-**3. Integrating the Provider in Your Root Layout**
-
-Wrap your application with the newly created `AnalyticsProvider` in your main layout file:
-
-```jsx
-import { AnalyticsProvider } from './AnalyticsProvider';
-
-export default function RootLayout({
-  children,
-}: {
-  children: React.ReactNode,
-}) {
-  return (
-    <html lang='en'>
-      <body>
-        <AnalyticsProvider apiKey='YOUR_API_KEY'>
-          Your Page Content
-        </AnalyticsProvider>
-      </body>
-    </html>
-  );
-}
-```
-
-**4. Using the SDK**
-
-Once the SDK is initialized, you can use its methods to track events and user interactions. Here’s how to do that:
-
-```jsx
-import { useFormoAnalytics } from '@formo/analytics';
-import React, { useEffect } from 'react';
-
-const YourComponent = () => {
-  const analytics = useFormoAnalytics();
-
-  useEffect(() => {
-    const track = async () => {
-      try {
-        analytics.track('custom_event', { key: 'value' }); // Track a custom event
-      } catch (error) {
-        console.error('Failed to track event', error);
-      }
-    };
-
-    track();
-  }, [analytics]);
-
-  return <div>Your Component Content</div>;
-};
-```
-
-# Development Notes
-
-If you want to contribute or run a local version of the Formo Analytics SDK, follow these steps:
-
-1. Build the SDK Locally
-
-Run the following command to build both CommonJS and ESM versions of the SDK:
-
-```jsx
-yarn build-cjs && yarn build-esm && yarn webpack --mode=production
-```
-
-or if you're using NPM:
-
-```jsx
-yarn build
-```
-
-2. Authenticate with NPM
-
-To publish a new version of the package, log in to your NPM account:
-
-```jsx
-npm login
-```
-
-or:
-
-```jsx
-npm adduser
-```
-
-3. Publish the Package
-
-Run the following command to publish the package to NPM:
-
-```jsx
-yarn publish
-```
-
-or:
-
-```jsx
-npm run publish
-```
-
-# Troubleshooting
-
-**API Key Not Provided:** Ensure you pass a valid apiKey when initializing the SDK.
-**SDK Not Initialized:** If you encounter issues with initialization, check the console logs for errors and ensure the project ID and API key are correct.
-**Network Errors:** Verify that the analytics service URL is accessible from your network.

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

@@ -3,7 +3,7 @@ interface IFormoAnalytics {
     /**
      * Initializes the FormoAnalytics instance with the provided API key and project ID.
      */
-    init(apiKey: string, options: Options): Promise<FormoAnalytics>;
+    init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
     /**
      * Tracks page visit events.
      */
@@ -41,28 +41,29 @@ export declare class FormoAnalytics implements IFormoAnalytics {
     private _registeredProviderListeners;
     private walletAddressSessionKey;
     private config;
-    private sessionIdKey;
     private timezoneToCountry;
     currentChainId?: string | null;
     currentConnectedAddress?: string;
     private constructor();
-    static init(apiKey: string, options: Options): Promise<FormoAnalytics>;
+    static init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
     get provider(): EIP1193Provider | undefined;
-    private getSessionId;
-    private getOrigin;
-    private setSessionCookie;
-    private generateSessionId;
-    private getCookieValue;
     private trackEvent;
-    private getCommonTrackingFields;
     private trackPageHit;
+    private isAutomationEnvironment;
+    private getUserLocation;
+    private getUserLanguage;
+    buildEventPayload(eventSpecificPayload?: Record<string, unknown>): Promise<Record<string, unknown>>;
     private trackProvider;
+    private getAndStoreConnectedAddress;
     private getCurrentWallet;
+    private fetchAccounts;
+    private fetchChainId;
     private getCurrentChainId;
     private registerAddressChangedListener;
     private registerChainChangedListener;
     private onAddressChanged;
     private onAddressConnected;
+    private handleDisconnection;
     private onAddressDisconnected;
     private onChainChanged;
     /**

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

@@ -1 +1 @@
-{"version":3,"file":"FormoAnalytics.d.ts","sourceRoot":"","sources":["../../../src/FormoAnalytics.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5D,UAAU,eAAe;IACvB;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEhE;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;OAEG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;CAChE;AAID,qBAAa,cAAe,YAAW,eAAe;aAgBlC,MAAM,EAAE,MAAM;IACvB,OAAO,EAAE,OAAO;IAhBzB,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,4BAA4B,CAG7B;IAEP,OAAO,CAAC,uBAAuB,CAAmB;IAClD,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,iBAAiB,CAAwC;IAEjE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,OAAO;WAeM,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAU5E,IAAI,QAAQ,IAAI,eAAe,GAAG,SAAS,CAE1C;IAED,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,SAAS;IAKjB,OAAO,CAAC,gBAAgB;IASxB,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,cAAc;YAUR,UAAU;IAgExB,OAAO,CAAC,uBAAuB;IA6B/B,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,aAAa;YA0BP,gBAAgB;YAwBhB,iBAAiB;IAiB/B,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,4BAA4B;YAOtB,gBAAgB;YAWhB,kBAAkB;IAchC,OAAO,CAAC,qBAAqB;YAgBf,cAAc;IA4C5B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAI1B,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAK/D,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAiBnE,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAkB3D,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAuBlE,IAAI;IAIJ,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG;CAGxC"}
+{"version":3,"file":"FormoAnalytics.d.ts","sourceRoot":"","sources":["../../../src/FormoAnalytics.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5D,UAAU,eAAe;IACvB;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEjE;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;OAEG;IACH,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAE5D;;OAEG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;CAChE;AAID,qBAAa,cAAe,YAAW,eAAe;aAelC,MAAM,EAAE,MAAM;IACvB,OAAO,EAAE,OAAO;IAfzB,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,4BAA4B,CAG7B;IAEP,OAAO,CAAC,uBAAuB,CAAmB;IAClD,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,iBAAiB,CAAwC;IAEjE,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC,OAAO;WAeM,IAAI,CACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,cAAc,CAAC;IAU1B,IAAI,QAAQ,IAAI,eAAe,GAAG,SAAS,CAE1C;YAIa,UAAU;IA2DxB,OAAO,CAAC,YAAY;IAcpB,OAAO,CAAC,uBAAuB;IAS/B,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,eAAe;IAajB,iBAAiB,CACrB,oBAAoB,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GACjD,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IA2BnC,OAAO,CAAC,aAAa;YA4BP,2BAA2B;YAiB3B,gBAAgB;YA2BhB,aAAa;YAwBb,YAAY;YAqBZ,iBAAiB;IAgB/B,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,4BAA4B;YAOtB,gBAAgB;YAWhB,kBAAkB;IAchC,OAAO,CAAC,mBAAmB;IAc3B,OAAO,CAAC,qBAAqB;YAOf,cAAc;IAmC5B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAI1B,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;IAK/D,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAiBnE,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAU3D,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAuBlE,IAAI;IAIJ,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,GAAG;CAGxC"}