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

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

@@ -0,0 +1,238 @@
+/* eslint-disable */
+
+import type { IBranded } from '../templates/IBranded.d.ts';
+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 { IMetrics } from '../templates/IMetrics.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';
+
+/**
+ * Video usage and heartbeats.
+ */
+export interface IEngagementVideo {
+  branded?: IBranded;
+  /**
+   * 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 type of interaction.
+   */
+  engagement?: {
+    /**
+     * Semantic event type (e.g. "start" (first start), “pause”. "next", "stop" etc.).
+     */
+    engagementType?: 'Start' | 'Pause' | 'Resume' | 'Stop' | 'Cancel' | 'Error' | 'Seek' | 'Watch' | 'Load';
+  };
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Engagement';
+  experiments?: IExperiments;
+  /**
+   * Type of user interaction with the video
+   */
+  interaction?: {
+    /**
+     * Wether the user is actively viewing the application or consuming content while the application is in the background.
+     */
+    appState: 'Foreground' | 'Background';
+    /**
+     * How the content is displayed in the application
+     */
+    displayMode: 'Normal' | 'Sticky' | 'Fullscreen' | 'Overlay' | 'Minimized' | 'PictureInPicture' | 'Floating';
+    /**
+     * True if the video is muted.
+     */
+    isMuted: boolean;
+    /**
+     * The number of times the video has automatically repeated itself.
+     */
+    loopCount?: number;
+    /**
+     * Identifies the entry path that led to the playback. Examples include direct playback, next/previous navigation etc
+     */
+    playEntry: string;
+    /**
+     * Describes what triggered playback. `None` indicates automatic continuation of an ongoing playback flow, such as Play Next or Stories advancing without user interaction
+     */
+    playTrigger: 'Autoplay' | 'Click' | 'Scoll' | 'None';
+    /**
+     * Indicates how the video started.
+     */
+    playType: 'Automatic' | 'Manual';
+    /**
+     * How the content is being consumed by the user
+     */
+    playbackDevice: 'Device' | 'Chromecast' | 'Airplay' | 'Carplay';
+    /**
+     * The current playback speed.
+     * @exclusiveMinimum 0
+     */
+    playbackSpeed?: number;
+    /**
+     * The offset of the current playback from the start of the video in milliseconds.
+     */
+    positionMs: number;
+    /**
+     * The playback position in the video where the current play segment started. For the first segment it equals the start position, and after a seek it equals the seek-from position.
+     */
+    prevPositionMs: number;
+    /**
+     * 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?: 'High' | 'Medium' | 'low' | 'Unknown';
+    /**
+     * The playback position (in milliseconds) the user initiated the seek (timeline jump) from. Only included when engagement.type = "seek"
+     */
+    seekFromMs?: number;
+    /**
+     * The playback position (in milliseconds) the user sought to. Only included when engagement.type = "seek"
+     */
+    seekToMs?: number;
+    /**
+     * How much time user has spent on the playback (in milliseconds) regardless of seeking, pausing etc
+     */
+    viewtimeMs: number;
+  };
+  metrics?: IMetrics;
+  object: {
+    /**
+     * Numeric value of the video aspect ratio
+     */
+    aspectRatio: number;
+    /**
+     * The editorial category of this video
+     */
+    category: string;
+    /**
+     * The total duration of the video in milliseconds. Use -1 for live streams with unknown duration.
+     */
+    durationMs: number;
+    /**
+     * The size of the player.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * Which episode
+     */
+    episode?: string;
+    /**
+     * Video thumbnail from Stream to use in (Kilkaya) dashboards
+     */
+    imageUrl: string;
+    /**
+     * True if the video is an ad published through editorial CMS and not Xandr. Typical Brand Studio and Partnerstudio.
+     */
+    isAd: boolean;
+    /**
+     * True if the video has loop
+     */
+    isLoop: boolean;
+    /**
+     * True if video is sponsored.
+     */
+    isSponsored: boolean;
+    /**
+     * The name of the video.
+     */
+    name: string;
+    /**
+     * The unique ID for this video.
+     */
+    objectId: string;
+    /**
+     * The Stream newsroom and provider where the video is published
+     */
+    objectNamespace: string;
+    /**
+     * The unique SDRN for this video.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'Video';
+    /**
+     * Indicates how the video is configured to start
+     */
+    playTypeIntent: 'Automatic' | 'Manual';
+    /**
+     * The type of player exposed to the user
+     */
+    player: 'VideoPlayer' | 'StoriesPlayer' | 'AudioPlayer' | 'TtsPlayer';
+    /**
+     * A unique ID for this player instance.
+     */
+    playerId: string;
+    /**
+     * The ID of the playlist.
+     */
+    playlistId?: string;
+    /**
+     * The position of the video in the playlist.
+     * @minimum 0
+     */
+    queuePosition?: number;
+    /**
+     * Indicates the type of queue or playlist the video belongs to, such as editorially curated, user-created, or automatically generated queues.
+     */
+    queueType: 'Automatic' | 'UserCreated' | 'EditorialQueue';
+    /**
+     * Which season
+     */
+    season?: string;
+    /**
+     * Follow accesslevel from Stream (viewer access). Where there is no access level it is set to "Free"
+     */
+    streamAccessLevel: string;
+    /**
+     * Reflects the stream type as defined in Stream at the time of playback (live, VOD, waslive etc).
+     */
+    streamType: string;
+    tags?: string[];
+    /**
+     * Type of video. Fetched from content type in Stream.
+     */
+    variant: string;
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

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

@@ -0,0 +1,147 @@
+/* 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';
+
+/**
+ * Events for ads from Xandr.
+ */
+export interface IEngagementVideoAd {
+  /**
+   * 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 type of interaction.
+   */
+  engagement?: {
+    /**
+     * Semantic event type.
+     */
+    engagementType: 'AdStart' | 'AdSkip' | 'AdStop';
+  };
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Engagement';
+  experiments?: IExperiments;
+  /**
+   * Type of user interaction with the video ad
+   *
+   */
+  interaction?: {
+    /**
+     * True if the ad is muted.
+     */
+    isMuted: boolean;
+    /**
+     * Indicates how the ad playback was initiated.
+     */
+    playType: 'Automatic' | 'Manual';
+    /**
+     * Position (in milliseconds) for when the ad is skipped, stopped or completed.
+     */
+    positionMs: number;
+  };
+  object: {
+    /**
+     * Duration of this specific ad in milliseconds. If the duration is unknown or not provided by the ad server, the fallback is -1.
+     */
+    adDurationMs: number;
+    /**
+     * Ad product name used by SMS
+     */
+    adFormat: string;
+    /**
+     * The unique ID of this ad from the ad server.
+     */
+    adId: string;
+    /**
+     * Ad position (index) in ad playlist
+     */
+    adSequencePosition: number;
+    /**
+     * Milliseconds until the ad can be skipped.
+     */
+    adSkipOffsetMs?: number;
+    /**
+     * True if the ad is skippable.
+     */
+    adSkippable: boolean;
+    /**
+     * Indicates where the ad appears in the playback sequence (e.g. preroll, midroll, postroll, overlay). Describes the ad position relative to the video, not the ad’s creative type.
+     */
+    adSlot: 'Preroll' | 'Midroll' | 'Postroll' | 'Overlay';
+    /**
+     * The identifier of the asset the ad belongs to.
+     */
+    mediaAssetId: string;
+    /**
+     * The unique SDRN of the embedded mediaAsset (not ads from Xandr) ready to play in the player.
+     */
+    mediaAssetSdrn: string;
+    /**
+     * The type of media product the ad belongs to. Fetched from content type in Stream.
+     */
+    mediaAssetVariant: string;
+    /**
+     * The unique SDRN for this ad.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'VideoAd';
+    /**
+     * The type of player exposed to the user
+     */
+    player: 'VideoPlayer' | 'StoriesPlayer';
+    /**
+     * A unique ID for this player instance.
+     */
+    playerId: string;
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  target?: {
+    info?: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

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

@@ -0,0 +1,91 @@
+/* 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 { IMetrics } from '../templates/IMetrics.d.ts';
+import type { IPageRef } from '../templates/IPageRef.d.ts';
+import type { IPlacement } from '../templates/IPlacement.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 widget component.
+ */
+export interface IEngagementWidget {
+  /**
+   * 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;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of event.
+   */
+  eventType: 'Engagement';
+  experiments?: IExperiments;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The size of the component.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * 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 component.
+     */
+    objectType: 'Widget';
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement?: IPlacement;
+  provider: IProvider;
+  /**
+   * The schema of the 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/IHeartbeatCommercialArticle.d.ts

@@ -0,0 +1,96 @@
+/* eslint-disable */
+
+import type { IBranded } from '../templates/IBranded.d.ts';
+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 { IMetrics } from '../templates/IMetrics.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';
+
+/**
+ * Periodic engagement heartbeat for a commercial (branded) article, emitted at a fixed cadence while the reader is active, to capture the interval retention a single Leave event cannot. The article is identified by page.info.pageId.
+ */
+export interface IHeartbeatCommercialArticle {
+  branded?: IBranded;
+  /**
+   * 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: 'Heartbeat';
+  experiments?: IExperiments;
+  /**
+   * Cumulative active reading time and reading depth at this heartbeat tick. The counters reset when the single-page app re-initialises. Not flushed on unload and silent in a hidden tab, so the last tick before exit can be missing.
+   */
+  heartbeat: {
+    /**
+     * Cumulative active reading time in milliseconds at this tick, on a 5000 ms grid. Activity is window focus, resize and scroll plus document.body focus, mousemove, mousedown, keydown and beforeunload, throttled to 500 ms.
+     * @minimum 5000
+     */
+    activeTimeMs: number;
+    /**
+     * Maximum absolute scroll offset in pixels reached at this tick. Same name and semantics as leave.maxPageScrollPosition, which likewise carries no lower bound.
+     */
+    maxPageScrollPosition?: number;
+    /**
+     * Maximum reading depth at this tick, in hundredths: the value times 100 is a whole number 0 to 100. Element coverage of body main, falling back to document.body, not scroll progress. A tick above 1.0 is discarded, not clamped.
+     * @minimum 0
+     * @maximum 1
+     */
+    maxPageViewPercentage?: number;
+  };
+  metrics?: IMetrics;
+  /**
+   * The object associated with the Schema
+   */
+  object: {
+    /**
+     * The type of the object.
+     */
+    objectType: 'CommercialArticle';
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The browser navigation that got the user to the current page.
+     */
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll' | 'Swipe' | 'DeepLink' | 'Push';
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

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

@@ -0,0 +1,115 @@
+/* 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';
+
+/**
+ * An ad creative that has become viewable to the user for a previously requested ad opportunity.
+ */
+export interface IImpressionAd {
+  /**
+   * 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: {
+    /**
+     * Commercial ad format identifier.
+     * @example "Topboard"
+     */
+    adFormat?: string;
+    /**
+     * Creative identifier.
+     * @example "cr-ab12cd"
+     */
+    creativeId?: string;
+    /**
+     * Channel of demand.
+     * @example "direct"
+     */
+    demandChannel?: string;
+    /**
+     * Type of creative.
+     * @example "banner"
+     */
+    mediaType?: string;
+    /**
+     * The unique ID for this component.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN for this component.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'Ad';
+    /**
+     * ID for a single ad opportunity in a placement on a page view, shared across all related ad lifecycle events.
+     * @example "opp-12345"
+     */
+    opportunityId?: string;
+    /**
+     * Source system to render the ad.
+     * @example "microsoft"
+     */
+    platform: string;
+    /**
+     * Creative size.
+     * @example "320x250"
+     */
+    size?: string;
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement: {
+    /**
+     * Placement identifier (string).
+     * @example "adserver-placement-id"
+     */
+    placementId: string;
+  };
+  provider: IProvider;
+  /**
+   * URL to the JSON schema for this event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}