@srgssr/pillarbox-web 1.17.0 → 1.18.0

package/dist/types/src/trackers/SRGAnalytics.d.ts

@@ -1,62 +1,58 @@
 export default SRGAnalytics;
+/** @import Player from 'video.js/dist/types/player' */
 /**
- * SRG analytics
- * @class SRGAnalytics
- * @ignore
+ * The SRG analytics class tracks media playback according to the standard defined by SRG SSR.
  *
- * ### Script URL
- * JS script : https://colibri-js.akamaized.net/penguin/tc_SRGGD_11.js
+ * @class SRGAnalytics
  *
  * ### Official documentation
- * Variables list
- * @see https://confluence.srg.beecollaboration.com/display/INTFORSCHUNG/Datalayer+for+media+players
  *
- * Standard event sequences
- * @see https://confluence.srg.beecollaboration.com/display/INTFORSCHUNG/standard+streaming+events%3A+sequence+of+events+for+media+player+actions
+ * - [New variable list]{@link https://srgssr-ch.atlassian.net/wiki/spaces/INTFORSCHUNG/pages/1009353309/Labels+check+for+migration+of+integration+layer+in+SAM}
+ * - [Variables list]{@link https://srgssr-ch.atlassian.net/wiki/spaces/INTFORSCHUNG/pages/795904478/Datalayer+for+media+players}
+ * - [Standard event sequences]{@link https://srgssr-ch.atlassian.net/wiki/spaces/INTFORSCHUNG/pages/795904171/standard+streaming+events+sequence+of+events+for+media+player+actions}
+ * - [Review of Standard Media Actions]{@link https://srgssr-ch.atlassian.net/wiki/spaces/INTFORSCHUNG/pages/795902249/Implementation+Concept+-+draft}
+ * - [ComScore Implementation Guide]{@link https://www.dropbox.com/sh/cdwuikq0abxi21m/AABmSyXYKUTWSAwRZgQA9Ujna/JavaScript%20Latest%20Version?dl=0&preview=Comscore_Library-JavaScript-Streaming_Tag-Implementation_Guide-International.pdf&subfolder_nav_tracking=1}
  *
- * Review of Standard Media Actions
- * @see https://confluence.srg.beecollaboration.com/display/INTFORSCHUNG/Implementation+Concept+-+draft
+ * ### Script URL
  *
- * ComScore Implementation Guide
- * @see https://www.dropbox.com/sh/cdwuikq0abxi21m/AABmSyXYKUTWSAwRZgQA9Ujna/JavaScript%20Latest%20Version?dl=0&preview=Comscore_Library-JavaScript-Streaming_Tag-Implementation_Guide-International.pdf&subfolder_nav_tracking=1
+ * JS script : https://colibri-js.akamaized.net/penguin/tc_SRGGD_11.js
  *
  * ### Variables list
- * - 'event_id', // init | play | stop | pos | pause | seek | uptime | eof
- * - 'event_timestamp', // Seems to be generated automatically from the documentation, but the TP overrides it
- * - 'event_name', // NA TP seems to not sending this variable
- * - 'event_source', // NA TP seems to not sending this variable
- * - 'event_name', // NA TP seems to not sending this variable
- * - 'event_value', // NA TP seems to not sending this variable
- * - 'navigation_environment', // prod | preprod
- * - 'media_subtitles_on', // string true | false
- * - 'media_timeshift', // need better description
- * - 'media_quality', // SD | HD ?
- * - 'media_bandwidth', // NA for the web, 64000
- * - 'media_volume', // from 0 to 100
- * - 'media_embedding_url', //
- * - 'media_player_name', // videojs | letterbox-web ?
- * - 'media_chromecast_selected', // boolean true | false
- * - 'media_player_version', // player's version
- * - 'media_player_display', // is the player mode, on the TP : inline, embed etc..
- * - 'media_audio_track', // NA
- * - 'media_position_real', // NA
- * - 'media_time_spent', // NA
- * - 'device_id', // NA
- * - 'user_id_log_in', // NA only RTS has log in today
- * - 'media_thumbnail', // Not required by the spec but sended by the TP
- * - 'media_bu_distributer', // Not required by the spec but sended by the TP
  *
+ * - event_id: init | play | stop | pos | pause | seek | uptime | eof
+ * - event_timestamp: Seems to be generated automatically from the documentation, but the TP overrides it
+ * - event_name: NA TP seems to not sending this variable
+ * - event_source: NA TP seems to not sending this variable
+ * - event_name: NA TP seems to not sending this variable
+ * - event_value: NA TP seems to not sending this variable
+ * - navigation_environment: prod | preprod
+ * - media_subtitles_on: string true | false
+ * - media_timeshift: need better description
+ * - media_quality: SD | HD ?
+ * - media_bandwidth: NA for the web, 64000
+ * - media_volume: from 0 to 100
+ * - media_embedding_url:
+ * - media_player_name: videojs | letterbox-web ?
+ * - media_chromecast_selected: boolean true | false
+ * - media_player_version: player's version
+ * - media_player_display: is the player mode, on the TP : inline, embed etc..
+ * - media_audio_track: NA
+ * - media_position_real: NA
+ * - media_time_spent: NA
+ * - device_id: NA
+ * - user_id_log_in: NA only RTS has log in today
+ * - media_thumbnail: Not required by the spec but sended by the TP
+ * - media_bu_distributer: Not required by the spec but sended by the TP
  *
  * ### Sequence stories
  *
- * __Story 1 (AoD/VOD-basics)__: A VoD is played. The user does not interact with the player. The VoD plays to its end.
+ * #### Story 1 (AoD/VOD-basics): A VoD is played. The user does not interact with the player. The VoD plays to its end.
  *
  * Hints:
  * - Media sessions always start with PLAY. They end with STOP or EOF (or with PAUSE or last POS)
  * - POS is sent ever 30s
  *
- *
- * __Story 2 (livestream-basics A)__: A Livestream is played. The user does not interact with the player. After 61 seconds, playback is paused.
+ * #### Story 2 (livestream-basics A): A Livestream is played. The user does not interact with the player. After 61 seconds, playback is paused.
  *
  * Hints:
  * - Media sessions always start with PLAY. They end with STOP (or, worse for data quailty, with PAUSE or last POS/UPTIME)
@@ -64,14 +60,12 @@ export default SRGAnalytics;
  * - POS is sent ever 30s, UPTIME every 60s with inital UPTIME after 30s.
  * - This is the interval: 30s: POS + UPTIME; 60s: POS; 90s: POS + UPTIME; ...
  *
- *
- * __Story 3 (Seeking a VoD/AoD)__: A VoD is played. User seeks in the VoD/AoD.
+ * #### Story 3 (Seeking a VoD/AoD): A VoD is played. User seeks in the VoD/AoD.
  *
  * Hints:
  * - Once the Media Player slider is released (seek is over), another action to finish up the seeking is initiated. Typically this is PLAY. For that second PLAY, the media position has altered.
  *
- *
- * __Story 4 (Seeking a livestream)__: A Livestream is played. User goes back in the livestream.
+ * #### Story 4 (Seeking a livestream): A Livestream is played. User goes back in the livestream.
  *
  * Hints:
  * - Once the Media Player slider is released (seek is over), another action to finish up the seeking is initiated. Typically this is PLAY.  For that second PLAY, the a new variable, media_timeshift is passed.
@@ -86,15 +80,21 @@ declare class SRGAnalytics {
      * @returns {Number} Timestamp in seconds
      */
     static now(): number;
-    constructor(player: any, { debug, environment, playerVersion, tagCommanderScriptURL, }?: {
-        debug?: boolean;
-        environment?: string;
-        playerVersion?: string;
-        tagCommanderScriptURL?: string;
-    });
-    isDebugEnabled: boolean;
+    /**
+     * Creates an instance of SRGAnalytics.
+     *
+     * @constructor
+     * @param {Player} player The player instance
+     * @param {SRGAnalyticsOptions} [options={}] Configuration options
+     * @param {boolean} [options.debug=false] Enables debug mode if set to true
+     * @param {string} [options.environment='prod'] The environment in which the data is sent
+     * @param {string} [options.playerVersion='none'] The version of the player
+     * @param {string} [options.tagCommanderScriptURL='//colibri-js.akamaized.net/penguin/tc_SRGGD_11.js'] The URL for the Tag Commander script
+     */
+    constructor(player: Player, { debug, environment, playerVersion, tagCommanderScriptURL, }?: SRGAnalyticsOptions);
+    isDebugEnabled: SRGAnalyticsOptions;
     elapsedPlaybackTime: number;
-    environment: string;
+    environment: SRGAnalyticsOptions;
     hasStarted: boolean;
     heartBeatIntervalId: NodeJS.Timeout;
     initialized: boolean;
@@ -103,11 +103,11 @@ declare class SRGAnalytics {
     mediaSession: number;
     pendingQueue: any[];
     pendingTagCommanderReload: boolean;
-    player: any;
-    playerVersion: string;
+    player: Player;
+    playerVersion: SRGAnalyticsOptions;
     srcMediaData: any;
     startPlaybackSession: number;
-    tagCommanderScriptURL: string;
+    tagCommanderScriptURL: SRGAnalyticsOptions;
     trackedCurrentTime: number;
     uptimeIntervalId: NodeJS.Timeout;
     /**

package/dist/types/src/trackers/SRGAnalytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SRGAnalytics.d.ts","sourceRoot":"","sources":["../../../../src/trackers/SRGAnalytics.js"],"names":[],"mappings":";AAKA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH;IA2mBE;;;;OAIG;IACH,qBAEC;IAjnBD;;;;;OA+BC;IAtBC,wBAA2B;IAC3B,4BAA4B;IAC5B,oBAA8B;IAC9B,oBAAuB;IACvB,oCAAoC;IAEpC,qBAAwB;IACxB,mBAAsB;IACtB,mBAAsB;IACtB,qBAAqB;IACrB,oBAAsB;IACtB,mCAAsC;IACtC,YAAoB;IACpB,sBAAkC;IAClC,kBAA6B;IAC7B,6BAA6B;IAC7B,8BAAkD;IAClD,2BAA2B;IAC3B,iCAAiC;IAMnC;;;;OAIG;IACH,qBAEC;IAED;;OAEG;IACH,oBAIC;IAED;;;;OAIG;IACH,sBAGC;IAED;;;;OAIG;IACH,qBAFa,UAAQ,SAAS,CAQ7B;IAED;;OAEG;IACH,gBAiBC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAgBC;IAED;;;;OAIG;IACH,gBAIC;IAED;;;;OAIG;IACH,cAMC;IAED;;OAEG;IACH,cAmBC;IAED;;;;OAIG;IACH,+BAYC;IAED;;;;OAIG;IACH,8BAUC;IAED;;;;OAIG;IACH,+BAMC;IAED;;;;OAIG;IACH,2BAKC;IAED;;;;OAIG;IACH,iCAMC;IAED;;;;OAIG;IACH,gCAIC;IAED;;;;;;OAMG;IACH,uCAgDC;IAED;;OAEG;IACH,0BAcC;IAED;;;;;;;;;;OAUG;IACH,kBAOC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAYC;IAXC,0BAAwD;IACxD,qBAA8C;IAC9C,mBAA0C;IAC1C,uBAAkD;IAClD,wBAAoD;IACpD,kBAAwC;IACxC,mBAA0C;IAC1C,wBAAoD;IACpD,qBAA8C;IAC9C,wBAAoD;IACpD,qBAA8C;IAGhD;;;;;;;;;;;;;;OAcG;IACH,sBAgBC;IAED;;OAEG;IACH,mBAkBC;IAED;;;;OAIG;IACH,qCAMC;IAED;;;;OAIG;IACH,+BAEC;IAED;;;;OAIG;IACH,sBAOC;IAED;;;;OAIG;IACH,uBAOC;IAED;;;;OAIG;IACH,2BAEC;IAED;;;;OAIG;IACH,8BAEC;IAED;;;;OAIG;IACH,6BAaC;IAED;;;;OAIG;IACH,kBAYC;IAED;;;;OAIG;IACH,mBAKC;IAED;;;;;;OAMG;IACH,oEASC;IAED;;;;OAIG;IACH,oDA6BC;IAWD;;;;OAIG;IACH,aAkBC;IAED;;;;;;;;OAQG;IACH,cAoBC;IAED;;;;;OAKG;IACH,mBAEC;IAED;;OAEG;IACH,oCAOC;IAED;;;;OAIG;IACH,gBAKC;IAED;;;;OAIG;IACH,mBAIC;IAED;;;;OAIG;IACH,sBASC;IAED;;OAEG;IACH,4CAEC;IAED;;;;;;;OAOG;IACH,eAkBC;IAVC,gCASS;IAGX;;;;;;;;;;OAUG;IACH,gBAsBC;CACF"}
+{"version":3,"file":"SRGAnalytics.d.ts","sourceRoot":"","sources":["../../../../src/trackers/SRGAnalytics.js"],"names":[],"mappings":";AAGA,uDAAuD;AAMvD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwEG;AACH;IAsnBE;;;;OAIG;IACH,qBAEC;IA5nBD;;;;;;;;;;OAUG;IACH,iHA+BC;IAtBC,oCAA2B;IAC3B,4BAA4B;IAC5B,iCAA8B;IAC9B,oBAAuB;IACvB,oCAAoC;IAEpC,qBAAwB;IACxB,mBAAsB;IACtB,mBAAsB;IACtB,qBAAqB;IACrB,oBAAsB;IACtB,mCAAsC;IACtC,eAAoB;IACpB,mCAAkC;IAClC,kBAA6B;IAC7B,6BAA6B;IAC7B,2CAAkD;IAClD,2BAA2B;IAC3B,iCAAiC;IAMnC;;;;OAIG;IACH,qBAEC;IAED;;OAEG;IACH,oBAIC;IAED;;;;OAIG;IACH,sBAGC;IAED;;;;OAIG;IACH,qBAFa,UAAQ,SAAS,CAQ7B;IAED;;OAEG;IACH,gBAiBC;IAED;;;;;;;;;;;;;;;OAeG;IACH,gBAgBC;IAED;;;;OAIG;IACH,gBAIC;IAED;;;;OAIG;IACH,cAMC;IAED;;OAEG;IACH,cAmBC;IAED;;;;OAIG;IACH,+BAYC;IAED;;;;OAIG;IACH,8BAUC;IAED;;;;OAIG;IACH,+BAMC;IAED;;;;OAIG;IACH,2BAKC;IAED;;;;OAIG;IACH,iCAMC;IAED;;;;OAIG;IACH,gCAIC;IAED;;;;;;OAMG;IACH,uCAgDC;IAED;;OAEG;IACH,0BAcC;IAED;;;;;;;;;;OAUG;IACH,kBAOC;IAED;;;;;;;;;;;;;;;OAeG;IACH,sBAYC;IAXC,0BAAwD;IACxD,qBAA8C;IAC9C,mBAA0C;IAC1C,uBAAkD;IAClD,wBAAoD;IACpD,kBAAwC;IACxC,mBAA0C;IAC1C,wBAAoD;IACpD,qBAA8C;IAC9C,wBAAoD;IACpD,qBAA8C;IAGhD;;;;;;;;;;;;;;OAcG;IACH,sBAgBC;IAED;;OAEG;IACH,mBAkBC;IAED;;;;OAIG;IACH,qCAMC;IAED;;;;OAIG;IACH,+BAEC;IAED;;;;OAIG;IACH,sBAOC;IAED;;;;OAIG;IACH,uBAOC;IAED;;;;OAIG;IACH,2BAEC;IAED;;;;OAIG;IACH,8BAEC;IAED;;;;OAIG;IACH,6BAaC;IAED;;;;OAIG;IACH,kBAYC;IAED;;;;OAIG;IACH,mBAKC;IAED;;;;;;OAMG;IACH,oEASC;IAED;;;;OAIG;IACH,oDA6BC;IAWD;;;;OAIG;IACH,aAkBC;IAED;;;;;;;;OAQG;IACH,cAoBC;IAED;;;;;OAKG;IACH,mBAEC;IAED;;OAEG;IACH,oCAOC;IAED;;;;OAIG;IACH,gBAKC;IAED;;;;OAIG;IACH,mBAIC;IAED;;;;OAIG;IACH,sBASC;IAED;;OAEG;IACH,4CAEC;IAED;;;;;;;OAOG;IACH,eAkBC;IAVC,gCASS;IAGX;;;;;;;;;;OAUG;IACH,gBAsBC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@srgssr/pillarbox-web",
   "description": "Pillarbox is the modern SRG SSR player",
-  "version": "1.17.0",
+  "version": "1.18.0",
   "type": "module",
   "module": "dist/pillarbox.es.js",
   "main": "dist/pillarbox.cjs.js",

package/dist/types/src/components/typedef.d.ts

@@ -1,14 +0,0 @@
-/**
- * The track to select
- */
-export type TrackSelector = {
-    /**
-     * The track language
-     */
-    language: string;
-    /**
-     * The track kind
-     */
-    kind: string;
-};
-//# sourceMappingURL=typedef.d.ts.map

package/dist/types/src/components/typedef.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedef.d.ts","sourceRoot":"","sources":["../../../../src/components/typedef.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/types/src/middleware/typedef.d.ts

@@ -1,67 +0,0 @@
-import { MainResource } from '../dataProvider/model/typedef';
-import { KeySystems } from '../utils/typedef';
-/**
- * A {@link MainResource} that can contain {@link KeySystems} information.
- */
-export interface MainResourceWithKeySystems extends MainResource, KeySystems {
-}
-/**
- * Represents the result of composing source media data.
- */
-export type ComposedSrcMediaData = {
-    /**
-     * The URL of the source media.
-     */
-    src: string;
-    /**
-     * The MIME type of the source media.
-     */
-    type: string;
-    /**
-     * A mapping of DRM types to their corresponding key systems information.
-     */
-    keySystems: KeySystems;
-    /**
-     * Indicates whether trackers are disabled for the source media.
-     */
-    disableTrackers: boolean;
-    /**
-     * The merged media data from the source and additional media data.
-     */
-    mediaData: MainResource;
-};
-/**
- * Represents a set of options specific to the SRG SSR.
- *
- * __Note__:
- *
- * - All these options have a default value and can therefore be undefined.
- * - DataProvider options cannot be combined with each other.
- */
-export type SrgOptions = {
-    /**
-     * A function returning an object representing a mediaComposition.
-     *
-     * @example
-     * // Must match the following signature
-     * (data: string) => any
-     */
-    dataProvider: undefined | Function;
-    /**
-     * A specific host for a different IL environment.
-     */
-    dataProviderHost: undefined | string;
-    /**
-     * A function for handling a custom data source.
-     *
-     * @example
-     * // Must match the following signature
-     * (contentId: string) => string
-     */
-    dataProviderUrlHandler: undefined | Function;
-    /**
-     * The URL of the TagCommander script.
-     */
-    tagCommanderScriptURL: undefined | string;
-};
-//# sourceMappingURL=typedef.d.ts.map

package/dist/types/src/middleware/typedef.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedef.d.ts","sourceRoot":"","sources":["../../../../src/middleware/typedef.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C;;GAEG;AACH,MAAM,WAAW,0BAA2B,SAAQ,YAAY,EAAE,UAAU;CAE3E;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,SAAS,EAAE,YAAY,CAAC;CACzB,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;;;;;OAMG;IACH,YAAY,EAAE,SAAS,GAAG,QAAQ,CAAC;IACnC;;OAEG;IACH,gBAAgB,EAAE,SAAS,GAAG,MAAM,CAAC;IACrC;;;;;;OAMG;IACH,sBAAsB,EAAE,SAAS,GAAG,QAAQ,CAAC;IAC7C;;OAEG;IACH,qBAAqB,EAAE,SAAS,GAAG,MAAM,CAAC;CAC3C,CAAA"}