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

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

@@ -0,0 +1,139 @@
+/* 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 { IHealthFood } from '../templates/IHealthFood.d.ts';
+import type { IHealthOrigin } from '../templates/IHealthOrigin.d.ts';
+import type { IHealthPhysicalActivity } from '../templates/IHealthPhysicalActivity.d.ts';
+import type { IHealthTraining } from '../templates/IHealthTraining.d.ts';
+import type { IHealthUserData } from '../templates/IHealthUserData.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';
+
+/**
+ * Tracking when a user completes health-related actions within a health application. This includes both simple actions (logged food, scanned barcode) and complex multi-step processes (started new program, achieved goals). Only used by Vektklubb/Wellobe.
+ */
+export interface ICompletedHealthAction {
+  /**
+   * 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: 'Completed';
+  experiments?: IExperiments;
+  metrics?: IMetrics;
+  /**
+   * Information about the health action that was completed.
+   */
+  object: {
+    /**
+     * The specific type of health action that was completed.
+     */
+    actionType:
+      | 'Logged'
+      | 'Scanned'
+      | 'Started'
+      | 'SetFilters'
+      | 'Added'
+      | 'Removed'
+      | 'Completed'
+      | 'Achieved'
+      | 'Saved'
+      | 'Deleted'
+      | 'Updated'
+      | 'Shared';
+    /**
+     * The health category this action relates to.
+     * @example "nutrition"
+     */
+    category?: string;
+    /**
+     * Freeform custom properties with dynamic field names for health-specific action data.
+     * @additionalProperties true
+     */
+    custom?: {
+      [k: string]: unknown;
+    };
+    food?: IHealthFood;
+    /**
+     * The descriptive name of the action that was completed.
+     * @example "Logged breakfast meal"
+     */
+    name?: string;
+    /**
+     * The unique ID of this health action.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this health action.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'HealthAction';
+    physicalActivity?: IHealthPhysicalActivity;
+    /**
+     * Tags associated with this health action.
+     */
+    tags?: string[];
+    /**
+     * The title of the completion message or confirmation shown to the user.
+     * @example "Barcode scanned successfully"
+     */
+    title?: string;
+    training?: IHealthTraining;
+  };
+  origin?: IHealthOrigin;
+  /**
+   * Page context where the action was completed (not applicable for background actions).
+   */
+  page?: {
+    info: IPageRef;
+    /**
+     * The pageviewID of the page where the action occurred.
+     * @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;
+  /**
+   * Information about what this action affects or relates to.
+   */
+  target?: {
+    content?: IContent;
+    info?: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+  userHealthData?: IHealthUserData;
+}

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

@@ -0,0 +1,117 @@
+/* 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';
+
+/**
+ * A user click interaction with an ad creative for a previously requested ad opportunity.
+ */
+export interface IEngagementAd {
+  /**
+   * 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: {
+    /**
+     * 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;
+}

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

@@ -0,0 +1,144 @@
+/* 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 { 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 {
+  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;
+  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: {
+    /**
+     * Count how many options users had to choose from when clicking on an affiliate.
+     */
+    containerItemCount?: number;
+    /**
+     * 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 1
+     */
+    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

@@ -0,0 +1,213 @@
+/* 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 { 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';
+
+/**
+ * Audio usage and heartbeats.
+ */
+export interface IEngagementAudio {
+  /**
+   * 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 audio
+   */
+  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' | 'Fullscreen' | 'Minimized';
+    /**
+     * True if the audio is muted
+     */
+    isMuted: boolean;
+    /**
+     * Identifies the entry path that led to the playback. Examples include direct playback, next 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' | 'Scroll' | 'None';
+    /**
+     * Indicates how the audio 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 audio in milliseconds
+     */
+    positionMs: number;
+    /**
+     * The playback position in the audio 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 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: {
+    /**
+     * The editorial category of this audio
+     */
+    category: string;
+    /**
+     * The total duration of the audio 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;
+    /**
+     * Audio thumbnail from Stream to use in (Kilkaya) dashboards
+     */
+    imageUrl?: string;
+    /**
+     * The name of the audio.
+     */
+    name: string;
+    /**
+     * The unique ID for this audio.
+     */
+    objectId: string;
+    /**
+     * The Stream newsroom and provider where the audio is published
+     */
+    objectNamespace: string;
+    /**
+     * The unique SDRN for this audio.
+     */
+    objectSdrn: string;
+    objectType: 'Audio';
+    /**
+     * Indicates how the audio 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 unique ID for this audio when published in PodMe.
+     */
+    podmeId?: string;
+    /**
+     * The position of the audio in the playlist.
+     * @minimum 0
+     */
+    queuePosition?: number;
+    /**
+     * Indicates the type of queue or playlist the audio 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 audio. 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;
+}