@formo/analytics 1.12.0-alpha.3 → 1.13.0-alpha.1

package/.env.example

@@ -0,0 +1 @@
+REACT_APP_HIGHLIGHT_PROJECT_ID = 

package/CONTRIBUTING.md

@@ -0,0 +1,93 @@
+# Development Guide
+
+If you want to contribute or run a local version of the Formo Analytics SDK, follow these steps:
+
+### 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
+```
+
+### Testing locally
+
+1. Link the local package to your project
+
+> See [this guide](https://dev.to/one-beyond/different-approaches-to-testing-your-own-packages-locally-npm-link-4hoj) on how to use `npm link`  or [this guide](https://classic.yarnpkg.com/lang/en/docs/cli/link/) for `yarn link` to test the package locally.
+
+For example, if I want to test the package with a project that is in the same directory: 
+
+```
+~/
+├── formo-analytics-example-next/
+└── sdk/
+```
+
+Run the following command:
+
+```bash
+# ~/formo-analytics-example-next
+npm link ../sdk
+OR
+yarn link ../sdk
+```
+
+Any changes you make to your local package will be reflected in the project you linked it to. 
+However, you have to run `build` to apply the changes you made to the local package:
+
+```
+# ~/sdk
+npm run build
+```
+
+The new change will be reflected in the project you linked it to.
+
+To unlink the package, run the following command:
+
+```bash
+# In ~/formo-analytics-example-next
+npm unlink ../sdk
+OR
+yarn unlink ../sdk
+```
+
+## Troubleshooting
+
+- Remove your `node_modules` and `yarn link` and run `yarn link` and `yarn install` again.
+- Try running `yarn build` in the SDK directory to ensure the changes are applied.
+- Try running `yarn unlink` and `yarn link` again.
+
+# Publishing
+
+1. Authenticate with NPM
+
+To publish a new version of the package, log in to your NPM account:
+
+```jsx
+npm login
+```
+
+or:
+
+```jsx
+npm adduser
+```
+
+2. Publish the Package
+
+Run the following command to publish the package to NPM:
+
+```jsx
+// Increment the version number in package.json and create git tag
+npm version
+
+// Publish the package to NPM
+npm publish
+```

package/README.md

@@ -1,167 +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 `index.html`:
+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';
-  const projectId = 'YOUR_PROJECT_ID';
-
-  script.src = 'https://unpkg.com/@formo/analytics';
-  script.onload = function () {
-    FormoAnalytics.init(apiKey, projectId)
-      .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
-
----
-
-### 1. Install the npm package:
-
-Install @formo/analytics via yarn or npm:
-
-```
-yarn add @formo/analytics
-```
-
-or
-
-```
-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,
-  projectId: string,
-  children: React.ReactNode,
-};
-
-// The provider component
-export const AnalyticsProvider: FC<FormoAnalyticsProviderProps> = ({
-  apiKey,
-  projectId,
-  children,
-}) => {
-  // Initialize the FormoAnalytics SDK inside useEffect
-  const [isInitialized, setIsInitialized] = useState(false);
-
-  useEffect(() => {
-    const initialize = async () => {
-      try {
-        await FormoAnalytics.init(apiKey, projectId);
-        console.log('FormoAnalytics SDK initialized');
-        setIsInitialized(true);
-      } catch (error) {
-        console.error('Failed to initialize FormoAnalytics SDK', error);
-      }
-    };
-
-    initialize();
-  }, [apiKey, projectId]);
-
-  // To prevent app crashes, render a loading state during initialization
-  if (!isInitialized) {
-    return (
-      <FormoAnalyticsProvider apiKey={apiKey} projectId={projectId}>
-        Loading Content
-      </FormoAnalyticsProvider>
-    );
-  }
-
-  return (
-    <FormoAnalyticsProvider apiKey={apiKey} projectId={projectId}>
-      {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' projectId='YOUR_PROJECT_ID'>
-          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 {
-        console.log('Tracking page hit...');
-        analytics.page(); // Track the page view
-        analytics.track('custom_event', { key: 'value' }); // Track a custom event
-      } catch (error) {
-        console.error('Failed to track page hit', error);
-      }
-    };
-
-    track();
-  }, [analytics]);
-
-  return <div>Your Component Content</div>;
-};
-```
-
-# Development notes
-
-To run a local version of the script:
-
-1. Run `yarn build-cjs && yarn build-esm && yarn webpack --mode=production` or `npm run build` at the root level to build the script.
-2. To authorize device, login into npmjs using `npm login` or `npm adduser`
-3. Run `yarn publish` or `npm run publish` to publish new versions of the package.

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

@@ -1,13 +1,5 @@
-import { ChainID, EIP1193Provider } from './types';
+import { ChainID, Address, EIP1193Provider, Options, Config } from "./types";
 interface IFormoAnalytics {
-    /**
-     * Initializes the FormoAnalytics instance with the provided API key and project ID.
-     */
-    init(apiKey: string, projectId: string): Promise<FormoAnalytics>;
-    /**
-     * Identifies the user with the provided user data.
-     */
-    identify(userData: Record<string, any>): void;
     /**
      * Tracks page visit events.
      */
@@ -16,85 +8,69 @@ interface IFormoAnalytics {
      * Connects to a wallet with the specified chain ID and address.
      */
     connect(params: {
-        account: string;
         chainId: ChainID;
+        address: string;
     }): Promise<void>;
     /**
-     * Disconnects the current wallet and clears the session information.
+     * Disconnects the current wallet.
      */
-    disconnect(attributes?: {
-        account?: string;
+    disconnect(params?: {
         chainId?: ChainID;
-    }): void;
+        address?: string;
+    }): Promise<void>;
     /**
-     * Tracks a specific event with a name and associated data.
+     * Switches the blockchain chain context and optionally logs additional params.
      */
-    track(eventName: string, eventData: Record<string, any>): void;
+    chain(params: {
+        chainId: ChainID;
+        address?: string;
+    }): Promise<void>;
     /**
-     * Switches the blockchain chain context and optionally logs additional attributes.
+     * Tracks a specific event with a name and associated data.
      */
-    chain(attributes: {
-        chainId: ChainID;
-        account?: string;
-    }): void;
+    track(eventName: string, eventData: Record<string, any>): Promise<void>;
 }
 export declare class FormoAnalytics implements IFormoAnalytics {
     readonly apiKey: string;
-    projectId: string;
+    options: Options;
     private _provider?;
-    private _registeredProviderListeners;
-    private sessionKey;
-    private config;
-    private sessionIdKey;
-    private timezoneToCountry;
-    currentChainId?: string | null;
-    currentConnectedAccount?: string;
+    private _providerListeners;
+    config: Config;
+    currentChainId?: ChainID;
+    currentConnectedAddress?: Address;
     private constructor();
-    static init(apiKey: string, projectId: string): Promise<FormoAnalytics>;
-    get provider(): EIP1193Provider | undefined;
-    private identifyUser;
-    private getSessionId;
-    private setSessionCookie;
-    private generateSessionId;
-    private getCookieValue;
-    private trackEvent;
-    private maskSensitiveData;
-    private trackPageHit;
-    private trackProvider;
-    private registerChainChangedListener;
-    private handleAccountDisconnected;
-    private onChainChanged;
-    private onAccountsChanged;
-    private registerAccountsChangedListener;
-    private getCurrentChainId;
-    private handleAccountConnected;
-    private getCurrentWallet;
-    /**
-     * Stores the wallet address in session storage when connected.
-     * @param address - The wallet address to store.
-     */
-    private storeWalletAddress;
-    /**
-     * Clears the wallet address from session storage when disconnected.
-     */
-    private clearWalletAddress;
-    private buildApiUrl;
-    connect({ account, chainId }: {
-        account: string;
+    static init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
+    connect({ chainId, address }: {
         chainId: ChainID;
+        address: Address;
     }): Promise<void>;
-    disconnect(attributes?: {
-        account?: string;
+    disconnect(params?: {
         chainId?: ChainID;
-    }): Promise<void> | undefined;
-    chain({ chainId, account }: {
+        address?: Address;
+    }): Promise<void>;
+    chain({ chainId, address }: {
         chainId: ChainID;
-        account?: string;
+        address?: Address;
     }): Promise<void>;
-    init(apiKey: string, projectId: string): Promise<FormoAnalytics>;
-    identify(userData: any): void;
-    page(): void;
-    track(eventName: string, eventData: any): void;
+    page(): Promise<void>;
+    track(eventName: string, eventData: Record<string, any>): Promise<void>;
+    private trackProvider;
+    private registerAddressChangedListener;
+    private registerChainChangedListener;
+    private onAddressChanged;
+    private onAddressConnected;
+    private handleDisconnect;
+    private onAddressDisconnected;
+    private onChainChanged;
+    private trackPageHit;
+    private trackEvent;
+    get provider(): EIP1193Provider | undefined;
+    private getAddress;
+    private getAccounts;
+    private getCurrentChainId;
+    private getLocation;
+    private getLanguage;
+    private buildEventPayload;
 }
 export {};
 //# sourceMappingURL=FormoAnalytics.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"FormoAnalytics.d.ts","sourceRoot":"","sources":["../../../src/FormoAnalytics.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,OAAO,EAAE,eAAe,EAAoB,MAAM,SAAS,CAAC;AAErE,UAAU,eAAe;IACvB;;OAEG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAEjE;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAE9C;;OAEG;IACH,IAAI,IAAI,IAAI,CAAC;IAEb;;OAEG;IACH,OAAO,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtE;;OAEG;IACH,UAAU,CAAC,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAEvE;;OAEG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAE/D;;OAEG;IACH,KAAK,CAAC,UAAU,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;CACjE;AACD,qBAAa,cAAe,YAAW,eAAe;aAgBlC,MAAM,EAAE,MAAM;IACvB,SAAS,EAAE,MAAM;IAhB1B,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,4BAA4B,CAG7B;IAEP,OAAO,CAAC,UAAU,CAAmB;IACrC,OAAO,CAAC,MAAM,CAAM;IACpB,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;WAcM,IAAI,CACf,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,cAAc,CAAC;IAU1B,IAAI,QAAQ,IAAI,eAAe,GAAG,SAAS,CAE1C;IAED,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,gBAAgB;IAUxB,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,cAAc;YAUR,UAAU;IA0DxB,OAAO,CAAC,iBAAiB;IAkEzB,OAAO,CAAC,YAAY;IAmCpB,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,yBAAyB;YAgBnB,cAAc;YA4Cd,iBAAiB;IAW/B,OAAO,CAAC,+BAA+B;YAYzB,iBAAiB;YAkBjB,sBAAsB;YActB,gBAAgB;IAyB9B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,WAAW;IAiBnB,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE;IAiBnE,UAAU,CAAC,UAAU,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE;IAoB/D,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;IAyBlE,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAMhE,QAAQ,CAAC,QAAQ,EAAE,GAAG;IAItB,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,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAE7E,UAAU,eAAe;IACvB;;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,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;OAEG;IACH,KAAK,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErE;;OAEG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACzE;AAED,qBAAa,cAAe,YAAW,eAAe;aAYlC,MAAM,EAAE,MAAM;IACvB,OAAO,EAAE,OAAO;IAZzB,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,kBAAkB,CAGnB;IAEP,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,OAAO;WAeM,IAAI,CACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,cAAc,CAAC;IAUpB,OAAO,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBpF,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAM5E,KAAK,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBnF,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7E,OAAO,CAAC,aAAa;IA8BrB,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,4BAA4B;YAOtB,gBAAgB;YAQhB,kBAAkB;YAYlB,gBAAgB;YAUhB,qBAAqB;YAIrB,cAAc;IAsC5B,OAAO,CAAC,YAAY;YAcN,UAAU;IAyCxB,IAAI,QAAQ,IAAI,eAAe,GAAG,SAAS,CAE1C;YAEa,UAAU;YAsBV,WAAW;YAuBX,iBAAiB;IA0B/B,OAAO,CAAC,WAAW;IAUnB,OAAO,CAAC,WAAW;YAcL,iBAAiB;CAwBhC"}