@xylabs/pixel 5.0.94 → 5.0.96

package/README.md

@@ -1,62 +1,52 @@
 # @xylabs/pixel
 
-[![logo][]](https://xylabs.com)
+[![npm][npm-badge]][npm-link]
+[![license][license-badge]][license-link]
 
-[![main-build][]][main-build-link]
-[![npm-badge][]][npm-link]
-[![npm-downloads-badge][]][npm-link]
-[![jsdelivr-badge][]][jsdelivr-link]
-[![npm-license-badge][]](LICENSE)
-[![codacy-badge][]][codacy-link]
-[![codeclimate-badge][]][codeclimate-link]
-[![snyk-badge][]][snyk-link]
-[![socket-badge][]][socket-link]
+> Event Client for xylabs ESB
 
+## Install
 
-Event Client for xylabs ESB
+Using npm:
 
+```sh
+npm install {{name}}
+```
 
+Using yarn:
 
-## Reference
+```sh
+yarn add {{name}}
+```
 
-**@xylabs/pixel**
+Using pnpm:
 
-***
+```sh
+pnpm add {{name}}
+```
 
-## Classes
+Using bun:
 
-| Class | Description |
-| ------ | ------ |
-| [PixelApi](#classes/PixelApi) | HTTP client for sending tracking events to the XY Labs pixel API. |
-| [XyPixel](#classes/XyPixel) | Singleton pixel tracker that queues and sends user events to the XY Labs tracking API. |
-| [Referrer](#classes/Referrer) | Tracks and persists the document referrer in both session and local storage. |
-| [UniqueUserId](#classes/UniqueUserId) | Generates and persists a unique user identifier in localStorage. |
-| [UserEventHandler](#classes/UserEventHandler) | Abstract base class for handling user tracking events. |
-| [UtmFields](#classes/UtmFields) | Tracks UTM campaign parameters from query strings, persisting history in localStorage. |
-| [XyUserEventHandler](#classes/XyUserEventHandler) | Concrete event handler that sends tracking events through the XyPixel singleton. |
+```sh
+bun add {{name}}
+```
 
-## Interfaces
 
-| Interface | Description |
-| ------ | ------ |
-| [UserEvent](#interfaces/UserEvent) | Represents a single user tracking event to be sent to the pixel API. |
-| [CommonFields](#interfaces/CommonFields) | Common fields shared across all tracking event types. |
-| [FunnelStartedFields](#interfaces/FunnelStartedFields) | Fields for a funnel-started tracking event. |
-| [PurchaseFields](#interfaces/PurchaseFields) | Fields for a purchase tracking event. |
-| [TestStartedFields](#interfaces/TestStartedFields) | Fields for a test-started tracking event (e.g. A/B test). |
-| [UserClickFields](#interfaces/UserClickFields) | Fields for a user click tracking event. |
-| [ViewContentFields](#interfaces/ViewContentFields) | Fields for a view-content tracking event. |
-| [XyLabsTrackingEventJson](#interfaces/XyLabsTrackingEventJson) | JSON structure for an XY Labs tracking event as stored or transmitted. |
+## License
 
-## Type Aliases
+See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
 
-| Type Alias | Description |
-| ------ | ------ |
-| [UserEventSystem](#type-aliases/UserEventSystem) | Parsed browser/OS/engine information from the user agent string. |
+## Reference
 
-### classes
+### packages
 
-  ### <a id="PixelApi"></a>PixelApi
+  ### pixel
+
+    ### .temp-typedoc
+
+      ### classes
+
+        ### <a id="PixelApi"></a>PixelApi
 
 [**@xylabs/pixel**](#../README)
 
@@ -69,14 +59,14 @@ HTTP client for sending tracking events to the XY Labs pixel API.
 ### Constructor
 
 ```ts
-new PixelApi(baseUri?: string): PixelApi;
+new PixelApi(baseUri?): PixelApi;
 ```
 
 ### Parameters
 
-| Parameter | Type | Default value |
-| ------ | ------ | ------ |
-| `baseUri` | `string` | `'prod'` |
+#### baseUri?
+
+`string` = `'prod'`
 
 ### Returns
 
@@ -87,16 +77,18 @@ new PixelApi(baseUri?: string): PixelApi;
 ### trackEvents()
 
 ```ts
-trackEvents(events: UserEvent[]): Promise<any>;
+trackEvents(events): Promise<any>;
 ```
 
 Sends an array of user events to the tracking API.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `events` | [`UserEvent`](#../interfaces/UserEvent)[] | The events to submit |
+#### events
+
+[`UserEvent`](#../interfaces/UserEvent)[]
+
+The events to submit
 
 ### Returns
 
@@ -104,7 +96,7 @@ Sends an array of user events to the tracking API.
 
 The response data from the API
 
-  ### <a id="Referrer"></a>Referrer
+        ### <a id="Referrer"></a>Referrer
 
 [**@xylabs/pixel**](#../README)
 
@@ -126,10 +118,19 @@ new Referrer(): Referrer;
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="local"></a> `local` | `string` |
-| <a id="session"></a> `session` | `string` |
+### local
+
+```ts
+local: string;
+```
+
+***
+
+### session
+
+```ts
+session: string;
+```
 
 ## Methods
 
@@ -156,7 +157,7 @@ Returns the referrer data as a JSON object, or undefined if both values are empt
 
 An object with local and session referrer strings, or undefined
 
-  ### <a id="UniqueUserId"></a>UniqueUserId
+        ### <a id="UniqueUserId"></a>UniqueUserId
 
 [**@xylabs/pixel**](#../README)
 
@@ -178,9 +179,11 @@ new UniqueUserId(): UniqueUserId;
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="id"></a> `id` | `string` |
+### id
+
+```ts
+id: string;
+```
 
 ## Methods
 
@@ -196,7 +199,7 @@ Returns the unique user ID as a string.
 
 `string`
 
-  ### <a id="UserEventHandler"></a>UserEventHandler
+        ### <a id="UserEventHandler"></a>UserEventHandler
 
 [**@xylabs/pixel**](#../README)
 
@@ -210,9 +213,9 @@ Abstract base class for handling user tracking events.
 
 ## Type Parameters
 
-| Type Parameter |
-| ------ |
-| `TData` *extends* `EmptyObject` |
+### TData
+
+`TData` *extends* `EmptyObject`
 
 ## Constructors
 
@@ -231,22 +234,22 @@ new UserEventHandler<TData>(): UserEventHandler<TData>;
 ### funnelStarted()
 
 ```ts
-abstract funnelStarted<T>(fields: FunnelStartedFields | T): Promisable<void>;
+abstract funnelStarted<T>(fields): Promisable<void>;
 ```
 
 Tracks a funnel-started event.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `object` |
+#### T
+
+`T` *extends* `object`
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`FunnelStartedFields`](#../interfaces/FunnelStartedFields) \| `T` |
+#### fields
+
+[`FunnelStartedFields`](#../interfaces/FunnelStartedFields) \| `T`
 
 ### Returns
 
@@ -257,22 +260,22 @@ Tracks a funnel-started event.
 ### testStarted()
 
 ```ts
-abstract testStarted<T>(fields: TestStartedFields | T): Promisable<void>;
+abstract testStarted<T>(fields): Promisable<void>;
 ```
 
 Tracks a test-started event.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `object` |
+#### T
+
+`T` *extends* `object`
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`TestStartedFields`](#../interfaces/TestStartedFields) \| `T` |
+#### fields
+
+[`TestStartedFields`](#../interfaces/TestStartedFields) \| `T`
 
 ### Returns
 
@@ -283,22 +286,22 @@ Tracks a test-started event.
 ### userClick()
 
 ```ts
-abstract userClick<T>(fields: UserClickFields | T): Promisable<void>;
+abstract userClick<T>(fields): Promisable<void>;
 ```
 
 Tracks a user click event.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `object` |
+#### T
+
+`T` *extends* `object`
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`UserClickFields`](#../interfaces/UserClickFields) \| `T` |
+#### fields
+
+[`UserClickFields`](#../interfaces/UserClickFields) \| `T`
 
 ### Returns
 
@@ -309,28 +312,28 @@ Tracks a user click event.
 ### viewContent()
 
 ```ts
-abstract viewContent<T>(fields: T | ViewContentFields): Promisable<void>;
+abstract viewContent<T>(fields): Promisable<void>;
 ```
 
 Tracks a view-content event.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `object` |
+#### T
+
+`T` *extends* `object`
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | `T` \| [`ViewContentFields`](#../interfaces/ViewContentFields) |
+#### fields
+
+`T` \| [`ViewContentFields`](#../interfaces/ViewContentFields)
 
 ### Returns
 
 `Promisable`\<`void`\>
 
-  ### <a id="UtmFields"></a>UtmFields
+        ### <a id="UtmFields"></a>UtmFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -352,9 +355,11 @@ new UtmFields(): UtmFields;
 
 ## Properties
 
-| Property | Type | Default value |
-| ------ | ------ | ------ |
-| <a id="fields"></a> `fields` | `Record`\<`string`, `string`\>[] | `[]` |
+### fields
+
+```ts
+fields: Record<string, string>[] = [];
+```
 
 ## Methods
 
@@ -402,7 +407,7 @@ Checks the query string for new UTM values and appends them to the history if ch
 
 The current UTM fields array, or undefined if empty
 
-  ### <a id="XyPixel"></a>XyPixel
+        ### <a id="XyPixel"></a>XyPixel
 
 [**@xylabs/pixel**](#../README)
 
@@ -412,15 +417,59 @@ Singleton pixel tracker that queues and sends user events to the XY Labs trackin
 
 ## Properties
 
-| Property | Modifier | Type | Default value |
-| ------ | ------ | ------ | ------ |
-| <a id="api"></a> `api` | `static` | [`PixelApi`](#PixelApi) | `undefined` |
-| <a id="cid"></a> `cid` | `public` | `string` | `undefined` |
-| <a id="email"></a> `email?` | `public` | `string` | `undefined` |
-| <a id="email_hash"></a> `email_hash?` | `public` | `string` \| `null` | `undefined` |
-| <a id="exids"></a> `exids?` | `public` | `ExIds` | `undefined` |
-| <a id="pixelid"></a> `pixelId?` | `public` | `string` | `undefined` |
-| <a id="queue"></a> `queue` | `public` | [`UserEvent`](#../interfaces/UserEvent)[] | `[]` |
+### api
+
+```ts
+static api: PixelApi;
+```
+
+***
+
+### cid
+
+```ts
+cid: string;
+```
+
+***
+
+### email?
+
+```ts
+optional email?: string;
+```
+
+***
+
+### email\_hash?
+
+```ts
+optional email_hash?: string | null;
+```
+
+***
+
+### exids?
+
+```ts
+optional exids?: ExIds;
+```
+
+***
+
+### pixelId?
+
+```ts
+optional pixelId?: string;
+```
+
+***
+
+### queue
+
+```ts
+queue: UserEvent[] = [];
+```
 
 ## Accessors
 
@@ -443,16 +492,18 @@ Returns the singleton XyPixel instance, throwing if not yet initialized.
 ### init()
 
 ```ts
-static init(pixelId: string): XyPixel;
+static init(pixelId): XyPixel;
 ```
 
 Initializes the XyPixel singleton with the given pixel ID.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `pixelId` | `string` | The pixel identifier for this tracking instance |
+#### pixelId
+
+`string`
+
+The pixel identifier for this tracking instance
 
 ### Returns
 
@@ -465,16 +516,18 @@ The newly created XyPixel instance
 ### selectApi()
 
 ```ts
-static selectApi(api: PixelApi): void;
+static selectApi(api): void;
 ```
 
 Replaces the default PixelApi instance used for sending events.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `api` | [`PixelApi`](#PixelApi) | The PixelApi instance to use |
+#### api
+
+[`PixelApi`](#PixelApi)
+
+The PixelApi instance to use
 
 ### Returns
 
@@ -485,16 +538,18 @@ Replaces the default PixelApi instance used for sending events.
 ### identify()
 
 ```ts
-identify(email?: string): void;
+identify(email?): void;
 ```
 
 Associates an email address with this pixel instance, hashing it for privacy.
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `email?` | `string` | The email address to identify the user with |
+#### email?
+
+`string`
+
+The email address to identify the user with
 
 ### Returns
 
@@ -506,32 +561,44 @@ Associates an email address with this pixel instance, hashing it for privacy.
 
 ```ts
 send<T>(
-   event: string, 
-   fields?: T, 
-eventId?: string): Promise<void>;
+   event, 
+   fields?, 
+eventId?): Promise<void>;
 ```
 
 Queues a tracking event and attempts to flush the queue to the API.
 
 ### Type Parameters
 
-| Type Parameter |
-| ------ |
-| `T` *extends* `Record`\<`string`, `unknown`\> |
+#### T
+
+`T` *extends* `Record`\<`string`, `unknown`\>
 
 ### Parameters
 
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `event` | `string` | The event name |
-| `fields?` | `T` | Optional event-specific fields |
-| `eventId?` | `string` | Optional unique event identifier |
+#### event
+
+`string`
+
+The event name
+
+#### fields?
+
+`T`
+
+Optional event-specific fields
+
+#### eventId?
+
+`string`
+
+Optional unique event identifier
 
 ### Returns
 
 `Promise`\<`void`\>
 
-  ### <a id="XyUserEventHandler"></a>XyUserEventHandler
+        ### <a id="XyUserEventHandler"></a>XyUserEventHandler
 
 [**@xylabs/pixel**](#../README)
 
@@ -545,9 +612,9 @@ Concrete event handler that sends tracking events through the XyPixel singleton.
 
 ## Type Parameters
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `T` *extends* `EmptyObject` | `EmptyObject` |
+### T
+
+`T` *extends* `EmptyObject` = `EmptyObject`
 
 ## Constructors
 
@@ -570,16 +637,16 @@ new XyUserEventHandler<T>(): XyUserEventHandler<T>;
 ### funnelStarted()
 
 ```ts
-funnelStarted(fields: FunnelStartedFields | T): Promise<void>;
+funnelStarted(fields): Promise<void>;
 ```
 
 Sends a funnel-started event via the pixel API.
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`FunnelStartedFields`](#../interfaces/FunnelStartedFields) \| `T` |
+#### fields
+
+[`FunnelStartedFields`](#../interfaces/FunnelStartedFields) \| `T`
 
 ### Returns
 
@@ -594,16 +661,16 @@ Sends a funnel-started event via the pixel API.
 ### purchase()
 
 ```ts
-purchase(fields: PurchaseFields | T): Promise<void>;
+purchase(fields): Promise<void>;
 ```
 
 Sends a purchase event via the pixel API.
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`PurchaseFields`](#../interfaces/PurchaseFields) \| `T` |
+#### fields
+
+[`PurchaseFields`](#../interfaces/PurchaseFields) \| `T`
 
 ### Returns
 
@@ -614,16 +681,16 @@ Sends a purchase event via the pixel API.
 ### testStarted()
 
 ```ts
-testStarted(fields: TestStartedFields | T): Promise<void>;
+testStarted(fields): Promise<void>;
 ```
 
 Sends a test-started event via the pixel API.
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`TestStartedFields`](#../interfaces/TestStartedFields) \| `T` |
+#### fields
+
+[`TestStartedFields`](#../interfaces/TestStartedFields) \| `T`
 
 ### Returns
 
@@ -638,16 +705,16 @@ Sends a test-started event via the pixel API.
 ### userClick()
 
 ```ts
-userClick(fields: UserClickFields | T): Promise<void>;
+userClick(fields): Promise<void>;
 ```
 
 Sends a user click event via the pixel API.
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`UserClickFields`](#../interfaces/UserClickFields) \| `T` |
+#### fields
+
+[`UserClickFields`](#../interfaces/UserClickFields) \| `T`
 
 ### Returns
 
@@ -662,16 +729,16 @@ Sends a user click event via the pixel API.
 ### viewContent()
 
 ```ts
-viewContent(fields: ViewContentFields | T): Promise<void>;
+viewContent(fields): Promise<void>;
 ```
 
 Sends a view-content event via the pixel API.
 
 ### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `fields` | [`ViewContentFields`](#../interfaces/ViewContentFields) \| `T` |
+#### fields
+
+[`ViewContentFields`](#../interfaces/ViewContentFields) \| `T`
 
 ### Returns
 
@@ -681,9 +748,9 @@ Sends a view-content event via the pixel API.
 
 [`UserEventHandler`](#UserEventHandler).[`viewContent`](UserEventHandler.md#viewcontent)
 
-### interfaces
+      ### interfaces
 
-  ### <a id="CommonFields"></a>CommonFields
+        ### <a id="CommonFields"></a>CommonFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -701,12 +768,21 @@ Common fields shared across all tracking event types.
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="funnel"></a> `funnel?` | `string` |
-| <a id="testdata"></a> `testData?` | `string` |
+### funnel?
 
-  ### <a id="FunnelStartedFields"></a>FunnelStartedFields
+```ts
+optional funnel?: string;
+```
+
+***
+
+### testData?
+
+```ts
+optional testData?: string;
+```
+
+        ### <a id="FunnelStartedFields"></a>FunnelStartedFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -720,13 +796,37 @@ Fields for a funnel-started tracking event.
 
 ## Properties
 
-| Property | Type | Inherited from |
-| ------ | ------ | ------ |
-| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
-| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
-| <a id="name"></a> `name` | `string` | - |
+### funnel?
+
+```ts
+optional funnel?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
 
-  ### <a id="PurchaseFields"></a>PurchaseFields
+***
+
+### testData?
+
+```ts
+optional testData?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+        ### <a id="PurchaseFields"></a>PurchaseFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -740,16 +840,61 @@ Fields for a purchase tracking event.
 
 ## Properties
 
-| Property | Type | Inherited from |
-| ------ | ------ | ------ |
-| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
-| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
-| <a id="id"></a> `id` | `string` | - |
-| <a id="name"></a> `name?` | `string` | - |
-| <a id="price"></a> `price?` | `number` | - |
-| <a id="value"></a> `value?` | `number` | - |
+### funnel?
+
+```ts
+optional funnel?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
+
+***
+
+### testData?
+
+```ts
+optional testData?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
+
+***
+
+### id
+
+```ts
+id: string;
+```
+
+***
+
+### name?
 
-  ### <a id="TestStartedFields"></a>TestStartedFields
+```ts
+optional name?: string;
+```
+
+***
+
+### price?
+
+```ts
+optional price?: number;
+```
+
+***
+
+### value?
+
+```ts
+optional value?: number;
+```
+
+        ### <a id="TestStartedFields"></a>TestStartedFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -763,13 +908,37 @@ Fields for a test-started tracking event (e.g. A/B test).
 
 ## Properties
 
-| Property | Type | Inherited from |
-| ------ | ------ | ------ |
-| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
-| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
-| <a id="name"></a> `name` | `string` | - |
+### funnel?
+
+```ts
+optional funnel?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
+
+***
+
+### testData?
+
+```ts
+optional testData?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
+
+***
 
-  ### <a id="UserClickFields"></a>UserClickFields
+### name
+
+```ts
+name: string;
+```
+
+        ### <a id="UserClickFields"></a>UserClickFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -783,16 +952,61 @@ Fields for a user click tracking event.
 
 ## Properties
 
-| Property | Type | Inherited from |
-| ------ | ------ | ------ |
-| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
-| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
-| <a id="elementname"></a> `elementName` | `string` | - |
-| <a id="elementtype"></a> `elementType` | `string` | - |
-| <a id="intent"></a> `intent?` | `string` | - |
-| <a id="placement"></a> `placement?` | `string` | - |
+### funnel?
+
+```ts
+optional funnel?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
+
+***
+
+### testData?
+
+```ts
+optional testData?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
+
+***
+
+### elementName
+
+```ts
+elementName: string;
+```
+
+***
+
+### elementType
+
+```ts
+elementType: string;
+```
 
-  ### <a id="UserEvent"></a>UserEvent
+***
+
+### intent?
+
+```ts
+optional intent?: string;
+```
+
+***
+
+### placement?
+
+```ts
+optional placement?: string;
+```
+
+        ### <a id="UserEvent"></a>UserEvent
 
 [**@xylabs/pixel**](#../README)
 
@@ -802,29 +1016,153 @@ Represents a single user tracking event to be sent to the pixel API.
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="cid"></a> `cid` | `string` |
-| <a id="create_time"></a> `create_time?` | `number` |
-| <a id="email"></a> `email?` | `string` |
-| <a id="email_hash"></a> `email_hash?` | `string` |
-| <a id="event"></a> `event?` | `string` |
-| <a id="event_id"></a> `event_id?` | `string` |
-| <a id="exids"></a> `exids?` | `ExIds` |
-| <a id="fields"></a> `fields?` | `Record`\<`string`, `unknown`\> |
-| <a id="host"></a> `host?` | `string` |
-| <a id="pathname"></a> `pathname?` | `string` |
-| <a id="pixel"></a> `pixel?` | `string` |
-| <a id="receive_time"></a> `receive_time?` | `number` |
-| <a id="referrer"></a> `referrer?` | \{ `local`: `string`; `session`: `string`; \} |
-| `referrer.local` | `string` |
-| `referrer.session` | `string` |
-| <a id="rid"></a> `rid?` | `string` |
-| <a id="system"></a> `system?` | `ParsedResult` |
-| <a id="uid"></a> `uid?` | `string` |
-| <a id="utm"></a> `utm?` | `Record`\<`string`, `string`\>[] \| `Record`\<`string`, `string`[]\> |
-
-  ### <a id="ViewContentFields"></a>ViewContentFields
+### cid
+
+```ts
+cid: string;
+```
+
+***
+
+### create\_time?
+
+```ts
+optional create_time?: number;
+```
+
+***
+
+### email?
+
+```ts
+optional email?: string;
+```
+
+***
+
+### email\_hash?
+
+```ts
+optional email_hash?: string;
+```
+
+***
+
+### event?
+
+```ts
+optional event?: string;
+```
+
+***
+
+### event\_id?
+
+```ts
+optional event_id?: string;
+```
+
+***
+
+### exids?
+
+```ts
+optional exids?: ExIds;
+```
+
+***
+
+### fields?
+
+```ts
+optional fields?: Record<string, unknown>;
+```
+
+***
+
+### host?
+
+```ts
+optional host?: string;
+```
+
+***
+
+### pathname?
+
+```ts
+optional pathname?: string;
+```
+
+***
+
+### pixel?
+
+```ts
+optional pixel?: string;
+```
+
+***
+
+### receive\_time?
+
+```ts
+optional receive_time?: number;
+```
+
+***
+
+### referrer?
+
+```ts
+optional referrer?: object;
+```
+
+### local
+
+```ts
+local: string;
+```
+
+### session
+
+```ts
+session: string;
+```
+
+***
+
+### rid?
+
+```ts
+optional rid?: string;
+```
+
+***
+
+### system?
+
+```ts
+optional system?: ParsedResult;
+```
+
+***
+
+### uid?
+
+```ts
+optional uid?: string;
+```
+
+***
+
+### utm?
+
+```ts
+optional utm?: Record<string, string>[] | Record<string, string[]>;
+```
+
+        ### <a id="ViewContentFields"></a>ViewContentFields
 
 [**@xylabs/pixel**](#../README)
 
@@ -838,14 +1176,45 @@ Fields for a view-content tracking event.
 
 ## Properties
 
-| Property | Type | Inherited from |
-| ------ | ------ | ------ |
-| <a id="funnel"></a> `funnel?` | `string` | [`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel) |
-| <a id="testdata"></a> `testData?` | `string` | [`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata) |
-| <a id="name"></a> `name` | `string` | - |
-| <a id="path"></a> `path` | `string` | - |
+### funnel?
+
+```ts
+optional funnel?: string;
+```
 
-  ### <a id="XyLabsTrackingEventJson"></a>XyLabsTrackingEventJson
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`funnel`](CommonFields.md#funnel)
+
+***
+
+### testData?
+
+```ts
+optional testData?: string;
+```
+
+### Inherited from
+
+[`CommonFields`](#CommonFields).[`testData`](CommonFields.md#testdata)
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+***
+
+### path
+
+```ts
+path: string;
+```
+
+        ### <a id="XyLabsTrackingEventJson"></a>XyLabsTrackingEventJson
 
 [**@xylabs/pixel**](#../README)
 
@@ -855,77 +1224,164 @@ JSON structure for an XY Labs tracking event as stored or transmitted.
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="cid"></a> `cid` | `string` |
-| <a id="create_time"></a> `create_time?` | `number` |
-| <a id="email"></a> `email?` | `string` |
-| <a id="email_hash"></a> `email_hash?` | `string` |
-| <a id="event"></a> `event?` | `string` |
-| <a id="event_id"></a> `event_id?` | `string` |
-| <a id="exids"></a> `exids?` | `Record`\<`string`, `string`\> |
-| <a id="fields"></a> `fields?` | `Record`\<`string`, `unknown`\> |
-| <a id="host"></a> `host?` | `string` |
-| <a id="ip"></a> `ip?` | `string` |
-| <a id="pathname"></a> `pathname?` | `string` |
-| <a id="pixel"></a> `pixel?` | `string` |
-| <a id="receive_time"></a> `receive_time?` | `number` |
-| <a id="rid"></a> `rid?` | `string` |
-| <a id="system"></a> `system?` | `unknown` |
-| <a id="ua"></a> `ua?` | `string` |
-| <a id="uid"></a> `uid?` | `string` |
-| <a id="utm"></a> `utm?` | `Record`\<`string`, `string`\>[] \| `Record`\<`string`, `string`[]\> |
-
-### type-aliases
-
-  ### <a id="UserEventSystem"></a>UserEventSystem
+### cid
 
-[**@xylabs/pixel**](#../README)
+```ts
+cid: string;
+```
 
 ***
 
+### create\_time?
+
 ```ts
-type UserEventSystem = Bowser.Parser.ParsedResult;
+optional create_time?: number;
 ```
 
-Parsed browser/OS/engine information from the user agent string.
+***
 
+### email?
 
-Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
+```ts
+optional email?: string;
+```
 
-## Maintainers
+***
 
--   [Arie Trouw](https://github.com/arietrouw) ([arietrouw.com](https://arietrouw.com))
--   [Matt Jones](https://github.com/jonesmac)
--   [Joel Carter](https://github.com/JoelBCarter)
--   [Jordan Trouw](https://github.com/jordantrouw)
+### email\_hash?
 
-## License
+```ts
+optional email_hash?: string;
+```
+
+***
 
-> See the [LICENSE](LICENSE) file for license details
+### event?
 
-## Credits
+```ts
+optional event?: string;
+```
 
-[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
+***
 
-[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
+### event\_id?
 
-[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
-[npm-badge]: https://img.shields.io/npm/v/@xylabs/pixel.svg
-[npm-link]: https://www.npmjs.com/package/@xylabs/pixel
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json
+```ts
+optional event_id?: string;
+```
+
+***
+
+### exids?
+
+```ts
+optional exids?: Record<string, string>;
+```
+
+***
+
+### fields?
+
+```ts
+optional fields?: Record<string, unknown>;
+```
+
+***
 
-[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/pixel
-[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/pixel
+### host?
 
-[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/pixel/badge
-[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/pixel
+```ts
+optional host?: string;
+```
+
+***
+
+### ip?
+
+```ts
+optional ip?: string;
+```
+
+***
+
+### pathname?
+
+```ts
+optional pathname?: string;
+```
 
-[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/pixel
-[socket-link]: https://socket.dev/npm/package/@xylabs/pixel
+***
+
+### pixel?
+
+```ts
+optional pixel?: string;
+```
+
+***
+
+### receive\_time?
+
+```ts
+optional receive_time?: number;
+```
+
+***
+
+### rid?
+
+```ts
+optional rid?: string;
+```
+
+***
+
+### system?
+
+```ts
+optional system?: unknown;
+```
+
+***
+
+### ua?
+
+```ts
+optional ua?: string;
+```
+
+***
+
+### uid?
+
+```ts
+optional uid?: string;
+```
+
+***
+
+### utm?
+
+```ts
+optional utm?: Record<string, string>[] | Record<string, string[]>;
+```
+
+      ### type-aliases
+
+        ### <a id="UserEventSystem"></a>UserEventSystem
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+```ts
+type UserEventSystem = Bowser.Parser.ParsedResult;
+```
+
+Parsed browser/OS/engine information from the user agent string.
+
+
+[npm-badge]: https://img.shields.io/npm/v/@xylabs/pixel.svg
+[npm-link]: https://www.npmjs.com/package/@xylabs/pixel
+[license-badge]: https://img.shields.io/npm/l/@xylabs/pixel.svg
+[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE