@adtrackify/at-tracking-event-types 4.18.2 → 4.20.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

@@ -1,209 +1,310 @@
-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 declare type IntentSignalEntry = string;
-export interface SessionInitPayload {
-    pixelId: string;
-    sessionId: string;
-    identityId?: string;
-    pagePath: string;
-    referrer?: string;
-    userAgent?: string;
-    mktSource?: string;
-    mktMedium?: string;
-    mktCampaign?: string;
-    isReturning?: boolean;
-}
-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: IntentSignalEntry[];
-    elementInteractions: ElementInteractionEntry[];
-    pageContext: PageContextData;
-    scrollPositions: ScrollPositionSample[];
-    mktSource?: string;
-    mktMedium?: string;
-    mktCampaign?: string;
-}
-export interface HeartbeatResponse {
-    sessionScore: number;
-    intentScore: number;
-    sessionExpired: boolean;
-    isReturning?: boolean;
-}
-export interface SessionInitResponse {
-    sessionScore: number;
-    intentScore: number;
-    isReturning?: boolean;
-    sessionExpired?: boolean;
-}
-export interface PageEndResponse {
-    ok: 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: IntentSignalEntry[];
-}
-export declare type SessionEndReason = 'hard_timeout' | 'idle_timeout' | 'max_duration' | 'snapshot';
-export declare type SessionEventName = 'session_start' | 'session_end' | 'session_record' | 'session_snapshot';
-export interface SessionEventPayload {
-    eventName: SessionEventName;
-    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: IntentSignalEntry[];
-    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[];
-}
+import { SESSION_END_REASON } from '../api/analytics/analytics-enums.js';
+export declare enum SESSION_RECORD_EVENT_NAME {
+    SESSION_RECORD = "session_record",
+    SESSION_SNAPSHOT = "session_snapshot"
+}
+export declare enum ELEMENT_INTERACTION_TYPE {
+    CTA_CLICK = "cta_click",
+    DEAD_CLICK = "dead_click",
+    RAGE_CLICK = "rage_click",
+    IMG_INTERACT = "img_interact",
+    SECTION_VIEW = "section_view",
+    FORM_FIELD = "form_field"
+}
+export interface ElementInteractionEntry {
+    type: ELEMENT_INTERACTION_TYPE;
+    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;
+    isReturning?: boolean;
+}
+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;
+    isReturning?: boolean;
+}
+export interface SessionInitResponse {
+    sessionScore: number;
+    intentScore: number;
+    isReturning?: boolean;
+    sessionExpired?: boolean;
+}
+export interface PageEndResponse {
+    ok: 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 interface SessionEventPayload {
+    eventName: string;
+    messageId: string;
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    cf?: CloudflareCfData;
+}
+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: SESSION_END_REASON;
+    country?: string;
+    region?: string;
+    city?: string;
+    latitude?: number;
+    longitude?: number;
+}
+export interface SessionRecordPayload extends SessionEventPayload {
+    eventName: SESSION_RECORD_EVENT_NAME;
+    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: SESSION_END_REASON;
+    pageSequence: PageSequenceEntry[];
+}
+export declare enum REALTIME_MESSAGE_TYPE {
+    SESSION_UPDATE = "session_update",
+    ENGAGEMENT_HEARTBEAT = "engagement_heartbeat",
+    COMMERCE_EVENT = "commerce_event"
+}
+export interface RealtimeIngressMessage {
+    type: REALTIME_MESSAGE_TYPE;
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    currentPage?: string;
+    country?: string;
+    region?: string;
+    city?: string;
+    totalActiveTime?: number;
+    sessionScore?: number;
+    intentScore?: number;
+    lastSeenAt: number;
+    eventName?: string;
+    eventValue?: number;
+    currency?: string;
+}
+export interface RealtimeCommerceMessage {
+    type: REALTIME_MESSAGE_TYPE.COMMERCE_EVENT;
+    pixelId: string;
+    sessionId: string;
+    identityId: string;
+    eventName: string;
+    value?: number;
+    currency?: string;
+    collectedAt: string;
+}
+export interface SessionCollectMessage {
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    eventName?: string;
+    trackingEvent?: {
+        id?: string;
+        name?: string;
+        pixelId?: string;
+        sessionId?: string;
+        identityId?: string;
+        data?: Record<string, unknown>;
+        context?: Record<string, unknown>;
+        collectedAt?: string;
+        collectedAtEpoch?: number;
+    };
+    country?: string;
+    region?: string;
+    city?: string;
+    currentPage?: string;
+    pagePath?: string;
+    totalActiveTime?: number;
+    sessionScore?: number;
+    intentScore?: number;
+    cf?: CloudflareCfData;
+    context?: {
+        identity?: {
+            identityId?: string;
+            traits?: Record<string, unknown>;
+        };
+    };
+    [key: string]: unknown;
+}
+export interface CloudflareCfData {
+    country?: string | null;
+    isEUCountry?: string | null;
+    continent?: string | null;
+    region?: string | null;
+    regionCode?: string | null;
+    city?: string | null;
+    postalCode?: string | null;
+    latitude?: string | null;
+    longitude?: string | null;
+    metroCode?: string | null;
+    timezone?: string;
+    asn?: number;
+    asOrganization?: string;
+    colo?: string;
+    httpProtocol?: string;
+    tlsVersion?: string;
+    tlsCipher?: string;
+    tlsClientAuth?: Record<string, unknown> | null;
+    botManagement?: Record<string, unknown> | null;
+    isBot?: boolean;
+    isSuspectedBot?: boolean;
+    verifiedBotCategory?: string;
+    clientAcceptEncoding?: string | null;
+    requestPriority?: string | null;
+    [key: string]: unknown;
+}

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

@@ -1,2 +1,21 @@
-export {};
+export var SESSION_RECORD_EVENT_NAME;
+(function (SESSION_RECORD_EVENT_NAME) {
+    SESSION_RECORD_EVENT_NAME["SESSION_RECORD"] = "session_record";
+    SESSION_RECORD_EVENT_NAME["SESSION_SNAPSHOT"] = "session_snapshot";
+})(SESSION_RECORD_EVENT_NAME || (SESSION_RECORD_EVENT_NAME = {}));
+export var ELEMENT_INTERACTION_TYPE;
+(function (ELEMENT_INTERACTION_TYPE) {
+    ELEMENT_INTERACTION_TYPE["CTA_CLICK"] = "cta_click";
+    ELEMENT_INTERACTION_TYPE["DEAD_CLICK"] = "dead_click";
+    ELEMENT_INTERACTION_TYPE["RAGE_CLICK"] = "rage_click";
+    ELEMENT_INTERACTION_TYPE["IMG_INTERACT"] = "img_interact";
+    ELEMENT_INTERACTION_TYPE["SECTION_VIEW"] = "section_view";
+    ELEMENT_INTERACTION_TYPE["FORM_FIELD"] = "form_field";
+})(ELEMENT_INTERACTION_TYPE || (ELEMENT_INTERACTION_TYPE = {}));
+export var REALTIME_MESSAGE_TYPE;
+(function (REALTIME_MESSAGE_TYPE) {
+    REALTIME_MESSAGE_TYPE["SESSION_UPDATE"] = "session_update";
+    REALTIME_MESSAGE_TYPE["ENGAGEMENT_HEARTBEAT"] = "engagement_heartbeat";
+    REALTIME_MESSAGE_TYPE["COMMERCE_EVENT"] = "commerce_event";
+})(REALTIME_MESSAGE_TYPE || (REALTIME_MESSAGE_TYPE = {}));
 //# sourceMappingURL=session-engagement-types.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACnC,8DAAiC,CAAA;IACjC,kEAAqC,CAAA;AACvC,CAAC,EAHW,yBAAyB,KAAzB,yBAAyB,QAGpC;AAOD,MAAM,CAAN,IAAY,wBAaX;AAbD,WAAY,wBAAwB;IAElC,mDAAuB,CAAA;IAEvB,qDAAyB,CAAA;IAEzB,qDAAyB,CAAA;IAEzB,yDAA6B,CAAA;IAE7B,yDAA6B,CAAA;IAE7B,qDAAyB,CAAA;AAC3B,CAAC,EAbW,wBAAwB,KAAxB,wBAAwB,QAanC;AAifD,MAAM,CAAN,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAE/B,0DAAiC,CAAA;IAEjC,sEAA6C,CAAA;IAE7C,0DAAiC,CAAA;AACnC,CAAC,EAPW,qBAAqB,KAArB,qBAAqB,QAOhC"}