@schibsted/pulse-sdk 8.0.0-rc.12 → 8.0.0-rc.14

package/dist/cjs/Tracker.js

@@ -114,6 +114,17 @@ const anonymousEvents = {
 function getAnonymousEventBuilder(name) {
     return name in anonymousEvents ? anonymousEvents[name] : anonymousEvents.trackerEvent;
 }
+// This looks overkill, but a mapping feels safer than doing string operations (capitalize) with javascript
+const mapDeployStageToTpaasStage = (deployStage) => {
+    switch (deployStage) {
+        case 'dev':
+            return 'Dev';
+        case 'pre':
+            return 'Pre';
+        case 'pro':
+            return 'Pro';
+    }
+};
 /**
  * Determines if the SDK is running in a Hybrid (WebView) environment.
  *
@@ -291,6 +302,8 @@ class Tracker {
             tpaasCollectorBaseUrl: config_browser_1.collectorEndpoints[deployStageTpaas],
             trackerId: (0, uuid_1.v4)(),
             vendors: config?.vendors?.length ? [] : ['xandr'],
+            useBeacon: true,
+            useBeaconWhenAvailable: true,
         }, config);
         // Move to default config?
         this.builders = (0, utils_1.pulseMerge)({}, builders, {
@@ -522,6 +535,7 @@ class Tracker {
             providerGroup: this.state.provider?.group,
             component: this.state.component,
             componentVersion: this.state.componentVersion,
+            routingStage: mapDeployStageToTpaasStage(this.state.deployStageTpaas),
             experiments,
             currentPageReferrer,
         };
@@ -606,6 +620,7 @@ class Tracker {
             component: this.state.component,
             componentVersion: this.state.componentVersion,
             pageviewId: this.state.pageViewId,
+            routingStage: mapDeployStageToTpaasStage(this.state.deployStageTpaas),
             currentPage,
             currentPageReferrer,
             experiments,
@@ -1556,6 +1571,15 @@ class Tracker {
         const event = (0, tpaas_builders_1.buildEngagementTeaserEvent)(input, dependencies);
         return this.sendTpaasEvent(event);
     }
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    async trackEngagementTvModule(input) {
+        const dependencies = await this.prepareTpaasEvent();
+        const event = (0, tpaas_builders_1.buildEngagementTvModuleEvent)(input, dependencies);
+        return this.sendTpaasEvent(event);
+    }
     /**
      * @param input
      * @category TPaaS Tracking
@@ -2330,12 +2354,18 @@ class Tracker {
     async prepareQueuesAndSend(eventQueue, retryEventQueue) {
         const promisesToBeSent = eventQueue.splice(0);
         const eventsToBeSent = promisesToBeSent.map((p) => p.inputValue);
-        const eventsToRetry = retryEventQueue;
+        const eventsToRetry = retryEventQueue.splice(0);
         eventQueue.length = 0;
         retryEventQueue.length = 0;
         const evaluatedEvents = await Promise.all(eventsToBeSent);
         const url = this._getCollectorPath();
         const data = [...evaluatedEvents, ...eventsToRetry];
+        // in some cases, _sendImmediately executes an asynchronous operation (cisSync) after checking for empty array
+        // due to that, it's still possible for this function to be called with an empty array, so we need to check for that again before sending
+        // in order to avoid making an empty request to collector
+        if (data.length === 0) {
+            return [];
+        }
         // biome-ignore lint/suspicious/noExplicitAny: -
         async function onFailedSend(response) {
             // We retry an event once, but discard already retried events

package/dist/cjs/leaveTrackingTpaas/index.js

@@ -57,7 +57,8 @@ let activityListeners = [];
 let resizeObserver = null;
 let throttledUpdateFn = (0, utils_1.throttle)(() => undefined, 0);
 let durationStartTime = 0;
-let activityStartTime = 0;
+let previousActivityTime = 0;
+let activityDurationMs = 0;
 let currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
 let additionalHeightBuilder;
 /**
@@ -90,8 +91,9 @@ function addTpaasLeaveTracking({ objectElement, pageElement, schema, objectResiz
         additionalHeightBuilder = heightBuilder;
         addTpaasLeaveListeners();
         addUpdateEventListeners(objectDomElement, pageDomElement, objectResizable);
-        activityStartTime = resetTime();
+        previousActivityTime = resetTime();
         durationStartTime = resetTime();
+        activityDurationMs = 0;
         currentLeaveSchema = schema;
         currentTrackMethod = trackMethod;
         logger.debug('addLeaveTracking:after:state', currentLeaveEvent);
@@ -184,7 +186,8 @@ function removeUpdateEventListeners() {
 const resetEventDefaults = () => {
     currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
     durationStartTime = resetTime();
-    activityStartTime = resetTime();
+    previousActivityTime = resetTime();
+    activityDurationMs = 0;
 };
 const resetTpaasViewedContent = () => {
     currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
@@ -223,11 +226,13 @@ function getTpaasLeaveObject() {
     const endTime = Date.now();
     // TPaaS leave event requires duration/activity to be at least 1ms, otherwise the event is rejected
     // also, in practice, it's almost impossible to have an activity or duration of 0ms
+    // We don't call increaseActivityDuration here because it's possible to call getTpaasLeaveObject multiple times
+    // without any activity events in between, which would incorrectly increase the activity duration.
     const durationMs = Math.max(endTime - durationStartTime, 1);
-    const activityDurationMs = Math.max(Math.min(endTime - activityStartTime, constants_1.ACTIVITY_DURATION_LIMIT_MS), 1);
+    const lastActivityDuration = calculateActivityGap(endTime);
     const leave = {
         durationMs,
-        activityDurationMs,
+        activityDurationMs: Math.max(activityDurationMs + lastActivityDuration, 1),
         ...currentLeaveEvent,
     };
     logger.debug('trackTpaasLeave: event', leave);
@@ -314,9 +319,16 @@ function addUpdateActivityDurationListeners() {
         types_1.BrowserEvents.TOUCHSTART,
     ];
     activityListeners = addEventListeners(activityEvents, () => {
-        activityStartTime = resetTime();
+        increaseActivityDuration(Date.now());
     }, { passive: true });
 }
+function calculateActivityGap(activityEndTime) {
+    return Math.min(activityEndTime - previousActivityTime, constants_1.ACTIVITY_DURATION_LIMIT_MS);
+}
+function increaseActivityDuration(activityEndTime) {
+    activityDurationMs += calculateActivityGap(activityEndTime);
+    previousActivityTime = resetTime();
+}
 /*
  Add listeners to a set of browser events.
  */

package/dist/cjs/tpaas-builders/builders/device.js

@@ -139,7 +139,7 @@ function getOperatingSystem(uaParser) {
     if (osName.includes('windows')) {
         return 'Windows';
     }
-    if (osName.includes('macos')) {
+    if (osName.includes('macos') || osName.includes('mac os')) {
         return 'Mac';
     }
     if (osName.includes('android')) {

package/dist/cjs/tpaas-builders/builders/trackerBuilder.js

@@ -1,12 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.builder = void 0;
-const builder = (autoTrackerVersion, isHybrid, version) => {
+const builder = ({ autoTrackerVersion, isHybrid, routingStage, version, }) => {
     return {
         tracker: {
             autoTrackerVersion,
             isAutoTracker: !!autoTrackerVersion,
             isHybrid,
+            routingStage,
             trackerType: 'JS',
             version,
         },

package/dist/cjs/tpaas-builders/builders.js

@@ -33,6 +33,7 @@ exports.buildEngagementAudioEvent = buildEngagementAudioEvent;
 exports.buildEngagementFormEvent = buildEngagementFormEvent;
 exports.buildEngagementOfferEvent = buildEngagementOfferEvent;
 exports.buildEngagementTeaserEvent = buildEngagementTeaserEvent;
+exports.buildEngagementTvModuleEvent = buildEngagementTvModuleEvent;
 exports.buildEngagementUIElementEvent = buildEngagementUIElementEvent;
 exports.buildEngagementVideoEvent = buildEngagementVideoEvent;
 exports.buildEngagementVideoAdEvent = buildEngagementVideoAdEvent;
@@ -73,9 +74,9 @@ const utm_1 = require("./builders/utm");
  * @private
  */
 const getCommonBuildersOutput = (createdAt, dependencies, input) => {
-    const { autoTrackerVersion, isHybrid, version, environmentId, jwe, user, consents, providerId, providerName, providerGroup, component, componentVersion, pageviewId, currentPage, currentPageReferrer, } = dependencies;
+    const { autoTrackerVersion, isHybrid, version, environmentId, jwe, user, consents, providerId, providerName, providerGroup, component, componentVersion, pageviewId, currentPage, currentPageReferrer, routingStage, } = dependencies;
     const { experiments } = input;
-    return (0, ts_deepmerge_1.merge)((0, trackerBuilder_1.builder)(autoTrackerVersion, isHybrid, version), (0, time_1.builder)(createdAt), (0, session_1.builder)(createdAt), (0, device_1.builder)(environmentId, jwe), (0, user_1.builder)(user), (0, baseEvent_1.builder)(), (0, consents_1.builder)(consents), (0, provider_1.builder)(providerId, component, componentVersion, providerName, providerGroup), (0, pageInfo_1.builder)(currentPage), (0, pageviewId_1.builder)(pageviewId), (0, utm_1.builder)(), (0, referrer_1.builder)(currentPageReferrer), (0, catalogVersion_1.builder)(), (0, experiments_1.builder)(dependencies.experiments, experiments));
+    return (0, ts_deepmerge_1.merge)((0, trackerBuilder_1.builder)({ autoTrackerVersion, isHybrid, version, routingStage }), (0, time_1.builder)(createdAt), (0, session_1.builder)(createdAt), (0, device_1.builder)(environmentId, jwe), (0, user_1.builder)(user), (0, baseEvent_1.builder)(), (0, consents_1.builder)(consents), (0, provider_1.builder)(providerId, component, componentVersion, providerName, providerGroup), (0, pageInfo_1.builder)(currentPage), (0, pageviewId_1.builder)(pageviewId), (0, utm_1.builder)(), (0, referrer_1.builder)(currentPageReferrer), (0, catalogVersion_1.builder)(), (0, experiments_1.builder)(dependencies.experiments, experiments));
 };
 exports.getCommonBuildersOutput = getCommonBuildersOutput;
 // there's a bug in the ts-deepmerge library that doesn't properly resolve merging optionals with required properties
@@ -107,8 +108,8 @@ const normalizePageInput = (input) => {
 // #region AnonymousView Event Builders
 function buildAnonymousViewUIElementEvent(input, dependencies) {
     const createdAt = new Date();
-    const { autoTrackerVersion, isHybrid, version, pageviewId, providerId, providerName, providerGroup, component, componentVersion, currentPageReferrer, } = dependencies;
-    return (0, ts_deepmerge_1.merge)(tpaas_schemas_1.AnonymousViewUIElement, (0, baseEvent_1.builder)(), (0, trackerBuilder_1.builder)(autoTrackerVersion, isHybrid, version), (0, time_1.builder)(createdAt), (0, pageviewId_1.builder)(pageviewId), (0, utm_1.builder)(), (0, anonymous_1.builder)(), (0, provider_1.builder)(providerId, component, componentVersion, providerName, providerGroup), (0, referrer_1.builder)(currentPageReferrer), (0, experiments_1.builder)(dependencies.experiments, input.experiments), (0, catalogVersion_1.builder)(), normalizePageInput(input));
+    const { autoTrackerVersion, isHybrid, version, pageviewId, providerId, providerName, providerGroup, component, componentVersion, currentPageReferrer, routingStage, } = dependencies;
+    return (0, ts_deepmerge_1.merge)(tpaas_schemas_1.AnonymousViewUIElement, (0, baseEvent_1.builder)(), (0, trackerBuilder_1.builder)({ autoTrackerVersion, isHybrid, version, routingStage }), (0, time_1.builder)(createdAt), (0, pageviewId_1.builder)(pageviewId), (0, utm_1.builder)(), (0, anonymous_1.builder)(), (0, provider_1.builder)(providerId, component, componentVersion, providerName, providerGroup), (0, referrer_1.builder)(currentPageReferrer), (0, experiments_1.builder)(dependencies.experiments, input.experiments), (0, catalogVersion_1.builder)(), normalizePageInput(input));
 }
 // #endregion
 // #region View Event Builders
@@ -194,8 +195,8 @@ function buildLeaveVideoPageEvent(input, dependencies) {
 }
 function buildLeaveWeatherEvent(input, dependencies) {
     const createdAt = new Date();
-    const { autoTrackerVersion, isHybrid, version, providerId, providerName, providerGroup, component, componentVersion, user, experiments, } = dependencies;
-    return (0, ts_deepmerge_1.merge)(normalizePageInput(input), tpaas_schemas_1.LeaveWeather, (0, time_1.builder)(createdAt), (0, trackerBuilder_1.builder)(autoTrackerVersion, isHybrid, version), (0, baseEvent_1.builder)(), (0, provider_1.builder)(providerId, component, componentVersion, providerName, providerGroup), (0, user_1.builder)(user), (0, experiments_1.builder)(experiments, input.experiments), (0, consents_1.builder)(dependencies.consents), (0, device_1.builder)(dependencies.environmentId, dependencies.jwe), (0, catalogVersion_1.builder)(), (0, navigationType_1.builder)(input.page?.navigationType), (0, pageviewId_1.builder)(dependencies.pageviewId), (0, pageInfo_1.builder)(dependencies.currentPage), (0, referrer_1.builder)(dependencies.currentPageReferrer));
+    const { autoTrackerVersion, isHybrid, version, providerId, providerName, providerGroup, component, componentVersion, user, experiments, routingStage, } = dependencies;
+    return (0, ts_deepmerge_1.merge)(normalizePageInput(input), tpaas_schemas_1.LeaveWeather, (0, time_1.builder)(createdAt), (0, trackerBuilder_1.builder)({ autoTrackerVersion, isHybrid, version, routingStage }), (0, baseEvent_1.builder)(), (0, provider_1.builder)(providerId, component, componentVersion, providerName, providerGroup), (0, user_1.builder)(user), (0, experiments_1.builder)(experiments, input.experiments), (0, consents_1.builder)(dependencies.consents), (0, device_1.builder)(dependencies.environmentId, dependencies.jwe), (0, catalogVersion_1.builder)(), (0, navigationType_1.builder)(input.page?.navigationType), (0, pageviewId_1.builder)(dependencies.pageviewId), (0, pageInfo_1.builder)(dependencies.currentPage), (0, referrer_1.builder)(dependencies.currentPageReferrer));
 }
 // #endregion
 // #region Engagement Event Builders
@@ -211,6 +212,9 @@ function buildEngagementOfferEvent(input, dependencies) {
 function buildEngagementTeaserEvent(input, dependencies) {
     return (0, ts_deepmerge_1.merge)(tpaas_schemas_1.EngagementTeaser, (0, exports.getCommonBuildersOutput)(new Date(), dependencies, input), normalizePageInput(input));
 }
+function buildEngagementTvModuleEvent(input, dependencies) {
+    return (0, ts_deepmerge_1.merge)(tpaas_schemas_1.EngagementTvModule, (0, exports.getCommonBuildersOutput)(new Date(), dependencies, input), normalizePageInput(input));
+}
 function buildEngagementUIElementEvent(input, dependencies) {
     return (0, ts_deepmerge_1.merge)(tpaas_schemas_1.EngagementUIElement, (0, exports.getCommonBuildersOutput)(new Date(), dependencies, input), normalizePageInput(input));
 }