@schibsted/pulse-sdk 8.0.0-rc.6 → 8.0.0-rc.8

package/dist/cjs/Tracker.js

@@ -53,6 +53,7 @@ const consent_manager_1 = require("./builders/consent-manager");
 const consents_1 = require("./builders/consents");
 const events_1 = require("./builders/events");
 const events_anonymous_node_1 = require("./builders/events-anonymous-node");
+const experiments_1 = require("./builders/experiments");
 const session_browser_1 = require("./builders/session-browser");
 const config_1 = require("./config");
 const config_browser_1 = require("./config-browser");
@@ -68,6 +69,7 @@ const version_1 = require("./version");
 const visibility_observer_1 = require("./visibility-observer");
 const warnOnce_1 = __importDefault(require("./warnOnce"));
 const event_builder_1 = require("./wrapper/engagement/ui-element/event-builder");
+const types_1 = require("./wrapper/types");
 const page_from_page_view_1 = require("./wrapper/utils/page-from-page-view");
 const event_builder_2 = require("./wrapper/view/article/event-builder");
 const event_builder_3 = require("./wrapper/view/frontpage/event-builder");
@@ -157,6 +159,27 @@ function unsubscribe(eventName, callback) {
  * @class Tracker
  */
 class Tracker {
+    async getCurrentTpaasPage() {
+        const { id, type, url } = await this.currentPage;
+        return {
+            // remove the SDRN prefix, it's not expected for TPaaS
+            pageId: id.startsWith('sdrn:') ? id.split(':').slice(-1)[0] : id,
+            // make sure the pageType is valid for TPaaS
+            pageType: (0, tpaas_event_builder_1.isPageType)(type) ? type : 'Page',
+            url,
+        };
+    }
+    async getCurrentLegacyPage() {
+        const { id, type, url } = await this.currentPage;
+        // make sure the pageType is valid for legacy events
+        const validatedType = (0, types_1.isLegacyPageType)(type) ? type : 'Page';
+        return {
+            // add the SDRN prefix if it's not there, legacy events expect the full SDRN format
+            id: id.startsWith('sdrn:') ? id : `sdrn:${this.state.providerId}:${validatedType.toLowerCase()}:${id}`,
+            type: validatedType,
+            url,
+        };
+    }
     /**
      * > [!WARNING]
      * >
@@ -175,12 +198,18 @@ class Tracker {
         // the tracking of the same element with both old and new events at the same time
         this.legacyVisibilityObservers = new Map();
         this.visibilityObservers = new Map();
-        this.legacyCurrentPage = {
-            id: 'undefined-id',
+        /**
+         * @private
+         *
+         * This is used as the source of truth for the current page's information, which is updated based on the View Page-level event
+         * As a single source of truth for the current page, this needs to be compatible between legacy and TPaaS events, hence the need for a custom data type.
+         * Legacy events can provide an id with SDRN, while TPaaS events don't need it
+         */
+        this.currentPage = {
+            id: 'unknown',
             type: 'Page',
-            url: typeof window !== 'undefined' ? window.location.href : '',
+            url: pulse_utils_1.isBrowser ? window.location.href : undefined,
         };
-        this.currentPage = undefined;
         /**
          * Promise that resolves when a session ID becomes available
          * @private
@@ -192,7 +221,7 @@ class Tracker {
          */
         this.hasProxyListener = false;
         this.setPageDefaults = (pageViewEvent) => {
-            this.legacyCurrentPage = (0, page_from_page_view_1.pageFromPageView)(pageViewEvent);
+            this.currentPage = (0, page_from_page_view_1.pageFromPageView)(pageViewEvent);
             if (pageViewEvent.origin) {
                 const pageDefaults = { origin: pageViewEvent.origin };
                 this.update(pageDefaults, true);
@@ -200,8 +229,8 @@ class Tracker {
         };
         this.setCurrentPage = (id, type) => {
             this.currentPage = {
-                pageId: id,
-                pageType: type,
+                id: id || 'unknown',
+                type: type || 'Page',
                 url: pulse_utils_1.isBrowser ? window.location.href : undefined,
             };
         };
@@ -443,7 +472,9 @@ class Tracker {
             return {
                 name: exp.name || exp.id,
                 variant: exp.variant || '',
-                experimentSdrn: exp.id,
+                // nobody should be sending experiment id with an sdrn format, but in case they do
+                // we want to be able to handle it and not generate an invalid sdrn by adding another layer to it
+                experimentSdrn: exp.id.startsWith('sdrn:') ? exp.id : (0, experiments_1.generateExperimentSDRN)(exp.id, exp.platform),
                 platform: exp.platform || '',
                 testId: exp.custom?.testId,
             };
@@ -530,10 +561,11 @@ class Tracker {
                 source: source || 'unknown',
             };
         }
-        const [actor, consents, experiments] = await Promise.all([
+        const [actor, consents, experiments, currentPage] = await Promise.all([
             this.getActor(),
             this.getConsents(),
             this.adaptExperiments(this.builders.experiments),
+            this.getCurrentTpaasPage(),
         ]);
         const { environmentId, jwe } = (0, pulse_cis_sync_1.parsePulseCookies)();
         return {
@@ -544,28 +576,12 @@ class Tracker {
             consents: adaptConsentsToNewFormat(consents),
             providerId: this.state.providerId,
             pageviewId: this.state.pageViewId,
-            currentPage: this.currentPage,
+            currentPage,
             experiments,
             environmentId,
             jwe,
         };
     }
-    /**
-     * Generate a generic TPaaS event with common builders output
-     * The method should be used for experiments, not for real production work.
-     * It doesn't have any real TPaaS schema associated with it.
-     * The method doesn't queue or send the event, it just returns the merged object.
-     * The method can be removed at any time in the future, so use it with caution.
-     *
-     * @param input - The input object to merge with the common builders output
-     * @returns A promise that resolves to the merged object
-     * @private
-     * @category TPaaS Tracking
-     */
-    async generateGenericTpaasEvent(input) {
-        const dependencies = await this.prepareTpaasEvent();
-        return (0, pulse_utils_1.pulseMerge)({}, input, (0, tpaas_event_builder_1.getCommonBuildersOutput)(new Date(), dependencies));
-    }
     /**
      * This method extends the list of base experiments that will be automatically included in every event sent by the tracker.
      *
@@ -587,6 +603,9 @@ class Tracker {
      * @category Tracking
      */
     addExperiments(experiments) {
+        if (experiments.some((experiment) => experiment.id.startsWith('sdrn:'))) {
+            loglevel_1.default.warn('Pulse - addExperiments received an experiment id starting with "sdrn:"; pass the raw experiment id instead. The SDK will generate the sdrn automatically.');
+        }
         this.update({ experiments }, true);
     }
     /**
@@ -621,7 +640,7 @@ class Tracker {
             const viewUIElementInputProperties = buildEventFromElement(element);
             this.trackLegacyViewUIElement(viewUIElementInputProperties);
         }));
-        this.legacyVisibilityObservers.get(selector)?.observe(selector);
+        this.legacyVisibilityObservers.get(selector)?.observe(selector, {});
     }
     /**
      * The `addUIElementVisibilityTracking` function provides an interface for sending tracking events when specific UI elements become visible within the viewport.
@@ -653,7 +672,38 @@ class Tracker {
             const eventInput = buildEventFromElement(element);
             this.trackImpressionUIElement(eventInput);
         }));
-        this.visibilityObservers.get(selector)?.observe(selector);
+        this.visibilityObservers.get(selector)?.observe(selector, {});
+    }
+    /**
+     * The `addElementVisibilityObserver` function provides an interface for executing arbitrary code when specific DOM Elements become visible within the viewport.
+     * It is built on the `VisibilityObserver` class, which efficiently detects visibility changes in DOM elements.
+     * When an element becomes at least 2/3 visible, a callback is triggered, with the Element that invoked the callback call as argument.
+     * It leverages the [Intersection Observer API](https://developer.mozilla.org/en-US/docs/Web/API/Intersection_Observer_API) for viewport tracking
+     * and the [Mutation Observer API](https://developer.mozilla.org/en-US/docs/Web/API/MutationObserver) to monitor lazy-loaded elements.
+     *
+     * Example usage:
+     *
+     * ```ts
+     * tracker.addElementVisibilityObserver('[data-pulse-entity-id]', (element) => {
+     *   const eventInput = parseElementIntoEventInput(element); // user-defined function
+     *   tracker.trackImpressionTeaser(eventInput); // can be anything actually, not necessarily a Teaser tracking call
+     * });
+     * ```
+     * @param selector
+     * @param callback
+     * @param options {ObserverOptions}
+     * @param options.threshold - A number between 0 and 1 indicating how much of the element should be visible to trigger
+     * the callback. Default is 0.67 (2/3 of the element).
+     */
+    addElementVisibilityObserver(selector, callback, options = {}) {
+        if (this.visibilityObservers.has(selector)) {
+            console.warn(`Cannot add UI Element visibility tracking for selector "${selector}" as it is already being tracked.`);
+            return;
+        }
+        this.visibilityObservers.set(selector, new visibility_observer_1.VisibilityObserver((element) => {
+            callback(element);
+        }));
+        this.visibilityObservers.get(selector)?.observe(selector, options);
     }
     /**
      * The old trackViewArticle method from the Media Wrapper.
@@ -747,7 +797,7 @@ class Tracker {
      * @category Legacy Tracking
      */
     trackLegacyViewUIElement(inputProperties, trackOptions) {
-        const viewUIElementEventData = (0, event_builder_8.buildLegacyViewUIElementEvent)(inputProperties, this.legacyCurrentPage);
+        const viewUIElementEventData = (0, event_builder_8.buildLegacyViewUIElementEvent)(inputProperties, this.getCurrentLegacyPage());
         return this.track('trackerEvent', viewUIElementEventData, trackOptions);
     }
     /**
@@ -758,7 +808,7 @@ class Tracker {
      * @category Legacy Tracking
      */
     trackLegacyClickUIElement(inputProperties, trackOptions) {
-        const clickUIElementEventData = (0, event_builder_1.buildClickUIElementEvent)(inputProperties, this.legacyCurrentPage);
+        const clickUIElementEventData = (0, event_builder_1.buildClickUIElementEvent)(inputProperties, this.getCurrentLegacyPage());
         return this.track('trackerEvent', clickUIElementEventData, trackOptions);
     }
     /**
@@ -831,10 +881,9 @@ class Tracker {
         const result = this.sendTpaasEvent(event);
         if ((0, leaveTrackingTpaas_1.shouldEnableLeaveTracking)(options.leaveTracking)) {
             const leavePageCallback = async (leave) => {
-                const { metrics, ...rest } = input; // metrics are not part of LeavePage schema, so we need to omit them
                 await this.trackLeavePage({
                     leave,
-                    ...rest,
+                    ...input,
                 });
             };
             (0, leaveTrackingTpaas_1.addTpaasLeaveTracking)({
@@ -905,12 +954,9 @@ class Tracker {
         const result = this.sendTpaasEvent(event);
         if ((0, leaveTrackingTpaas_1.shouldEnableLeaveTracking)(options.leaveTracking)) {
             const leaveArticleCallback = async (leave) => {
-                // omit these properties from LeaveArticle because they're not part of the LeaveArticle schema
-                const { authors, hotness, lifetime, sponsor, wordCount, ...rest } = input.object;
                 await this.trackLeaveArticle({
                     leave,
                     ...input,
-                    object: rest,
                 });
             };
             (0, leaveTrackingTpaas_1.addTpaasLeaveTracking)({
@@ -1020,6 +1066,15 @@ class Tracker {
         }
         return result;
     }
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    async trackImpressionAdSlot(input) {
+        const dependencies = await this.prepareTpaasEvent();
+        const event = (0, tpaas_event_builder_1.buildImpressionAdSlotEvent)(input, dependencies);
+        return this.sendTpaasEvent(event);
+    }
     /**
      * @param input
      * @category TPaaS Tracking
@@ -1078,10 +1133,9 @@ class Tracker {
         const result = this.sendTpaasEvent(event);
         if ((0, leaveTrackingTpaas_1.shouldEnableLeaveTracking)(options.leaveTracking)) {
             const leaveFrontpageCallback = async (leave) => {
-                const { metrics, ...rest } = input; // metrics are not part of LeaveFrontpage schema, so we need to omit them
                 await this.trackLeaveFrontpage({
                     leave,
-                    ...rest,
+                    ...input,
                 });
             };
             (0, leaveTrackingTpaas_1.addTpaasLeaveTracking)({
@@ -1157,12 +1211,9 @@ class Tracker {
         const result = this.sendTpaasEvent(event);
         if ((0, leaveTrackingTpaas_1.shouldEnableLeaveTracking)(options.leaveTracking)) {
             const leaveLockedArticleCallback = async (leave) => {
-                // omit these properties because they're not part of the LeaveLockedArticle schema
-                const { authors, hotness, lifetime, sponsor, wordCount, ...rest } = input.object;
                 await this.trackLeaveLockedArticle({
                     leave,
                     ...input,
-                    object: rest,
                 });
             };
             (0, leaveTrackingTpaas_1.addTpaasLeaveTracking)({
@@ -1308,11 +1359,9 @@ class Tracker {
         const result = this.sendTpaasEvent(event);
         if ((0, leaveTrackingTpaas_1.shouldEnableLeaveTracking)(options.leaveTracking)) {
             const leaveWeatherCallback = async (leave) => {
-                // omit object and page from input because they're not part of the LeaveWeather schema
-                const { object, page, ...rest } = input;
                 await this.trackLeaveWeather({
                     leave,
-                    ...rest,
+                    ...input,
                 });
             };
             (0, leaveTrackingTpaas_1.addTpaasLeaveTracking)({

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/tracker-proxy/consts.js

@@ -22,6 +22,7 @@ exports.TPAAS_ALLOWED_METHODS = [
     'trackEngagementVideoAd',
     'trackEngagementWidget',
     'trackCompletedHealthAction',
+    'trackImpressionAdSlot',
     'trackImpressionForm',
     'trackImpressionHealthUIElement',
     'trackImpressionOffer',

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.6';
+exports.SDK_VERSION = '8.0.0-rc.8';

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);
+}