@adtrackify/at-tracking-event-types 4.25.4 → 4.26.0

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

@@ -1,342 +1,457 @@
-import { SESSION_END_REASON } from '../api/analytics/analytics-enums.js';
-import type { EventContext, PageInfo } from './context/event-context.js';
-export declare enum RETURN_TIER {
-    NEW = "new",
-    RECENT_RETURN = "recent_return",
-    WARM_RETURN = "warm_return",
-    COLD_RETURN = "cold_return"
-}
-export declare enum FUNNEL_STAGE {
-    LANDING = 0,
-    BROWSE = 1,
-    PRODUCT_VIEW = 2,
-    CART = 3,
-    CHECKOUT = 4,
-    PAYMENT = 5,
-    PURCHASE = 6
-}
-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;
-    visitCount?: number;
-    daysSinceLastVisit?: number | null;
-    context?: EventContext;
-}
-export interface HeartbeatPayload {
-    pixelId: string;
-    sessionId: string;
-    identityId?: string;
-    activeTimeDelta: number;
-    interactionDelta: number;
-    scrollDepth: number;
-    pagePath: string;
-    resumed?: boolean;
-    intentScore: number;
-    page?: PageInfo;
-}
-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;
-    context?: EventContext;
-}
-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;
-    requestHeaders?: Record<string, string>;
-}
-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[];
-    visitCount?: number;
-    daysSinceLastVisit?: number | null;
-    returnTier?: RETURN_TIER;
-}
-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;
-    maxFunnelStage?: number;
-    distinctProductsViewed?: number;
-    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;
-    maxFunnelStage?: number;
-    distinctProductsViewed?: number;
-    hasPurchase: boolean;
-    conversionValue: number;
-    endReason: SESSION_END_REASON;
-    pageSequence: PageSequenceEntry[];
-    visitCount?: number;
-    daysSinceLastVisit?: number | null;
-    returnTier?: RETURN_TIER;
-}
-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;
-    maxFunnelStage?: number;
-    pageCount?: number;
-    landingPage?: string;
-    lastSeenAt: number;
-    eventName?: string;
-    eventValue?: number;
-    currency?: string;
-    returnTier?: RETURN_TIER;
-}
-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?: EventContext;
-        collectedAt?: string;
-        collectedAtEpoch?: number;
-    };
-    country?: string;
-    region?: string;
-    city?: string;
-    currentPage?: string;
-    pagePath?: string;
-    totalActiveTime?: number;
-    sessionScore?: number;
-    intentScore?: number;
-    cf?: CloudflareCfData;
-    requestHeaders?: Record<string, string>;
-    context?: EventContext;
-    [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;
-}
+import { SESSION_END_REASON } from '../api/analytics/analytics-enums.js';
+import type { CloudflareCfData } from './context/event-context-cloudflare.js';
+import type { EventContext, PageInfo } from './context/event-context.js';
+import type { InternalEvent } from './base/event.js';
+import { INTERNAL_EVENT_TYPE } from './base/event.js';
+import { SESSION_EVENT_NAME } from './base/event-name-enum.js';
+export declare enum RETURN_TIER {
+    NEW = "new",
+    RECENT_RETURN = "recent_return",
+    WARM_RETURN = "warm_return",
+    COLD_RETURN = "cold_return"
+}
+export declare enum FUNNEL_STAGE {
+    LANDING = 0,
+    BROWSE = 1,
+    PRODUCT_VIEW = 2,
+    CART = 3,
+    CHECKOUT = 4,
+    PAYMENT = 5,
+    PURCHASE = 6
+}
+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 SessionEvent extends InternalEvent {
+    type: INTERNAL_EVENT_TYPE.SESSION;
+    name: SESSION_EVENT_NAME;
+    sessionId: string;
+}
+export interface SessionInitEvent extends SessionEvent {
+    name: SESSION_EVENT_NAME.SESSION_INIT;
+    data: SessionInitData;
+}
+export interface SessionInitData {
+    pagePath: string;
+    isReturning?: boolean;
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+}
+export interface SessionHeartbeatEvent extends SessionEvent {
+    name: SESSION_EVENT_NAME.SESSION_HEARTBEAT;
+    data: SessionHeartbeatData;
+}
+export interface SessionHeartbeatData {
+    pagePath: string;
+    activeTimeDelta: number;
+    interactionDelta: number;
+    scrollDepth: number;
+    intentScore: number;
+    resumed?: boolean;
+    page?: PageInfo;
+}
+export interface SessionPageEndEvent extends SessionEvent {
+    name: SESSION_EVENT_NAME.SESSION_PAGE_END;
+    data: SessionPageEndData;
+}
+export interface SessionPageEndData {
+    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[];
+}
+export interface SessionStartEvent extends SessionEvent {
+    name: SESSION_EVENT_NAME.SESSION_START;
+    data: SessionStartData;
+}
+export interface SessionStartData {
+    messageId: string;
+    sessionStartAt: string;
+    landingPage: string;
+    pageSequence: PageSequenceEntry[];
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+    returnTier?: RETURN_TIER;
+}
+export interface SessionEndEvent extends SessionEvent {
+    name: SESSION_EVENT_NAME.SESSION_END;
+    data: SessionEndData;
+}
+export interface SessionEndData {
+    messageId: string;
+    sessionEndAt: string;
+    sessionDuration: number;
+    totalActiveTime: number;
+    pageCount: number;
+    resumeCount: number;
+    sessionScore: number;
+    intentScore: number;
+    peakIntentScore: number;
+    idleTimeoutTriggered: boolean;
+    endReason: SESSION_END_REASON;
+    maxFunnelStage?: number;
+    distinctProductsViewed?: number;
+}
+export interface SessionRecordEvent extends SessionEvent {
+    name: SESSION_EVENT_NAME.SESSION_RECORD | SESSION_EVENT_NAME.SESSION_SNAPSHOT;
+    data: SessionRecordData;
+}
+export interface SessionRecordData {
+    messageId: string;
+    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;
+    maxFunnelStage?: number;
+    distinctProductsViewed?: number;
+    hasPurchase: boolean;
+    conversionValue: number;
+    endReason: SESSION_END_REASON;
+    pageSequence: PageSequenceEntry[];
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+    returnTier?: RETURN_TIER;
+}
+export interface SessionInitPayload {
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    pagePath: string;
+    referrer?: string;
+    userAgent?: string;
+    mktSource?: string;
+    mktMedium?: string;
+    mktCampaign?: string;
+    isReturning?: boolean;
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+    context?: EventContext;
+}
+export interface HeartbeatPayload {
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    activeTimeDelta: number;
+    interactionDelta: number;
+    scrollDepth: number;
+    pagePath: string;
+    resumed?: boolean;
+    intentScore: number;
+    page?: PageInfo;
+}
+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;
+    context?: EventContext;
+}
+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;
+    requestHeaders?: Record<string, string>;
+}
+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[];
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+    returnTier?: RETURN_TIER;
+}
+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;
+    maxFunnelStage?: number;
+    distinctProductsViewed?: number;
+    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;
+    maxFunnelStage?: number;
+    distinctProductsViewed?: number;
+    hasPurchase: boolean;
+    conversionValue: number;
+    endReason: SESSION_END_REASON;
+    pageSequence: PageSequenceEntry[];
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+    returnTier?: RETURN_TIER;
+}
+export interface SessionState {
+    initialized: boolean;
+    flushed: boolean;
+    pixelId: string;
+    sessionId: string;
+    identityId?: string;
+    pixelId_sessionId: string;
+    sessionStartAt: string;
+    lastHeartbeatAt: number;
+    lastActiveHeartbeatAt: number;
+    lastSnapshotAt: number;
+    activeTimeSinceLastSnapshot: number;
+    totalActiveTime: number;
+    totalIdleTime: number;
+    pageCount: number;
+    eventCount: number;
+    maxScrollDepth: number;
+    resumeCount: number;
+    sessionScore: number;
+    avgPageScore: number;
+    pageScoreSum: number;
+    pageScoreCount: 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;
+    maxFunnelStage: number;
+    distinctProductsViewed: number;
+    productPaths: string[];
+    isReturning?: boolean;
+    visitCount?: number;
+    daysSinceLastVisit?: number | null;
+    returnTier?: RETURN_TIER;
+    country?: string;
+    region?: string;
+    city?: string;
+    latitude?: number;
+    longitude?: number;
+    cfData?: CloudflareCfData;
+    isSuspectedBot?: boolean;
+    requestHeaders?: Record<string, string>;
+    context?: EventContext;
+    pageSequence: PageSequenceEntry[];
+}
+export interface SessionBounceResult {
+    isBounce: boolean;
+    isBounceNoInteraction: boolean;
+}
+export interface HeartbeatUpdateResult {
+    snapshotDue: boolean;
+}
+export declare enum SessionEndpoint {
+    Init = "init",
+    Heartbeat = "heartbeat",
+    Page = "page"
+}