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

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

@@ -0,0 +1,96 @@
+/* eslint-disable */
+
+import type { IConsents } from '../templates/IConsents.d.ts';
+import type { IDevice } from '../templates/IDevice.d.ts';
+import type { IExperiments } from '../templates/IExperiments.d.ts';
+import type { ILeave } from '../templates/ILeave.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 user navigating away from a weather page.
+ */
+export interface ILeaveWeather {
+  /**
+   * 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;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The editorial category of this forecast.
+     */
+    category?: string;
+    /**
+     * The country within which the forecast is done.
+     */
+    country: string;
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the schema.
+     */
+    objectType: 'Weather';
+    /**
+     * The location within the region covered by this forecast.
+     */
+    place?: string;
+    /**
+     * The region covered by the forecast.
+     */
+    region: string;
+    tags?: string[];
+  };
+  page: {
+    info: IPageRef;
+    /**
+     * The browser navigation that got the user to the current page.
+     */
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender';
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  provider: IProvider;
+  /**
+   * The schema of the 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/ILoadAd.d.ts

@@ -0,0 +1,119 @@
+/* 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 being loaded/rendered for a previously requested ad opportunity.
+ */
+export interface ILoadAd {
+  /**
+   * 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: 'Load';
+  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;
+    /**
+     * Load time in ms.
+     */
+    loadTimeMs?: 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/IViewArticle.d.ts

@@ -0,0 +1,133 @@
+/* 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 { ILocation } from '../templates/ILocation.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 page dedicated to presenting an article.
+ */
+export interface IViewArticle {
+  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;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'View';
+  experiments?: IExperiments;
+  location?: ILocation;
+  metrics?: IMetrics;
+  object: {
+    authors: string[];
+    /**
+     * The editorial category of this article.
+     */
+    category: string;
+    /**
+     * True if scrolling up/down transitions to the next or previous article.
+     */
+    isStacked: boolean;
+    /**
+     * The publication date of this version of the article.
+     * @format date-time
+     */
+    lastUpdatedDate: string;
+    /**
+     * The newsroom that published the article.
+     * @example "vg"
+     */
+    newsroom: string;
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of this page.
+     */
+    objectType: 'Article';
+    /**
+     * The publication date of the article.
+     * @format date-time
+     */
+    publicationDate: string;
+    /**
+     * The name of the company that sponsored the article. Empty if the article was not sponsored.
+     */
+    sponsor?: string;
+    /**
+     * The title of the page.
+     */
+    title: string;
+    /**
+     * Url of the article top or when missing article main image.
+     */
+    topImageUrl?: string;
+    /**
+     * The type of article.
+     */
+    variant: 'Article' | 'LiveArticle' | 'Special';
+    /**
+     * The version counter of the article.
+     * @minimum 0
+     */
+    versionCounter: number;
+    /**
+     * The number of words in this version of the article.
+     * @exclusiveMinimum 0
+     */
+    wordCount: number;
+  };
+  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;
+  /**
+   * The schema of the 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/IViewAudioPage.d.ts

@@ -0,0 +1,87 @@
+/* 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 page allowing the user to access audio content.
+ */
+export interface IViewAudioPage {
+  /**
+   * 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: 'View';
+  experiments?: IExperiments;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     */
+    category: string;
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'AudioPage';
+    /**
+     * The title of the page.
+     */
+    title: string;
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The browser navigation that got the user to the current page.
+     */
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | '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/IViewError.d.ts

@@ -0,0 +1,90 @@
+/* eslint-disable */
+
+import type { IConsents } from '../templates/IConsents.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 error page.
+ */
+export interface IViewError {
+  /**
+   * 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;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  eventType: 'View';
+  experiments?: IExperiments;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     */
+    category?: string;
+    /**
+     * The response code of the page.
+     * @example 418
+     */
+    errorCode: number;
+    /**
+     * The error message.
+     * @example "I'm a teapot"
+     */
+    errorMessage: string;
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of this page.
+     */
+    objectType: 'Error';
+    /**
+     * The title of the page.
+     */
+    title: string;
+  };
+  page: {
+    info: IPageRef;
+    /**
+     * The browser navigation that got the user to the current page.
+     */
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'Scroll';
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  provider: IProvider;
+  /**
+   * The schema of the 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/IViewFrontpage.d.ts

@@ -0,0 +1,80 @@
+/* eslint-disable */
+
+import type { IConsents } from '../templates/IConsents.d.ts';
+import type { IDevice } from '../templates/IDevice.d.ts';
+import type { IExperiments } from '../templates/IExperiments.d.ts';
+import type { ILocation } from '../templates/ILocation.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';
+
+export interface IViewFrontpage {
+  /**
+   * 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;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of event.
+   */
+  eventType: 'View';
+  experiments?: IExperiments;
+  location?: ILocation;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The unique ID of this page
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page
+     */
+    objectSdrn: string;
+    /**
+     * The type of this page.
+     */
+    objectType: 'Frontpage';
+    /**
+     * The title of the page.
+     */
+    title: string;
+  };
+  page: {
+    info: IPageRef;
+    /**
+     * The browser navigation that got the user to the current page.
+     */
+    navigationType: 'Navigate' | 'Reload' | 'BackForward' | 'Prerender' | 'DeepLink' | 'Push';
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  provider: IProvider;
+  /**
+   * The schema of the event.
+   * @format uri
+   * @pattern ^https://tpaas-schemas.schibsted.media/.+\.json$
+   */
+  schema: string;
+  session: ISession;
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}