@shware/analytics 0.0.8 → 0.1.1

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { T as TrackTags, a as ThirdPartyLogger, E as EventName, b as TrackProperties, c as TrackEventResponse, V as Visitor, d as VisitorProperties } from './shared/analytics.CbeSxKlP.mjs';
+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 Storage {
     getItem: (key: string) => (string | null) | Promise<string | null>;
@@ -10,12 +11,13 @@ interface Options {
     endpoint: string;
     getTags: () => TrackTags | Promise<TrackTags>;
     getDeviceId: () => string | Promise<string>;
-    thirdPartyLoggers?: ThirdPartyLogger[];
+    thirdPartyTrackers?: ThirdPartyTracker[];
+    thirdPartyUserSetters?: ThirdPartyUserSetter[];
 }
 declare function setupAnalytics(init: Options): void;
 
 interface TrackOptions {
-    enableThirdPartyLogging?: boolean;
+    enableThirdPartyTracking?: boolean;
     onSucceed?: (response?: TrackEventResponse) => void;
     onError?: (error: unknown) => void;
 }
@@ -24,4 +26,168 @@ declare function track<T extends EventName = EventName>(name: T, properties?: Tr
 declare function getVisitor(): Promise<Visitor>;
 declare function setVisitor(properties: VisitorProperties): Promise<Visitor>;
 
-export { TrackProperties, TrackTags, VisitorProperties, getVisitor, setVisitor, setupAnalytics, track };
+declare const createTrackEventSchema: z.ZodObject<{
+    name: z.ZodString;
+    tags: z.ZodObject<{
+        os: z.ZodOptional<z.ZodString>;
+        os_name: z.ZodOptional<z.ZodString>;
+        os_version: z.ZodOptional<z.ZodString>;
+        browser: z.ZodOptional<z.ZodString>;
+        browser_name: z.ZodOptional<z.ZodString>;
+        browser_version: z.ZodOptional<z.ZodString>;
+        platform: z.ZodOptional<z.ZodEnum<["ios", "android", "web", "macos", "windows", "linux", "unknown"]>>;
+        device: z.ZodOptional<z.ZodString>;
+        device_id: z.ZodOptional<z.ZodString>;
+        device_type: z.ZodOptional<z.ZodString>;
+        device_vendor: z.ZodOptional<z.ZodString>;
+        device_pixel_ratio: z.ZodOptional<z.ZodString>;
+        screen_resolution: z.ZodOptional<z.ZodEffects<z.ZodString, `${number}x${number}`, string>>;
+        release: z.ZodOptional<z.ZodString>;
+        language: z.ZodOptional<z.ZodString>;
+        timezone: z.ZodOptional<z.ZodString>;
+        environment: z.ZodOptional<z.ZodEnum<["development", "production"]>>;
+        source_url: z.ZodOptional<z.ZodString>;
+        source: z.ZodOptional<z.ZodEnum<["web", "app", "offline"]>>;
+        fbc: z.ZodOptional<z.ZodString>;
+        fbp: z.ZodOptional<z.ZodString>;
+        gclid: z.ZodOptional<z.ZodString>;
+        utm_source: z.ZodOptional<z.ZodString>;
+        utm_medium: z.ZodOptional<z.ZodString>;
+        utm_campaign: z.ZodOptional<z.ZodString>;
+        utm_term: z.ZodOptional<z.ZodString>;
+        utm_content: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        os?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        browser?: string | undefined;
+        browser_name?: string | undefined;
+        browser_version?: string | undefined;
+        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
+        device?: string | undefined;
+        device_id?: string | undefined;
+        device_type?: string | undefined;
+        device_vendor?: string | undefined;
+        device_pixel_ratio?: string | undefined;
+        screen_resolution?: `${number}x${number}` | undefined;
+        release?: string | undefined;
+        language?: string | undefined;
+        timezone?: string | undefined;
+        environment?: "development" | "production" | undefined;
+        source_url?: string | undefined;
+        source?: "web" | "app" | "offline" | undefined;
+        fbc?: string | undefined;
+        fbp?: string | undefined;
+        gclid?: string | undefined;
+        utm_source?: string | undefined;
+        utm_medium?: string | undefined;
+        utm_campaign?: string | undefined;
+        utm_term?: string | undefined;
+        utm_content?: string | undefined;
+    }, {
+        os?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        browser?: string | undefined;
+        browser_name?: string | undefined;
+        browser_version?: string | undefined;
+        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
+        device?: string | undefined;
+        device_id?: string | undefined;
+        device_type?: string | undefined;
+        device_vendor?: string | undefined;
+        device_pixel_ratio?: string | undefined;
+        screen_resolution?: string | undefined;
+        release?: string | undefined;
+        language?: string | undefined;
+        timezone?: string | undefined;
+        environment?: "development" | "production" | undefined;
+        source_url?: string | undefined;
+        source?: "web" | "app" | "offline" | undefined;
+        fbc?: string | undefined;
+        fbp?: string | undefined;
+        gclid?: string | undefined;
+        utm_source?: string | undefined;
+        utm_medium?: string | undefined;
+        utm_campaign?: string | undefined;
+        utm_term?: string | undefined;
+        utm_content?: string | undefined;
+    }>;
+    properties: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    tags: {
+        os?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        browser?: string | undefined;
+        browser_name?: string | undefined;
+        browser_version?: string | undefined;
+        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
+        device?: string | undefined;
+        device_id?: string | undefined;
+        device_type?: string | undefined;
+        device_vendor?: string | undefined;
+        device_pixel_ratio?: string | undefined;
+        screen_resolution?: `${number}x${number}` | undefined;
+        release?: string | undefined;
+        language?: string | undefined;
+        timezone?: string | undefined;
+        environment?: "development" | "production" | undefined;
+        source_url?: string | undefined;
+        source?: "web" | "app" | "offline" | undefined;
+        fbc?: string | undefined;
+        fbp?: string | undefined;
+        gclid?: string | undefined;
+        utm_source?: string | undefined;
+        utm_medium?: string | undefined;
+        utm_campaign?: string | undefined;
+        utm_term?: string | undefined;
+        utm_content?: string | undefined;
+    };
+    properties: Record<string, string | number | boolean | null>;
+}, {
+    name: string;
+    tags: {
+        os?: string | undefined;
+        os_name?: string | undefined;
+        os_version?: string | undefined;
+        browser?: string | undefined;
+        browser_name?: string | undefined;
+        browser_version?: string | undefined;
+        platform?: "ios" | "android" | "web" | "macos" | "windows" | "linux" | "unknown" | undefined;
+        device?: string | undefined;
+        device_id?: string | undefined;
+        device_type?: string | undefined;
+        device_vendor?: string | undefined;
+        device_pixel_ratio?: string | undefined;
+        screen_resolution?: string | undefined;
+        release?: string | undefined;
+        language?: string | undefined;
+        timezone?: string | undefined;
+        environment?: "development" | "production" | undefined;
+        source_url?: string | undefined;
+        source?: "web" | "app" | "offline" | undefined;
+        fbc?: string | undefined;
+        fbp?: string | undefined;
+        gclid?: string | undefined;
+        utm_source?: string | undefined;
+        utm_medium?: string | undefined;
+        utm_campaign?: string | undefined;
+        utm_term?: string | undefined;
+        utm_content?: string | undefined;
+    };
+    properties: Record<string, string | number | boolean | null>;
+}>;
+declare const createVisitorSchema: z.ZodObject<{
+    device_id: z.ZodString;
+    properties: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean, z.ZodNull]>>;
+}, "strip", z.ZodTypeAny, {
+    device_id: string;
+    properties: Record<string, string | number | boolean | null>;
+}, {
+    device_id: string;
+    properties: Record<string, string | number | boolean | null>;
+}>;
+
+export { TrackProperties, TrackTags, VisitorProperties, createTrackEventSchema, createVisitorSchema, getVisitor, setVisitor, setupAnalytics, track };

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import axios from 'axios';
 import retry from 'axios-retry';
 import { TokenBucket } from 'limiter';
+import { z } from 'zod';
 
 const config = {
   http: null,
@@ -8,14 +9,16 @@ const config = {
   storage: null,
   getTags: null,
   getDeviceId: null,
-  thirdPartyLoggers: []
+  thirdPartyTrackers: [],
+  thirdPartyUserSetters: []
 };
 function setupAnalytics(init) {
   config.release = init.release;
   config.storage = init.storage;
   config.getTags = init.getTags;
   config.getDeviceId = init.getDeviceId;
-  config.thirdPartyLoggers = init.thirdPartyLoggers ?? [];
+  config.thirdPartyTrackers = init.thirdPartyTrackers ?? [];
+  config.thirdPartyUserSetters = init.thirdPartyUserSetters ?? [];
   config.http = axios.create({ baseURL: init.endpoint, withCredentials: true, adapter: "fetch" });
   retry(config.http, { retries: 5, retryDelay: retry.exponentialDelay });
 }
@@ -50,11 +53,12 @@ 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;
 }
 
-const defaultOptions = { enableThirdPartyLogging: true };
+const defaultOptions = { enableThirdPartyTracking: true };
 const REQUEST_TOKENS = 2;
 const tokenBucket = new TokenBucket({
   bucketSize: 20,
@@ -72,8 +76,8 @@ async function trackAsync(name, properties, trackOptions = defaultOptions) {
       timestamp: (/* @__PURE__ */ new Date()).toISOString()
     };
     const { data } = await config.http.post(`/events`, dto);
-    if (!trackOptions.enableThirdPartyLogging || !config.thirdPartyLoggers) return;
-    config.thirdPartyLoggers.forEach((logger) => logger(name, properties, data.id));
+    if (!trackOptions.enableThirdPartyTracking || !config.thirdPartyTrackers) return;
+    config.thirdPartyTrackers.forEach((tracker) => tracker(name, properties, data.id));
     trackOptions.onSucceed?.(data);
   } catch (e) {
     if (e instanceof Error) {
@@ -86,4 +90,48 @@ function track(name, properties, trackOptions = defaultOptions) {
   trackAsync(name, properties, trackOptions).catch(console.error);
 }
 
-export { getVisitor, setVisitor, setupAnalytics, track };
+const createTrackEventSchema = z.object({
+  name: z.string().trim().min(1).max(64),
+  tags: z.object({
+    os: z.string().optional(),
+    os_name: z.string().optional(),
+    os_version: z.string().optional(),
+    browser: z.string().optional(),
+    browser_name: z.string().optional(),
+    browser_version: z.string().optional(),
+    platform: z.enum(["ios", "android", "web", "macos", "windows", "linux", "unknown"]).optional(),
+    device: z.string().optional(),
+    device_id: z.string().trim().min(1).max(36).optional(),
+    device_type: z.string().optional(),
+    device_vendor: z.string().optional(),
+    device_pixel_ratio: z.string().optional(),
+    screen_resolution: z.string().regex(/^\d+x\d+$/).transform((v) => v).optional(),
+    release: z.string().optional(),
+    language: z.string().optional(),
+    timezone: z.string().optional(),
+    environment: z.enum(["development", "production"]).optional(),
+    source_url: z.string().optional(),
+    source: z.enum(["web", "app", "offline"]).optional(),
+    fbc: z.string().optional(),
+    fbp: z.string().optional(),
+    gclid: z.string().optional(),
+    utm_source: z.string().optional(),
+    utm_medium: z.string().optional(),
+    utm_campaign: z.string().optional(),
+    utm_term: z.string().optional(),
+    utm_content: z.string().optional()
+  }),
+  properties: z.record(
+    z.string().trim().min(1).max(128),
+    z.union([z.string(), z.number(), z.boolean(), z.null()])
+  )
+});
+const createVisitorSchema = z.object({
+  device_id: z.string().trim().min(1).max(36),
+  properties: z.record(
+    z.string().trim().min(1).max(128),
+    z.union([z.string(), z.number(), z.boolean(), z.null()])
+  )
+});
+
+export { createTrackEventSchema, createVisitorSchema, getVisitor, setVisitor, setupAnalytics, track };

package/dist/shared/{analytics.CbeSxKlP.d.mts → analytics.BsiFCGfy.d.mts}

@@ -231,7 +231,7 @@ 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 ThirdPartyLogger = <T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, event_id?: string) => void;
+type ThirdPartyTracker = <T extends EventName = EventName>(name: T, properties?: TrackProperties<T>, event_id?: string) => void;
 interface PlatformInfo {
     os?: string;
     os_name?: string;
@@ -267,8 +267,19 @@ interface ThirdPartyFields {
      */
     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 {
+interface TrackTags extends PlatformInfo, DeviceInfo, EnvironmentInfo, SourceInfo, ThirdPartyFields, UTMParams {
     [key: string]: string | undefined;
 }
 interface TrackEventResponse {
@@ -278,11 +289,12 @@ interface TrackEventResponse {
      * */
     id: string;
 }
-type VisitorProperties = Record<Lowercase<string>, AllowedPropertyValues | AllowedPropertyValues[] | undefined>;
+type VisitorProperties = Record<Lowercase<string>, AllowedPropertyValues>;
 interface Visitor {
     id: string;
     device_id: string;
     properties: VisitorProperties;
 }
+type ThirdPartyUserSetter = (properties: VisitorProperties) => void;
 
-export type { EventName as E, TrackTags as T, Visitor as V, ThirdPartyLogger as a, TrackProperties as b, TrackEventResponse as c, VisitorProperties as d };
+export type { EventName as E, TrackTags as T, Visitor as V, ThirdPartyTracker as a, ThirdPartyUserSetter as b, TrackProperties as c, TrackEventResponse as d, VisitorProperties as e };

package/dist/web.d.mts

@@ -1,4 +1,4 @@
-import { T as TrackTags } from './shared/analytics.CbeSxKlP.mjs';
+import { T as TrackTags } from './shared/analytics.BsiFCGfy.mjs';
 
 declare function getDeviceId(): string;
 declare function getTags(release: string): TrackTags;

package/dist/web.mjs

@@ -11,6 +11,7 @@ function getDeviceId() {
 }
 function getTags(release) {
   const parser = Bowser.getParser(window.navigator.userAgent);
+  const params = new URLSearchParams(window.location.search);
   const os = parser.getOS();
   const browser = parser.getBrowser();
   const platform = parser.getPlatform();
@@ -34,7 +35,13 @@ function getTags(release) {
     timezone: Intl.DateTimeFormat().resolvedOptions().timeZone,
     environment: process.env.NODE_ENV === "development" ? "development" : "production",
     fbc: parsed._fbc,
-    fbp: parsed._fbp
+    fbp: parsed._fbp,
+    gclid: params.get("gclid") ?? void 0,
+    utm_source: params.get("utm_source") ?? void 0,
+    utm_medium: params.get("utm_medium") ?? void 0,
+    utm_campaign: params.get("utm_campaign") ?? void 0,
+    utm_term: params.get("utm_term") ?? void 0,
+    utm_content: params.get("utm_content") ?? void 0
   };
   return tags;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shware/analytics",
-  "version": "0.0.8",
+  "version": "0.1.1",
   "type": "module",
   "scripts": {
     "dev": "tsc --watch",
@@ -22,7 +22,8 @@
     "bowser": "^2.11.0",
     "cookie": "^1.0.2",
     "limiter": "^3.0.0",
-    "uuid": "^11.1.0"
+    "uuid": "^11.1.0",
+    "zod": "^3.24.2"
   },
   "devDependencies": {
     "@types/node": "^22.13.10",