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

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

@@ -0,0 +1,111 @@
+/* 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 form component.
+ */
+export interface IEngagementForm {
+  /**
+   * 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';
+    fields?: {
+      /**
+       * The default value of the field.
+       */
+      default?: string;
+      /**
+       * The data type of the field.
+       */
+      fieldType: string;
+      /**
+       * The name of the field.
+       */
+      name: string;
+      /**
+       * True if the field is required.
+       */
+      required: boolean;
+    }[];
+    /**
+     * 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: 'Form';
+  };
+  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;
+}

package/dist/types/tpaas-schemas/types/schemas/IEngagementHealthUIElement.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 { 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';
+
+/**
+ * Tracking user interactions with UI elements within health applications. This includes clicks, scrolls, drags and other user engagement actions with buttons, items, content cards, and other interactive elements. Only used by the Vektklubb/Wellobe projects.
+ */
+export interface IEngagementHealthUIElement {
+  /**
+   * 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;
+  metrics?: IMetrics;
+  /**
+   * Information about the UI element being interacted with.
+   */
+  object: {
+    /**
+     * The health category this UI element relates to.
+     * @example "breakfast"
+     */
+    category?: string;
+    /**
+     * Freeform custom properties with dynamic field names for health-specific UI engagement data.
+     * @additionalProperties true
+     */
+    custom?: {
+      [k: string]: unknown;
+    };
+    /**
+     * The size of the UI element.
+     */
+    elementSize: 'XS' | 'S' | 'M' | 'L' | 'XL';
+    /**
+     * The text content of the UI element.
+     * @example "Scan Barcode"
+     */
+    elementText?: string;
+    food?: IHealthFood;
+    /**
+     * The name of the UI element.
+     * @example "Grilled Chicken Recipe"
+     */
+    name: string;
+    /**
+     * The unique ID for this UI element.
+     */
+    objectId: string;
+    /**
+     * The unique SDRN for this UI element.
+     */
+    objectSdrn: string;
+    /**
+     * The type of the object.
+     */
+    objectType: 'HealthUIElement';
+    physicalActivity?: IHealthPhysicalActivity;
+    training?: IHealthTraining;
+  };
+  origin?: IHealthOrigin;
+  /**
+   * Page context where the UI interaction occurred.
+   */
+  page: {
+    content?: IContent;
+    info: IPageRef;
+    /**
+     * The pageviewID of the parent page.
+     * @format uuid
+     */
+    pageviewId: string;
+    referrer?: IPageRef;
+    utm?: IUtmTags;
+  };
+  placement: {
+    /**
+     * The closest parent container used for traffic attribution.
+     * @example "recipes"
+     */
+    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;
+  /**
+   * Information about what this UI interaction leads to or affects.
+   */
+  target?: {
+    content?: IContent;
+    info?: IPageRef;
+  };
+  time: ITime;
+  tracker: ITracker;
+  user?: IUser;
+  userHealthData?: IHealthUserData;
+}

package/dist/types/tpaas-schemas/types/schemas/IEngagementOffer.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 { 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 an offer event.
+ */
+export interface IEngagementOffer {
+  /**
+   * 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 campaign associated with this offer.
+     * @example "summer-sale"
+     */
+    campaign: string;
+    /**
+     * 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 component.
+     */
+    objectType: 'Offer';
+    offerCodes?: string[];
+    /**
+     * The variant/layout of the offer.
+     */
+    offerType?: 'Login' | 'Meter' | 'Paid';
+  };
+  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;
+    /**
+     * The position where this offer was placed.
+     */
+    offerPlacement: 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;
+}

package/dist/types/tpaas-schemas/types/schemas/IEngagementSchoolUIElement.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 { 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 { 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';
+
+/**
+ * Interaction with a UIElement for Aftenposten Skole/JuniorSkole.
+ */
+export interface IEngagementSchoolUIElement {
+  /**
+   * 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;
+    /**
+     * 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;
+  };
+  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/IEngagementSportsUIElement.d.ts

@@ -0,0 +1,157 @@
+/* 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 { 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';
+
+/**
+ * Interaction with a sports UIElement.
+ */
+export interface IEngagementSportsUIElement {
+  /**
+   * 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;
+    /**
+     * 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;
+  };
+  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;
+}