@xylabs/pixel 5.0.1 → 5.0.3

package/dist/browser/index.mjs

@@ -155,10 +155,10 @@ var XyPixel = class _XyPixel {
     this.api = api;
   }
   static utmFields = () => {
-    if (_XyPixel.utmFieldsObj === void 0) {
-      _XyPixel.utmFieldsObj = new UtmFields();
+    if (this.utmFieldsObj === void 0) {
+      this.utmFieldsObj = new UtmFields();
     }
-    return _XyPixel.utmFieldsObj;
+    return this.utmFieldsObj;
   };
   identify(email) {
     this.email = email;

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 (XyPixel.utmFieldsObj === undefined) {\n      XyPixel.utmFieldsObj = new UtmFields()\n    }\n    return XyPixel.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,SAAQ,iBAAiB,QAAW;AACtC,eAAQ,eAAe,IAAI,UAAU;AAAA,IACvC;AACA,WAAO,SAAQ;AAAA,EACjB;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\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":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/pixel",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "description": "Event Client for xylabs ESB",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -35,10 +35,10 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.1",
-    "@xylabs/object": "~5.0.1",
-    "@xylabs/promise": "~5.0.1",
-    "@xylabs/typeof": "~5.0.1",
+    "@xylabs/assert": "~5.0.3",
+    "@xylabs/object": "~5.0.3",
+    "@xylabs/promise": "~5.0.3",
+    "@xylabs/typeof": "~5.0.3",
     "async-mutex": "~0.5.0",
     "axios": "~1.11.0",
     "bowser": "~2.11.0",
@@ -48,10 +48,10 @@
   },
   "devDependencies": {
     "@types/js-cookie": "~3.0.6",
-    "@types/node": "~24.1.0",
+    "@types/node": "~24.2.0",
     "@types/spark-md5": "~3.0.5",
-    "@xylabs/ts-scripts-yarn3": "~7.0.3",
-    "@xylabs/tsconfig-dom": "~7.0.3",
+    "@xylabs/ts-scripts-yarn3": "~7.1.0",
+    "@xylabs/tsconfig-dom": "~7.1.0",
     "axios": "~1.11.0",
     "typescript": "~5.9.2",
     "vitest": "~3.2.4"

package/src/Pixel.ts

@@ -49,10 +49,10 @@ export class XyPixel {
   }
 
   private static utmFields = () => {
-    if (XyPixel.utmFieldsObj === undefined) {
-      XyPixel.utmFieldsObj = new UtmFields()
+    if (this.utmFieldsObj === undefined) {
+      this.utmFieldsObj = new UtmFields()
     }
-    return XyPixel.utmFieldsObj
+    return this.utmFieldsObj
   }
 
   identify(email?: string) {