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

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

@@ -0,0 +1,119 @@
+/* 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 { 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';
+
+/**
+ * A generic event to track when a user views a health-related page on a website or app. Only used by the Vektklubb/Wellobe projects.
+ */
+export interface IViewHealthPage {
+  /**
+   * 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;
+  /**
+   * Information about the health page being viewed.
+   */
+  object: {
+    /**
+     * Used to pass the same information across events
+     * @example "breakfast"
+     */
+    category?: string;
+    /**
+     * Freeform custom properties with dynamic field names for health-specific data
+     * @additionalProperties true
+     */
+    custom?: {
+      [k: string]: unknown;
+    };
+    food?: IHealthFood;
+    /**
+     * The name of page
+     * @example "Logbook"
+     */
+    name: string;
+    /**
+     * The unique ID of this health page
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this health page
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'HealthPage';
+    physicalActivity?: IHealthPhysicalActivity;
+    /**
+     * Tags associated with this health page.
+     */
+    tags?: string[];
+    /**
+     * The title of the health page
+     * @example "Be well med Wellobe: Vecka 4"
+     */
+    title?: string;
+    training?: IHealthTraining;
+  };
+  origin?: IHealthOrigin;
+  /**
+   * Page navigation and referrer information
+   */
+  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;
+  userHealthData?: IHealthUserData;
+}

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

@@ -0,0 +1,76 @@
+/* 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';
+
+/**
+ * Prompt a specific action.
+ */
+export interface IViewLandingpage {
+  /**
+   * 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 unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of this page.
+     */
+    objectType: 'Landingpage';
+    /**
+     * 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/IViewListing.d.ts

@@ -0,0 +1,118 @@
+/* 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';
+
+/**
+ * Show a collection of content.
+ */
+export interface IViewListing {
+  /**
+   * 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;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The location of the page in the brand’s page hierarchy.
+     * @pattern ^[a-z0-9-]+(>[a-z0-9-]+)*$
+     */
+    category?: string;
+    /**
+     * The engine producing this listing. Use “editorial” for manually curated lists.
+     */
+    contentSource: 'Capi' | 'Curate' | 'ElasticSearch' | 'Editorial' | 'Other';
+    /**
+     * Filters applied to the listing.
+     */
+    filters?: string[];
+    /**
+     * True if list is populated indefinitely (doomscroll).
+     */
+    isInfinite: boolean;
+    /**
+     * The total number of items in the listing, or -1 if unknown.
+     * @minimum -1
+     */
+    itemsTotal: number;
+    /**
+     * The type of listing page, e.g. 'tag', 'section' etc.
+     */
+    listingType: 'Tag' | 'Story' | 'Section' | 'Search' | 'Author' | 'Other';
+    /**
+     * The unique ID of this page.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN of this page.
+     */
+    objectSdrn: string;
+    /**
+     * The type of this page.
+     */
+    objectType: 'Listing';
+    /**
+     * Current pagination index. Zero if results are not paged.
+     * @minimum 0
+     */
+    pageNumber: number;
+    /**
+     * The search query used by the user, if the listing page supports search.
+     * @example "risotto"
+     */
+    searchQuery?: string;
+    /**
+     * Indicates how results are sorted. Use “editorial” for manually curated lists.
+     */
+    sortingMethod: 'Time' | 'Editorial' | 'Relevance' | 'Alphabetical' | 'Other';
+    /**
+     * 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/IViewLockedArticle.d.ts

@@ -0,0 +1,139 @@
+/* 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 { 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 preventing the user from accessing article content.
+ */
+export interface IViewLockedArticle {
+  /**
+   * 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: 'LockedArticle';
+    /**
+     * 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';
+    /**
+     * The publication date of the article.
+     * @format date-time
+     */
+    publicationDate: string;
+    /**
+     * The name of the company that sponsored the article. Omitted 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/IViewLockedAudioPage.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 audio content.
+ */
+export interface IViewLockedAudioPage {
+  /**
+   * 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 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/IViewLockedPage.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 generic pageview event.
+ */
+export interface IViewLockedPage {
+  /**
+   * 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: '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;
+}