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

package/dist/types/tpaas-schemas/types/schemas/IImpressionSchoolUIElement.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 { 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 interactive element within a component or page, e.g., a button, link, or form field on Aftenposten Skole/JuniorSkole
+ */
+export interface IImpressionSchoolUIElement {
+  /**
+   * 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';
+    /**
+     * The text of the element.
+     */
+    elementText?: string;
+    /**
+     * The type of UIElement (div, span, a, …).
+     */
+    elementType: string;
+    /**
+     * 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: 'SchoolUIElement';
+    school?: ISchool;
+    /**
+     * The name of the company that sponsored the UIElement. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
+  };
+  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/IImpressionSportsUIElement.d.ts

@@ -0,0 +1,159 @@
+/* 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 { ISports } from '../templates/ISports.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 interactive sports element within a component or page, e.g., a button, link, or form field.
+ */
+export interface IImpressionSportsUIElement {
+  /**
+   * 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';
+    /**
+     * The text of the element.
+     */
+    elementText?: string;
+    /**
+     * The type of UIElement (div, span, a, …).
+     */
+    elementType: string;
+    /**
+     * 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: 'SportsUIElement';
+    /**
+     * The name of the company that sponsored the UIElement. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
+    /**
+     * Name of the sport.
+     */
+    sportName: string;
+    sports?: ISports;
+  };
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    /**
+     * 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;
+    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/IImpressionTeaser.d.ts

@@ -0,0 +1,112 @@
+/* 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 { 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 widget promoting content.
+ */
+export interface IImpressionTeaser {
+  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;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The engine producing this teaser. Use “editorial” for manually curated item.
+     */
+    contentSource: 'Capi' | 'Curate' | 'ElasticSearch' | 'Editorial' | 'Stream';
+    /**
+     * The creative of the teaser.
+     */
+    creativeURL?: string;
+    /**
+     * The size of the component.
+     */
+    elementSize?: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * The URL to the teaser image.
+     * @example "https://akamai.vgc.no/v2/images/bf0b043a-beb4-382a-be20-89bba60bdc44?fit=crop&format=auto&w=1440&s=183a09a7662535f456fa261fb7cc4f8af6a55aa1"
+     */
+    imageUrl?: string;
+    /**
+     * 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: 'Teaser';
+    /**
+     * The name of the company that sponsored the UIElement. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
+    /**
+     * The title of the teaser.
+     */
+    title: string;
+  };
+  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;
+  target: {
+    content?: IContent;
+    info: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

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

@@ -0,0 +1,107 @@
+/* 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 interactive element within a component or page, e.g., a button, link, or form field.
+ */
+export interface IImpressionUIElement {
+  /**
+   * 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';
+    /**
+     * The text of the element.
+     */
+    elementText?: string;
+    /**
+     * The type of UIElement (div, span, a, …).
+     */
+    elementType: string;
+    /**
+     * 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: 'UIElement';
+    /**
+     * The name of the company that sponsored the UIElement. Omitted if it was not sponsored.
+     */
+    sponsor?: string;
+  };
+  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/IImpressionWidget.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 reusable component on a page.
+ */
+export interface IImpressionWidget {
+  /**
+   * 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 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: 'Widget';
+  };
+  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;
+  target?: {
+    content?: IContent;
+    info?: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+}

package/dist/types/tpaas-schemas/types/schemas/ILeaveArticle.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 { 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 an article page.
+ */
+export interface ILeaveArticle {
+  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 page.
+   */
+  eventType: 'Leave';
+  experiments?: IExperiments;
+  leave: ILeave;
+  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;
+}