@schibsted/pulse-sdk 8.0.0-rc.1 → 8.0.0-rc.10

package/dist/cjs/Tracker.test-d.js

@@ -10,6 +10,8 @@ const ARTICLE_PAYLOAD = {
         {
             name: 'test-experiment',
             variant: 'test-variant',
+            platform: 'web',
+            experimentSdrn: 'sdrn:the-standard:experiment:test-experiment',
         },
     ],
     object: {
@@ -35,8 +37,6 @@ const ARTICLE_PAYLOAD = {
         },
     },
     provider: {
-        component: 'test-component',
-        componentVersion: '1.0.0',
         product: 'test-product',
         stage: 'Dev',
         version: '1.0.0',

package/dist/cjs/builders/actor.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultValue = void 0;
 exports.generateActorSDRN = generateActorSDRN;
-exports.isActorInput = isActorInput;
+exports.hasActorBuilder = hasActorBuilder;
 exports.default = actor;
 const pulse_utils_1 = require("@schibsted/pulse-utils");
 /**
@@ -18,11 +18,11 @@ function generateActorSDRN(id, realm = '__REALM_NOT_SET__') {
     return `sdrn:${realm}:user:${outputId}`;
 }
 /**
- * Type guard to check if the input is an ActorInput
+ * Type guard to check if the input has an Actor Builder
  * @param input
  * @internal
  */
-function isActorInput(input) {
+function hasActorBuilder(input) {
     // biome-ignore lint/suspicious/noPrototypeBuiltins: Object.hasOwn is not available in ES2020
     return (0, pulse_utils_1.isPlainObject)(input) && Object.prototype.hasOwnProperty.call(input, 'actor');
 }

package/dist/cjs/builders/consents.js

@@ -14,7 +14,7 @@ const pulse_utils_1 = require("@schibsted/pulse-utils");
 const warnOnce_1 = __importDefault(require("../warnOnce"));
 const consent_manager_1 = require("./consent-manager");
 /**
- * @enum ConsentCategory
+ * @enum ConsentsCategory
  */
 var ConsentsCategory;
 (function (ConsentsCategory) {
@@ -23,7 +23,7 @@ var ConsentsCategory;
     ConsentsCategory["CMP_ADVERTISING"] = "CMP_ADVERTISING";
     ConsentsCategory["CMP_PERSONALIZATION"] = "CMP_PERSONALIZATION";
 })(ConsentsCategory || (exports.ConsentsCategory = ConsentsCategory = {}));
-exports.ConsentsSourceValues = ['default', 'cmp', 'cache'];
+exports.ConsentsSourceValues = ['default', 'cmp', 'cache', 'url'];
 exports.ConsentsPurposeCategoryStatusValues = ['accepted', 'rejected', 'unknown'];
 const isLegacyConsentsPurpose = (consentsPurposeCategory) => {
     return !consentsPurposeCategory?.status;

package/dist/cjs/builders/events-node.js

@@ -65,7 +65,7 @@ function routableEventDefaults(eventInput) {
 function routableEvent({ eventInput, sdkConfig } = {}) {
     return Object.assign({}, eventInput, {
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || exports.DEFAULT_SCHEMA_LOCATION}/events/base-routable-event.json/246.json#`,
+            `http://${sdkConfig?.schemaLocation || exports.DEFAULT_SCHEMA_LOCATION}/events/base-routable-event.json/248.json#`,
         provider: (0, provider_1.default)(eventInput),
         actor: (0, actor_1.default)(eventInput),
     });
@@ -98,7 +98,7 @@ function trackerEvent({ eventInput, sdkConfig } = {}) {
         '@type': eventInput?.type || 'View',
         pageViewId: pageViewIdInput || pageViewIdSdk,
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || exports.DEFAULT_SCHEMA_LOCATION}/events/tracker-event.json/360.json`,
+            `http://${sdkConfig?.schemaLocation || exports.DEFAULT_SCHEMA_LOCATION}/events/tracker-event.json/361.json`,
         actor: (0, actor_1.default)(parentInput),
         consents: (0, consents_1.default)(parentInput),
         experiments: (0, experiments_1.default)(parentInput),
@@ -116,7 +116,7 @@ trackerEvent.defaults = trackerEventInput;
 function engagementEvent({ eventInput, sdkConfig } = {}) {
     return Object.assign(trackerEvent({ eventInput, sdkConfig }), {
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || exports.DEFAULT_SCHEMA_LOCATION}/events/engagement-event.json/386.json`,
+            `http://${sdkConfig?.schemaLocation || exports.DEFAULT_SCHEMA_LOCATION}/events/engagement-event.json/388.json`,
         '@type': 'Engagement',
     });
 }

package/dist/cjs/builders/experiments.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.defaultValue = void 0;
+exports.generateExperimentSDRN = generateExperimentSDRN;
 exports.default = experiments;
 function generateExperimentSDRN(id, experimentationPlatform) {
     return `sdrn:${experimentationPlatform}:experiment:${id}`;

package/dist/cjs/identity/actor.js

@@ -10,9 +10,7 @@ const warnOnce_1 = __importDefault(require("../warnOnce"));
 /**
  * @internal exported for testing
  */
-exports.WARN_CIS_SYNC_LOGIN_UNDEFINED = 'Cis sync initiated with no actor builder and no event available. If you do not use a login system, please indicate' +
-    ' this using tracker.update({ actor: undefined }), otherwise do tracker.update({ actor: somePromise }) with a' +
-    ' promise that resolves to the login state.';
+exports.WARN_CIS_SYNC_LOGIN_UNDEFINED = 'No Actor Builder found in event input or tracker builders. Please provide an Actor Builder to ensure the SDK resolves logged-in and logged-out scenarios correctly.';
 /**
  * Get the actor id (userId) from the current browser. A promise is returned
  * because a call may be made to complete the login process.
@@ -33,6 +31,19 @@ const getActor = async (builders) => {
     return await evaluateActor(builders);
 };
 exports.getActor = getActor;
+/**
+ * Pinpoints the Actor Builder from the Event payload or the available Builders
+ * @param eventInput - The event input which may contain an `actor` property
+ * @param builders - The builders managed by the SDK.
+ */
+function getActorSource(eventInput = {}, builders = {}) {
+    if ((0, actor_1.hasActorBuilder)(eventInput)) {
+        return eventInput.actor;
+    }
+    if ((0, actor_1.hasActorBuilder)(builders)) {
+        return builders.actor;
+    }
+}
 const userIsLoggedIn = async (builders) => {
     const actor = await getActor(builders);
     return !!actor?.id;
@@ -45,8 +56,9 @@ exports.userIsLoggedIn = userIsLoggedIn;
  * @private
  */
 const evaluateActor = async (eventInput = {}, builders = {}) => {
-    if ((0, actor_1.isActorInput)(eventInput) || (0, actor_1.isActorInput)(builders)) {
-        const evaluatedActor = await (0, pulse_utils_1.evaluateAndFlatten)(eventInput.actor || builders.actor);
+    const actorSource = getActorSource(eventInput, builders);
+    if (actorSource) {
+        const evaluatedActor = await (0, pulse_utils_1.evaluateAndFlatten)(actorSource);
         if (evaluatedActor) {
             return evaluatedActor;
         }
@@ -54,7 +66,7 @@ const evaluateActor = async (eventInput = {}, builders = {}) => {
     // We allow an empty actor object, because it is a sign that the application is not setting nor updating Actor correctly.
     // Inferring "id: undefined" as a fallback would mask that bug.
     // Hence, the warning below.
-    (0, warnOnce_1.default)('no-actor-builder-and-no-event-present', exports.WARN_CIS_SYNC_LOGIN_UNDEFINED);
+    (0, warnOnce_1.default)('no-actor-builder', exports.WARN_CIS_SYNC_LOGIN_UNDEFINED);
     return {};
 };
 exports.evaluateActor = evaluateActor;

package/dist/cjs/identity/cis.js

@@ -45,7 +45,7 @@ const cisSync = async (data, builders, config) => {
     // _pulse2data cookie, or just not do the sync.
     //
     const actorPromise = (0, actor_1.evaluateActor)(data, builders);
-    const { cisBaseUrl, cisEnabled, includeAdvertising: includeAdvertisingPromise, isHybrid, nativeJwe, providerId, trackerId, vendors, } = config || {};
+    const { adChoicesEnabled, cisBaseUrl, cisEnabled, includeAdvertising: includeAdvertisingPromise, isHybrid, nativeJwe, providerId, trackerId, vendors, } = config || {};
     const [includeAdvertising, actor] = await Promise.all([includeAdvertisingPromise, actorPromise]);
     const { id, realm } = actor;
     if (cisEnabled) {
@@ -53,6 +53,7 @@ const cisSync = async (data, builders, config) => {
         return (0, pulse_cis_sync_1.syncWithCis)(
         // @ts-expect-error
         id, nativeJwe, cisBaseUrl, realm, providerId, isHybrid ? 'Hybrid' : 'Web', version_1.SDK_VERSION, {
+            adChoicesEnabled,
             includeAdvertising,
             vendors,
             trackerId,

package/dist/cjs/leaveTrackingTpaas/constants.js

@@ -1,12 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_PAGE_LEAVE_EVENT = exports.DEFAULT_ACTIVITY_DURATION = void 0;
-const DEFAULT_ACTIVITY_DURATION = () => ({
-    value: 0,
-    interval: undefined,
-    timeSinceLastActivity: 0,
-});
-exports.DEFAULT_ACTIVITY_DURATION = DEFAULT_ACTIVITY_DURATION;
+exports.ACTIVITY_DURATION_LIMIT_MS = exports.DEFAULT_PAGE_LEAVE_EVENT = void 0;
 const DEFAULT_PAGE_LEAVE_EVENT = () => ({
     objectViewPercentage: 0,
     maxObjectViewPercentage: 0,
@@ -16,3 +10,4 @@ const DEFAULT_PAGE_LEAVE_EVENT = () => ({
     maxPageScrollPosition: 0,
 });
 exports.DEFAULT_PAGE_LEAVE_EVENT = DEFAULT_PAGE_LEAVE_EVENT;
+exports.ACTIVITY_DURATION_LIMIT_MS = 30000;

package/dist/cjs/leaveTrackingTpaas/index.js

@@ -56,19 +56,42 @@ let updateViewedContentListeners = [];
 let activityListeners = [];
 let resizeObserver = null;
 let throttledUpdateFn = (0, pulse_utils_1.throttle)(() => undefined, 0);
-let startTime = 0;
-let activityDuration = (0, constants_1.DEFAULT_ACTIVITY_DURATION)();
+let durationStartTime = 0;
+let activityStartTime = 0;
 let currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
 let additionalHeightBuilder;
+/**
+ * Resolves a DOM element from either a CSS selector string or an Element instance.
+ */
+function resolveDomElement(element) {
+    try {
+        return typeof element === 'string' ? document.querySelector(element) : element || null;
+    }
+    catch (e) {
+        logger.error('Error while resolving DOM element', e);
+        return null;
+    }
+}
 /*
  Add leave tracking
  */
 function addTpaasLeaveTracking({ objectElement, pageElement, schema, objectResizable, heightBuilder, trackMethod, }) {
     function _addLeaveTracking() {
+        const objectDomElement = resolveDomElement(objectElement);
+        if (objectDomElement == null) {
+            logger.error('Could not find object element for leave tracking');
+            return;
+        }
+        let pageDomElement = resolveDomElement(pageElement);
+        if (pageDomElement == null) {
+            logger.warn('Could not find page element for leave tracking, defaulting to document.body');
+            pageDomElement = document.body;
+        }
         additionalHeightBuilder = heightBuilder;
         addTpaasLeaveListeners();
-        addUpdateEventListeners(objectElement, pageElement || document.body, objectResizable);
-        startTime = resetTime();
+        addUpdateEventListeners(objectDomElement, pageDomElement, objectResizable);
+        activityStartTime = resetTime();
+        durationStartTime = resetTime();
         currentLeaveSchema = schema;
         currentTrackMethod = trackMethod;
         logger.debug('addLeaveTracking:after:state', currentLeaveEvent);
@@ -160,12 +183,8 @@ function removeUpdateEventListeners() {
  */
 const resetEventDefaults = () => {
     currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
-    startTime = resetTime();
-    activityDuration = resetActivityDuration();
-};
-const resetActivityDuration = () => {
-    clearInterval(activityDuration.interval);
-    return (0, constants_1.DEFAULT_ACTIVITY_DURATION)();
+    durationStartTime = resetTime();
+    activityStartTime = resetTime();
 };
 const resetTpaasViewedContent = () => {
     currentLeaveEvent = (0, constants_1.DEFAULT_PAGE_LEAVE_EVENT)();
@@ -174,34 +193,41 @@ exports.resetTpaasViewedContent = resetTpaasViewedContent;
 const resetTime = () => Date.now();
 /*
  Send a Leave event only if Page Leave tracking is active in the SDK
- The event that is ultimately sent is a merge between the default event
- saved in this file and the event supplied by the brand, with preference going
- to the brand event. After the event has been sent, leave page tracking is removed
+ The event that is ultimately sent is the View event saved in the currentTrackMethod callback.
+ After the event has been sent, leave page tracking is removed
  and must be explicitly re-added if needed.
 */
-function trackTpaasActiveLeave() {
+async function trackTpaasActiveLeave() {
     if (leaveTpaasTrackingIsActive()) {
-        trackTpaasLeave();
+        await trackTpaasLeave();
     }
 }
 /*
  Send a Leave event regardless of whether Page Leave tracking is active in the SDK
- The event that is ultimately sent is a merge between the default event
- saved in this file and the event supplied by the brand, with preference going
- to the brand event. After the event has been sent, leave page tracking is removed
+ The event that is ultimately sent is the View event saved in the currentTrackMethod callback.
+ After the event has been sent, leave page tracking is removed
  and must be explicitly re-added if needed.
  */
-function trackTpaasLeave() {
+async function trackTpaasLeave() {
     const leave = getTpaasLeaveObject();
-    currentTrackMethod(leave);
+    // Capture currentTrackMethod and remove tracking synchronously before awaiting.
+    // If removal happened after the await, a new trackView* call arriving during the async
+    // gap would see tracking still active with the same schema and silently discard its
+    // new callback (e.g. a fresh leaveAudioBuilder), causing the next leave event to
+    // never fire or to use the wrong builder.
+    const trackMethod = currentTrackMethod;
     removeTpaasLeaveTracking();
+    await trackMethod(leave);
 }
 function getTpaasLeaveObject() {
     const endTime = Date.now();
-    const duration = endTime - startTime;
+    // 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
+    const durationMs = Math.max(endTime - durationStartTime, 1);
+    const activityDurationMs = Math.max(Math.min(endTime - activityStartTime, constants_1.ACTIVITY_DURATION_LIMIT_MS), 1);
     const leave = {
-        durationMs: duration,
-        activityDurationMs: activityDuration.value,
+        durationMs,
+        activityDurationMs,
         ...currentLeaveEvent,
     };
     logger.debug('trackTpaasLeave: event', leave);
@@ -276,18 +302,10 @@ exports.calculateScrollPosition = calculateScrollPosition;
  'mousedown', 'mousemove', 'keydown', 'scroll' and/or 'touchstart' browser events.
  */
 function addUpdateActivityDurationListeners() {
-    if (activityDuration.interval !== undefined) {
-        // If the interval is already set, do not set it again
+    // if there are already listeners for activity, do not add more
+    if (activityListeners.length > 0) {
         return;
     }
-    const interval = 1000;
-    const activityTimeout = 30 * 1000;
-    activityDuration.interval = window.setInterval(() => {
-        activityDuration.timeSinceLastActivity += interval;
-        if (activityDuration.timeSinceLastActivity < activityTimeout) {
-            activityDuration.value += interval;
-        }
-    }, interval);
     const activityEvents = [
         types_1.BrowserEvents.SCROLL,
         types_1.BrowserEvents.MOUSEDOWN,
@@ -296,15 +314,9 @@ function addUpdateActivityDurationListeners() {
         types_1.BrowserEvents.TOUCHSTART,
     ];
     activityListeners = addEventListeners(activityEvents, () => {
-        activityDuration = resetLastActivity(activityDuration);
+        activityStartTime = resetTime();
     }, { passive: true });
 }
-function resetLastActivity(activityDuration) {
-    return {
-        ...activityDuration,
-        timeSinceLastActivity: 0,
-    };
-}
 /*
  Add listeners to a set of browser events.
  */

package/dist/cjs/tracker-proxy/consts.js

@@ -37,15 +37,13 @@ exports.TPAAS_ALLOWED_METHODS = [
     'trackLeaveLandingpage',
     'trackLeaveListing',
     'trackLeaveLockedArticle',
-    'trackLeaveLockedAudio',
     'trackLeaveLockedAudioPage',
-    'trackLeaveLockedVideo',
     'trackLeaveLockedVideoPage',
     'trackLeavePage',
+    'trackLeaveSportsPage',
     'trackLeaveVideoPage',
     'trackLeaveWeather',
     'trackViewArticle',
-    'trackViewAudio',
     'trackViewAudioPage',
     'trackViewError',
     'trackViewFrontpage',
@@ -53,15 +51,23 @@ exports.TPAAS_ALLOWED_METHODS = [
     'trackViewLandingpage',
     'trackViewListing',
     'trackViewLockedArticle',
-    'trackViewLockedAudio',
     'trackViewLockedAudioPage',
-    'trackViewLockedVideo',
     'trackViewLockedVideoPage',
     'trackViewPage',
+    'trackViewSportsPage',
     'trackViewTitle',
-    'trackViewVideo',
     'trackViewVideoPage',
     'trackViewWeather',
+    // these are not TPaaS methods,
+    // but they're part of this list to not have to duplicate the tracker-tpaas-proxy.ts implementation in tracker-proxy.ts
+    'trackLegacyViewArticle',
+    'trackLegacyViewLoginPoster',
+    'trackLegacyViewSalesPoster',
+    'trackLegacyViewListing',
+    'trackLegacyViewFrontpage',
+    'trackLegacyViewPage',
+    'trackLegacyViewUIElement',
+    'trackLegacyClickUIElement',
 ];
 function isPulseProxyMessage(message) {
     return (message !== null &&

package/dist/cjs/tracker-proxy/proxy-provider.js

@@ -13,6 +13,11 @@ function startProxyProviderListener(tracker) {
         loglevel_1.default.debug('Proxy Provider - Not in browser environment, skipping message listener');
         return () => { };
     }
+    if (tracker.hasProxyListener) {
+        loglevel_1.default.debug('Proxy Provider - Message listener already registered for this tracker, skipping');
+        return () => { };
+    }
+    tracker.hasProxyListener = true;
     loglevel_1.default.debug('Proxy Provider - Added message listener for proxy provider');
     const listener = async (event) => {
         loglevel_1.default.debug('Proxy Provider - message received', event.data);
@@ -64,5 +69,6 @@ function startProxyProviderListener(tracker) {
     window.addEventListener('message', listener);
     return () => {
         window.removeEventListener('message', listener);
+        tracker.hasProxyListener = false;
     };
 }

package/dist/cjs/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
 // This file is auto-generated by bin/generate-version.js. Do not edit manually.
-exports.SDK_VERSION = '8.0.0-rc.1';
+exports.SDK_VERSION = '8.0.0-rc.10';

package/dist/cjs/visibility-observer/index.js

@@ -16,14 +16,16 @@ class VisibilityObserver {
      * Uses {@link https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver | MutationObserver} to monitor the DOM for dynamically loaded content.
      * Callback is invoked only once per element.
      * @param selector The CSS selector for elements to track.
+     * @param options {ObserverOptions} Optional configuration for the observer.
+     * @param options.threshold Which ratio triggers the Observer callback.
      * @throws Error if called more than once.
      */
-    observe(selector) {
+    observe(selector, { threshold = 0.67 }) {
         if (this.selector) {
             throw new Error(`Cannot observe selector ${selector}. A visibility observer has already been set up for selector ${this.selector}.`);
         }
         this.selector = selector;
-        this.setupObservers();
+        this.setupObservers({ threshold });
         // biome-ignore lint/suspicious/useIterableCallbackReturn: -
         this.elements().forEach((elementToTrack) => this.observeIntersection(elementToTrack));
     }
@@ -33,14 +35,14 @@ class VisibilityObserver {
     elements() {
         return Array.from(document.querySelectorAll(this.selector));
     }
-    // Initialize both observers and start watching for DOM changes
-    setupObservers() {
-        this.setupIntersectionObserver();
+    // Initialise both observers and start watching for DOM changes
+    setupObservers({ threshold }) {
+        this.setupIntersectionObserver({ threshold });
         this.setupMutationObserver();
         this.observeMutations();
     }
     // Create observer to detect when elements become visible in the viewport
-    setupIntersectionObserver() {
+    setupIntersectionObserver({ threshold }) {
         this.intersectionObserver = new IntersectionObserver((entries) => {
             entries.forEach((entry) => {
                 if (entry.isIntersecting) {
@@ -49,7 +51,7 @@ class VisibilityObserver {
                     this.intersectionObserver.unobserve(node);
                 }
             });
-        }, { threshold: 2 / 3 });
+        }, { threshold });
     }
     // Create observer to detect DOM changes that may add/remove tracked elements
     setupMutationObserver() {

package/dist/cjs/wrapper/types/event.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLegacyPageType = isLegacyPageType;
+const LEGACY_PAGE_TYPE_VALUES = ['Article', 'Listing', 'Frontpage', 'SalesPoster', 'Page', 'LoginPoster'];
+function isLegacyPageType(value) {
+    return LEGACY_PAGE_TYPE_VALUES.includes(value);
+}