@schibsted/pulse-sdk 8.0.0-rc.5 → 8.0.0-rc.7
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.
- package/dist/cjs/Tracker.js +137 -119
- package/dist/cjs/leaveTrackingTpaas/constants.js +2 -7
- package/dist/cjs/leaveTrackingTpaas/index.js +52 -40
- package/dist/cjs/tracker-proxy/consts.js +3 -0
- package/dist/cjs/version.js +1 -1
- package/dist/cjs/visibility-observer/index.js +9 -7
- package/dist/cjs/wrapper/types/event.js +5 -0
- package/dist/ejs/Tracker.js +138 -120
- package/dist/ejs/leaveTrackingTpaas/constants.js +1 -5
- package/dist/ejs/leaveTrackingTpaas/index.js +53 -41
- package/dist/ejs/tracker-proxy/consts.js +3 -0
- package/dist/ejs/version.js +1 -1
- package/dist/ejs/visibility-observer/index.js +9 -7
- package/dist/ejs/wrapper/types/event.js +4 -1
- package/dist/types/Tracker.d.ts +55 -20
- package/dist/types/index.d.ts +1 -1
- package/dist/types/leaveTrackingTpaas/constants.d.ts +1 -5
- package/dist/types/leaveTrackingTpaas/index.d.ts +6 -6
- package/dist/types/leaveTrackingTpaas/types.d.ts +1 -9
- package/dist/types/tracker-proxy/consts.d.ts +1 -1
- package/dist/types/types.d.ts +19 -13
- package/dist/types/version.d.ts +1 -1
- package/dist/types/visibility-observer/index.d.ts +6 -1
- package/dist/types/wrapper/types/event.d.ts +3 -1
- package/node_modules/@schibsted/pulse-utils/package.json +1 -1
- package/node_modules/@schibsted/tpaas-event-builder/dist/cjs/builders.js +5 -1
- package/node_modules/@schibsted/tpaas-event-builder/dist/cjs/guards.js +7 -0
- package/node_modules/@schibsted/tpaas-event-builder/dist/cjs/index.js +3 -0
- package/node_modules/@schibsted/tpaas-event-builder/dist/ejs/builders.js +5 -2
- package/node_modules/@schibsted/tpaas-event-builder/dist/ejs/guards.js +4 -0
- package/node_modules/@schibsted/tpaas-event-builder/dist/ejs/index.js +1 -0
- package/node_modules/@schibsted/tpaas-event-builder/dist/index.d.ts +792 -166
- package/node_modules/@schibsted/tpaas-event-builder/package.json +1 -1
- package/node_modules/@schibsted/tpaas-schemas/dist/cjs/constants.js +66 -57
- package/node_modules/@schibsted/tpaas-schemas/dist/ejs/constants.js +64 -55
- package/node_modules/@schibsted/tpaas-schemas/dist/index.d.ts +836 -219
- package/package.json +4 -4
|
@@ -56,19 +56,42 @@ let updateViewedContentListeners = [];
|
|
|
56
56
|
let activityListeners = [];
|
|
57
57
|
let resizeObserver = null;
|
|
58
58
|
let throttledUpdateFn = (0, pulse_utils_1.throttle)(() => undefined, 0);
|
|
59
|
-
let
|
|
60
|
-
let
|
|
59
|
+
let durationStartTime = 0;
|
|
60
|
+
let activityStartTime = 0;
|
|
61
61
|
let currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
|
|
62
62
|
let additionalHeightBuilder;
|
|
63
|
+
/**
|
|
64
|
+
* Resolves a DOM element from either a CSS selector string or an Element instance.
|
|
65
|
+
*/
|
|
66
|
+
function resolveDomElement(element) {
|
|
67
|
+
try {
|
|
68
|
+
return typeof element === 'string' ? document.querySelector(element) : element || null;
|
|
69
|
+
}
|
|
70
|
+
catch (e) {
|
|
71
|
+
logger.error('Error while resolving DOM element', e);
|
|
72
|
+
return null;
|
|
73
|
+
}
|
|
74
|
+
}
|
|
63
75
|
/*
|
|
64
76
|
Add leave tracking
|
|
65
77
|
*/
|
|
66
78
|
function addTpaasLeaveTracking({ objectElement, pageElement, schema, objectResizable, heightBuilder, trackMethod, }) {
|
|
67
79
|
function _addLeaveTracking() {
|
|
80
|
+
const objectDomElement = resolveDomElement(objectElement);
|
|
81
|
+
if (objectDomElement == null) {
|
|
82
|
+
logger.error('Could not find object element for leave tracking');
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
let pageDomElement = resolveDomElement(pageElement);
|
|
86
|
+
if (pageDomElement == null) {
|
|
87
|
+
logger.warn('Could not find page element for leave tracking, defaulting to document.body');
|
|
88
|
+
pageDomElement = document.body;
|
|
89
|
+
}
|
|
68
90
|
additionalHeightBuilder = heightBuilder;
|
|
69
91
|
addTpaasLeaveListeners();
|
|
70
|
-
addUpdateEventListeners(
|
|
71
|
-
|
|
92
|
+
addUpdateEventListeners(objectDomElement, pageDomElement, objectResizable);
|
|
93
|
+
activityStartTime = resetTime();
|
|
94
|
+
durationStartTime = resetTime();
|
|
72
95
|
currentLeaveSchema = schema;
|
|
73
96
|
currentTrackMethod = trackMethod;
|
|
74
97
|
logger.debug('addLeaveTracking:after:state', currentLeaveEvent);
|
|
@@ -160,12 +183,8 @@ function removeUpdateEventListeners() {
|
|
|
160
183
|
*/
|
|
161
184
|
const resetEventDefaults = () => {
|
|
162
185
|
currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
};
|
|
166
|
-
const resetActivityDuration = () => {
|
|
167
|
-
clearInterval(activityDuration.interval);
|
|
168
|
-
return (0, constants_1.DEFAULT_ACTIVITY_DURATION)();
|
|
186
|
+
durationStartTime = resetTime();
|
|
187
|
+
activityStartTime = resetTime();
|
|
169
188
|
};
|
|
170
189
|
const resetTpaasViewedContent = () => {
|
|
171
190
|
currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
|
|
@@ -174,34 +193,41 @@ exports.resetTpaasViewedContent = resetTpaasViewedContent;
|
|
|
174
193
|
const resetTime = () => Date.now();
|
|
175
194
|
/*
|
|
176
195
|
Send a Leave event only if Page Leave tracking is active in the SDK
|
|
177
|
-
The event that is ultimately sent is
|
|
178
|
-
|
|
179
|
-
to the brand event. After the event has been sent, leave page tracking is removed
|
|
196
|
+
The event that is ultimately sent is the View event saved in the currentTrackMethod callback.
|
|
197
|
+
After the event has been sent, leave page tracking is removed
|
|
180
198
|
and must be explicitly re-added if needed.
|
|
181
199
|
*/
|
|
182
|
-
function trackTpaasActiveLeave() {
|
|
200
|
+
async function trackTpaasActiveLeave() {
|
|
183
201
|
if (leaveTpaasTrackingIsActive()) {
|
|
184
|
-
trackTpaasLeave();
|
|
202
|
+
await trackTpaasLeave();
|
|
185
203
|
}
|
|
186
204
|
}
|
|
187
205
|
/*
|
|
188
206
|
Send a Leave event regardless of whether Page Leave tracking is active in the SDK
|
|
189
|
-
The event that is ultimately sent is
|
|
190
|
-
|
|
191
|
-
to the brand event. After the event has been sent, leave page tracking is removed
|
|
207
|
+
The event that is ultimately sent is the View event saved in the currentTrackMethod callback.
|
|
208
|
+
After the event has been sent, leave page tracking is removed
|
|
192
209
|
and must be explicitly re-added if needed.
|
|
193
210
|
*/
|
|
194
|
-
function trackTpaasLeave() {
|
|
211
|
+
async function trackTpaasLeave() {
|
|
195
212
|
const leave = getTpaasLeaveObject();
|
|
196
|
-
currentTrackMethod
|
|
213
|
+
// Capture currentTrackMethod and remove tracking synchronously before awaiting.
|
|
214
|
+
// If removal happened after the await, a new trackView* call arriving during the async
|
|
215
|
+
// gap would see tracking still active with the same schema and silently discard its
|
|
216
|
+
// new callback (e.g. a fresh leaveAudioBuilder), causing the next leave event to
|
|
217
|
+
// never fire or to use the wrong builder.
|
|
218
|
+
const trackMethod = currentTrackMethod;
|
|
197
219
|
removeTpaasLeaveTracking();
|
|
220
|
+
await trackMethod(leave);
|
|
198
221
|
}
|
|
199
222
|
function getTpaasLeaveObject() {
|
|
200
223
|
const endTime = Date.now();
|
|
201
|
-
|
|
224
|
+
// TPaaS leave event requires duration/activity to be at least 1ms, otherwise the event is rejected
|
|
225
|
+
// also, in practice, it's almost impossible to have an activity or duration of 0ms
|
|
226
|
+
const durationMs = Math.max(endTime - durationStartTime, 1);
|
|
227
|
+
const activityDurationMs = Math.max(Math.min(endTime - activityStartTime, constants_1.ACTIVITY_DURATION_LIMIT_MS), 1);
|
|
202
228
|
const leave = {
|
|
203
|
-
durationMs
|
|
204
|
-
activityDurationMs
|
|
229
|
+
durationMs,
|
|
230
|
+
activityDurationMs,
|
|
205
231
|
...currentLeaveEvent,
|
|
206
232
|
};
|
|
207
233
|
logger.debug('trackTpaasLeave: event', leave);
|
|
@@ -276,18 +302,10 @@ exports.calculateScrollPosition = calculateScrollPosition;
|
|
|
276
302
|
'mousedown', 'mousemove', 'keydown', 'scroll' and/or 'touchstart' browser events.
|
|
277
303
|
*/
|
|
278
304
|
function addUpdateActivityDurationListeners() {
|
|
279
|
-
if
|
|
280
|
-
|
|
305
|
+
// if there are already listeners for activity, do not add more
|
|
306
|
+
if (activityListeners.length > 0) {
|
|
281
307
|
return;
|
|
282
308
|
}
|
|
283
|
-
const interval = 1000;
|
|
284
|
-
const activityTimeout = 30 * 1000;
|
|
285
|
-
activityDuration.interval = window.setInterval(() => {
|
|
286
|
-
activityDuration.timeSinceLastActivity += interval;
|
|
287
|
-
if (activityDuration.timeSinceLastActivity < activityTimeout) {
|
|
288
|
-
activityDuration.value += interval;
|
|
289
|
-
}
|
|
290
|
-
}, interval);
|
|
291
309
|
const activityEvents = [
|
|
292
310
|
types_1.BrowserEvents.SCROLL,
|
|
293
311
|
types_1.BrowserEvents.MOUSEDOWN,
|
|
@@ -296,15 +314,9 @@ function addUpdateActivityDurationListeners() {
|
|
|
296
314
|
types_1.BrowserEvents.TOUCHSTART,
|
|
297
315
|
];
|
|
298
316
|
activityListeners = addEventListeners(activityEvents, () => {
|
|
299
|
-
|
|
317
|
+
activityStartTime = resetTime();
|
|
300
318
|
}, { passive: true });
|
|
301
319
|
}
|
|
302
|
-
function resetLastActivity(activityDuration) {
|
|
303
|
-
return {
|
|
304
|
-
...activityDuration,
|
|
305
|
-
timeSinceLastActivity: 0,
|
|
306
|
-
};
|
|
307
|
-
}
|
|
308
320
|
/*
|
|
309
321
|
Add listeners to a set of browser events.
|
|
310
322
|
*/
|
|
@@ -22,6 +22,7 @@ exports.TPAAS_ALLOWED_METHODS = [
|
|
|
22
22
|
'trackEngagementVideoAd',
|
|
23
23
|
'trackEngagementWidget',
|
|
24
24
|
'trackCompletedHealthAction',
|
|
25
|
+
'trackImpressionAdSlot',
|
|
25
26
|
'trackImpressionForm',
|
|
26
27
|
'trackImpressionHealthUIElement',
|
|
27
28
|
'trackImpressionOffer',
|
|
@@ -39,6 +40,7 @@ exports.TPAAS_ALLOWED_METHODS = [
|
|
|
39
40
|
'trackLeaveLockedAudioPage',
|
|
40
41
|
'trackLeaveLockedVideoPage',
|
|
41
42
|
'trackLeavePage',
|
|
43
|
+
'trackLeaveSportsPage',
|
|
42
44
|
'trackLeaveVideoPage',
|
|
43
45
|
'trackLeaveWeather',
|
|
44
46
|
'trackViewArticle',
|
|
@@ -52,6 +54,7 @@ exports.TPAAS_ALLOWED_METHODS = [
|
|
|
52
54
|
'trackViewLockedAudioPage',
|
|
53
55
|
'trackViewLockedVideoPage',
|
|
54
56
|
'trackViewPage',
|
|
57
|
+
'trackViewSportsPage',
|
|
55
58
|
'trackViewTitle',
|
|
56
59
|
'trackViewVideoPage',
|
|
57
60
|
'trackViewWeather',
|
package/dist/cjs/version.js
CHANGED
|
@@ -16,14 +16,16 @@ class VisibilityObserver {
|
|
|
16
16
|
* Uses {@link https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver | MutationObserver} to monitor the DOM for dynamically loaded content.
|
|
17
17
|
* Callback is invoked only once per element.
|
|
18
18
|
* @param selector The CSS selector for elements to track.
|
|
19
|
+
* @param options {ObserverOptions} Optional configuration for the observer.
|
|
20
|
+
* @param options.threshold Which ratio triggers the Observer callback.
|
|
19
21
|
* @throws Error if called more than once.
|
|
20
22
|
*/
|
|
21
|
-
observe(selector) {
|
|
23
|
+
observe(selector, { threshold = 0.67 }) {
|
|
22
24
|
if (this.selector) {
|
|
23
25
|
throw new Error(`Cannot observe selector ${selector}. A visibility observer has already been set up for selector ${this.selector}.`);
|
|
24
26
|
}
|
|
25
27
|
this.selector = selector;
|
|
26
|
-
this.setupObservers();
|
|
28
|
+
this.setupObservers({ threshold });
|
|
27
29
|
// biome-ignore lint/suspicious/useIterableCallbackReturn: -
|
|
28
30
|
this.elements().forEach((elementToTrack) => this.observeIntersection(elementToTrack));
|
|
29
31
|
}
|
|
@@ -33,14 +35,14 @@ class VisibilityObserver {
|
|
|
33
35
|
elements() {
|
|
34
36
|
return Array.from(document.querySelectorAll(this.selector));
|
|
35
37
|
}
|
|
36
|
-
//
|
|
37
|
-
setupObservers() {
|
|
38
|
-
this.setupIntersectionObserver();
|
|
38
|
+
// Initialise both observers and start watching for DOM changes
|
|
39
|
+
setupObservers({ threshold }) {
|
|
40
|
+
this.setupIntersectionObserver({ threshold });
|
|
39
41
|
this.setupMutationObserver();
|
|
40
42
|
this.observeMutations();
|
|
41
43
|
}
|
|
42
44
|
// Create observer to detect when elements become visible in the viewport
|
|
43
|
-
setupIntersectionObserver() {
|
|
45
|
+
setupIntersectionObserver({ threshold }) {
|
|
44
46
|
this.intersectionObserver = new IntersectionObserver((entries) => {
|
|
45
47
|
entries.forEach((entry) => {
|
|
46
48
|
if (entry.isIntersecting) {
|
|
@@ -49,7 +51,7 @@ class VisibilityObserver {
|
|
|
49
51
|
this.intersectionObserver.unobserve(node);
|
|
50
52
|
}
|
|
51
53
|
});
|
|
52
|
-
}, { threshold
|
|
54
|
+
}, { threshold });
|
|
53
55
|
}
|
|
54
56
|
// Create observer to detect DOM changes that may add/remove tracked elements
|
|
55
57
|
setupMutationObserver() {
|
|
@@ -1,2 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.isLegacyPageType = isLegacyPageType;
|
|
4
|
+
const LEGACY_PAGE_TYPE_VALUES = ['Article', 'Listing', 'Frontpage', 'SalesPoster', 'Page', 'LoginPoster'];
|
|
5
|
+
function isLegacyPageType(value) {
|
|
6
|
+
return LEGACY_PAGE_TYPE_VALUES.includes(value);
|
|
7
|
+
}
|