@xylabs/pixel 4.13.15 → 4.13.17

package/README.md

@@ -1,73 +1,60 @@
-[![logo][]](https://xylabs.com)
+# @xylabs/pixel
 
-# sdk-pixel-js
+[![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]
 
-> This library is made public by XY Labs
-
-## Table of Contents
-
--   [Title](#sdk-pixel-js)
--   [Description](#description)
--   [Install](#install)
--   [Scripts](#scripts)
--   [Maintainers](#maintainers)
--   [License](#license)
--   [Credits](#credits)
-
-## Description
+Version: 4.13.15
 
-SDK for User Event Reporting
+Event Client for xylabs ESB
 
-## Install
+## Documentation
 
-Using npm:
+Coming Soon!
 
-```sh
-npm i --save @xylabs/sdk-js
-```
-
-Using yarn:
-
-```sh
-yarn add @xylabs/sdk-js
-```
-
-## Scripts
-
-See [ts-scripts](https://github.com/xylabs/ts-scripts/blob/main/README.md) for
-list of shared scripts.
+Part of [sdk-js](https://www.npmjs.com/package/@xyo-network/sdk-js)
 
 ## Maintainers
 
--   [Arie Trouw](https://github.com/arietrouw) (<https://arietrouw.com>)
+-   [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)
 
 ## License
 
-See the [LICENSE](LICENSE) file for license details
+> See the [LICENSE](LICENSE) file for license details
 
 ## Credits
 
-Made with 🔥and ❄️ by [XY Labs](https://xylabs.com)
+[Made with 🔥 and ❄️ by XYLabs](https://xylabs.com)
 
 [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
 
-[main-build]: https://github.com/xylabs/sdk-pixel-js/actions/workflows/build.yml/badge.svg
-[main-build-link]: https://github.com/xylabs/sdk-pixel-js/actions/workflows/build.yml
-
+[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
 
-[codacy-badge]: https://app.codacy.com/project/badge/Grade/c5405a253a0d489a98b2aa711c3c0824
-[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-pixel-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-pixel-js&utm_campaign=Badge_Grade
+[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/pixel
+[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/pixel
 
-[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c926665bade6b2493e32/maintainability
-[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-pixel-js/maintainability
+[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/pixel/badge
+[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/pixel
 
-[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-pixel-js/badge.svg?targetFile=package.json
-[snyk-link]: https://snyk.io/test/github/xylabs/sdk-pixel-js?targetFile=package.json
+[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/pixel
+[socket-link]: https://socket.dev/npm/package/@xylabs/pixel

package/dist/browser/index.d.ts

@@ -1,168 +1,15 @@
-import Bowser from 'bowser';
-import { JsonObject, EmptyObject } from '@xylabs/object';
-import { Promisable } from '@xylabs/promise';
-
-interface ExIds {
-    fbc?: string;
-    fbp?: string;
-    ga?: string;
-    gclid?: string;
-    rdt_uid?: string;
-    scid?: string;
-    tt_sessionId?: string;
-}
-
-type UserEventSystem = Bowser.Parser.ParsedResult;
-
-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[]>;
-}
-
-declare class PixelApi {
-    private endPoint;
-    constructor(baseUri?: string);
-    trackEvents(events: UserEvent[]): Promise<any>;
-}
-
-interface CommonFields {
-    funnel?: string;
-    testData?: string;
-}
-
-interface FunnelStartedFields extends CommonFields {
-    name: string;
-}
-
-declare class XyPixel {
-    static api: PixelApi;
-    private static _instance?;
-    private static utmFieldsObj;
-    cid: string;
-    email?: string;
-    email_hash?: string | null;
-    exids?: ExIds;
-    pixelId?: string;
-    queue: UserEvent[];
-    private queueMutex;
-    private constructor();
-    static get instance(): XyPixel;
-    static init(pixelId: string): XyPixel;
-    static selectApi(api: PixelApi): void;
-    private static utmFields;
-    identify(email?: string): void;
-    send<T extends JsonObject>(event: string, fields?: T, eventId?: string): Promise<void>;
-    private tryFlushQueue;
-    private updateFbId;
-}
-
-interface PurchaseFields extends CommonFields {
-    id: string;
-    name?: string;
-    price?: number;
-    value?: number;
-}
-
-declare class Referrer {
-    private static storageId;
-    local: string;
-    session: string;
-    constructor();
-    toJson(): {
-        local: string;
-        session: string;
-    } | undefined;
-    private getFromLocal;
-    private getFromSession;
-}
-
-interface TestStartedFields extends CommonFields {
-    name: string;
-}
-
-declare class UniqueUserId {
-    private static localStorageId;
-    id: string;
-    constructor();
-    toString(): string;
-    private generateId;
-}
-
-interface UserClickFields extends CommonFields {
-    elementName: string;
-    elementType: string;
-    intent?: string;
-    placement?: string;
-}
-
-interface ViewContentFields extends CommonFields {
-    name: string;
-    path: string;
-}
-
-declare 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>;
-}
-
-declare class UtmFields {
-    private static localStorageId;
-    fields: Record<string, string>[];
-    constructor();
-    getUtmRecord: () => Record<string, string> | null;
-    toString(): string;
-    update(): Record<string, string>[];
-}
-
-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[]>;
-}
-
-declare class XyUserEventHandler<T extends EmptyObject = EmptyObject> extends UserEventHandler<T> {
-    constructor();
-    funnelStarted(fields: T | FunnelStartedFields): Promise<void>;
-    purchase(fields: T | PurchaseFields): Promise<void>;
-    testStarted(fields: T | TestStartedFields): Promise<void>;
-    userClick(fields: T | UserClickFields): Promise<void>;
-    viewContent(fields: T | ViewContentFields): Promise<void>;
-}
-
-export { PixelApi, Referrer, UniqueUserId, UserEventHandler, UtmFields, XyPixel, XyUserEventHandler };
-export type { CommonFields, FunnelStartedFields, PurchaseFields, TestStartedFields, UserClickFields, UserEvent, UserEventSystem, ViewContentFields, XyLabsTrackingEventJson };
+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';
+//# sourceMappingURL=index.d.ts.map

package/dist/browser/spec/Pixel.spec.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @vitest-environment jsdom
+ */
+export {};
+//# sourceMappingURL=Pixel.spec.d.ts.map

package/dist/browser/spec/Pixel.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Pixel.spec.d.ts","sourceRoot":"","sources":["../../../src/spec/Pixel.spec.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xylabs/pixel",
-  "version": "4.13.15",
+  "version": "4.13.17",
   "description": "Event Client for xylabs ESB",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -29,10 +29,10 @@
   "module": "dist/browser/index.mjs",
   "types": "dist/browser/index.d.ts",
   "dependencies": {
-    "@xylabs/assert": "^4.13.15",
-    "@xylabs/object": "^4.13.15",
-    "@xylabs/promise": "^4.13.15",
-    "@xylabs/typeof": "^4.13.15",
+    "@xylabs/assert": "^4.13.17",
+    "@xylabs/object": "^4.13.17",
+    "@xylabs/promise": "^4.13.17",
+    "@xylabs/typeof": "^4.13.17",
     "async-mutex": "^0.5.0",
     "axios": "^1.10.0",
     "bowser": "^2.11.0",
@@ -42,10 +42,10 @@
   },
   "devDependencies": {
     "@types/js-cookie": "^3.0.6",
-    "@types/node": "^24.0.13",
+    "@types/node": "^24.0.14",
     "@types/spark-md5": "^3.0.5",
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.20",
-    "@xylabs/tsconfig-dom": "^7.0.0-rc.20",
+    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
+    "@xylabs/tsconfig-dom": "^7.0.0-rc.27",
     "axios": "^1.10.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"

package/build/browser/index.d.ts

@@ -1,15 +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';
-//# sourceMappingURL=index.d.ts.map