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

package/dist/types/Tracker.d.ts

@@ -8,7 +8,7 @@ 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 { ClickUIElementInputProperties } from './wrapper/engagement/ui-element/types';
 import type { BaseEventExperiment } from './wrapper/types';
 import type { ViewArticleInputProperties } from './wrapper/view/article/types';
@@ -376,7 +376,6 @@ export default class Tracker {
      */
     private prepareAnonymousTpaasEvent;
     /**
-     *
      * @private
      * @category TPaaS Tracking
      */
@@ -549,20 +548,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 +577,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 +618,13 @@ 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
@@ -656,37 +655,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 +728,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 +1243,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", "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.6";

package/node_modules/@schibsted/pulse-utils/package.json

@@ -30,7 +30,7 @@
   "devDependencies": {
     "@types/lodash": "4.17.24",
     "@types/node": "24.10.13",
-    "lodash": "4.17.23",
+    "lodash": "4.18.1",
     "typescript": "5.9.3"
   }
 }

package/node_modules/@schibsted/tpaas-event-builder/dist/index.d.ts

@@ -4941,7 +4941,7 @@ type DeepOmit<T, K extends string> = T extends readonly unknown[] ? T : T extend
 } extends infer Result ? {
 	[P in keyof Result as Result[P] extends Record<string, never> ? never : P]: Result[P];
 } : never : T;
-type OptionalNavigationType<T extends ITpaasEvent> = T extends {
+type OptionalNavigationType<T> = T extends {
 	page: {
 		navigationType: infer N;
 	};
@@ -4949,6 +4949,14 @@ type OptionalNavigationType<T extends ITpaasEvent> = T extends {
 	page: Omit<T["page"], "navigationType"> & {
 		navigationType?: N;
 	};
+} : T extends {
+	page?: {
+		navigationType: infer N;
+	};
+} ? Omit<T, "page"> & {
+	page?: Omit<NonNullable<T["page"]>, "navigationType"> & {
+		navigationType?: N;
+	};
 } : T;
 /**
  * InputParams is a utility type that omits certain properties from a given type T.
@@ -4957,7 +4965,7 @@ type OptionalNavigationType<T extends ITpaasEvent> = T extends {
  *
  * @privateRemarks
  */
-export type InputParams<T extends ITpaasEvent> = DeepOmit<WithOptionalPage<OptionalNavigationType<T>>, OmittedProperties>;
+export type InputParams<T extends ITpaasEvent> = DeepOmit<OptionalNavigationType<WithOptionalPage<T>>, OmittedProperties>;
 type WithOptionalPage<T> = T extends TpaasOptionalPageSchemas ? Omit<T, "page"> & {
 	page?: T["page"];
 } : T;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@schibsted/pulse-sdk",
-  "version": "8.0.0-rc.5",
+  "version": "8.0.0-rc.6",
   "description": "Node.js / Browser Pulse SDK",
   "author": "Schibsted Data&Tech",
   "license": "UNLICENSED",
@@ -42,10 +42,10 @@
     "ts-deepmerge": "7.0.3",
     "ua-parser-js": "2.0.9",
     "uuid": "13.0.0",
+    "@schibsted/tpaas-event-builder": "1.0.0",
     "@schibsted/pulse-cis-sync": "2.0.18",
     "@schibsted/pulse-utils": "1.0.2",
-    "@schibsted/tpaas-schemas": "1.0.0",
-    "@schibsted/tpaas-event-builder": "1.0.0"
+    "@schibsted/tpaas-schemas": "1.0.0"
   },
   "devDependencies": {
     "@testing-library/dom": "10.4.1",