@formo/analytics 1.13.0-alpha.1 → 1.13.3-alpha.0

package/CONTRIBUTING.md

@@ -85,9 +85,9 @@ npm adduser
 Run the following command to publish the package to NPM:
 
 ```jsx
-// Increment the version number in package.json and create git tag
-npm version
+// Increment the version number in package.json and create git tag https://docs.npmjs.com/cli/v8/commands/npm-version
+npm version <major/minor/patch>
 
 // Publish the package to NPM
-npm publish
+npm publish 
 ```

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

@@ -1,34 +1,38 @@
-import { ChainID, Address, EIP1193Provider, Options, Config } from "./types";
+import { ChainID, Address, EIP1193Provider, Options, Config, SignatureStatus, TransactionStatus } from "./types";
 interface IFormoAnalytics {
-    /**
-     * Tracks page visit events.
-     */
     page(): void;
-    /**
-     * Connects to a wallet with the specified chain ID and address.
-     */
     connect(params: {
         chainId: ChainID;
-        address: string;
+        address: Address;
     }): Promise<void>;
-    /**
-     * Disconnects the current wallet.
-     */
     disconnect(params?: {
         chainId?: ChainID;
-        address?: string;
+        address?: Address;
     }): Promise<void>;
-    /**
-     * Switches the blockchain chain context and optionally logs additional params.
-     */
     chain(params: {
         chainId: ChainID;
-        address?: string;
+        address?: Address;
     }): Promise<void>;
-    /**
-     * Tracks a specific event with a name and associated data.
-     */
-    track(eventName: string, eventData: Record<string, any>): Promise<void>;
+    signature({ status, chainId, address, message, signatureHash, }: {
+        status: SignatureStatus;
+        chainId?: ChainID;
+        address: Address;
+        message: string;
+        signatureHash?: string;
+    }): Promise<void>;
+    transaction({ status, chainId, address, data, to, value, transactionHash, }: {
+        status: TransactionStatus;
+        chainId: ChainID;
+        address: Address;
+        data?: string;
+        to?: string;
+        value?: string;
+        transactionHash?: string;
+    }): Promise<void>;
+    identify(params: {
+        address: Address;
+    }): Promise<void>;
+    track(action: string, payload: Record<string, any>): Promise<void>;
 }
 export declare class FormoAnalytics implements IFormoAnalytics {
     readonly apiKey: string;
@@ -40,30 +44,114 @@ export declare class FormoAnalytics implements IFormoAnalytics {
     currentConnectedAddress?: Address;
     private constructor();
     static init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
-    connect({ chainId, address }: {
+    /**
+     * Emits a page visit event with the current URL information, fire on page change.
+     * @returns {Promise<void>}
+     */
+    page(): Promise<void>;
+    /**
+     * Emits a wallet connect event.
+     * @param {ChainID} params.chainId
+     * @param {Address} params.address
+     * @throws {Error} If chainId or address is empty
+     * @returns {Promise<void>}
+     */
+    connect({ chainId, address, }: {
         chainId: ChainID;
         address: Address;
     }): Promise<void>;
+    /**
+     * Emits a wallet disconnect event.
+     * @param {ChainID} params.chainId
+     * @param {Address} params.address
+     * @returns {Promise<void>}
+     */
     disconnect(params?: {
         chainId?: ChainID;
         address?: Address;
     }): Promise<void>;
-    chain({ chainId, address }: {
+    /**
+     * Emits a chain network change event.
+     * @param {ChainID} params.chainId
+     * @param {Address} params.address
+     * @throws {Error} If chainId is empty, zero, or not a valid number
+     * @throws {Error} If no address is provided and no previous address is recorded
+     * @returns {Promise<void>}
+     */
+    chain({ chainId, address, }: {
         chainId: ChainID;
         address?: Address;
     }): Promise<void>;
-    page(): Promise<void>;
-    track(eventName: string, eventData: Record<string, any>): Promise<void>;
+    /**
+     * Emits a signature event.
+     * @param {SignatureStatus} params.status - requested, confirmed, rejected
+     * @param {ChainID} params.chainId
+     * @param {Address} params.address
+     * @param {string} params.message
+     * @param {string} params.signatureHash - only provided if status is confirmed
+     * @returns {Promise<void>}
+     */
+    signature({ status, chainId, address, message, signatureHash, }: {
+        status: SignatureStatus;
+        chainId?: ChainID;
+        address: Address;
+        message: string;
+        signatureHash?: string;
+    }): Promise<void>;
+    /**
+     * Emits a transaction event.
+     * @param {TransactionStatus} params.status - started, broadcasted, rejected
+     * @param {ChainID} params.chainId
+     * @param {Address} params.address
+     * @param {string} params.data
+     * @param {string} params.to
+     * @param {string} params.value
+     * @param {string} params.transactionHash - only provided if status is broadcasted
+     * @returns {Promise<void>}
+     */
+    transaction({ status, chainId, address, data, to, value, transactionHash, }: {
+        status: TransactionStatus;
+        chainId: ChainID;
+        address: Address;
+        data?: string;
+        to?: string;
+        value?: string;
+        transactionHash?: string;
+    }): Promise<void>;
+    /**
+     * Emits a identify event with current wallet address.
+     * @param {Address} params.address
+     * @returns {Promise<void>}
+     */
+    identify({ address, providerName, rdns }: {
+        address: Address;
+        providerName?: string;
+        rdns?: string;
+    }): Promise<void>;
+    /**
+     * Emits a custom event with custom data.
+     * @param {string} action
+     * @param {Record<string, any>} payload
+     * @returns {Promise<void>}
+     */
+    track(action: string, payload: Record<string, any>): Promise<void>;
     private trackProvider;
     private registerAddressChangedListener;
     private registerChainChangedListener;
+    private registerSignatureListener;
+    private registerTransactionListener;
     private onAddressChanged;
     private onAddressConnected;
     private handleDisconnect;
     private onAddressDisconnected;
     private onChainChanged;
+    private trackFirstPageVisit;
+    private trackPagesChange;
+    private onLocationChange;
     private trackPageHit;
     private trackEvent;
+    private getProviders;
+    private identifyAll;
     get provider(): EIP1193Provider | undefined;
     private getAddress;
     private getAccounts;
@@ -71,6 +159,9 @@ export declare class FormoAnalytics implements IFormoAnalytics {
     private getLocation;
     private getLanguage;
     private buildEventPayload;
+    private buildSignatureEventPayload;
+    private buildTransactionEventPayload;
+    private getActionDescriptor;
 }
 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":"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"}
+{"version":3,"file":"FormoAnalytics.d.ts","sourceRoot":"","sources":["../../../src/FormoAnalytics.ts"],"names":[],"mappings":"AASA,OAAO,EACL,OAAO,EACP,OAAO,EACP,eAAe,EACf,OAAO,EACP,MAAM,EAGN,eAAe,EACf,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,UAAU,eAAe;IACvB,IAAI,IAAI,IAAI,CAAC;IAEb,OAAO,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACvE,UAAU,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7E,KAAK,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,SAAS,CAAC,EACR,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,aAAa,GACd,EAAE;QACD,MAAM,EAAE,eAAe,CAAC;QACxB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,WAAW,CAAC,EACV,MAAM,EACN,OAAO,EACP,OAAO,EACP,IAAI,EACJ,EAAE,EACF,KAAK,EACL,eAAe,GAChB,EAAE;QACD,MAAM,EAAE,iBAAiB,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAClB,QAAQ,CAAC,MAAM,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACpE;AAED,qBAAa,cAAe,YAAW,eAAe;aASlC,MAAM,EAAE,MAAM;IACvB,OAAO,EAAE,OAAO;IATzB,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,kBAAkB,CAAoD;IAE9E,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,OAAO;WAkBM,IAAI,CACf,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,OAAO,GAChB,OAAO,CAAC,cAAc,CAAC;IAc1B;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAI3B;;;;;;OAMG;IACG,OAAO,CAAC,EACZ,OAAO,EACP,OAAO,GACR,EAAE;QACD,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;KAClB,GAAG,OAAO,CAAC,IAAI,CAAC;IAiBjB;;;;;OAKG;IACG,UAAU,CAAC,MAAM,CAAC,EAAE;QACxB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjB;;;;;;;OAOG;IACG,KAAK,CAAC,EACV,OAAO,EACP,OAAO,GACR,EAAE;QACD,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBjB;;;;;;;;OAQG;IACG,SAAS,CAAC,EACd,MAAM,EACN,OAAO,EACP,OAAO,EACP,OAAO,EACP,aAAa,GACd,EAAE;QACD,MAAM,EAAE,eAAe,CAAC;QACxB,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjB;;;;;;;;;;OAUG;IACG,WAAW,CAAC,EAChB,MAAM,EACN,OAAO,EACP,OAAO,EACP,IAAI,EACJ,EAAE,EACF,KAAK,EACL,eAAe,GAChB,EAAE;QACD,MAAM,EAAE,iBAAiB,CAAC;QAC1B,OAAO,EAAE,OAAO,CAAC;QACjB,OAAO,EAAE,OAAO,CAAC;QACjB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B,GAAG,OAAO,CAAC,IAAI,CAAC;IAYjB;;;;OAIG;IACU,QAAQ,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAUjI;;;;;OAKG;IACG,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQxE,OAAO,CAAC,aAAa;IA0BrB,OAAO,CAAC,8BAA8B;IAYtC,OAAO,CAAC,4BAA4B;IAOpC,OAAO,CAAC,yBAAyB;IAuDjC,OAAO,CAAC,2BAA2B;YA2DrB,gBAAgB;YAQhB,kBAAkB;YAYlB,gBAAgB;YAchB,qBAAqB;YAOrB,cAAc;YAkCd,mBAAmB;YAQnB,gBAAgB;YAoBhB,gBAAgB;IAW9B,OAAO,CAAC,YAAY;YAgBN,UAAU;YA8CV,YAAY;YAaZ,WAAW;IAazB,IAAI,QAAQ,IAAI,eAAe,GAAG,SAAS,CAE1C;YAEa,UAAU;YAqBV,WAAW;YAmBX,iBAAiB;IAwB/B,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,WAAW;YAcL,iBAAiB;IAyB/B,OAAO,CAAC,0BAA0B;YAgCpB,4BAA4B;IAgB1C,OAAO,CAAC,mBAAmB;CAG5B"}