@schibsted/pulse-sdk 8.0.0-rc.13 → 8.0.0-rc.15

package/dist/types/tpaas-schemas/types/schemas/IEngagementAffiliate.d.ts

@@ -0,0 +1,138 @@
+/* eslint-disable */
+
+import type { IConsents } from '../templates/IConsents.d.ts';
+import type { IContent } from '../templates/IContent.d.ts';
+import type { IDevice } from '../templates/IDevice.d.ts';
+import type { IEngagement } from '../templates/IEngagement.d.ts';
+import type { IExperiments } from '../templates/IExperiments.d.ts';
+import type { IPageRef } from '../templates/IPageRef.d.ts';
+import type { IProvider } from '../templates/IProvider.d.ts';
+import type { ISession } from '../templates/ISession.d.ts';
+import type { ITime } from '../templates/ITime.d.ts';
+import type { ITracker } from '../templates/ITracker.d.ts';
+import type { IUser } from '../templates/IUser.d.ts';
+import type { IUtmTags } from '../templates/IUtmTags.d.ts';
+
+/**
+ * Interaction with an affiliate link (e.g. buy button, product card, banner).
+ */
+export interface IEngagementAffiliate {
+  /**
+   * The version of the TPaaS schemas catalog that this particular schema belongs to. Semver format.
+   * @pattern ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
+   * @example "1.2.3"
+   */
+  catalogVersion: string;
+  consents: IConsents;
+  device: IDevice;
+  engagement: IEngagement;
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Engagement';
+  experiments?: IExperiments;
+  object: {
+    /**
+     * ISO-4217 currency code.
+     * @example "NOK"
+     */
+    currency?: string;
+    /**
+     * The size of the component.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * Whether the affiliate link is commercial.
+     */
+    isCommercial: boolean;
+    /**
+     * The name of the component.
+     */
+    name: string;
+    /**
+     * The unique ID for this component.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN for this component.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'Affiliate';
+    /**
+     * Price of the product.
+     */
+    price?: number;
+    /**
+     * Product category.
+     * @example "cars"
+     */
+    productCategory?: string;
+    /**
+     * Stable product identifier.
+     */
+    productId?: string;
+    /**
+     * Name of the product.
+     */
+    productName: string;
+    /**
+     * Name of the shop the affiliate link points to.
+     * @example "Elkjøp"
+     */
+    storeName: string;
+    /**
+     * Brand-specific markers.
+     */
+    tags?: string[];
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement: {
+    /**
+     * Element the affiliate link lives in, used for traffic attribution.
+     * @example "ProductSummaryBox"
+     */
+    containerName: string;
+    /**
+     * Indicator if the player was visible at pageload (“above”) or if the user had to scroll to it (“below”).
+     */
+    foldPosition?: 'Above' | 'Below' | 'Unknown';
+    /**
+     * Position of this link among affiliate links in the same element.
+     * @minimum -19
+     */
+    primaryPosition?: number;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  target: {
+    content?: IContent;
+    info: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

package/dist/types/tpaas-schemas/types/schemas/IEngagementAudio.d.ts

@@ -207,12 +207,6 @@ export interface IEngagementAudio {
     referrer?: IPageRef;
     utm?: IUtmTags;
   };
-  placement: {
-    /**
-     * ContainerName is the name of the UI container/module in which the player renders (not the player type or content type).
-     */
-    containerName: string;
-  };
   provider: IProvider;
   /**
    * URL to the JSON schema for this event.

package/dist/types/tpaas-schemas/types/schemas/IEngagementTeaser.d.ts

@@ -52,6 +52,11 @@ export interface IEngagementTeaser {
      * The size of the component.
      */
     elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * The URL to the teaser image.
+     * @example "https://akamai.vgc.no/v2/images/bf0b043a-beb4-382a-be20-89bba60bdc44?fit=crop&format=auto&w=1440&s=183a09a7662535f456fa261fb7cc4f8af6a55aa1"
+     */
+    imageUrl?: string;
     /**
      * The name of the component.
      */
@@ -68,6 +73,10 @@ export interface IEngagementTeaser {
      * The type of the component.
      */
     objectType: 'Teaser';
+    /**
+     * The name of the company that sponsored the Teaser. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
     /**
      * The title of the teaser.
      */

package/dist/types/tpaas-schemas/types/schemas/IEngagementTvModule.d.ts

@@ -0,0 +1,130 @@
+/* eslint-disable */
+
+import type { IConsents } from '../templates/IConsents.d.ts';
+import type { IContent } from '../templates/IContent.d.ts';
+import type { IDevice } from '../templates/IDevice.d.ts';
+import type { IEngagement } from '../templates/IEngagement.d.ts';
+import type { IExperiments } from '../templates/IExperiments.d.ts';
+import type { IPageRef } from '../templates/IPageRef.d.ts';
+import type { IProvider } from '../templates/IProvider.d.ts';
+import type { ISession } from '../templates/ISession.d.ts';
+import type { ITime } from '../templates/ITime.d.ts';
+import type { ITracker } from '../templates/ITracker.d.ts';
+import type { IUser } from '../templates/IUser.d.ts';
+import type { IUtmTags } from '../templates/IUtmTags.d.ts';
+
+/**
+ * Interaction with a TvModule element. (Note: currently only used by TVnu.)
+ */
+export interface IEngagementTvModule {
+  /**
+   * The version of the TPaaS schemas catalog that this particular schema belongs to. Semver format.
+   * @pattern ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
+   * @example "1.2.3"
+   */
+  catalogVersion: string;
+  consents: IConsents;
+  device: IDevice;
+  engagement: IEngagement;
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Engagement';
+  experiments?: IExperiments;
+  object: {
+    /**
+     * The size of the component.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * The text of the element.
+     */
+    elementText?: string;
+    /**
+     * The type of UIElement (div, span, a, …).
+     */
+    elementType: string;
+    /**
+     * Action taken on the module: Add module, remove module, change placement of module, etc.
+     * @example "moveTop"
+     */
+    moduleAction?: string;
+    /**
+     * Content interacted with in the module: Article teaser text, Title, List Name.
+     * @example "Ted Lasso"
+     */
+    moduleContent?: string;
+    /**
+     * Text set as header (or title) for the module.
+     * @example "Fotbolls-VM"
+     */
+    moduleHeader: string;
+    /**
+     * Type of TV module users interact with.
+     * @example "Editorial"
+     */
+    moduleType:
+      | 'Channel'
+      | 'Sport'
+      | 'PlayProvider'
+      | 'Editorial'
+      | 'ProgramList'
+      | 'SportListing'
+      | 'PremiereCalendar'
+      | 'UserCalendar'
+      | 'TrailerList';
+    /**
+     * The name of the component.
+     */
+    name: string;
+    /**
+     * The unique ID for this component.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN for this component.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'TvModule';
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement: {
+    /**
+     * The closest parent container used for traffic attribution. When in doubt use “page”.
+     */
+    containerName: string;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  target?: {
+    content?: IContent;
+    info?: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

package/dist/types/tpaas-schemas/types/schemas/IEngagementUIElement.d.ts

@@ -65,6 +65,10 @@ export interface IEngagementUIElement {
      * The type of the component.
      */
     objectType: 'UIElement';
+    /**
+     * The name of the company that sponsored the UIElement. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
   };
   page: {
     content?: IContent;

package/dist/types/tpaas-schemas/types/schemas/IEngagementVideo.d.ts

@@ -98,7 +98,7 @@ export interface IEngagementVideo {
      */
     prevPositionMs: number;
     /**
-     * The current playback quality.
+     * The current playback quality. High quality equals 1080p or more, medium equals between 480p and up to 1080p and low quality equals below 480p. This definition applies for both vertical and horizontal content.
      */
     quality?: string;
     /**
@@ -230,12 +230,6 @@ export interface IEngagementVideo {
     referrer?: IPageRef;
     utm?: IUtmTags;
   };
-  placement: {
-    /**
-     * ContainerName is the name of the UI container/module in which the player renders (not the player type or content type).
-     */
-    containerName: string;
-  };
   provider: IProvider;
   /**
    * URL to the JSON schema for this event.

package/dist/types/tpaas-schemas/types/schemas/IImpressionAffiliate.d.ts

@@ -0,0 +1,136 @@
+/* eslint-disable */
+
+import type { IConsents } from '../templates/IConsents.d.ts';
+import type { IContent } from '../templates/IContent.d.ts';
+import type { IDevice } from '../templates/IDevice.d.ts';
+import type { IExperiments } from '../templates/IExperiments.d.ts';
+import type { IPageRef } from '../templates/IPageRef.d.ts';
+import type { IProvider } from '../templates/IProvider.d.ts';
+import type { ISession } from '../templates/ISession.d.ts';
+import type { ITime } from '../templates/ITime.d.ts';
+import type { ITracker } from '../templates/ITracker.d.ts';
+import type { IUser } from '../templates/IUser.d.ts';
+import type { IUtmTags } from '../templates/IUtmTags.d.ts';
+
+/**
+ * Impression of an affiliate link (e.g. buy button, product card, banner).
+ */
+export interface IImpressionAffiliate {
+  /**
+   * The version of the TPaaS schemas catalog that this particular schema belongs to. Semver format.
+   * @pattern ^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$
+   * @example "1.2.3"
+   */
+  catalogVersion: string;
+  consents: IConsents;
+  device: IDevice;
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Impression';
+  experiments?: IExperiments;
+  object: {
+    /**
+     * ISO-4217 currency code.
+     * @example "NOK"
+     */
+    currency?: string;
+    /**
+     * The size of the component.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * Whether the affiliate link is commercial.
+     */
+    isCommercial: boolean;
+    /**
+     * The name of the component.
+     */
+    name: string;
+    /**
+     * The unique ID for this component.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN for this component.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'Affiliate';
+    /**
+     * Price of the product.
+     */
+    price?: number;
+    /**
+     * Product category.
+     * @example "cars"
+     */
+    productCategory?: string;
+    /**
+     * Stable product identifier.
+     */
+    productId?: string;
+    /**
+     * Name of the product.
+     */
+    productName: string;
+    /**
+     * Name of the shop the affiliate link points to.
+     * @example "Elkjøp"
+     */
+    storeName: string;
+    /**
+     * Brand-specific markers.
+     */
+    tags?: string[];
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement: {
+    /**
+     * Element the affiliate link lives in, used for traffic attribution.
+     * @example "ProductSummaryBox"
+     */
+    containerName: string;
+    /**
+     * Indicator if the player was visible at pageload (“above”) or if the user had to scroll to it (“below”).
+     */
+    foldPosition: 'Above' | 'Below' | 'Unknown';
+    /**
+     * Position of this link among affiliate links in the same element.
+     * @minimum -19
+     */
+    primaryPosition?: number;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  target: {
+    content?: IContent;
+    info: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

package/dist/types/tpaas-schemas/types/schemas/IImpressionForm.d.ts

@@ -103,8 +103,8 @@ export interface IImpressionForm {
    */
   schema: string;
   session: ISession;
-  target: {
-    content: IContent;
+  target?: {
+    content?: IContent;
     info?: IPageRef;
   };
   time: ITime;

package/dist/types/tpaas-schemas/types/schemas/IImpressionTeaser.d.ts

@@ -50,6 +50,11 @@ export interface IImpressionTeaser {
      * The size of the component.
      */
     elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * The URL to the teaser image.
+     * @example "https://akamai.vgc.no/v2/images/bf0b043a-beb4-382a-be20-89bba60bdc44?fit=crop&format=auto&w=1440&s=183a09a7662535f456fa261fb7cc4f8af6a55aa1"
+     */
+    imageUrl?: string;
     /**
      * The name of the component.
      */
@@ -66,6 +71,10 @@ export interface IImpressionTeaser {
      * The type of the object.
      */
     objectType: 'Teaser';
+    /**
+     * The name of the company that sponsored the UIElement. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
     /**
      * The title of the teaser.
      */

package/dist/types/tpaas-schemas/types/schemas/ILeaveArticle.d.ts

@@ -108,7 +108,7 @@ export interface ILeaveArticle {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll' | 'Swipe' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/ILeaveAudioPage.d.ts

@@ -65,7 +65,7 @@ export interface ILeaveAudioPage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/ILeaveFrontpage.d.ts

@@ -60,7 +60,7 @@ export interface ILeaveFrontpage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/ILeaveListing.d.ts

@@ -47,6 +47,10 @@ export interface ILeaveListing {
      * The engine producing this listing. Use “editorial” for manually curated lists.
      */
     contentSource: 'Capi' | 'Curate' | 'ElasticSearch' | 'Editorial';
+    /**
+     * Filters applied to the listing.
+     */
+    filters?: string[];
     /**
      * True if list is populated indefinitely.
      */
@@ -77,10 +81,15 @@ export interface ILeaveListing {
      * @minimum 0
      */
     pageNumber: number;
+    /**
+     * The search query used by the user, if the listing page supports search.
+     * @example "risotto"
+     */
+    searchQuery?: string;
     /**
      * Indicates how results are sorted. Use “editorial” for manually curated lists.
      */
-    sortingMethod: 'Time' | 'Editorial' | 'Relevance' | 'Alphabetical';
+    sortingMethod: 'Time' | 'Editorial' | 'Relevance' | 'Alphabetical' | 'Other';
     /**
      * The title of the page.
      */

package/dist/types/tpaas-schemas/types/schemas/ILeaveLockedArticle.d.ts

@@ -116,7 +116,7 @@ export interface ILeaveLockedArticle {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll' | 'Swipe' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/ILeaveLockedAudioPage.d.ts

@@ -74,7 +74,7 @@ export interface ILeaveLockedAudioPage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/ILeaveLockedVideoPage.d.ts

@@ -74,7 +74,7 @@ export interface ILeaveLockedVideoPage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/ILeaveVideoPage.d.ts

@@ -68,7 +68,7 @@ export interface ILeaveVideoPage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/IViewArticle.d.ts

@@ -108,7 +108,7 @@ export interface IViewArticle {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll' | 'Swipe' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/IViewAudioPage.d.ts

@@ -64,7 +64,7 @@ export interface IViewAudioPage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/IViewFrontpage.d.ts

@@ -57,7 +57,7 @@ export interface IViewFrontpage {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid

package/dist/types/tpaas-schemas/types/schemas/IViewListing.d.ts

@@ -42,6 +42,10 @@ export interface IViewListing {
      * The engine producing this listing. Use “editorial” for manually curated lists.
      */
     contentSource: 'Capi' | 'Curate' | 'ElasticSearch' | 'Editorial';
+    /**
+     * Filters applied to the listing.
+     */
+    filters?: string[];
     /**
      * True if list is populated indefinitely (doomscroll).
      */
@@ -72,10 +76,15 @@ export interface IViewListing {
      * @minimum 0
      */
     pageNumber: number;
+    /**
+     * The search query used by the user, if the listing page supports search.
+     * @example "risotto"
+     */
+    searchQuery?: string;
     /**
      * Indicates how results are sorted. Use “editorial” for manually curated lists.
      */
-    sortingMethod: 'Time' | 'Editorial' | 'Relevance' | 'Alphabetical';
+    sortingMethod: 'Time' | 'Editorial' | 'Relevance' | 'Alphabetical' | 'Other';
     /**
      * The title of the page.
      */

package/dist/types/tpaas-schemas/types/schemas/IViewLockedArticle.d.ts

@@ -116,7 +116,7 @@ export interface IViewLockedArticle {
     /**
      * The browser navigation that got the user to the current page.
      */
-    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll';
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll' | 'Swipe' | 'DeepLink' | 'Push';
     /**
      * The pageviewID.
      * @format uuid