@xylabs/pixel 1.4.10 → 1.4.12

package/src/Pixel.ts

@@ -13,12 +13,19 @@ import { UtmFields } from './UtmFields'
 const emailHashLocalStorageName = 'xy_email_hash'
 
 export class XyPixel {
-  public pixelId?: string
+  public static api = new PixelApi()
+
+  private static _instance?: XyPixel
+  private static utmFieldsObj: UtmFields
+
+  public cid = new UniqueUserId().id
   public email?: string
   public email_hash?: string | null
-  public queue: UserEvent[] = []
-  public cid = new UniqueUserId().id
   public exids?: ExIds
+  public pixelId?: string
+
+  public queue: UserEvent[] = []
+
   private queueMutex = new Mutex()
 
   private constructor(pixelId: string) {
@@ -26,49 +33,19 @@ export class XyPixel {
     this.email_hash = localStorage.getItem(emailHashLocalStorageName)
   }
 
-  public identify(email?: string) {
-    this.email = email
-    this.email_hash = email ? md5(email) : undefined
-    if (this.email_hash) {
-      localStorage.setItem(emailHashLocalStorageName, this.email_hash)
-    }
+  public static get instance(): XyPixel {
+    return assertEx(this._instance, 'XyPixel uninitialized')
   }
 
-  private updateFbId() {
-    this.exids = {
-      ...{
-        fbc: Cookies.get('_fbc'),
-        fbp: Cookies.get('_fbp'),
-        ga: Cookies.get('_ga'),
-        gclid: Cookies.get('_gclid'),
-        rdt_uid: Cookies.get('rdt_uid'),
-        scid: Cookies.get('_scid'),
-        tt_sessionId: sessionStorage.getItem('tt_sessionId') ?? undefined,
-      },
-    }
+  public static init(pixelId: string) {
+    this._instance = new XyPixel(pixelId)
+    return this._instance
   }
 
-  private async tryFlushQueue() {
-    await this.queueMutex.runExclusive(async () => {
-      if (this.queue.length === 0) return
-      const api = XyPixel.api
-      if (api) {
-        const events = this.queue
-        this.queue = []
-        try {
-          await api.trackEvents(events)
-        } catch (ex) {
-          if (events) {
-            //put it back since it failed
-            this.queue = this.queue.concat(events)
-          }
-          console.error(ex)
-        }
-      }
-    })
+  public static selectApi(api: PixelApi) {
+    this.api = api
   }
 
-  private static utmFieldsObj: UtmFields
   private static utmFields = () => {
     if (XyPixel.utmFieldsObj === undefined) {
       XyPixel.utmFieldsObj = new UtmFields()
@@ -76,6 +53,14 @@ export class XyPixel {
     return XyPixel.utmFieldsObj
   }
 
+  public identify(email?: string) {
+    this.email = email
+    this.email_hash = email ? md5(email) : undefined
+    if (this.email_hash) {
+      localStorage.setItem(emailHashLocalStorageName, this.email_hash)
+    }
+  }
+
   public async send<T extends Record<string, unknown>>(event: string, fields?: T, eventId?: string) {
     this.updateFbId()
     const utm = XyPixel.utmFields().update()
@@ -100,18 +85,37 @@ export class XyPixel {
     await this.tryFlushQueue()
   }
 
-  private static _instance?: XyPixel
-  public static get instance(): XyPixel {
-    return assertEx(this._instance, 'XyPixel uninitialized')
-  }
-
-  public static init(pixelId: string) {
-    this._instance = new XyPixel(pixelId)
-    return this._instance
+  private async tryFlushQueue() {
+    await this.queueMutex.runExclusive(async () => {
+      if (this.queue.length === 0) return
+      const api = XyPixel.api
+      if (api) {
+        const events = this.queue
+        this.queue = []
+        try {
+          await api.trackEvents(events)
+        } catch (ex) {
+          if (events) {
+            //put it back since it failed
+            this.queue = this.queue.concat(events)
+          }
+          console.error(ex)
+        }
+      }
+    })
   }
 
-  public static api = new PixelApi()
-  public static selectApi(api: PixelApi) {
-    this.api = api
+  private updateFbId() {
+    this.exids = {
+      ...{
+        fbc: Cookies.get('_fbc'),
+        fbp: Cookies.get('_fbp'),
+        ga: Cookies.get('_ga'),
+        gclid: Cookies.get('_gclid'),
+        rdt_uid: Cookies.get('rdt_uid'),
+        scid: Cookies.get('_scid'),
+        tt_sessionId: sessionStorage.getItem('tt_sessionId') ?? undefined,
+      },
+    }
   }
 }

package/src/Referrer.ts

@@ -9,6 +9,15 @@ export class Referrer {
     window.localStorage.setItem(Referrer.storageId, this.local)
   }
 
+  public toJson() {
+    if ((this.local && this.local.length > 0) || (this.session && this.session.length > 0)) {
+      return {
+        local: this.local,
+        session: this.session,
+      }
+    }
+  }
+
   private getFromLocal() {
     const value = window.localStorage.getItem(Referrer.storageId)
     if (value && value.length > 0) {
@@ -22,13 +31,4 @@ export class Referrer {
       return value
     }
   }
-
-  public toJson() {
-    if ((this.local && this.local.length > 0) || (this.session && this.session.length > 0)) {
-      return {
-        local: this.local,
-        session: this.session,
-      }
-    }
-  }
 }

package/src/UniqueUserId.ts

@@ -3,15 +3,17 @@ import randomBytes from 'randombytes'
 export class UniqueUserId {
   private static localStorageId = '_coin_cid'
   public id: string
+
   constructor() {
     this.id = window.localStorage.getItem(UniqueUserId.localStorageId) ?? this.generateId()
     window.localStorage.setItem(UniqueUserId.localStorageId, this.id)
   }
-  private generateId() {
-    return randomBytes(16).toString('base64')
-  }
 
   public toString() {
     return this.id
   }
+
+  private generateId() {
+    return randomBytes(16).toString('base64')
+  }
 }

package/src/UserEventHandler.ts

@@ -4,8 +4,8 @@ import { UserClickFields } from './UserClickFields'
 import { ViewContentFields } from './ViewContentFields'
 
 export abstract class UserEventHandler<T> {
-  abstract testStarted(fields: T | TestStartedFields): Promise<void>
   abstract funnelStarted(fields: T | FunnelStartedFields): Promise<void>
-  abstract viewContent(fields: T | ViewContentFields): Promise<void>
+  abstract testStarted(fields: T | TestStartedFields): Promise<void>
   abstract userClick(fields: T | UserClickFields): Promise<void>
+  abstract viewContent(fields: T | ViewContentFields): Promise<void>
 }

package/src/UtmFields.ts

@@ -1,4 +1,4 @@
-import isEqual from 'lodash/isEqual'
+import { isEqual } from 'lodash-es'
 
 export class UtmFields {
   private static localStorageId = '_coin_utm'
@@ -31,6 +31,10 @@ export class UtmFields {
     return Object.keys(record).length > 0 ? record : null
   }
 
+  public toString() {
+    return JSON.stringify(this.fields)
+  }
+
   //check the query string and if there an new/updated utm values, add them to the fields
   public update() {
     const record = this.getUtmRecord()
@@ -41,8 +45,4 @@ export class UtmFields {
     }
     return this.fields ?? undefined
   }
-
-  public toString() {
-    return JSON.stringify(this.fields)
-  }
 }

package/src/XyLabsTrackingEventJson.ts

@@ -8,13 +8,13 @@ export interface XyLabsTrackingEventJson {
   exids?: Record<string, string>
   fields?: Record<string, unknown>
   host?: string
+  ip?: string
   pathname?: string
   pixel?: string
   receive_time?: number
   rid?: string
-  uid?: string
-  utm?: Record<string, string>[] | Record<string, string[]>
   system?: unknown
-  ip?: string
   ua?: string
+  uid?: string
+  utm?: Record<string, string>[] | Record<string, string[]>
 }

package/src/XyUserEventHandler.ts

@@ -9,16 +9,20 @@ export class XyUserEventHandler<T extends Record<string, unknown>> extends UserE
   constructor() {
     super()
   }
-  public async testStarted(fields: T | TestStartedFields) {
-    return await XyPixel.instance.send('TestStarted', fields)
-  }
+
   public async funnelStarted(fields: T | FunnelStartedFields) {
     return await XyPixel.instance.send('FunnelStarted', fields)
   }
-  public async viewContent(fields: T | ViewContentFields) {
-    return await XyPixel.instance.send('ViewContent', fields)
+
+  public async testStarted(fields: T | TestStartedFields) {
+    return await XyPixel.instance.send('TestStarted', fields)
   }
+
   public async userClick(fields: T | UserClickFields) {
     return await XyPixel.instance.send('ViewPage', fields)
   }
+
+  public async viewContent(fields: T | ViewContentFields) {
+    return await XyPixel.instance.send('ViewContent', fields)
+  }
 }