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

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

@@ -0,0 +1,97 @@
+/* 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 { 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 leaving a page preventing them from accessing premium audio content.
+ */
+export interface ILeaveLockedAudioPage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     */
+    category: string;
+    /**
+     * True if 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 object.
+     */
+    objectType: 'LockedAudioPage';
+    /**
+     * 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/ILeaveLockedPage.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 { 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 leaving a page preventing them from accessing a premium generic page.
+ */
+export interface ILeaveLockedPage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     */
+    category?: string;
+    objectId: string;
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'LockedPage';
+    /**
+     * Indicator if the offer was visible at pageload (“above”) or if the user had to scroll to it (“below”).
+     */
+    offerFoldPosition: 'Above' | 'Below' | 'Unknown';
+    /**
+     * The reason the user saw this paywall instead of the content.
+     */
+    paywallType: 'Paid' | 'Metered' | 'Login' | 'Free' | 'Dynamic';
+    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/ILeaveLockedVideoPage.d.ts

@@ -0,0 +1,97 @@
+/* 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 { 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 leaving a page preventing them from accessing premium video content.
+ */
+export interface ILeaveLockedVideoPage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  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/ILeavePage.d.ts

@@ -0,0 +1,82 @@
+/* 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';
+
+/**
+ * An event tracking the user exiting a generic page.
+ */
+export interface ILeavePage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     */
+    category?: string;
+    objectId: string;
+    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/ILeaveSchoolPage.d.ts

@@ -0,0 +1,84 @@
+/* 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 { 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';
+
+/**
+ * An event tracking the user exiting a generic page.
+ */
+export interface ILeaveSchoolPage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     */
+    category?: string;
+    objectId: string;
+    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/ILeaveSportsPage.d.ts

@@ -0,0 +1,137 @@
+/* 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 { 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';
+
+/**
+ * An event tracking the user leaving a sports page.
+ */
+export interface ILeaveSportsPage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  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/ILeaveVideoPage.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 { IExperiments } from '../templates/IExperiments.d.ts';
+import type { ILeave } from '../templates/ILeave.d.ts';
+import type { ILeaveStories } from '../templates/ILeaveStories.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 leaving a video page.
+ */
+export interface ILeaveVideoPage {
+  /**
+   * 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: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  leaveStories?: ILeaveStories;
+  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;
+}