@xylabs/pixel 4.13.20 → 4.13.22

package/README.md

@@ -12,13 +12,1280 @@
 [![snyk-badge][]][snyk-link]
 [![socket-badge][]][socket-link]
 
-Version: 4.13.19
 
 Event Client for xylabs ESB
 
-## Documentation
+## Reference
+
+**@xylabs/pixel**
+
+***
+
+## Classes
+
+- [PixelApi](#classes/PixelApi)
+- [XyPixel](#classes/XyPixel)
+- [Referrer](#classes/Referrer)
+- [UniqueUserId](#classes/UniqueUserId)
+- [UserEventHandler](#classes/UserEventHandler)
+- [UtmFields](#classes/UtmFields)
+- [XyUserEventHandler](#classes/XyUserEventHandler)
+
+## Interfaces
+
+- [UserEvent](#interfaces/UserEvent)
+- [CommonFields](#interfaces/CommonFields)
+- [FunnelStartedFields](#interfaces/FunnelStartedFields)
+- [PurchaseFields](#interfaces/PurchaseFields)
+- [TestStartedFields](#interfaces/TestStartedFields)
+- [UserClickFields](#interfaces/UserClickFields)
+- [ViewContentFields](#interfaces/ViewContentFields)
+- [XyLabsTrackingEventJson](#interfaces/XyLabsTrackingEventJson)
+
+## Type Aliases
+
+- [UserEventSystem](#type-aliases/UserEventSystem)
+
+### classes
+
+  ### <a id="PixelApi"></a>PixelApi
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new PixelApi(baseUri): PixelApi;
+```
+
+### Parameters
+
+#### baseUri
+
+`string` = `'prod'`
+
+### Returns
+
+`PixelApi`
+
+## Methods
+
+### trackEvents()
+
+```ts
+trackEvents(events): Promise<any>;
+```
+
+### Parameters
+
+#### events
+
+[`UserEvent`](#../interfaces/UserEvent)[]
+
+### Returns
+
+`Promise`\<`any`\>
+
+  ### <a id="Referrer"></a>Referrer
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new Referrer(): Referrer;
+```
+
+### Returns
+
+`Referrer`
+
+## Properties
+
+### local
+
+```ts
+local: string;
+```
+
+***
+
+### session
+
+```ts
+session: string;
+```
+
+## Methods
+
+### toJson()
+
+```ts
+toJson(): 
+  | undefined
+  | {
+  local: string;
+  session: string;
+};
+```
+
+### Returns
+
+  \| `undefined`
+  \| \{
+  `local`: `string`;
+  `session`: `string`;
+\}
+
+  ### <a id="UniqueUserId"></a>UniqueUserId
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new UniqueUserId(): UniqueUserId;
+```
+
+### Returns
+
+`UniqueUserId`
+
+## Properties
+
+### id
+
+```ts
+id: string;
+```
+
+## Methods
+
+### toString()
+
+```ts
+toString(): string;
+```
+
+### Returns
+
+`string`
+
+  ### <a id="UserEventHandler"></a>UserEventHandler
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extended by
+
+- [`XyUserEventHandler`](#XyUserEventHandler)
+
+## Type Parameters
+
+### TData
+
+`TData` *extends* `EmptyObject`
+
+## Constructors
+
+### Constructor
+
+```ts
+new UserEventHandler<TData>(): UserEventHandler<TData>;
+```
+
+### Returns
+
+`UserEventHandler`\<`TData`\>
+
+## Methods
+
+### funnelStarted()
+
+```ts
+abstract funnelStarted<T>(fields): Promisable<void>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### fields
+
+[`FunnelStartedFields`](#../interfaces/FunnelStartedFields) | `T`
+
+### Returns
+
+`Promisable`\<`void`\>
+
+***
+
+### testStarted()
+
+```ts
+abstract testStarted<T>(fields): Promisable<void>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### fields
+
+[`TestStartedFields`](#../interfaces/TestStartedFields) | `T`
+
+### Returns
+
+`Promisable`\<`void`\>
+
+***
+
+### userClick()
+
+```ts
+abstract userClick<T>(fields): Promisable<void>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### fields
+
+[`UserClickFields`](#../interfaces/UserClickFields) | `T`
+
+### Returns
+
+`Promisable`\<`void`\>
+
+***
+
+### viewContent()
+
+```ts
+abstract viewContent<T>(fields): Promisable<void>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `object`
+
+### Parameters
+
+#### fields
+
+`T` | [`ViewContentFields`](#../interfaces/ViewContentFields)
+
+### Returns
+
+`Promisable`\<`void`\>
+
+  ### <a id="UtmFields"></a>UtmFields
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Constructors
+
+### Constructor
+
+```ts
+new UtmFields(): UtmFields;
+```
+
+### Returns
+
+`UtmFields`
+
+## Properties
+
+### fields
+
+```ts
+fields: Record<string, string>[] = [];
+```
+
+## Methods
+
+### getUtmRecord()
+
+```ts
+getUtmRecord(): null | Record<string, string>;
+```
+
+### Returns
+
+`null` \| `Record`\<`string`, `string`\>
+
+***
+
+### toString()
+
+```ts
+toString(): string;
+```
+
+### Returns
+
+`string`
+
+***
+
+### update()
+
+```ts
+update(): Record<string, string>[];
+```
+
+### Returns
+
+`Record`\<`string`, `string`\>[]
+
+  ### <a id="XyPixel"></a>XyPixel
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Properties
+
+### api
+
+```ts
+static api: PixelApi;
+```
+
+***
+
+### cid
+
+```ts
+cid: string;
+```
+
+***
+
+### email?
+
+```ts
+optional email: string;
+```
+
+***
+
+### email\_hash?
+
+```ts
+optional email_hash: null | string;
+```
+
+***
+
+### exids?
+
+```ts
+optional exids: ExIds;
+```
+
+***
+
+### pixelId?
+
+```ts
+optional pixelId: string;
+```
+
+***
+
+### queue
+
+```ts
+queue: UserEvent[] = [];
+```
+
+## Accessors
+
+### instance
+
+### Get Signature
+
+```ts
+get static instance(): XyPixel;
+```
+
+#### Returns
+
+`XyPixel`
+
+## Methods
+
+### init()
+
+```ts
+static init(pixelId): XyPixel;
+```
+
+### Parameters
+
+#### pixelId
+
+`string`
+
+### Returns
+
+`XyPixel`
+
+***
+
+### selectApi()
+
+```ts
+static selectApi(api): void;
+```
+
+### Parameters
+
+#### api
+
+[`PixelApi`](#PixelApi)
+
+### Returns
+
+`void`
+
+***
+
+### identify()
+
+```ts
+identify(email?): void;
+```
+
+### Parameters
+
+#### email?
+
+`string`
+
+### Returns
+
+`void`
+
+***
+
+### send()
+
+```ts
+send<T>(
+   event, 
+   fields?, 
+eventId?): Promise<void>;
+```
+
+### Type Parameters
+
+#### T
+
+`T` *extends* `JsonObject`
+
+### Parameters
+
+#### event
+
+`string`
+
+#### fields?
+
+`T`
+
+#### eventId?
+
+`string`
+
+### Returns
+
+`Promise`\<`void`\>
+
+  ### <a id="XyUserEventHandler"></a>XyUserEventHandler
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extends
+
+- [`UserEventHandler`](#UserEventHandler)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T` *extends* `EmptyObject` = `EmptyObject`
+
+## Constructors
+
+### Constructor
+
+```ts
+new XyUserEventHandler<T>(): XyUserEventHandler<T>;
+```
+
+### Returns
+
+`XyUserEventHandler`\<`T`\>
+
+### Overrides
+
+[`UserEventHandler`](#UserEventHandler).[`constructor`](UserEventHandler.md#constructor)
+
+## Methods
+
+### funnelStarted()
+
+```ts
+funnelStarted(fields): Promise<void>;
+```
+
+### Parameters
+
+#### fields
+
+[`FunnelStartedFields`](#../interfaces/FunnelStartedFields) | `T`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Overrides
+
+[`UserEventHandler`](#UserEventHandler).[`funnelStarted`](UserEventHandler.md#funnelstarted)
+
+***
+
+### purchase()
+
+```ts
+purchase(fields): Promise<void>;
+```
+
+### Parameters
+
+#### fields
+
+[`PurchaseFields`](#../interfaces/PurchaseFields) | `T`
+
+### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### testStarted()
+
+```ts
+testStarted(fields): Promise<void>;
+```
+
+### Parameters
+
+#### fields
+
+[`TestStartedFields`](#../interfaces/TestStartedFields) | `T`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Overrides
+
+[`UserEventHandler`](#UserEventHandler).[`testStarted`](UserEventHandler.md#teststarted)
+
+***
+
+### userClick()
+
+```ts
+userClick(fields): Promise<void>;
+```
+
+### Parameters
+
+#### fields
+
+[`UserClickFields`](#../interfaces/UserClickFields) | `T`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Overrides
+
+[`UserEventHandler`](#UserEventHandler).[`userClick`](UserEventHandler.md#userclick)
+
+***
+
+### viewContent()
+
+```ts
+viewContent(fields): Promise<void>;
+```
+
+### Parameters
+
+#### fields
+
+[`ViewContentFields`](#../interfaces/ViewContentFields) | `T`
+
+### Returns
+
+`Promise`\<`void`\>
+
+### Overrides
+
+[`UserEventHandler`](#UserEventHandler).[`viewContent`](UserEventHandler.md#viewcontent)
+
+### interfaces
+
+  ### <a id="CommonFields"></a>CommonFields
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extended by
+
+- [`FunnelStartedFields`](#FunnelStartedFields)
+- [`PurchaseFields`](#PurchaseFields)
+- [`TestStartedFields`](#TestStartedFields)
+- [`UserClickFields`](#UserClickFields)
+- [`ViewContentFields`](#ViewContentFields)
+
+## Properties
+
+### funnel?
+
+```ts
+optional funnel: string;
+```
+
+***
+
+### testData?
+
+```ts
+optional testData: string;
+```
+
+  ### <a id="FunnelStartedFields"></a>FunnelStartedFields
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extends
+
+- [`CommonFields`](#CommonFields)
+
+## Properties
+
+### 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)
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+  ### <a id="PurchaseFields"></a>PurchaseFields
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extends
+
+- [`CommonFields`](#CommonFields)
+
+## Properties
+
+### 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?
+
+```ts
+optional name: string;
+```
+
+***
+
+### price?
+
+```ts
+optional price: number;
+```
+
+***
+
+### value?
+
+```ts
+optional value: number;
+```
+
+  ### <a id="TestStartedFields"></a>TestStartedFields
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extends
+
+- [`CommonFields`](#CommonFields)
+
+## Properties
+
+### 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)
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+  ### <a id="UserClickFields"></a>UserClickFields
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Extends
+
+- [`CommonFields`](#CommonFields)
+
+## Properties
+
+### 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;
+```
+
+***
+
+### intent?
+
+```ts
+optional intent: string;
+```
+
+***
+
+### placement?
+
+```ts
+optional placement: string;
+```
+
+  ### <a id="UserEvent"></a>UserEvent
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Properties
+
+### 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)
+
+***
+
+## Extends
+
+- [`CommonFields`](#CommonFields)
+
+## Properties
+
+### 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)
+
+***
+
+### name
+
+```ts
+name: string;
+```
+
+***
+
+### path
+
+```ts
+path: string;
+```
+
+  ### <a id="XyLabsTrackingEventJson"></a>XyLabsTrackingEventJson
+
+[**@xylabs/pixel**](#../README)
+
+***
+
+## Properties
+
+### 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: Record<string, string>;
+```
+
+***
+
+### fields?
+
+```ts
+optional fields: Record<string, unknown>;
+```
+
+***
+
+### host?
+
+```ts
+optional host: string;
+```
+
+***
+
+### ip?
+
+```ts
+optional ip: string;
+```
+
+***
+
+### pathname?
+
+```ts
+optional pathname: string;
+```
+
+***
+
+### 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;
+```
 
-Coming Soon!
 
 Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/pixel",
-  "version": "4.13.20",
+  "version": "4.13.22",
   "description": "Event Client for xylabs ESB",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -35,10 +35,10 @@
     "src"
   ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.20",
-    "@xylabs/object": "^4.13.20",
-    "@xylabs/promise": "^4.13.20",
-    "@xylabs/typeof": "^4.13.20",
+    "@xylabs/assert": "^4.13.22",
+    "@xylabs/object": "^4.13.22",
+    "@xylabs/promise": "^4.13.22",
+    "@xylabs/typeof": "^4.13.22",
     "async-mutex": "^0.5.0",
     "axios": "^1.10.0",
     "bowser": "^2.11.0",
@@ -48,7 +48,7 @@
   },
   "devDependencies": {
     "@types/js-cookie": "^3.0.6",
-    "@types/node": "^24.0.14",
+    "@types/node": "^24.0.15",
     "@types/spark-md5": "^3.0.5",
     "@xylabs/ts-scripts-yarn3": "^7.0.0",
     "@xylabs/tsconfig-dom": "^7.0.0",