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

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

@@ -18,6 +18,7 @@ export const TPAAS_ALLOWED_METHODS = [
     'trackEngagementVideoAd',
     'trackEngagementWidget',
     'trackCompletedHealthAction',
+    'trackImpressionAdSlot',
     'trackImpressionForm',
     'trackImpressionHealthUIElement',
     'trackImpressionOffer',
@@ -35,6 +36,7 @@ export const TPAAS_ALLOWED_METHODS = [
     'trackLeaveLockedAudioPage',
     'trackLeaveLockedVideoPage',
     'trackLeavePage',
+    'trackLeaveSportsPage',
     'trackLeaveVideoPage',
     'trackLeaveWeather',
     'trackViewArticle',
@@ -48,6 +50,7 @@ export const TPAAS_ALLOWED_METHODS = [
     'trackViewLockedAudioPage',
     'trackViewLockedVideoPage',
     'trackViewPage',
+    'trackViewSportsPage',
     'trackViewTitle',
     'trackViewVideoPage',
     'trackViewWeather',

package/dist/ejs/version.js

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

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

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';
@@ -8,9 +8,10 @@ import { anonymousEngagementEvent, anonymousTrackerEvent } from './builders/even
 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, TrackViewAudioPageOptions, TrackViewEventOptions, TrackViewVideoPageOptions } from './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
@@ -376,7 +385,6 @@ export default class Tracker {
      */
     private prepareAnonymousTpaasEvent;
     /**
-     *
      * @private
      * @category TPaaS Tracking
      */
@@ -461,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.
@@ -549,20 +579,20 @@ export default class Tracker {
     private setCurrentPage;
     trackCompletedHealthAction(input: InputParams<ICompletedHealthAction>): Promise<unknown>;
     trackEngagementHealthUIElement(input: InputParams<IEngagementHealthUIElement>): Promise<unknown>;
-    trackViewHealthPage(input: InputParams<IViewHealthPage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewHealthPage(input: InputParams<IViewHealthPage>, options: TrackViewEventOptions<IViewHealthPage>): Promise<unknown>;
     trackImpressionHealthUIElement(input: InputParams<IImpressionHealthUIElement>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewPage(input: InputParams<IViewPage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewPage(input: InputParams<IViewPage>, options: TrackViewEventOptions<IViewPage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewSportsPage(input: InputParams<IViewSportsPage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewSportsPage(input: InputParams<IViewSportsPage>, options: TrackViewEventOptions<IViewSportsPage>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -578,7 +608,7 @@ export default class Tracker {
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewArticle(input: InputParams<IViewArticle>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewArticle(input: InputParams<IViewArticle>, options: TrackViewEventOptions<IViewArticle>): Promise<unknown>;
     /**
      * Tracks a View AudioPage event and automatically fires a Leave AudioPage event when the user
      * navigates away.
@@ -619,13 +649,18 @@ export default class Tracker {
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewAudioPage(input: InputParams<IViewAudioPage>, options: TrackViewAudioPageOptions): Promise<unknown>;
+    trackViewAudioPage(input: InputParams<IViewAudioPage>, options: TrackViewEventOptions<IViewAudioPage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewError(input: InputParams<IViewError>, options: TrackViewEventOptions): Promise<unknown>;
+    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
@@ -656,37 +691,37 @@ export default class Tracker {
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewFrontpage(input: InputParams<IViewFrontpage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewFrontpage(input: InputParams<IViewFrontpage>, options: TrackViewEventOptions<IViewFrontpage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLandingpage(input: InputParams<IViewLandingpage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewLandingpage(input: InputParams<IViewLandingpage>, options: TrackViewEventOptions<IViewLandingpage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewListing(input: InputParams<IViewListing>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewListing(input: InputParams<IViewListing>, options: TrackViewEventOptions<IViewListing>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedArticle(input: InputParams<IViewLockedArticle>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewLockedArticle(input: InputParams<IViewLockedArticle>, options: TrackViewEventOptions<IViewLockedArticle>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedAudioPage(input: InputParams<IViewLockedAudioPage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewLockedAudioPage(input: InputParams<IViewLockedAudioPage>, options: TrackViewEventOptions<IViewLockedAudioPage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedVideoPage(input: InputParams<IViewLockedVideoPage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewLockedVideoPage(input: InputParams<IViewLockedVideoPage>, options: TrackViewEventOptions<IViewLockedVideoPage>): Promise<unknown>;
     /**
      * Tracks a View VideoPage event and automatically fires a Leave VideoPage event when the user
      * navigates away.
@@ -729,13 +764,13 @@ export default class Tracker {
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewVideoPage(input: InputParams<IViewVideoPage>, options: TrackViewVideoPageOptions): Promise<unknown>;
+    trackViewVideoPage(input: InputParams<IViewVideoPage>, options: TrackViewEventOptions<IViewVideoPage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewWeather(input: InputParams<IViewWeather>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewWeather(input: InputParams<IViewWeather>, options: TrackViewEventOptions<IViewWeather>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -1244,7 +1279,7 @@ export default class Tracker {
      * with the added guarantee that a second Leave event will not be triggered if one already has been sent.
      * @category TPaaS Leave Tracking
      */
-    trackTpaasActiveLeave(): void;
+    trackTpaasActiveLeave(): Promise<void>;
     /**
      * Check if leave tracking is enabled (if an event will be sent when the user leaves the page)
      * ```

package/dist/types/index.d.ts

@@ -15,7 +15,7 @@ export { subscribe, subscribeOnce, subscribeWithState, unsubscribe } from './Tra
 /**
  * TPaaS specific type exports
  */
-export type { AudioPageLeaveTrackingOptions, LeaveAudioInput, LeaveStoriesInput, LeaveTrackingDisabled, LeaveTrackingOptions, TrackViewAudioPageOptions, TrackViewEventOptions, TrackViewVideoPageOptions, VideoPageLeaveTrackingOptions, } from './types';
+export type { LeaveAudioInput, LeaveStoriesInput, LeaveTrackingDisabled, LeaveTrackingOptions, TrackViewEventOptions, TrackViewEventOptionsForProxy, } from './types';
 /**
  * Media Wrapper Types exports below
  */

package/dist/types/leaveTrackingTpaas/constants.d.ts

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

package/dist/types/leaveTrackingTpaas/index.d.ts

@@ -1,7 +1,7 @@
-import type { ILeave } from '@schibsted/tpaas-schemas';
-import type { LeaveTrackingOptions, TrackViewEventOptions } from '../types';
+import type { ILeave, ITpaasEvent } from '@schibsted/tpaas-schemas';
+import type { LeaveTrackingOptions, LeaveTrackingOptionsForProxy, TrackViewEventOptions } from '../types';
 import type { LeaveObjectTypes, Listener, TrackMethod } from './types';
-export declare function addTpaasLeaveTracking({ objectElement, pageElement, schema, objectResizable, heightBuilder, trackMethod, }: LeaveTrackingOptions & {
+export declare function addTpaasLeaveTracking({ objectElement, pageElement, schema, objectResizable, heightBuilder, trackMethod, }: (LeaveTrackingOptions | LeaveTrackingOptionsForProxy) & {
     schema: LeaveObjectTypes;
     trackMethod: TrackMethod;
 }): void;
@@ -15,8 +15,8 @@ export declare function removeTpaasLeaveTracking(): void;
  */
 export declare function updateTpaasLeaveTracking(objectElement: Element, pageElement: Element, resetProperties: boolean): void;
 export declare const resetTpaasViewedContent: () => void;
-export declare function trackTpaasActiveLeave(): void;
-export declare function trackTpaasLeave(): void;
+export declare function trackTpaasActiveLeave(): Promise<void>;
+export declare function trackTpaasLeave(): Promise<void>;
 export declare function getTpaasLeaveObject(): ILeave;
 export declare function updateTpaasViewedContent(objectElement: Element, pageElement: Element): void;
 export declare const calculateScrolledPixels: (element: Element) => number;
@@ -25,4 +25,4 @@ export declare function addEventListeners(events: string[], handler: () => void,
 export declare function removeEventListeners(eventListeners: Listener[], options?: {
     capture?: boolean;
 }): Listener[];
-export declare function shouldEnableLeaveTracking(leaveOptions: TrackViewEventOptions['leaveTracking']): leaveOptions is LeaveTrackingOptions;
+export declare function shouldEnableLeaveTracking(leaveOptions: TrackViewEventOptions<ITpaasEvent>['leaveTracking']): leaveOptions is LeaveTrackingOptions | LeaveTrackingOptionsForProxy;

package/dist/types/leaveTrackingTpaas/types.d.ts

@@ -15,14 +15,6 @@ export declare enum BrowserEvents {
     TOUCHSTART = "touchstart"
 }
 export type Listener = [name: string, listener: () => void];
-/**
- * @typedef ActivityDuration
- */
-export type ActivityDuration = {
-    value: number;
-    interval: number | undefined;
-    timeSinceLastActivity: number;
-};
 /**
  * Used to provide extra height to view %-calculations for objects that have fake-scrolls or similar
  * For instance if you have an element that captures scroll for about 1000px
@@ -39,7 +31,7 @@ export interface AdditionalHeightInfo {
      */
     viewedHeight: number;
 }
-export type TrackMethod = (leave: ILeave) => void;
+export type TrackMethod = (leave: ILeave) => Promise<void>;
 export type LeaveObjectTypes = Extract<ITpaasEvent, {
     eventType: 'Leave';
 }>['object']['objectType'];

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", "trackLeaveVideoPage", "trackLeaveWeather", "trackViewArticle", "trackViewAudioPage", "trackViewError", "trackViewFrontpage", "trackViewHealthPage", "trackViewLandingpage", "trackViewListing", "trackViewLockedArticle", "trackViewLockedAudioPage", "trackViewLockedVideoPage", "trackViewPage", "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/types.d.ts

@@ -1,4 +1,4 @@
-import type { ILeaveAudio, ILeaveStories } from '@schibsted/tpaas-schemas';
+import type { ILeaveAudio, ILeaveStories, ITpaasEvent, IViewAudioPage, IViewVideoPage } from '@schibsted/tpaas-schemas';
 import type { v4 } from 'uuid';
 import type { Session } from './builders';
 import type { AnonymousTrackerEventInput } from './builders/events-anonymous-node';
@@ -53,41 +53,47 @@ export type LeaveAudioInput = Omit<ILeaveAudio, 'activityDurationMs' | 'duration
  * metrics when the Leave VideoPage event fires.
  */
 export type LeaveStoriesInput = Omit<ILeaveStories, 'activityDurationMs' | 'durationMs'>;
-export type TrackViewEventOptions = {
-    leaveTracking: LeaveTrackingOptions | LeaveTrackingDisabled;
+export type TrackViewEventOptions<T extends ITpaasEvent> = {
+    leaveTracking: LeaveTrackingDisabled | LeaveTrackingOptionsForProxy | (T extends IViewAudioPage ? AudioPageLeaveTrackingOptions : T extends IViewVideoPage ? VideoPageLeaveTrackingOptions : LeaveTrackingOptions);
+};
+export type TrackViewEventOptionsForProxy = {
+    leaveTracking: LeaveTrackingDisabled | LeaveTrackingOptionsForProxy;
 };
 export type LeaveTrackingOptions = {
-    objectElement: HTMLElement;
-    pageElement?: HTMLElement;
+    objectElement: Element;
+    pageElement?: Element;
     objectResizable?: boolean;
     heightBuilder?: () => AdditionalHeightInfo;
 };
+export type LeaveTrackingOptionsForProxy = {
+    objectElement: string;
+    pageElement?: string;
+    objectResizable?: boolean;
+    heightBuilder?: never;
+    leaveAudioBuilder?: never;
+    leaveStoriesBuilder?: never;
+};
 export type LeaveTrackingDisabled = false;
 /**
  * Leave tracking options for {@link Tracker.trackViewAudioPage}.
  * Extends {@link LeaveTrackingOptions} with an optional builder for audio engagement statistics.
  */
-export type AudioPageLeaveTrackingOptions = LeaveTrackingOptions & {
+type AudioPageLeaveTrackingOptions = LeaveTrackingOptions & {
     /**
      * Called at leave time to provide audio engagement statistics for the Leave AudioPage event.
      * If not provided, all audio engagement fields default to `0`.
      */
     leaveAudioBuilder?: () => LeaveAudioInput;
 };
-export type TrackViewAudioPageOptions = {
-    leaveTracking: AudioPageLeaveTrackingOptions | LeaveTrackingDisabled;
-};
 /**
  * Leave tracking options for {@link Tracker.trackViewVideoPage}.
  * Extends {@link LeaveTrackingOptions} with an optional builder for story carousel statistics.
  */
-export type VideoPageLeaveTrackingOptions = LeaveTrackingOptions & {
+type VideoPageLeaveTrackingOptions = LeaveTrackingOptions & {
     /**
      * Called at leave time to provide story carousel statistics for the Leave VideoPage event.
      * If not provided, `leaveStories` will be omitted from the Leave VideoPage event.
      */
     leaveStoriesBuilder?: () => LeaveStoriesInput;
 };
-export type TrackViewVideoPageOptions = {
-    leaveTracking: VideoPageLeaveTrackingOptions | LeaveTrackingDisabled;
-};
+export {};

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "8.0.0-rc.5";
+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';