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

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

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

package/dist/ejs/builders/actor.js

@@ -12,11 +12,11 @@ export 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
  */
-export function isActorInput(input) {
+export function hasActorBuilder(input) {
     // biome-ignore lint/suspicious/noPrototypeBuiltins: Object.hasOwn is not available in ES2020
     return isPlainObject(input) && Object.prototype.hasOwnProperty.call(input, 'actor');
 }

package/dist/ejs/builders/consents.js

@@ -3,7 +3,7 @@ import { isPromise } from '@schibsted/pulse-utils';
 import warnOnce from '../warnOnce';
 import { getFallbackConsents } from './consent-manager';
 /**
- * @enum ConsentCategory
+ * @enum ConsentsCategory
  */
 export var ConsentsCategory;
 (function (ConsentsCategory) {
@@ -12,7 +12,7 @@ export var ConsentsCategory;
     ConsentsCategory["CMP_ADVERTISING"] = "CMP_ADVERTISING";
     ConsentsCategory["CMP_PERSONALIZATION"] = "CMP_PERSONALIZATION";
 })(ConsentsCategory || (ConsentsCategory = {}));
-export const ConsentsSourceValues = ['default', 'cmp', 'cache'];
+export const ConsentsSourceValues = ['default', 'cmp', 'cache', 'url'];
 export const ConsentsPurposeCategoryStatusValues = ['accepted', 'rejected', 'unknown'];
 const isLegacyConsentsPurpose = (consentsPurposeCategory) => {
     return !consentsPurposeCategory?.status;

package/dist/ejs/builders/events-anonymous-node.js

@@ -25,7 +25,7 @@ export function anonymousTrackerEvent({ eventInput, sdkConfig } = {}) {
     return Object.assign({}, omit(eventInput, ['type']), {
         '@type': eventInput?.type || 'View',
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/tracker-event.json/351.json`,
+            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/tracker-event.json/360.json`,
         consents: consentsBuilder(parentInput),
         experiments: experimentsBuilder(parentInput),
         experimentMetadata: experimentMetadataBuilder(parentInput),

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

@@ -22,7 +22,7 @@ function routableEventDefaults(eventInput) {
 export function routableEvent({ eventInput, sdkConfig } = {}) {
     return Object.assign({}, eventInput, {
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/base-routable-event.json/246.json#`,
+            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/base-routable-event.json/248.json#`,
         provider: providerBuilder(eventInput),
         actor: actorBuilder(eventInput),
     });
@@ -55,7 +55,7 @@ export function trackerEvent({ eventInput, sdkConfig } = {}) {
         '@type': eventInput?.type || 'View',
         pageViewId: pageViewIdInput || pageViewIdSdk,
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/tracker-event.json/359.json`,
+            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/tracker-event.json/361.json`,
         actor: actorBuilder(parentInput),
         consents: consentsBuilder(parentInput),
         experiments: experimentsBuilder(parentInput),
@@ -73,7 +73,7 @@ trackerEvent.defaults = trackerEventInput;
 export function engagementEvent({ eventInput, sdkConfig } = {}) {
     return Object.assign(trackerEvent({ eventInput, sdkConfig }), {
         schema: eventInput?.schema ||
-            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/engagement-event.json/386.json`,
+            `http://${sdkConfig?.schemaLocation || DEFAULT_SCHEMA_LOCATION}/events/engagement-event.json/388.json`,
         '@type': 'Engagement',
     });
 }

package/dist/ejs/builders/experiments.js

@@ -1,4 +1,4 @@
-function generateExperimentSDRN(id, experimentationPlatform) {
+export function generateExperimentSDRN(id, experimentationPlatform) {
     return `sdrn:${experimentationPlatform}:experiment:${id}`;
 }
 /**

package/dist/ejs/builders/tracker-node.js

@@ -1,4 +1,4 @@
-import version from '../version.json';
+import { SDK_VERSION } from '../version';
 /**
  * Format tracker objects
  */
@@ -7,7 +7,7 @@ export default function tracker(input) {
     const base = {
         name: 'Pulse Node.js SDK',
         type: 'JS',
-        version: version.SDK_VERSION,
+        version: SDK_VERSION,
     };
     return Object.assign({}, base, trackerInput);
 }

package/dist/ejs/identity/actor.js

@@ -1,12 +1,10 @@
 import { evaluateAndFlatten } from '@schibsted/pulse-utils';
-import { isActorInput } from '../builders/actor';
+import { hasActorBuilder } from '../builders/actor';
 import warnOnce from '../warnOnce';
 /**
  * @internal exported for testing
  */
-export const 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.';
+export const 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.
@@ -25,6 +23,19 @@ const getUserId = async (builders) => {
 const getActor = async (builders) => {
     return await evaluateActor(builders);
 };
+/**
+ * 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 (hasActorBuilder(eventInput)) {
+        return eventInput.actor;
+    }
+    if (hasActorBuilder(builders)) {
+        return builders.actor;
+    }
+}
 const userIsLoggedIn = async (builders) => {
     const actor = await getActor(builders);
     return !!actor?.id;
@@ -36,8 +47,9 @@ const userIsLoggedIn = async (builders) => {
  * @private
  */
 const evaluateActor = async (eventInput = {}, builders = {}) => {
-    if (isActorInput(eventInput) || isActorInput(builders)) {
-        const evaluatedActor = await evaluateAndFlatten(eventInput.actor || builders.actor);
+    const actorSource = getActorSource(eventInput, builders);
+    if (actorSource) {
+        const evaluatedActor = await evaluateAndFlatten(actorSource);
         if (evaluatedActor) {
             return evaluatedActor;
         }
@@ -45,7 +57,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.
-    warnOnce('no-actor-builder-and-no-event-present', WARN_CIS_SYNC_LOGIN_UNDEFINED);
+    warnOnce('no-actor-builder', WARN_CIS_SYNC_LOGIN_UNDEFINED);
     return {};
 };
 export { getUserId, getActor, userIsLoggedIn, evaluateActor };

package/dist/ejs/identity/cis.js

@@ -1,5 +1,5 @@
 import { clearCookieJweIfStale, resetRefreshAfter, syncWithCis } from '@schibsted/pulse-cis-sync';
-import version from '../version.json';
+import { SDK_VERSION } from '../version';
 import { evaluateActor } from './actor';
 const requireCisSyncCallForAdvertisingIds = () => {
     resetRefreshAfter(new Date());
@@ -40,14 +40,15 @@ const cisSync = async (data, builders, config) => {
     // _pulse2data cookie, or just not do the sync.
     //
     const actorPromise = 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) {
         // @ts-expect-error
         return syncWithCis(
         // @ts-expect-error
-        id, nativeJwe, cisBaseUrl, realm, providerId, isHybrid ? 'Hybrid' : 'Web', version.SDK_VERSION, {
+        id, nativeJwe, cisBaseUrl, realm, providerId, isHybrid ? 'Hybrid' : 'Web', SDK_VERSION, {
+            adChoicesEnabled,
             includeAdvertising,
             vendors,
             trackerId,

package/dist/ejs/leaveTrackingTpaas/constants.js

@@ -1,8 +1,3 @@
-export const DEFAULT_ACTIVITY_DURATION = () => ({
-    value: 0,
-    interval: undefined,
-    timeSinceLastActivity: 0,
-});
 export const DEFAULT_PAGE_LEAVE_EVENT = () => ({
     objectViewPercentage: 0,
     maxObjectViewPercentage: 0,
@@ -11,3 +6,4 @@ export const DEFAULT_PAGE_LEAVE_EVENT = () => ({
     pageScrollPosition: 0,
     maxPageScrollPosition: 0,
 });
+export const ACTIVITY_DURATION_LIMIT_MS = 30000;

package/dist/ejs/leaveTrackingTpaas/index.js

@@ -1,6 +1,6 @@
 import { isBrowser, isFunction, throttle } from '@schibsted/pulse-utils';
 import * as logger from 'loglevel';
-import { DEFAULT_ACTIVITY_DURATION, DEFAULT_PAGE_LEAVE_EVENT } from './constants';
+import { ACTIVITY_DURATION_LIMIT_MS, DEFAULT_PAGE_LEAVE_EVENT } from './constants';
 import { BrowserEvents } from './types';
 let currentLeaveSchema;
 let currentTrackMethod;
@@ -9,19 +9,42 @@ let updateViewedContentListeners = [];
 let activityListeners = [];
 let resizeObserver = null;
 let throttledUpdateFn = throttle(() => undefined, 0);
-let startTime = 0;
-let activityDuration = DEFAULT_ACTIVITY_DURATION();
+let durationStartTime = 0;
+let activityStartTime = 0;
 let currentLeaveEvent = 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
  */
 export 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);
@@ -113,12 +136,8 @@ function removeUpdateEventListeners() {
  */
 const resetEventDefaults = () => {
     currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
-    startTime = resetTime();
-    activityDuration = resetActivityDuration();
-};
-const resetActivityDuration = () => {
-    clearInterval(activityDuration.interval);
-    return DEFAULT_ACTIVITY_DURATION();
+    durationStartTime = resetTime();
+    activityStartTime = resetTime();
 };
 export const resetTpaasViewedContent = () => {
     currentLeaveEvent = DEFAULT_PAGE_LEAVE_EVENT();
@@ -126,34 +145,41 @@ export const 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.
 */
-export function trackTpaasActiveLeave() {
+export 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.
  */
-export function trackTpaasLeave() {
+export 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);
 }
 export 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, ACTIVITY_DURATION_LIMIT_MS), 1);
     const leave = {
-        durationMs: duration,
-        activityDurationMs: activityDuration.value,
+        durationMs,
+        activityDurationMs,
         ...currentLeaveEvent,
     };
     logger.debug('trackTpaasLeave: event', leave);
@@ -226,18 +252,10 @@ export const calculateScrollPosition = (element) => Math.abs(Math.min(element.ge
  '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 = [
         BrowserEvents.SCROLL,
         BrowserEvents.MOUSEDOWN,
@@ -246,15 +264,9 @@ function addUpdateActivityDurationListeners() {
         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/ejs/tracker-proxy/consts.js

@@ -33,15 +33,13 @@ export const TPAAS_ALLOWED_METHODS = [
     'trackLeaveLandingpage',
     'trackLeaveListing',
     'trackLeaveLockedArticle',
-    'trackLeaveLockedAudio',
     'trackLeaveLockedAudioPage',
-    'trackLeaveLockedVideo',
     'trackLeaveLockedVideoPage',
     'trackLeavePage',
+    'trackLeaveSportsPage',
     'trackLeaveVideoPage',
     'trackLeaveWeather',
     'trackViewArticle',
-    'trackViewAudio',
     'trackViewAudioPage',
     'trackViewError',
     'trackViewFrontpage',
@@ -49,15 +47,23 @@ export const 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',
 ];
 export function isPulseProxyMessage(message) {
     return (message !== null &&

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

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

package/dist/ejs/version.js

@@ -0,0 +1,2 @@
+// This file is auto-generated by bin/generate-version.js. Do not edit manually.
+export const SDK_VERSION = '8.0.0-rc.10';

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

@@ -13,14 +13,16 @@ export 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));
     }
@@ -30,14 +32,14 @@ export 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) {
@@ -46,7 +48,7 @@ export 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/ejs/wrapper/types/event.js

@@ -1 +1,4 @@
-export {};
+const LEGACY_PAGE_TYPE_VALUES = ['Article', 'Listing', 'Frontpage', 'SalesPoster', 'Page', 'LoginPoster'];
+export function isLegacyPageType(value) {
+    return LEGACY_PAGE_TYPE_VALUES.includes(value);
+}