@adtrackify/at-tracking-event-types 4.18.1 → 4.19.0

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

@@ -1,6 +1,18 @@
-export declare type ElementInteractionType = 'cta_click' | 'dead_click' | 'rage_click' | 'img_interact' | 'section_view' | 'form_field';
+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: ElementInteractionType;
+    type: ELEMENT_INTERACTION_TYPE;
     selector?: string;
     text?: string;
     href?: string;
@@ -28,7 +40,6 @@ export interface ScrollPositionSample {
     y: number;
     ts: number;
 }
-export declare type IntentSignalEntry = string;
 export interface SessionInitPayload {
     pixelId: string;
     sessionId: string;
@@ -75,7 +86,7 @@ export interface PageEndPayload {
     rapidClickCount: number;
     pageScore: number;
     intentScore: number;
-    intentSignals: IntentSignalEntry[];
+    intentSignals: string[];
     elementInteractions: ElementInteractionEntry[];
     pageContext: PageContextData;
     scrollPositions: ScrollPositionSample[];
@@ -118,17 +129,15 @@ export interface PageSequenceEntry {
     rapidClickCount: number;
     pageScore: number;
     intentScore: number;
-    intentSignals: IntentSignalEntry[];
+    intentSignals: string[];
 }
-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;
+    eventName: string;
     messageId: string;
     pixelId: string;
     sessionId: string;
     identityId?: string;
-    cf?: Record<string, unknown>;
+    cf?: CloudflareCfData;
 }
 export interface SessionStartPayload extends SessionEventPayload {
     eventName: 'session_start';
@@ -156,7 +165,7 @@ export interface SessionEndPayload extends SessionEventPayload {
     intentScore: number;
     peakIntentScore: number;
     idleTimeoutTriggered: boolean;
-    endReason: SessionEndReason;
+    endReason: SESSION_END_REASON;
     country?: string;
     region?: string;
     city?: string;
@@ -164,7 +173,7 @@ export interface SessionEndPayload extends SessionEventPayload {
     longitude?: number;
 }
 export interface SessionRecordPayload extends SessionEventPayload {
-    eventName: 'session_record' | 'session_snapshot';
+    eventName: SESSION_RECORD_EVENT_NAME;
     pixelId_sessionId: string;
     sessionStartAt: string;
     sessionEndAt: string;
@@ -181,7 +190,7 @@ export interface SessionRecordPayload extends SessionEventPayload {
     avgPageScore: number;
     intentScore: number;
     peakIntentScore: number;
-    intentSignals: IntentSignalEntry[];
+    intentSignals: string[];
     totalInteractionCount: number;
     totalClickCount: number;
     totalKeyPressCount: number;
@@ -204,6 +213,98 @@ export interface SessionRecordPayload extends SessionEventPayload {
     longitude?: number;
     hasPurchase: boolean;
     conversionValue: number;
-    endReason: SessionEndReason;
+    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"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adtrackify/at-tracking-event-types",
-  "version": "4.18.1",
+  "version": "4.19.0",
   "description": "",
   "files": [
     "dist/*"
@@ -39,10 +39,10 @@
   "scripts": {
     "clean": "rimraf dist",
     "build": "npm run clean && npm run verify && cross-env NODE_ENV=production stage=dev APP_ENV=dev npm run tsc",
-    "elint": "eslint --ignore-path .gitignore .",
+    "elint": "eslint --ignore-path .gitignore --ext .ts .",
     "format": "prettier --write \"src/**/*.ts\" \"src/**/*.js\"",
     "lint": "tslint -p tsconfig.json",
-    "lint:fix": "eslint --ignore-path .gitignore . --fix",
+    "lint:fix": "eslint --ignore-path .gitignore --ext .ts . --fix",
     "coverage": "npm run test:all -- --coverage --group=unit",
     "test": "jest --group=unit --coverage",
     "test:all": "cross-env AWS_REGION=us-east-2 NODE_ENV=test jest --group=unit --coverage",