@schibsted/pulse-sdk 8.0.0-rc.17 → 8.0.0-rc.18

package/dist/cjs/Tracker.js

@@ -172,12 +172,12 @@ function unsubscribe(eventName, callback) {
  * @class Tracker
  */
 class Tracker {
-    async getCurrentTpaasPage() {
-        const { id, type, url } = await this.currentPageInfo;
+    async getCurrentTpaasPage(currentPageInfo = this.currentPageContext.info) {
+        const { id, type, url } = await currentPageInfo;
         return (0, map_page_to_page_ref_1.mapPageToPageRef)(id, type, url);
     }
     async getCurrentLegacyPage() {
-        const { id, type, url } = await this.currentPageInfo;
+        const { id, type, url } = await this.currentPageContext.info;
         // make sure the pageType is valid for legacy events
         const validatedType = (0, types_1.isLegacyPageType)(type) ? type : 'Page';
         return {
@@ -206,37 +206,33 @@ class Tracker {
         this.legacyVisibilityObservers = new Map();
         this.visibilityObservers = new Map();
         /**
-         * @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
+         * Current page state shared by legacy and TPaaS tracking. See CurrentPageContext for
+         * which properties are shared and which are exclusively TPaaS metadata.
          */
-        this.currentPageInfo = {
-            id: 'unknown',
-            type: 'Page',
-            url: utils_1.isBrowser ? window.location.href : undefined,
-        };
-        /**
-         * @private
-         *
-         * This is used as the source of truth for the current page's referrer information, which is updated based on the View Page-level event
-         * !! This is only used in TPaaS events and contexts, as we don't want to risk changing the behaviour of legacy events
-         * This is also the reason this is being kept as a separate variable from the currentPageInfo property,
-         *  which is used for both legacy and TPaaS events
-         */
-        this.currentPageReferrer = {
-            url: utils_1.isBrowser ? document.referrer || undefined : undefined,
-        };
-        this.setCurrentTpaasPageData = (id, type, referrer) => {
-            this.currentPageInfo = {
-                id: id || 'unknown',
-                type: type || 'Page',
+        this.currentPageContext = {
+            info: {
+                id: 'unknown',
+                type: 'Page',
                 url: utils_1.isBrowser ? window.location.href : undefined,
-            };
-            this.currentPageReferrer = {
-                ...referrer,
-                url: referrer?.url ?? (utils_1.isBrowser ? document.referrer || undefined : undefined),
+            },
+            referrer: {
+                url: utils_1.isBrowser ? document.referrer || undefined : undefined,
+            },
+        };
+        this.setCurrentTpaasPageData = ({ id, type, referrer, content, sports, }) => {
+            // TPaaS Views replace the context, intentionally resetting omitted content and sports.
+            this.currentPageContext = {
+                info: {
+                    id: id || 'unknown',
+                    type: type || 'Page',
+                    url: utils_1.isBrowser ? window.location.href : undefined,
+                },
+                referrer: {
+                    ...referrer,
+                    url: referrer?.url ?? (utils_1.isBrowser ? document.referrer || undefined : undefined),
+                },
+                content,
+                sports,
             };
         };
         /**
@@ -250,8 +246,9 @@ class Tracker {
          */
         this.hasProxyListener = false;
         this.setPageDefaults = (pageViewEvent) => {
-            this.currentPageInfo = (0, page_from_page_view_1.pageFromPageView)(pageViewEvent);
-            this.currentPageReferrer = Promise.resolve(pageViewEvent.origin).then((originProperties) => (0, map_page_to_page_ref_1.mapPageToPageRef)(originProperties?.id, originProperties?.type, originProperties?.url));
+            // Legacy Views update only the shared properties, preserving TPaaS-only content and sports.
+            this.currentPageContext.info = (0, page_from_page_view_1.pageFromPageView)(pageViewEvent);
+            this.currentPageContext.referrer = Promise.resolve(pageViewEvent.origin).then((originProperties) => (0, map_page_to_page_ref_1.mapPageToPageRef)(originProperties?.id, originProperties?.type, originProperties?.url));
             if (pageViewEvent.origin) {
                 const pageDefaults = { origin: pageViewEvent.origin };
                 this.update(pageDefaults, true);
@@ -517,6 +514,11 @@ class Tracker {
      * @category TPaaS Tracking
      */
     async prepareAnonymousTpaasEvent() {
+        const { isHybrid, pageViewId, providerId, component, componentVersion, deployStageTpaas } = this.state;
+        const providerName = this.state.provider?.name;
+        const providerGroup = this.state.provider?.group;
+        const experimentsInput = this.builders.experiments;
+        const currentPageReferrerInput = this.currentPageContext.referrer;
         try {
             await this._applyRemoteConfigEndpoints();
         }
@@ -524,20 +526,19 @@ class Tracker {
             loglevel_1.default.trace('Failed to sync remote config', ex);
         }
         const [experiments, currentPageReferrer] = await Promise.all([
-            this.adaptExperiments(this.builders.experiments),
-            this.currentPageReferrer,
+            this.adaptExperiments(experimentsInput),
+            currentPageReferrerInput,
         ]);
         return {
-            autoTrackerVersion: this.builders.tracker?.autoTrackerVersion,
             version: version_1.SDK_VERSION,
-            isHybrid: !!this.state.isHybrid,
-            pageviewId: this.state.pageViewId,
-            providerId: this.state.providerId,
-            providerName: this.state.provider?.name,
-            providerGroup: this.state.provider?.group,
-            component: this.state.component,
-            componentVersion: this.state.componentVersion,
-            routingStage: mapDeployStageToTpaasStage(this.state.deployStageTpaas),
+            isHybrid: !!isHybrid,
+            pageviewId: pageViewId,
+            providerId,
+            providerName,
+            providerGroup,
+            component,
+            componentVersion,
+            routingStage: mapDeployStageToTpaasStage(deployStageTpaas),
             experiments,
             currentPageReferrer,
         };
@@ -547,8 +548,15 @@ class Tracker {
      * @category TPaaS Tracking
      */
     async prepareTpaasEvent() {
+        // Capture event context before any asynchronous work so a concurrent update or View
+        // event cannot change the dependencies used to finish building this event.
+        const builders = { ...this.builders };
+        const { isHybrid, providerId, component, componentVersion, pageViewId, deployStageTpaas } = this.state;
+        const providerName = this.state.provider?.name;
+        const providerGroup = this.state.provider?.group;
+        const { info: currentPageInfoInput, content: currentPageContent, sports: currentPageSports, referrer: currentPageReferrerInput, } = this.currentPageContext;
         try {
-            await this.syncRemoteResources(undefined, { ...this.builders });
+            await this.syncRemoteResources(undefined, builders);
         }
         catch (ex) {
             loglevel_1.default.trace('Failed to sync remote resources', ex);
@@ -602,28 +610,31 @@ class Tracker {
                 source: source || 'unknown',
             };
         }
+        // Consents are intentionally not part of the event-context snapshot. Read them after
+        // remote synchronization so a blocking tracking call can use newly resolved consents.
         const [actor, consents, experiments, currentPage, currentPageReferrer] = await Promise.all([
-            this.getActor(),
+            identity.getActor(builders),
             this.getConsents(),
-            this.adaptExperiments(this.builders.experiments),
-            this.getCurrentTpaasPage(),
-            this.currentPageReferrer,
+            this.adaptExperiments(builders.experiments),
+            this.getCurrentTpaasPage(currentPageInfoInput),
+            currentPageReferrerInput,
         ]);
         const { environmentId, jwe } = (0, cis_sync_1.parsePulseCookies)();
         return {
-            autoTrackerVersion: this.builders.tracker?.autoTrackerVersion,
             version: version_1.SDK_VERSION,
-            isHybrid: !!this.state.isHybrid,
+            isHybrid: !!isHybrid,
             user: adaptActorToNewFormat(actor),
             consents: adaptConsentsToNewFormat(consents),
-            providerId: this.state.providerId,
-            providerName: this.state.provider?.name,
-            providerGroup: this.state.provider?.group,
-            component: this.state.component,
-            componentVersion: this.state.componentVersion,
-            pageviewId: this.state.pageViewId,
-            routingStage: mapDeployStageToTpaasStage(this.state.deployStageTpaas),
+            providerId,
+            providerName,
+            providerGroup,
+            component,
+            componentVersion,
+            pageviewId: pageViewId,
+            routingStage: mapDeployStageToTpaasStage(deployStageTpaas),
             currentPage,
+            currentPageContent,
+            currentPageSports,
             currentPageReferrer,
             experiments,
             environmentId,
@@ -883,7 +894,11 @@ class Tracker {
     }
     async trackViewHealthPage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewHealthPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewHealthPage.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewHealthPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -923,7 +938,11 @@ class Tracker {
      */
     async trackViewPage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewPage.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -949,7 +968,12 @@ class Tracker {
      */
     async trackViewSportsPage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewSportsPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewSportsPage.object.objectType,
+            referrer: input.page?.referrer,
+            sports: input.object.sports,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewSportsPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -974,7 +998,11 @@ class Tracker {
      */
     async trackViewTitle(input) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewTitle.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewTitle.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewTitleEvent)(input, dependencies);
         return this.sendTpaasEvent(event);
@@ -1014,7 +1042,12 @@ class Tracker {
      */
     async trackViewArticle(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewArticle.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewArticle.object.objectType,
+            referrer: input.page?.referrer,
+            content: input.page?.content,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewArticleEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1075,7 +1108,12 @@ class Tracker {
      */
     async trackViewAudioPage(input, options) {
         this.newPageView();
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewAudioPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewAudioPage.object.objectType,
+            referrer: input.page?.referrer,
+            content: input.page?.content,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewAudioPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1113,7 +1151,11 @@ class Tracker {
      */
     async trackViewError(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewError.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewError.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewErrorEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1186,6 +1228,15 @@ class Tracker {
         const event = (0, tpaas_builders_1.buildImpressionPlayerEvent)(input, dependencies);
         return this.sendTpaasEvent(event);
     }
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    async trackImpressionSportsUIElement(input) {
+        const dependencies = await this.prepareTpaasEvent();
+        const event = (0, tpaas_builders_1.buildImpressionSportsUIElementEvent)(input, dependencies);
+        return this.sendTpaasEvent(event);
+    }
     /**
      * @param input
      * @category TPaaS Tracking
@@ -1211,7 +1262,11 @@ class Tracker {
      */
     async trackViewFrontpage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewFrontpage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewFrontpage.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewFrontpageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1237,7 +1292,11 @@ class Tracker {
      */
     async trackViewLandingpage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewLandingpage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewLandingpage.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewLandingpageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1263,7 +1322,11 @@ class Tracker {
      */
     async trackViewListing(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewListing.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewListing.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewListingEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1289,7 +1352,12 @@ class Tracker {
      */
     async trackViewLockedArticle(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewLockedArticle.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewLockedArticle.object.objectType,
+            referrer: input.page?.referrer,
+            content: input.page?.content,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewLockedArticleEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1315,7 +1383,12 @@ class Tracker {
      */
     async trackViewLockedAudioPage(input, options) {
         this.newPageView();
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewLockedAudioPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewLockedAudioPage.object.objectType,
+            referrer: input.page?.referrer,
+            content: input.page?.content,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewLockedAudioPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1334,6 +1407,37 @@ class Tracker {
         }
         return result;
     }
+    /**
+     * @param input
+     * @param options
+     * @category TPaaS Tracking
+     */
+    async trackViewLockedPage(input, options) {
+        this.newPageView();
+        // LockedPage is not currently part of the catalog's PageRef.pageType enum.
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: 'Page',
+            referrer: input.page?.referrer,
+        });
+        const dependencies = await this.prepareTpaasEvent();
+        const event = (0, tpaas_builders_1.buildViewLockedPageEvent)(input, dependencies);
+        const result = this.sendTpaasEvent(event);
+        if ((0, leaveTrackingTpaas_1.shouldEnableLeaveTracking)(options.leaveTracking)) {
+            const leaveLockedPageCallback = async (leave) => {
+                await this.trackLeaveLockedPage({
+                    leave,
+                    ...input,
+                });
+            };
+            (0, leaveTrackingTpaas_1.addTpaasLeaveTracking)({
+                ...options.leaveTracking,
+                schema: tpaas_schemas_1.LeaveLockedPage.object.objectType,
+                trackMethod: leaveLockedPageCallback,
+            });
+        }
+        return result;
+    }
     /**
      * @param input
      * @param options
@@ -1341,7 +1445,12 @@ class Tracker {
      */
     async trackViewLockedVideoPage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewLockedVideoPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewLockedVideoPage.object.objectType,
+            referrer: input.page?.referrer,
+            content: input.page?.content,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewLockedVideoPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1404,7 +1513,12 @@ class Tracker {
      */
     async trackViewVideoPage(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewVideoPage.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewVideoPage.object.objectType,
+            referrer: input.page?.referrer,
+            content: input.page?.content,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewVideoPageEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1437,7 +1551,11 @@ class Tracker {
      */
     async trackViewWeather(input, options) {
         this.newPageView(); // Reset the page view ID if it is not set, to ensure a new page view is tracked
-        this.setCurrentTpaasPageData(input.object.objectId, tpaas_schemas_1.ViewWeather.object.objectType, input.page?.referrer);
+        this.setCurrentTpaasPageData({
+            id: input.object.objectId,
+            type: tpaas_schemas_1.ViewWeather.object.objectType,
+            referrer: input.page?.referrer,
+        });
         const dependencies = await this.prepareTpaasEvent();
         const event = (0, tpaas_builders_1.buildViewWeatherEvent)(input, dependencies);
         const result = this.sendTpaasEvent(event);
@@ -1528,6 +1646,15 @@ class Tracker {
         const event = (0, tpaas_builders_1.buildLeaveLockedAudioPageEvent)(input, dependencies);
         return this.sendTpaasEvent(event);
     }
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    async trackLeaveLockedPage(input) {
+        const dependencies = await this.prepareTpaasEvent();
+        const event = (0, tpaas_builders_1.buildLeaveLockedPageEvent)(input, dependencies);
+        return this.sendTpaasEvent(event);
+    }
     /**
      * @param input
      * @category TPaaS Tracking
@@ -1618,6 +1745,15 @@ class Tracker {
         const event = (0, tpaas_builders_1.buildEngagementOfferEvent)(input, dependencies);
         return this.sendTpaasEvent(event);
     }
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    async trackEngagementSportsUIElement(input) {
+        const dependencies = await this.prepareTpaasEvent();
+        const event = (0, tpaas_builders_1.buildEngagementSportsUIElementEvent)(input, dependencies);
+        return this.sendTpaasEvent(event);
+    }
     /**
      * @param input
      * @category TPaaS Tracking

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.builder = void 0;
+const builder = (content) => ({
+    page: content ? { content } : {},
+});
+exports.builder = builder;

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.builder = void 0;
+const builder = (sports) => ({
+    page: sports ? { sports } : {},
+});
+exports.builder = builder;

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

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