@formo/analytics 1.16.7 → 1.16.8

package/src/types/base.ts

@@ -1,4 +1,10 @@
 import { LogLevel } from "../lib";
+import {
+  IFormoEventContext,
+  IFormoEventProperties,
+  SignatureStatus,
+  TransactionStatus,
+} from "./events";
 import { EIP1193Provider } from "./provider";
 
 export type Nullable<T> = T | null;
@@ -9,6 +15,83 @@ export type ChainID = number;
 export type Address = string;
 
 export type ValidInputTypes = Uint8Array | bigint | string | number | boolean;
+export interface IFormoAnalytics {
+  page(
+    category?: string,
+    name?: string,
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): void;
+  reset(): void;
+  detect(
+    params: { rdns: string; providerName: string },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  connect(
+    params: { chainId: ChainID; address: Address },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  disconnect(
+    params?: { chainId?: ChainID; address?: Address },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  chain(
+    params: { chainId: ChainID; address?: Address },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  signature(
+    params: {
+      status: SignatureStatus;
+      chainId?: ChainID;
+      address: Address;
+      message: string;
+      signatureHash?: string;
+    },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  transaction(
+    params: {
+      status: TransactionStatus;
+      chainId: ChainID;
+      address: Address;
+      data?: string;
+      to?: string;
+      value?: string;
+      transactionHash?: string;
+    },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  identify(
+    params: {
+      address: Address;
+      providerName?: string;
+      userId?: string;
+      rdns?: string;
+    },
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+  track(
+    event: string,
+    properties?: IFormoEventProperties,
+    context?: IFormoEventContext,
+    callback?: (...args: unknown[]) => void
+  ): Promise<void>;
+}
 
 export interface Options {
   provider?: EIP1193Provider;

package/src/types/events.ts

@@ -17,7 +17,17 @@ export interface ICommonProperties {
 
 export type IFormoEventProperties = Record<string, unknown>;
 export type IFormoEventContext = Record<string, unknown>;
-export type UTMParameters = Record<string, string>;
+export type UTMParameters = {
+  utm_source: string;
+  utm_medium: string;
+  utm_campaign: string;
+  utm_term: string;
+  utm_content: string;
+};
+export type ITrafficSource = UTMParameters & {
+  ref: string;
+  referrer: string;
+};
 
 export interface IFormoEvent extends ICommonProperties {
   context: Nullable<IFormoEventContext>;