@shware/analytics 0.1.4 → 0.1.5

package/dist/index.cjs

@@ -0,0 +1,201 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key2 of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key2) && key2 !== except)
+        __defProp(to, key2, { get: () => from[key2], enumerable: !(desc = __getOwnPropDesc(from, key2)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createTrackEventSchema: () => createTrackEventSchema,
+  createVisitorSchema: () => createVisitorSchema,
+  getVisitor: () => getVisitor,
+  setVisitor: () => setVisitor,
+  setupAnalytics: () => setupAnalytics,
+  track: () => track,
+  updateVisitorSchema: () => updateVisitorSchema
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/setup.ts
+var import_axios = __toESM(require("axios"), 1);
+var import_axios_retry = __toESM(require("axios-retry"), 1);
+var config = {
+  http: null,
+  release: "0.0.0",
+  storage: null,
+  getTags: null,
+  getDeviceId: null,
+  thirdPartyTrackers: [],
+  thirdPartyUserSetters: []
+};
+function setupAnalytics(init) {
+  config.release = init.release;
+  config.storage = init.storage;
+  config.getTags = init.getTags;
+  config.getDeviceId = init.getDeviceId;
+  config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];
+  config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];
+  config.http = import_axios.default.create({ baseURL: init.endpoint, withCredentials: true, adapter: "fetch" });
+  (0, import_axios_retry.default)(config.http, { retries: 5, retryDelay: import_axios_retry.default.exponentialDelay });
+}
+
+// src/track.ts
+var import_limiter = require("limiter");
+
+// src/visitor.ts
+var key = "visitor_id";
+async function getOrCreateVisitor() {
+  const visitorId = await config.storage.getItem(key);
+  if (visitorId) {
+    const response = await config.http.get(`/visitors/${visitorId}`);
+    return response.data;
+  } else {
+    const dto = {
+      device_id: await config.getDeviceId(),
+      properties: await config.getTags()
+    };
+    const response = await config.http.post(`/visitors`, dto);
+    await config.storage.setItem(key, response.data.id);
+    return response.data;
+  }
+}
+var visitor = null;
+var visitorFetcher = null;
+async function getVisitor() {
+  if (visitor) return visitor;
+  if (visitorFetcher) return visitorFetcher;
+  visitorFetcher = getOrCreateVisitor();
+  visitor = await visitorFetcher;
+  visitorFetcher = null;
+  return visitor;
+}
+async function setVisitor(properties) {
+  const dto = { properties };
+  const { id } = await getVisitor();
+  const response = await config.http.patch(`/visitors/${id}`, dto);
+  config.thirdPartyUserSetters.forEach((setter) => setter(properties));
+  visitor = response.data;
+  return response.data;
+}
+
+// src/track.ts
+var defaultOptions = { enableThirdPartyTracking: true };
+var REQUEST_TOKENS = 2;
+var tokenBucket = new import_limiter.TokenBucket({
+  bucketSize: 20,
+  interval: "second",
+  tokensPerInterval: 1
+});
+async function trackAsync(name, properties, trackOptions = defaultOptions) {
+  var _a, _b;
+  try {
+    await tokenBucket.removeTokens(REQUEST_TOKENS);
+    const dto = {
+      name,
+      properties,
+      tags: await config.getTags(),
+      visitor_id: (await getVisitor()).id,
+      timestamp: (/* @__PURE__ */ new Date()).toISOString()
+    };
+    const { data } = await config.http.post(`/events`, dto);
+    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;
+    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));
+    (_a = trackOptions.onSucceed) == null ? void 0 : _a.call(trackOptions, data);
+  } catch (e) {
+    if (e instanceof Error) {
+      console.log("Failed to send track event:", e.message);
+    }
+    (_b = trackOptions.onError) == null ? void 0 : _b.call(trackOptions, e);
+  }
+}
+function track(name, properties, trackOptions = defaultOptions) {
+  trackAsync(name, properties, trackOptions).catch(console.error);
+}
+
+// src/schema.ts
+var import_zod = require("zod");
+var createTrackEventSchema = import_zod.z.object({
+  name: import_zod.z.string().trim().min(1).max(64),
+  visitor_id: import_zod.z.coerce.bigint(),
+  tags: import_zod.z.object({
+    os: import_zod.z.string().optional(),
+    os_name: import_zod.z.string().optional(),
+    os_version: import_zod.z.string().optional(),
+    browser: import_zod.z.string().optional(),
+    browser_name: import_zod.z.string().optional(),
+    browser_version: import_zod.z.string().optional(),
+    platform: import_zod.z.enum(["ios", "android", "web", "macos", "windows", "linux", "unknown"]).optional(),
+    device: import_zod.z.string().optional(),
+    device_id: import_zod.z.string().trim().min(1).max(36).optional(),
+    device_type: import_zod.z.string().optional(),
+    device_vendor: import_zod.z.string().optional(),
+    device_pixel_ratio: import_zod.z.string().optional(),
+    screen_resolution: import_zod.z.string().regex(/^\d+x\d+$/).transform((v) => v).optional(),
+    release: import_zod.z.string().optional(),
+    language: import_zod.z.string().optional(),
+    timezone: import_zod.z.string().optional(),
+    environment: import_zod.z.enum(["development", "production"]).optional(),
+    source_url: import_zod.z.string().optional(),
+    source: import_zod.z.enum(["web", "app", "offline"]).optional(),
+    fbc: import_zod.z.string().optional(),
+    fbp: import_zod.z.string().optional(),
+    gclid: import_zod.z.string().optional(),
+    utm_source: import_zod.z.string().optional(),
+    utm_medium: import_zod.z.string().optional(),
+    utm_campaign: import_zod.z.string().optional(),
+    utm_term: import_zod.z.string().optional(),
+    utm_content: import_zod.z.string().optional()
+  }),
+  properties: import_zod.z.record(
+    import_zod.z.string().trim().min(1).max(128),
+    import_zod.z.union([import_zod.z.string().max(512), import_zod.z.number(), import_zod.z.boolean(), import_zod.z.null()])
+  ).refine((data) => Object.keys(data).length <= 64)
+});
+var createVisitorSchema = import_zod.z.object({
+  device_id: import_zod.z.string().trim().min(1).max(36),
+  properties: import_zod.z.record(
+    import_zod.z.string().trim().min(1).max(128),
+    import_zod.z.union([import_zod.z.string().max(512), import_zod.z.number(), import_zod.z.boolean(), import_zod.z.null()])
+  ).refine((data) => Object.keys(data).length <= 64)
+});
+var updateVisitorSchema = import_zod.z.object({
+  properties: import_zod.z.record(
+    import_zod.z.string().trim().min(1).max(128),
+    import_zod.z.union([import_zod.z.string().max(512), import_zod.z.number(), import_zod.z.boolean(), import_zod.z.null()])
+  ).refine((data) => Object.keys(data).length <= 64)
+});
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createTrackEventSchema,
+  createVisitorSchema,
+  getVisitor,
+  setVisitor,
+  setupAnalytics,
+  track,
+  updateVisitorSchema
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/setup.ts","../src/track.ts","../src/visitor.ts","../src/schema.ts"],"sourcesContent":["export { setupAnalytics } from './setup';\nexport { track } from './track';\nexport { getVisitor, setVisitor } from './visitor';\nexport { createTrackEventSchema, createVisitorSchema, updateVisitorSchema } from './schema';\nexport { type VisitorProperties, type TrackProperties, type TrackTags } from './types';\n","import axios, { AxiosInstance } from 'axios';\nimport retry from 'axios-retry';\nimport { ThirdPartyTracker, ThirdPartyUserSetter, TrackTags } from './types';\n\nexport interface Storage {\n  getItem: (key: string) => (string | null) | Promise<string | null>;\n  setItem: (key: string, value: string) => void | Promise<void>;\n}\n\nexport interface Options {\n  release: string;\n  storage: Storage;\n  endpoint: string;\n  getTags: () => TrackTags | Promise<TrackTags>;\n  getDeviceId: () => string | Promise<string>;\n  thirdPartyTrackers?: ThirdPartyTracker[];\n  thirdPartyUserSetters?: ThirdPartyUserSetter[];\n}\n\ninterface Config {\n  release: string;\n  storage: Storage;\n  http: AxiosInstance;\n  getTags: () => TrackTags | Promise<TrackTags>;\n  getDeviceId: () => string | Promise<string>;\n  thirdPartyTrackers: ThirdPartyTracker[];\n  thirdPartyUserSetters: ThirdPartyUserSetter[];\n}\n\nexport const config: Config = {\n  http: null!,\n  release: '0.0.0',\n  storage: null!,\n  getTags: null!,\n  getDeviceId: null!,\n  thirdPartyTrackers: [],\n  thirdPartyUserSetters: [],\n};\n\nexport function setupAnalytics(init: Options) {\n  config.release = init.release;\n  config.storage = init.storage;\n  config.getTags = init.getTags;\n  config.getDeviceId = init.getDeviceId;\n  config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];\n  config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];\n  config.http = axios.create({ baseURL: init.endpoint, withCredentials: true, adapter: 'fetch' });\n  retry(config.http, { retries: 5, retryDelay: retry.exponentialDelay });\n}\n","import { TokenBucket } from 'limiter';\nimport { CreateTrackEventDTO, EventName, TrackProperties, TrackEventResponse } from './types';\nimport { config } from './setup';\nimport { getVisitor } from './visitor';\n\nexport interface TrackOptions {\n  enableThirdPartyTracking?: boolean;\n  onSucceed?: (response?: TrackEventResponse) => void;\n  onError?: (error: unknown) => void;\n}\n\nconst defaultOptions: TrackOptions = { enableThirdPartyTracking: true };\n\nconst REQUEST_TOKENS = 2;\nconst tokenBucket = new TokenBucket({\n  bucketSize: 20,\n  interval: 'second',\n  tokensPerInterval: 1,\n});\n\nasync function trackAsync<T extends EventName = EventName>(\n  name: T,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  try {\n    await tokenBucket.removeTokens(REQUEST_TOKENS);\n    const dto: CreateTrackEventDTO<T> = {\n      name,\n      properties,\n      tags: await config.getTags(),\n      visitor_id: (await getVisitor()).id,\n      timestamp: new Date().toISOString(),\n    };\n    const { data } = await config.http.post<TrackEventResponse>(`/events`, dto);\n\n    // send to third-party loggers, for example Google Analytics and Facebook Pixel\n    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;\n    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));\n    trackOptions.onSucceed?.(data);\n  } catch (e: unknown) {\n    if (e instanceof Error) {\n      console.log('Failed to send track event:', e.message);\n    }\n    trackOptions.onError?.(e);\n  }\n}\n\nexport function track<T extends EventName = EventName>(\n  name: T,\n  properties?: TrackProperties<T>,\n  trackOptions: TrackOptions = defaultOptions\n) {\n  trackAsync(name, properties, trackOptions).catch(console.error);\n}\n","import { config } from './setup';\nimport type { CreateVisitorDTO, UpdateVisitorDTO, Visitor, VisitorProperties } from './types';\n\nconst key = 'visitor_id';\nasync function getOrCreateVisitor(): Promise<Visitor> {\n  const visitorId = await config.storage.getItem(key);\n  if (visitorId) {\n    const response = await config.http.get<Visitor>(`/visitors/${visitorId}`);\n    return response.data;\n  } else {\n    const dto: CreateVisitorDTO = {\n      device_id: await config.getDeviceId(),\n      properties: (await config.getTags()) as VisitorProperties,\n    };\n    const response = await config.http.post<Visitor>(`/visitors`, dto);\n    await config.storage.setItem(key, response.data.id);\n    return response.data;\n  }\n}\n\nlet visitor: Visitor | null = null;\nlet visitorFetcher: Promise<Visitor> | null = null;\n\nexport async function getVisitor(): Promise<Visitor> {\n  if (visitor) return visitor;\n  if (visitorFetcher) return visitorFetcher;\n  visitorFetcher = getOrCreateVisitor();\n  visitor = await visitorFetcher;\n  visitorFetcher = null;\n  return visitor;\n}\n\nexport async function setVisitor(properties: VisitorProperties) {\n  const dto: UpdateVisitorDTO = { properties };\n  const { id } = await getVisitor();\n  const response = await config.http.patch<Visitor>(`/visitors/${id}`, dto);\n  config.thirdPartyUserSetters.forEach((setter) => setter(properties));\n  visitor = response.data;\n  return response.data;\n}\n","import { z } from 'zod';\n\nexport const createTrackEventSchema = z.object({\n  name: z.string().trim().min(1).max(64),\n  visitor_id: z.coerce.bigint(),\n  tags: z.object({\n    os: z.string().optional(),\n    os_name: z.string().optional(),\n    os_version: z.string().optional(),\n    browser: z.string().optional(),\n    browser_name: z.string().optional(),\n    browser_version: z.string().optional(),\n    platform: z.enum(['ios', 'android', 'web', 'macos', 'windows', 'linux', 'unknown']).optional(),\n    device: z.string().optional(),\n    device_id: z.string().trim().min(1).max(36).optional(),\n    device_type: z.string().optional(),\n    device_vendor: z.string().optional(),\n    device_pixel_ratio: z.string().optional(),\n    screen_resolution: z\n      .string()\n      .regex(/^\\d+x\\d+$/)\n      .transform((v) => v as `${number}x${number}`)\n      .optional(),\n    release: z.string().optional(),\n    language: z.string().optional(),\n    timezone: z.string().optional(),\n    environment: z.enum(['development', 'production']).optional(),\n    source_url: z.string().optional(),\n    source: z.enum(['web', 'app', 'offline']).optional(),\n    fbc: z.string().optional(),\n    fbp: z.string().optional(),\n    gclid: z.string().optional(),\n    utm_source: z.string().optional(),\n    utm_medium: z.string().optional(),\n    utm_campaign: z.string().optional(),\n    utm_term: z.string().optional(),\n    utm_content: z.string().optional(),\n  }),\n  properties: z\n    .record(\n      z.string().trim().min(1).max(128),\n      z.union([z.string().max(512), z.number(), z.boolean(), z.null()])\n    )\n    .refine((data) => Object.keys(data).length <= 64),\n});\n\nexport const createVisitorSchema = z.object({\n  device_id: z.string().trim().min(1).max(36),\n  properties: z\n    .record(\n      z.string().trim().min(1).max(128),\n      z.union([z.string().max(512), z.number(), z.boolean(), z.null()])\n    )\n    .refine((data) => Object.keys(data).length <= 64),\n});\n\nexport const updateVisitorSchema = z.object({\n  properties: z\n    .record(\n      z.string().trim().min(1).max(128),\n      z.union([z.string().max(512), z.number(), z.boolean(), z.null()])\n    )\n    .refine((data) => Object.keys(data).length <= 64),\n});\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAAqC;AACrC,yBAAkB;AA4BX,IAAM,SAAiB;AAAA,EAC5B,MAAM;AAAA,EACN,SAAS;AAAA,EACT,SAAS;AAAA,EACT,SAAS;AAAA,EACT,aAAa;AAAA,EACb,oBAAoB,CAAC;AAAA,EACrB,uBAAuB,CAAC;AAC1B;AAEO,SAAS,eAAe,MAAe;AAC5C,SAAO,UAAU,KAAK;AACtB,SAAO,UAAU,KAAK;AACtB,SAAO,UAAU,KAAK;AACtB,SAAO,cAAc,KAAK;AAC1B,SAAO,qBAAqB,KAAK,sBAAsB,CAAC;AACxD,SAAO,wBAAwB,KAAK,yBAAyB,CAAC;AAC9D,SAAO,OAAO,aAAAA,QAAM,OAAO,EAAE,SAAS,KAAK,UAAU,iBAAiB,MAAM,SAAS,QAAQ,CAAC;AAC9F,yBAAAC,SAAM,OAAO,MAAM,EAAE,SAAS,GAAG,YAAY,mBAAAA,QAAM,iBAAiB,CAAC;AACvE;;;AChDA,qBAA4B;;;ACG5B,IAAM,MAAM;AACZ,eAAe,qBAAuC;AACpD,QAAM,YAAY,MAAM,OAAO,QAAQ,QAAQ,GAAG;AAClD,MAAI,WAAW;AACb,UAAM,WAAW,MAAM,OAAO,KAAK,IAAa,aAAa,SAAS,EAAE;AACxE,WAAO,SAAS;AAAA,EAClB,OAAO;AACL,UAAM,MAAwB;AAAA,MAC5B,WAAW,MAAM,OAAO,YAAY;AAAA,MACpC,YAAa,MAAM,OAAO,QAAQ;AAAA,IACpC;AACA,UAAM,WAAW,MAAM,OAAO,KAAK,KAAc,aAAa,GAAG;AACjE,UAAM,OAAO,QAAQ,QAAQ,KAAK,SAAS,KAAK,EAAE;AAClD,WAAO,SAAS;AAAA,EAClB;AACF;AAEA,IAAI,UAA0B;AAC9B,IAAI,iBAA0C;AAE9C,eAAsB,aAA+B;AACnD,MAAI,QAAS,QAAO;AACpB,MAAI,eAAgB,QAAO;AAC3B,mBAAiB,mBAAmB;AACpC,YAAU,MAAM;AAChB,mBAAiB;AACjB,SAAO;AACT;AAEA,eAAsB,WAAW,YAA+B;AAC9D,QAAM,MAAwB,EAAE,WAAW;AAC3C,QAAM,EAAE,GAAG,IAAI,MAAM,WAAW;AAChC,QAAM,WAAW,MAAM,OAAO,KAAK,MAAe,aAAa,EAAE,IAAI,GAAG;AACxE,SAAO,sBAAsB,QAAQ,CAAC,WAAW,OAAO,UAAU,CAAC;AACnE,YAAU,SAAS;AACnB,SAAO,SAAS;AAClB;;;AD5BA,IAAM,iBAA+B,EAAE,0BAA0B,KAAK;AAEtE,IAAM,iBAAiB;AACvB,IAAM,cAAc,IAAI,2BAAY;AAAA,EAClC,YAAY;AAAA,EACZ,UAAU;AAAA,EACV,mBAAmB;AACrB,CAAC;AAED,eAAe,WACb,MACA,YACA,eAA6B,gBAC7B;AAxBF;AAyBE,MAAI;AACF,UAAM,YAAY,aAAa,cAAc;AAC7C,UAAM,MAA8B;AAAA,MAClC;AAAA,MACA;AAAA,MACA,MAAM,MAAM,OAAO,QAAQ;AAAA,MAC3B,aAAa,MAAM,WAAW,GAAG;AAAA,MACjC,YAAW,oBAAI,KAAK,GAAE,YAAY;AAAA,IACpC;AACA,UAAM,EAAE,KAAK,IAAI,MAAM,OAAO,KAAK,KAAyB,WAAW,GAAG;AAG1E,QAAI,CAAC,aAAa,4BAA4B,CAAC,OAAO,mBAAoB;AAC1E,WAAO,mBAAmB,QAAQ,CAAC,YAAY,QAAQ,MAAM,YAAY,KAAK,EAAE,CAAC;AACjF,uBAAa,cAAb,sCAAyB;AAAA,EAC3B,SAAS,GAAY;AACnB,QAAI,aAAa,OAAO;AACtB,cAAQ,IAAI,+BAA+B,EAAE,OAAO;AAAA,IACtD;AACA,uBAAa,YAAb,sCAAuB;AAAA,EACzB;AACF;AAEO,SAAS,MACd,MACA,YACA,eAA6B,gBAC7B;AACA,aAAW,MAAM,YAAY,YAAY,EAAE,MAAM,QAAQ,KAAK;AAChE;;;AEtDA,iBAAkB;AAEX,IAAM,yBAAyB,aAAE,OAAO;AAAA,EAC7C,MAAM,aAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE;AAAA,EACrC,YAAY,aAAE,OAAO,OAAO;AAAA,EAC5B,MAAM,aAAE,OAAO;AAAA,IACb,IAAI,aAAE,OAAO,EAAE,SAAS;AAAA,IACxB,SAAS,aAAE,OAAO,EAAE,SAAS;AAAA,IAC7B,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,IAChC,SAAS,aAAE,OAAO,EAAE,SAAS;AAAA,IAC7B,cAAc,aAAE,OAAO,EAAE,SAAS;AAAA,IAClC,iBAAiB,aAAE,OAAO,EAAE,SAAS;AAAA,IACrC,UAAU,aAAE,KAAK,CAAC,OAAO,WAAW,OAAO,SAAS,WAAW,SAAS,SAAS,CAAC,EAAE,SAAS;AAAA,IAC7F,QAAQ,aAAE,OAAO,EAAE,SAAS;AAAA,IAC5B,WAAW,aAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,SAAS;AAAA,IACrD,aAAa,aAAE,OAAO,EAAE,SAAS;AAAA,IACjC,eAAe,aAAE,OAAO,EAAE,SAAS;AAAA,IACnC,oBAAoB,aAAE,OAAO,EAAE,SAAS;AAAA,IACxC,mBAAmB,aAChB,OAAO,EACP,MAAM,WAAW,EACjB,UAAU,CAAC,MAAM,CAA0B,EAC3C,SAAS;AAAA,IACZ,SAAS,aAAE,OAAO,EAAE,SAAS;AAAA,IAC7B,UAAU,aAAE,OAAO,EAAE,SAAS;AAAA,IAC9B,UAAU,aAAE,OAAO,EAAE,SAAS;AAAA,IAC9B,aAAa,aAAE,KAAK,CAAC,eAAe,YAAY,CAAC,EAAE,SAAS;AAAA,IAC5D,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,IAChC,QAAQ,aAAE,KAAK,CAAC,OAAO,OAAO,SAAS,CAAC,EAAE,SAAS;AAAA,IACnD,KAAK,aAAE,OAAO,EAAE,SAAS;AAAA,IACzB,KAAK,aAAE,OAAO,EAAE,SAAS;AAAA,IACzB,OAAO,aAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,IAChC,YAAY,aAAE,OAAO,EAAE,SAAS;AAAA,IAChC,cAAc,aAAE,OAAO,EAAE,SAAS;AAAA,IAClC,UAAU,aAAE,OAAO,EAAE,SAAS;AAAA,IAC9B,aAAa,aAAE,OAAO,EAAE,SAAS;AAAA,EACnC,CAAC;AAAA,EACD,YAAY,aACT;AAAA,IACC,aAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAAA,IAChC,aAAE,MAAM,CAAC,aAAE,OAAO,EAAE,IAAI,GAAG,GAAG,aAAE,OAAO,GAAG,aAAE,QAAQ,GAAG,aAAE,KAAK,CAAC,CAAC;AAAA,EAClE,EACC,OAAO,CAAC,SAAS,OAAO,KAAK,IAAI,EAAE,UAAU,EAAE;AACpD,CAAC;AAEM,IAAM,sBAAsB,aAAE,OAAO;AAAA,EAC1C,WAAW,aAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE;AAAA,EAC1C,YAAY,aACT;AAAA,IACC,aAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAAA,IAChC,aAAE,MAAM,CAAC,aAAE,OAAO,EAAE,IAAI,GAAG,GAAG,aAAE,OAAO,GAAG,aAAE,QAAQ,GAAG,aAAE,KAAK,CAAC,CAAC;AAAA,EAClE,EACC,OAAO,CAAC,SAAS,OAAO,KAAK,IAAI,EAAE,UAAU,EAAE;AACpD,CAAC;AAEM,IAAM,sBAAsB,aAAE,OAAO;AAAA,EAC1C,YAAY,aACT;AAAA,IACC,aAAE,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,EAAE,IAAI,GAAG;AAAA,IAChC,aAAE,MAAM,CAAC,aAAE,OAAO,EAAE,IAAI,GAAG,GAAG,aAAE,OAAO,GAAG,aAAE,QAAQ,GAAG,aAAE,KAAK,CAAC,CAAC;AAAA,EAClE,EACC,OAAO,CAAC,SAAS,OAAO,KAAK,IAAI,EAAE,UAAU,EAAE;AACpD,CAAC;","names":["axios","retry"]}

package/dist/{index.d.mts → index.d.cts}

@@ -1,6 +1,304 @@
-import { T as TrackTags, a as ThirdPartyTracker, b as ThirdPartyUserSetter, E as EventName, c as TrackProperties, d as TrackEventResponse, V as Visitor, e as VisitorProperties } from './shared/analytics.BsiFCGfy.mjs';
 import { z } from 'zod';
 
+interface Item {
+    item_brand?: string;
+    item_id?: string;
+    item_name?: string;
+    item_category?: string;
+    item_category2?: string;
+    item_category3?: string;
+    item_category4?: string;
+    item_category5?: string;
+    item_list_id?: string;
+    item_list_name?: string;
+    item_location_id?: string;
+    item_variant?: string;
+    quantity?: number;
+    price?: number;
+}
+/**
+ * ref: https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client_type=gtag
+ * ref: https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.Event
+ * */
+type StandardEventProperties = {
+    add_payment_info: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        payment_type?: string;
+    };
+    add_shipping_info: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        shipping_tier?: string;
+    };
+    add_to_cart: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    add_to_wishlist: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    begin_checkout: {
+        currency?: string;
+        value?: number;
+        coupon?: string;
+        items?: Item[];
+        [key: string]: any;
+    };
+    close_convert_lead: {
+        currency: string;
+        value: number;
+    };
+    close_unconvert_lead: {
+        currency: string;
+        value: number;
+        unconvert_lead_reason?: string;
+    };
+    disqualify_lead: {
+        currency: string;
+        value: number;
+        disqualified_lead_reason?: string;
+    };
+    earn_virtual_currency: {
+        virtual_currency_name: string;
+        value: number;
+    };
+    generate_lead: {
+        currency?: string;
+        value?: number;
+    };
+    join_group: {
+        group_id: string;
+    };
+    level_end: {
+        level: number;
+        success?: string;
+    };
+    level_start: {
+        level: number;
+    };
+    level_up: {
+        level: number;
+        character?: string;
+    };
+    login: {
+        method: string;
+    };
+    post_score: {
+        score: number;
+        level?: number;
+        character?: string;
+    };
+    purchase: {
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        items?: Item[];
+        shipping?: number;
+        tax?: number;
+        value?: number;
+        transaction_id?: string;
+        [key: string]: any;
+    };
+    qualify_lead: {
+        currency: string;
+        value: number;
+    };
+    refund: {
+        affiliation?: string;
+        coupon?: string;
+        currency?: string;
+        items?: Item[];
+        shipping?: number;
+        tax?: number;
+        value?: number;
+        transaction_id?: string;
+    };
+    remove_from_cart: {
+        items?: Item[];
+        value?: number;
+        currency?: string;
+    };
+    search: {
+        search_term: string;
+        number_of_nights?: number;
+        number_of_rooms?: number;
+        number_of_passengers?: number;
+        origin?: string;
+        destination?: string;
+        start_date?: string;
+        end_date?: string;
+        travel_class?: string;
+    };
+    select_content: {
+        content_type: string;
+        item_id: string;
+    };
+    select_item: {
+        items?: Item[];
+        content_type: string;
+        item_list_id: string;
+        item_list_name: string;
+    };
+    select_promotion: {
+        creative_name: string;
+        creative_slot: string;
+        items?: Item[];
+        location_id: string;
+        promotion_id: string;
+        promotion_name: string;
+    };
+    share: {
+        content_type: string;
+        item_id: string;
+        method: string;
+        activity_type?: string | null;
+        post_id?: string;
+    };
+    sign_up: {
+        method: string;
+    };
+    spend_virtual_currency: {
+        item_name: string;
+        virtual_currency_name: string;
+        value: number;
+    };
+    tutorial_begin: undefined;
+    tutorial_complete: undefined;
+    unlock_achievement: {
+        achievement_id: string;
+    };
+    view_cart: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    view_item: {
+        items?: Item[];
+        currency?: string;
+        value?: number;
+    };
+    view_item_list: {
+        items?: Item[];
+        item_list_id?: string;
+        item_list_name?: string;
+    };
+    view_promotion: {
+        items?: Item[];
+        location_id?: string;
+        creative_name?: string;
+        creative_slot?: string;
+        promotion_id?: string;
+        promotion_name?: string;
+    };
+    working_lead: {
+        currency: string;
+        value: number;
+        lead_status?: string;
+    };
+    ad_impression: {
+        value?: number;
+        currency?: string;
+        ad_format?: string;
+        ad_platform?: string;
+        ad_source?: string;
+        ad_unit_name?: string;
+    };
+    app_open: undefined;
+    campaign_details: {
+        source: string;
+        medium: string;
+        campaign: string;
+        term?: string;
+        content?: string;
+        aclid?: string;
+        cp1?: string;
+    };
+    screen_view: {
+        screen_name?: string;
+        screen_class?: string;
+    };
+    view_search_results: {
+        search_term: string;
+    };
+};
+type AllowedPropertyValues = string | number | boolean | null;
+type EventName = Lowercase<string>;
+type CustomEventProperties = Record<Lowercase<string>, AllowedPropertyValues>;
+type TrackProperties<T extends EventName = EventName> = T extends keyof StandardEventProperties ? StandardEventProperties[T] : CustomEventProperties;
+type ThirdPartyTracker = <T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, event_id?: string) => void;
+interface PlatformInfo {
+    os?: string;
+    os_name?: string;
+    os_version?: string;
+    browser?: string;
+    browser_name?: string;
+    browser_version?: string;
+    platform?: 'ios' | 'android' | 'web' | 'macos' | 'windows' | 'linux' | 'unknown';
+}
+interface DeviceInfo {
+    device?: string;
+    device_id?: string;
+    device_type?: string;
+    device_vendor?: string;
+    device_pixel_ratio?: string;
+    screen_resolution?: `${number}x${number}`;
+}
+interface EnvironmentInfo {
+    release?: string;
+    language?: string;
+    timezone?: string;
+    environment?: 'development' | 'production';
+}
+interface SourceInfo {
+    source_url?: string;
+    source?: 'app' | 'web' | 'offline';
+}
+interface ThirdPartyFields {
+    /**
+     * Meta pixel fields
+     * ref: https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/customer-information-parameters#fbc
+     * Stored in the _fbc/_fbp browser cookie under your domain
+     */
+    fbc?: string;
+    fbp?: string;
+    /**
+     * Google Analytics fields
+     */
+    gclid?: string;
+}
+interface UTMParams {
+    utm_source?: string;
+    utm_medium?: string;
+    utm_campaign?: string;
+    utm_term?: string;
+    utm_content?: string;
+}
+interface TrackTags extends PlatformInfo, DeviceInfo, EnvironmentInfo, SourceInfo, ThirdPartyFields, UTMParams {
+    [key: string]: string | undefined;
+}
+interface TrackEventResponse {
+    /**
+     * track event id
+     * some tracking system will use event_id and event_name for deduplication
+     * */
+    id: string;
+}
+type VisitorProperties = Record<Lowercase<string>, AllowedPropertyValues>;
+interface Visitor {
+    id: string;
+    device_id: string;
+    properties: VisitorProperties;
+}
+type ThirdPartyUserSetter = (properties: VisitorProperties) => void;
+
 interface Storage {
     getItem: (key: string) => (string | null) | Promise<string | null>;
     setItem: (key: string, value: string) => void | Promise<void>;
@@ -200,4 +498,4 @@ declare const updateVisitorSchema: z.ZodObject<{
     properties: Record<string, string | number | boolean | null>;
 }>;
 
-export { TrackProperties, TrackTags, VisitorProperties, createTrackEventSchema, createVisitorSchema, getVisitor, setVisitor, setupAnalytics, track, updateVisitorSchema };
+export { type TrackProperties, type TrackTags, type VisitorProperties, createTrackEventSchema, createVisitorSchema, getVisitor, setVisitor, setupAnalytics, track, updateVisitorSchema };