@schibsted/pulse-sdk 8.0.0-rc.2 → 8.0.0-rc.20

package/dist/types/Tracker.d.ts

@@ -1,16 +1,16 @@
-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 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 ILeaveLockedAudio, type ILeaveLockedAudioPage, type ILeaveLockedVideo, type ILeaveLockedVideoPage, type ILeavePage, type ILeaveSportsPage, type ILeaveVideoPage, type ILeaveWeather, type ITpaasEvent, type IViewArticle, type IViewAudio, type IViewAudioPage, type IViewError, type IViewFrontpage, type IViewHealthPage, type IViewLandingpage, type IViewListing, type IViewLockedArticle, type IViewLockedAudio, type IViewLockedAudioPage, type IViewLockedVideo, type IViewLockedVideoPage, type IViewPage, type IViewSportsPage, type IViewTitle, type IViewVideo, 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';
 import { anonymousEngagementEvent, anonymousTrackerEvent } from './builders/events-anonymous-node';
+import { type AdvertisingIdentifiers, type AdvertisingVendor } from './cis-sync';
 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 IAnonymousViewUIElement, type ICompletedHealthAction, type IEngagementAd, type IEngagementAffiliate, type IEngagementAudio, type IEngagementForm, type IEngagementHealthUIElement, type IEngagementOffer, type IEngagementSchoolUIElement, type IEngagementSportsUIElement, type IEngagementTeaser, type IEngagementTvModule, type IEngagementTvSearch, type IEngagementUIElement, type IEngagementVideo, type IEngagementVideoAd, type IEngagementWidget, type IHeartbeatCommercialArticle, type IImpressionAd, type IImpressionAdSlot, type IImpressionAffiliate, type IImpressionForm, type IImpressionHealthUIElement, type IImpressionOffer, type IImpressionPlayer, type IImpressionSchoolUIElement, type IImpressionSportsUIElement, 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 ILeaveLockedPage, type ILeaveLockedVideoPage, type ILeavePage, type ILeaveSchoolPage, type ILeaveSportsPage, type ILeaveVideoPage, type ILeaveWeather, type ILoadAd, type InputParams, type IProvider, type IRequestAd, type ITpaasEvent, type IViewArticle, type IViewAudioPage, type IViewError, type IViewFrontpage, type IViewHealthPage, type IViewLandingpage, type IViewListing, type IViewLockedArticle, type IViewLockedAudioPage, type IViewLockedPage, type IViewLockedVideoPage, type IViewPage, type IViewSchoolPage, type IViewSportsPage, type IViewTitle, type IViewVideoPage, type IViewWeather } from './tpaas-schemas';
+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';
@@ -74,6 +74,43 @@ export type DeployStage = 'dev' | 'pre' | 'pro';
  * **Note** that the `username` and `password` is *for Node.js environments only*.
  */
 export interface SDKConfigInput {
+    /**
+     * AdChoices: dictates which advertising identifiers are issued, in relation to advertising consents given by the user.
+     * When `true` and `requireAdvertisingOptIn` is `true`, if the user has not given consent to advertising purpose,
+     * neither `adId` nor `ppId` are issued.
+     * @see requireAdvertisingOptIn
+     */
+    adChoicesEnabled?: boolean;
+    /**
+     * The component name to include in tracked events.
+     * Automatically populated as `.provider.component` for both TPaaS and legacy events.
+     */
+    component?: IProvider['component'];
+    /**
+     * The component version to include in tracked events.
+     * Automatically populated as `.provider.componentVersion` for both TPaaS and legacy events.
+     */
+    componentVersion?: IProvider['componentVersion'];
+    /**
+     * The provider deployment stage to include in tracked events.
+     * Automatically populated as `.provider.stage` for TPaaS events.
+     */
+    stage: IProvider['stage'];
+    /**
+     * The product name to include in tracked events.
+     * Automatically populated as `.provider.product` for TPaaS events.
+     */
+    product: NonNullable<IProvider['product']>;
+    /**
+     * The product version to include in tracked events.
+     * Automatically populated as `.provider.version` for TPaaS events.
+     */
+    version: NonNullable<IProvider['version']>;
+    /**
+     * Provider metadata to include in TPaaS events.
+     * Automatically populated as `.provider.name` and `.provider.group`.
+     */
+    provider?: Pick<IProvider, 'name' | 'group'>;
     /**
      * Function handler to call in place of the built-in tracker call.
      * @function
@@ -97,9 +134,24 @@ export interface SDKConfigInput {
      */
     nativeJwe?: string;
     password?: string;
+    /**
+     * When true, user's consents are (waited and) evaluated in order to instruct the apis to restrict the issuing of
+     * advertising identifiers;
+     * It has direct effect on the issuing of `adId`.
+     * In connection with `adChoicesEnabled` option, restricts the issuing of `ppId` as well.
+     * @see adChoicesEnabled
+     */
     requireAdvertisingOptIn?: boolean;
     trackerId?: string;
+    /**
+     * @deprecated Starting with 8.0.0-rc.13, the SDK will default this config to true instead of undefined (basically false).
+     * In v9, this config will be removed and the SDK will always use Beacon when available.
+     */
     useBeacon?: boolean;
+    /**
+     * @deprecated Starting with 8.0.0-rc.13, the SDK will default this config to true instead of undefined (basically false).
+     * In v9, this config will be removed and the SDK will always use Beacon when available.
+     */
     useBeaconWhenAvailable?: boolean;
     username?: string;
     vendors?: AdvertisingVendor[];
@@ -116,37 +168,18 @@ export interface SDKConfigInput {
  * @internal
  */
 export type SDKState = {
-    altEventHandler?: AltEventHandler;
-    autoCreateConsents?: boolean;
-    cisBaseUrl?: string;
-    cisEnabled?: boolean;
-    collectorBaseUrl?: string;
     collectorPath: string;
-    configurationTag?: string;
-    consents?: Consents | ConsentsInput | Promise<Consents>;
     deployStage: DeployStage;
     deployStageTpaas: DeployStage;
     environment: 'node' | 'browser';
-    eventDebounce?: number;
     includeAdvertising: boolean | Promise<boolean>;
-    isHybrid?: boolean;
-    nativeJwe?: string;
     pageViewId: string;
-    password?: string;
     providerId: string;
     remoteConfigurationUrl: string;
-    requireAdvertisingOptIn?: boolean;
     schemaLocation: string;
-    trackerId?: string;
+    trackerId: string;
     tpaasCollectorBaseUrl: string;
-    useBeacon?: boolean;
-    useBeaconWhenAvailable?: boolean;
-    username?: string;
     vendors: AdvertisingVendor[];
-    /**
-     * @deprecated Xandr sync and AnId functionality no longer supported.
-     */
-    xandrEnabled?: boolean;
 } & SDKConfigInput & FallbackSDKConfig;
 /**
  * Input for event builders. Different events will read and process different
@@ -278,8 +311,14 @@ export default class Tracker {
     private bookmark;
     private legacyVisibilityObservers;
     private visibilityObservers;
-    private legacyCurrentPage;
-    private currentPage;
+    /**
+     * Current page state shared by legacy and TPaaS tracking. See CurrentPageContext for
+     * which properties are shared and which are exclusively TPaaS metadata.
+     */
+    private currentPageContext;
+    private getCurrentTpaasPage;
+    private getCurrentLegacyPage;
+    private setCurrentTpaasPageData;
     /**
      * Promise that resolves when a session ID becomes available
      * @private
@@ -303,7 +342,7 @@ export default class Tracker {
      * @param config Options to set the SDK with
      * @param builders Initial values for event properties that will be persisted across events
      */
-    constructor(providerId: string, config?: SDKConfigInput, builders?: Builders);
+    constructor(providerId: string, config: SDKConfigInput, builders?: Builders);
     /**
      * Add event to the tracker event queue
      *
@@ -381,24 +420,10 @@ export default class Tracker {
      */
     private prepareAnonymousTpaasEvent;
     /**
-     *
      * @private
      * @category TPaaS Tracking
      */
     private prepareTpaasEvent;
-    /**
-     * Generate a generic TPaaS event with common builders output
-     * The method should be used for experiments, not for real production work.
-     * It doesn't have any real TPaaS schema associated with it.
-     * The method doesn't queue or send the event, it just returns the merged object.
-     * The method can be removed at any time in the future, so use it with caution.
-     *
-     * @param input - The input object to merge with the common builders output
-     * @returns A promise that resolves to the merged object
-     * @private
-     * @category TPaaS Tracking
-     */
-    generateGenericTpaasEvent<T>(input: T): Promise<T & ReturnType<typeof getCommonBuildersOutput>>;
     /**
      * This method extends the list of base experiments that will be automatically included in every event sent by the tracker.
      *
@@ -466,6 +491,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.
@@ -551,23 +598,28 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackAnonymousViewUIElement(input: InputParams<IAnonymousViewUIElement>): Promise<unknown>;
-    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
+     * @param options
+     * @category TPaaS Tracking
+     */
+    trackViewSchoolPage(input: InputParams<IViewSchoolPage>, options: TrackViewEventOptions<IViewSchoolPage>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -582,19 +634,18 @@ export default class Tracker {
      * @param input
      * @category TPaaS Tracking
      */
-    trackImpressionAdSlot(input: InputParams<IImpressionAdSlot>): Promise<unknown>;
+    trackLoadAd(input: InputParams<ILoadAd>): Promise<unknown>;
     /**
      * @param input
-     * @param options
      * @category TPaaS Tracking
      */
-    trackViewArticle(input: InputParams<IViewArticle>, options: TrackViewEventOptions): Promise<unknown>;
+    trackRequestAd(input: InputParams<IRequestAd>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewAudio(input: InputParams<IViewAudio>): 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.
@@ -635,13 +686,28 @@ 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
+     */
+    trackImpressionAd(input: InputParams<IImpressionAd>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackImpressionAdSlot(input: InputParams<IImpressionAdSlot>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackImpressionAffiliate(input: InputParams<IImpressionAffiliate>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -661,64 +727,64 @@ export default class Tracker {
      * @param input
      * @category TPaaS Tracking
      */
-    trackImpressionTeaser(input: InputParams<IImpressionTeaser>): Promise<unknown>;
+    trackImpressionSportsUIElement(input: InputParams<IImpressionSportsUIElement>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
      */
-    trackImpressionUIElement(input: InputParams<IImpressionUIElement>): Promise<unknown>;
+    trackImpressionSchoolUIElement(input: InputParams<IImpressionSchoolUIElement>): Promise<unknown>;
     /**
      * @param input
-     * @param options
      * @category TPaaS Tracking
      */
-    trackViewFrontpage(input: InputParams<IViewFrontpage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackImpressionTeaser(input: InputParams<IImpressionTeaser>): Promise<unknown>;
     /**
      * @param input
-     * @param options
      * @category TPaaS Tracking
      */
-    trackViewLandingpage(input: InputParams<IViewLandingpage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackImpressionUIElement(input: InputParams<IImpressionUIElement>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewListing(input: InputParams<IViewListing>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewFrontpage(input: InputParams<IViewFrontpage>, options: TrackViewEventOptions<IViewFrontpage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedArticle(input: InputParams<IViewLockedArticle>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewLandingpage(input: InputParams<IViewLandingpage>, options: TrackViewEventOptions<IViewLandingpage>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedAudio(input: InputParams<IViewLockedAudio>): Promise<unknown>;
+    trackViewListing(input: InputParams<IViewListing>, options: TrackViewEventOptions<IViewListing>): Promise<unknown>;
     /**
      * @param input
      * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedAudioPage(input: InputParams<IViewLockedAudioPage>, options: TrackViewEventOptions): Promise<unknown>;
+    trackViewLockedArticle(input: InputParams<IViewLockedArticle>, options: TrackViewEventOptions<IViewLockedArticle>): Promise<unknown>;
     /**
      * @param input
+     * @param options
      * @category TPaaS Tracking
      */
-    trackViewLockedVideo(input: InputParams<IViewLockedVideo>): 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>;
+    trackViewLockedPage(input: InputParams<IViewLockedPage>, options: TrackViewEventOptions<IViewLockedPage>): Promise<unknown>;
     /**
      * @param input
+     * @param options
      * @category TPaaS Tracking
      */
-    trackViewVideo(input: InputParams<IViewVideo>): 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.
@@ -761,13 +827,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
@@ -803,11 +869,6 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackLeaveLockedArticle(input: InputParams<ILeaveLockedArticle>): Promise<unknown>;
-    /**
-     * @param input
-     * @category TPaaS Tracking
-     */
-    trackLeaveLockedAudio(input: InputParams<ILeaveLockedAudio>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -817,7 +878,7 @@ export default class Tracker {
      * @param input
      * @category TPaaS Tracking
      */
-    trackLeaveLockedVideo(input: InputParams<ILeaveLockedVideo>): Promise<unknown>;
+    trackLeaveLockedPage(input: InputParams<ILeaveLockedPage>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -833,6 +894,11 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackLeaveSportsPage(input: InputParams<ILeaveSportsPage>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackLeaveSchoolPage(input: InputParams<ILeaveSchoolPage>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -843,6 +909,16 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackLeaveWeather(input: InputParams<ILeaveWeather>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackEngagementAd(input: InputParams<IEngagementAd>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackEngagementAffiliate(input: InputParams<IEngagementAffiliate>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -858,11 +934,31 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackEngagementOffer(input: InputParams<IEngagementOffer>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackEngagementSportsUIElement(input: InputParams<IEngagementSportsUIElement>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackEngagementSchoolUIElement(input: InputParams<IEngagementSchoolUIElement>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
      */
     trackEngagementTeaser(input: InputParams<IEngagementTeaser>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackEngagementTvModule(input: InputParams<IEngagementTvModule>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackEngagementTvSearch(input: InputParams<IEngagementTvSearch>): Promise<unknown>;
     /**
      * @param input
      * @category TPaaS Tracking
@@ -883,6 +979,11 @@ export default class Tracker {
      * @category TPaaS Tracking
      */
     trackEngagementWidget(input: InputParams<IEngagementWidget>): Promise<unknown>;
+    /**
+     * @param input
+     * @category TPaaS Tracking
+     */
+    trackHeartbeatCommercialArticle(input: InputParams<IHeartbeatCommercialArticle>): Promise<unknown>;
     /**
      * this is the method that actually sends the event to the server
      * @private
@@ -1074,11 +1175,11 @@ export default class Tracker {
      * @internal
      * @category Configuration
      */
-    syncRemoteResources(input?: unknown, builders?: Builders): Promise<{
+    syncRemoteResources(input?: Partial<Builders>, builders?: Builders): Promise<{
         adId?: string;
         doTracking: boolean;
         environmentId?: string;
-        ppId?: import("@schibsted/pulse-cis-sync").PPIDsByVendor;
+        ppId?: import("./cis-sync").PPIDsByVendor;
     }>;
     /**
      * @internal
@@ -1286,7 +1387,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)
      * ```
@@ -1308,7 +1409,7 @@ export default class Tracker {
     /**
      * @private
      */
-    private resolveTrackGlobals;
+    private resolveAnonymousTrackGlobals;
     /**
      * Send all anonymous events that are in the internal anonymous event queue.
      *

package/dist/types/builders/actor.d.ts

@@ -1,3 +1,4 @@
+import type { Builders } from '../Tracker';
 import type { TrackerEventInput } from './events';
 /**
  * generateActorSDRN
@@ -24,11 +25,11 @@ export type Actor = {
     'spt:userId': string;
 };
 /**
- * Type guard to check if the input is an ActorInput
+ * Type guard to check if the input has an Actor Builder
  * @param input
  * @internal
  */
-export declare function isActorInput(input: unknown): input is ActorInput;
+export declare function hasActorBuilder(input: unknown): input is Pick<Builders, 'actor'>;
 /**
  * Function to generate a builder for Actor objects.
  */

package/dist/types/builders/consents.d.ts

@@ -1,6 +1,6 @@
 import type { TrackerEventInput } from './events';
 /**
- * @enum ConsentCategory
+ * @enum ConsentsCategory
  */
 export declare enum ConsentsCategory {
     CMP_ANALYTICS = "CMP_ANALYTICS",
@@ -8,9 +8,9 @@ export declare enum ConsentsCategory {
     CMP_ADVERTISING = "CMP_ADVERTISING",
     CMP_PERSONALIZATION = "CMP_PERSONALIZATION"
 }
-export declare const ConsentsSourceValues: readonly ["default", "cmp", "cache"];
+export declare const ConsentsSourceValues: readonly ['default', 'cmp', 'cache', 'url'];
 export type ConsentsSource = (typeof ConsentsSourceValues)[number];
-export declare const ConsentsPurposeCategoryStatusValues: readonly ["accepted", "rejected", "unknown"];
+export declare const ConsentsPurposeCategoryStatusValues: readonly ['accepted', 'rejected', 'unknown'];
 export type ConsentsPurposeCategoryStatus = (typeof ConsentsPurposeCategoryStatusValues)[number];
 export interface ConsentsBase {
     source?: ConsentsSource;

package/dist/types/builders/device-node.d.ts

@@ -53,7 +53,7 @@ export type Device = {
  *
  * @internal
  */
-export declare const device: (defaultValueHandler: () => unknown) => (input?: Pick<TrackerEventInput, "device">) => Device | undefined;
+export declare const device: (defaultValueHandler: () => unknown) => (input?: Pick<TrackerEventInput, 'device'>) => Device | undefined;
 /**
  * @internal
  */
@@ -61,5 +61,5 @@ export declare const defaultValue: () => {};
 /**
  * Builder for Device objects.
  */
-declare const _default: (input?: Pick<TrackerEventInput, "device">) => Device | undefined;
+declare const _default: (input?: Pick<TrackerEventInput, 'device'>) => Device | undefined;
 export default _default;

package/dist/types/builders/events-anonymous-node.d.ts

@@ -38,8 +38,8 @@ export declare function anonymousTrackerEvent({ eventInput, sdkConfig }?: EventP
     experimentMetadata: ExperimentMetadata | undefined;
     object: Record<string, unknown> | undefined;
     origin: {
-        '@type'?: string | undefined;
         '@id'?: string | number | undefined;
+        '@type'?: string | undefined;
     } & {
         [k: string]: unknown;
         url?: string;
@@ -50,7 +50,7 @@ export declare function anonymousTrackerEvent({ eventInput, sdkConfig }?: EventP
     isAnonymous: boolean;
 };
 export declare namespace anonymousTrackerEvent {
-    var defaults: typeof trackerAnonymousEventInput;
+    export { trackerAnonymousEventInput as defaults };
 }
 export declare function anonymousEngagementEvent({ eventInput, sdkConfig }?: EventParams<AnonymousTrackerEventInput>): {
     [k: string]: any;
@@ -62,8 +62,8 @@ export declare function anonymousEngagementEvent({ eventInput, sdkConfig }?: Eve
     experimentMetadata: ExperimentMetadata | undefined;
     object: Record<string, unknown> | undefined;
     origin: {
-        '@type'?: string | undefined;
         '@id'?: string | number | undefined;
+        '@type'?: string | undefined;
     } & {
         [k: string]: unknown;
         url?: string;
@@ -77,6 +77,6 @@ export declare function anonymousEngagementEvent({ eventInput, sdkConfig }?: Eve
     '@type': string;
 };
 export declare namespace anonymousEngagementEvent {
-    var defaults: typeof trackerAnonymousEventInput;
+    export { trackerAnonymousEventInput as defaults };
 }
 export {};

package/dist/types/builders/events-node.d.ts

@@ -57,7 +57,7 @@ export declare function routableEvent({ eventInput, sdkConfig }?: EventParams<Ro
     actor: import("./actor").Actor | undefined;
 };
 export declare namespace routableEvent {
-    var defaults: typeof routableEventDefaults;
+    export { routableEventDefaults as defaults };
 }
 /**
  * Add default value to TrackerEventInput.
@@ -80,8 +80,8 @@ export declare function trackerEvent({ eventInput, sdkConfig }?: EventParams<Tra
     location: import("./location").Location | undefined;
     object: Record<string, unknown> | undefined;
     origin: {
-        '@type'?: string | undefined;
         '@id'?: string | number | undefined;
+        '@type'?: string | undefined;
     } & {
         [k: string]: unknown;
         url?: string;
@@ -91,7 +91,7 @@ export declare function trackerEvent({ eventInput, sdkConfig }?: EventParams<Tra
     tracker: import("./tracker-node").Tracker;
 };
 export declare namespace trackerEvent {
-    var defaults: typeof trackerEventInput;
+    export { trackerEventInput as defaults };
 }
 export declare function engagementEvent({ eventInput, sdkConfig }?: EventParams<TrackerEventInput>): {
     [k: string]: any;
@@ -107,8 +107,8 @@ export declare function engagementEvent({ eventInput, sdkConfig }?: EventParams<
     location: import("./location").Location | undefined;
     object: Record<string, unknown> | undefined;
     origin: {
-        '@type'?: string | undefined;
         '@id'?: string | number | undefined;
+        '@type'?: string | undefined;
     } & {
         [k: string]: unknown;
         url?: string;
@@ -121,7 +121,7 @@ export declare function engagementEvent({ eventInput, sdkConfig }?: EventParams<
     '@type': string;
 };
 export declare namespace engagementEvent {
-    var defaults: typeof trackerEventInput;
+    export { trackerEventInput as defaults };
 }
 export declare function identityEvent({ eventInput }?: EventParams<IdentityEventInput>): IdentityEventInput;
 export declare namespace identityEvent {

package/dist/types/builders/experiments.d.ts

@@ -1,4 +1,5 @@
 import type { TrackerEventInput } from './events';
+export declare function generateExperimentSDRN(id?: string | number, experimentationPlatform?: string): string;
 /**
  * The necessary values to construct a valid "sdrn" for experiment.
  * Additional properties are allowed.

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

@@ -1,6 +1,6 @@
 export type { ActorInput } from './actor';
 export * as actor from './actor';
-export type { ConsentCategory, ConsentedToPurposeInput, ConsentPurposeCategory, Consents, ConsentsInput, ConsentsOutput, } from './consents';
+export type { ConsentCategory, ConsentedToPurposeInput, ConsentPurposeCategory, Consents, ConsentsCategory, ConsentsInput, ConsentsOutput, ConsentsPurposeCategory, } from './consents';
 export * as consents from './consents';
 export type { DeviceInput } from './device';
 export * as device from './device';