@glomex/integration-web-component 1.1321.0 → 1.1322.0

package/build/index.d.ts

@@ -1,4 +1,3 @@
-import type { ContentStopReason as ContentStopReason_2 } from 'src/constants';
 
 
 export declare interface Ad {
@@ -532,86 +531,182 @@ export declare class IntegrationElement extends HTMLElement implements Integrati
  * ```
  */
 export declare interface IntegrationElementEventMap {
-    /** @eventProperty */
-    ready: CustomEvent<unknown>;
-    /** @eventProperty */
-    integrationabort: CustomEvent<unknown & {
+    /**
+     * @inheritdoc IntegrationEvent.READY
+     * @eventProperty
+     */
+    [IntegrationEvent.READY]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.INTEGRATION_ABORT
+     * @eventProperty
+     */
+    [IntegrationEvent.INTEGRATION_ABORT]: CustomEvent<{
         error: Error;
     }>;
-    /** @eventProperty */
-    integrationadavailable: CustomEvent<unknown>;
-    /** @eventProperty */
-    integrationpassback: CustomEvent<unknown & {
+    /**
+     * @inheritdoc IntegrationEvent.INTEGRATION_AD_AVAILABLE
+     * @eventProperty
+     */
+    [IntegrationEvent.INTEGRATION_AD_AVAILABLE]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.INTEGRATION_PASSBACK
+     * @eventProperty
+     */
+    [IntegrationEvent.INTEGRATION_PASSBACK]: CustomEvent<{
         reason: string;
     }>;
-    /** @eventProperty */
-    userupdateconsent: CustomEvent<unknown>;
-    /** @eventProperty */
-    playlistupdate: CustomEvent<unknown>;
-    /** @eventProperty */
-    playersetpresentationmode: CustomEvent<unknown & {
+    /**
+     * @inheritdoc IntegrationEvent.USER_UPDATE_CONSENT
+     * @eventProperty
+     */
+    [IntegrationEvent.USER_UPDATE_CONSENT]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.PLAYLIST_UPDATE
+     * @eventProperty
+     */
+    [IntegrationEvent.PLAYLIST_UPDATE]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.PLAYER_SET_PRESENTATION_MODE
+     * @eventProperty
+     */
+    [IntegrationEvent.PLAYER_SET_PRESENTATION_MODE]: CustomEvent<{
         mode: PresentationMode;
     }>;
-    /** @eventProperty */
-    contentselect: CustomEvent<unknown & {
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_SELECT
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_SELECT]: CustomEvent<{
         sessionId: string;
         source: ContentSource;
     }>;
-    /** @eventProperty */
-    contentstart: CustomEvent<unknown>;
-    /** @eventProperty */
-    contentimpression: CustomEvent<unknown>;
-    /** @eventProperty */
-    contentbufferingstart: CustomEvent<unknown>;
-    /** @eventProperty */
-    contentbufferingend: CustomEvent<unknown>;
-    /** @eventProperty */
-    contentstop: CustomEvent<unknown & {
-        reason: ContentStopReason_2;
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_START
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_START]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_IMPRESSION
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_IMPRESSION]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_BUFFERING_START
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_BUFFERING_START]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_BUFFERING_END
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_BUFFERING_END]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_STOP
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_STOP]: CustomEvent<{
+        reason: ContentStopReason;
     }>;
-    /** @eventProperty */
-    contenterror: CustomEvent<unknown & {
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_ERROR
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_ERROR]: CustomEvent<{
         error: MediaError_2 | MediaItemError;
     }>;
-    /** @eventProperty */
-    contentmarkerreached: CustomEvent<unknown & {
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_MARKER_REACHED
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_MARKER_REACHED]: CustomEvent<{
         markerName: string;
         markerData: unknown;
     }>;
-    /** @eventProperty */
-    timeupdate: CustomEvent<unknown> | HTMLElementEventMap['timeupdate'];
-    /** @eventProperty */
-    seeking: CustomEvent<unknown> | HTMLElementEventMap['seeking'];
-    /** @eventProperty */
-    seeked: CustomEvent<unknown> | HTMLElementEventMap['seeked'];
-    /** @eventProperty */
-    play: CustomEvent<unknown> | HTMLElementEventMap['play'];
-    /** @eventProperty */
-    pause: CustomEvent<unknown> | HTMLElementEventMap['pause'];
-    /** @eventProperty */
-    volumechange: CustomEvent<unknown> | HTMLElementEventMap['volumechange'];
-    /** @eventProperty */
-    ended: CustomEvent<unknown> | HTMLElementEventMap['ended'];
-    /** @eventProperty */
-    adimpression: CustomEvent<unknown>;
-    /** @eventProperty */
-    adbufferingstart: CustomEvent<unknown>;
-    /** @eventProperty */
-    adbufferingend: CustomEvent<unknown>;
-    /** @eventProperty */
-    adtimeupdate: CustomEvent<unknown>;
-    /** @eventProperty */
-    advolumechange: CustomEvent<unknown>;
-    /** @eventProperty */
-    adpaused: CustomEvent<unknown>;
-    /** @eventProperty */
-    adresumed: CustomEvent<unknown>;
-    /** @eventProperty */
-    adclick: CustomEvent<unknown>;
-    /** @eventProperty */
-    adskipped: CustomEvent<unknown>;
-    /** @eventProperty */
-    adcomplete: CustomEvent<unknown>;
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_TIME_UPDATE
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_TIME_UPDATE]: CustomEvent<void> | HTMLElementEventMap['timeupdate'];
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_SEEKING
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_SEEKING]: CustomEvent<void> | HTMLElementEventMap['seeking'];
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_SEEKED
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_SEEKED]: CustomEvent<void> | HTMLElementEventMap['seeked'];
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_PLAY
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_PLAY]: CustomEvent<void> | HTMLElementEventMap['play'];
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_PAUSE
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_PAUSE]: CustomEvent<void> | HTMLElementEventMap['pause'];
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_VOLUME_CHANGE
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_VOLUME_CHANGE]: CustomEvent<void> | HTMLElementEventMap['volumechange'];
+    /**
+     * @inheritdoc IntegrationEvent.CONTENT_ENDED
+     * @eventProperty
+     */
+    [IntegrationEvent.CONTENT_ENDED]: CustomEvent<void> | HTMLElementEventMap['ended'];
+    /**
+     * @inheritdoc IntegrationEvent.AD_IMPRESSION
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_IMPRESSION]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_BUFFERING_START
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_BUFFERING_START]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_BUFFERING_END
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_BUFFERING_END]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_TIME_UPDATE
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_TIME_UPDATE]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_VOLUME_CHANGE
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_VOLUME_CHANGE]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_PAUSED
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_PAUSED]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_RESUMED
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_RESUMED]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_CLICK
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_CLICK]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_SKIPPED
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_SKIPPED]: CustomEvent<void>;
+    /**
+     * @inheritdoc IntegrationEvent.AD_COMPLETE
+     * @eventProperty
+     */
+    [IntegrationEvent.AD_COMPLETE]: CustomEvent<void>;
 }
 
 /**
@@ -620,69 +715,174 @@ export declare interface IntegrationElementEventMap {
  * @see {@link IntegrationElementEventMap} for a full list of event types and their payloads
  */
 export declare enum IntegrationEvent {
-    /** @eventProperty */
+    /**
+     * When the integration got initialized.
+     * @eventProperty
+     */
     READY = "ready",
-    /** @eventProperty */
+    /**
+     * When the integration got aborted because of a configuration / authorization error.
+     * It is not triggered when the content errors.
+     * @eventProperty
+     */
     INTEGRATION_ABORT = "integrationabort",
-    /** @eventProperty */
+    /**
+     * When an ad is available.
+     * @eventProperty
+     */
     INTEGRATION_AD_AVAILABLE = "integrationadavailable",
-    /** @eventProperty */
+    /**
+     * When a passback is triggered because of no content or no ad. Only available when {@link IntegrationElement#passback} is set.
+     * @eventProperty
+     */
     INTEGRATION_PASSBACK = "integrationpassback",
-    /** @eventProperty */
+    /**
+     * When the user's consent got updated.
+     * See {@link IntegrationElement#consent} to get the current consent.
+     * @eventProperty
+     */
     USER_UPDATE_CONSENT = "userupdateconsent",
-    /** @eventProperty */
+    /**
+     * When the playlist is updated (e.g. new media item got added). See {@link IntegrationElement#playlist} to get the current playlist items.
+     * @eventProperty
+     */
     PLAYLIST_UPDATE = "playlistupdate",
-    /** @eventProperty */
+    /**
+     * When the player's presentation mode got changed.
+     * @eventProperty
+     */
     PLAYER_SET_PRESENTATION_MODE = "playersetpresentationmode",
-    /** @eventProperty */
+    /**
+     * When content got selected. See {@link IntegrationElement#content} to get the current content.
+     * @eventProperty
+     */
     CONTENT_SELECT = "contentselect",
-    /** @eventProperty */
+    /**
+     * When content started initially (e.g. before ad break).
+     * @eventProperty
+     */
     CONTENT_START = "contentstart",
-    /** @eventProperty */
+    /**
+     * When the first frame of the content got played back.
+     * @eventProperty
+     */
     CONTENT_IMPRESSION = "contentimpression",
-    /** @eventProperty */
+    /**
+     * When content buffering started.
+     * @eventProperty
+     */
     CONTENT_BUFFERING_START = "contentbufferingstart",
-    /** @eventProperty */
+    /**
+     * When content buffering ended.
+     * @eventProperty
+     */
     CONTENT_BUFFERING_END = "contentbufferingend",
-    /** @eventProperty */
+    /**
+     * When content got stopped (e.g. loading another content or it ended normally). The reason is provided in the payload.
+     * It gets triggered after a potential postroll.
+     * @eventProperty
+     */
     CONTENT_STOP = "contentstop",
-    /** @eventProperty */
+    /**
+     * When a content error occurs upon loading or playing the content.
+     * @eventProperty
+     */
     CONTENT_ERROR = "contenterror",
-    /** @eventProperty */
+    /**
+     * When a marker is reached. See {@link MediaItem#markers} how to define own markers.
+     * @eventProperty
+     */
     CONTENT_MARKER_REACHED = "contentmarkerreached",
-    /** @eventProperty */
+    /**
+     * When the content's time updates. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/timeupdate_event HTMLMediaElement.timeupdate}.
+     * See {@link IntegrationElement#currentTime} to get the current time.
+     * @eventProperty
+     */
     CONTENT_TIME_UPDATE = "timeupdate",
-    /** @eventProperty */
+    /**
+     * When the content is seeking. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seeking_event HTMLMediaElement.seeking}.
+     * See {@link IntegrationElement#seeking} to get the current seeking state.
+     * @eventProperty
+     */
     CONTENT_SEEKING = "seeking",
-    /** @eventProperty */
+    /**
+     * When the content has seeked. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/seeked_event HTMLMediaElement.seeked}.
+     * @eventProperty
+     */
     CONTENT_SEEKED = "seeked",
-    /** @eventProperty */
+    /**
+     * When the content switches from paused to playing. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/play_event HTMLMediaElement.play}.
+     * @eventProperty
+     */
     CONTENT_PLAY = "play",
-    /** @eventProperty */
+    /**
+     * When the content switches from playing to paused. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/pause_event HTMLMediaElement.pause}.
+     * @eventProperty
+     */
     CONTENT_PAUSE = "pause",
-    /** @eventProperty */
+    /**
+     * When the content's volume changes. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/volumechange_event HTMLMediaElement.volumechange}.
+     * See {@link IntegrationElement#volume} to get the current volume.
+     * @eventProperty
+     */
     CONTENT_VOLUME_CHANGE = "volumechange",
-    /** @eventProperty */
+    /**
+     * When the content reached its end. This is equal to {@link https://developer.mozilla.org/en-US/docs/Web/API/HTMLMediaElement/ended_event HTMLMediaElement.ended}.
+     * See {@link IntegrationElement#ended} to check if the content ended.
+     * @eventProperty
+     */
     CONTENT_ENDED = "ended",
-    /** @eventProperty */
+    /**
+     * When the first frame of the ad got played back.
+     * See {@link IntegrationElement#currentAd} to get the current ad.
+     * @eventProperty
+     */
     AD_IMPRESSION = "adimpression",
-    /** @eventProperty */
+    /**
+     * When the ad started buffering.
+     * @eventProperty
+     */
     AD_BUFFERING_START = "adbufferingstart",
-    /** @eventProperty */
+    /**
+     * When the ad stopped buffering.
+     * @eventProperty
+     */
     AD_BUFFERING_END = "adbufferingend",
-    /** @eventProperty */
+    /**
+     * When the ad's time updates.
+     * @eventProperty
+     */
     AD_TIME_UPDATE = "adtimeupdate",
-    /** @eventProperty */
+    /**
+     * When the ad's volume changes.
+     * See {@link IntegrationElement#adVolume} to get the current volume.
+     * @eventProperty
+     */
     AD_VOLUME_CHANGE = "advolumechange",
-    /** @eventProperty */
+    /**
+     * When the ad paused.
+     * @eventProperty
+     */
     AD_PAUSED = "adpaused",
-    /** @eventProperty */
+    /**
+     * When the ad resumed.
+     * @eventProperty
+     */
     AD_RESUMED = "adresumed",
-    /** @eventProperty */
+    /**
+     * When the ad was clicked.
+     * @eventProperty
+     */
     AD_CLICK = "adclick",
-    /** @eventProperty */
+    /**
+     * When the ad was skipped.
+     * @eventProperty
+     */
     AD_SKIPPED = "adskipped",
-    /** @eventProperty */
+    /**
+     * When the ad completed.
+     * @eventProperty
+     */
     AD_COMPLETE = "adcomplete"
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@glomex/integration-web-component",
-  "version": "1.1321.0",
+  "version": "1.1322.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.1321.0",
+    "@glomex/integration": "^1.1322.0",
     "@microsoft/api-extractor": "^7.52.1",
     "@rslib/core": "^0.5.4",
     "typescript": "^5.8.2"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ea599e0a4b5cbf460f4985c48eed1fb86572e013"
+  "gitHead": "bf85997c70954b7bb81417c7782567ebd6e4f772"
 }