@adtrackify/at-tracking-event-types 4.23.0 → 4.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/dist/cjs/types/event/context/event-context.d.ts +1 -1
  2. package/dist/cjs/types/event/session-engagement-types.d.ts +14 -10
  3. package/dist/cjs/types/event/session-engagement-types.js +8 -1
  4. package/dist/cjs/types/event/session-engagement-types.js.map +1 -1
  5. package/dist/esm/types/event/context/event-context.d.ts +1 -1
  6. package/dist/esm/types/event/session-engagement-types.d.ts +14 -10
  7. package/dist/esm/types/event/session-engagement-types.js +7 -0
  8. package/dist/esm/types/event/session-engagement-types.js.map +1 -1
  9. package/package.json +1 -1
package/dist/cjs/types/event/context/event-context.d.ts CHANGED
@@ -198,7 +198,7 @@ export interface PageInfo {
198
198
  search?: string;
199
199
  title?: string;
200
200
  url?: string;
201
- qsp?: any;
201
+ qsp?: Record<string, unknown>;
202
202
  }
203
203
  export interface ShopifyInfo {
204
204
  collections?: string;
package/dist/cjs/types/event/session-engagement-types.d.ts CHANGED
@@ -1,5 +1,11 @@
1
1
  import { SESSION_END_REASON } from '../api/analytics/analytics-enums.js';
2
2
  import type { EventContext, PageInfo } from './context/event-context.js';
3
+ export declare enum RETURN_TIER {
4
+ NEW = "new",
5
+ RECENT_RETURN = "recent_return",
6
+ WARM_RETURN = "warm_return",
7
+ COLD_RETURN = "cold_return"
8
+ }
3
9
  export declare enum FUNNEL_STAGE {
4
10
  LANDING = 0,
5
11
  BROWSE = 1,
@@ -61,6 +67,8 @@ export interface SessionInitPayload {
61
67
  mktMedium?: string;
62
68
  mktCampaign?: string;
63
69
  isReturning?: boolean;
70
+ visitCount?: number;
71
+ daysSinceLastVisit?: number | null;
64
72
  context?: EventContext;
65
73
  }
66
74
  export interface HeartbeatPayload {
@@ -169,7 +177,7 @@ export interface SessionStartPayload extends SessionEventPayload {
169
177
  pageSequence: PageSequenceEntry[];
170
178
  visitCount?: number;
171
179
  daysSinceLastVisit?: number | null;
172
- returnTier?: string;
180
+ returnTier?: RETURN_TIER;
173
181
  }
174
182
  export interface SessionEndPayload extends SessionEventPayload {
175
183
  eventName: 'session_end';
@@ -238,7 +246,7 @@ export interface SessionRecordPayload extends SessionEventPayload {
238
246
  pageSequence: PageSequenceEntry[];
239
247
  visitCount?: number;
240
248
  daysSinceLastVisit?: number | null;
241
- returnTier?: string;
249
+ returnTier?: RETURN_TIER;
242
250
  }
243
251
  export declare enum REALTIME_MESSAGE_TYPE {
244
252
  SESSION_UPDATE = "session_update",
@@ -264,7 +272,7 @@ export interface RealtimeIngressMessage {
264
272
  eventName?: string;
265
273
  eventValue?: number;
266
274
  currency?: string;
267
- returnTier?: string;
275
+ returnTier?: RETURN_TIER;
268
276
  }
269
277
  export interface RealtimeCommerceMessage {
270
278
  type: REALTIME_MESSAGE_TYPE.COMMERCE_EVENT;
@@ -288,7 +296,7 @@ export interface SessionCollectMessage {
288
296
  sessionId?: string;
289
297
  identityId?: string;
290
298
  data?: Record<string, unknown>;
291
- context?: Record<string, unknown>;
299
+ context?: EventContext;
292
300
  collectedAt?: string;
293
301
  collectedAtEpoch?: number;
294
302
  };
@@ -301,12 +309,8 @@ export interface SessionCollectMessage {
301
309
  sessionScore?: number;
302
310
  intentScore?: number;
303
311
  cf?: CloudflareCfData;
304
- context?: {
305
- identity?: {
306
- identityId?: string;
307
- traits?: Record<string, unknown>;
308
- };
309
- };
312
+ requestHeaders?: Record<string, string>;
313
+ context?: EventContext;
310
314
  [key: string]: unknown;
311
315
  }
312
316
  export interface CloudflareCfData {
package/dist/cjs/types/event/session-engagement-types.js CHANGED
@@ -1,6 +1,13 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.REALTIME_MESSAGE_TYPE = exports.ELEMENT_INTERACTION_TYPE = exports.SESSION_RECORD_EVENT_NAME = exports.FUNNEL_STAGE = void 0;
3
+ exports.REALTIME_MESSAGE_TYPE = exports.ELEMENT_INTERACTION_TYPE = exports.SESSION_RECORD_EVENT_NAME = exports.FUNNEL_STAGE = exports.RETURN_TIER = void 0;
4
+ var RETURN_TIER;
5
+ (function (RETURN_TIER) {
6
+ RETURN_TIER["NEW"] = "new";
7
+ RETURN_TIER["RECENT_RETURN"] = "recent_return";
8
+ RETURN_TIER["WARM_RETURN"] = "warm_return";
9
+ RETURN_TIER["COLD_RETURN"] = "cold_return";
10
+ })(RETURN_TIER = exports.RETURN_TIER || (exports.RETURN_TIER = {}));
4
11
  var FUNNEL_STAGE;
5
12
  (function (FUNNEL_STAGE) {
6
13
  FUNNEL_STAGE[FUNNEL_STAGE["LANDING"] = 0] = "LANDING";
package/dist/cjs/types/event/session-engagement-types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":";;;AAeA,IAAY,YAeX;AAfD,WAAY,YAAY;IAEtB,qDAAW,CAAA;IAEX,mDAAU,CAAA;IAEV,+DAAgB,CAAA;IAEhB,+CAAQ,CAAA;IAER,uDAAY,CAAA;IAEZ,qDAAW,CAAA;IAEX,uDAAY,CAAA;AACd,CAAC,EAfW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAevB;AAGD,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACnC,8DAAiC,CAAA;IACjC,kEAAqC,CAAA;AACvC,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC;AAOD,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,GAAxB,gCAAwB,KAAxB,gCAAwB,QAanC;AA6gBD,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAE/B,0DAAiC,CAAA;IAEjC,sEAA6C,CAAA;IAE7C,0DAAiC,CAAA;AACnC,CAAC,EAPW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAOhC"}
1
+ {"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":";;;AAYA,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,8CAA+B,CAAA;IAC/B,0CAA2B,CAAA;IAC3B,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AAKD,IAAY,YAeX;AAfD,WAAY,YAAY;IAEtB,qDAAW,CAAA;IAEX,mDAAU,CAAA;IAEV,+DAAgB,CAAA;IAEhB,+CAAQ,CAAA;IAER,uDAAY,CAAA;IAEZ,qDAAW,CAAA;IAEX,uDAAY,CAAA;AACd,CAAC,EAfW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAevB;AAGD,IAAY,yBAGX;AAHD,WAAY,yBAAyB;IACnC,8DAAiC,CAAA;IACjC,kEAAqC,CAAA;AACvC,CAAC,EAHW,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAGpC;AAOD,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,GAAxB,gCAAwB,KAAxB,gCAAwB,QAanC;AAshBD,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAE/B,0DAAiC,CAAA;IAEjC,sEAA6C,CAAA;IAE7C,0DAAiC,CAAA;AACnC,CAAC,EAPW,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAOhC"}
package/dist/esm/types/event/context/event-context.d.ts CHANGED
@@ -198,7 +198,7 @@ export interface PageInfo {
198
198
  search?: string;
199
199
  title?: string;
200
200
  url?: string;
201
- qsp?: any;
201
+ qsp?: Record<string, unknown>;
202
202
  }
203
203
  export interface ShopifyInfo {
204
204
  collections?: string;
package/dist/esm/types/event/session-engagement-types.d.ts CHANGED
@@ -1,5 +1,11 @@
1
1
  import { SESSION_END_REASON } from '../api/analytics/analytics-enums.js';
2
2
  import type { EventContext, PageInfo } from './context/event-context.js';
3
+ export declare enum RETURN_TIER {
4
+ NEW = "new",
5
+ RECENT_RETURN = "recent_return",
6
+ WARM_RETURN = "warm_return",
7
+ COLD_RETURN = "cold_return"
8
+ }
3
9
  export declare enum FUNNEL_STAGE {
4
10
  LANDING = 0,
5
11
  BROWSE = 1,
@@ -61,6 +67,8 @@ export interface SessionInitPayload {
61
67
  mktMedium?: string;
62
68
  mktCampaign?: string;
63
69
  isReturning?: boolean;
70
+ visitCount?: number;
71
+ daysSinceLastVisit?: number | null;
64
72
  context?: EventContext;
65
73
  }
66
74
  export interface HeartbeatPayload {
@@ -169,7 +177,7 @@ export interface SessionStartPayload extends SessionEventPayload {
169
177
  pageSequence: PageSequenceEntry[];
170
178
  visitCount?: number;
171
179
  daysSinceLastVisit?: number | null;
172
- returnTier?: string;
180
+ returnTier?: RETURN_TIER;
173
181
  }
174
182
  export interface SessionEndPayload extends SessionEventPayload {
175
183
  eventName: 'session_end';
@@ -238,7 +246,7 @@ export interface SessionRecordPayload extends SessionEventPayload {
238
246
  pageSequence: PageSequenceEntry[];
239
247
  visitCount?: number;
240
248
  daysSinceLastVisit?: number | null;
241
- returnTier?: string;
249
+ returnTier?: RETURN_TIER;
242
250
  }
243
251
  export declare enum REALTIME_MESSAGE_TYPE {
244
252
  SESSION_UPDATE = "session_update",
@@ -264,7 +272,7 @@ export interface RealtimeIngressMessage {
264
272
  eventName?: string;
265
273
  eventValue?: number;
266
274
  currency?: string;
267
- returnTier?: string;
275
+ returnTier?: RETURN_TIER;
268
276
  }
269
277
  export interface RealtimeCommerceMessage {
270
278
  type: REALTIME_MESSAGE_TYPE.COMMERCE_EVENT;
@@ -288,7 +296,7 @@ export interface SessionCollectMessage {
288
296
  sessionId?: string;
289
297
  identityId?: string;
290
298
  data?: Record<string, unknown>;
291
- context?: Record<string, unknown>;
299
+ context?: EventContext;
292
300
  collectedAt?: string;
293
301
  collectedAtEpoch?: number;
294
302
  };
@@ -301,12 +309,8 @@ export interface SessionCollectMessage {
301
309
  sessionScore?: number;
302
310
  intentScore?: number;
303
311
  cf?: CloudflareCfData;
304
- context?: {
305
- identity?: {
306
- identityId?: string;
307
- traits?: Record<string, unknown>;
308
- };
309
- };
312
+ requestHeaders?: Record<string, string>;
313
+ context?: EventContext;
310
314
  [key: string]: unknown;
311
315
  }
312
316
  export interface CloudflareCfData {
package/dist/esm/types/event/session-engagement-types.js CHANGED
@@ -1,3 +1,10 @@
1
+ export var RETURN_TIER;
2
+ (function (RETURN_TIER) {
3
+ RETURN_TIER["NEW"] = "new";
4
+ RETURN_TIER["RECENT_RETURN"] = "recent_return";
5
+ RETURN_TIER["WARM_RETURN"] = "warm_return";
6
+ RETURN_TIER["COLD_RETURN"] = "cold_return";
7
+ })(RETURN_TIER || (RETURN_TIER = {}));
1
8
  export var FUNNEL_STAGE;
2
9
  (function (FUNNEL_STAGE) {
3
10
  FUNNEL_STAGE[FUNNEL_STAGE["LANDING"] = 0] = "LANDING";
package/dist/esm/types/event/session-engagement-types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":"AAeA,MAAM,CAAN,IAAY,YAeX;AAfD,WAAY,YAAY;IAEtB,qDAAW,CAAA;IAEX,mDAAU,CAAA;IAEV,+DAAgB,CAAA;IAEhB,+CAAQ,CAAA;IAER,uDAAY,CAAA;IAEZ,qDAAW,CAAA;IAEX,uDAAY,CAAA;AACd,CAAC,EAfW,YAAY,KAAZ,YAAY,QAevB;AAGD,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;AA6gBD,MAAM,CAAN,IAAY,qBAOX;AAPD,WAAY,qBAAqB;IAE/B,0DAAiC,CAAA;IAEjC,sEAA6C,CAAA;IAE7C,0DAAiC,CAAA;AACnC,CAAC,EAPW,qBAAqB,KAArB,qBAAqB,QAOhC"}
1
+ {"version":3,"file":"session-engagement-types.js","sourceRoot":"","sources":["../../../../src/types/event/session-engagement-types.ts"],"names":[],"mappings":"AAYA,MAAM,CAAN,IAAY,WAKX;AALD,WAAY,WAAW;IACrB,0BAAW,CAAA;IACX,8CAA+B,CAAA;IAC/B,0CAA2B,CAAA;IAC3B,0CAA2B,CAAA;AAC7B,CAAC,EALW,WAAW,KAAX,WAAW,QAKtB;AAKD,MAAM,CAAN,IAAY,YAeX;AAfD,WAAY,YAAY;IAEtB,qDAAW,CAAA;IAEX,mDAAU,CAAA;IAEV,+DAAgB,CAAA;IAEhB,+CAAQ,CAAA;IAER,uDAAY,CAAA;IAEZ,qDAAW,CAAA;IAEX,uDAAY,CAAA;AACd,CAAC,EAfW,YAAY,KAAZ,YAAY,QAevB;AAGD,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;AAshBD,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@adtrackify/at-tracking-event-types",
3
- "version": "4.23.0",
3
+ "version": "4.24.0",
4
4
  "description": "",
5
5
  "files": [
6
6
  "dist/*"