@glomex/integration-web-component 1.1304.0 → 1.1306.0

package/build/index.d.ts

@@ -94,7 +94,7 @@ declare interface ExperimentVariant {
  *
  * @example the most simple glomex-external-media-item with inline JSON
  *
- * It is possible to use {@link MediaItem}, {@link MinimalMediaItem}, or array of {@link MediaItem} or {@link MinimalMediaItem}
+ * It is possible to use {@link MediaItem} or array of {@link MediaItem}
  * in JSON format.
  *
  * ```html
@@ -182,7 +182,7 @@ export declare class ExternalMediaItemElement extends HTMLElement implements Med
      * {@inheritDoc MediaItem#hasProductPlacement}
      */
     hasProductPlacement?: boolean;
-    get data(): MinimalMediaItem | MediaItem;
+    get data(): MediaItem;
 }
 
 export declare function getIntegrationCssUrl(integrationId: string): string;
@@ -662,15 +662,102 @@ declare interface MediaError_2 {
 }
 export { MediaError_2 as MediaError }
 
-export declare interface MediaItem extends MinimalMediaItem {
-    /** @ignore */
-    ppsj: string;
+export declare interface MediaItem {
+    /**
+     * Unique identifier of the media item.
+     */
+    id: string;
+    /**
+     * Poster image of the media item.
+     */
+    poster: string;
+    /**
+     * Sources of the media item.
+     */
+    sources: MediaSource_2[];
+    /**
+     * Title of the media item.
+     */
+    title: string;
+    /**
+     * Duration of the media item in seconds. Not defined when livestream.
+     */
+    duration?: number;
+    /**
+     * Description of the media item.
+     */
+    description?: string;
+    /**
+     * Language of the media item. 2-letter ISO language code.
+     *
+     * @defaultValue `de` (German)
+     */
+    language?: string;
+    /**
+     * IAB categories (as {@link iabCategoryTaxonomy}) of the media item. Used for monetization.
+     */
+    iabCategories?: string[];
+    /**
+     * IAB category taxonomy used for {@link iabCategories} ({@link https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies see IAB spec for details})
+     * @defaultValue `9` for IAB Tech Lab Content Taxonomy 3.1
+     */
+    iabCategoryTaxonomy?: number;
+    /**
+     * Aspect ratio of the media item. Useful when vertical variants are used.
+     *
+     * @defaultValue `16:9`
+     */
+    aspectRatio?: string;
+    /**
+     * Minimum age to watch the media item. Shows a minimum age indicator in the UI.
+     *
+     * @defaultValue `0` (no minimum age)
+     */
+    minimumAge?: number;
+    /**
+     * Release date of the media item. Unix timestamp in milliseconds.
+     * Useful for JSON-LD generation.
+     */
+    releaseDate?: number;
+    /**
+     * Time when the media item expires. Unix timestamp in milliseconds.
+     * Useful for JSON-LD generation.
+     */
+    endDate?: number;
+    /**
+     * Whether the media item has product placements. Shows a product placement indicator in the UI.
+     */
+    hasProductPlacement?: boolean;
+    /**
+     * Channel of the media item.
+     */
+    channel?: Channel;
+    /**
+     * Markers of the media item.
+     *
+     * @defaultValue `[{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]`
+     */
+    markers?: (Marker | CustomMarker)[];
+    /**
+     * In which country can this media item be played (e.g. `['de', 'at']`)? Useful for
+     * JSON-LD generation.
+     *
+     * @defaultValue `['all']` (worldwide)
+     */
+    regionsAllowed?: string[];
+    /**
+     * Will be automatically filled based on {@link minimumAge} and {@link iabCategories}.
+     * @ignore */
+    ppsj?: string;
     /**
      * Mark this media item as a recommendation.
      */
     isRecommendation?: boolean;
-    /** @ignore */
-    playlistId: string;
+    /**
+     * An internal marker for the used playlist. It is automatically filled.
+     * @ignore
+     */
+    playlistId?: string;
     /**
      * JSON-LD `contentUrl` that allows search engines to crawl the media source.
      * You should only allow known crawlers ({@link https://developers.google.com/search/docs/crawling-indexing/verifying-googlebot?hl=en how to verify Googlebot & Crawler})
@@ -678,7 +765,8 @@ export declare interface MediaItem extends MinimalMediaItem {
      */
     seoContentUrl?: string;
     /**
-     * Additional teaser options.
+     * Additional teaser options that improve the loading experience and enable additional
+     * integration variants.
      */
     teaser?: {
         /** Image of the first frame of the media item. Used for initially showing the first frame of the media item. */
@@ -687,30 +775,16 @@ export declare interface MediaItem extends MinimalMediaItem {
         firstFrameBlurHash?: string | null;
         /** Blurred version of the first frame of the media item. Used to show something early while loading. */
         firstFrameBlurred?: string;
-        /**
-         * The root `poster` is used
-         * @ignore
-         */
-        poster?: string;
         /** {@link https://blurha.sh/ Blurhash} of the poster of the media item. Used for coloring the background. */
         posterBlurHash?: string | null;
         /** Blurred version of the poster of the media item. Used to show something early while loading. */
         posterBlurred?: string;
-        /**
-         * Can probably be removed because unused.
-         * @ignore
-         */
-        thumbnail?: string;
         /** Teaser video URL which is used for previewing the media item for some integrations. */
         video?: string;
-        /**
-         * The root `title` is used
-         *
-         * @ignore
-         */
-        title?: string;
     };
-    /** @ignore */
+    /**
+     * Additional labels for this media item.
+     */
     labels?: {
         id: string;
         name: string;
@@ -723,7 +797,7 @@ export declare interface MediaItem extends MinimalMediaItem {
         name: string;
     };
     /**
-     * Details to show for the age rating (e.g. `['Alcohol']`)
+     * Additional details to show for the age rating (e.g. `['Alcohol']`) next to the minimum age.
      */
     ageRatingDetails?: string[];
     /** Keywords of the media item */
@@ -738,10 +812,17 @@ export declare interface MediaItem extends MinimalMediaItem {
         name: string;
         id?: string;
     };
+    /** Error information if the media item is not available upfront. */
     error?: MediaItemError;
-    /** @ignore */
+    /**
+     * Internal definition of experiments.
+     * @ignore
+     */
     experiments?: Experiment[];
-    /** @ignore */
+    /**
+     * Advanced additional content branding (e.g. L around the video).
+     * @ignore
+     */
     branding?: {
         backgroundColor?: string;
         cutInZoomAssetUrl?: string;
@@ -749,17 +830,6 @@ export declare interface MediaItem extends MinimalMediaItem {
         logoUrl?: string;
         logoLinkUrl?: string;
     };
-    /** @ignore */
-    tracking?: {
-        scriptUrl: string;
-        data?: {
-            episodeExternalId?: string;
-            showTitle?: string;
-            showId?: string;
-            onlineExclusive?: boolean;
-            channel?: string;
-        };
-    };
     /** Livestream details */
     livestream?: {
         /** UTC start time of the livestream in milliseconds */
@@ -767,8 +837,11 @@ export declare interface MediaItem extends MinimalMediaItem {
         /** UTC end time of the livestream in milliseconds */
         endTime?: number;
     };
-    /** @ignore */
-    allowTeaserExperiments: boolean;
+    /**
+     * Only relevant for glomex-internal use.
+     * @ignore
+     */
+    allowTeaserExperiments?: boolean;
     /**
      * URL of the API script that should be executed for this media-item. Script
      * must export `export function connectIntegration(glomexIntegration) {}`
@@ -830,7 +903,7 @@ export declare interface MediaItem extends MinimalMediaItem {
  * ```
  */
 export declare interface MediaItemElement extends HTMLElement {
-    readonly data: MediaItem | MinimalMediaItem | (MediaItem | MinimalMediaItem)[] | Promise<MediaItem | MinimalMediaItem | (MediaItem | MinimalMediaItem)[]>;
+    readonly data: MediaItem | MediaItem[] | Promise<MediaItem | MediaItem[]>;
 }
 
 /**
@@ -960,88 +1033,6 @@ export declare enum Mimetype {
     JOYN = "application/x-joyn-source"
 }
 
-export declare interface MinimalMediaItem {
-    /**
-     * Unique identifier of the media item.
-     */
-    id: string;
-    /**
-     * Poster image of the media item.
-     */
-    poster: string;
-    /**
-     * Sources of the media item.
-     */
-    sources: MediaSource_2[];
-    /**
-     * Title of the media item.
-     */
-    title: string;
-    /**
-     * Duration of the media item in seconds. Not defined when livestream.
-     */
-    duration?: number;
-    /**
-     * Description of the media item.
-     */
-    description?: string;
-    /**
-     * Language of the media item. 2-letter ISO language code.
-     *
-     * @defaultValue `de` (German)
-     */
-    language?: string;
-    /**
-     * IAB categories (as {@link iabCategoryTaxonomy}) of the media item.
-     */
-    iabCategories?: string[];
-    /**
-     * IAB category taxonomy used for {@link iabCategories} ({@link https://github.com/InteractiveAdvertisingBureau/AdCOM/blob/main/AdCOM%20v1.0%20FINAL.md#list_categorytaxonomies see IAB spec for details})
-     * @defaultValue `9` for IAB Tech Lab Content Taxonomy 3.1
-     */
-    iabCategoryTaxonomy?: number;
-    /**
-     * Aspect ratio of the media item.
-     *
-     * @defaultValue `16:9`
-     */
-    aspectRatio?: string;
-    /**
-     * Minimum age to watch the media item.
-     *
-     * @defaultValue `0` (no minimum age)
-     */
-    minimumAge?: number;
-    /**
-     * Release date of the media item. Unix timestamp in milliseconds.
-     */
-    releaseDate?: number;
-    /**
-     * Time when the media item expires. Unix timestamp in milliseconds.
-     */
-    endDate?: number;
-    /**
-     * Whether the media item has product placements.
-     */
-    hasProductPlacement?: boolean;
-    /**
-     * Channel of the media item.
-     */
-    channel?: Channel;
-    /**
-     * Markers of the media item.
-     *
-     * @defaultValue `[{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]`
-     */
-    markers?: (Marker | CustomMarker)[];
-    /**
-     * In which country can this media item be played (e.g. `['de', 'at']`)?
-     *
-     * @defaultValue `['all']` (worldwide)
-     */
-    regionsAllowed?: string[];
-}
-
 export declare interface Page {
     url: string;
     searchParams: Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1304.0",
+  "version": "1.1306.0",
   "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.1304.0",
+    "@glomex/integration": "^1.1306.0",
     "@microsoft/api-extractor": "^7.52.1",
     "@rslib/core": "^0.5.4",
     "typescript": "^5.8.2"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8f05916404a4dd5c1efc0b61991a19f556343450"
+  "gitHead": "899ed92cd26a595ef3a97d06e547903253b4e002"
 }