@xylabs/pixel

[![logo][]](https://xylabs.com)

[![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

Reference

@xylabs/pixel

*

Classes

- PixelApi
- XyPixel
- Referrer
- UniqueUserId
- UserEventHandler
- UtmFields
- XyUserEventHandler

Interfaces

- UserEvent
- CommonFields
- FunnelStartedFields
- PurchaseFields
- TestStartedFields
- UserClickFields
- ViewContentFields
- XyLabsTrackingEventJson

Type Aliases

- UserEventSystem

$3

### PixelApi

@xylabs/pixel

*

Constructors

$3

``ts
new PixelApi(baseUri): PixelApi;
`

$3

#### baseUri

string = 'prod'

$3

PixelApi

Methods

$3

`ts
trackEvents(events): Promise;
`

$3

#### events

UserEvent[]

$3

Promise\<any\>

### Referrer

@xylabs/pixel

*

Constructors

$3

`ts
new Referrer(): Referrer;
`

$3

Referrer

Properties

$3

`ts
local: string;
`

*

$3

`ts
session: string;
`

Methods

$3

`ts
toJson():
| undefined
| {
local: string;
session: string;
};
`

$3

\| undefined
\| \{
local: string;
session: string;
\}

### UniqueUserId

@xylabs/pixel

*

Constructors

$3

`ts
new UniqueUserId(): UniqueUserId;
`

$3

UniqueUserId

Properties

$3

`ts
id: string;
`

Methods

$3

`ts
toString(): string;
`

$3

string

### UserEventHandler

@xylabs/pixel

*

Extended by

- XyUserEventHandler

Type Parameters

$3

TData extends EmptyObject

Constructors

$3

`ts
new UserEventHandler(): UserEventHandler;
`

$3

UserEventHandler\<TData\>

Methods

$3

`ts
abstract funnelStarted(fields): Promisable;
`

$3

#### T

T extends object

$3

#### fields

FunnelStartedFields | T

$3

Promisable\<void\>

*

$3

`ts
abstract testStarted(fields): Promisable;
`

$3

#### T

T extends object

$3

#### fields

TestStartedFields | T

$3

Promisable\<void\>

*

$3

`ts
abstract userClick(fields): Promisable;
`

$3

#### T

T extends object

$3

#### fields

UserClickFields | T

$3

Promisable\<void\>

*

$3

`ts
abstract viewContent(fields): Promisable;
`

$3

#### T

T extends object

$3

#### fields

T | ViewContentFields

$3

Promisable\<void\>

### UtmFields

@xylabs/pixel

*

Constructors

$3

`ts
new UtmFields(): UtmFields;
`

$3

UtmFields

Properties

$3

`ts
fields: Record[] = [];
`

Methods

$3

`ts
getUtmRecord(): null | Record;
`

$3

null \| Record\<string, string\>

*

$3

`ts
toString(): string;
`

$3

string

*

$3

`ts
update(): Record[];
`

$3

Record\<string, string\>[]

### XyPixel

@xylabs/pixel

*

Properties

$3

`ts
static api: PixelApi;
`

*

$3

`ts
cid: string;
`

*

$3

`ts
optional email: string;
`

*

$3

`ts
optional email_hash: null | string;
`

*

$3

`ts
optional exids: ExIds;
`

*

$3

`ts
optional pixelId: string;
`

*

$3

`ts
queue: UserEvent[] = [];
`

Accessors

$3

$3

`ts
get static instance(): XyPixel;
`

#### Returns

XyPixel

Methods

$3

`ts
static init(pixelId): XyPixel;
`

$3

#### pixelId

string

$3

XyPixel

*

$3

`ts
static selectApi(api): void;
`

$3

#### api

PixelApi

$3

void

*

$3

`ts
identify(email?): void;
`

$3

#### email?

string

$3

void

*

$3

`ts
send(
event,
fields?,
eventId?): Promise;
`

$3

#### T

T extends JsonObject

$3

#### event

string

#### fields?

T

#### eventId?

string

$3

Promise\<void\>

### XyUserEventHandler

@xylabs/pixel

*

Extends

- UserEventHandler\<T\>

Type Parameters

$3

T extends EmptyObject = EmptyObject

Constructors

$3

`ts
new XyUserEventHandler(): XyUserEventHandler;
`

$3

XyUserEventHandler\<T\>

$3

UserEventHandler.constructor

Methods

$3

`ts
funnelStarted(fields): Promise;
`

$3

#### fields

FunnelStartedFields | T

$3

Promise\<void\>

$3

UserEventHandler.funnelStarted

*

$3

`ts
purchase(fields): Promise;
`

$3

#### fields

PurchaseFields | T

$3

Promise\<void\>

*

$3

`ts
testStarted(fields): Promise;
`

$3

#### fields

TestStartedFields | T

$3

Promise\<void\>

$3

UserEventHandler.testStarted

*

$3

`ts
userClick(fields): Promise;
`

$3

#### fields

UserClickFields | T

$3

Promise\<void\>

$3

UserEventHandler.userClick

*

$3

`ts
viewContent(fields): Promise;
`

$3

#### fields

ViewContentFields | T

$3

Promise\<void\>

$3

UserEventHandler.viewContent

$3

### CommonFields

@xylabs/pixel

*

Extended by

- FunnelStartedFields
- PurchaseFields
- TestStartedFields
- UserClickFields
- ViewContentFields

Properties

$3

`ts
optional funnel: string;
`

*

$3

`ts
optional testData: string;
`

### FunnelStartedFields

@xylabs/pixel

*

Extends

- CommonFields

Properties

$3

`ts
optional funnel: string;
`

$3

CommonFields.funnel

*

$3

`ts
optional testData: string;
`

$3

CommonFields.testData

*

$3

`ts
name: string;
`

### PurchaseFields

@xylabs/pixel

*

Extends

- CommonFields

Properties

$3

`ts
optional funnel: string;
`

$3

CommonFields.funnel

*

$3

`ts
optional testData: string;
`

$3

CommonFields.testData

*

$3

`ts
id: string;
`

*

$3

`ts
optional name: string;
`

*

$3

`ts
optional price: number;
`

*

$3

`ts
optional value: number;
`

### TestStartedFields

@xylabs/pixel

*

Extends

- CommonFields

Properties

$3

`ts
optional funnel: string;
`

$3

CommonFields.funnel

*

$3

`ts
optional testData: string;
`

$3

CommonFields.testData

*

$3

`ts
name: string;
`

### UserClickFields

@xylabs/pixel

*

Extends

- CommonFields

Properties

$3

`ts
optional funnel: string;
`

$3

CommonFields.funnel

*

$3

`ts
optional testData: string;
`

$3

CommonFields.testData

*

$3

`ts
elementName: string;
`

*

$3

`ts
elementType: string;
`

*

$3

`ts
optional intent: string;
`

*

$3

`ts
optional placement: string;
`

### UserEvent

@xylabs/pixel

*

Properties

$3

`ts
cid: string;
`

*

$3

`ts
optional create_time: number;
`

*

$3

`ts
optional email: string;
`

*

$3

`ts
optional email_hash: string;
`

*

$3

`ts
optional event: string;
`

*

$3

`ts
optional event_id: string;
`

*

$3

`ts
optional exids: ExIds;
`

*

$3

`ts
optional fields: Record;
`

*

$3

`ts
optional host: string;
`

*

$3

`ts
optional pathname: string;
`

*

$3

`ts
optional pixel: string;
`

*

$3

`ts
optional receive_time: number;
`

*

$3

`ts
optional referrer: object;
`

$3

`ts
local: string;
`

$3

`ts
session: string;
`

*

$3

`ts
optional rid: string;
`

*

$3

`ts
optional system: ParsedResult;
`

*

$3

`ts
optional uid: string;
`

*

$3

`ts
optional utm: Record[] | Record;
`

### ViewContentFields

@xylabs/pixel

*

Extends

- CommonFields

Properties

$3

`ts
optional funnel: string;
`

$3

CommonFields.funnel

*

$3

`ts
optional testData: string;
`

$3

CommonFields.testData

*

$3

`ts
name: string;
`

*

$3

`ts
path: string;
`

### XyLabsTrackingEventJson

@xylabs/pixel

*

Properties

$3

`ts
cid: string;
`

*

$3

`ts
optional create_time: number;
`

*

$3

`ts
optional email: string;
`

*

$3

`ts
optional email_hash: string;
`

*

$3

`ts
optional event: string;
`

*

$3

`ts
optional event_id: string;
`

*

$3

`ts
optional exids: Record;
`

*

$3

`ts
optional fields: Record;
`

*

$3

`ts
optional host: string;
`

*

$3

`ts
optional ip: string;
`

*

$3

`ts
optional pathname: string;
`

*

$3

`ts
optional pixel: string;
`

*

$3

`ts
optional receive_time: number;
`

*

$3

`ts
optional rid: string;
`

*

$3

`ts
optional system: unknown;
`

*

$3

`ts
optional ua: string;
`

*

$3

`ts
optional uid: string;
`

*

$3

`ts
optional utm: Record[] | Record;
`

$3

### UserEventSystem

@xylabs/pixel

*

`ts
type UserEventSystem = Bowser.Parser.ParsedResult;
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[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

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/pixel
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/pixel

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/pixel/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/pixel

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/pixel
[socket-link]: https://socket.dev/npm/package/@xylabs/pixel