@xylabs/pixel 5.0.83 → 5.0.86

package/dist/browser/Api/Api.d.ts

@@ -1,7 +1,13 @@
 import type { UserEvent } from './UserEvent.ts';
+/** HTTP client for sending tracking events to the XY Labs pixel API. */
 export declare class PixelApi {
     private endPoint;
     constructor(baseUri?: string);
+    /**
+     * Sends an array of user events to the tracking API.
+     * @param events - The events to submit
+     * @returns The response data from the API
+     */
     trackEvents(events: UserEvent[]): Promise<any>;
 }
 //# sourceMappingURL=Api.d.ts.map

package/dist/browser/Api/Api.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Api.d.ts","sourceRoot":"","sources":["../../../src/Api/Api.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAQ/C,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAQ;gBAGZ,OAAO,SAAS;IAItB,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE;CAGtC"}
+{"version":3,"file":"Api.d.ts","sourceRoot":"","sources":["../../../src/Api/Api.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAQ/C,wEAAwE;AACxE,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAQ;gBAGZ,OAAO,SAAS;IAI5B;;;;OAIG;IACG,WAAW,CAAC,MAAM,EAAE,SAAS,EAAE;CAGtC"}

package/dist/browser/Api/UserEvent.d.ts

@@ -1,5 +1,6 @@
 import type { ExIds } from '../ExIds.ts';
 import type { UserEventSystem } from './UserEventSystem.ts';
+/** Represents a single user tracking event to be sent to the pixel API. */
 export interface UserEvent {
     cid: string;
     create_time?: number;

package/dist/browser/Api/UserEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserEvent.d.ts","sourceRoot":"","sources":["../../../src/Api/UserEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAC1D"}
+{"version":3,"file":"UserEvent.d.ts","sourceRoot":"","sources":["../../../src/Api/UserEvent.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAE3D,2EAA2E;AAC3E,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAA;IAC7C,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,eAAe,CAAA;IACxB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAC1D"}

package/dist/browser/Api/UserEventSystem.d.ts

@@ -1,3 +1,4 @@
 import type Bowser from 'bowser';
+/** Parsed browser/OS/engine information from the user agent string. */
 export type UserEventSystem = Bowser.Parser.ParsedResult;
 //# sourceMappingURL=UserEventSystem.d.ts.map

package/dist/browser/Api/UserEventSystem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserEventSystem.d.ts","sourceRoot":"","sources":["../../../src/Api/UserEventSystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAA"}
+{"version":3,"file":"UserEventSystem.d.ts","sourceRoot":"","sources":["../../../src/Api/UserEventSystem.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,QAAQ,CAAA;AAEhC,uEAAuE;AACvE,MAAM,MAAM,eAAe,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAA"}

package/dist/browser/CommonFields.d.ts

@@ -1,3 +1,4 @@
+/** Common fields shared across all tracking event types. */
 export interface CommonFields {
     funnel?: string;
     testData?: string;

package/dist/browser/CommonFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"CommonFields.d.ts","sourceRoot":"","sources":["../../src/CommonFields.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}
+{"version":3,"file":"CommonFields.d.ts","sourceRoot":"","sources":["../../src/CommonFields.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB"}

package/dist/browser/ExIds.d.ts

@@ -1,3 +1,4 @@
+/** External tracking identifiers from third-party cookies and sessions (Facebook, Google, TikTok, etc.). */
 export interface ExIds {
     fbc?: string;
     fbp?: string;

package/dist/browser/ExIds.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ExIds.d.ts","sourceRoot":"","sources":["../../src/ExIds.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,KAAK;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB"}
+{"version":3,"file":"ExIds.d.ts","sourceRoot":"","sources":["../../src/ExIds.ts"],"names":[],"mappings":"AAAA,4GAA4G;AAC5G,MAAM,WAAW,KAAK;IACpB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB"}

package/dist/browser/FunnelStartedFields.d.ts

@@ -1,4 +1,5 @@
 import type { CommonFields } from './CommonFields.ts';
+/** Fields for a funnel-started tracking event. */
 export interface FunnelStartedFields extends CommonFields {
     name: string;
 }

package/dist/browser/FunnelStartedFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FunnelStartedFields.d.ts","sourceRoot":"","sources":["../../src/FunnelStartedFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,MAAM,CAAA;CACb"}
+{"version":3,"file":"FunnelStartedFields.d.ts","sourceRoot":"","sources":["../../src/FunnelStartedFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,kDAAkD;AAClD,MAAM,WAAW,mBAAoB,SAAQ,YAAY;IACvD,IAAI,EAAE,MAAM,CAAA;CACb"}

package/dist/browser/Pixel.d.ts

@@ -2,6 +2,7 @@ import type { JsonObject } from '@xylabs/object';
 import type { UserEvent } from './Api/index.ts';
 import { PixelApi } from './Api/index.ts';
 import type { ExIds } from './ExIds.ts';
+/** Singleton pixel tracker that queues and sends user events to the XY Labs tracking API. */
 export declare class XyPixel {
     static api: PixelApi;
     private static _instance?;
@@ -14,11 +15,31 @@ export declare class XyPixel {
     queue: UserEvent[];
     private queueMutex;
     private constructor();
+    /** Returns the singleton XyPixel instance, throwing if not yet initialized. */
     static get instance(): XyPixel;
+    /**
+     * Initializes the XyPixel singleton with the given pixel ID.
+     * @param pixelId - The pixel identifier for this tracking instance
+     * @returns The newly created XyPixel instance
+     */
     static init(pixelId: string): XyPixel;
+    /**
+     * Replaces the default PixelApi instance used for sending events.
+     * @param api - The PixelApi instance to use
+     */
     static selectApi(api: PixelApi): void;
     private static utmFields;
+    /**
+     * Associates an email address with this pixel instance, hashing it for privacy.
+     * @param email - The email address to identify the user with
+     */
     identify(email?: string): void;
+    /**
+     * Queues a tracking event and attempts to flush the queue to the API.
+     * @param event - The event name
+     * @param fields - Optional event-specific fields
+     * @param eventId - Optional unique event identifier
+     */
     send<T extends JsonObject>(event: string, fields?: T, eventId?: string): Promise<void>;
     private tryFlushQueue;
     private updateFbId;

package/dist/browser/Pixel.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Pixel.d.ts","sourceRoot":"","sources":["../../src/Pixel.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAKhD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAQvC,qBAAa,OAAO;IAClB,MAAM,CAAC,GAAG,WAAiB;IAE3B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAS;IAClC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAW;IAEtC,GAAG,SAAwB;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,KAAK,EAAE,SAAS,EAAE,CAAK;IAEvB,OAAO,CAAC,UAAU,CAAc;IAEhC,OAAO;IAKP,MAAM,KAAK,QAAQ,IAAI,OAAO,CAE7B;IAED,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM;IAK3B,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ;IAI9B,OAAO,CAAC,MAAM,CAAC,SAAS,CAKvB;IAED,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM;IAQjB,IAAI,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM;YAsB9D,aAAa;IAqB3B,OAAO,CAAC,UAAU;CAWnB"}
+{"version":3,"file":"Pixel.d.ts","sourceRoot":"","sources":["../../src/Pixel.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAKhD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAQvC,6FAA6F;AAC7F,qBAAa,OAAO;IAClB,MAAM,CAAC,GAAG,WAAiB;IAE3B,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAS;IAClC,OAAO,CAAC,MAAM,CAAC,YAAY,CAAW;IAEtC,GAAG,SAAwB;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,KAAK,EAAE,SAAS,EAAE,CAAK;IAEvB,OAAO,CAAC,UAAU,CAAc;IAEhC,OAAO;IAKP,+EAA+E;IAC/E,MAAM,KAAK,QAAQ,IAAI,OAAO,CAE7B;IAED;;;;OAIG;IACH,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM;IAK3B;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,QAAQ;IAI9B,OAAO,CAAC,MAAM,CAAC,SAAS,CAKvB;IAED;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM;IAQvB;;;;;OAKG;IACG,IAAI,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,MAAM;YAsB9D,aAAa;IAqB3B,OAAO,CAAC,UAAU;CAWnB"}

package/dist/browser/PurchaseFields.d.ts

@@ -1,4 +1,5 @@
 import type { CommonFields } from './CommonFields.ts';
+/** Fields for a purchase tracking event. */
 export interface PurchaseFields extends CommonFields {
     id: string;
     name?: string;

package/dist/browser/PurchaseFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PurchaseFields.d.ts","sourceRoot":"","sources":["../../src/PurchaseFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}
+{"version":3,"file":"PurchaseFields.d.ts","sourceRoot":"","sources":["../../src/PurchaseFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,4CAA4C;AAC5C,MAAM,WAAW,cAAe,SAAQ,YAAY;IAClD,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}

package/dist/browser/Referrer.d.ts

@@ -1,8 +1,13 @@
+/** Tracks and persists the document referrer in both session and local storage. */
 export declare class Referrer {
     private static storageId;
     local: string;
     session: string;
     constructor();
+    /**
+     * Returns the referrer data as a JSON object, or undefined if both values are empty.
+     * @returns An object with local and session referrer strings, or undefined
+     */
     toJson(): {
         local: string;
         session: string;

package/dist/browser/Referrer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Referrer.d.ts","sourceRoot":"","sources":["../../src/Referrer.ts"],"names":[],"mappings":"AAAA,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAmB;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;;IAQf,MAAM;;;;IASN,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,cAAc;CAMvB"}
+{"version":3,"file":"Referrer.d.ts","sourceRoot":"","sources":["../../src/Referrer.ts"],"names":[],"mappings":"AAAA,mFAAmF;AACnF,qBAAa,QAAQ;IACnB,OAAO,CAAC,MAAM,CAAC,SAAS,CAAmB;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;;IAQf;;;OAGG;IACH,MAAM;;;;IASN,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,cAAc;CAMvB"}

package/dist/browser/TestStartedFields.d.ts

@@ -1,4 +1,5 @@
 import type { CommonFields } from './CommonFields.ts';
+/** Fields for a test-started tracking event (e.g. A/B test). */
 export interface TestStartedFields extends CommonFields {
     name: string;
 }

package/dist/browser/TestStartedFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TestStartedFields.d.ts","sourceRoot":"","sources":["../../src/TestStartedFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,EAAE,MAAM,CAAA;CACb"}
+{"version":3,"file":"TestStartedFields.d.ts","sourceRoot":"","sources":["../../src/TestStartedFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,gEAAgE;AAChE,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,EAAE,MAAM,CAAA;CACb"}

package/dist/browser/UniqueUserId.d.ts

@@ -1,7 +1,9 @@
+/** Generates and persists a unique user identifier in localStorage. */
 export declare class UniqueUserId {
     private static localStorageId;
     id: string;
     constructor();
+    /** Returns the unique user ID as a string. */
     toString(): string;
     private generateId;
 }

package/dist/browser/UniqueUserId.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UniqueUserId.d.ts","sourceRoot":"","sources":["../../src/UniqueUserId.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAc;IAC3C,EAAE,EAAE,MAAM,CAAA;;IAOV,QAAQ;IAIR,OAAO,CAAC,UAAU;CAGnB"}
+{"version":3,"file":"UniqueUserId.d.ts","sourceRoot":"","sources":["../../src/UniqueUserId.ts"],"names":[],"mappings":"AAAA,uEAAuE;AACvE,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAc;IAC3C,EAAE,EAAE,MAAM,CAAA;;IAOV,8CAA8C;IAC9C,QAAQ;IAIR,OAAO,CAAC,UAAU;CAGnB"}

package/dist/browser/UserClickFields.d.ts

@@ -1,4 +1,5 @@
 import type { CommonFields } from './CommonFields.ts';
+/** Fields for a user click tracking event. */
 export interface UserClickFields extends CommonFields {
     elementName: string;
     elementType: string;

package/dist/browser/UserClickFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserClickFields.d.ts","sourceRoot":"","sources":["../../src/UserClickFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}
+{"version":3,"file":"UserClickFields.d.ts","sourceRoot":"","sources":["../../src/UserClickFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,8CAA8C;AAC9C,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,WAAW,EAAE,MAAM,CAAA;IACnB,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}

package/dist/browser/UserEventHandler.d.ts

@@ -4,10 +4,15 @@ import type { FunnelStartedFields } from './FunnelStartedFields.ts';
 import type { TestStartedFields } from './TestStartedFields.ts';
 import type { UserClickFields } from './UserClickFields.ts';
 import type { ViewContentFields } from './ViewContentFields.ts';
+/** Abstract base class for handling user tracking events. */
 export declare abstract class UserEventHandler<TData extends EmptyObject> {
+    /** Tracks a funnel-started event. */
     abstract funnelStarted<T extends TData>(fields: T | FunnelStartedFields): Promisable<void>;
+    /** Tracks a test-started event. */
     abstract testStarted<T extends TData>(fields: T | TestStartedFields): Promisable<void>;
+    /** Tracks a user click event. */
     abstract userClick<T extends TData>(fields: T | UserClickFields): Promisable<void>;
+    /** Tracks a view-content event. */
     abstract viewContent<T extends TData>(fields: T | ViewContentFields): Promisable<void>;
 }
 //# sourceMappingURL=UserEventHandler.d.ts.map

package/dist/browser/UserEventHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UserEventHandler.d.ts","sourceRoot":"","sources":["../../src/UserEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,8BAAsB,gBAAgB,CAAC,KAAK,SAAS,WAAW;IAC9D,QAAQ,CAAC,aAAa,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,mBAAmB,GAAG,UAAU,CAAC,IAAI,CAAC;IAC1F,QAAQ,CAAC,WAAW,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC;IACtF,QAAQ,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC;IAClF,QAAQ,CAAC,WAAW,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC;CACvF"}
+{"version":3,"file":"UserEventHandler.d.ts","sourceRoot":"","sources":["../../src/UserEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AACjD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAA;AAEjD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,6DAA6D;AAC7D,8BAAsB,gBAAgB,CAAC,KAAK,SAAS,WAAW;IAC9D,qCAAqC;IACrC,QAAQ,CAAC,aAAa,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,mBAAmB,GAAG,UAAU,CAAC,IAAI,CAAC;IAC1F,mCAAmC;IACnC,QAAQ,CAAC,WAAW,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC;IACtF,iCAAiC;IACjC,QAAQ,CAAC,SAAS,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC;IAClF,mCAAmC;IACnC,QAAQ,CAAC,WAAW,CAAC,CAAC,SAAS,KAAK,EAAE,MAAM,EAAE,CAAC,GAAG,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC;CACvF"}

package/dist/browser/UtmFields.d.ts

@@ -1,9 +1,19 @@
+/** Tracks UTM campaign parameters from query strings, persisting history in localStorage. */
 export declare class UtmFields {
     private static localStorageId;
     fields: Record<string, string>[];
     constructor();
+    /**
+     * Parses UTM parameters from the current URL query string.
+     * @returns A record of UTM key-value pairs, or null if none are present
+     */
     getUtmRecord: () => Record<string, string> | null;
+    /** Returns the UTM fields history as a JSON string. */
     toString(): string;
+    /**
+     * Checks the query string for new UTM values and appends them to the history if changed.
+     * @returns The current UTM fields array, or undefined if empty
+     */
     update(): Record<string, string>[];
 }
 //# sourceMappingURL=UtmFields.d.ts.map

package/dist/browser/UtmFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"UtmFields.d.ts","sourceRoot":"","sources":["../../src/UtmFields.ts"],"names":[],"mappings":"AAEA,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAc;IAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAK;;IAgBrC,YAAY,sCAWX;IAED,QAAQ;IAKR,MAAM;CAOP"}
+{"version":3,"file":"UtmFields.d.ts","sourceRoot":"","sources":["../../src/UtmFields.ts"],"names":[],"mappings":"AAEA,6FAA6F;AAC7F,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAC,cAAc,CAAc;IAC3C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAK;;IAgBrC;;;OAGG;IACH,YAAY,sCAWX;IAED,uDAAuD;IACvD,QAAQ;IAIR;;;OAGG;IAEH,MAAM;CAOP"}

package/dist/browser/ViewContentFields.d.ts

@@ -1,4 +1,5 @@
 import type { CommonFields } from './CommonFields.ts';
+/** Fields for a view-content tracking event. */
 export interface ViewContentFields extends CommonFields {
     name: string;
     path: string;

package/dist/browser/ViewContentFields.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ViewContentFields.d.ts","sourceRoot":"","sources":["../../src/ViewContentFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb"}
+{"version":3,"file":"ViewContentFields.d.ts","sourceRoot":"","sources":["../../src/ViewContentFields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAErD,gDAAgD;AAChD,MAAM,WAAW,iBAAkB,SAAQ,YAAY;IACrD,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;CACb"}

package/dist/browser/XyLabsTrackingEventJson.d.ts

@@ -1,3 +1,4 @@
+/** JSON structure for an XY Labs tracking event as stored or transmitted. */
 export interface XyLabsTrackingEventJson {
     cid: string;
     create_time?: number;

package/dist/browser/XyLabsTrackingEventJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XyLabsTrackingEventJson.d.ts","sourceRoot":"","sources":["../../src/XyLabsTrackingEventJson.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAC1D"}
+{"version":3,"file":"XyLabsTrackingEventJson.d.ts","sourceRoot":"","sources":["../../src/XyLabsTrackingEventJson.ts"],"names":[],"mappings":"AAAA,6EAA6E;AAC7E,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAA;CAC1D"}

package/dist/browser/XyUserEventHandler.d.ts

@@ -5,12 +5,18 @@ import type { TestStartedFields } from './TestStartedFields.ts';
 import type { UserClickFields } from './UserClickFields.ts';
 import { UserEventHandler } from './UserEventHandler.ts';
 import type { ViewContentFields } from './ViewContentFields.ts';
+/** Concrete event handler that sends tracking events through the XyPixel singleton. */
 export declare class XyUserEventHandler<T extends EmptyObject = EmptyObject> extends UserEventHandler<T> {
     constructor();
+    /** Sends a funnel-started event via the pixel API. */
     funnelStarted(fields: T | FunnelStartedFields): Promise<void>;
+    /** Sends a purchase event via the pixel API. */
     purchase(fields: T | PurchaseFields): Promise<void>;
+    /** Sends a test-started event via the pixel API. */
     testStarted(fields: T | TestStartedFields): Promise<void>;
+    /** Sends a user click event via the pixel API. */
     userClick(fields: T | UserClickFields): Promise<void>;
+    /** Sends a view-content event via the pixel API. */
     viewContent(fields: T | ViewContentFields): Promise<void>;
 }
 //# sourceMappingURL=XyUserEventHandler.d.ts.map

package/dist/browser/XyUserEventHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"XyUserEventHandler.d.ts","sourceRoot":"","sources":["../../src/XyUserEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAoB,MAAM,gBAAgB,CAAA;AAEnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,qBAAa,kBAAkB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;;IAKxF,aAAa,CAAC,MAAM,EAAE,CAAC,GAAG,mBAAmB;IAI7C,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,cAAc;IAInC,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,iBAAiB;IAIzC,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,eAAe;IAIrC,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,iBAAiB;CAGhD"}
+{"version":3,"file":"XyUserEventHandler.d.ts","sourceRoot":"","sources":["../../src/XyUserEventHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAoB,MAAM,gBAAgB,CAAA;AAEnE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,uFAAuF;AACvF,qBAAa,kBAAkB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,gBAAgB,CAAC,CAAC,CAAC;;IAK9F,sDAAsD;IAChD,aAAa,CAAC,MAAM,EAAE,CAAC,GAAG,mBAAmB;IAInD,gDAAgD;IAC1C,QAAQ,CAAC,MAAM,EAAE,CAAC,GAAG,cAAc;IAIzC,oDAAoD;IAC9C,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,iBAAiB;IAI/C,kDAAkD;IAC5C,SAAS,CAAC,MAAM,EAAE,CAAC,GAAG,eAAe;IAI3C,oDAAoD;IAC9C,WAAW,CAAC,MAAM,EAAE,CAAC,GAAG,iBAAiB;CAGhD"}

package/dist/browser/getSystemInfo.d.ts

@@ -1,3 +1,8 @@
 import Bowser from 'bowser';
+/**
+ * Returns parsed browser, OS, and engine information from the user agent string.
+ * Results are cached after the first call.
+ * @returns The parsed system info, or undefined if parsing fails
+ */
 export declare const getSystemInfo: () => Bowser.Parser.ParsedResult | undefined;
 //# sourceMappingURL=getSystemInfo.d.ts.map

package/dist/browser/getSystemInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getSystemInfo.d.ts","sourceRoot":"","sources":["../../src/getSystemInfo.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAM3B,eAAO,MAAM,aAAa,8CAQzB,CAAA"}
+{"version":3,"file":"getSystemInfo.d.ts","sourceRoot":"","sources":["../../src/getSystemInfo.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAA;AAM3B;;;;GAIG;AACH,eAAO,MAAM,aAAa,8CAQzB,CAAA"}

package/dist/browser/index.mjs

@@ -12,6 +12,11 @@ var PixelApi = class {
   constructor(baseUri = "prod") {
     this.endPoint = isUndefined(apiBaseUri[baseUri]) ? baseUri : `${apiBaseUri[baseUri]}/t/event/queue`;
   }
+  /**
+   * Sends an array of user events to the tracking API.
+   * @param events - The events to submit
+   * @returns The response data from the API
+   */
   async trackEvents(events) {
     return (await axios.post(this.endPoint, events)).data;
   }
@@ -46,6 +51,10 @@ var Referrer = class _Referrer {
     this.local = this.getFromLocal() ?? document.referrer;
     globalThis.localStorage.setItem(_Referrer.storageId, this.local);
   }
+  /**
+   * Returns the referrer data as a JSON object, or undefined if both values are empty.
+   * @returns An object with local and session referrer strings, or undefined
+   */
   toJson() {
     if (this.local.length > 0 || this.session.length > 0) {
       return {
@@ -76,6 +85,7 @@ var UniqueUserId = class _UniqueUserId {
     this.id = globalThis.localStorage.getItem(_UniqueUserId.localStorageId) ?? this.generateId();
     globalThis.localStorage.setItem(_UniqueUserId.localStorageId, this.id);
   }
+  /** Returns the unique user ID as a string. */
   toString() {
     return this.id;
   }
@@ -102,6 +112,10 @@ var UtmFields = class _UtmFields {
     this.update();
     globalThis.localStorage.setItem(_UtmFields.localStorageId, JSON.stringify(this.fields));
   }
+  /**
+   * Parses UTM parameters from the current URL query string.
+   * @returns A record of UTM key-value pairs, or null if none are present
+   */
   getUtmRecord = () => {
     const record = {};
     const parsedQueryString = document.location.search.split("?")[1]?.split("&") ?? [];
@@ -114,9 +128,14 @@ var UtmFields = class _UtmFields {
     }
     return Object.keys(record).length > 0 ? record : null;
   };
+  /** Returns the UTM fields history as a JSON string. */
   toString() {
     return JSON.stringify(this.fields);
   }
+  /**
+   * Checks the query string for new UTM values and appends them to the history if changed.
+   * @returns The current UTM fields array, or undefined if empty
+   */
   // check the query string and if there an new/updated utm values, add them to the fields
   update() {
     const record = this.getUtmRecord();
@@ -144,13 +163,23 @@ var XyPixel = class _XyPixel {
     this.pixelId = pixelId;
     this.email_hash = localStorage.getItem(emailHashLocalStorageName);
   }
+  /** Returns the singleton XyPixel instance, throwing if not yet initialized. */
   static get instance() {
     return assertEx(this._instance, () => "XyPixel uninitialized");
   }
+  /**
+   * Initializes the XyPixel singleton with the given pixel ID.
+   * @param pixelId - The pixel identifier for this tracking instance
+   * @returns The newly created XyPixel instance
+   */
   static init(pixelId) {
     this._instance = new _XyPixel(pixelId);
     return this._instance;
   }
+  /**
+   * Replaces the default PixelApi instance used for sending events.
+   * @param api - The PixelApi instance to use
+   */
   static selectApi(api) {
     this.api = api;
   }
@@ -160,6 +189,10 @@ var XyPixel = class _XyPixel {
     }
     return this.utmFieldsObj;
   };
+  /**
+   * Associates an email address with this pixel instance, hashing it for privacy.
+   * @param email - The email address to identify the user with
+   */
   identify(email) {
     this.email = email;
     this.email_hash = email !== void 0 && email.length > 0 ? md5.hash(email, true) : void 0;
@@ -167,6 +200,12 @@ var XyPixel = class _XyPixel {
       localStorage.setItem(emailHashLocalStorageName, this.email_hash);
     }
   }
+  /**
+   * Queues a tracking event and attempts to flush the queue to the API.
+   * @param event - The event name
+   * @param fields - Optional event-specific fields
+   * @param eventId - Optional unique event identifier
+   */
   async send(event, fields, eventId) {
     this.updateFbId();
     const utm = _XyPixel.utmFields().update();
@@ -229,18 +268,23 @@ var XyUserEventHandler = class extends UserEventHandler {
   constructor() {
     super();
   }
+  /** Sends a funnel-started event via the pixel API. */
   async funnelStarted(fields) {
     return await XyPixel.instance.send("FunnelStarted", toSafeJsonObject(fields, [], 10));
   }
+  /** Sends a purchase event via the pixel API. */
   async purchase(fields) {
     return await XyPixel.instance.send("Purchase", toSafeJsonObject(fields, [], 10));
   }
+  /** Sends a test-started event via the pixel API. */
   async testStarted(fields) {
     return await XyPixel.instance.send("TestStarted", toSafeJsonObject(fields, [], 10));
   }
+  /** Sends a user click event via the pixel API. */
   async userClick(fields) {
     return await XyPixel.instance.send("ViewPage", toSafeJsonObject(fields, [], 10));
   }
+  /** Sends a view-content event via the pixel API. */
   async viewContent(fields) {
     return await XyPixel.instance.send("ViewContent", toSafeJsonObject(fields, [], 10));
   }

package/dist/browser/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/Api/Api.ts","../../src/Pixel.ts","../../src/getSystemInfo.ts","../../src/Referrer.ts","../../src/UniqueUserId.ts","../../src/UtmFields.ts","../../src/UserEventHandler.ts","../../src/XyUserEventHandler.ts"],"sourcesContent":["import { isUndefined } from '@xylabs/typeof'\nimport axios from 'axios'\n\nimport type { UserEvent } from './UserEvent.ts'\n\nconst apiBaseUri: Record<string, string> = {\n  beta: 'https://pixel.xylabs.com',\n  local: 'http://localhost:3030',\n  prod: 'https://pixel.xylabs.com',\n}\n\nexport class PixelApi {\n  private endPoint: string\n\n  /* baseUri can either be a preset (prod, beta, local), or a specific uri */\n  constructor(baseUri = 'prod') {\n    this.endPoint = isUndefined(apiBaseUri[baseUri]) ? baseUri : `${apiBaseUri[baseUri]}/t/event/queue`\n  }\n\n  async trackEvents(events: UserEvent[]) {\n    return (await axios.post(this.endPoint, events)).data\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { JsonObject } from '@xylabs/object'\nimport { Mutex } from 'async-mutex'\nimport Cookies from 'js-cookie'\nimport md5 from 'spark-md5'\n\nimport type { UserEvent } from './Api/index.ts'\nimport { PixelApi } from './Api/index.ts'\nimport type { ExIds } from './ExIds.ts'\nimport { getSystemInfo } from './getSystemInfo.ts'\nimport { Referrer } from './Referrer.ts'\nimport { UniqueUserId } from './UniqueUserId.ts'\nimport { UtmFields } from './UtmFields.ts'\n\nconst emailHashLocalStorageName = 'xy_email_hash'\n\nexport class XyPixel {\n  static api = new PixelApi()\n\n  private static _instance?: XyPixel\n  private static utmFieldsObj: UtmFields\n\n  cid = new UniqueUserId().id\n  email?: string\n  email_hash?: string | null\n  exids?: ExIds\n  pixelId?: string\n\n  queue: UserEvent[] = []\n\n  private queueMutex = new Mutex()\n\n  private constructor(pixelId: string) {\n    this.pixelId = pixelId\n    this.email_hash = localStorage.getItem(emailHashLocalStorageName)\n  }\n\n  static get instance(): XyPixel {\n    return assertEx(this._instance, () => 'XyPixel uninitialized')\n  }\n\n  static init(pixelId: string) {\n    this._instance = new XyPixel(pixelId)\n    return this._instance\n  }\n\n  static selectApi(api: PixelApi) {\n    this.api = api\n  }\n\n  private static utmFields = () => {\n    if (this.utmFieldsObj === undefined) {\n      this.utmFieldsObj = new UtmFields()\n    }\n    return this.utmFieldsObj\n  }\n\n  identify(email?: string) {\n    this.email = email\n    this.email_hash = (email !== undefined && email.length > 0) ? md5.hash(email, true) : undefined\n    if (this.email_hash !== undefined) {\n      localStorage.setItem(emailHashLocalStorageName, this.email_hash)\n    }\n  }\n\n  async send<T extends JsonObject>(event: string, fields?: T, eventId?: string) {\n    this.updateFbId()\n    const utm = XyPixel.utmFields().update()\n    const referrer = new Referrer()\n    this.queue.push({\n      cid: this.cid,\n      create_time: Date.now(),\n      email_hash: this.email_hash ?? undefined,\n      event,\n      event_id: eventId,\n      exids: this.exids,\n      fields,\n      host: document.location.host,\n      pathname: document.location.pathname,\n      pixel: this.pixelId,\n      referrer: referrer.toJson(),\n      system: getSystemInfo(),\n      utm,\n    })\n    await this.tryFlushQueue()\n  }\n\n  private async tryFlushQueue() {\n    await this.queueMutex.runExclusive(async () => {\n      if (this.queue.length === 0) return\n      const api = XyPixel.api\n      if (api !== undefined) {\n        const events = this.queue\n        this.queue = []\n        try {\n          await api.trackEvents(events)\n        } catch (ex) {\n          if (events !== undefined) {\n            // put it back since it failed\n            this.queue = [...this.queue, ...events]\n          }\n          // eslint-disable-next-line no-console\n          console.error(ex)\n        }\n      }\n    })\n  }\n\n  private updateFbId() {\n    this.exids = {\n      fbc: Cookies.get('_fbc'),\n      fbp: Cookies.get('_fbp'),\n      ga: Cookies.get('_ga'),\n      gclid: Cookies.get('_gcl_aw'),\n      rdt_uid: Cookies.get('rdt_uid'),\n      scid: Cookies.get('_scid'),\n      tt_sessionId: sessionStorage.getItem('tt_sessionId') ?? undefined,\n    }\n  }\n}\n","import Bowser from 'bowser'\n\nimport type { UserEventSystem } from './Api/index.ts'\n\nlet systemInfo: UserEventSystem | undefined\n\nexport const getSystemInfo = () => {\n  try {\n    systemInfo = systemInfo || Bowser.getParser(globalThis.navigator.userAgent).getResult()\n  } catch (ex) {\n    // eslint-disable-next-line no-console\n    console.log(`getSystemInfo Error: ${ex}`)\n  }\n  return systemInfo\n}\n","export class Referrer {\n  private static storageId = '_coin_referrer'\n  local: string\n  session: string\n  constructor() {\n    this.session = this.getFromSession() ?? document.referrer\n    sessionStorage.setItem(Referrer.storageId, this.session)\n    this.local = this.getFromLocal() ?? document.referrer\n    globalThis.localStorage.setItem(Referrer.storageId, this.local)\n  }\n\n  toJson() {\n    if ((this.local.length > 0) || (this.session.length > 0)) {\n      return {\n        local: this.local,\n        session: this.session,\n      }\n    }\n  }\n\n  private getFromLocal() {\n    const value = globalThis.localStorage.getItem(Referrer.storageId)\n    if (value !== null && value.length > 0) {\n      return value\n    }\n  }\n\n  private getFromSession() {\n    const value = sessionStorage.getItem(Referrer.storageId)\n    if (value !== null && value.length > 0) {\n      return value\n    }\n  }\n}\n","export class UniqueUserId {\n  private static localStorageId = '_coin_cid'\n  id: string\n\n  constructor() {\n    this.id = globalThis.localStorage.getItem(UniqueUserId.localStorageId) ?? this.generateId()\n    globalThis.localStorage.setItem(UniqueUserId.localStorageId, this.id)\n  }\n\n  toString() {\n    return this.id\n  }\n\n  private generateId() {\n    return crypto.randomUUID()\n  }\n}\n","import isEqual from 'fast-deep-equal'\n\nexport class UtmFields {\n  private static localStorageId = '_coin_utm'\n  fields: Record<string, string>[] = []\n  constructor() {\n    const storedString = globalThis.localStorage.getItem(UtmFields.localStorageId) ?? '[]'\n    try {\n      this.fields = JSON.parse(storedString)\n    } catch {\n      this.fields = []\n    }\n    // this clears the old object version if needed\n    if (!Array.isArray(this.fields)) {\n      this.fields = []\n    }\n    this.update()\n    globalThis.localStorage.setItem(UtmFields.localStorageId, JSON.stringify(this.fields))\n  }\n\n  getUtmRecord = () => {\n    const record: Record<string, string> = {}\n    const parsedQueryString = document.location.search.split('?')[1]?.split('&') ?? []\n    for (const item of parsedQueryString) {\n      const [fullKey, value] = item.split('=')\n      const [keyCategory, keyName] = fullKey.split('_')\n      if (keyCategory === 'utm') {\n        record[keyName] = value\n      }\n    }\n    return Object.keys(record).length > 0 ? record : null\n  }\n\n  toString() {\n    return JSON.stringify(this.fields)\n  }\n\n  // check the query string and if there an new/updated utm values, add them to the fields\n  update() {\n    const record = this.getUtmRecord()\n    if (record && !isEqual(this.fields.at(-1), record)) {\n      this.fields.push(record)\n    }\n    return this.fields ?? undefined\n  }\n}\n","import type { EmptyObject } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\n\nimport type { FunnelStartedFields } from './FunnelStartedFields.ts'\nimport type { TestStartedFields } from './TestStartedFields.ts'\nimport type { UserClickFields } from './UserClickFields.ts'\nimport type { ViewContentFields } from './ViewContentFields.ts'\n\nexport abstract class UserEventHandler<TData extends EmptyObject> {\n  abstract funnelStarted<T extends TData>(fields: T | FunnelStartedFields): Promisable<void>\n  abstract testStarted<T extends TData>(fields: T | TestStartedFields): Promisable<void>\n  abstract userClick<T extends TData>(fields: T | UserClickFields): Promisable<void>\n  abstract viewContent<T extends TData>(fields: T | ViewContentFields): Promisable<void>\n}\n","import { type EmptyObject, toSafeJsonObject } from '@xylabs/object'\n\nimport type { FunnelStartedFields } from './FunnelStartedFields.ts'\nimport { XyPixel } from './Pixel.ts'\nimport type { PurchaseFields } from './PurchaseFields.ts'\nimport type { TestStartedFields } from './TestStartedFields.ts'\nimport type { UserClickFields } from './UserClickFields.ts'\nimport { UserEventHandler } from './UserEventHandler.ts'\nimport type { ViewContentFields } from './ViewContentFields.ts'\n\nexport class XyUserEventHandler<T extends EmptyObject = EmptyObject> extends UserEventHandler<T> {\n  constructor() {\n    super()\n  }\n\n  async funnelStarted(fields: T | FunnelStartedFields) {\n    return await XyPixel.instance.send('FunnelStarted', toSafeJsonObject(fields, [], 10))\n  }\n\n  async purchase(fields: T | PurchaseFields) {\n    return await XyPixel.instance.send('Purchase', toSafeJsonObject(fields, [], 10))\n  }\n\n  async testStarted(fields: T | TestStartedFields) {\n    return await XyPixel.instance.send('TestStarted', toSafeJsonObject(fields, [], 10))\n  }\n\n  async userClick(fields: T | UserClickFields) {\n    return await XyPixel.instance.send('ViewPage', toSafeJsonObject(fields, [], 10))\n  }\n\n  async viewContent(fields: T | ViewContentFields) {\n    return await XyPixel.instance.send('ViewContent', toSafeJsonObject(fields, [], 10))\n  }\n}\n"],"mappings":";AAAA,SAAS,mBAAmB;AAC5B,OAAO,WAAW;AAIlB,IAAM,aAAqC;AAAA,EACzC,MAAM;AAAA,EACN,OAAO;AAAA,EACP,MAAM;AACR;AAEO,IAAM,WAAN,MAAe;AAAA,EACZ;AAAA;AAAA,EAGR,YAAY,UAAU,QAAQ;AAC5B,SAAK,WAAW,YAAY,WAAW,OAAO,CAAC,IAAI,UAAU,GAAG,WAAW,OAAO,CAAC;AAAA,EACrF;AAAA,EAEA,MAAM,YAAY,QAAqB;AACrC,YAAQ,MAAM,MAAM,KAAK,KAAK,UAAU,MAAM,GAAG;AAAA,EACnD;AACF;;;ACtBA,SAAS,gBAAgB;AAEzB,SAAS,aAAa;AACtB,OAAO,aAAa;AACpB,OAAO,SAAS;;;ACJhB,OAAO,YAAY;AAInB,IAAI;AAEG,IAAM,gBAAgB,MAAM;AACjC,MAAI;AACF,iBAAa,cAAc,OAAO,UAAU,WAAW,UAAU,SAAS,EAAE,UAAU;AAAA,EACxF,SAAS,IAAI;AAEX,YAAQ,IAAI,wBAAwB,EAAE,EAAE;AAAA,EAC1C;AACA,SAAO;AACT;;;ACdO,IAAM,WAAN,MAAM,UAAS;AAAA,EACpB,OAAe,YAAY;AAAA,EAC3B;AAAA,EACA;AAAA,EACA,cAAc;AACZ,SAAK,UAAU,KAAK,eAAe,KAAK,SAAS;AACjD,mBAAe,QAAQ,UAAS,WAAW,KAAK,OAAO;AACvD,SAAK,QAAQ,KAAK,aAAa,KAAK,SAAS;AAC7C,eAAW,aAAa,QAAQ,UAAS,WAAW,KAAK,KAAK;AAAA,EAChE;AAAA,EAEA,SAAS;AACP,QAAK,KAAK,MAAM,SAAS,KAAO,KAAK,QAAQ,SAAS,GAAI;AACxD,aAAO;AAAA,QACL,OAAO,KAAK;AAAA,QACZ,SAAS,KAAK;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,eAAe;AACrB,UAAM,QAAQ,WAAW,aAAa,QAAQ,UAAS,SAAS;AAChE,QAAI,UAAU,QAAQ,MAAM,SAAS,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEQ,iBAAiB;AACvB,UAAM,QAAQ,eAAe,QAAQ,UAAS,SAAS;AACvD,QAAI,UAAU,QAAQ,MAAM,SAAS,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACjCO,IAAM,eAAN,MAAM,cAAa;AAAA,EACxB,OAAe,iBAAiB;AAAA,EAChC;AAAA,EAEA,cAAc;AACZ,SAAK,KAAK,WAAW,aAAa,QAAQ,cAAa,cAAc,KAAK,KAAK,WAAW;AAC1F,eAAW,aAAa,QAAQ,cAAa,gBAAgB,KAAK,EAAE;AAAA,EACtE;AAAA,EAEA,WAAW;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,aAAa;AACnB,WAAO,OAAO,WAAW;AAAA,EAC3B;AACF;;;AChBA,OAAO,aAAa;AAEb,IAAM,YAAN,MAAM,WAAU;AAAA,EACrB,OAAe,iBAAiB;AAAA,EAChC,SAAmC,CAAC;AAAA,EACpC,cAAc;AACZ,UAAM,eAAe,WAAW,aAAa,QAAQ,WAAU,cAAc,KAAK;AAClF,QAAI;AACF,WAAK,SAAS,KAAK,MAAM,YAAY;AAAA,IACvC,QAAQ;AACN,WAAK,SAAS,CAAC;AAAA,IACjB;AAEA,QAAI,CAAC,MAAM,QAAQ,KAAK,MAAM,GAAG;AAC/B,WAAK,SAAS,CAAC;AAAA,IACjB;AACA,SAAK,OAAO;AACZ,eAAW,aAAa,QAAQ,WAAU,gBAAgB,KAAK,UAAU,KAAK,MAAM,CAAC;AAAA,EACvF;AAAA,EAEA,eAAe,MAAM;AACnB,UAAM,SAAiC,CAAC;AACxC,UAAM,oBAAoB,SAAS,SAAS,OAAO,MAAM,GAAG,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AACjF,eAAW,QAAQ,mBAAmB;AACpC,YAAM,CAAC,SAAS,KAAK,IAAI,KAAK,MAAM,GAAG;AACvC,YAAM,CAAC,aAAa,OAAO,IAAI,QAAQ,MAAM,GAAG;AAChD,UAAI,gBAAgB,OAAO;AACzB,eAAO,OAAO,IAAI;AAAA,MACpB;AAAA,IACF;AACA,WAAO,OAAO,KAAK,MAAM,EAAE,SAAS,IAAI,SAAS;AAAA,EACnD;AAAA,EAEA,WAAW;AACT,WAAO,KAAK,UAAU,KAAK,MAAM;AAAA,EACnC;AAAA;AAAA,EAGA,SAAS;AACP,UAAM,SAAS,KAAK,aAAa;AACjC,QAAI,UAAU,CAAC,QAAQ,KAAK,OAAO,GAAG,EAAE,GAAG,MAAM,GAAG;AAClD,WAAK,OAAO,KAAK,MAAM;AAAA,IACzB;AACA,WAAO,KAAK,UAAU;AAAA,EACxB;AACF;;;AJ/BA,IAAM,4BAA4B;AAE3B,IAAM,UAAN,MAAM,SAAQ;AAAA,EACnB,OAAO,MAAM,IAAI,SAAS;AAAA,EAE1B,OAAe;AAAA,EACf,OAAe;AAAA,EAEf,MAAM,IAAI,aAAa,EAAE;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,QAAqB,CAAC;AAAA,EAEd,aAAa,IAAI,MAAM;AAAA,EAEvB,YAAY,SAAiB;AACnC,SAAK,UAAU;AACf,SAAK,aAAa,aAAa,QAAQ,yBAAyB;AAAA,EAClE;AAAA,EAEA,WAAW,WAAoB;AAC7B,WAAO,SAAS,KAAK,WAAW,MAAM,uBAAuB;AAAA,EAC/D;AAAA,EAEA,OAAO,KAAK,SAAiB;AAC3B,SAAK,YAAY,IAAI,SAAQ,OAAO;AACpC,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,OAAO,UAAU,KAAe;AAC9B,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,OAAe,YAAY,MAAM;AAC/B,QAAI,KAAK,iBAAiB,QAAW;AACnC,WAAK,eAAe,IAAI,UAAU;AAAA,IACpC;AACA,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,SAAS,OAAgB;AACvB,SAAK,QAAQ;AACb,SAAK,aAAc,UAAU,UAAa,MAAM,SAAS,IAAK,IAAI,KAAK,OAAO,IAAI,IAAI;AACtF,QAAI,KAAK,eAAe,QAAW;AACjC,mBAAa,QAAQ,2BAA2B,KAAK,UAAU;AAAA,IACjE;AAAA,EACF;AAAA,EAEA,MAAM,KAA2B,OAAe,QAAY,SAAkB;AAC5E,SAAK,WAAW;AAChB,UAAM,MAAM,SAAQ,UAAU,EAAE,OAAO;AACvC,UAAM,WAAW,IAAI,SAAS;AAC9B,SAAK,MAAM,KAAK;AAAA,MACd,KAAK,KAAK;AAAA,MACV,aAAa,KAAK,IAAI;AAAA,MACtB,YAAY,KAAK,cAAc;AAAA,MAC/B;AAAA,MACA,UAAU;AAAA,MACV,OAAO,KAAK;AAAA,MACZ;AAAA,MACA,MAAM,SAAS,SAAS;AAAA,MACxB,UAAU,SAAS,SAAS;AAAA,MAC5B,OAAO,KAAK;AAAA,MACZ,UAAU,SAAS,OAAO;AAAA,MAC1B,QAAQ,cAAc;AAAA,MACtB;AAAA,IACF,CAAC;AACD,UAAM,KAAK,cAAc;AAAA,EAC3B;AAAA,EAEA,MAAc,gBAAgB;AAC5B,UAAM,KAAK,WAAW,aAAa,YAAY;AAC7C,UAAI,KAAK,MAAM,WAAW,EAAG;AAC7B,YAAM,MAAM,SAAQ;AACpB,UAAI,QAAQ,QAAW;AACrB,cAAM,SAAS,KAAK;AACpB,aAAK,QAAQ,CAAC;AACd,YAAI;AACF,gBAAM,IAAI,YAAY,MAAM;AAAA,QAC9B,SAAS,IAAI;AACX,cAAI,WAAW,QAAW;AAExB,iBAAK,QAAQ,CAAC,GAAG,KAAK,OAAO,GAAG,MAAM;AAAA,UACxC;AAEA,kBAAQ,MAAM,EAAE;AAAA,QAClB;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,aAAa;AACnB,SAAK,QAAQ;AAAA,MACX,KAAK,QAAQ,IAAI,MAAM;AAAA,MACvB,KAAK,QAAQ,IAAI,MAAM;AAAA,MACvB,IAAI,QAAQ,IAAI,KAAK;AAAA,MACrB,OAAO,QAAQ,IAAI,SAAS;AAAA,MAC5B,SAAS,QAAQ,IAAI,SAAS;AAAA,MAC9B,MAAM,QAAQ,IAAI,OAAO;AAAA,MACzB,cAAc,eAAe,QAAQ,cAAc,KAAK;AAAA,IAC1D;AAAA,EACF;AACF;;;AK/GO,IAAe,mBAAf,MAA2D;AAKlE;;;ACbA,SAA2B,wBAAwB;AAU5C,IAAM,qBAAN,cAAsE,iBAAoB;AAAA,EAC/F,cAAc;AACZ,UAAM;AAAA,EACR;AAAA,EAEA,MAAM,cAAc,QAAiC;AACnD,WAAO,MAAM,QAAQ,SAAS,KAAK,iBAAiB,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACtF;AAAA,EAEA,MAAM,SAAS,QAA4B;AACzC,WAAO,MAAM,QAAQ,SAAS,KAAK,YAAY,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACjF;AAAA,EAEA,MAAM,YAAY,QAA+B;AAC/C,WAAO,MAAM,QAAQ,SAAS,KAAK,eAAe,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACpF;AAAA,EAEA,MAAM,UAAU,QAA6B;AAC3C,WAAO,MAAM,QAAQ,SAAS,KAAK,YAAY,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACjF;AAAA,EAEA,MAAM,YAAY,QAA+B;AAC/C,WAAO,MAAM,QAAQ,SAAS,KAAK,eAAe,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACpF;AACF;","names":[]}
+{"version":3,"sources":["../../src/Api/Api.ts","../../src/Pixel.ts","../../src/getSystemInfo.ts","../../src/Referrer.ts","../../src/UniqueUserId.ts","../../src/UtmFields.ts","../../src/UserEventHandler.ts","../../src/XyUserEventHandler.ts"],"sourcesContent":["import { isUndefined } from '@xylabs/typeof'\nimport axios from 'axios'\n\nimport type { UserEvent } from './UserEvent.ts'\n\nconst apiBaseUri: Record<string, string> = {\n  beta: 'https://pixel.xylabs.com',\n  local: 'http://localhost:3030',\n  prod: 'https://pixel.xylabs.com',\n}\n\n/** HTTP client for sending tracking events to the XY Labs pixel API. */\nexport class PixelApi {\n  private endPoint: string\n\n  /* baseUri can either be a preset (prod, beta, local), or a specific uri */\n  constructor(baseUri = 'prod') {\n    this.endPoint = isUndefined(apiBaseUri[baseUri]) ? baseUri : `${apiBaseUri[baseUri]}/t/event/queue`\n  }\n\n  /**\n   * Sends an array of user events to the tracking API.\n   * @param events - The events to submit\n   * @returns The response data from the API\n   */\n  async trackEvents(events: UserEvent[]) {\n    return (await axios.post(this.endPoint, events)).data\n  }\n}\n","import { assertEx } from '@xylabs/assert'\nimport type { JsonObject } from '@xylabs/object'\nimport { Mutex } from 'async-mutex'\nimport Cookies from 'js-cookie'\nimport md5 from 'spark-md5'\n\nimport type { UserEvent } from './Api/index.ts'\nimport { PixelApi } from './Api/index.ts'\nimport type { ExIds } from './ExIds.ts'\nimport { getSystemInfo } from './getSystemInfo.ts'\nimport { Referrer } from './Referrer.ts'\nimport { UniqueUserId } from './UniqueUserId.ts'\nimport { UtmFields } from './UtmFields.ts'\n\nconst emailHashLocalStorageName = 'xy_email_hash'\n\n/** Singleton pixel tracker that queues and sends user events to the XY Labs tracking API. */\nexport class XyPixel {\n  static api = new PixelApi()\n\n  private static _instance?: XyPixel\n  private static utmFieldsObj: UtmFields\n\n  cid = new UniqueUserId().id\n  email?: string\n  email_hash?: string | null\n  exids?: ExIds\n  pixelId?: string\n\n  queue: UserEvent[] = []\n\n  private queueMutex = new Mutex()\n\n  private constructor(pixelId: string) {\n    this.pixelId = pixelId\n    this.email_hash = localStorage.getItem(emailHashLocalStorageName)\n  }\n\n  /** Returns the singleton XyPixel instance, throwing if not yet initialized. */\n  static get instance(): XyPixel {\n    return assertEx(this._instance, () => 'XyPixel uninitialized')\n  }\n\n  /**\n   * Initializes the XyPixel singleton with the given pixel ID.\n   * @param pixelId - The pixel identifier for this tracking instance\n   * @returns The newly created XyPixel instance\n   */\n  static init(pixelId: string) {\n    this._instance = new XyPixel(pixelId)\n    return this._instance\n  }\n\n  /**\n   * Replaces the default PixelApi instance used for sending events.\n   * @param api - The PixelApi instance to use\n   */\n  static selectApi(api: PixelApi) {\n    this.api = api\n  }\n\n  private static utmFields = () => {\n    if (this.utmFieldsObj === undefined) {\n      this.utmFieldsObj = new UtmFields()\n    }\n    return this.utmFieldsObj\n  }\n\n  /**\n   * Associates an email address with this pixel instance, hashing it for privacy.\n   * @param email - The email address to identify the user with\n   */\n  identify(email?: string) {\n    this.email = email\n    this.email_hash = (email !== undefined && email.length > 0) ? md5.hash(email, true) : undefined\n    if (this.email_hash !== undefined) {\n      localStorage.setItem(emailHashLocalStorageName, this.email_hash)\n    }\n  }\n\n  /**\n   * Queues a tracking event and attempts to flush the queue to the API.\n   * @param event - The event name\n   * @param fields - Optional event-specific fields\n   * @param eventId - Optional unique event identifier\n   */\n  async send<T extends JsonObject>(event: string, fields?: T, eventId?: string) {\n    this.updateFbId()\n    const utm = XyPixel.utmFields().update()\n    const referrer = new Referrer()\n    this.queue.push({\n      cid: this.cid,\n      create_time: Date.now(),\n      email_hash: this.email_hash ?? undefined,\n      event,\n      event_id: eventId,\n      exids: this.exids,\n      fields,\n      host: document.location.host,\n      pathname: document.location.pathname,\n      pixel: this.pixelId,\n      referrer: referrer.toJson(),\n      system: getSystemInfo(),\n      utm,\n    })\n    await this.tryFlushQueue()\n  }\n\n  private async tryFlushQueue() {\n    await this.queueMutex.runExclusive(async () => {\n      if (this.queue.length === 0) return\n      const api = XyPixel.api\n      if (api !== undefined) {\n        const events = this.queue\n        this.queue = []\n        try {\n          await api.trackEvents(events)\n        } catch (ex) {\n          if (events !== undefined) {\n            // put it back since it failed\n            this.queue = [...this.queue, ...events]\n          }\n          // eslint-disable-next-line no-console\n          console.error(ex)\n        }\n      }\n    })\n  }\n\n  private updateFbId() {\n    this.exids = {\n      fbc: Cookies.get('_fbc'),\n      fbp: Cookies.get('_fbp'),\n      ga: Cookies.get('_ga'),\n      gclid: Cookies.get('_gcl_aw'),\n      rdt_uid: Cookies.get('rdt_uid'),\n      scid: Cookies.get('_scid'),\n      tt_sessionId: sessionStorage.getItem('tt_sessionId') ?? undefined,\n    }\n  }\n}\n","import Bowser from 'bowser'\n\nimport type { UserEventSystem } from './Api/index.ts'\n\nlet systemInfo: UserEventSystem | undefined\n\n/**\n * Returns parsed browser, OS, and engine information from the user agent string.\n * Results are cached after the first call.\n * @returns The parsed system info, or undefined if parsing fails\n */\nexport const getSystemInfo = () => {\n  try {\n    systemInfo = systemInfo || Bowser.getParser(globalThis.navigator.userAgent).getResult()\n  } catch (ex) {\n    // eslint-disable-next-line no-console\n    console.log(`getSystemInfo Error: ${ex}`)\n  }\n  return systemInfo\n}\n","/** Tracks and persists the document referrer in both session and local storage. */\nexport class Referrer {\n  private static storageId = '_coin_referrer'\n  local: string\n  session: string\n  constructor() {\n    this.session = this.getFromSession() ?? document.referrer\n    sessionStorage.setItem(Referrer.storageId, this.session)\n    this.local = this.getFromLocal() ?? document.referrer\n    globalThis.localStorage.setItem(Referrer.storageId, this.local)\n  }\n\n  /**\n   * Returns the referrer data as a JSON object, or undefined if both values are empty.\n   * @returns An object with local and session referrer strings, or undefined\n   */\n  toJson() {\n    if ((this.local.length > 0) || (this.session.length > 0)) {\n      return {\n        local: this.local,\n        session: this.session,\n      }\n    }\n  }\n\n  private getFromLocal() {\n    const value = globalThis.localStorage.getItem(Referrer.storageId)\n    if (value !== null && value.length > 0) {\n      return value\n    }\n  }\n\n  private getFromSession() {\n    const value = sessionStorage.getItem(Referrer.storageId)\n    if (value !== null && value.length > 0) {\n      return value\n    }\n  }\n}\n","/** Generates and persists a unique user identifier in localStorage. */\nexport class UniqueUserId {\n  private static localStorageId = '_coin_cid'\n  id: string\n\n  constructor() {\n    this.id = globalThis.localStorage.getItem(UniqueUserId.localStorageId) ?? this.generateId()\n    globalThis.localStorage.setItem(UniqueUserId.localStorageId, this.id)\n  }\n\n  /** Returns the unique user ID as a string. */\n  toString() {\n    return this.id\n  }\n\n  private generateId() {\n    return crypto.randomUUID()\n  }\n}\n","import isEqual from 'fast-deep-equal'\n\n/** Tracks UTM campaign parameters from query strings, persisting history in localStorage. */\nexport class UtmFields {\n  private static localStorageId = '_coin_utm'\n  fields: Record<string, string>[] = []\n  constructor() {\n    const storedString = globalThis.localStorage.getItem(UtmFields.localStorageId) ?? '[]'\n    try {\n      this.fields = JSON.parse(storedString)\n    } catch {\n      this.fields = []\n    }\n    // this clears the old object version if needed\n    if (!Array.isArray(this.fields)) {\n      this.fields = []\n    }\n    this.update()\n    globalThis.localStorage.setItem(UtmFields.localStorageId, JSON.stringify(this.fields))\n  }\n\n  /**\n   * Parses UTM parameters from the current URL query string.\n   * @returns A record of UTM key-value pairs, or null if none are present\n   */\n  getUtmRecord = () => {\n    const record: Record<string, string> = {}\n    const parsedQueryString = document.location.search.split('?')[1]?.split('&') ?? []\n    for (const item of parsedQueryString) {\n      const [fullKey, value] = item.split('=')\n      const [keyCategory, keyName] = fullKey.split('_')\n      if (keyCategory === 'utm') {\n        record[keyName] = value\n      }\n    }\n    return Object.keys(record).length > 0 ? record : null\n  }\n\n  /** Returns the UTM fields history as a JSON string. */\n  toString() {\n    return JSON.stringify(this.fields)\n  }\n\n  /**\n   * Checks the query string for new UTM values and appends them to the history if changed.\n   * @returns The current UTM fields array, or undefined if empty\n   */\n  // check the query string and if there an new/updated utm values, add them to the fields\n  update() {\n    const record = this.getUtmRecord()\n    if (record && !isEqual(this.fields.at(-1), record)) {\n      this.fields.push(record)\n    }\n    return this.fields ?? undefined\n  }\n}\n","import type { EmptyObject } from '@xylabs/object'\nimport type { Promisable } from '@xylabs/promise'\n\nimport type { FunnelStartedFields } from './FunnelStartedFields.ts'\nimport type { TestStartedFields } from './TestStartedFields.ts'\nimport type { UserClickFields } from './UserClickFields.ts'\nimport type { ViewContentFields } from './ViewContentFields.ts'\n\n/** Abstract base class for handling user tracking events. */\nexport abstract class UserEventHandler<TData extends EmptyObject> {\n  /** Tracks a funnel-started event. */\n  abstract funnelStarted<T extends TData>(fields: T | FunnelStartedFields): Promisable<void>\n  /** Tracks a test-started event. */\n  abstract testStarted<T extends TData>(fields: T | TestStartedFields): Promisable<void>\n  /** Tracks a user click event. */\n  abstract userClick<T extends TData>(fields: T | UserClickFields): Promisable<void>\n  /** Tracks a view-content event. */\n  abstract viewContent<T extends TData>(fields: T | ViewContentFields): Promisable<void>\n}\n","import { type EmptyObject, toSafeJsonObject } from '@xylabs/object'\n\nimport type { FunnelStartedFields } from './FunnelStartedFields.ts'\nimport { XyPixel } from './Pixel.ts'\nimport type { PurchaseFields } from './PurchaseFields.ts'\nimport type { TestStartedFields } from './TestStartedFields.ts'\nimport type { UserClickFields } from './UserClickFields.ts'\nimport { UserEventHandler } from './UserEventHandler.ts'\nimport type { ViewContentFields } from './ViewContentFields.ts'\n\n/** Concrete event handler that sends tracking events through the XyPixel singleton. */\nexport class XyUserEventHandler<T extends EmptyObject = EmptyObject> extends UserEventHandler<T> {\n  constructor() {\n    super()\n  }\n\n  /** Sends a funnel-started event via the pixel API. */\n  async funnelStarted(fields: T | FunnelStartedFields) {\n    return await XyPixel.instance.send('FunnelStarted', toSafeJsonObject(fields, [], 10))\n  }\n\n  /** Sends a purchase event via the pixel API. */\n  async purchase(fields: T | PurchaseFields) {\n    return await XyPixel.instance.send('Purchase', toSafeJsonObject(fields, [], 10))\n  }\n\n  /** Sends a test-started event via the pixel API. */\n  async testStarted(fields: T | TestStartedFields) {\n    return await XyPixel.instance.send('TestStarted', toSafeJsonObject(fields, [], 10))\n  }\n\n  /** Sends a user click event via the pixel API. */\n  async userClick(fields: T | UserClickFields) {\n    return await XyPixel.instance.send('ViewPage', toSafeJsonObject(fields, [], 10))\n  }\n\n  /** Sends a view-content event via the pixel API. */\n  async viewContent(fields: T | ViewContentFields) {\n    return await XyPixel.instance.send('ViewContent', toSafeJsonObject(fields, [], 10))\n  }\n}\n"],"mappings":";AAAA,SAAS,mBAAmB;AAC5B,OAAO,WAAW;AAIlB,IAAM,aAAqC;AAAA,EACzC,MAAM;AAAA,EACN,OAAO;AAAA,EACP,MAAM;AACR;AAGO,IAAM,WAAN,MAAe;AAAA,EACZ;AAAA;AAAA,EAGR,YAAY,UAAU,QAAQ;AAC5B,SAAK,WAAW,YAAY,WAAW,OAAO,CAAC,IAAI,UAAU,GAAG,WAAW,OAAO,CAAC;AAAA,EACrF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,YAAY,QAAqB;AACrC,YAAQ,MAAM,MAAM,KAAK,KAAK,UAAU,MAAM,GAAG;AAAA,EACnD;AACF;;;AC5BA,SAAS,gBAAgB;AAEzB,SAAS,aAAa;AACtB,OAAO,aAAa;AACpB,OAAO,SAAS;;;ACJhB,OAAO,YAAY;AAInB,IAAI;AAOG,IAAM,gBAAgB,MAAM;AACjC,MAAI;AACF,iBAAa,cAAc,OAAO,UAAU,WAAW,UAAU,SAAS,EAAE,UAAU;AAAA,EACxF,SAAS,IAAI;AAEX,YAAQ,IAAI,wBAAwB,EAAE,EAAE;AAAA,EAC1C;AACA,SAAO;AACT;;;AClBO,IAAM,WAAN,MAAM,UAAS;AAAA,EACpB,OAAe,YAAY;AAAA,EAC3B;AAAA,EACA;AAAA,EACA,cAAc;AACZ,SAAK,UAAU,KAAK,eAAe,KAAK,SAAS;AACjD,mBAAe,QAAQ,UAAS,WAAW,KAAK,OAAO;AACvD,SAAK,QAAQ,KAAK,aAAa,KAAK,SAAS;AAC7C,eAAW,aAAa,QAAQ,UAAS,WAAW,KAAK,KAAK;AAAA,EAChE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS;AACP,QAAK,KAAK,MAAM,SAAS,KAAO,KAAK,QAAQ,SAAS,GAAI;AACxD,aAAO;AAAA,QACL,OAAO,KAAK;AAAA,QACZ,SAAS,KAAK;AAAA,MAChB;AAAA,IACF;AAAA,EACF;AAAA,EAEQ,eAAe;AACrB,UAAM,QAAQ,WAAW,aAAa,QAAQ,UAAS,SAAS;AAChE,QAAI,UAAU,QAAQ,MAAM,SAAS,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AAAA,EAEQ,iBAAiB;AACvB,UAAM,QAAQ,eAAe,QAAQ,UAAS,SAAS;AACvD,QAAI,UAAU,QAAQ,MAAM,SAAS,GAAG;AACtC,aAAO;AAAA,IACT;AAAA,EACF;AACF;;;ACrCO,IAAM,eAAN,MAAM,cAAa;AAAA,EACxB,OAAe,iBAAiB;AAAA,EAChC;AAAA,EAEA,cAAc;AACZ,SAAK,KAAK,WAAW,aAAa,QAAQ,cAAa,cAAc,KAAK,KAAK,WAAW;AAC1F,eAAW,aAAa,QAAQ,cAAa,gBAAgB,KAAK,EAAE;AAAA,EACtE;AAAA;AAAA,EAGA,WAAW;AACT,WAAO,KAAK;AAAA,EACd;AAAA,EAEQ,aAAa;AACnB,WAAO,OAAO,WAAW;AAAA,EAC3B;AACF;;;AClBA,OAAO,aAAa;AAGb,IAAM,YAAN,MAAM,WAAU;AAAA,EACrB,OAAe,iBAAiB;AAAA,EAChC,SAAmC,CAAC;AAAA,EACpC,cAAc;AACZ,UAAM,eAAe,WAAW,aAAa,QAAQ,WAAU,cAAc,KAAK;AAClF,QAAI;AACF,WAAK,SAAS,KAAK,MAAM,YAAY;AAAA,IACvC,QAAQ;AACN,WAAK,SAAS,CAAC;AAAA,IACjB;AAEA,QAAI,CAAC,MAAM,QAAQ,KAAK,MAAM,GAAG;AAC/B,WAAK,SAAS,CAAC;AAAA,IACjB;AACA,SAAK,OAAO;AACZ,eAAW,aAAa,QAAQ,WAAU,gBAAgB,KAAK,UAAU,KAAK,MAAM,CAAC;AAAA,EACvF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,eAAe,MAAM;AACnB,UAAM,SAAiC,CAAC;AACxC,UAAM,oBAAoB,SAAS,SAAS,OAAO,MAAM,GAAG,EAAE,CAAC,GAAG,MAAM,GAAG,KAAK,CAAC;AACjF,eAAW,QAAQ,mBAAmB;AACpC,YAAM,CAAC,SAAS,KAAK,IAAI,KAAK,MAAM,GAAG;AACvC,YAAM,CAAC,aAAa,OAAO,IAAI,QAAQ,MAAM,GAAG;AAChD,UAAI,gBAAgB,OAAO;AACzB,eAAO,OAAO,IAAI;AAAA,MACpB;AAAA,IACF;AACA,WAAO,OAAO,KAAK,MAAM,EAAE,SAAS,IAAI,SAAS;AAAA,EACnD;AAAA;AAAA,EAGA,WAAW;AACT,WAAO,KAAK,UAAU,KAAK,MAAM;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAS;AACP,UAAM,SAAS,KAAK,aAAa;AACjC,QAAI,UAAU,CAAC,QAAQ,KAAK,OAAO,GAAG,EAAE,GAAG,MAAM,GAAG;AAClD,WAAK,OAAO,KAAK,MAAM;AAAA,IACzB;AACA,WAAO,KAAK,UAAU;AAAA,EACxB;AACF;;;AJzCA,IAAM,4BAA4B;AAG3B,IAAM,UAAN,MAAM,SAAQ;AAAA,EACnB,OAAO,MAAM,IAAI,SAAS;AAAA,EAE1B,OAAe;AAAA,EACf,OAAe;AAAA,EAEf,MAAM,IAAI,aAAa,EAAE;AAAA,EACzB;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EAEA,QAAqB,CAAC;AAAA,EAEd,aAAa,IAAI,MAAM;AAAA,EAEvB,YAAY,SAAiB;AACnC,SAAK,UAAU;AACf,SAAK,aAAa,aAAa,QAAQ,yBAAyB;AAAA,EAClE;AAAA;AAAA,EAGA,WAAW,WAAoB;AAC7B,WAAO,SAAS,KAAK,WAAW,MAAM,uBAAuB;AAAA,EAC/D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,OAAO,KAAK,SAAiB;AAC3B,SAAK,YAAY,IAAI,SAAQ,OAAO;AACpC,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,OAAO,UAAU,KAAe;AAC9B,SAAK,MAAM;AAAA,EACb;AAAA,EAEA,OAAe,YAAY,MAAM;AAC/B,QAAI,KAAK,iBAAiB,QAAW;AACnC,WAAK,eAAe,IAAI,UAAU;AAAA,IACpC;AACA,WAAO,KAAK;AAAA,EACd;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAS,OAAgB;AACvB,SAAK,QAAQ;AACb,SAAK,aAAc,UAAU,UAAa,MAAM,SAAS,IAAK,IAAI,KAAK,OAAO,IAAI,IAAI;AACtF,QAAI,KAAK,eAAe,QAAW;AACjC,mBAAa,QAAQ,2BAA2B,KAAK,UAAU;AAAA,IACjE;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,KAA2B,OAAe,QAAY,SAAkB;AAC5E,SAAK,WAAW;AAChB,UAAM,MAAM,SAAQ,UAAU,EAAE,OAAO;AACvC,UAAM,WAAW,IAAI,SAAS;AAC9B,SAAK,MAAM,KAAK;AAAA,MACd,KAAK,KAAK;AAAA,MACV,aAAa,KAAK,IAAI;AAAA,MACtB,YAAY,KAAK,cAAc;AAAA,MAC/B;AAAA,MACA,UAAU;AAAA,MACV,OAAO,KAAK;AAAA,MACZ;AAAA,MACA,MAAM,SAAS,SAAS;AAAA,MACxB,UAAU,SAAS,SAAS;AAAA,MAC5B,OAAO,KAAK;AAAA,MACZ,UAAU,SAAS,OAAO;AAAA,MAC1B,QAAQ,cAAc;AAAA,MACtB;AAAA,IACF,CAAC;AACD,UAAM,KAAK,cAAc;AAAA,EAC3B;AAAA,EAEA,MAAc,gBAAgB;AAC5B,UAAM,KAAK,WAAW,aAAa,YAAY;AAC7C,UAAI,KAAK,MAAM,WAAW,EAAG;AAC7B,YAAM,MAAM,SAAQ;AACpB,UAAI,QAAQ,QAAW;AACrB,cAAM,SAAS,KAAK;AACpB,aAAK,QAAQ,CAAC;AACd,YAAI;AACF,gBAAM,IAAI,YAAY,MAAM;AAAA,QAC9B,SAAS,IAAI;AACX,cAAI,WAAW,QAAW;AAExB,iBAAK,QAAQ,CAAC,GAAG,KAAK,OAAO,GAAG,MAAM;AAAA,UACxC;AAEA,kBAAQ,MAAM,EAAE;AAAA,QAClB;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA,EAEQ,aAAa;AACnB,SAAK,QAAQ;AAAA,MACX,KAAK,QAAQ,IAAI,MAAM;AAAA,MACvB,KAAK,QAAQ,IAAI,MAAM;AAAA,MACvB,IAAI,QAAQ,IAAI,KAAK;AAAA,MACrB,OAAO,QAAQ,IAAI,SAAS;AAAA,MAC5B,SAAS,QAAQ,IAAI,SAAS;AAAA,MAC9B,MAAM,QAAQ,IAAI,OAAO;AAAA,MACzB,cAAc,eAAe,QAAQ,cAAc,KAAK;AAAA,IAC1D;AAAA,EACF;AACF;;;AKnIO,IAAe,mBAAf,MAA2D;AASlE;;;AClBA,SAA2B,wBAAwB;AAW5C,IAAM,qBAAN,cAAsE,iBAAoB;AAAA,EAC/F,cAAc;AACZ,UAAM;AAAA,EACR;AAAA;AAAA,EAGA,MAAM,cAAc,QAAiC;AACnD,WAAO,MAAM,QAAQ,SAAS,KAAK,iBAAiB,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACtF;AAAA;AAAA,EAGA,MAAM,SAAS,QAA4B;AACzC,WAAO,MAAM,QAAQ,SAAS,KAAK,YAAY,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACjF;AAAA;AAAA,EAGA,MAAM,YAAY,QAA+B;AAC/C,WAAO,MAAM,QAAQ,SAAS,KAAK,eAAe,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACpF;AAAA;AAAA,EAGA,MAAM,UAAU,QAA6B;AAC3C,WAAO,MAAM,QAAQ,SAAS,KAAK,YAAY,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACjF;AAAA;AAAA,EAGA,MAAM,YAAY,QAA+B;AAC/C,WAAO,MAAM,QAAQ,SAAS,KAAK,eAAe,iBAAiB,QAAQ,CAAC,GAAG,EAAE,CAAC;AAAA,EACpF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/pixel",
-  "version": "5.0.83",
+  "version": "5.0.86",
   "description": "Event Client for xylabs ESB",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -35,10 +35,10 @@
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.83",
-    "@xylabs/object": "~5.0.83",
-    "@xylabs/promise": "~5.0.83",
-    "@xylabs/typeof": "~5.0.83",
+    "@xylabs/assert": "~5.0.86",
+    "@xylabs/object": "~5.0.86",
+    "@xylabs/promise": "~5.0.86",
+    "@xylabs/typeof": "~5.0.86",
     "async-mutex": "~0.5.0",
     "bowser": "2.14.1",
     "fast-deep-equal": "~3.1.3",
@@ -49,9 +49,9 @@
     "@types/js-cookie": "~3.0.6",
     "@types/node": "~25.4.0",
     "@types/spark-md5": "~3.0.5",
-    "@xylabs/ts-scripts-yarn3": "~7.4.11",
-    "@xylabs/tsconfig": "~7.4.11",
-    "@xylabs/tsconfig-dom": "~7.4.11",
+    "@xylabs/ts-scripts-yarn3": "~7.4.16",
+    "@xylabs/tsconfig": "~7.4.16",
+    "@xylabs/tsconfig-dom": "~7.4.16",
     "axios": "^1.13.6",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"