@formo/analytics 1.13.4-alpha.4 → 1.13.4-alpha.5

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

@@ -0,0 +1,169 @@
+import { ChainID, Address, EIP1193Provider, Options, Config, SignatureStatus, TransactionStatus } from "./types";
+interface IFormoAnalytics {
+    page(): void;
+    connect(params: {
+        chainId: ChainID;
+        address: Address;
+    }): Promise<void>;
+    disconnect(params?: {
+        chainId?: ChainID;
+        address?: Address;
+    }): Promise<void>;
+    chain(params: {
+        chainId: ChainID;
+        address?: Address;
+    }): 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;
+    options: Options;
+    private _provider?;
+    private _providerListeners;
+    private identifySent?;
+    readonly identifySentKey = "identifySent";
+    config: Config;
+    currentChainId?: ChainID;
+    currentConnectedAddress?: Address;
+    private constructor();
+    static init(apiKey: string, options?: Options): Promise<FormoAnalytics>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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 an 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 trackFirstPageHit;
+    private trackPageHits;
+    private onLocationChange;
+    private trackPageHit;
+    private trackEvent;
+    private getProviders;
+    private identifyAll;
+    get provider(): EIP1193Provider | undefined;
+    private getAddress;
+    private getAccounts;
+    private getCurrentChainId;
+    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

@@ -0,0 +1 @@
+{"version":3,"file":"FormoAnalytics.d.ts","sourceRoot":"","sources":["../../../src/FormoAnalytics.ts"],"names":[],"mappings":"AAQA,OAAO,EACL,OAAO,EACP,OAAO,EACP,eAAe,EACf,OAAO,EACP,MAAM,EAGN,eAAe,EACf,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAGjB,UAAU,eAAe;IACvB,IAAI,IAAI,IAAI,CAAC;IACb,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;aAWlC,MAAM,EAAE,MAAM;IACvB,OAAO,EAAE,OAAO;IAXzB,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,kBAAkB,CAAoD;IAC9E,OAAO,CAAC,YAAY,CAAC,CAAU;IAC/B,QAAQ,CAAC,eAAe,kBAAkB;IAE1C,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC,OAAO;WA2BM,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,EACpB,OAAO,EACP,YAAY,EACZ,IAAI,GACL,EAAE;QACD,OAAO,EAAE,OAAO,CAAC;QACjB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,GAAG,OAAO,CAAC,IAAI,CAAC;IAYjB;;;;;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,iBAAiB;YAQjB,aAAa;YAmBb,gBAAgB;IAS9B,OAAO,CAAC,YAAY;YAgBN,UAAU;YA0CV,YAAY;YAaZ,WAAW;IAqBzB,IAAI,QAAQ,IAAI,eAAe,GAAG,SAAS,CAE1C;YAEa,UAAU;YAmBV,WAAW;YA6BX,iBAAiB;IAwB/B,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,WAAW;YAcL,iBAAiB;IAwB/B,OAAO,CAAC,0BAA0B;YAgCpB,4BAA4B;IAgB1C,OAAO,CAAC,mBAAmB;CAG5B"}