@adtrackify/at-tracking-event-types 4.17.9 → 4.18.0

package/dist/esm/types/event/saas-event-properties.d.ts

@@ -1,47 +1,47 @@
-import { USER_ROLE } from '../api/accounts/account-enums.js';
-export declare enum BILLING_INTERVAL {
-    DAY = "day",
-    WEEK = "week",
-    MONTH = "month",
-    YEAR = "year"
-}
-export interface SaaSEventProperties {
-    accountId?: string;
-    accountName?: string;
-    accountCreatedAt?: string;
-    userId?: string;
-    userEmail?: string;
-    userRole?: USER_ROLE;
-    subscriptionId?: string;
-    planId?: string;
-    planName?: string;
-    billingInterval?: BILLING_INTERVAL;
-    mrr?: number;
-    arr?: number;
-    mrrDelta?: number;
-    ltv?: number;
-    trialStartDate?: string;
-    trialEndDate?: string;
-    trialDaysRemaining?: number;
-    usageInfo?: {
-        currentUsage?: number;
-        limit?: number;
-        usagePercentage?: number;
-    };
-    invoiceId?: string;
-    amount?: number;
-    currency?: string;
-    failureReason?: string;
-    seatCount?: number;
-    seatDelta?: number;
-    addonId?: string;
-    addonName?: string;
-    featureId?: string;
-    featureName?: string;
-    milestoneId?: string;
-    milestoneName?: string;
-    inactiveDays?: number;
-    cancelReason?: string;
-    cancelFeedback?: string;
-    cancelledAt?: string;
-}
+import { USER_ROLE } from '../api/accounts/account-enums.js';
+export declare enum BILLING_INTERVAL {
+    DAY = "day",
+    WEEK = "week",
+    MONTH = "month",
+    YEAR = "year"
+}
+export interface SaaSEventProperties {
+    accountId?: string;
+    accountName?: string;
+    accountCreatedAt?: string;
+    userId?: string;
+    userEmail?: string;
+    userRole?: USER_ROLE;
+    subscriptionId?: string;
+    planId?: string;
+    planName?: string;
+    billingInterval?: BILLING_INTERVAL;
+    mrr?: number;
+    arr?: number;
+    mrrDelta?: number;
+    ltv?: number;
+    trialStartDate?: string;
+    trialEndDate?: string;
+    trialDaysRemaining?: number;
+    usageInfo?: {
+        currentUsage?: number;
+        limit?: number;
+        usagePercentage?: number;
+    };
+    invoiceId?: string;
+    amount?: number;
+    currency?: string;
+    failureReason?: string;
+    seatCount?: number;
+    seatDelta?: number;
+    addonId?: string;
+    addonName?: string;
+    featureId?: string;
+    featureName?: string;
+    milestoneId?: string;
+    milestoneName?: string;
+    inactiveDays?: number;
+    cancelReason?: string;
+    cancelFeedback?: string;
+    cancelledAt?: string;
+}

package/dist/esm/types/event/saas-event-properties.js

@@ -1,8 +1,8 @@
-export var BILLING_INTERVAL;
-(function (BILLING_INTERVAL) {
-    BILLING_INTERVAL["DAY"] = "day";
-    BILLING_INTERVAL["WEEK"] = "week";
-    BILLING_INTERVAL["MONTH"] = "month";
-    BILLING_INTERVAL["YEAR"] = "year";
-})(BILLING_INTERVAL || (BILLING_INTERVAL = {}));
+export var BILLING_INTERVAL;
+(function (BILLING_INTERVAL) {
+    BILLING_INTERVAL["DAY"] = "day";
+    BILLING_INTERVAL["WEEK"] = "week";
+    BILLING_INTERVAL["MONTH"] = "month";
+    BILLING_INTERVAL["YEAR"] = "year";
+})(BILLING_INTERVAL || (BILLING_INTERVAL = {}));
 //# sourceMappingURL=saas-event-properties.js.map

package/dist/esm/types/event/session-engagement-types.d.ts

@@ -0,0 +1,201 @@
+export declare type ElementInteractionType = 'cta_click' | 'dead_click' | 'rage_click' | 'img_interact' | 'section_view' | 'form_field';
+export interface ElementInteractionEntry {
+    type: ElementInteractionType;
+    selector?: string;
+    text?: string;
+    href?: string;
+    ts: number;
+    pageX?: number;
+    pageY?: number;
+    duration?: number;
+    dwellTime?: number;
+    viewDuration?: number;
+    fieldName?: string;
+    fieldType?: string;
+    imgSrc?: string;
+    imgAlt?: string;
+    deadClick?: boolean;
+    rageClick?: boolean;
+    clickCount?: number;
+}
+export interface PageContextData {
+    viewportWidth: number;
+    viewportHeight: number;
+    pageHeight: number;
+    devicePixelRatio: number;
+}
+export interface ScrollPositionSample {
+    y: number;
+    ts: number;
+}
+export interface SessionInitPayload {
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    pagePath: string;
+    referrer?: string;
+    userAgent?: string;
+    mktSource?: string;
+    mktMedium?: string;
+    mktCampaign?: string;
+}
+export interface HeartbeatPayload {
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    activeTimeDelta: number;
+    interactionDelta: number;
+    scrollDepth: number;
+    pagePath: string;
+    resumed?: boolean;
+    intentScore: number;
+}
+export interface PageEndPayload {
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    pagePath: string;
+    timeOnPage: number;
+    activeTime: number;
+    idleTime: number;
+    interactionCount: number;
+    clickCount: number;
+    keyPressCount: number;
+    swipeCount: number;
+    pinchZoomCount: number;
+    scrollDepth: number;
+    exitScrollDepth: number;
+    timeToFirstInteraction: number;
+    timeToFirstScroll: number;
+    scrollUpCount: number;
+    inputFieldFocusCount: number;
+    copyCount: number;
+    rapidClickCount: number;
+    pageScore: number;
+    intentScore: number;
+    intentSignals: string[];
+    elementInteractions: ElementInteractionEntry[];
+    pageContext: PageContextData;
+    scrollPositions: ScrollPositionSample[];
+    mktSource?: string;
+    mktMedium?: string;
+    mktCampaign?: string;
+}
+export interface HeartbeatResponse {
+    sessionScore: number;
+    intentScore: number;
+    sessionExpired: boolean;
+}
+export interface SessionInitResponse {
+    sessionScore: number;
+    intentScore: number;
+    isReturning?: boolean;
+}
+export interface PageSequenceEntry {
+    pagePath: string;
+    enteredAt: string;
+    activeTime: number;
+    idleTime: number;
+    interactionCount: number;
+    clickCount: number;
+    keyPressCount: number;
+    swipeCount: number;
+    pinchZoomCount: number;
+    scrollDepth: number;
+    exitScrollDepth: number;
+    timeToFirstInteraction: number;
+    timeToFirstScroll: number;
+    scrollUpCount: number;
+    inputFieldFocusCount: number;
+    copyCount: number;
+    rapidClickCount: number;
+    pageScore: number;
+    intentScore: number;
+    intentSignals: string[];
+}
+export declare type SessionEndReason = 'hard_timeout' | 'idle_timeout' | 'max_duration' | 'snapshot';
+export interface SessionEventPayload {
+    eventName: string;
+    messageId: string;
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    cf?: Record<string, unknown>;
+}
+export interface SessionStartPayload extends SessionEventPayload {
+    eventName: 'session_start';
+    sessionStartAt: string;
+    landingPage: string;
+    referrer?: string;
+    mktSource?: string;
+    mktMedium?: string;
+    mktCampaign?: string;
+    country?: string;
+    region?: string;
+    city?: string;
+    latitude?: number;
+    longitude?: number;
+    pageSequence: PageSequenceEntry[];
+}
+export interface SessionEndPayload extends SessionEventPayload {
+    eventName: 'session_end';
+    sessionEndAt: string;
+    sessionDuration: number;
+    totalActiveTime: number;
+    pageCount: number;
+    resumeCount: number;
+    sessionScore: number;
+    intentScore: number;
+    peakIntentScore: number;
+    idleTimeoutTriggered: boolean;
+    endReason: SessionEndReason;
+    country?: string;
+    region?: string;
+    city?: string;
+    latitude?: number;
+    longitude?: number;
+}
+export interface SessionRecordPayload extends SessionEventPayload {
+    eventName: 'session_record' | 'session_snapshot';
+    pixelId_sessionId: string;
+    sessionStartAt: string;
+    sessionEndAt: string;
+    sessionDuration: number;
+    totalActiveTime: number;
+    totalIdleTime: number;
+    pageCount: number;
+    eventCount: number;
+    maxScrollDepth: number;
+    isBounce: boolean;
+    isBounceNoInteraction: boolean;
+    resumeCount: number;
+    sessionScore: number;
+    avgPageScore: number;
+    intentScore: number;
+    peakIntentScore: number;
+    intentSignals: string[];
+    totalInteractionCount: number;
+    totalClickCount: number;
+    totalKeyPressCount: number;
+    totalScrollUpCount: number;
+    totalInputFieldFocusCount: number;
+    totalCopyCount: number;
+    totalRapidClickCount: number;
+    totalSwipeCount: number;
+    totalPinchZoomCount: number;
+    landingPage: string;
+    exitPage: string;
+    referrer?: string;
+    mktSource?: string;
+    mktMedium?: string;
+    mktCampaign?: string;
+    country?: string;
+    region?: string;
+    city?: string;
+    latitude?: number;
+    longitude?: number;
+    hasPurchase: boolean;
+    conversionValue: number;
+    endReason: SessionEndReason;
+    pageSequence: PageSequenceEntry[];
+}

package/dist/esm/types/event/session-engagement-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=session-engagement-types.js.map

package/dist/esm/types/event/session-engagement-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":""}

package/dist/esm/types/event/tracking-event.d.ts

@@ -1,69 +1,69 @@
-import { InternalEvent } from './base/event.js';
-import { AddressInfo } from '../common/address.js';
-import { SaaSEventProperties } from './saas-event-properties.js';
-export interface TrackingEvent extends InternalEvent {
-    data?: TrackingEventData;
-    testCode?: string;
-}
-export interface EcommerceEventProperties {
-    isSyntheticWebhookEvent?: boolean;
-    firstName?: string;
-    lastName?: string;
-    email?: string;
-    phone?: string;
-    addresses?: AddressInfo[];
-    cartId?: string;
-    transactionId?: string;
-    orderId?: string;
-    orderName?: string;
-    affiliation?: string;
-    currency?: string;
-    price?: number;
-    subtotalPrice?: number;
-    value?: number;
-    tax?: number;
-    shipping?: number;
-    discount?: number;
-    coupon?: string;
-    paymentType?: string;
-    shippingTier?: string;
-    creativeName?: string;
-    creativeSlot?: string;
-    locationId?: string;
-    promotionId?: string;
-    promotionName?: string;
-    items?: GenericContent[];
-    orderSourceName?: string;
-    tags?: string[];
-    totalUnitCost?: number;
-    totalUnitMargin?: number;
-}
-export interface TrackingEventData extends EcommerceEventProperties, SaaSEventProperties {
-    [key: string]: any;
-}
-export interface GenericContent {
-    [key: string]: any;
-    content_type?: string;
-    id?: string;
-    name?: string;
-    sku?: string;
-    brand?: string;
-    variant?: string;
-    coupon?: string;
-    currency?: string;
-    discount?: number;
-    index?: number;
-    value?: number;
-    price?: number;
-    quantity?: number;
-    url?: string;
-    locationId?: string;
-    imageUrl?: string;
-    category?: string;
-    category2?: string;
-    category3?: string;
-    category4?: string;
-    category5?: string;
-    unitCost?: number;
-    unitMargin?: number;
-}
+import { InternalEvent } from './base/event.js';
+import { AddressInfo } from '../common/address.js';
+import { SaaSEventProperties } from './saas-event-properties.js';
+export interface TrackingEvent extends InternalEvent {
+    data?: TrackingEventData;
+    testCode?: string;
+}
+export interface EcommerceEventProperties {
+    isSyntheticWebhookEvent?: boolean;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    addresses?: AddressInfo[];
+    cartId?: string;
+    transactionId?: string;
+    orderId?: string;
+    orderName?: string;
+    affiliation?: string;
+    currency?: string;
+    price?: number;
+    subtotalPrice?: number;
+    value?: number;
+    tax?: number;
+    shipping?: number;
+    discount?: number;
+    coupon?: string;
+    paymentType?: string;
+    shippingTier?: string;
+    creativeName?: string;
+    creativeSlot?: string;
+    locationId?: string;
+    promotionId?: string;
+    promotionName?: string;
+    items?: GenericContent[];
+    orderSourceName?: string;
+    tags?: string[];
+    totalUnitCost?: number;
+    totalUnitMargin?: number;
+}
+export interface TrackingEventData extends EcommerceEventProperties, SaaSEventProperties {
+    [key: string]: any;
+}
+export interface GenericContent {
+    [key: string]: any;
+    content_type?: string;
+    id?: string;
+    name?: string;
+    sku?: string;
+    brand?: string;
+    variant?: string;
+    coupon?: string;
+    currency?: string;
+    discount?: number;
+    index?: number;
+    value?: number;
+    price?: number;
+    quantity?: number;
+    url?: string;
+    locationId?: string;
+    imageUrl?: string;
+    category?: string;
+    category2?: string;
+    category3?: string;
+    category4?: string;
+    category5?: string;
+    unitCost?: number;
+    unitMargin?: number;
+}

package/dist/esm/types/event/tracking-event.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=tracking-event.js.map

package/dist/esm/types/event-bus-event.d.ts

@@ -1,25 +1,25 @@
-import { LogEvent, MetricEvent, TrackingEvent } from './event';
-export interface EventBusEvent {
-    eventId: string;
-    eventType: string;
-    eventTime: string;
-    eventData?: object;
-}
-export interface EventBusTrackingEvent extends EventBusEvent {
-    eventData: {
-        trackingEvent: TrackingEvent;
-        pixelId: string;
-    };
-}
-export interface EventBusMetricEvent extends EventBusEvent {
-    eventData: {
-        metricEvent: MetricEvent;
-        pixelId: string;
-    };
-}
-export interface EventBusLogEvent extends EventBusEvent {
-    eventData: {
-        logEvent: LogEvent;
-        pixelId: string;
-    };
-}
+import { LogEvent, MetricEvent, TrackingEvent } from './event';
+export interface EventBusEvent {
+    eventId: string;
+    eventType: string;
+    eventTime: string;
+    eventData?: object;
+}
+export interface EventBusTrackingEvent extends EventBusEvent {
+    eventData: {
+        trackingEvent: TrackingEvent;
+        pixelId: string;
+    };
+}
+export interface EventBusMetricEvent extends EventBusEvent {
+    eventData: {
+        metricEvent: MetricEvent;
+        pixelId: string;
+    };
+}
+export interface EventBusLogEvent extends EventBusEvent {
+    eventData: {
+        logEvent: LogEvent;
+        pixelId: string;
+    };
+}

package/dist/esm/types/event-bus-event.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=event-bus-event.js.map

package/dist/esm/types/fingerprint/browser-attributes.d.ts

@@ -1,60 +1,60 @@
-export interface BrowserFingerprintAttributes {
-    ad_blocker?: boolean;
-    architecture?: number;
-    audio_analyser?: string;
-    audio_formats?: string;
-    browser_locationbar?: boolean;
-    browser_menubar?: boolean;
-    browser_personalbar?: boolean;
-    browser_statusbar?: boolean;
-    browser_toolbar?: boolean;
-    canvas_geometry_hash?: string;
-    canvas_winding?: boolean;
-    color_depth?: number;
-    color_gamut?: string;
-    cookie_enabled?: boolean;
-    device_timezone?: string;
-    fonts?: string;
-    forced_colors?: boolean;
-    hdr?: boolean;
-    indexed_db?: boolean;
-    inverted_colors?: boolean;
-    local_storage?: boolean;
-    motion_reduced?: boolean;
-    navigator_build_id?: string;
-    navigator_cpu_class?: string;
-    navigator_device_memory?: number;
-    navigator_do_not_track?: string;
-    navigator_hardware_concurrency?: number;
-    navigator_java_enabled?: boolean;
-    navigator_language?: string;
-    navigator_languages?: string;
-    navigator_media_devices?: string;
-    navigator_os_cpu?: string;
-    navigator_pdf_viewer_enabled?: boolean;
-    navigator_permissions?: string;
-    navigator_platform?: string;
-    navigator_plugins?: string;
-    navigator_product?: string;
-    navigator_product_sub?: string;
-    navigator_properties?: string;
-    navigator_user_agent?: string;
-    navigator_vendor?: string;
-    navigator_vendor_sub?: string;
-    open_database?: boolean;
-    screen_resolution?: string;
-    session_storage?: boolean;
-    video_card?: string;
-    video_formats?: string;
-    web_gl_extensions?: string;
-    web_gl_img_bytes_hash?: string;
-    web_gl_img_hash?: string;
-    web_gl_renderer?: string;
-    web_gl_renderer_unmasked?: string;
-    web_gl_shader_precisions?: string;
-    web_gl_shading_language_version?: string;
-    web_gl_status?: string;
-    web_gl_vendor?: string;
-    web_gl_vendor_unmasked?: string;
-    web_gl_version?: string;
-}
+export interface BrowserFingerprintAttributes {
+    ad_blocker?: boolean;
+    architecture?: number;
+    audio_analyser?: string;
+    audio_formats?: string;
+    browser_locationbar?: boolean;
+    browser_menubar?: boolean;
+    browser_personalbar?: boolean;
+    browser_statusbar?: boolean;
+    browser_toolbar?: boolean;
+    canvas_geometry_hash?: string;
+    canvas_winding?: boolean;
+    color_depth?: number;
+    color_gamut?: string;
+    cookie_enabled?: boolean;
+    device_timezone?: string;
+    fonts?: string;
+    forced_colors?: boolean;
+    hdr?: boolean;
+    indexed_db?: boolean;
+    inverted_colors?: boolean;
+    local_storage?: boolean;
+    motion_reduced?: boolean;
+    navigator_build_id?: string;
+    navigator_cpu_class?: string;
+    navigator_device_memory?: number;
+    navigator_do_not_track?: string;
+    navigator_hardware_concurrency?: number;
+    navigator_java_enabled?: boolean;
+    navigator_language?: string;
+    navigator_languages?: string;
+    navigator_media_devices?: string;
+    navigator_os_cpu?: string;
+    navigator_pdf_viewer_enabled?: boolean;
+    navigator_permissions?: string;
+    navigator_platform?: string;
+    navigator_plugins?: string;
+    navigator_product?: string;
+    navigator_product_sub?: string;
+    navigator_properties?: string;
+    navigator_user_agent?: string;
+    navigator_vendor?: string;
+    navigator_vendor_sub?: string;
+    open_database?: boolean;
+    screen_resolution?: string;
+    session_storage?: boolean;
+    video_card?: string;
+    video_formats?: string;
+    web_gl_extensions?: string;
+    web_gl_img_bytes_hash?: string;
+    web_gl_img_hash?: string;
+    web_gl_renderer?: string;
+    web_gl_renderer_unmasked?: string;
+    web_gl_shader_precisions?: string;
+    web_gl_shading_language_version?: string;
+    web_gl_status?: string;
+    web_gl_vendor?: string;
+    web_gl_vendor_unmasked?: string;
+    web_gl_version?: string;
+}

package/dist/esm/types/fingerprint/browser-attributes.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=browser-attributes.js.map

package/dist/esm/types/fingerprint/index.d.ts

@@ -1,6 +1,6 @@
-import { BrowserFingerprintAttributes } from './browser-attributes';
-import { ServerFingerprintAttributes } from './server-attributes';
-export interface FingerprintAttributes extends BrowserFingerprintAttributes, ServerFingerprintAttributes {
-}
-export * from './browser-attributes.js';
-export * from './server-attributes.js';
+import { BrowserFingerprintAttributes } from './browser-attributes';
+import { ServerFingerprintAttributes } from './server-attributes';
+export interface FingerprintAttributes extends BrowserFingerprintAttributes, ServerFingerprintAttributes {
+}
+export * from './browser-attributes.js';
+export * from './server-attributes.js';

package/dist/esm/types/fingerprint/index.js

@@ -1,3 +1,3 @@
-export * from './browser-attributes.js';
-export * from './server-attributes.js';
+export * from './browser-attributes.js';
+export * from './server-attributes.js';
 //# sourceMappingURL=index.js.map