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

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

@@ -0,0 +1,95 @@
+/* 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 preventing the user from accessing premium video content.
+ */
+export interface IViewLockedVideoPage {
+  /**
+   * 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;
+    /**
+     * True if the content is accessible to the user.
+     */
+    isAccessible: boolean;
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the page.
+     */
+    objectType: 'LockedVideoPage';
+    /**
+     * The reason the user saw this paywall instead of the content.
+     */
+    paywallType: 'Paid' | 'Metered' | 'Login' | 'Free' | 'Dynamic';
+    /**
+     * 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/IViewPage.d.ts

@@ -0,0 +1,86 @@
+/* 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 { 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 generic pageview event.
+ */
+export interface IViewPage {
+  /**
+   * 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;
+  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 this page.
+     */
+    objectType: 'Page';
+    tags?: string[];
+    /**
+     * 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';
+    /**
+     * 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/IViewSchoolPage.d.ts

@@ -0,0 +1,88 @@
+/* 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 { IMetrics } from '../templates/IMetrics.d.ts';
+import type { IPageRef } from '../templates/IPageRef.d.ts';
+import type { IProvider } from '../templates/IProvider.d.ts';
+import type { ISchool } from '../templates/ISchool.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 pageview event for Aftenposten Skole/JuniorSkole.
+ */
+export interface IViewSchoolPage {
+  /**
+   * 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: 'SchoolPage';
+    school?: ISchool;
+    tags?: string[];
+    /**
+     * 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';
+    /**
+     * 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/IViewSportsPage.d.ts

@@ -0,0 +1,135 @@
+/* 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 { 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 { ISports } from '../templates/ISports.d.ts';
+import type { ISportsUserFeatures } from '../templates/ISportsUserFeatures.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 sports pageview event.
+ */
+export interface IViewSportsPage {
+  /**
+   * 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: 'SportsPage';
+    /**
+     * Name of the sport.
+     */
+    sportName: string;
+    /**
+     * Subview (feature) within the sportView.
+     */
+    sportSubview?:
+      | 'Schedule'
+      | 'Info'
+      | 'Tournaments'
+      | 'Season'
+      | 'Lineups'
+      | 'Person'
+      | 'Team'
+      | 'Report'
+      | 'Standings'
+      | 'Statistics'
+      | 'CupTree'
+      | 'MedalTable'
+      | 'UserProfile'
+      | 'PredictionsGame'
+      | 'Overview'
+      | 'Squad'
+      | 'Rankings'
+      | 'Ratings'
+      | 'Liveblog'
+      | 'News'
+      | 'Leagues'
+      | 'League'
+      | 'Profile';
+    /**
+     * View type within sports.
+     */
+    sportView:
+      | 'Person'
+      | 'Tournament'
+      | 'Season'
+      | 'UserProfile'
+      | 'PredictionsGame'
+      | 'Schedule'
+      | 'Event'
+      | 'Team'
+      | 'Tournaments'
+      | 'Studio';
+    sports?: ISports;
+    tags?: string[];
+    /**
+     * 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';
+    /**
+     * 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;
+  userFeatures?: ISportsUserFeatures;
+}

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

@@ -0,0 +1,92 @@
+/* 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 { 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 showing summary information about a TV series, streaming show, or sport event. (Note: currently only used by TVnu.)
+ */
+export interface IViewTitle {
+  /**
+   * 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;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The editorial category of this title.
+     */
+    category: string;
+    linearChannel?: string[];
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of this page.
+     */
+    objectType: 'Title';
+    playProvider?: string[];
+    /**
+     * The name of the company that sponsored the title. Omitted if the title was not sponsored.
+     */
+    sponsor?: string;
+    tags: string[];
+    /**
+     * 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';
+    /**
+     * 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/IViewVideoPage.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 video content.
+ */
+export interface IViewVideoPage {
+  /**
+   * 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: 'VideoPage';
+    /**
+     * 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/IViewWeather.d.ts

@@ -0,0 +1,94 @@
+/* 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 { 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 showing a weather forecast.
+ */
+export interface IViewWeather {
+  /**
+   * 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;
+  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 this page.
+     */
+    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;
+}