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

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

@@ -0,0 +1,89 @@
+/* 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 { 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';
+
+/**
+ * A space where an advertisement can be served.
+ */
+export interface IImpressionAdSlot {
+  /**
+   * 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;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * Ad product name used by SMS.
+     */
+    adFormat: string;
+    /**
+     * 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 object.
+     */
+    objectType: 'AdSlot';
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement?: IPlacement;
+  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/IImpressionAffiliate.d.ts

@@ -0,0 +1,142 @@
+/* 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 { 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 {
+  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: '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: {
+    /**
+     * Count how many options users had to choose from when viewing 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/IImpressionForm.d.ts

@@ -0,0 +1,113 @@
+/* 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';
+
+/**
+ * A form field to collect declared data.
+ */
+export interface IImpressionForm {
+  /**
+   * 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: {
+    /**
+     * The size of the component.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    fields: {
+      /**
+       * The default value of the field.
+       */
+      default?: string;
+      /**
+       * The data type of the field.
+       */
+      fieldType: 'String' | 'Number' | 'Boolean';
+      /**
+       * The name of the field.
+       */
+      name: string;
+      /**
+       * True if the field is required.
+       */
+      required: 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: 'Form';
+  };
+  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;
+    /**
+     * Indicator if the widget was visible at pageload (“above”) or if the user had to scroll to it (“below”).
+     */
+    foldPosition: 'Above' | 'Below' | 'Unknown';
+  };
+  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/IImpressionHealthUIElement.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 { 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';
+
+/**
+ * An event to track when a user views specific health-related content ui elements such as popups, modals, tooltips, educational ui content, or interactive health components within a page or app. Only used by the Vektklubb/Wellobe projects.
+ */
+export interface IImpressionHealthUIElement {
+  /**
+   * 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;
+  metrics?: IMetrics;
+  /**
+   * Information about the specific health content element being viewed
+   */
+  object: {
+    /**
+     * The health category this content relates to.
+     * @example "breakfast"
+     */
+    category?: string;
+    /**
+     * The specific type of health content being viewed.
+     * @example "modal"
+     */
+    contentType: string;
+    /**
+     * Freeform custom properties with dynamic field names for health-specific data.
+     * @additionalProperties true
+     */
+    custom?: {
+      [k: string]: unknown;
+    };
+    /**
+     * The size of the content element.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    food?: IHealthFood;
+    /**
+     * The name/title of the health content element.
+     * @example "Question quiz"
+     */
+    name: string;
+    /**
+     * The unique ID of this health content element.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this health content element.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'HealthUIElement';
+    physicalActivity?: IHealthPhysicalActivity;
+    /**
+     * Tags associated with this health content.
+     */
+    tags?: string[];
+    training?: IHealthTraining;
+  };
+  origin?: IHealthOrigin;
+  /**
+   * Page navigation and referrer information.
+   */
+  page: {
+    info: IPageRef;
+    /**
+     * The pageviewID of the parent page.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement?: {
+    /**
+     * The parent container or page section where this content appears.
+     * @example "Logbook"
+     */
+    containerName?: string;
+    /**
+     * Position relative to the fold or if it's an overlay element.
+     */
+    foldPosition?: 'Above' | 'Below' | 'Overlay' | 'Unknown';
+  };
+  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 content element links to or relates to.
+   */
+  target?: {
+    content?: IContent;
+    info?: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+  userHealthData?: IHealthUserData;
+}

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

@@ -0,0 +1,109 @@
+/* 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';
+
+/**
+ * A widget asking the user to buy a subscription, often with some discount or other perks.
+ */
+export interface IImpressionOffer {
+  /**
+   * 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: {
+    /**
+     * The campaign associated with this offer.
+     * @example "summer-sale"
+     */
+    campaign: string;
+    /**
+     * 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 object.
+     */
+    objectType: 'Offer';
+    offerCodes: string[];
+    /**
+     * The variant/layout of the offer.
+     */
+    offerType?: 'Login' | 'Meter' | 'Paid';
+  };
+  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;
+    /**
+     * Indicator if the widget was visible at pageload (“above”) or if the user had to scroll to it (“below”).
+     */
+    foldPosition: 'Above' | 'Below' | 'Unknown';
+    /**
+     * The position where this offer was placed.
+     */
+    offerPlacement: 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/IImpressionPlayer.d.ts

@@ -0,0 +1,108 @@
+/* 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';
+
+/**
+ * A component used for video and audio/TTS playbacks with metadata about the player.
+ */
+export interface IImpressionPlayer {
+  /**
+   * 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;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The size of the player.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * The unique ID of the embedded mediaAsset (not ads from Xandr) ready to play in the player.
+     */
+    mediaAssetId: string;
+    /**
+     * The name of the embedded asset (not ads from Xandr). Fallback is -1 when name is not available.
+     */
+    mediaAssetName: string;
+    /**
+     * The unique SDRN of the embedded mediaAsset (not ads from Xandr) ready to play in the player.
+     */
+    mediaAssetSdrn: string;
+    /**
+     * The unique SDRN for this player.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'Player';
+    /**
+     * The type of player exposed to the user.
+     */
+    player: 'VideoPlayer' | 'StoriesPlayer' | 'AudioPlayer' | 'TtsPlayer';
+    /**
+     * The type of player engine exposed to the user.
+     */
+    playerEngine: 'WebPlayer' | 'AppPlayer';
+    /**
+     * A unique ID for this player instance.
+     */
+    playerId: string;
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  /**
+   * It describes where the teaser is shown on the page and in what structural context at the moment the engagement event was fired.
+   */
+  placement?: {
+    /**
+     * Indicator if the player was visible at pageload (“above”) or if the user had to scroll to it (“below”).
+     */
+    foldPosition: 'Above' | 'Below' | 'Unknown';
+  };
+  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;
+}