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

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

@@ -316,6 +316,7 @@ interface ICancelSubscription {
 		/**
 		 * The environmentId.
 		 * @pattern ^[0-9a-fA-F-]+$
+		 * @example "42401e1f-7e04-4b73-8bed-1ceffc0ed8cc"
 		 */
 		environmentId: string;
 	};
@@ -539,14 +540,17 @@ interface IChangePushNotificationSettings {
 interface IHealthOrigin {
 	/**
 	 * The specific UI element or component that navigated to this page.
+	 * @example "logging_hq_button"
 	 */
 	content?: string;
 	/**
 	 * The feature area that navigated to this page
+	 * @example "meal_logging"
 	 */
 	feature?: string;
 	/**
 	 * The origin name / place that the user navigated from.
+	 * @example "logbook"
 	 */
 	name?: string;
 }
@@ -575,9 +579,9 @@ interface IContent {
 	 */
 	contentType: "Article" | "LiveArticle" | "SpecialArticle" | "Podcast" | "Episode" | "Audiobook" | "AudiobookSample" | "Movie" | "Series" | "Story";
 	/**
-	 * The newsroom that the target content belongs to.
+	 * The namespace that the target content belongs to, for example its newsroom
 	 */
-	newsroom: string;
+	namespace: string;
 	/**
 	 * A list of product features that give access to this content. (Uses OR, i.e., having one is enough for access.)
 	 */
@@ -1265,15 +1269,11 @@ interface IPlacement {
 	 * The context in which the recommendation was made.
 	 */
 	curateContext?: string;
-	/**
-	 * The source of the impression/engagement.
-	 */
-	curateSource?: string;
 	/**
 	 * Indicator if the player was visible at pageload (“above”) or if the user had to scroll to it (“below”).
 	 */
 	foldPosition: "Above" | "Below" | "Unknown";
-	positionInBundle: number;
+	positionInBundle?: number;
 	/**
 	 * The parent’s primary direction along which components are laid out.
 	 */
@@ -2662,6 +2662,7 @@ interface IInternalAccessDecision {
 		deviceType?: "Desktop" | "Mobile" | "Tablet" | "SmartTv" | "Other";
 		/**
 		 * The environment ID.
+		 * @example "42401e1f-7e04-4b73-8bed-1ceffc0ed8cc"
 		 */
 		environmentId: string;
 		/**
@@ -2684,7 +2685,7 @@ interface IInternalAccessDecision {
 	eventType: "Internal";
 	experiments?: IExperiments;
 	object: {
-		arm: {
+		arm?: {
 			/**
 			 * Unique ID of the experimental arm the user is assigned to.
 			 */
@@ -2698,6 +2699,18 @@ interface IInternalAccessDecision {
 			 */
 			config: {
 				armId: string;
+				rctProbabilities?: {
+					/**
+					 * @minimum 0
+					 * @maximum 1
+					 */
+					close: number;
+					/**
+					 * @minimum 0
+					 * @maximum 1
+					 */
+					open: number;
+				};
 				version: string;
 				/**
 				 * @minimum 0
@@ -2741,7 +2754,7 @@ interface IInternalAccessDecision {
 		 * Categorization of how the decision was made.
 		 */
 		decisionType: "Policy" | "Replay" | "Fallback";
-		episode: {
+		episode?: {
 			/**
 			 * End time of the episode in UTC.
 			 * @format date-time
@@ -2757,6 +2770,10 @@ interface IInternalAccessDecision {
 			 */
 			startAt: string;
 		};
+		/**
+		 * Internal Decision System error that caused the fallback.
+		 */
+		fallbackReason?: "EngineTimeout" | "EpisodeReadError" | "EpisodeWriteError" | "RequestCountError" | "ArmReadError" | "ArmWriteError";
 		/**
 		 * The type of the object.
 		 */
@@ -2778,10 +2795,6 @@ interface IInternalAccessDecision {
 	schema: string;
 	target: {
 		content: {
-			/**
-			 * The access restriction placed on the content.
-			 */
-			accessLevel?: "Free" | "Login" | "Meter" | "Paid" | "Dynamic";
 			/**
 			 * The format that this content is presented in.
 			 */
@@ -2794,6 +2807,11 @@ interface IInternalAccessDecision {
 			 * The subtype of the content.
 			 */
 			contentType?: "Article" | "LiveArticle" | "SpecialArticle" | "Podcast" | "Episode" | "Audiobook" | "AudiobookSample" | "Movie" | "Series" | "Story";
+			layout?: string;
+			/**
+			 * @minimum 1
+			 */
+			layoutPosition?: number;
 			/**
 			 * The id of the provider that requested the access decision and where the result will be shown (svdse). Note: Not the same as .provider.providerId.
 			 */
@@ -3413,9 +3431,8 @@ interface ILeaveListing {
 		itemsTotal: number;
 		/**
 		 * The type of listing page, e.g. 'tag', 'section' etc.
-		 * @pattern Tag,Story,Section,Search,Author,Other
 		 */
-		listingType: string;
+		listingType: "Tag" | "Story" | "Section" | "Search" | "Author" | "Other";
 		/**
 		 * The unique ID of this page.
 		 */
@@ -4191,6 +4208,7 @@ interface IPurchaseSubscription {
 		/**
 		 * The environmentId.
 		 * @pattern ^[0-9a-fA-F-]+$
+		 * @example "42401e1f-7e04-4b73-8bed-1ceffc0ed8cc"
 		 */
 		environmentId?: string;
 	};
@@ -4285,6 +4303,7 @@ interface IPurchaseSubscription {
 		utm?: IUtmTags;
 		/**
 		 * The session ID on a partner domain (set via query parameter), else the current session ID. This value is used to connect cross-domain events such as behavior events to purchase events.
+		 * @example "079bc17a-4ee8-42ab-a29f-2fbba4cd403f"
 		 */
 		xDomainId?: string;
 	};
@@ -5527,31 +5546,7 @@ interface IViewWeather {
 	user?: IUser;
 }
 type ITpaasEvent = IAnonymousViewUIElement | ICancelSubscription | IChangePushNotificationSettings | ICompletedHealthAction | IEngagementAudio | IEngagementForm | IEngagementHealthUIElement | IEngagementNotification | IEngagementOffer | IEngagementTeaser | IEngagementUIElement | IEngagementVideo | IEngagementVideoAd | IEngagementWidget | IImpressionAdSlot | IImpressionForm | IImpressionHealthUIElement | IImpressionNotification | IImpressionOffer | IImpressionPlayer | IImpressionTeaser | IImpressionUIElement | IImpressionWidget | IInternalAccessDecision | IInternalProbe | ILaunchApp | ILeaveArticle | ILeaveAudioPage | ILeaveError | ILeaveFrontpage | ILeaveLandingpage | ILeaveListing | ILeaveLockedArticle | ILeaveLockedAudioPage | ILeaveLockedVideoPage | ILeavePage | ILeaveSportsPage | ILeaveVideoPage | ILeaveWeather | IPurchaseSubscription | IViewArticle | IViewAudioPage | IViewError | IViewFrontpage | IViewHealthPage | IViewLandingpage | IViewListing | IViewLockedArticle | IViewLockedAudioPage | IViewLockedVideoPage | IViewPage | IViewSportsPage | IViewTitle | IViewVideoPage | IViewWeather;
-type UserParams = Pick<IUser, "hasAnySubscription" | "region"> & {
-	id: string;
-	realm: string;
-};
-/**
- * @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 dependencies for all event types. let's make it more complex only if needed.
- */
-export interface TpaasEventBuilderDependencies {
-	user?: UserParams;
-	autoTrackerVersion: ITracker["autoTrackerVersion"];
-	version: ITracker["version"];
-	isHybrid: ITracker["isHybrid"];
-	consents?: IConsents;
-	providerId: IProvider["providerId"];
-	environmentId: IDevice["environmentId"];
-	jwe: IDevice["jweIds"];
-	pageviewId: string;
-	experiments?: IExperiments;
-	currentPage?: IPageRef;
-}
-type OmittedProperties = "user" | "eventId" | "consents" | "device" | "time" | "tracker" | "session" | "eventType" | "schema" | "object.objectType" | "isAnonymous" | "provider.providerId" | "provider.providerSdrn" | "page.pageviewId" | "page.utm" | "page.info" | "page.referrer.url" | "catalogVersion";
+type OmittedProperties = "user" | "eventId" | "consents" | "device" | "time" | "tracker" | "session" | "eventType" | "schema" | "object.objectType" | "isAnonymous" | "provider.providerId" | "provider.providerSdrn" | "provider.component" | "provider.componentVersion" | "page.pageviewId" | "page.utm" | "page.info" | "page.referrer.url" | "catalogVersion";
 type DeepOmit<T, K extends string> = T extends readonly unknown[] ? T : T extends object ? {
 	[P in keyof T as P extends K ? never : P]: DeepOmit<T[P], K extends `${Exclude<P, symbol>}.${infer R}` ? R : never>;
 } extends infer Result ? {
@@ -5574,25 +5569,46 @@ type OptionalNavigationType<T> = T extends {
 		navigationType?: N;
 	};
 } : T;
+type WithOptionalPage<T> = T extends TpaasOptionalPageSchemas ? Omit<T, "page"> & {
+	page?: T["page"];
+} : T;
+type TpaasOptionalPageSchemas = IAnonymousViewUIElement | ICompletedHealthAction | IEngagementAudio | IEngagementForm | IEngagementHealthUIElement | IEngagementOffer | IEngagementTeaser | IEngagementUIElement | IEngagementVideo | IEngagementVideoAd | IEngagementWidget | IImpressionAdSlot | IImpressionForm | IImpressionHealthUIElement | IImpressionOffer | IImpressionPlayer | IImpressionTeaser | IImpressionUIElement | IImpressionWidget | ILeaveAudioPage | ILeaveError | ILeaveFrontpage | ILeaveLandingpage | ILeaveListing | ILeaveLockedAudioPage | ILeaveLockedVideoPage | ILeavePage | ILeaveSportsPage | ILeaveVideoPage | ILeaveWeather | IViewAudioPage | IViewError | IViewFrontpage | IViewHealthPage | IViewLandingpage | IViewListing | IViewLockedAudioPage | IViewLockedVideoPage | IViewPage | IViewSportsPage | IViewTitle | IViewVideoPage | IViewWeather;
+type InputParams<T extends ITpaasEvent> = DeepOmit<OptionalNavigationType<WithOptionalPage<T>>, OmittedProperties>;
+type UserParams = Pick<IUser, "hasAnySubscription" | "region"> & {
+	id: string;
+	realm: string;
+};
 /**
- * InputParams is a utility type that omits certain properties from a given type T.
- * @param T - The type from which properties will be omitted.
  * @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 dependencies for all event types. let's make it more complex only if needed.
  */
-export type InputParams<T extends ITpaasEvent> = DeepOmit<OptionalNavigationType<WithOptionalPage<T>>, OmittedProperties>;
-type WithOptionalPage<T> = T extends TpaasOptionalPageSchemas ? Omit<T, "page"> & {
-	page?: T["page"];
-} : T;
-type TpaasOptionalPageSchemas = IAnonymousViewUIElement | ICompletedHealthAction | IEngagementAudio | IEngagementForm | IEngagementHealthUIElement | IEngagementOffer | IEngagementTeaser | IEngagementUIElement | IEngagementVideo | IEngagementVideoAd | IEngagementWidget | IImpressionAdSlot | IImpressionForm | IImpressionHealthUIElement | IImpressionOffer | IImpressionPlayer | IImpressionTeaser | IImpressionUIElement | IImpressionWidget | ILeaveAudioPage | ILeaveError | ILeaveFrontpage | ILeaveLandingpage | ILeaveListing | ILeaveLockedAudioPage | ILeaveLockedVideoPage | ILeavePage | ILeaveSportsPage | ILeaveVideoPage | ILeaveWeather | IViewAudioPage | IViewError | IViewFrontpage | IViewHealthPage | IViewLandingpage | IViewListing | IViewLockedAudioPage | IViewLockedVideoPage | IViewPage | IViewSportsPage | IViewTitle | IViewVideoPage | IViewWeather;
+export interface TpaasEventBuilderDependencies {
+	user?: UserParams;
+	autoTrackerVersion: ITracker["autoTrackerVersion"];
+	version: ITracker["version"];
+	isHybrid: ITracker["isHybrid"];
+	consents?: IConsents;
+	providerId: IProvider["providerId"];
+	component?: IProvider["component"];
+	componentVersion?: IProvider["componentVersion"];
+	environmentId: IDevice["environmentId"];
+	jwe: IDevice["jweIds"];
+	pageviewId: string;
+	experiments?: IExperiments;
+	currentPage?: IPageRef;
+}
 /**
  * Common builders output to be merged into all events
  * @param createdAt
  * @param dependencies {TpaasEventBuilderDependencies}
  * @private
  */
-export declare const getCommonBuildersOutput: (createdAt: Date, { autoTrackerVersion, isHybrid, version, environmentId, jwe, user, consents, providerId, pageviewId, currentPage, }: TpaasEventBuilderDependencies) => {
+export declare const getCommonBuildersOutput: (createdAt: Date, dependencies: TpaasEventBuilderDependencies, input: InputParams<Extract<ITpaasEvent, {
+	experiments?: IExperiments;
+}>>) => {
 	time: {
 		createdAt: string;
 		publishedAt: string | undefined;
@@ -5647,12 +5663,13 @@ export declare const getCommonBuildersOutput: (createdAt: Date, { autoTrackerVer
 		trackerType: "JS" | "IOS" | "Android" | "Backend";
 	};
 	catalogVersion: string;
+	experiments: IExperiments | undefined;
 	provider: {
 		providerId: string;
 		providerSdrn: string;
 	};
 };
-export declare function buildAnonymousViewUIElementEvent(input: InputParams<IAnonymousViewUIElement>, dependencies: Pick<TpaasEventBuilderDependencies, "autoTrackerVersion" | "isHybrid" | "version" | "pageviewId" | "providerId" | "experiments">): IAnonymousViewUIElement;
+export declare function buildAnonymousViewUIElementEvent(input: InputParams<IAnonymousViewUIElement>, dependencies: Pick<TpaasEventBuilderDependencies, "autoTrackerVersion" | "isHybrid" | "version" | "pageviewId" | "providerId" | "experiments" | "component" | "componentVersion">): IAnonymousViewUIElement;
 export declare function buildViewArticleEvent(input: InputParams<IViewArticle>, dependencies: TpaasEventBuilderDependencies): IViewArticle;
 export declare function buildViewAudioPageEvent(input: InputParams<IViewAudioPage>, dependencies: TpaasEventBuilderDependencies): IViewAudioPage;
 export declare function buildViewErrorEvent(input: InputParams<IViewError>, dependencies: TpaasEventBuilderDependencies): IViewError;

package/node_modules/@schibsted/tpaas-event-builder/package.json

@@ -28,6 +28,7 @@
     "uuid": "14.0.0"
   },
   "devDependencies": {
+    "@schibsted/tpaas-test-fixtures": "workspace:*",
     "@types/uuid": "11.0.0",
     "dts-bundle-generator": "9.5.1",
     "tsx": "4.21.0",