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

package/dist/types/Tracker.d.ts

@@ -1,6 +1,6 @@
 import { type AdvertisingIdentifiers, type AdvertisingVendor } from '@schibsted/pulse-cis-sync';
 import { getCommonBuildersOutput, type InputParams } from '@schibsted/tpaas-event-builder';
-import { type IAnonymousViewUIElement, type ICompletedHealthAction, type IEngagementAudio, type IEngagementForm, type IEngagementHealthUIElement, type IEngagementOffer, type IEngagementTeaser, type IEngagementUIElement, type IEngagementVideo, type IEngagementVideoAd, type IEngagementWidget, type IImpressionForm, type IImpressionHealthUIElement, type IImpressionOffer, type IImpressionPlayer, type IImpressionTeaser, type IImpressionUIElement, type IImpressionWidget, type ILeave, type ILeaveArticle, type ILeaveAudioPage, type ILeaveError, type ILeaveFrontpage, type ILeaveLandingpage, type ILeaveListing, type ILeaveLockedArticle, type ILeaveLockedAudioPage, type ILeaveLockedVideoPage, type ILeavePage, type ILeaveSportsPage, type ILeaveVideoPage, type ILeaveWeather, type ITpaasEvent, type IViewArticle, type IViewAudioPage, type IViewError, type IViewFrontpage, type IViewHealthPage, type IViewLandingpage, type IViewListing, type IViewLockedArticle, type IViewLockedAudioPage, type IViewLockedVideoPage, type IViewPage, type IViewSportsPage, type IViewTitle, type IViewVideoPage, type IViewWeather } from '@schibsted/tpaas-schemas';
+import { type IAnonymousViewUIElement, type ICompletedHealthAction, type IEngagementAudio, type IEngagementForm, type IEngagementHealthUIElement, type IEngagementOffer, type IEngagementTeaser, type IEngagementUIElement, type IEngagementVideo, type IEngagementVideoAd, type IEngagementWidget, type IImpressionAdSlot, type IImpressionForm, type IImpressionHealthUIElement, type IImpressionOffer, type IImpressionPlayer, type IImpressionTeaser, type IImpressionUIElement, type IImpressionWidget, type ILeave, type ILeaveArticle, type ILeaveAudioPage, type ILeaveError, type ILeaveFrontpage, type ILeaveLandingpage, type ILeaveListing, type ILeaveLockedArticle, type ILeaveLockedAudioPage, type ILeaveLockedVideoPage, type ILeavePage, type ILeaveSportsPage, type ILeaveVideoPage, type ILeaveWeather, type ITpaasEvent, type IViewArticle, type IViewAudioPage, type IViewError, type IViewFrontpage, type IViewHealthPage, type IViewLandingpage, type IViewListing, type IViewLockedArticle, type IViewLockedAudioPage, type IViewLockedVideoPage, type IViewPage, type IViewSportsPage, type IViewTitle, type IViewVideoPage, type IViewWeather } from '@schibsted/tpaas-schemas';
 import logger from 'loglevel';
 import type { ActorInput, Consents, ConsentsInput, DeviceInput, LocationInput, ObjectInput, OriginInput, ProviderInput, TrackerInput } from './builders';
 import { engagementEvent, identityEvent, routableEvent, trackerEvent } from './builders/events';
@@ -9,8 +9,9 @@ import type { Deferred, ResolvedInput } from './defer';
 import { type Listener } from './EventBus/EventBus';
 import type { LeaveEvent, LeaveEventBuilder, LeaveEventOptions } from './leaveTracking/types';
 import type { AnonymousEventInputTypesByTrackingMethod, EventInput, EventInputTypesByTrackingMethod, TrackViewEventOptions } from './types';
+import { type ObserverOptions } from './visibility-observer';
 import type { ClickUIElementInputProperties } from './wrapper/engagement/ui-element/types';
-import type { BaseEventExperiment } from './wrapper/types';
+import { type BaseEventExperiment } from './wrapper/types';
 import type { ViewArticleInputProperties } from './wrapper/view/article/types';
 import type { ViewFrontpageInputProperties } from './wrapper/view/frontpage/types';
 import type { ViewListingInputProperties } from './wrapper/view/listing/types';
@@ -273,8 +274,16 @@ export default class Tracker {
     private bookmark;
     private legacyVisibilityObservers;
     private visibilityObservers;
-    private legacyCurrentPage;
+    /**
+     * @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
+     */
     private currentPage;
+    private getCurrentTpaasPage;
+    private getCurrentLegacyPage;
     /**
      * Promise that resolves when a session ID becomes available
      * @private
@@ -460,6 +469,28 @@ export default class Tracker {
      * @category Tracking
      */
     addUIElementVisibilityTracking(selector: string, buildEventFromElement: (element: HTMLElement) => InputParams<IImpressionUIElement>): void;
+    /**
+     * 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: string, callback: (element: HTMLElement) => void, options?: ObserverOptions): void;
     private setPageDefaults;
     /**
      * The old trackViewArticle method from the Media Wrapper.
@@ -625,6 +656,11 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackViewError(input: InputParams<IViewError>, options: TrackViewEventOptions<IViewError>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackImpressionAdSlot(input: InputParams<IImpressionAdSlot>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking

package/dist/types/tracker-proxy/consts.d.ts

@@ -17,7 +17,7 @@ export declare const MESSAGE_TYPE_INVOKE = "pulse-tracker-proxy:invoke";
 export declare const MESSAGE_TYPE_RETURN = "pulse-tracker-proxy:return";
 export declare const MESSAGE_TYPE_RETURN_ERROR = "pulse-tracker-proxy:return-error";
 export declare const ALLOWED_METHODS: readonly ["track"];
-export declare const TPAAS_ALLOWED_METHODS: readonly ["trackAnonymousViewUIElement", "trackEngagementAudio", "trackEngagementForm", "trackEngagementHealthUIElement", "trackEngagementOffer", "trackEngagementTeaser", "trackEngagementUIElement", "trackEngagementVideo", "trackEngagementVideoAd", "trackEngagementWidget", "trackCompletedHealthAction", "trackImpressionForm", "trackImpressionHealthUIElement", "trackImpressionOffer", "trackImpressionPlayer", "trackImpressionTeaser", "trackImpressionUIElement", "trackImpressionWidget", "trackLeaveArticle", "trackLeaveAudioPage", "trackLeaveError", "trackLeaveFrontpage", "trackLeaveLandingpage", "trackLeaveListing", "trackLeaveLockedArticle", "trackLeaveLockedAudioPage", "trackLeaveLockedVideoPage", "trackLeavePage", "trackLeaveSportsPage", "trackLeaveVideoPage", "trackLeaveWeather", "trackViewArticle", "trackViewAudioPage", "trackViewError", "trackViewFrontpage", "trackViewHealthPage", "trackViewLandingpage", "trackViewListing", "trackViewLockedArticle", "trackViewLockedAudioPage", "trackViewLockedVideoPage", "trackViewPage", "trackViewSportsPage", "trackViewTitle", "trackViewVideoPage", "trackViewWeather", "trackLegacyViewArticle", "trackLegacyViewLoginPoster", "trackLegacyViewSalesPoster", "trackLegacyViewListing", "trackLegacyViewFrontpage", "trackLegacyViewPage", "trackLegacyViewUIElement", "trackLegacyClickUIElement"];
+export declare const TPAAS_ALLOWED_METHODS: readonly ["trackAnonymousViewUIElement", "trackEngagementAudio", "trackEngagementForm", "trackEngagementHealthUIElement", "trackEngagementOffer", "trackEngagementTeaser", "trackEngagementUIElement", "trackEngagementVideo", "trackEngagementVideoAd", "trackEngagementWidget", "trackCompletedHealthAction", "trackImpressionAdSlot", "trackImpressionForm", "trackImpressionHealthUIElement", "trackImpressionOffer", "trackImpressionPlayer", "trackImpressionTeaser", "trackImpressionUIElement", "trackImpressionWidget", "trackLeaveArticle", "trackLeaveAudioPage", "trackLeaveError", "trackLeaveFrontpage", "trackLeaveLandingpage", "trackLeaveListing", "trackLeaveLockedArticle", "trackLeaveLockedAudioPage", "trackLeaveLockedVideoPage", "trackLeavePage", "trackLeaveSportsPage", "trackLeaveVideoPage", "trackLeaveWeather", "trackViewArticle", "trackViewAudioPage", "trackViewError", "trackViewFrontpage", "trackViewHealthPage", "trackViewLandingpage", "trackViewListing", "trackViewLockedArticle", "trackViewLockedAudioPage", "trackViewLockedVideoPage", "trackViewPage", "trackViewSportsPage", "trackViewTitle", "trackViewVideoPage", "trackViewWeather", "trackLegacyViewArticle", "trackLegacyViewLoginPoster", "trackLegacyViewSalesPoster", "trackLegacyViewListing", "trackLegacyViewFrontpage", "trackLegacyViewPage", "trackLegacyViewUIElement", "trackLegacyClickUIElement"];
 export declare function isPulseProxyMessage(message: unknown): message is Message;
 export type TrackInvocation = {
     method: 'track';

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.0.0-rc.6";
+export declare const SDK_VERSION = "8.0.0-rc.7";

package/dist/types/visibility-observer/index.d.ts

@@ -1,4 +1,7 @@
 type ComponentViewCallback = (node: HTMLElement) => void;
+export interface ObserverOptions {
+    threshold?: number;
+}
 /**
  * Observes visibility of elements matching a selector using MutationObserver and IntersectionObserver.
  */
@@ -16,9 +19,11 @@ export declare 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: string): void;
+    observe(selector: string, { threshold }: ObserverOptions): void;
     /**
      * @returns {HTMLElement[]} An array of elements that match the selector in the document.
      */

package/dist/types/wrapper/types/event.d.ts

@@ -1,5 +1,7 @@
 type NavigationType = 'navigation' | 'alternative' | 'refresh' | 'unknown';
-type PageType = 'Article' | 'Listing' | 'Frontpage' | 'SalesPoster' | 'Page' | 'LoginPoster';
+declare const LEGACY_PAGE_TYPE_VALUES: readonly ["Article", "Listing", "Frontpage", "SalesPoster", "Page", "LoginPoster"];
+export declare function isLegacyPageType(value: string): value is PageType;
+type PageType = (typeof LEGACY_PAGE_TYPE_VALUES)[number];
 type TargetCategory = 'Article' | 'Audio' | 'Video' | 'Weather' | 'Title' | 'other';
 type TargetType = 'Article' | 'ArticleReference' | 'ExternalContent';
 type SalesPosterType = 'Ip' | 'Login' | 'Paid' | 'Meter' | 'Personalised';

package/node_modules/@schibsted/tpaas-event-builder/dist/cjs/builders.js

@@ -41,6 +41,7 @@ exports.buildCompletedHealthActionEvent = buildCompletedHealthActionEvent;
 exports.buildEngagementHealthUIElementEvent = buildEngagementHealthUIElementEvent;
 exports.buildViewHealthPageEvent = buildViewHealthPageEvent;
 exports.buildImpressionHealthUIElementEvent = buildImpressionHealthUIElementEvent;
+exports.buildImpressionAdSlotEvent = buildImpressionAdSlotEvent;
 exports.buildImpressionFormEvent = buildImpressionFormEvent;
 exports.buildImpressionOfferEvent = buildImpressionOfferEvent;
 exports.buildImpressionPlayerEvent = buildImpressionPlayerEvent;
@@ -192,7 +193,7 @@ function buildLeaveVideoPageEvent(input, dependencies) {
 function buildLeaveWeatherEvent(input, dependencies) {
     const createdAt = new Date();
     const { autoTrackerVersion, isHybrid, version, providerId, user, experiments } = dependencies;
-    return (0, ts_deepmerge_1.merge)(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), (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)());
+    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), (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));
 }
 // #endregion
 // #region Engagement Event Builders
@@ -236,6 +237,9 @@ function buildImpressionHealthUIElementEvent(input, dependencies) {
 }
 // #endregion
 // #region Impression Event Builders
+function buildImpressionAdSlotEvent(input, dependencies) {
+    return (0, ts_deepmerge_1.merge)(normalizePageInput(input), tpaas_schemas_1.ImpressionAdSlot, (0, exports.getCommonBuildersOutput)(new Date(), dependencies), (0, experiments_1.builder)(dependencies.experiments, input.experiments));
+}
 function buildImpressionFormEvent(input, dependencies) {
     return (0, ts_deepmerge_1.merge)(normalizePageInput(input), tpaas_schemas_1.ImpressionForm, (0, exports.getCommonBuildersOutput)(new Date(), dependencies), (0, experiments_1.builder)(dependencies.experiments, input.experiments));
 }

package/node_modules/@schibsted/tpaas-event-builder/dist/cjs/guards.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPageType = isPageType;
+const tpaas_schemas_1 = require("@schibsted/tpaas-schemas");
+function isPageType(pageType) {
+    return tpaas_schemas_1.PAGE_TYPE_VALUES.some((val) => val === pageType);
+}

package/node_modules/@schibsted/tpaas-event-builder/dist/cjs/index.js

@@ -14,4 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPageType = void 0;
 __exportStar(require("./builders"), exports);
+var guards_1 = require("./guards");
+Object.defineProperty(exports, "isPageType", { enumerable: true, get: function () { return guards_1.isPageType; } });

package/node_modules/@schibsted/tpaas-event-builder/dist/ejs/builders.js

@@ -1,4 +1,4 @@
-import { AnonymousViewUIElement, CompletedHealthAction, EngagementAudio, EngagementForm, EngagementHealthUIElement, EngagementOffer, EngagementTeaser, EngagementUIElement, EngagementVideo, EngagementVideoAd, EngagementWidget, ImpressionForm, ImpressionHealthUIElement, ImpressionOffer, ImpressionPlayer, ImpressionTeaser, ImpressionUIElement, ImpressionWidget, LeaveArticle, LeaveAudioPage, LeaveError, LeaveFrontpage, LeaveLandingpage, LeaveListing, LeaveLockedArticle, LeaveLockedAudioPage, LeaveLockedVideoPage, LeavePage, LeaveSportsPage, LeaveVideoPage, LeaveWeather, ViewArticle, ViewAudioPage, ViewError, ViewFrontpage, ViewHealthPage, ViewLandingpage, ViewListing, ViewLockedArticle, ViewLockedAudioPage, ViewLockedVideoPage, ViewPage, ViewSportsPage, ViewTitle, ViewVideoPage, ViewWeather, } from '@schibsted/tpaas-schemas';
+import { AnonymousViewUIElement, CompletedHealthAction, EngagementAudio, EngagementForm, EngagementHealthUIElement, EngagementOffer, EngagementTeaser, EngagementUIElement, EngagementVideo, EngagementVideoAd, EngagementWidget, ImpressionAdSlot, ImpressionForm, ImpressionHealthUIElement, ImpressionOffer, ImpressionPlayer, ImpressionTeaser, ImpressionUIElement, ImpressionWidget, LeaveArticle, LeaveAudioPage, LeaveError, LeaveFrontpage, LeaveLandingpage, LeaveListing, LeaveLockedArticle, LeaveLockedAudioPage, LeaveLockedVideoPage, LeavePage, LeaveSportsPage, LeaveVideoPage, LeaveWeather, ViewArticle, ViewAudioPage, ViewError, ViewFrontpage, ViewHealthPage, ViewLandingpage, ViewListing, ViewLockedArticle, ViewLockedAudioPage, ViewLockedVideoPage, ViewPage, ViewSportsPage, ViewTitle, ViewVideoPage, ViewWeather, } from '@schibsted/tpaas-schemas';
 import { merge } from 'ts-deepmerge';
 import { builder as anonymousBuilder } from './builders/anonymous';
 import { builder as baseEventBuilder } from './builders/baseEvent';
@@ -142,7 +142,7 @@ export function buildLeaveVideoPageEvent(input, dependencies) {
 export function buildLeaveWeatherEvent(input, dependencies) {
     const createdAt = new Date();
     const { autoTrackerVersion, isHybrid, version, providerId, user, experiments } = dependencies;
-    return merge(input, LeaveWeather, timeBuilder(createdAt), trackerBuilder(autoTrackerVersion, isHybrid, version), baseEventBuilder(), providerBuilder(providerId), userBuilder(user), experimentsBuilder(experiments, input.experiments), consentsBuilder(dependencies.consents), deviceBuilder(dependencies.environmentId, dependencies.jwe), catalogVersionBuilder());
+    return merge(normalizePageInput(input), LeaveWeather, timeBuilder(createdAt), trackerBuilder(autoTrackerVersion, isHybrid, version), baseEventBuilder(), providerBuilder(providerId), userBuilder(user), experimentsBuilder(experiments, input.experiments), consentsBuilder(dependencies.consents), deviceBuilder(dependencies.environmentId, dependencies.jwe), catalogVersionBuilder(), navigationTypeBuilder(input.page?.navigationType), pageviewIdBuilder(dependencies.pageviewId), pageInfoBuilder(dependencies.currentPage));
 }
 // #endregion
 // #region Engagement Event Builders
@@ -186,6 +186,9 @@ export function buildImpressionHealthUIElementEvent(input, dependencies) {
 }
 // #endregion
 // #region Impression Event Builders
+export function buildImpressionAdSlotEvent(input, dependencies) {
+    return merge(normalizePageInput(input), ImpressionAdSlot, getCommonBuildersOutput(new Date(), dependencies), experimentsBuilder(dependencies.experiments, input.experiments));
+}
 export function buildImpressionFormEvent(input, dependencies) {
     return merge(normalizePageInput(input), ImpressionForm, getCommonBuildersOutput(new Date(), dependencies), experimentsBuilder(dependencies.experiments, input.experiments));
 }

package/node_modules/@schibsted/tpaas-event-builder/dist/ejs/guards.js

@@ -0,0 +1,4 @@
+import { PAGE_TYPE_VALUES } from '@schibsted/tpaas-schemas';
+export function isPageType(pageType) {
+    return PAGE_TYPE_VALUES.some((val) => val === pageType);
+}

package/node_modules/@schibsted/tpaas-event-builder/dist/ejs/index.js

@@ -1 +1,2 @@
 export * from './builders';
+export { isPageType } from './guards';