@glomex/integration-web-component 1.1476.0 → 1.1478.0

package/dist/index.d.ts

@@ -27,6 +27,12 @@ export declare interface Ad {
     clickThroughUrl?: string;
 }
 
+export declare class AdError extends Error {
+    code: string;
+    name: string;
+    constructor(message: string, code: string);
+}
+
 export declare const ALLOWED_UI_ACTIONS: readonly ["play", "pause", "openEpg", "startAgeSetup", "forgotPin"];
 
 /**
@@ -971,6 +977,13 @@ export declare interface IntegrationElementEventMap {
      * @eventProperty
      */
     [IntegrationEvent.AD_COMPLETE]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_ERROR
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_ERROR]: CustomEvent<{
+        error: AdError;
+    }>;
     /**
      * @inheritdoc IntegrationEvent.UI_INTERACTION
      * @eventProperty
@@ -1174,6 +1187,11 @@ export declare enum IntegrationEvent {
      * @eventProperty
      */
     AD_COMPLETE = "adcomplete",
+    /**
+     * When a non-fatal ad error occurs during playback or setup (not triggered when ad loading fails).
+     * @eventProperty
+     */
+    AD_ERROR = "aderror",
     /**
      * When the user interacted with the UI (e.g. play, pause, seek, etc.). The specific action is provided in the payload.
      * @eventProperty
@@ -1261,7 +1279,7 @@ export declare interface Marker {
     type: MarkerType;
     /**
      * Threshold for the marker:
-     * - {@link MarkerType.TIME_IN_SECONDS}: seconds
+     * - {@link MarkerType.TIME_IN_SECONDS}: seconds (use negative values to calculate position from end of content, e.g., -10 means 10 seconds before the end; only valid for VoD content)
      * - {@link MarkerType.PERCENT}: percent as fraction (0-1)
      * - {@link MarkerType.TIME_IN_SECONDS_RECURRING}: seconds
      */
@@ -1387,7 +1405,52 @@ export declare interface MediaItem {
      */
     channel?: Channel;
     /**
-     * Markers of the media item.
+     * Markers control ad breaks and custom time-based events during playback.
+     *
+     * **⚠️ Important:** When providing custom markers, the default PREROLL is **not** added automatically.
+     * You must explicitly include a PREROLL marker if you want ads to play.
+     *
+     * **Reserved marker names:** Only `PREROLL`, `MIDROLL`, and `POSTROLL` from {@link KnownMarkerName}
+     * can be used for ad markers. All other `KnownMarkerName` values are reserved for internal use.
+     * Use custom string names (e.g., `'halfwayPoint'`) for your own markers.
+     *
+     * **Listening for custom markers:** When a custom marker is reached, the player dispatches
+     * an {@link IntegrationEvent.CONTENT_MARKER_REACHED} event. Listen for this event to react
+     * to your custom markers:
+     *
+     * ```js
+     * player.addEventListener('contentmarkerreached', (event) => {
+     *   const { markerName, markerData } = event.detail;
+     *   if (markerName === 'showEndCreditsOverlay') {
+     *     // Show your overlay
+     *   }
+     * });
+     * ```
+     *
+     * @example
+     * // Default: pre-roll ads only (same as omitting markers)
+     * markers: [{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]
+     *
+     * @example
+     * // Pre-roll + mid-roll at 60 seconds
+     * markers: [
+     *   { name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 },
+     *   { name: KnownMarkerName.MIDROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 60 }
+     * ]
+     *
+     * @example
+     * // Custom marker at 50% of content
+     * markers: [
+     *   { name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 },
+     *   { name: 'halfwayPoint', type: MarkerType.PERCENT, threshold: 0.5 }
+     * ]
+     *
+     * @example
+     * // Custom marker 15 seconds before end (e.g., for end credits overlay)
+     * markers: [
+     *   { name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 },
+     *   { name: 'showEndCreditsOverlay', type: MarkerType.TIME_IN_SECONDS, threshold: -15 }
+     * ]
      *
      * @defaultValue `[{ name: KnownMarkerName.PREROLL, type: MarkerType.TIME_IN_SECONDS, threshold: 0 }]`
      */

package/dist/index.js

@@ -1 +1 @@
-(_=m||(m={})).DEFAULT="turbo-integration",_.SCRIPT="turbo-script",_.IFRAME="turbo-iframe",_.FULLPAGE="turbo-fullpage",_.AMP_VIDEO_IFRAME="turbo-amp-video-iframe",_.AMP_IFRAME="turbo-amp-iframe",(N=u||(u={})).INTEGRATION="glomex-integration",N.EXTERNAL_MEDIA_ITEM="glomex-external-media-item",N.GLOMEX_MEDIA_ITEM="glomex-media-item",(I=D||(D={})).INTEGRATION_CONFIGS="application/glomex-integration-configs+json",I.EXTERNAL_MEDIA_ITEM="application/glomex-external-media-item+json";let e="turbo",t=`${e}-player`,n=`${e}DebugPlayerConfig`;(A=S||(S={})).HIDDEN="hidden",A.INLINE="inline",A.DOCK="dock",A.LIGHTBOX="lightbox",A.LIGHTBOX_EXTERNAL="lightbox-external",A.FULLSCREEN="fullscreen",A.AMP_DOCK="amp-dock",(l=P||(P={})).READY="ready",l.INTEGRATION_ABORT="integrationabort",l.INTEGRATION_AD_AVAILABLE="integrationadavailable",l.INTEGRATION_PASSBACK="integrationpassback",l.USER_UPDATE_CONSENT="userupdateconsent",l.PLAYLIST_UPDATE="playlistupdate",l.PLAYER_SET_PRESENTATION_MODE="playersetpresentationmode",l.CONTENT_SELECT="contentselect",l.CONTENT_START="contentstart",l.CONTENT_IMPRESSION="contentimpression",l.CONTENT_BUFFERING_START="contentbufferingstart",l.CONTENT_BUFFERING_END="contentbufferingend",l.CONTENT_STOP="contentstop",l.CONTENT_ERROR="contenterror",l.CONTENT_MARKER_REACHED="contentmarkerreached",l.CONTENT_QUALITY_CHANGED="contentqualitychanged",l.CONTENT_TIME_UPDATE="timeupdate",l.CONTENT_SEEKING="seeking",l.CONTENT_SEEKED="seeked",l.CONTENT_PLAY="play",l.CONTENT_PAUSE="pause",l.CONTENT_VOLUME_CHANGE="volumechange",l.CONTENT_ENDED="ended",l.AD_BREAK_REQUEST="adbreakrequest",l.AD_BREAK_REQUEST_ERROR="adbreakrequesterror",l.AD_LOADED="adloaded",l.AD_IMPRESSION="adimpression",l.AD_BUFFERING_START="adbufferingstart",l.AD_BUFFERING_END="adbufferingend",l.AD_TIME_UPDATE="adtimeupdate",l.AD_VOLUME_CHANGE="advolumechange",l.AD_PAUSED="adpaused",l.AD_RESUMED="adresumed",l.AD_CLICK="adclick",l.AD_SKIPPED="adskipped",l.AD_COMPLETE="adcomplete",l.UI_INTERACTION="uiinteraction",(s=M||(M={})).TIME_IN_SECONDS="time",s.PERCENT="percent",s.TIME_IN_SECONDS_RECURRING="timeRecurring",(d=g||(g={})).PREROLL="preroll",d.MIDROLL="midroll",d.POSTROLL="postroll",d.FIRST_QUARTILE="contentFirstQuartile",d.MIDPOINT="contentMidpoint",d.THIRD_QUARTILE="contentThirdQuartile",d.COMPLETE="contentComplete",d.STILL_INTERESTING="stillInteresting",d.REQUEST_RECOMMENDATIONS="requestRecommendations",(c=U||(U={})).NOT_FOUND="NotFound",c.NOT_AVAILABLE="NotAvailable",c.GEOBLOCKED="Geoblocked",c.YOUTH_PROTECTED="YouthProtected",c.TERMINATED="Terminated",c.LOGIN_REQUIRED="LoginRequired",c.HIGHER_TIER_ACCOUNT_REQUIRED="HigherTierAccountRequired",c.GENERIC="Generic",(R=G||(G={})).GLOMEX="glomex",R.JOYN="joyn",R.EXTERNAL="external",(p=y||(y={})).HLS="application/vnd.apple.mpegurl",p.HLS_LEGACY="application/x-mpegURL",p.DASH="application/dash+xml",p.MP4="video/mp4",p.OGG="video/ogg",p.WEBM="video/webm",p.MP3="audio/mp3",p.AAC="audio/aac",p.WAV="audio/wav",p.OGG_AUDIO="audio/ogg",p.MPEG_AUDIO="audio/mpeg",p.DYNAMIC_CONTENT="application/x-turbo-dynamic-content",p.JOYN="application/x-joyn-source",(O=b||(b={})).LIVE="live",O.VOD="vod",O.INTERACTIVE="interactive",O.EMBED="embed",(C=F||(F={})).PRE_CLICK="pre-click-to-play",C.CLICK="click-to-play",C.AUTOPLAY_SCROLL="autoplay-scroll",C.AUTOPLAY_SCROLL_OUT="autoplay-scroll-out",C.CLICK_NEXT="click-to-play-next",C.CLICK_REPLAY="click-to-play-replay",C.AUTOPLAY_NEXT="autoplay-next",(L=f||(f={})).CLEAR_PLAYLIST="clearPlaylist",L.SELECT_PLAYLIST_ITEM="selectPlaylistItem",L.ENDED="ended",L.CONTENT_ERROR="contentError",L.API_STOP="apiStop",L.LIVESTREAM_STOP="livestreamStop",L.PAGE_HIDE="pageHide",L.BEFORE_UNLOAD="beforeUnload";let a=["play","pause","openEpg","startAgeSetup","forgotPin"],E="player.glomex.com",o=`https://${E}/integration/1/integration.js`;function i(e){return`https://${E}/variant/${e}/variant.css`}function r(){if(window.customElements.get(u.INTEGRATION))return;let e=document.createElement("script");e.innerText=`import('${o}');`,e.type="module",(document.head||document.body).appendChild(e)}function T(e){if(document.querySelector(`link[href="${i(e)}"]`))return;let t=document.createElement("link");t.rel="stylesheet",t.href=i(e),(document.head||document.body).appendChild(t)}var _,N,I,A,l,s,d,c,R,p,O,C,L,m,u,D,S,P,M,g,U,G,y,b,F,f,k="turbo",h="glomex";export{a as ALLOWED_UI_ACTIONS,n as DEBUG_CONFIG_STORAGE_KEY,t as EXTERNAL_PLAYER_NAME,u as ComponentName,f as ContentStopReason,P as IntegrationEvent,g as KnownMarkerName,M as MarkerType,U as MediaItemErrorCode,G as MediaItemProvider,y as Mimetype,m as Origin,b as PlaybackMode,S as PresentationMode,D as ScriptType,F as StartMethod,i as getIntegrationCssUrl,r as loadIntegrationComponent,T as loadIntegrationStyles,k as INTERNAL_PREFIX,h as PUBLIC_PREFIX};
+(_=m||(m={})).DEFAULT="turbo-integration",_.SCRIPT="turbo-script",_.IFRAME="turbo-iframe",_.FULLPAGE="turbo-fullpage",_.AMP_VIDEO_IFRAME="turbo-amp-video-iframe",_.AMP_IFRAME="turbo-amp-iframe",(N=u||(u={})).INTEGRATION="glomex-integration",N.EXTERNAL_MEDIA_ITEM="glomex-external-media-item",N.GLOMEX_MEDIA_ITEM="glomex-media-item",(I=D||(D={})).INTEGRATION_CONFIGS="application/glomex-integration-configs+json",I.EXTERNAL_MEDIA_ITEM="application/glomex-external-media-item+json";let e="turbo",t=`${e}-player`,n=`${e}DebugPlayerConfig`;(A=S||(S={})).HIDDEN="hidden",A.INLINE="inline",A.DOCK="dock",A.LIGHTBOX="lightbox",A.LIGHTBOX_EXTERNAL="lightbox-external",A.FULLSCREEN="fullscreen",A.AMP_DOCK="amp-dock",(l=P||(P={})).READY="ready",l.INTEGRATION_ABORT="integrationabort",l.INTEGRATION_AD_AVAILABLE="integrationadavailable",l.INTEGRATION_PASSBACK="integrationpassback",l.USER_UPDATE_CONSENT="userupdateconsent",l.PLAYLIST_UPDATE="playlistupdate",l.PLAYER_SET_PRESENTATION_MODE="playersetpresentationmode",l.CONTENT_SELECT="contentselect",l.CONTENT_START="contentstart",l.CONTENT_IMPRESSION="contentimpression",l.CONTENT_BUFFERING_START="contentbufferingstart",l.CONTENT_BUFFERING_END="contentbufferingend",l.CONTENT_STOP="contentstop",l.CONTENT_ERROR="contenterror",l.CONTENT_MARKER_REACHED="contentmarkerreached",l.CONTENT_QUALITY_CHANGED="contentqualitychanged",l.CONTENT_TIME_UPDATE="timeupdate",l.CONTENT_SEEKING="seeking",l.CONTENT_SEEKED="seeked",l.CONTENT_PLAY="play",l.CONTENT_PAUSE="pause",l.CONTENT_VOLUME_CHANGE="volumechange",l.CONTENT_ENDED="ended",l.AD_BREAK_REQUEST="adbreakrequest",l.AD_BREAK_REQUEST_ERROR="adbreakrequesterror",l.AD_LOADED="adloaded",l.AD_IMPRESSION="adimpression",l.AD_BUFFERING_START="adbufferingstart",l.AD_BUFFERING_END="adbufferingend",l.AD_TIME_UPDATE="adtimeupdate",l.AD_VOLUME_CHANGE="advolumechange",l.AD_PAUSED="adpaused",l.AD_RESUMED="adresumed",l.AD_CLICK="adclick",l.AD_SKIPPED="adskipped",l.AD_COMPLETE="adcomplete",l.AD_ERROR="aderror",l.UI_INTERACTION="uiinteraction",(s=M||(M={})).TIME_IN_SECONDS="time",s.PERCENT="percent",s.TIME_IN_SECONDS_RECURRING="timeRecurring",(d=g||(g={})).PREROLL="preroll",d.MIDROLL="midroll",d.POSTROLL="postroll",d.FIRST_QUARTILE="contentFirstQuartile",d.MIDPOINT="contentMidpoint",d.THIRD_QUARTILE="contentThirdQuartile",d.COMPLETE="contentComplete",d.STILL_INTERESTING="stillInteresting",d.REQUEST_RECOMMENDATIONS="requestRecommendations",(c=U||(U={})).NOT_FOUND="NotFound",c.NOT_AVAILABLE="NotAvailable",c.GEOBLOCKED="Geoblocked",c.YOUTH_PROTECTED="YouthProtected",c.TERMINATED="Terminated",c.LOGIN_REQUIRED="LoginRequired",c.HIGHER_TIER_ACCOUNT_REQUIRED="HigherTierAccountRequired",c.GENERIC="Generic",(R=G||(G={})).GLOMEX="glomex",R.JOYN="joyn",R.EXTERNAL="external",(p=y||(y={})).HLS="application/vnd.apple.mpegurl",p.HLS_LEGACY="application/x-mpegURL",p.DASH="application/dash+xml",p.MP4="video/mp4",p.OGG="video/ogg",p.WEBM="video/webm",p.MP3="audio/mp3",p.AAC="audio/aac",p.WAV="audio/wav",p.OGG_AUDIO="audio/ogg",p.MPEG_AUDIO="audio/mpeg",p.DYNAMIC_CONTENT="application/x-turbo-dynamic-content",p.JOYN="application/x-joyn-source",(O=b||(b={})).LIVE="live",O.VOD="vod",O.INTERACTIVE="interactive",O.EMBED="embed",(C=F||(F={})).PRE_CLICK="pre-click-to-play",C.CLICK="click-to-play",C.AUTOPLAY_SCROLL="autoplay-scroll",C.AUTOPLAY_SCROLL_OUT="autoplay-scroll-out",C.CLICK_NEXT="click-to-play-next",C.CLICK_REPLAY="click-to-play-replay",C.AUTOPLAY_NEXT="autoplay-next",(L=f||(f={})).CLEAR_PLAYLIST="clearPlaylist",L.SELECT_PLAYLIST_ITEM="selectPlaylistItem",L.ENDED="ended",L.CONTENT_ERROR="contentError",L.API_STOP="apiStop",L.LIVESTREAM_STOP="livestreamStop",L.PAGE_HIDE="pageHide",L.BEFORE_UNLOAD="beforeUnload";let a=["play","pause","openEpg","startAgeSetup","forgotPin"],E="player.glomex.com",o=`https://${E}/integration/1/integration.js`;function r(e){return`https://${E}/variant/${e}/variant.css`}function i(){if(window.customElements.get(u.INTEGRATION))return;let e=document.createElement("script");e.innerText=`import('${o}');`,e.type="module",(document.head||document.body).appendChild(e)}function T(e){if(document.querySelector(`link[href="${r(e)}"]`))return;let t=document.createElement("link");t.rel="stylesheet",t.href=r(e),(document.head||document.body).appendChild(t)}var _,N,I,A,l,s,d,c,R,p,O,C,L,m,u,D,S,P,M,g,U,G,y,b,F,f,k="turbo",h="glomex";export{a as ALLOWED_UI_ACTIONS,n as DEBUG_CONFIG_STORAGE_KEY,t as EXTERNAL_PLAYER_NAME,u as ComponentName,f as ContentStopReason,P as IntegrationEvent,g as KnownMarkerName,M as MarkerType,U as MediaItemErrorCode,G as MediaItemProvider,y as Mimetype,m as Origin,b as PlaybackMode,S as PresentationMode,D as ScriptType,F as StartMethod,r as getIntegrationCssUrl,i as loadIntegrationComponent,T as loadIntegrationStyles,k as INTERNAL_PREFIX,h as PUBLIC_PREFIX};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1476.0",
+  "version": "1.1478.0",
   "description": "Web component and types to integrate the glomex player",
   "documentation": "https://docs.glomex.com",
   "homepage": "https://glomex.com",
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "catalog:",
-    "@glomex/integration": "1.1476.0",
+    "@glomex/integration": "1.1478.0",
     "@microsoft/api-extractor": "catalog:",
     "@rslib/core": "catalog:",
     "npm-run-all": "catalog:",
@@ -42,5 +42,5 @@
     "access": "public"
   },
   "license": "MIT",
-  "gitHead": "427cef38d6a250af73113546e27ea766e1530a45"
+  "gitHead": "5c4af5f5c3f822a09675e6fb49b3bcc01a93853c"
 }