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

package/dist/types/tpaas-builders/builders.d.ts

@@ -0,0 +1,141 @@
+import type { TpaasAnonymousEventContext, TpaasEventContext } from '../tpaas-context/types';
+import { type IAnonymousImpressionUIElement, 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 IExperiments, 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 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 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';
+/**
+ * Common builders output to be merged into all events
+ * @param context {TpaasEventContext} the event context, including the tracking input
+ * @private
+ */
+type EventContextWithExperiments = TpaasEventContext<Extract<ITpaasEvent, {
+    experiments?: IExperiments;
+}>>;
+export declare const getCommonBuildersOutput: (context: EventContextWithExperiments) => {
+    catalogVersion: string;
+    consents: {
+        advertising: "Accepted" | "Rejected" | "Unknown";
+        analytics: "Accepted" | "Rejected" | "Unknown";
+        marketing: "Accepted" | "Rejected" | "Unknown";
+        personalization: "Accepted" | "Rejected" | "Unknown";
+        source: string;
+    };
+    device: {
+        browserVersion: string | undefined;
+        clientType: "Chrome" | "Edge" | "Firefox" | "NativeScreen" | "Other" | "Safari" | "Samsung" | "Webview";
+        deviceType: "Desktop" | "Mobile" | "Other" | "SmartTv" | "Tablet";
+        environmentId: string;
+        ipAddress: string | undefined;
+        jweIds: string | undefined;
+        mobileBrand: string | undefined;
+        mobileModel: string | undefined;
+        operatingSystem: "Android" | "Linux" | "Mac" | "Other" | "Windows" | "iOS";
+        screenOrientation: "Landscape" | "Portrait";
+        userAgent: string | undefined;
+        viewportSize: "L" | "M" | "S" | "Unknown" | "XL" | "XS";
+    };
+    eventId: string;
+    experiments: IExperiments | undefined;
+    page: {
+        info: {
+            pageId: string | undefined;
+            pageType: "AppWidget" | "Article" | "AudioPage" | "Error" | "Frontpage" | "HealthPage" | "Landingpage" | "Listing" | "LockedArticle" | "LockedAudioPage" | "LockedPage" | "LockedVideoPage" | "Login" | "Notification" | "Page" | "Purchase" | "SchoolPage" | "SportsPage" | "Title" | "VideoPage" | "Weather" | undefined;
+            url: string | undefined;
+        };
+        pageviewId: string;
+        referrer: import("..").IPageRef | undefined;
+        utm: import("..").IUtmTags | undefined;
+    };
+    provider: {
+        component: string | undefined;
+        componentVersion: string | undefined;
+        group: string | undefined;
+        name: string | undefined;
+        product: string;
+        providerId: string;
+        providerSdrn: string;
+        stage: "Dev" | "Pre" | "Pro";
+        version: string;
+    };
+    session: {
+        isFirstEvent: boolean;
+        sessionId: string;
+        startTime: string;
+        xDomainId: string | undefined;
+    };
+    time: {
+        createdAt: string;
+        publishedAt: string | undefined;
+        republishedAt: string | undefined;
+        sentAt: string;
+    };
+    tracker: {
+        isHybrid: boolean;
+        proxyVersion: string | undefined;
+        routingStage: "Dev" | "Pre" | "Pro";
+        trackerType: "Android" | "Backend" | "IOS" | "JS";
+        version: string;
+    };
+    user: import("..").IUser | undefined;
+};
+export declare function buildAnonymousImpressionUIElementEvent(context: TpaasAnonymousEventContext<IAnonymousImpressionUIElement>): IAnonymousImpressionUIElement;
+export declare function buildViewArticleEvent(context: TpaasEventContext<IViewArticle>): IViewArticle;
+export declare function buildViewAudioPageEvent(context: TpaasEventContext<IViewAudioPage>): IViewAudioPage;
+export declare function buildViewErrorEvent(context: TpaasEventContext<IViewError>): IViewError;
+export declare function buildViewFrontpageEvent(context: TpaasEventContext<IViewFrontpage>): IViewFrontpage;
+export declare function buildViewLandingpageEvent(context: TpaasEventContext<IViewLandingpage>): IViewLandingpage;
+export declare function buildViewListingEvent(context: TpaasEventContext<IViewListing>): IViewListing;
+export declare function buildViewLockedArticleEvent(context: TpaasEventContext<IViewLockedArticle>): IViewLockedArticle;
+export declare function buildViewLockedAudioPageEvent(context: TpaasEventContext<IViewLockedAudioPage>): IViewLockedAudioPage;
+export declare function buildViewLockedPageEvent(context: TpaasEventContext<IViewLockedPage>): IViewLockedPage;
+export declare function buildViewLockedVideoPageEvent(context: TpaasEventContext<IViewLockedVideoPage>): IViewLockedVideoPage;
+export declare function buildLeaveLockedVideoPageEvent(context: TpaasEventContext<ILeaveLockedVideoPage>): ILeaveLockedVideoPage;
+export declare function buildViewPageEvent(context: TpaasEventContext<IViewPage>): IViewPage;
+export declare function buildViewSportsPageEvent(context: TpaasEventContext<IViewSportsPage>): IViewSportsPage;
+export declare function buildViewSchoolPageEvent(context: TpaasEventContext<IViewSchoolPage>): IViewSchoolPage;
+export declare function buildViewTitleEvent(context: TpaasEventContext<IViewTitle>): IViewTitle;
+export declare function buildViewVideoPageEvent(context: TpaasEventContext<IViewVideoPage>): IViewVideoPage;
+export declare function buildViewWeatherEvent(context: TpaasEventContext<IViewWeather>): IViewWeather;
+export declare function buildLeaveArticleEvent(context: TpaasEventContext<ILeaveArticle>): ILeaveArticle;
+export declare function buildLeaveAudioPageEvent(context: TpaasEventContext<ILeaveAudioPage>): ILeaveAudioPage;
+export declare function buildLeaveErrorEvent(context: TpaasEventContext<ILeaveError>): ILeaveError;
+export declare function buildLeaveFrontpageEvent(context: TpaasEventContext<ILeaveFrontpage>): ILeaveFrontpage;
+export declare function buildLeaveLandingpageEvent(context: TpaasEventContext<ILeaveLandingpage>): ILeaveLandingpage;
+export declare function buildLeaveListingEvent(context: TpaasEventContext<ILeaveListing>): ILeaveListing;
+export declare function buildLeaveLockedArticleEvent(context: TpaasEventContext<ILeaveLockedArticle>): ILeaveLockedArticle;
+export declare function buildLeaveLockedAudioPageEvent(context: TpaasEventContext<ILeaveLockedAudioPage>): ILeaveLockedAudioPage;
+export declare function buildLeaveLockedPageEvent(context: TpaasEventContext<ILeaveLockedPage>): ILeaveLockedPage;
+export declare function buildLeavePageEvent(context: TpaasEventContext<ILeavePage>): ILeavePage;
+export declare function buildLeaveSportsPageEvent(context: TpaasEventContext<ILeaveSportsPage>): ILeaveSportsPage;
+export declare function buildLeaveSchoolPageEvent(context: TpaasEventContext<ILeaveSchoolPage>): ILeaveSchoolPage;
+export declare function buildLeaveVideoPageEvent(context: TpaasEventContext<ILeaveVideoPage>): ILeaveVideoPage;
+export declare function buildLeaveWeatherEvent(context: TpaasEventContext<ILeaveWeather>): ILeaveWeather;
+export declare function buildEngagementAdEvent(context: TpaasEventContext<IEngagementAd>): IEngagementAd;
+export declare function buildEngagementAffiliateEvent(context: TpaasEventContext<IEngagementAffiliate>): IEngagementAffiliate;
+export declare function buildEngagementAudioEvent(context: TpaasEventContext<IEngagementAudio>): IEngagementAudio;
+export declare function buildEngagementFormEvent(context: TpaasEventContext<IEngagementForm>): IEngagementForm;
+export declare function buildEngagementOfferEvent(context: TpaasEventContext<IEngagementOffer>): IEngagementOffer;
+export declare function buildEngagementSportsUIElementEvent(context: TpaasEventContext<IEngagementSportsUIElement>): IEngagementSportsUIElement;
+export declare function buildEngagementSchoolUIElementEvent(context: TpaasEventContext<IEngagementSchoolUIElement>): IEngagementSchoolUIElement;
+export declare function buildEngagementTeaserEvent(context: TpaasEventContext<IEngagementTeaser>): IEngagementTeaser;
+export declare function buildEngagementTvModuleEvent(context: TpaasEventContext<IEngagementTvModule>): IEngagementTvModule;
+export declare function buildEngagementTvSearchEvent(context: TpaasEventContext<IEngagementTvSearch>): IEngagementTvSearch;
+export declare function buildEngagementUIElementEvent(context: TpaasEventContext<IEngagementUIElement>): IEngagementUIElement;
+export declare function buildEngagementVideoEvent(context: TpaasEventContext<IEngagementVideo>): IEngagementVideo;
+export declare function buildEngagementVideoAdEvent(context: TpaasEventContext<IEngagementVideoAd>): IEngagementVideoAd;
+export declare function buildEngagementWidgetEvent(context: TpaasEventContext<IEngagementWidget>): IEngagementWidget;
+export declare function buildHeartbeatCommercialArticleEvent(context: TpaasEventContext<IHeartbeatCommercialArticle>): IHeartbeatCommercialArticle;
+export declare function buildCompletedHealthActionEvent(context: TpaasEventContext<ICompletedHealthAction>): ICompletedHealthAction;
+export declare function buildEngagementHealthUIElementEvent(context: TpaasEventContext<IEngagementHealthUIElement>): IEngagementHealthUIElement;
+export declare function buildViewHealthPageEvent(context: TpaasEventContext<IViewHealthPage>): IViewHealthPage;
+export declare function buildImpressionHealthUIElementEvent(context: TpaasEventContext<IImpressionHealthUIElement>): IImpressionHealthUIElement;
+export declare function buildImpressionAdEvent(context: TpaasEventContext<IImpressionAd>): IImpressionAd;
+export declare function buildImpressionAdSlotEvent(context: TpaasEventContext<IImpressionAdSlot>): IImpressionAdSlot;
+export declare function buildImpressionAffiliateEvent(context: TpaasEventContext<IImpressionAffiliate>): IImpressionAffiliate;
+export declare function buildImpressionFormEvent(context: TpaasEventContext<IImpressionForm>): IImpressionForm;
+export declare function buildImpressionOfferEvent(context: TpaasEventContext<IImpressionOffer>): IImpressionOffer;
+export declare function buildImpressionPlayerEvent(context: TpaasEventContext<IImpressionPlayer>): IImpressionPlayer;
+export declare function buildImpressionSportsUIElementEvent(context: TpaasEventContext<IImpressionSportsUIElement>): IImpressionSportsUIElement;
+export declare function buildImpressionSchoolUIElementEvent(context: TpaasEventContext<IImpressionSchoolUIElement>): IImpressionSchoolUIElement;
+export declare function buildImpressionTeaserEvent(context: TpaasEventContext<IImpressionTeaser>): IImpressionTeaser;
+export declare function buildImpressionUIElementEvent(context: TpaasEventContext<IImpressionUIElement>): IImpressionUIElement;
+export declare function buildImpressionWidgetEvent(context: TpaasEventContext<IImpressionWidget>): IImpressionWidget;
+export declare function buildLoadAdEvent(context: TpaasEventContext<ILoadAd>): ILoadAd;
+export {};

package/dist/types/tpaas-builders/guards.d.ts

@@ -0,0 +1,2 @@
+import { PAGE_TYPE_VALUES } from '../tpaas-schemas';
+export declare function isPageType(pageType?: string): pageType is (typeof PAGE_TYPE_VALUES)[number];

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

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

package/dist/types/tpaas-context/adapters.d.ts

@@ -0,0 +1,26 @@
+import type { ActorInput, Consents } from '../builders';
+import type { IExperiments } from '../tpaas-schemas';
+import type { BaseEventExperiment } from '../wrapper/types';
+import type { TpaasEventContext, UserParams } from './types';
+/**
+ * Adapts the legacy actor input to the TPaaS user format.
+ *
+ * @privateRemarks
+ * This is a temporary solution to adapt the actor to the new format.
+ * It should be removed once we have new methods in place to get the actor.
+ *
+ * @private
+ */
+export declare function adaptActorToNewFormat(actor?: ActorInput): UserParams | undefined;
+/**
+ * Adapts the legacy consents to the TPaaS consents format.
+ *
+ * @private
+ */
+export declare function adaptConsentsToNewFormat(consents?: Consents): TpaasEventContext['consents'];
+/**
+ * Adapts the base experiments stored in the tracker to the TPaaS experiments format.
+ *
+ * @private
+ */
+export declare function adaptExperiments(baseExperiments?: BaseEventExperiment[]): IExperiments;

package/dist/types/tpaas-context/browser.d.ts

@@ -0,0 +1,8 @@
+import type { TpaasBrowserContext } from './types';
+/**
+ * Reads the browser state that can change between events, such as the URL after an SPA navigation
+ * or the viewport after a resize. Call it synchronously, when the event is tracked.
+ *
+ * @private
+ */
+export declare const captureBrowserContext: () => TpaasBrowserContext;

package/dist/types/tpaas-context/index.d.ts

@@ -0,0 +1,2 @@
+export { prepareAnonymousTpaasEventContext, prepareTpaasEventContext, type TpaasContextSource } from './prepare';
+export type { TpaasAnonymousEventContext, TpaasEventContext } from './types';

package/dist/types/tpaas-context/prepare.d.ts

@@ -0,0 +1,38 @@
+import type { Consents } from '../builders';
+import type { Builders, CurrentPageContext, SDKState } from '../Tracker';
+import type { InputParams, ITpaasEvent } from '../tpaas-schemas';
+import type { TpaasAnonymousEventContext, TpaasEventContext } from './types';
+/**
+ * What the Tracker provides to resolve the context of a TPaaS event.
+ *
+ * `state`, `builders` and `currentPage` are read synchronously when an event is tracked, so a later
+ * update or View event cannot change the context of an event that is still being prepared.
+ *
+ * @private
+ */
+export interface TpaasContextSource {
+    state: Pick<SDKState, 'isHybrid' | 'pageViewId' | 'providerId' | 'provider' | 'component' | 'componentVersion' | 'stage' | 'product' | 'version' | 'deployStageTpaas'>;
+    builders: Builders;
+    currentPage: CurrentPageContext;
+    /** Applies the remote configuration. A failure does not prevent the event from being tracked. */
+    applyRemoteConfig(): Promise<void>;
+    /** Applies the remote configuration and syncs with CIS. A failure does not prevent the event from being tracked. */
+    syncRemoteResources(builders: Builders): Promise<unknown>;
+    getConsents(): Promise<Consents>;
+    /** Called when the event's session has been resolved and stored. */
+    onSessionResolved(): void;
+}
+/**
+ * Resolves the context of an anonymous TPaaS event.
+ * Callers specify the event schema because it cannot be inferred from `InputParams<I>`.
+ *
+ * @private
+ */
+export declare function prepareAnonymousTpaasEventContext<I extends ITpaasEvent>(source: TpaasContextSource, input: InputParams<I>): Promise<TpaasAnonymousEventContext<I>>;
+/**
+ * Resolves the context of a TPaaS event.
+ * Callers specify the event schema because it cannot be inferred from `InputParams<I>`.
+ *
+ * @private
+ */
+export declare function prepareTpaasEventContext<I extends ITpaasEvent>(source: TpaasContextSource, input: InputParams<I>): Promise<TpaasEventContext<I>>;

package/dist/types/tpaas-context/session.d.ts

@@ -0,0 +1,10 @@
+import type { ISession } from '../tpaas-schemas';
+/**
+ * Registers an event created at `createdAt` in the stored session and returns it in the TPaaS format.
+ *
+ * Call it synchronously, together with capturing `createdAt`, before any asynchronous work.
+ * Sessions are then updated in the order events are tracked, which is also their creation order.
+ *
+ * @private
+ */
+export declare const resolveSession: (createdAt: Date) => ISession;

package/dist/types/tpaas-context/types.d.ts

@@ -0,0 +1,66 @@
+import type { IConsents, IContent, IDevice, IExperiments, InputParams, IPageRef, IProvider, ISession, ITpaasEvent, ITracker, IUser, IViewSportsPage } from '../tpaas-schemas';
+/**
+ * Browser state read when the event is tracked.
+ * @private
+ */
+export interface TpaasBrowserContext {
+    url?: string;
+    search: string;
+    screenOrientationType?: OrientationType;
+    viewportWidth: number;
+    viewportHeight: number;
+    userAgent: string | undefined;
+}
+export type UserParams = Pick<IUser, 'hasAnySubscription' | 'region'> & {
+    id: string;
+    realm: string;
+};
+/**
+ * Everything the TPaaS event builders need besides the tracking input, resolved by `prepareTpaasEventContext`.
+ *
+ * @private
+ *
+ * @privateRemarks
+ * These can be different from one event type to another, depending on the builders used by that event type.
+ * However, for now, we use the same context for all event types. let's make it more complex only if needed.
+ */
+export interface TpaasEventContext<I extends ITpaasEvent = ITpaasEvent> {
+    /**
+     * The tracking input, copied when the track method is called.
+     */
+    input: InputParams<I>;
+    /**
+     * Event creation time, captured when the track method is called, before any asynchronous work.
+     */
+    createdAt: Date;
+    /**
+     * Session resolved together with `createdAt`, so sessions are updated in the order events are tracked.
+     */
+    session: ISession;
+    /**
+     * Browser state read together with `createdAt`, so it describes the moment the event was tracked.
+     */
+    browser: TpaasBrowserContext;
+    user?: UserParams;
+    version: ITracker['version'];
+    isHybrid: ITracker['isHybrid'];
+    routingStage: ITracker['routingStage'];
+    consents?: IConsents;
+    providerId: IProvider['providerId'];
+    providerName?: IProvider['name'];
+    providerGroup?: IProvider['group'];
+    providerStage: IProvider['stage'];
+    providerProduct: NonNullable<IProvider['product']>;
+    providerVersion: NonNullable<IProvider['version']>;
+    component?: IProvider['component'];
+    componentVersion?: IProvider['componentVersion'];
+    environmentId: IDevice['environmentId'];
+    jwe: IDevice['jweIds'];
+    pageviewId: string;
+    experiments?: IExperiments;
+    currentPage?: IPageRef;
+    currentPageContent?: IContent;
+    currentPageSports?: Pick<IViewSportsPage['object'], 'sportName' | 'sportSubview' | 'sportView' | 'sports'>;
+    currentPageReferrer: IPageRef;
+}
+export type TpaasAnonymousEventContext<I extends ITpaasEvent> = Pick<TpaasEventContext<I>, 'input' | 'createdAt' | 'browser' | 'isHybrid' | 'version' | 'pageviewId' | 'providerId' | 'providerName' | 'providerGroup' | 'providerStage' | 'providerProduct' | 'providerVersion' | 'experiments' | 'component' | 'componentVersion' | 'currentPageReferrer' | 'routingStage'>;