@leather.io/analytics 3.3.2 → 3.4.0

package/dist/index.d.ts

@@ -210,7 +210,7 @@ interface AnalyticsClientInterface {
     track: (event: string, ...args: any[]) => Promise<any>;
     group: (groupId: string, traits?: any, ...args: any[]) => Promise<any>;
     identify: (...args: any[]) => Promise<any>;
-    page?: (name: string, ...args: any[]) => Promise<any>;
+    page?: (category?: string, name?: string, ...args: any[]) => Promise<any>;
 }
 interface AnalyticsClientConfig<T extends AnalyticsClientInterface> {
     client: T;
@@ -231,12 +231,12 @@ declare function configureAnalyticsClient<T extends AnalyticsClientInterface>({
     defaultTraits?: JsonMap;
 }): {
     track<K extends keyof Events>(event: K, ...properties: undefined extends Events[K] ? [] : [param: Events[K]]): Promise<any>;
-    untypedTrack(event: string, properties?: JsonMap): Promise<any>;
-    screen: (name: string, ...args: any[]) => Promise<any>;
-    group: (groupId: string, traits?: any, ...args: any[]) => Promise<any>;
-    identify: (...args: any[]) => Promise<any>;
-    page: ((name: string, ...args: any[]) => Promise<any>) | Promise<void>;
-    client: T;
+    untypedTrack(event: string, properties?: JsonMap | Record<string, unknown>): Promise<any>;
+    screen(name: string, properties?: JsonMap | Record<string, unknown>): Promise<any>;
+    group(groupId: string, traits?: JsonMap | Record<string, unknown>): Promise<any>;
+    identify(userId?: string, traits?: JsonMap | Record<string, unknown>): Promise<any>;
+    page(category?: string, name?: string, properties?: JsonMap | Record<string, unknown>): Promise<any>;
+    readonly client: T_1;
 };
 
 export { type AnalyticsClientConfig, type AnalyticsClientInterface, type DefaultProperties, type EventName, type Events, type JsonList, type JsonMap, type JsonValue, type OptionalIfUndefined, configureAnalyticsClient };

package/dist/index.js

@@ -1,20 +1,43 @@
 // src/client.ts
-function AnalyticsClient(analyticsClient, options) {
+function AnalyticsClient(config) {
+  const { client: analyticsClient, defaultProperties = {}, defaultTraits = {} } = config;
   return {
     async track(event, ...properties) {
-      return analyticsClient.track(event, { ...properties, ...options.defaultProperties });
+      return analyticsClient.track(event, { ...properties, ...defaultProperties });
     },
     async untypedTrack(event, properties) {
       if (event.match(/^[a-zA-Z0-9\s][a-zA-Z0-9\s]*$/)) {
         throw new Error("Event must be snake_case");
       }
-      return analyticsClient.track(event, { ...properties, ...options.defaultProperties });
+      return analyticsClient.track(event, {
+        ...properties,
+        ...defaultProperties
+      });
     },
-    screen: analyticsClient.screen.bind(analyticsClient),
-    group: analyticsClient.group.bind(analyticsClient),
-    identify: analyticsClient.identify.bind(analyticsClient),
-    page: analyticsClient.page ? analyticsClient.page.bind(analyticsClient) : Promise.resolve(),
-    client: analyticsClient
+    async screen(name, properties) {
+      return analyticsClient.screen(name, { ...properties, ...defaultProperties });
+    },
+    group(groupId, traits) {
+      return analyticsClient.group(groupId, { ...traits, ...defaultTraits });
+    },
+    async identify(userId, traits) {
+      return await analyticsClient.identify(userId, {
+        ...traits,
+        ...defaultTraits
+      });
+    },
+    page(category, name, properties) {
+      if (typeof analyticsClient.page === "function") {
+        return analyticsClient.page(category, name, {
+          ...properties,
+          ...defaultProperties
+        });
+      }
+      return Promise.resolve();
+    },
+    get client() {
+      return analyticsClient;
+    }
   };
 }
 
@@ -24,7 +47,7 @@ function configureAnalyticsClient({
   defaultProperties,
   defaultTraits
 }) {
-  return AnalyticsClient(client, { defaultProperties, defaultTraits });
+  return AnalyticsClient({ client, defaultProperties, defaultTraits });
 }
 export {
   configureAnalyticsClient

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/client.ts","../src/index.ts"],"sourcesContent":["import { AnalyticsClientConfig, AnalyticsClientInterface, Events, JsonMap } from './types';\n\nexport function AnalyticsClient<T extends AnalyticsClientInterface>(\n  analyticsClient: T,\n  options: Pick<AnalyticsClientConfig<T>, 'defaultProperties' | 'defaultTraits'>\n) {\n  return {\n    async track<K extends keyof Events>(\n      event: K,\n      ...properties: undefined extends Events[K] ? [] : [param: Events[K]]\n    ) {\n      return analyticsClient.track(event, { ...properties, ...options.defaultProperties });\n    },\n    async untypedTrack(event: string, properties?: JsonMap) {\n      if (event.match(/^[a-zA-Z0-9\\s][a-zA-Z0-9\\s]*$/)) {\n        throw new Error('Event must be snake_case');\n      }\n      return analyticsClient.track(event as any, { ...properties, ...options.defaultProperties });\n    },\n    screen: analyticsClient.screen.bind(analyticsClient),\n    group: analyticsClient.group.bind(analyticsClient),\n    identify: analyticsClient.identify.bind(analyticsClient),\n    page: analyticsClient.page ? analyticsClient.page.bind(analyticsClient) : Promise.resolve(),\n    client: analyticsClient,\n  };\n}\n","import { AnalyticsClient } from './client';\nimport { AnalyticsClientInterface, DefaultProperties, JsonMap } from './types';\n\nexport * from './types';\n\nexport function configureAnalyticsClient<T extends AnalyticsClientInterface>({\n  client,\n  defaultProperties,\n  defaultTraits,\n}: {\n  client: T;\n  defaultProperties: DefaultProperties;\n  defaultTraits?: JsonMap;\n}) {\n  return AnalyticsClient<T>(client, { defaultProperties, defaultTraits });\n}\n"],"mappings":";AAEO,SAAS,gBACd,iBACA,SACA;AACA,SAAO;AAAA,IACL,MAAM,MACJ,UACG,YACH;AACA,aAAO,gBAAgB,MAAM,OAAO,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IACrF;AAAA,IACA,MAAM,aAAa,OAAe,YAAsB;AACtD,UAAI,MAAM,MAAM,+BAA+B,GAAG;AAChD,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC5C;AACA,aAAO,gBAAgB,MAAM,OAAc,EAAE,GAAG,YAAY,GAAG,QAAQ,kBAAkB,CAAC;AAAA,IAC5F;AAAA,IACA,QAAQ,gBAAgB,OAAO,KAAK,eAAe;AAAA,IACnD,OAAO,gBAAgB,MAAM,KAAK,eAAe;AAAA,IACjD,UAAU,gBAAgB,SAAS,KAAK,eAAe;AAAA,IACvD,MAAM,gBAAgB,OAAO,gBAAgB,KAAK,KAAK,eAAe,IAAI,QAAQ,QAAQ;AAAA,IAC1F,QAAQ;AAAA,EACV;AACF;;;ACpBO,SAAS,yBAA6D;AAAA,EAC3E;AAAA,EACA;AAAA,EACA;AACF,GAIG;AACD,SAAO,gBAAmB,QAAQ,EAAE,mBAAmB,cAAc,CAAC;AACxE;","names":[]}
+{"version":3,"sources":["../src/client.ts","../src/index.ts"],"sourcesContent":["import { AnalyticsClientConfig, AnalyticsClientInterface, Events, JsonMap } from './types';\n\nexport function AnalyticsClient<T extends AnalyticsClientInterface>(\n  config: AnalyticsClientConfig<T>\n) {\n  const { client: analyticsClient, defaultProperties = {}, defaultTraits = {} } = config;\n\n  return {\n    async track<K extends keyof Events>(\n      event: K,\n      ...properties: undefined extends Events[K] ? [] : [param: Events[K]]\n    ) {\n      return analyticsClient.track(event, { ...properties, ...defaultProperties });\n    },\n\n    async untypedTrack(event: string, properties?: JsonMap | Record<string, unknown>) {\n      if (event.match(/^[a-zA-Z0-9\\s][a-zA-Z0-9\\s]*$/)) {\n        throw new Error('Event must be snake_case');\n      }\n      return analyticsClient.track(event as any, {\n        ...properties,\n        ...defaultProperties,\n      });\n    },\n\n    async screen(name: string, properties?: JsonMap | Record<string, unknown>) {\n      return analyticsClient.screen(name, { ...properties, ...defaultProperties });\n    },\n\n    group(groupId: string, traits?: JsonMap | Record<string, unknown>) {\n      return analyticsClient.group(groupId, { ...traits, ...defaultTraits });\n    },\n\n    async identify(userId?: string, traits?: JsonMap | Record<string, unknown>) {\n      return await analyticsClient.identify(userId, {\n        ...traits,\n        ...defaultTraits,\n      });\n    },\n\n    page(category?: string, name?: string, properties?: JsonMap | Record<string, unknown>) {\n      if (typeof analyticsClient.page === 'function') {\n        return analyticsClient.page(category, name, {\n          ...properties,\n          ...defaultProperties,\n        });\n      }\n      return Promise.resolve();\n    },\n\n    get client() {\n      return analyticsClient;\n    },\n  };\n}\n","import { AnalyticsClient } from './client';\nimport { AnalyticsClientInterface, DefaultProperties, JsonMap } from './types';\n\nexport * from './types';\n\nexport function configureAnalyticsClient<T extends AnalyticsClientInterface>({\n  client,\n  defaultProperties,\n  defaultTraits,\n}: {\n  client: T;\n  defaultProperties: DefaultProperties;\n  defaultTraits?: JsonMap;\n}) {\n  return AnalyticsClient<T>({ client, defaultProperties, defaultTraits });\n}\n"],"mappings":";AAEO,SAAS,gBACd,QACA;AACA,QAAM,EAAE,QAAQ,iBAAiB,oBAAoB,CAAC,GAAG,gBAAgB,CAAC,EAAE,IAAI;AAEhF,SAAO;AAAA,IACL,MAAM,MACJ,UACG,YACH;AACA,aAAO,gBAAgB,MAAM,OAAO,EAAE,GAAG,YAAY,GAAG,kBAAkB,CAAC;AAAA,IAC7E;AAAA,IAEA,MAAM,aAAa,OAAe,YAAgD;AAChF,UAAI,MAAM,MAAM,+BAA+B,GAAG;AAChD,cAAM,IAAI,MAAM,0BAA0B;AAAA,MAC5C;AACA,aAAO,gBAAgB,MAAM,OAAc;AAAA,QACzC,GAAG;AAAA,QACH,GAAG;AAAA,MACL,CAAC;AAAA,IACH;AAAA,IAEA,MAAM,OAAO,MAAc,YAAgD;AACzE,aAAO,gBAAgB,OAAO,MAAM,EAAE,GAAG,YAAY,GAAG,kBAAkB,CAAC;AAAA,IAC7E;AAAA,IAEA,MAAM,SAAiB,QAA4C;AACjE,aAAO,gBAAgB,MAAM,SAAS,EAAE,GAAG,QAAQ,GAAG,cAAc,CAAC;AAAA,IACvE;AAAA,IAEA,MAAM,SAAS,QAAiB,QAA4C;AAC1E,aAAO,MAAM,gBAAgB,SAAS,QAAQ;AAAA,QAC5C,GAAG;AAAA,QACH,GAAG;AAAA,MACL,CAAC;AAAA,IACH;AAAA,IAEA,KAAK,UAAmB,MAAe,YAAgD;AACrF,UAAI,OAAO,gBAAgB,SAAS,YAAY;AAC9C,eAAO,gBAAgB,KAAK,UAAU,MAAM;AAAA,UAC1C,GAAG;AAAA,UACH,GAAG;AAAA,QACL,CAAC;AAAA,MACH;AACA,aAAO,QAAQ,QAAQ;AAAA,IACzB;AAAA,IAEA,IAAI,SAAS;AACX,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACjDO,SAAS,yBAA6D;AAAA,EAC3E;AAAA,EACA;AAAA,EACA;AACF,GAIG;AACD,SAAO,gBAAmB,EAAE,QAAQ,mBAAmB,cAAc,CAAC;AACxE;","names":[]}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@leather.io/analytics",
   "author": "Leather.io contact@leather.io",
   "description": "Analytics package for Leather using Segment",
-  "version": "3.3.2",
+  "version": "3.4.0",
   "license": "MIT",
   "homepage": "https://github.com/leather.io/mono/tree/dev/packages/analytics",
   "repository": {
@@ -25,7 +25,7 @@
     "tsup": "8.1.0",
     "typescript": "5.7.3",
     "vitest": "2.1.9",
-    "@leather.io/models": "0.28.0"
+    "@leather.io/models": "0.30.0"
   },
   "files": [
     "dist"
@@ -43,6 +43,8 @@
     "build:watch": "tsup --watch --onSuccess 'tsup --dts-only'",
     "format": "prettier . --write \"src/**/*.ts\" --ignore-path ../../.prettierignore",
     "format:check": "prettier . --check \"src/**/*.ts\" --ignore-path ../../.prettierignore",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
     "typecheck": "tsc --noEmit"
   }
 }