@xylabs/pixel 5.0.80 → 5.0.82

package/README.md

@@ -59,12 +59,12 @@ Event Client for xylabs ESB
 ### Constructor
 
 ```ts
-new PixelApi(baseUri): PixelApi;
+new PixelApi(baseUri?): PixelApi;
 ```
 
 ### Parameters
 
-#### baseUri
+#### baseUri?
 
 `string` = `'prod'`
 
@@ -130,20 +130,20 @@ session: string;
 
 ```ts
 toJson(): 
-  | undefined
   | {
   local: string;
   session: string;
-};
+}
+  | undefined;
 ```
 
 ### Returns
 
-  \| `undefined`
   \| \{
   `local`: `string`;
   `session`: `string`;
 \}
+  \| `undefined`
 
   ### <a id="UniqueUserId"></a>UniqueUserId
 
@@ -338,12 +338,12 @@ fields: Record<string, string>[] = [];
 ### getUtmRecord()
 
 ```ts
-getUtmRecord(): null | Record<string, string>;
+getUtmRecord(): Record<string, string> | null;
 ```
 
 ### Returns
 
-`null` \| `Record`\<`string`, `string`\>
+`Record`\<`string`, `string`\> \| `null`
 
 ***
 
@@ -404,7 +404,7 @@ optional email: string;
 ### email\_hash?
 
 ```ts
-optional email_hash: null | string;
+optional email_hash: string | null;
 ```
 
 ***
@@ -514,7 +514,7 @@ eventId?): Promise<void>;
 
 #### T
 
-`T` *extends* `JsonObject`
+`T` *extends* `Record`\<`string`, `unknown`\>
 
 ### Parameters
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/pixel",
-  "version": "5.0.80",
+  "version": "5.0.82",
   "description": "Event Client for xylabs ESB",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -22,26 +22,23 @@
   "exports": {
     ".": {
       "types": "./dist/browser/index.d.ts",
-      "source": "./src/index.ts",
       "default": "./dist/browser/index.mjs"
     },
     "./package.json": "./package.json"
   },
   "module": "./dist/browser/index.mjs",
-  "source": "./src/index.ts",
   "types": "./dist/browser/index.d.ts",
   "files": [
     "dist",
-    "src",
     "!**/*.bench.*",
     "!**/*.spec.*",
     "!**/*.test.*"
   ],
   "dependencies": {
-    "@xylabs/assert": "~5.0.80",
-    "@xylabs/object": "~5.0.80",
-    "@xylabs/promise": "~5.0.80",
-    "@xylabs/typeof": "~5.0.80",
+    "@xylabs/assert": "~5.0.82",
+    "@xylabs/object": "~5.0.82",
+    "@xylabs/promise": "~5.0.82",
+    "@xylabs/typeof": "~5.0.82",
     "async-mutex": "~0.5.0",
     "bowser": "2.14.1",
     "fast-deep-equal": "~3.1.3",
@@ -50,11 +47,12 @@
   },
   "devDependencies": {
     "@types/js-cookie": "~3.0.6",
-    "@types/node": "~25.2.3",
+    "@types/node": "~25.4.0",
     "@types/spark-md5": "~3.0.5",
-    "@xylabs/ts-scripts-yarn3": "~7.3.2",
-    "@xylabs/tsconfig-dom": "~7.3.2",
-    "axios": "^1.13.5",
+    "@xylabs/ts-scripts-yarn3": "~7.4.11",
+    "@xylabs/tsconfig": "~7.4.11",
+    "@xylabs/tsconfig-dom": "~7.4.11",
+    "axios": "^1.13.6",
     "typescript": "~5.9.3",
     "vitest": "~4.0.18"
   },

package/src/Api/Api.ts

@@ -1,23 +0,0 @@
-import { isUndefined } from '@xylabs/typeof'
-import axios from 'axios'
-
-import type { UserEvent } from './UserEvent.ts'
-
-const apiBaseUri: Record<string, string> = {
-  beta: 'https://pixel.xylabs.com',
-  local: 'http://localhost:3030',
-  prod: 'https://pixel.xylabs.com',
-}
-
-export class PixelApi {
-  private endPoint: string
-
-  /* baseUri can either be a preset (prod, beta, local), or a specific uri */
-  constructor(baseUri = 'prod') {
-    this.endPoint = isUndefined(apiBaseUri[baseUri]) ? baseUri : `${apiBaseUri[baseUri]}/t/event/queue`
-  }
-
-  async trackEvents(events: UserEvent[]) {
-    return (await axios.post(this.endPoint, events)).data
-  }
-}

package/src/Api/UserEvent.ts

@@ -1,22 +0,0 @@
-import type { ExIds } from '../ExIds.ts'
-import type { UserEventSystem } from './UserEventSystem.ts'
-
-export interface UserEvent {
-  cid: string
-  create_time?: number
-  email?: string
-  email_hash?: string
-  event?: string
-  event_id?: string
-  exids?: ExIds
-  fields?: Record<string, unknown>
-  host?: string
-  pathname?: string
-  pixel?: string
-  receive_time?: number
-  referrer?: { local: string; session: string }
-  rid?: string
-  system?: UserEventSystem
-  uid?: string
-  utm?: Record<string, string>[] | Record<string, string[]>
-}

package/src/Api/UserEventSystem.ts

@@ -1,3 +0,0 @@
-import type Bowser from 'bowser'
-
-export type UserEventSystem = Bowser.Parser.ParsedResult

package/src/Api/index.ts

@@ -1,3 +0,0 @@
-export * from './Api.ts'
-export * from './UserEvent.ts'
-export * from './UserEventSystem.ts'

package/src/CommonFields.ts

@@ -1,4 +0,0 @@
-export interface CommonFields {
-  funnel?: string
-  testData?: string
-}

package/src/ExIds.ts

@@ -1,9 +0,0 @@
-export interface ExIds {
-  fbc?: string
-  fbp?: string
-  ga?: string
-  gclid?: string
-  rdt_uid?: string
-  scid?: string
-  tt_sessionId?: string
-}

package/src/FunnelStartedFields.ts

@@ -1,5 +0,0 @@
-import type { CommonFields } from './CommonFields.ts'
-
-export interface FunnelStartedFields extends CommonFields {
-  name: string
-}

package/src/Pixel.ts

@@ -1,120 +0,0 @@
-import { assertEx } from '@xylabs/assert'
-import type { JsonObject } from '@xylabs/object'
-import { Mutex } from 'async-mutex'
-import Cookies from 'js-cookie'
-import md5 from 'spark-md5'
-
-import type { UserEvent } from './Api/index.ts'
-import { PixelApi } from './Api/index.ts'
-import type { ExIds } from './ExIds.ts'
-import { getSystemInfo } from './getSystemInfo.ts'
-import { Referrer } from './Referrer.ts'
-import { UniqueUserId } from './UniqueUserId.ts'
-import { UtmFields } from './UtmFields.ts'
-
-const emailHashLocalStorageName = 'xy_email_hash'
-
-export class XyPixel {
-  static api = new PixelApi()
-
-  private static _instance?: XyPixel
-  private static utmFieldsObj: UtmFields
-
-  cid = new UniqueUserId().id
-  email?: string
-  email_hash?: string | null
-  exids?: ExIds
-  pixelId?: string
-
-  queue: UserEvent[] = []
-
-  private queueMutex = new Mutex()
-
-  private constructor(pixelId: string) {
-    this.pixelId = pixelId
-    this.email_hash = localStorage.getItem(emailHashLocalStorageName)
-  }
-
-  static get instance(): XyPixel {
-    return assertEx(this._instance, () => 'XyPixel uninitialized')
-  }
-
-  static init(pixelId: string) {
-    this._instance = new XyPixel(pixelId)
-    return this._instance
-  }
-
-  static selectApi(api: PixelApi) {
-    this.api = api
-  }
-
-  private static utmFields = () => {
-    if (this.utmFieldsObj === undefined) {
-      this.utmFieldsObj = new UtmFields()
-    }
-    return this.utmFieldsObj
-  }
-
-  identify(email?: string) {
-    this.email = email
-    this.email_hash = (email !== undefined && email.length > 0) ? md5.hash(email, true) : undefined
-    if (this.email_hash !== undefined) {
-      localStorage.setItem(emailHashLocalStorageName, this.email_hash)
-    }
-  }
-
-  async send<T extends JsonObject>(event: string, fields?: T, eventId?: string) {
-    this.updateFbId()
-    const utm = XyPixel.utmFields().update()
-    const referrer = new Referrer()
-    this.queue.push({
-      cid: this.cid,
-      create_time: Date.now(),
-      email_hash: this.email_hash ?? undefined,
-      event,
-      event_id: eventId,
-      exids: this.exids,
-      fields,
-      host: document.location.host,
-      pathname: document.location.pathname,
-      pixel: this.pixelId,
-      referrer: referrer.toJson(),
-      system: getSystemInfo(),
-      utm,
-    })
-    await this.tryFlushQueue()
-  }
-
-  private async tryFlushQueue() {
-    await this.queueMutex.runExclusive(async () => {
-      if (this.queue.length === 0) return
-      const api = XyPixel.api
-      if (api !== undefined) {
-        const events = this.queue
-        this.queue = []
-        try {
-          await api.trackEvents(events)
-        } catch (ex) {
-          if (events !== undefined) {
-            // put it back since it failed
-            this.queue = [...this.queue, ...events]
-          }
-          // eslint-disable-next-line no-console
-          console.error(ex)
-        }
-      }
-    })
-  }
-
-  private updateFbId() {
-    this.exids = {
-      fbc: Cookies.get('_fbc'),
-      fbp: Cookies.get('_fbp'),
-      ga: Cookies.get('_ga'),
-      gclid: Cookies.get('_gcl_aw'),
-      rdt_uid: Cookies.get('rdt_uid'),
-      scid: Cookies.get('_scid'),
-      tt_sessionId: sessionStorage.getItem('tt_sessionId') ?? undefined,
-    }
-  }
-}

package/src/PurchaseFields.ts

@@ -1,8 +0,0 @@
-import type { CommonFields } from './CommonFields.ts'
-
-export interface PurchaseFields extends CommonFields {
-  id: string
-  name?: string
-  price?: number
-  value?: number
-}

package/src/Referrer.ts

@@ -1,34 +0,0 @@
-export class Referrer {
-  private static storageId = '_coin_referrer'
-  local: string
-  session: string
-  constructor() {
-    this.session = this.getFromSession() ?? document.referrer
-    sessionStorage.setItem(Referrer.storageId, this.session)
-    this.local = this.getFromLocal() ?? document.referrer
-    globalThis.localStorage.setItem(Referrer.storageId, this.local)
-  }
-
-  toJson() {
-    if ((this.local.length > 0) || (this.session.length > 0)) {
-      return {
-        local: this.local,
-        session: this.session,
-      }
-    }
-  }
-
-  private getFromLocal() {
-    const value = globalThis.localStorage.getItem(Referrer.storageId)
-    if (value !== null && value.length > 0) {
-      return value
-    }
-  }
-
-  private getFromSession() {
-    const value = sessionStorage.getItem(Referrer.storageId)
-    if (value !== null && value.length > 0) {
-      return value
-    }
-  }
-}

package/src/TestStartedFields.ts

@@ -1,5 +0,0 @@
-import type { CommonFields } from './CommonFields.ts'
-
-export interface TestStartedFields extends CommonFields {
-  name: string
-}

package/src/UniqueUserId.ts

@@ -1,17 +0,0 @@
-export class UniqueUserId {
-  private static localStorageId = '_coin_cid'
-  id: string
-
-  constructor() {
-    this.id = globalThis.localStorage.getItem(UniqueUserId.localStorageId) ?? this.generateId()
-    globalThis.localStorage.setItem(UniqueUserId.localStorageId, this.id)
-  }
-
-  toString() {
-    return this.id
-  }
-
-  private generateId() {
-    return crypto.randomUUID()
-  }
-}

package/src/UserClickFields.ts

@@ -1,8 +0,0 @@
-import type { CommonFields } from './CommonFields.ts'
-
-export interface UserClickFields extends CommonFields {
-  elementName: string
-  elementType: string
-  intent?: string
-  placement?: string
-}

package/src/UserEventHandler.ts

@@ -1,14 +0,0 @@
-import type { EmptyObject } from '@xylabs/object'
-import type { Promisable } from '@xylabs/promise'
-
-import type { FunnelStartedFields } from './FunnelStartedFields.ts'
-import type { TestStartedFields } from './TestStartedFields.ts'
-import type { UserClickFields } from './UserClickFields.ts'
-import type { ViewContentFields } from './ViewContentFields.ts'
-
-export abstract class UserEventHandler<TData extends EmptyObject> {
-  abstract funnelStarted<T extends TData>(fields: T | FunnelStartedFields): Promisable<void>
-  abstract testStarted<T extends TData>(fields: T | TestStartedFields): Promisable<void>
-  abstract userClick<T extends TData>(fields: T | UserClickFields): Promisable<void>
-  abstract viewContent<T extends TData>(fields: T | ViewContentFields): Promisable<void>
-}

package/src/UtmFields.ts

@@ -1,46 +0,0 @@
-import isEqual from 'fast-deep-equal'
-
-export class UtmFields {
-  private static localStorageId = '_coin_utm'
-  fields: Record<string, string>[] = []
-  constructor() {
-    const storedString = globalThis.localStorage.getItem(UtmFields.localStorageId) ?? '[]'
-    try {
-      this.fields = JSON.parse(storedString)
-    } catch {
-      this.fields = []
-    }
-    // this clears the old object version if needed
-    if (!Array.isArray(this.fields)) {
-      this.fields = []
-    }
-    this.update()
-    globalThis.localStorage.setItem(UtmFields.localStorageId, JSON.stringify(this.fields))
-  }
-
-  getUtmRecord = () => {
-    const record: Record<string, string> = {}
-    const parsedQueryString = document.location.search.split('?')[1]?.split('&') ?? []
-    for (const item of parsedQueryString) {
-      const [fullKey, value] = item.split('=')
-      const [keyCategory, keyName] = fullKey.split('_')
-      if (keyCategory === 'utm') {
-        record[keyName] = value
-      }
-    }
-    return Object.keys(record).length > 0 ? record : null
-  }
-
-  toString() {
-    return JSON.stringify(this.fields)
-  }
-
-  // check the query string and if there an new/updated utm values, add them to the fields
-  update() {
-    const record = this.getUtmRecord()
-    if (record && !isEqual(this.fields.at(-1), record)) {
-      this.fields.push(record)
-    }
-    return this.fields ?? undefined
-  }
-}

package/src/ViewContentFields.ts

@@ -1,6 +0,0 @@
-import type { CommonFields } from './CommonFields.ts'
-
-export interface ViewContentFields extends CommonFields {
-  name: string
-  path: string
-}

package/src/XyLabsTrackingEventJson.ts

@@ -1,20 +0,0 @@
-export interface XyLabsTrackingEventJson {
-  cid: string
-  create_time?: number
-  email?: string
-  email_hash?: string
-  event?: string
-  event_id?: string
-  exids?: Record<string, string>
-  fields?: Record<string, unknown>
-  host?: string
-  ip?: string
-  pathname?: string
-  pixel?: string
-  receive_time?: number
-  rid?: string
-  system?: unknown
-  ua?: string
-  uid?: string
-  utm?: Record<string, string>[] | Record<string, string[]>
-}

package/src/XyUserEventHandler.ts

@@ -1,35 +0,0 @@
-import { type EmptyObject, toSafeJsonObject } from '@xylabs/object'
-
-import type { FunnelStartedFields } from './FunnelStartedFields.ts'
-import { XyPixel } from './Pixel.ts'
-import type { PurchaseFields } from './PurchaseFields.ts'
-import type { TestStartedFields } from './TestStartedFields.ts'
-import type { UserClickFields } from './UserClickFields.ts'
-import { UserEventHandler } from './UserEventHandler.ts'
-import type { ViewContentFields } from './ViewContentFields.ts'
-
-export class XyUserEventHandler<T extends EmptyObject = EmptyObject> extends UserEventHandler<T> {
-  constructor() {
-    super()
-  }
-
-  async funnelStarted(fields: T | FunnelStartedFields) {
-    return await XyPixel.instance.send('FunnelStarted', toSafeJsonObject(fields, [], 10))
-  }
-
-  async purchase(fields: T | PurchaseFields) {
-    return await XyPixel.instance.send('Purchase', toSafeJsonObject(fields, [], 10))
-  }
-
-  async testStarted(fields: T | TestStartedFields) {
-    return await XyPixel.instance.send('TestStarted', toSafeJsonObject(fields, [], 10))
-  }
-
-  async userClick(fields: T | UserClickFields) {
-    return await XyPixel.instance.send('ViewPage', toSafeJsonObject(fields, [], 10))
-  }
-
-  async viewContent(fields: T | ViewContentFields) {
-    return await XyPixel.instance.send('ViewContent', toSafeJsonObject(fields, [], 10))
-  }
-}

package/src/getSystemInfo.ts

@@ -1,15 +0,0 @@
-import Bowser from 'bowser'
-
-import type { UserEventSystem } from './Api/index.ts'
-
-let systemInfo: UserEventSystem | undefined
-
-export const getSystemInfo = () => {
-  try {
-    systemInfo = systemInfo || Bowser.getParser(globalThis.navigator.userAgent).getResult()
-  } catch (ex) {
-    // eslint-disable-next-line no-console
-    console.log(`getSystemInfo Error: ${ex}`)
-  }
-  return systemInfo
-}

package/src/index.ts

@@ -1,14 +0,0 @@
-export * from './Api/index.ts'
-export * from './CommonFields.ts'
-export * from './FunnelStartedFields.ts'
-export * from './Pixel.ts'
-export * from './PurchaseFields.ts'
-export * from './Referrer.ts'
-export * from './TestStartedFields.ts'
-export * from './UniqueUserId.ts'
-export * from './UserClickFields.ts'
-export * from './UserEventHandler.ts'
-export * from './UtmFields.ts'
-export * from './ViewContentFields.ts'
-export * from './XyLabsTrackingEventJson.ts'
-export * from './XyUserEventHandler.ts'