@glomex/integration-web-component 1.1312.4 → 1.1314.4

package/build/index.d.ts

@@ -9,6 +9,7 @@ export declare interface Ad {
     breakIndex: number;
     breakName: string;
     mimetype: string;
+    totalAds: number;
     nonLinearWidth?: number;
     nonLinearHeight?: number;
 }
@@ -30,6 +31,45 @@ export declare enum ComponentName {
     GLOMEX_MEDIA_ITEM = "glomex-media-item"
 }
 
+/**
+ * Describes the contract that an external API tracking script must implement so that it can be
+ * imported and executed by the integration. The API script must be hosted on the remote server
+ * with CORS enabled.
+ *
+ * @example
+ * ```ts
+ * import { IntegrationEvent } from '@glomex/integration';
+ * export const connectIntegration: ConnectIntegration = (
+ *   integration,
+ *   // userId will be undefined when no consent is given
+ *   { userCountryCode, userId, integrationEnvironment }
+ * ) => {
+ *   integration.addEventListener(IntegrationEvent.CONTENT_PLAY, () => {
+ *     console.log('play', integration.content);
+ *   });
+ * };
+ * ```
+ *
+ * @example
+ * ```js
+ * export const connectIntegration = (
+ *   integration,
+ *   // userId will be undefined when no consent is given
+ *   { userCountryCode, userId, integrationEnvironment }
+ * ) => {
+ *   const { IntegrationEvent } = integration.constructor;
+ *   integration.addEventListener(IntegrationEvent.CONTENT_PLAY, () => {
+ *     console.log('play', integration.content);
+ *   });
+ * };
+ * ```
+ */
+export declare type ConnectIntegration = (integration: IntegrationElement, context: {
+    userCountryCode?: string;
+    userId?: string;
+    integrationEnvironment?: string;
+}) => (() => void) | undefined;
+
 export declare interface Consent {
     gdprApplies: boolean;
     consentString?: string;
@@ -44,6 +84,18 @@ export declare interface Consent {
     addtlConsent?: string;
 }
 
+/**
+ * Selected source of the given content.
+ */
+declare interface ContentSource {
+    id: string;
+    mimetype: Mimetype;
+    src: string;
+    playbackMode: PlaybackMode;
+    entitlementToken?: string;
+    drm: boolean;
+}
+
 export declare interface CustomMarker {
     /** {@inheritDoc Marker.name} */
     name: string;
@@ -226,6 +278,7 @@ export declare function getIntegrationCssUrl(integrationId: string): string;
  * ```
  */
 export declare class GlomexMediaItemElement extends HTMLElement {
+    #private;
     /**
      * {@inheritDoc MediaItem#id}
      */
@@ -233,7 +286,7 @@ export declare class GlomexMediaItemElement extends HTMLElement {
     /**
      * Overridden poster of the media item.
      */
-    poster?: string;
+    poster: string;
     /**
      * Overridden title of the media item.
      */
@@ -242,11 +295,7 @@ export declare class GlomexMediaItemElement extends HTMLElement {
 
 export declare interface GlomexMediaItemWithOverrides {
     id: string;
-    overrides: {
-        title?: string;
-        poster?: string;
-        teaserVideo?: string;
-    };
+    overrides: Partial<Omit<MediaItem, 'id' | 'sources' | 'isExternal'>>;
 }
 
 /**
@@ -322,6 +371,10 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      * Pauses the current media playback.
      */
     pause(): void;
+    /**
+     * Snapshots current video frame.
+     */
+    getCurrentVideoFrame(): Promise<ImageBitmap>;
     /**
      * Returns the current playback time (in seconds) of the media.
      */
@@ -365,10 +418,18 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      * Returns `true` if the media playback is currently paused; otherwise, returns `false`.
      */
     get paused(): boolean;
+    /**
+     * Indicates whether the media playback has ended.
+     */
+    get ended(): boolean;
     /**
      * Indicates whether the media is currently in a seeking state.
      */
     get seeking(): boolean;
+    /**
+     * Indicates whether the media is currently in a buffering state.
+     */
+    get buffering(): boolean;
     /**
      * Retrieves the current presentation mode of the media player.
      * This mode may affect how the media is displayed.
@@ -418,6 +479,8 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
      * Retrieves details about the currently selected ad, if any.
      */
     get currentAd(): Ad | undefined;
+    /** Version of the integration */
+    get version(): string;
     /**
      * Sets the presentation mode of the media player to the specified mode. This mode affects how the integration gets displayed
      * (e.g. inline, dock, lightbox, fullscreen).
@@ -479,7 +542,10 @@ export declare interface IntegrationElementEventMap {
         mode: PresentationMode;
     }>;
     /** @eventProperty */
-    contentselect: CustomEvent<unknown>;
+    contentselect: CustomEvent<unknown & {
+        sessionId: string;
+        source: ContentSource;
+    }>;
     /** @eventProperty */
     contentstart: CustomEvent<unknown>;
     /** @eventProperty */
@@ -636,6 +702,11 @@ export declare interface IntegrationProperties {
      * Allows the publisher to provide an optional placement attribute, which supplies additional contextual information for enhanced analytics tracking.
      */
     placement?: string;
+    /**
+     * Allows the publisher to provide an optional ppid (publisher provided user id) attribute, which supplies additional contextual information for enhanced analytics tracking.
+     */
+    ppid?: string;
+    env?: 'stage' | 'local';
     variant?: string;
 }
 
@@ -698,6 +769,19 @@ export declare interface MediaItem {
      * Unique identifier of the media item.
      */
     id: string;
+    /**
+     * Additional ids that identify the media item in other systems
+     */
+    additionalIds?: {
+        joynId?: string;
+        joynMediaId?: string;
+        externalId?: string;
+    };
+    /**
+     * Whether the media item is external. This automatically gets set when an external media item is assigned.
+     * @ignore
+     */
+    isExternal?: boolean;
     /**
      * Poster image of the media item.
      */
@@ -833,15 +917,27 @@ export declare interface MediaItem {
     ageRatingDetails?: string[];
     /** Keywords of the media item */
     keywords?: string[];
-    /** Show id and name of the media item */
+    /** Show (often referred to as series, format or tv-show) the media item belongs to */
     show?: {
+        id?: string;
         name: string;
+        episodeNumber?: number;
+        seasonNumber?: number;
+    };
+    /** Competition the media item belongs to */
+    competition?: {
+        id?: string;
+        name?: string;
+    };
+    /** Compilation the media item belongs to */
+    compilation?: {
         id?: string;
+        name?: string;
     };
     /** Category id and name of the media item */
     category?: {
-        name: string;
         id?: string;
+        name: string;
     };
     /** Error information if the media item is not available upfront. */
     error?: MediaItemError;
@@ -869,7 +965,7 @@ export declare interface MediaItem {
         endTime?: number;
     };
     /**
-     * Only relevant for glomex-internal use.
+     * Only relevant for glomex-internal use. Mark it to allow teaser experiments.
      * @ignore
      */
     allowTeaserExperiments?: boolean;
@@ -880,26 +976,6 @@ export declare interface MediaItem {
      * @ignore
      */
     apiScriptUrl?: string;
-    /**
-     * An external episode identifier. Often the id the episode was imported from.
-     */
-    externalEpisodeId?: string;
-    /**
-     * An additional external show name. Often the name the show was imported from.
-     */
-    externalShowName?: string;
-    /**
-     * An additional external show identifier. Often the id the show was imported from.
-     */
-    externalShowId?: string;
-    /**
-     * An additional external channel name. Often the name the channel was imported from.
-     */
-    externalChannelName?: string;
-    /**
-     * Whether the media item is exclusive for the web.
-     */
-    isWebExclusive?: boolean;
 }
 
 /**
@@ -966,7 +1042,7 @@ declare interface MediaSourceBase {
     /**
      * Unique identifier of the media source.
      *
-     * @defaultValue `...` a generated identifier
+     * @defaultValue `V1StGXR8_Z5jdHi6B-myT` a generated identifier
      */
     id?: string;
     /**
@@ -1032,7 +1108,7 @@ declare interface MediaSourceDynamicContent extends MediaSourceBase {
 
 declare interface MediaSourceJoyn {
     /**
-     * Content / video identifier of joyn.
+     * Media / asset identifier of joyn.
      */
     id: string;
     mimetype: Mimetype.JOYN;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1312.4",
+  "version": "1.1314.4",
   "description": "Web component and types to integrate the glomex player",
   "documentation": "https://docs.glomex.com",
   "homepage": "https://glomex.com",
@@ -29,7 +29,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "^1.9.4",
-    "@glomex/integration": "^1.1312.4",
+    "@glomex/integration": "^1.1314.2",
     "@microsoft/api-extractor": "^7.52.1",
     "@rslib/core": "^0.5.4",
     "typescript": "^5.8.2"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0229af187d937b80d45edb3a18295522b2d341e4"
+  "gitHead": "51eb5cdd07185bef6a932201345f00019d53a20b"
 }