Bump video.js to 7.21.2 (latest-7) (#1251)

* Replace videojs 7.20.3 by 7.21.2 (latest-7) + correct some JSDoc formats + Uniformize default DEBUG value to True + Replace some `b` HTML tag by `strong`
EsupPortail · Jan 22, 2025 · 1e8c20f · 1e8c20f
1 parent fd784e2
commit 1e8c20f
Show file tree

Hide file tree

Showing 25 changed files with 228 additions and 228 deletions.
diff --git a/pod/completion/static/js/caption_maker.js b/pod/completion/static/js/caption_maker.js
@@ -324,7 +324,7 @@ var captionBeingDisplayed = -1;
 
 /**
  * Display existing caption
- * @param {[type]} seconds [description]
+ * @param {[type]} seconds - time in seconds
  */
 function displayExistingCaption(seconds) {
   var ci = findCaptionIndex(seconds);
@@ -360,7 +360,7 @@ function existingCaptionsEndTime() {
 
 /**
  * Update captions array.
- * @param  {[type]} vtt [description]
+ * @param  {string} vtt - VTT string
  */
 let updateCaptionsArray = (vtt) => {
   let arr = vtt.split("\n\n");
@@ -665,8 +665,8 @@ let updateCaptionHtmlContent = () => {
 
 /**
  * Update caption.
- * @param {[type]} ci          caption index
- * @param {[type]} captionText caption text
+ * @param {int} ci          - caption index
+ * @param {string} captionText - caption text
  */
 function updateCaption(ci, captionText) {
   captionsArray[ci].caption = captionText;
@@ -677,8 +677,8 @@ let lastEditedBlock = null;
 
 /**
  * Create a caption block object.
- * @param {Object} newCaption    Simple object representing the caption block
- * @param {Function} spawnFunction Function to call after block init
+ * @param {Object} newCaption      - Simple object representing the caption block
+ * @param {Function} spawnFunction - Function to call after block init
  */
 function createCaptionBlock(newCaption, spawnFunction) {
   let captionText = newCaption.caption;
@@ -871,7 +871,7 @@ function createCaptionBlock(newCaption, spawnFunction) {
 
     /**
      * Spawn New Block
-     * @param  {Event} e Triggered Event
+     * @param {Event} e - Triggered Event
      */
     spawnNew: function (e) {
       e.preventDefault();
@@ -900,7 +900,7 @@ function createCaptionBlock(newCaption, spawnFunction) {
 
     /**
      * Delete Block
-     * @param  {Event} e Triggered Event
+     * @param {Event} e - Triggered Event
      */
     delete: function (e) {
       e.preventDefault();
@@ -1140,8 +1140,8 @@ editorShortcuts.init();
 
 /**
  * Add caption list row
- * @param {[type]} ci         [description]
- * @param {[type]} newCaption [description]
+ * @param {int} ci            - Caption index
+ * @param {[type]} newCaption - Caption object
  */
 function addCaptionListRow(ci, newCaption) {
   let vtt = document.getElementById("caption-content");
@@ -1167,9 +1167,9 @@ function addCaptionListRow(ci, newCaption) {
 
 /**
  * Add caption
- * @param {[type]} captionStart [description]
- * @param {[type]} captionEnd   [description]
- * @param {[type]} captionText  [description]
+ * @param {[type]} captionStart - Start time
+ * @param {[type]} captionEnd   - End time
+ * @param {[type]} captionText  - Caption content
  */
 function addCaption(captionStart, captionEnd, captionText) {
   const pod = document.getElementById("podvideoplayer");
@@ -1190,8 +1190,8 @@ function addCaption(captionStart, captionEnd, captionText) {
 
 /**
  * Convert HMS time format to seconds only
- * @param  {string} str hms
- * @return {number}     corresponding seconds
+ * @param  {string} str - hms
+ * @return {number}     - corresponding seconds
  */
 function hmsToSecondsOnly(str) {
   let p = str.split(":"),
@@ -1206,7 +1206,7 @@ function hmsToSecondsOnly(str) {
 
 /**
  * Parses webvtt time string format into floating point seconds
- * @param {[type]} sTime [description]
+ * @param {[type]} sTime - Webvtt time string
  */
 function parseTime(sTime) {
   let seconds = hmsToSecondsOnly(sTime);
@@ -1228,7 +1228,7 @@ function parseTime(sTime) {
 
 /**
  * formats floating point seconds into the webvtt time string format
- * @param {[type]} seconds [description]
+ * @param {[type]} seconds - floating point seconds
  */
 function formatTime(seconds) {
   var hh = Math.floor(seconds / (60 * 60));
@@ -1246,7 +1246,7 @@ function formatTime(seconds) {
 
 /**
  * Find caption index
- * @param {[type]} seconds [description]
+ * @param {[type]} seconds - Time in seconds
  */
 function findCaptionIndex(seconds) {
   var below = -1;
@@ -1268,7 +1268,7 @@ function findCaptionIndex(seconds) {
 
 /**
  * Play selected caption
- * @param  {[type]} timeline [description]
+ * @param {string} timeline -
  */
 function playSelectedCaption(timeline) {
   if (timeline.includes("-->")) {
@@ -1288,7 +1288,7 @@ function playSelectedCaption(timeline) {
 
 /**
  * Escape Html entities
- * @param {string} s String to be escaped
+ * @param {string} s - String to be escaped
  */
 function XMLEncode(s) {
   return s
@@ -1302,7 +1302,7 @@ function XMLEncode(s) {
 
 /**
  * Decode Html entities
- * @param {String} s String to be decoded
+ * @param {String} s - String to be decoded
  */
 function XMLDecode(s) {
   return s
@@ -1315,7 +1315,7 @@ function XMLDecode(s) {
 
 /**
  * Load caption file
- * @param {[type]} fileObject [description]
+ * @param {[type]} fileObject - File object to be loaded
  */
 /*
 function loadCaptionFile(fileObject) {
@@ -1344,7 +1344,7 @@ function loadCaptionFile(fileObject) {
 
 /**
  * Invoked by script insertion of proxyvtt.ashx
- * @param {[type]} obj [description]
+ * @param {[type]} obj -
  */
 function processProxyVttResponse(obj) {
   obj = JSON.parse(obj);
@@ -1376,7 +1376,7 @@ function processProxyVttResponse(obj) {
 
 /**
  * Partial parser for WebVTT files based on the spec at http://dev.w3.org/html5/webvtt/
- * @param {[type]} vtt [description]
+ * @param {[type]} vtt - VTT file content
  */
 function parseAndLoadWebVTT(vtt) {
   var vttLines = vtt.split(/\r\n|\r|\n/); // create an array of lines from our file
@@ -1460,8 +1460,8 @@ const registerPlugin = videojs.registerPlugin || videojs.plugin;
 
 /**
  * On player ready Event
- * @param  {[type]} player  [description]
- * @param  {[type]} options [description]
+ * @param {[type]} player  - Video player
+ * @param {[type]} options - Options (not used ?)
  */
 const onPlayerReady = function (player, options) {
   let startKeyframe;
@@ -1483,8 +1483,8 @@ const onPlayerReady = function (player, options) {
 
   /**
    * Highlight video region
-   * @param  {[type]} startTime [description]
-   * @param  {[type]} endTime   [description]
+   * @param {[type]} startTime - Start time in seconds
+   * @param {[type]} endTime   - End time in seconds
    */
   highlightVideoRegion = function (startTime, endTime) {
     clearVideoRegion();
@@ -1520,7 +1520,7 @@ const onPlayerReady = function (player, options) {
 
 /**
  * Seek video player to absolute `time`.
- * @param  {[type]} time [description]
+ * @param {[type]} time - absolute time target
  */
 function seekVideoTo(time) {
   player.userActive(true);
@@ -1529,7 +1529,7 @@ function seekVideoTo(time) {
 
 /**
  * Seek video player to relative `time`.
- * @param  {[type]} time [description]
+ * @param {[type]} time - relative time target
  */
 function seekVideo(time) {
   player.userActive(true);
@@ -1538,7 +1538,7 @@ function seekVideo(time) {
 
 /**
  * Timeline regions
- * @param  {[type]} options [description]
+ * @param {[type]} options - Video player options
  */
 function timelineRegions(options) {
   this.ready(function () {

diff --git a/pod/completion/static/js/completion.js b/pod/completion/static/js/completion.js
@@ -85,11 +85,11 @@ document.addEventListener("submit", (e) => {
 /**
  * Send and get form.
  *
- * @param elt {HTMLElement} HTML element.
- * @param action {string} Action.
- * @param name {string} Name.
- * @param form {string} Form.
- * @param list {string} List.
+ * @param {HTMLElement} elt - HTML element.
+ * @param {string} action - Action.
+ * @param {string} name - Name.
+ * @param {string} form - Form.
+ * @param {string} list - List.
  *
  * @return {Promise<void>} The form promise.
  */

diff --git a/pod/enrichment/static/js/videojs-slides.js b/pod/enrichment/static/js/videojs-slides.js
@@ -243,7 +243,7 @@ var VideoSlides = function (items) {
   /**
    * slideShow function to show the current slide according to the time.
    *
-   * @param {number} time the current video time
+   * @param {number} time - the current video time
    * @return {void} doesn't return anything
    * @function slideShow
    */

diff --git a/pod/live/management/commands/checkLiveStartStop.py b/pod/live/management/commands/checkLiveStartStop.py
@@ -18,7 +18,7 @@
 )
 
 DEFAULT_EVENT_PATH = getattr(settings, "DEFAULT_EVENT_PATH", "")
-DEBUG = getattr(settings, "DEBUG", "")
+DEBUG = getattr(settings, "DEBUG", True)
 TIME_ZONE = getattr(settings, "TIME_ZONE", "Europe/Paris")
 
 

diff --git a/pod/main/static/js/admin.js b/pod/main/static/js/admin.js
@@ -13,7 +13,7 @@ const fieldHtml = document.getElementsByClassName("field-html")[0];
 /**
  * Function for show field.
  *
- * @param {HTMLElement} field The field to show.
+ * @param {HTMLElement} field - The field to show.
  */
 function showField(field) {
   field.classList.remove("d-none");
@@ -23,7 +23,7 @@ function showField(field) {
 /**
  * Function for hide field.
  *
- * @param {HTMLElement} field The field to hide.
+ * @param {HTMLElement} field - The field to hide.
  */
 function hideField(field) {
   field.classList.remove("d-block");

diff --git a/pod/main/static/js/utils.js b/pod/main/static/js/utils.js
@@ -13,8 +13,8 @@ Utils.prototype = {
   constructor: Utils,
   /**
    * Check if element is partial/fully in screen view
-   * @param element {HTMLElement} element to check
-   * @param fullyInView {Boolean} check full in view
+   * @param {HTMLElement} element - element to check
+   * @param {Boolean} fullyInView - check full in view
    **/
   isElementInView: function (element, fullyInView) {
     const pageTop = $(window).scrollTop();

diff --git a/pod/meeting/static/js/my_meetings.js b/pod/meeting/static/js/my_meetings.js
@@ -93,18 +93,18 @@ meetingModal.addEventListener("show.bs.modal", function (event) {
 /* TODO: check if level parameter can be removed. */
 /**
  * Recursively generate an HTML unordered list version of data
- * @param  {Array} data   Data to be displayed
- * @param  {Number} level level of recursion (useless?)
- * @return {string}       Generated HTML
+ * @param  {Array}  data  - Data to be displayed
+ * @param  {Number} level - level of recursion (useless?)
+ * @return {string} Generated HTML
  */
 function generateHtml(data, level = 0) {
   let html = "<ul>";
   for (let k in data) {
     if (typeof data[k] === "object") {
       html +=
-        "<li><b>" + k + ":</b> " + generateHtml(data[k], level++) + "</li>";
+        "<li><strong>" + k + ":</strong> " + generateHtml(data[k], level++) + "</li>";
     } else {
-      html += "<li><b>" + k + ":</b> " + data[k] + "</li>";
+      html += "<li><strong>" + k + ":</strong> " + data[k] + "</li>";
     }
   }
   html += "</ul>";

diff --git a/pod/package.json b/pod/package.json
@@ -11,7 +11,7 @@
     "jquery-ui-dist": "^1.13.2",
     "js-cookie": "^3.0.5",
     "spark-md5": "^3.0.2",
-    "video.js": "7.20.3",
+    "video.js": "latest-7",
     "videojs-contrib-quality-levels": "^3.0.0",
     "videojs-hls-quality-selector": "^1.1.4",
     "videojs-overlay": "^3.1.0",

diff --git a/pod/playlist/static/playlist/js/add-or-edit.js b/pod/playlist/static/playlist/js/add-or-edit.js
@@ -6,7 +6,7 @@
 /**
  * Hide or show the password field. If it is show, it is required.
  *
- * @param {boolean} toHide For hide the field, set to `true`.
+ * @param {boolean} toHide - To hide the field, set to `true`.
  */
 function hidePasswordField(toHide) {
   if (toHide) {
@@ -22,8 +22,8 @@ function hidePasswordField(toHide) {
 /**
  * Update the visibility for the help text.
  *
- * @param {string} visibility The new visibility.
- * @param {HTMLElement} helpText The help text element.
+ * @param {string} visibility - The new visibility.
+ * @param {HTMLElement} helpText - The help text element.
  */
 function updateVisibilityHelpText(visibility, helpText) {
   if (visibility == 'public') {

diff --git a/pod/playlist/static/playlist/js/playlist-player.js b/pod/playlist/static/playlist/js/playlist-player.js
@@ -131,7 +131,7 @@ function switchToNextVideo() {
 /**
  * Update the URL without refresh the page.
  *
- * @param {string} newUrl The new URL.
+ * @param {string} newUrl - The new URL.
  */
 function updateUrl(newUrl) {
   history.pushState({}, document.title, newUrl);
@@ -141,8 +141,8 @@ function updateUrl(newUrl) {
 /**
  * Refresh element with the DocumentFragment.
  *
- * @param {string} elementQuerySelector The query selector for the element.
- * @param {*} html The html code.
+ * @param {string} elementQuerySelector - The query selector for the element.
+ * @param {*} html - The html code.
  */
 function refreshElementWithDocumentFragment(elementQuerySelector, newHTMLContent) {
   const fragment = document.createDocumentFragment();
@@ -188,7 +188,7 @@ function asyncStartCountDown() {
 /**
  * Start the count down.
  *
- * @param {function} callback The call back function.
+ * @param {function} callback - The call back function.
  */
 function startCountdown(callback) {
   countdownElement.textContent = playlistCount;