@glomex/integration-web-component 1.1519.1 → 1.1521.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -35,10 +35,16 @@ export declare enum AdBreakName {
35
35
  POSTROLL = "postroll"
36
36
  }
37
37
 
38
- export declare class AdError extends Error {
39
- code: string;
38
+ /**
39
+ * A broad error shape accepted by AD_ERROR events.
40
+ * Any `Error` with a `name` and `code` satisfies this contract,
41
+ * so domain-specific errors can flow through without normalisation
42
+ * while preserving their origin.
43
+ */
44
+ export declare interface AdError extends Error {
40
45
  name: string;
41
- constructor(message: string, code: string);
46
+ message: string;
47
+ code: string;
42
48
  }
43
49
 
44
50
  /** Format of the ad - how it is presented */
@@ -504,6 +510,7 @@ export declare class GlomexMediaItemElement extends MediaItemElement {
504
510
  * @see {@link IntegrationElementEventMap} for a full list of event types and their payloads
505
511
  * @tagname glomex-integration
506
512
  * @slot - (optional) Slot for custom media items ({@link GlomexMediaItemElement}, {@link JoynMediaItemElement}, {@link ExternalMediaItemElement} or {@link MediaItemElement})
513
+ * @slot overlay - (optional) Slot for a custom overlay rendered on top of the player. Use `width: 100%; height: 100%` on the slotted element to cover the full player area.
507
514
  *
508
515
  * @example with a playlist-id
509
516
  *
@@ -514,6 +521,19 @@ export declare class GlomexMediaItemElement extends MediaItemElement {
514
521
  * ></glomex-integration>
515
522
  * ```
516
523
  *
524
+ * @example with a custom overlay
525
+ *
526
+ * ```html
527
+ * <glomex-integration
528
+ * integration-id="REPLACE_WITH_INTEGRATION_ID"
529
+ * playlist-id="REPLACE_WITH_PLAYLIST_ID"
530
+ * >
531
+ * <div slot="overlay" style="width: 100%; height: 100%;">
532
+ * Custom overlay content
533
+ * </div>
534
+ * </glomex-integration>
535
+ * ```
536
+ *
517
537
  * You can find more advanced examples in the {@link GlomexMediaItemElement}, {@link JoynMediaItemElement}, {@link ExternalMediaItemElement} or {@link MediaItemElement} documentation.
518
538
  */
519
539
  export declare class IntegrationElement extends HTMLElement implements IntegrationProperties {
@@ -1210,10 +1230,12 @@ export declare enum IntegrationEvent {
1210
1230
  CONTENT_ENDED = "ended",
1211
1231
  /**
1212
1232
  * When an ad break gets requested
1233
+ * @eventProperty
1213
1234
  */
1214
1235
  AD_BREAK_REQUEST = "adbreakrequest",
1215
1236
  /**
1216
1237
  * When an ad break request fails
1238
+ * @eventProperty
1217
1239
  */
1218
1240
  AD_BREAK_REQUEST_ERROR = "adbreakrequesterror",
1219
1241
  /**
@@ -2525,8 +2547,6 @@ declare type UiAction = (typeof ALLOWED_UI_ACTIONS)[number];
2525
2547
  export declare enum UserIdName {
2526
2548
  /** {@link https://netid.de netID} — European login alliance ID */
2527
2549
  NET_ID = "netId",
2528
- /** {@link https://7pass.de 7Pass} — ProSiebenSat.1 login ID */
2529
- SEVEN_PASS_ID = "sevenPassId",
2530
2550
  /** Publisher Provided ID */
2531
2551
  PPID = "ppid",
2532
2552
  /** {@link https://utiq.com Utiq} — telco-based advertising ID */
package/dist/index.js CHANGED
@@ -1 +1 @@
1
- function e(e){if("provider"in e)return e;let t=e.sources?.some(e=>e.mimetype===k.JOYN);return{id:e.id||"",provider:t?h.JOYN:h.EXTERNAL,item:e}}(I=S||(S={})).DEFAULT="turbo-integration",I.SCRIPT="turbo-script",I.IFRAME="turbo-iframe",I.FULLPAGE="turbo-fullpage",I.AMP_VIDEO_IFRAME="turbo-amp-video-iframe",I.AMP_IFRAME="turbo-amp-iframe",(T=M||(M={})).INTEGRATION="glomex-integration",T.EXTERNAL_MEDIA_ITEM="external-media-item",T.GLOMEX_MEDIA_ITEM="glomex-media-item",T.JOYN_MEDIA_ITEM="joyn-media-item",(_=g||(g={})).INTEGRATION_CONFIGS="application/integration-configs+json",_.INTEGRATION_CONFIGS_LEGACY="application/glomex-integration-configs+json",_.EXTERNAL_MEDIA_ITEM="application/external-media-item+json",_.EXTERNAL_MEDIA_ITEM_LEGACY="application/glomex-external-media-item+json";let t="turbo-player";(d=U||(U={})).NET_ID="netId",d.SEVEN_PASS_ID="sevenPassId",d.PPID="ppid",d.UTIQ_ID="utiqId",d.LIVERAMP_ID="liverampId",d.PAIR_ID="pairId",d.ATS_DIRECT="atsDirect",(N=G||(G={})).AAID="aaid",N.AFAI="afai",N.ASIA="asia",N.ASID="asid",N.TIFA="tifa",N.VAID="vaid",N.IDFA="idfa",N.IDFV="idfv",N.LGUDID="lgudid",N.MSAI="msai",N.OAID="oaid",N.PSNAI="psnai",N.RIDA="rida",N.VIDA="vida",N.WAID="waid",(A=y||(y={})).HIDDEN="hidden",A.INLINE="inline",A.DOCK="dock",A.LIGHTBOX="lightbox",A.LIGHTBOX_EXTERNAL="lightbox-external",A.FULLSCREEN="fullscreen",A.AMP_DOCK="amp-dock",(s=v||(v={})).READY="ready",s.INTEGRATION_ABORT="integrationabort",s.INTEGRATION_AD_AVAILABLE="integrationadavailable",s.INTEGRATION_PASSBACK="integrationpassback",s.USER_UPDATE_CONSENT="userupdateconsent",s.PLAYLIST_UPDATE="playlistupdate",s.PLAYER_SET_PRESENTATION_MODE="playersetpresentationmode",s.CONTENT_SELECT="contentselect",s.CONTENT_LOADSTART="loadstart",s.CONTENT_START="contentstart",s.CONTENT_IMPRESSION="contentimpression",s.CONTENT_BUFFERING_START="contentbufferingstart",s.CONTENT_BUFFERING_END="contentbufferingend",s.CONTENT_STOP="contentstop",s.CONTENT_ERROR="contenterror",s.CONTENT_MARKER_REACHED="contentmarkerreached",s.CONTENT_TIME_UPDATE="timeupdate",s.CONTENT_SEEKING="seeking",s.CONTENT_SEEKED="seeked",s.CONTENT_PLAY="play",s.CONTENT_PAUSE="pause",s.CONTENT_VOLUME_CHANGE="volumechange",s.CONTENT_RATECHANGE="ratechange",s.CONTENT_ENDED="ended",s.AD_BREAK_REQUEST="adbreakrequest",s.AD_BREAK_REQUEST_ERROR="adbreakrequesterror",s.AD_LOADED="adloaded",s.AD_IMPRESSION="adimpression",s.AD_BUFFERING_START="adbufferingstart",s.AD_BUFFERING_END="adbufferingend",s.AD_TIME_UPDATE="adtimeupdate",s.AD_VOLUME_CHANGE="advolumechange",s.AD_PAUSED="adpaused",s.AD_RESUMED="adresumed",s.AD_CLICK="adclick",s.AD_SKIPPED="adskipped",s.AD_COMPLETE="adcomplete",s.AD_ERROR="aderror",s.UI_INTERACTION="uiinteraction",(l=F||(F={})).TIME_IN_SECONDS="time",l.PERCENT="percent",l.TIME_IN_SECONDS_RECURRING="timeRecurring",(R=b||(b={})).PREROLL="preroll",R.MIDROLL="midroll",R.POSTROLL="postroll",R.FIRST_QUARTILE="contentFirstQuartile",R.MIDPOINT="contentMidpoint",R.THIRD_QUARTILE="contentThirdQuartile",R.COMPLETE="contentComplete",R.STILL_INTERESTING="stillInteresting",R.REQUEST_RECOMMENDATIONS="requestRecommendations",(c=f||(f={})).NOT_FOUND="NotFound",c.FORBIDDEN="Forbidden",c.HIDDEN="Hidden",c.NO_CONTENT="NoContent",c.GENERIC="Generic",(O=x||(x={})).NOT_FOUND="NotFound",O.NOT_AVAILABLE="NotAvailable",O.GEOBLOCKED="Geoblocked",O.YOUTH_PROTECTED="YouthProtected",O.TERMINATED="Terminated",O.EXPIRED="Expired",O.LOGIN_REQUIRED="LoginRequired",O.HIGHER_TIER_ACCOUNT_REQUIRED="HigherTierAccountRequired",O.VPN_DETECTED="VpnDetected",O.AGE_VERIFICATION_REQUIRED="AgeVerificationRequired",O.PIN_REQUIRED="PinRequired",O.INVALID_PIN="InvalidPin",O.GENERIC="Generic",(p=h||(h={})).GLOMEX="glomex",p.JOYN="joyn",p.EXTERNAL="external",(m=k||(k={})).HLS="application/vnd.apple.mpegurl",m.HLS_LEGACY="application/x-mpegURL",m.DASH="application/dash+xml",m.MP4="video/mp4",m.OGG="video/ogg",m.WEBM="video/webm",m.MP3="audio/mp3",m.AAC="audio/aac",m.WAV="audio/wav",m.OGG_AUDIO="audio/ogg",m.MPEG_AUDIO="audio/mpeg",m.DYNAMIC_CONTENT="application/x-turbo-dynamic-content",m.JOYN="application/x-joyn-source",(D=Y||(Y={})).LIVE="live",D.VOD="vod",D.INTERACTIVE="interactive",D.EMBED="embed",(C=V||(V={})).PREROLL="preroll",C.MIDROLL="midroll",C.POSTROLL="postroll",C.OVERLAY="overlay",(L=B||(B={})).LINEAR="linear",L.OVERLAY="overlay",L.CUTIN="cutin",L.PAUSE="pause",(u=H||(H={})).PRE_CLICK="pre-click-to-play",u.CLICK="click-to-play",u.AUTOPLAY_SCROLL="autoplay-scroll",u.AUTOPLAY_SCROLL_OUT="autoplay-scroll-out",u.CLICK_NEXT="click-to-play-next",u.CLICK_REPLAY="click-to-play-replay",u.AUTOPLAY_NEXT="autoplay-next",(P=X||(X={})).CLEAR_PLAYLIST="clearPlaylist",P.SELECT_PLAYLIST_ITEM="selectPlaylistItem",P.ENDED="ended",P.CONTENT_ERROR="contentError",P.API_STOP="apiStop",P.LIVESTREAM_STOP="livestreamStop",P.LIVESTREAM_NOT_STARTED="livestreamNotStarted",P.PAGE_HIDE="pageHide",P.BEFORE_UNLOAD="beforeUnload";let a="player.glomex.com",n=`https://${a}/integration/1/integration.js`;function o(e){return`https://${a}/variant/${e}/variant.css`}function E(){if(window.customElements.get(M.INTEGRATION))return;let e=document.createElement("script");e.innerText=`import('${n}');`,e.type="module",(document.head||document.body).appendChild(e)}function i(e){if(document.querySelector(`link[href="${o(e)}"]`))return;let t=document.createElement("link");t.rel="stylesheet",t.href=o(e),(document.head||document.body).appendChild(t)}async function r(){await customElements.whenDefined(M.INTEGRATION);let e=customElements.get(M.INTEGRATION);if(!e?.sharedContext)throw Error("sharedContext not available on glomex-integration element");return e.sharedContext}var I,T,_,d,N,A,s,l,R,c,O,p,m,D,C,L,u,P,S,M,g,U,G,y,v,F,b,f,x,h,k,Y,V,B,H,X,K="turbo",w="glomex";export{V as AdBreakName,B as AdFormat,M as ComponentName,X as ContentStopReason,G as DeviceIdName,t as EXTERNAL_PLAYER_NAME,v as IntegrationEvent,b as KnownMarkerName,F as MarkerType,x as MediaItemErrorCode,h as MediaItemProvider,f as MediaProviderErrorCode,k as Mimetype,S as Origin,Y as PlaybackMode,y as PresentationMode,g as ScriptType,H as StartMethod,U as UserIdName,o as getIntegrationCssUrl,r as getSharedContext,E as loadIntegrationComponent,i as loadIntegrationStyles,e as normalizeMediaItem,K as INTERNAL_PREFIX,w as PUBLIC_PREFIX};
1
+ function e(e){if("provider"in e)return e;let t=e.sources?.some(e=>e.mimetype===k.JOYN);return{id:e.id||"",provider:t?h.JOYN:h.EXTERNAL,item:e}}(I=S||(S={})).DEFAULT="turbo-integration",I.SCRIPT="turbo-script",I.IFRAME="turbo-iframe",I.FULLPAGE="turbo-fullpage",I.AMP_VIDEO_IFRAME="turbo-amp-video-iframe",I.AMP_IFRAME="turbo-amp-iframe",(T=M||(M={})).INTEGRATION="glomex-integration",T.EXTERNAL_MEDIA_ITEM="external-media-item",T.GLOMEX_MEDIA_ITEM="glomex-media-item",T.JOYN_MEDIA_ITEM="joyn-media-item",(_=g||(g={})).INTEGRATION_CONFIGS="application/integration-configs+json",_.INTEGRATION_CONFIGS_LEGACY="application/glomex-integration-configs+json",_.EXTERNAL_MEDIA_ITEM="application/external-media-item+json",_.EXTERNAL_MEDIA_ITEM_LEGACY="application/glomex-external-media-item+json";let t="turbo-player";(d=U||(U={})).NET_ID="netId",d.PPID="ppid",d.UTIQ_ID="utiqId",d.LIVERAMP_ID="liverampId",d.PAIR_ID="pairId",d.ATS_DIRECT="atsDirect",(N=G||(G={})).AAID="aaid",N.AFAI="afai",N.ASIA="asia",N.ASID="asid",N.TIFA="tifa",N.VAID="vaid",N.IDFA="idfa",N.IDFV="idfv",N.LGUDID="lgudid",N.MSAI="msai",N.OAID="oaid",N.PSNAI="psnai",N.RIDA="rida",N.VIDA="vida",N.WAID="waid",(A=y||(y={})).HIDDEN="hidden",A.INLINE="inline",A.DOCK="dock",A.LIGHTBOX="lightbox",A.LIGHTBOX_EXTERNAL="lightbox-external",A.FULLSCREEN="fullscreen",A.AMP_DOCK="amp-dock",(s=v||(v={})).READY="ready",s.INTEGRATION_ABORT="integrationabort",s.INTEGRATION_AD_AVAILABLE="integrationadavailable",s.INTEGRATION_PASSBACK="integrationpassback",s.USER_UPDATE_CONSENT="userupdateconsent",s.PLAYLIST_UPDATE="playlistupdate",s.PLAYER_SET_PRESENTATION_MODE="playersetpresentationmode",s.CONTENT_SELECT="contentselect",s.CONTENT_LOADSTART="loadstart",s.CONTENT_START="contentstart",s.CONTENT_IMPRESSION="contentimpression",s.CONTENT_BUFFERING_START="contentbufferingstart",s.CONTENT_BUFFERING_END="contentbufferingend",s.CONTENT_STOP="contentstop",s.CONTENT_ERROR="contenterror",s.CONTENT_MARKER_REACHED="contentmarkerreached",s.CONTENT_TIME_UPDATE="timeupdate",s.CONTENT_SEEKING="seeking",s.CONTENT_SEEKED="seeked",s.CONTENT_PLAY="play",s.CONTENT_PAUSE="pause",s.CONTENT_VOLUME_CHANGE="volumechange",s.CONTENT_RATECHANGE="ratechange",s.CONTENT_ENDED="ended",s.AD_BREAK_REQUEST="adbreakrequest",s.AD_BREAK_REQUEST_ERROR="adbreakrequesterror",s.AD_LOADED="adloaded",s.AD_IMPRESSION="adimpression",s.AD_BUFFERING_START="adbufferingstart",s.AD_BUFFERING_END="adbufferingend",s.AD_TIME_UPDATE="adtimeupdate",s.AD_VOLUME_CHANGE="advolumechange",s.AD_PAUSED="adpaused",s.AD_RESUMED="adresumed",s.AD_CLICK="adclick",s.AD_SKIPPED="adskipped",s.AD_COMPLETE="adcomplete",s.AD_ERROR="aderror",s.UI_INTERACTION="uiinteraction",(l=F||(F={})).TIME_IN_SECONDS="time",l.PERCENT="percent",l.TIME_IN_SECONDS_RECURRING="timeRecurring",(R=b||(b={})).PREROLL="preroll",R.MIDROLL="midroll",R.POSTROLL="postroll",R.FIRST_QUARTILE="contentFirstQuartile",R.MIDPOINT="contentMidpoint",R.THIRD_QUARTILE="contentThirdQuartile",R.COMPLETE="contentComplete",R.STILL_INTERESTING="stillInteresting",R.REQUEST_RECOMMENDATIONS="requestRecommendations",(c=f||(f={})).NOT_FOUND="NotFound",c.FORBIDDEN="Forbidden",c.HIDDEN="Hidden",c.NO_CONTENT="NoContent",c.GENERIC="Generic",(O=x||(x={})).NOT_FOUND="NotFound",O.NOT_AVAILABLE="NotAvailable",O.GEOBLOCKED="Geoblocked",O.YOUTH_PROTECTED="YouthProtected",O.TERMINATED="Terminated",O.EXPIRED="Expired",O.LOGIN_REQUIRED="LoginRequired",O.HIGHER_TIER_ACCOUNT_REQUIRED="HigherTierAccountRequired",O.VPN_DETECTED="VpnDetected",O.AGE_VERIFICATION_REQUIRED="AgeVerificationRequired",O.PIN_REQUIRED="PinRequired",O.INVALID_PIN="InvalidPin",O.GENERIC="Generic",(p=h||(h={})).GLOMEX="glomex",p.JOYN="joyn",p.EXTERNAL="external",(m=k||(k={})).HLS="application/vnd.apple.mpegurl",m.HLS_LEGACY="application/x-mpegURL",m.DASH="application/dash+xml",m.MP4="video/mp4",m.OGG="video/ogg",m.WEBM="video/webm",m.MP3="audio/mp3",m.AAC="audio/aac",m.WAV="audio/wav",m.OGG_AUDIO="audio/ogg",m.MPEG_AUDIO="audio/mpeg",m.DYNAMIC_CONTENT="application/x-turbo-dynamic-content",m.JOYN="application/x-joyn-source",(D=Y||(Y={})).LIVE="live",D.VOD="vod",D.INTERACTIVE="interactive",D.EMBED="embed",(C=V||(V={})).PREROLL="preroll",C.MIDROLL="midroll",C.POSTROLL="postroll",C.OVERLAY="overlay",(L=B||(B={})).LINEAR="linear",L.OVERLAY="overlay",L.CUTIN="cutin",L.PAUSE="pause",(u=H||(H={})).PRE_CLICK="pre-click-to-play",u.CLICK="click-to-play",u.AUTOPLAY_SCROLL="autoplay-scroll",u.AUTOPLAY_SCROLL_OUT="autoplay-scroll-out",u.CLICK_NEXT="click-to-play-next",u.CLICK_REPLAY="click-to-play-replay",u.AUTOPLAY_NEXT="autoplay-next",(P=X||(X={})).CLEAR_PLAYLIST="clearPlaylist",P.SELECT_PLAYLIST_ITEM="selectPlaylistItem",P.ENDED="ended",P.CONTENT_ERROR="contentError",P.API_STOP="apiStop",P.LIVESTREAM_STOP="livestreamStop",P.LIVESTREAM_NOT_STARTED="livestreamNotStarted",P.PAGE_HIDE="pageHide",P.BEFORE_UNLOAD="beforeUnload";let a="player.glomex.com",n=`https://${a}/integration/1/integration.js`;function o(e){return`https://${a}/variant/${e}/variant.css`}function E(){if(window.customElements.get(M.INTEGRATION))return;let e=document.createElement("script");e.innerText=`import('${n}');`,e.type="module",(document.head||document.body).appendChild(e)}function i(e){if(document.querySelector(`link[href="${o(e)}"]`))return;let t=document.createElement("link");t.rel="stylesheet",t.href=o(e),(document.head||document.body).appendChild(t)}async function r(){await customElements.whenDefined(M.INTEGRATION);let e=customElements.get(M.INTEGRATION);if(!e?.sharedContext)throw Error("sharedContext not available on glomex-integration element");return e.sharedContext}var I,T,_,d,N,A,s,l,R,c,O,p,m,D,C,L,u,P,S,M,g,U,G,y,v,F,b,f,x,h,k,Y,V,B,H,X,K="turbo",w="glomex";export{V as AdBreakName,B as AdFormat,M as ComponentName,X as ContentStopReason,G as DeviceIdName,t as EXTERNAL_PLAYER_NAME,v as IntegrationEvent,b as KnownMarkerName,F as MarkerType,x as MediaItemErrorCode,h as MediaItemProvider,f as MediaProviderErrorCode,k as Mimetype,S as Origin,Y as PlaybackMode,y as PresentationMode,g as ScriptType,H as StartMethod,U as UserIdName,o as getIntegrationCssUrl,r as getSharedContext,E as loadIntegrationComponent,i as loadIntegrationStyles,e as normalizeMediaItem,K as INTERNAL_PREFIX,w as PUBLIC_PREFIX};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@glomex/integration-web-component",
3
- "version": "1.1519.1",
3
+ "version": "1.1521.0",
4
4
  "description": "Web component and types to integrate the glomex player",
5
5
  "documentation": "https://docs.glomex.com",
6
6
  "homepage": "https://glomex.com",
@@ -32,7 +32,7 @@
32
32
  },
33
33
  "devDependencies": {
34
34
  "@biomejs/biome": "catalog:",
35
- "@glomex/integration": "1.1519.1",
35
+ "@glomex/integration": "1.1521.0",
36
36
  "@microsoft/api-extractor": "catalog:",
37
37
  "@rslib/core": "catalog:",
38
38
  "npm-run-all": "catalog:",
@@ -42,5 +42,5 @@
42
42
  "access": "public"
43
43
  },
44
44
  "license": "MIT",
45
- "gitHead": "26707f6137155ee706f7bf67e32fea9634d9ec17"
45
+ "gitHead": "24204ece78ed603c50b29d340f9191a9a5044a30"
46
46
  }