@beworke/pixel 0.1.0-rc.1

package/dist/index-DUfFzniE.d.mts

@@ -0,0 +1,274 @@
+type AttributionIdentifiers = {
+    readonly fbclid?: string;
+    readonly fbp?: string;
+    readonly fbc?: string;
+    readonly gclid?: string;
+    readonly gbraid?: string;
+    readonly wbraid?: string;
+    readonly ga?: string;
+    readonly gid?: string;
+    readonly gclAu?: string;
+    readonly ttclid?: string;
+    readonly ttp?: string;
+    readonly msclkid?: string;
+    readonly liFatId?: string;
+    readonly epik?: string;
+    readonly customClickIds?: Readonly<Record<string, string>>;
+    readonly firstCollectedAt?: number;
+    readonly lastCollectedAt?: number;
+    readonly landingUrl?: string;
+    readonly referrer?: string;
+};
+type AttributionConfig = {
+    readonly enabled: boolean;
+    readonly ttlDays?: number;
+    readonly persist?: boolean;
+    readonly captureUrlParams?: boolean;
+    readonly captureCookies?: boolean;
+    readonly customClickIdParams?: string[];
+};
+declare const DEFAULT_ATTRIBUTION_CONFIG: AttributionConfig;
+declare const ATTRIBUTION_STORAGE_KEY = "attribution";
+interface AttributionService {
+    init(): void;
+    destroy(): void;
+    collect(): AttributionIdentifiers;
+    getSnapshot(): AttributionIdentifiers;
+    update(partial: Partial<AttributionIdentifiers>): AttributionIdentifiers;
+    clear(): void;
+}
+
+interface BasePixelEvent {
+    readonly type: string;
+    readonly timestamp: number;
+    readonly path?: string;
+    readonly url?: string;
+    readonly hostname?: string;
+    readonly language?: string;
+    readonly timezone?: string;
+    /** Attribution click IDs / cookies — anexados pelo BaseEventBuilder. */
+    readonly identifiers?: AttributionIdentifiers;
+}
+
+interface PageViewEvent extends BasePixelEvent {
+    readonly type: 'PAGE_VIEW';
+}
+
+type PixelEventCategory = 'ENGAGEMENT' | 'CONVERSION' | 'IDENTITY' | 'SESSION' | 'SYSTEM' | 'INTEGRATION';
+type EngagementEventCategory = 'ENGAGEMENT';
+type ConversionEventCategory = 'CONVERSION';
+
+interface ScrollEvent extends BasePixelEvent {
+    readonly type: 'SCROLL';
+    readonly category: EngagementEventCategory;
+    readonly maxScrollPercent: number;
+    readonly scrollEvents: number;
+    readonly scrollVelocityAvg?: number;
+    readonly lastScrollAt?: number;
+}
+
+interface ElementDescriptor {
+    readonly tagName?: string;
+    readonly id?: string;
+    readonly classes?: string[];
+    readonly text?: string;
+    readonly role?: string;
+    readonly name?: string;
+    readonly dataset?: Record<string, string>;
+}
+
+interface PageClickEvent extends BasePixelEvent {
+    readonly type: 'PAGE_CLICK';
+    readonly category: EngagementEventCategory;
+    readonly clickCount: number;
+    readonly lastClickAt: number;
+    readonly rageClickCount?: number;
+    readonly target?: ElementDescriptor;
+    readonly currentTarget?: ElementDescriptor;
+    readonly clientX?: number;
+    readonly clientY?: number;
+    readonly pageX?: number;
+    readonly pageY?: number;
+    readonly offsetX?: number;
+    readonly offsetY?: number;
+}
+
+interface RageClickEvent extends BasePixelEvent {
+    readonly type: 'RAGE_CLICK';
+    readonly category: EngagementEventCategory;
+    readonly threshold: number;
+    readonly windowMs: number;
+    readonly clickCount: number;
+    readonly target?: ElementDescriptor;
+}
+
+interface VisibilityChangeEvent extends BasePixelEvent {
+    readonly type: 'VISIBILITY_CHANGE';
+    readonly category: EngagementEventCategory;
+    readonly isVisible: boolean;
+    readonly visibleSince?: number;
+    readonly hiddenAt?: number | null;
+}
+
+interface UserIdleEvent extends BasePixelEvent {
+    readonly type: 'USER_IDLE';
+    readonly category: EngagementEventCategory;
+    readonly idleSince: number;
+    readonly thresholdMs: number;
+}
+
+interface UserActiveEvent extends BasePixelEvent {
+    readonly type: 'USER_ACTIVE';
+    readonly category: EngagementEventCategory;
+    readonly activeAt: number;
+    readonly previousIdleDurationMs?: number;
+}
+
+interface ExitIntentEvent extends BasePixelEvent {
+    readonly type: 'EXIT_INTENT';
+    readonly category: EngagementEventCategory;
+    readonly triggeredAt: number;
+    readonly clientY?: number;
+}
+
+interface SessionRenewedEvent extends BasePixelEvent {
+    readonly type: 'SESSION_RENEWED';
+    readonly sessionId: string;
+    readonly previousSessionId?: string;
+}
+
+interface SessionExpiredEvent extends BasePixelEvent {
+    readonly type: 'SESSION_EXPIRED';
+    readonly sessionId: string;
+}
+
+interface PixelItem {
+    readonly id?: string;
+    readonly name?: string;
+    readonly category?: string;
+    readonly price?: number;
+    readonly quantity?: number;
+}
+interface PurchaseData {
+    readonly value?: number;
+    readonly currency?: string;
+    readonly orderId?: string;
+    readonly items?: PixelItem[];
+}
+interface LeadData {
+    readonly email?: string;
+    readonly phone?: string;
+    readonly name?: string;
+    readonly fields?: Record<string, unknown>;
+}
+interface AddToCartData {
+    readonly productId?: string;
+    readonly productName?: string;
+    readonly price?: number;
+    readonly currency?: string;
+    readonly quantity?: number;
+}
+interface RemoveFromCartData {
+    readonly productId?: string;
+    readonly quantity?: number;
+}
+interface InitiateCheckoutData {
+    readonly value?: number;
+    readonly currency?: string;
+    readonly items?: PixelItem[];
+}
+type PaymentMethod = 'CREDIT_CARD' | 'PIX' | 'BOLETO' | 'PAYPAL' | 'OTHER';
+interface AddPaymentInfoData {
+    readonly paymentMethod?: PaymentMethod;
+}
+interface ViewContentData {
+    readonly contentId?: string;
+    readonly contentType?: string;
+    readonly category?: string;
+    readonly value?: number;
+    readonly currency?: string;
+}
+interface SearchData {
+    readonly query: string;
+}
+type ConversionEventData = PurchaseData | LeadData | AddToCartData | RemoveFromCartData | InitiateCheckoutData | AddPaymentInfoData | ViewContentData | SearchData;
+
+interface PurchaseEvent extends BasePixelEvent {
+    readonly type: 'PURCHASE';
+    readonly category: ConversionEventCategory;
+    readonly data: PurchaseData;
+}
+
+interface LeadEvent extends BasePixelEvent {
+    readonly type: 'LEAD';
+    readonly category: ConversionEventCategory;
+    readonly data: LeadData;
+}
+
+interface AddToCartEvent extends BasePixelEvent {
+    readonly type: 'ADD_TO_CART';
+    readonly category: ConversionEventCategory;
+    readonly data: AddToCartData;
+}
+
+interface RemoveFromCartEvent extends BasePixelEvent {
+    readonly type: 'REMOVE_FROM_CART';
+    readonly category: ConversionEventCategory;
+    readonly data: RemoveFromCartData;
+}
+
+interface InitiateCheckoutEvent extends BasePixelEvent {
+    readonly type: 'INITIATE_CHECKOUT';
+    readonly category: ConversionEventCategory;
+    readonly data: InitiateCheckoutData;
+}
+
+interface AddPaymentInfoEvent extends BasePixelEvent {
+    readonly type: 'ADD_PAYMENT_INFO';
+    readonly category: ConversionEventCategory;
+    readonly data: AddPaymentInfoData;
+}
+
+interface ViewContentEvent extends BasePixelEvent {
+    readonly type: 'VIEW_CONTENT';
+    readonly category: ConversionEventCategory;
+    readonly data: ViewContentData;
+}
+
+interface SearchEvent extends BasePixelEvent {
+    readonly type: 'SEARCH';
+    readonly category: ConversionEventCategory;
+    readonly data: SearchData;
+}
+
+type PixelEvent = PageViewEvent | SessionRenewedEvent | SessionExpiredEvent | ScrollEvent | PageClickEvent | RageClickEvent | VisibilityChangeEvent | UserIdleEvent | UserActiveEvent | ExitIntentEvent | PurchaseEvent | LeadEvent | AddToCartEvent | RemoveFromCartEvent | InitiateCheckoutEvent | AddPaymentInfoEvent | ViewContentEvent | SearchEvent;
+
+interface BrowserMetadata {
+    readonly url?: string;
+    readonly path?: string;
+    readonly hostname?: string;
+    readonly origin?: string;
+    readonly title?: string;
+    readonly referrer?: string;
+    readonly language?: string;
+    readonly timezone?: string;
+    readonly userAgent?: string;
+    readonly platform?: string;
+    readonly screenWidth?: number;
+    readonly screenHeight?: number;
+    readonly colorDepth?: number;
+}
+interface BrowserMetadataService {
+    getMetadata(): BrowserMetadata;
+}
+
+declare class BaseEventBuilder {
+    private readonly metadataService;
+    private readonly attribution;
+    constructor(metadataService: BrowserMetadataService, attribution?: AttributionService | null);
+    build<T extends {
+        type: string;
+    }>(event: T): T & BasePixelEvent;
+}
+
+export { type AttributionService as A, type BrowserMetadataService as B, type ConversionEventData as C, DEFAULT_ATTRIBUTION_CONFIG as D, type ExitIntentEvent as E, type PixelEventCategory as F, type EngagementEventCategory as G, type ConversionEventCategory as H, type InitiateCheckoutData as I, type ElementDescriptor as J, type LeadData as L, type PixelEvent as P, type RemoveFromCartData as R, type SessionRenewedEvent as S, type UserIdleEvent as U, type ViewContentData as V, BaseEventBuilder as a, type AttributionConfig as b, type AttributionIdentifiers as c, type BrowserMetadata as d, type BasePixelEvent as e, type PageViewEvent as f, type SessionExpiredEvent as g, ATTRIBUTION_STORAGE_KEY as h, type PurchaseData as i, type AddToCartData as j, type AddPaymentInfoData as k, type SearchData as l, type ScrollEvent as m, type PageClickEvent as n, type RageClickEvent as o, type VisibilityChangeEvent as p, type UserActiveEvent as q, type PurchaseEvent as r, type LeadEvent as s, type AddToCartEvent as t, type RemoveFromCartEvent as u, type InitiateCheckoutEvent as v, type AddPaymentInfoEvent as w, type ViewContentEvent as x, type SearchEvent as y, type PixelItem as z };

package/dist/index-DUfFzniE.d.ts

@@ -0,0 +1,274 @@
+type AttributionIdentifiers = {
+    readonly fbclid?: string;
+    readonly fbp?: string;
+    readonly fbc?: string;
+    readonly gclid?: string;
+    readonly gbraid?: string;
+    readonly wbraid?: string;
+    readonly ga?: string;
+    readonly gid?: string;
+    readonly gclAu?: string;
+    readonly ttclid?: string;
+    readonly ttp?: string;
+    readonly msclkid?: string;
+    readonly liFatId?: string;
+    readonly epik?: string;
+    readonly customClickIds?: Readonly<Record<string, string>>;
+    readonly firstCollectedAt?: number;
+    readonly lastCollectedAt?: number;
+    readonly landingUrl?: string;
+    readonly referrer?: string;
+};
+type AttributionConfig = {
+    readonly enabled: boolean;
+    readonly ttlDays?: number;
+    readonly persist?: boolean;
+    readonly captureUrlParams?: boolean;
+    readonly captureCookies?: boolean;
+    readonly customClickIdParams?: string[];
+};
+declare const DEFAULT_ATTRIBUTION_CONFIG: AttributionConfig;
+declare const ATTRIBUTION_STORAGE_KEY = "attribution";
+interface AttributionService {
+    init(): void;
+    destroy(): void;
+    collect(): AttributionIdentifiers;
+    getSnapshot(): AttributionIdentifiers;
+    update(partial: Partial<AttributionIdentifiers>): AttributionIdentifiers;
+    clear(): void;
+}
+
+interface BasePixelEvent {
+    readonly type: string;
+    readonly timestamp: number;
+    readonly path?: string;
+    readonly url?: string;
+    readonly hostname?: string;
+    readonly language?: string;
+    readonly timezone?: string;
+    /** Attribution click IDs / cookies — anexados pelo BaseEventBuilder. */
+    readonly identifiers?: AttributionIdentifiers;
+}
+
+interface PageViewEvent extends BasePixelEvent {
+    readonly type: 'PAGE_VIEW';
+}
+
+type PixelEventCategory = 'ENGAGEMENT' | 'CONVERSION' | 'IDENTITY' | 'SESSION' | 'SYSTEM' | 'INTEGRATION';
+type EngagementEventCategory = 'ENGAGEMENT';
+type ConversionEventCategory = 'CONVERSION';
+
+interface ScrollEvent extends BasePixelEvent {
+    readonly type: 'SCROLL';
+    readonly category: EngagementEventCategory;
+    readonly maxScrollPercent: number;
+    readonly scrollEvents: number;
+    readonly scrollVelocityAvg?: number;
+    readonly lastScrollAt?: number;
+}
+
+interface ElementDescriptor {
+    readonly tagName?: string;
+    readonly id?: string;
+    readonly classes?: string[];
+    readonly text?: string;
+    readonly role?: string;
+    readonly name?: string;
+    readonly dataset?: Record<string, string>;
+}
+
+interface PageClickEvent extends BasePixelEvent {
+    readonly type: 'PAGE_CLICK';
+    readonly category: EngagementEventCategory;
+    readonly clickCount: number;
+    readonly lastClickAt: number;
+    readonly rageClickCount?: number;
+    readonly target?: ElementDescriptor;
+    readonly currentTarget?: ElementDescriptor;
+    readonly clientX?: number;
+    readonly clientY?: number;
+    readonly pageX?: number;
+    readonly pageY?: number;
+    readonly offsetX?: number;
+    readonly offsetY?: number;
+}
+
+interface RageClickEvent extends BasePixelEvent {
+    readonly type: 'RAGE_CLICK';
+    readonly category: EngagementEventCategory;
+    readonly threshold: number;
+    readonly windowMs: number;
+    readonly clickCount: number;
+    readonly target?: ElementDescriptor;
+}
+
+interface VisibilityChangeEvent extends BasePixelEvent {
+    readonly type: 'VISIBILITY_CHANGE';
+    readonly category: EngagementEventCategory;
+    readonly isVisible: boolean;
+    readonly visibleSince?: number;
+    readonly hiddenAt?: number | null;
+}
+
+interface UserIdleEvent extends BasePixelEvent {
+    readonly type: 'USER_IDLE';
+    readonly category: EngagementEventCategory;
+    readonly idleSince: number;
+    readonly thresholdMs: number;
+}
+
+interface UserActiveEvent extends BasePixelEvent {
+    readonly type: 'USER_ACTIVE';
+    readonly category: EngagementEventCategory;
+    readonly activeAt: number;
+    readonly previousIdleDurationMs?: number;
+}
+
+interface ExitIntentEvent extends BasePixelEvent {
+    readonly type: 'EXIT_INTENT';
+    readonly category: EngagementEventCategory;
+    readonly triggeredAt: number;
+    readonly clientY?: number;
+}
+
+interface SessionRenewedEvent extends BasePixelEvent {
+    readonly type: 'SESSION_RENEWED';
+    readonly sessionId: string;
+    readonly previousSessionId?: string;
+}
+
+interface SessionExpiredEvent extends BasePixelEvent {
+    readonly type: 'SESSION_EXPIRED';
+    readonly sessionId: string;
+}
+
+interface PixelItem {
+    readonly id?: string;
+    readonly name?: string;
+    readonly category?: string;
+    readonly price?: number;
+    readonly quantity?: number;
+}
+interface PurchaseData {
+    readonly value?: number;
+    readonly currency?: string;
+    readonly orderId?: string;
+    readonly items?: PixelItem[];
+}
+interface LeadData {
+    readonly email?: string;
+    readonly phone?: string;
+    readonly name?: string;
+    readonly fields?: Record<string, unknown>;
+}
+interface AddToCartData {
+    readonly productId?: string;
+    readonly productName?: string;
+    readonly price?: number;
+    readonly currency?: string;
+    readonly quantity?: number;
+}
+interface RemoveFromCartData {
+    readonly productId?: string;
+    readonly quantity?: number;
+}
+interface InitiateCheckoutData {
+    readonly value?: number;
+    readonly currency?: string;
+    readonly items?: PixelItem[];
+}
+type PaymentMethod = 'CREDIT_CARD' | 'PIX' | 'BOLETO' | 'PAYPAL' | 'OTHER';
+interface AddPaymentInfoData {
+    readonly paymentMethod?: PaymentMethod;
+}
+interface ViewContentData {
+    readonly contentId?: string;
+    readonly contentType?: string;
+    readonly category?: string;
+    readonly value?: number;
+    readonly currency?: string;
+}
+interface SearchData {
+    readonly query: string;
+}
+type ConversionEventData = PurchaseData | LeadData | AddToCartData | RemoveFromCartData | InitiateCheckoutData | AddPaymentInfoData | ViewContentData | SearchData;
+
+interface PurchaseEvent extends BasePixelEvent {
+    readonly type: 'PURCHASE';
+    readonly category: ConversionEventCategory;
+    readonly data: PurchaseData;
+}
+
+interface LeadEvent extends BasePixelEvent {
+    readonly type: 'LEAD';
+    readonly category: ConversionEventCategory;
+    readonly data: LeadData;
+}
+
+interface AddToCartEvent extends BasePixelEvent {
+    readonly type: 'ADD_TO_CART';
+    readonly category: ConversionEventCategory;
+    readonly data: AddToCartData;
+}
+
+interface RemoveFromCartEvent extends BasePixelEvent {
+    readonly type: 'REMOVE_FROM_CART';
+    readonly category: ConversionEventCategory;
+    readonly data: RemoveFromCartData;
+}
+
+interface InitiateCheckoutEvent extends BasePixelEvent {
+    readonly type: 'INITIATE_CHECKOUT';
+    readonly category: ConversionEventCategory;
+    readonly data: InitiateCheckoutData;
+}
+
+interface AddPaymentInfoEvent extends BasePixelEvent {
+    readonly type: 'ADD_PAYMENT_INFO';
+    readonly category: ConversionEventCategory;
+    readonly data: AddPaymentInfoData;
+}
+
+interface ViewContentEvent extends BasePixelEvent {
+    readonly type: 'VIEW_CONTENT';
+    readonly category: ConversionEventCategory;
+    readonly data: ViewContentData;
+}
+
+interface SearchEvent extends BasePixelEvent {
+    readonly type: 'SEARCH';
+    readonly category: ConversionEventCategory;
+    readonly data: SearchData;
+}
+
+type PixelEvent = PageViewEvent | SessionRenewedEvent | SessionExpiredEvent | ScrollEvent | PageClickEvent | RageClickEvent | VisibilityChangeEvent | UserIdleEvent | UserActiveEvent | ExitIntentEvent | PurchaseEvent | LeadEvent | AddToCartEvent | RemoveFromCartEvent | InitiateCheckoutEvent | AddPaymentInfoEvent | ViewContentEvent | SearchEvent;
+
+interface BrowserMetadata {
+    readonly url?: string;
+    readonly path?: string;
+    readonly hostname?: string;
+    readonly origin?: string;
+    readonly title?: string;
+    readonly referrer?: string;
+    readonly language?: string;
+    readonly timezone?: string;
+    readonly userAgent?: string;
+    readonly platform?: string;
+    readonly screenWidth?: number;
+    readonly screenHeight?: number;
+    readonly colorDepth?: number;
+}
+interface BrowserMetadataService {
+    getMetadata(): BrowserMetadata;
+}
+
+declare class BaseEventBuilder {
+    private readonly metadataService;
+    private readonly attribution;
+    constructor(metadataService: BrowserMetadataService, attribution?: AttributionService | null);
+    build<T extends {
+        type: string;
+    }>(event: T): T & BasePixelEvent;
+}
+
+export { type AttributionService as A, type BrowserMetadataService as B, type ConversionEventData as C, DEFAULT_ATTRIBUTION_CONFIG as D, type ExitIntentEvent as E, type PixelEventCategory as F, type EngagementEventCategory as G, type ConversionEventCategory as H, type InitiateCheckoutData as I, type ElementDescriptor as J, type LeadData as L, type PixelEvent as P, type RemoveFromCartData as R, type SessionRenewedEvent as S, type UserIdleEvent as U, type ViewContentData as V, BaseEventBuilder as a, type AttributionConfig as b, type AttributionIdentifiers as c, type BrowserMetadata as d, type BasePixelEvent as e, type PageViewEvent as f, type SessionExpiredEvent as g, ATTRIBUTION_STORAGE_KEY as h, type PurchaseData as i, type AddToCartData as j, type AddPaymentInfoData as k, type SearchData as l, type ScrollEvent as m, type PageClickEvent as n, type RageClickEvent as o, type VisibilityChangeEvent as p, type UserActiveEvent as q, type PurchaseEvent as r, type LeadEvent as s, type AddToCartEvent as t, type RemoveFromCartEvent as u, type InitiateCheckoutEvent as v, type AddPaymentInfoEvent as w, type ViewContentEvent as x, type SearchEvent as y, type PixelItem as z };