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

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

@@ -0,0 +1,114 @@
+/* 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 { IEngagement } from '../templates/IEngagement.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';
+
+/**
+ * An interaction with a teaser component.
+ */
+export interface IEngagementTeaser {
+  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;
+  engagement: IEngagement;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of event.
+   */
+  eventType: 'Engagement';
+  experiments?: IExperiments;
+  metrics?: IMetrics;
+  object: {
+    /**
+     * The engine producing this teaser. Use “Editorial” for manually curated item.
+     */
+    contentSource: 'Capi' | 'Curate' | 'ElasticSearch' | 'Editorial' | 'Stream' | 'Other';
+    /**
+     * 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 component.
+     */
+    objectType: 'Teaser';
+    /**
+     * The name of the company that sponsored the Teaser. 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;
+  /**
+   * The schema of the 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/IEngagementTvModule.d.ts

@@ -0,0 +1,133 @@
+/* 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 { IEngagement } from '../templates/IEngagement.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';
+
+/**
+ * Interaction with a TvModule element. (Note: currently only used by TVnu.)
+ */
+export interface IEngagementTvModule {
+  /**
+   * 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;
+  engagement: IEngagement;
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Engagement';
+  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;
+    /**
+     * Action taken on the module: Add module, remove module, change placement of module, etc.
+     * @example "moveTop"
+     */
+    moduleAction?: string;
+    /**
+     * Content interacted with in the module: Article teaser text, Title, List Name.
+     * @example "Ted Lasso"
+     */
+    moduleContent?: string;
+    /**
+     * Text set as header (or title) for the module.
+     * @example "Fotbolls-VM"
+     */
+    moduleHeader: string;
+    /**
+     * Type of TV module users interact with.
+     * @example "Editorial"
+     */
+    moduleType:
+      | 'Channel'
+      | 'Sport'
+      | 'PlayProvider'
+      | 'Editorial'
+      | 'ProgramList'
+      | 'SportListing'
+      | 'PremiereCalendar'
+      | 'UserCalendar'
+      | 'TrailerList'
+      | 'PlayListSet'
+      | 'PlayListFiltered'
+      | 'PlayUserFiltered';
+    /**
+     * 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: 'TvModule';
+  };
+  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;
+  };
+  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/IEngagementTvSearch.d.ts

@@ -0,0 +1,142 @@
+/* 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';
+
+/**
+ * Interaction with a tv.nu search functionality.
+ */
+export interface IEngagementTvSearch {
+  /**
+   * 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;
+  engagement: {
+    /**
+     * The action the user is performing.
+     */
+    action: 'Search' | 'ClickResult';
+    /**
+     * The name of the UIElement being interacted with.
+     */
+    elementName: string;
+  };
+  /**
+   * The unique identifier for the event.
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of the event.
+   */
+  eventType: 'Engagement';
+  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: 'TvSearch';
+    /**
+     * The clicked result.
+     */
+    result?: {
+      /**
+       * The title of the clicked result.
+       */
+      searchItemTitle: string;
+      searchResult: {
+        resultId: string;
+        resultType: string;
+      };
+    };
+    /**
+     * UUID identifying the search.
+     * @format uuid
+     */
+    searchId: string;
+    /**
+     * The search query used by the user.
+     */
+    searchQuery: string;
+    /**
+     * Search results shown to the user.
+     */
+    searchResults: {
+      resultId: string;
+      resultType: string;
+    }[];
+    /**
+     * 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;
+  };
+  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/IEngagementUIElement.d.ts

@@ -0,0 +1,105 @@
+/* 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 { IEngagement } from '../templates/IEngagement.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';
+
+/**
+ * Interaction with a UIElement.
+ */
+export interface IEngagementUIElement {
+  /**
+   * 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;
+  engagement: IEngagement;
+  /**
+   * Event ID
+   * @format uuid
+   */
+  eventId: string;
+  /**
+   * The type of event.
+   */
+  eventType: 'Engagement';
+  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 component.
+     */
+    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;
+  };
+  provider: IProvider;
+  /**
+   * The schema of the 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;
+}