@oat-sa/tao-core-ui 1.54.2 → 1.55.0

package/dist/mediaplayer/utils/timeObserver.js

@@ -2,53 +2,53 @@ define(['core/eventifier'], function (eventifier) { 'use strict';
 
     eventifier = eventifier && Object.prototype.hasOwnProperty.call(eventifier, 'default') ? eventifier['default'] : eventifier;
 
-    /**
-     * This program is free software; you can redistribute it and/or
-     * modify it under the terms of the GNU General Public License
-     * as published by the Free Software Foundation; under version 2
-     * of the License (non-upgradable).
-     *
-     * This program is distributed in the hope that it will be useful,
-     * but WITHOUT ANY WARRANTY; without even the implied warranty of
-     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-     * GNU General Public License for more details.
-     *
-     * You should have received a copy of the GNU General Public License
-     * along with this program; if not, write to the Free Software
-     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
-     *
-     * Copyright (c) 2021 (original work) Open Assessment Technologies SA ;
+    /**
+     * This program is free software; you can redistribute it and/or
+     * modify it under the terms of the GNU General Public License
+     * as published by the Free Software Foundation; under version 2
+     * of the License (non-upgradable).
+     *
+     * This program is distributed in the hope that it will be useful,
+     * but WITHOUT ANY WARRANTY; without even the implied warranty of
+     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+     * GNU General Public License for more details.
+     *
+     * You should have received a copy of the GNU General Public License
+     * along with this program; if not, write to the Free Software
+     * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+     *
+     * Copyright (c) 2021 (original work) Open Assessment Technologies SA ;
      */
-    /**
-     * Creates a time observer.
-     *
-     * It observes the updates applied to a timeline, raising a flag when an irregularity occurs.
-     *
-     * It works as follow:
-     * - an initial state is defined (example: current: 0, duration: 100)
-     * - each time a position is forced (say the position is changed outside of the regular time update), the observer needs
-     *   to be notified.
-     * - each time the position is updated (say regular time update), the observer needs to be called.
-     * - if the difference between the last regular update and the last one is too high, an event is triggered
-     *
-     * @example
-     * // Create a time observer with an expected interval of 2 seconds
-     * const observer = timeObserverFactory(2);
-     *
-     * // Init the state
-     * observer.start(player.position, player.duration);
-     *
-     * // Update on a regular basis
-     * player.on('timeupdate', () => observer.update(player.position));
-     *
-     * // Notify any position change outside of the regular update
-     * player.on('seek', () => observer.seek(player.position));
-     *
-     * // Gets informed from any irregularity
-     * observer.on('irregularity', () => console.log('irregular jump in time');
-     *
-     * @param {number} interval - The typical interval expected between two updates. It is given in seconds.
-     * @returns {timeObserver}
+    /**
+     * Creates a time observer.
+     *
+     * It observes the updates applied to a timeline, raising a flag when an irregularity occurs.
+     *
+     * It works as follow:
+     * - an initial state is defined (example: current: 0, duration: 100)
+     * - each time a position is forced (say the position is changed outside of the regular time update), the observer needs
+     *   to be notified.
+     * - each time the position is updated (say regular time update), the observer needs to be called.
+     * - if the difference between the last regular update and the last one is too high, an event is triggered
+     *
+     * @example
+     * // Create a time observer with an expected interval of 2 seconds
+     * const observer = timeObserverFactory(2);
+     *
+     * // Init the state
+     * observer.start(player.position, player.duration);
+     *
+     * // Update on a regular basis
+     * player.on('timeupdate', () => observer.update(player.position));
+     *
+     * // Notify any position change outside of the regular update
+     * player.on('seek', () => observer.seek(player.position));
+     *
+     * // Gets informed from any irregularity
+     * observer.on('irregularity', () => console.log('irregular jump in time');
+     *
+     * @param {number} interval - The typical interval expected between two updates. It is given in seconds.
+     * @returns {timeObserver}
      */
 
     function timeObserverFactory() {
@@ -59,47 +59,47 @@ define(['core/eventifier'], function (eventifier) { 'use strict';
       var duration = 0; // Last position forced
 
       var _seek = 0;
-      /**
-       * Defines the API of a time observer.
-       *
-       * It observes the updates applied to a timeline, raising a flag when an irregularity occurs.
-       *
-       * @namespace timeObserver
+      /**
+       * Defines the API of a time observer.
+       *
+       * It observes the updates applied to a timeline, raising a flag when an irregularity occurs.
+       *
+       * @namespace timeObserver
        */
 
       return eventifier({
-        /**
-         * Gets the current time position reported to the observer.
-         *
-         * @returns {number}
-         * @type {number}
-         * @member position
-         * @memberOf timeObserver
+        /**
+         * Gets the current time position reported to the observer.
+         *
+         * @returns {number}
+         * @type {number}
+         * @member position
+         * @memberOf timeObserver
          */
         get position() {
           return position;
         },
 
-        /**
-         * Gets the total duration reported to the observer.
-         *
-         * @returns {number}
-         * @type {number}
-         * @member duration
-         * @memberOf timeObserver
+        /**
+         * Gets the total duration reported to the observer.
+         *
+         * @returns {number}
+         * @type {number}
+         * @member duration
+         * @memberOf timeObserver
          */
         get duration() {
           return duration;
         },
 
-        /**
-         * Initialises the time state.
-         *
-         * @param {number} initPosition - The initial time position
-         * @param {number} initDuration - The total duration expected
-         * @returns {timeObserver}
-         * @function init
-         * @memberOf timeObserver
+        /**
+         * Initialises the time state.
+         *
+         * @param {number} initPosition - The initial time position
+         * @param {number} initDuration - The total duration expected
+         * @returns {timeObserver}
+         * @function init
+         * @memberOf timeObserver
          */
         init: function init(initPosition, initDuration) {
           position = _seek = initPosition;
@@ -107,22 +107,22 @@ define(['core/eventifier'], function (eventifier) { 'use strict';
           return this;
         },
 
-        /**
-         * Updates the time position. If the difference with the previous update is too high, an `irregularity` event
-         * will be emitted.
-         *
-         * @param {number} newPosition - The new time position
-         * @returns {timeObserver}
-         *
-         * @fires irregularity
+        /**
+         * Updates the time position. If the difference with the previous update is too high, an `irregularity` event
+         * will be emitted.
+         *
+         * @param {number} newPosition - The new time position
+         * @returns {timeObserver}
+         *
+         * @fires irregularity
          */
         update: function update(newPosition) {
           if (newPosition > _seek && newPosition - position > interval) {
-            /**
-             * Notifies an irregularity in the time update
-             * @event irregularity
-             * @param {number} position - last regular position
-             * @param {number} newPosition - new irregular position
+            /**
+             * Notifies an irregularity in the time update
+             * @event irregularity
+             * @param {number} position - last regular position
+             * @param {number} newPosition - new irregular position
              */
             this.trigger('irregularity', position, newPosition);
           }
@@ -131,11 +131,11 @@ define(['core/eventifier'], function (eventifier) { 'use strict';
           return this;
         },
 
-        /**
-         * Notifies the observer about a change in the position outside of the regular update.
-         *
-         * @param {number} seekPosition
-         * @returns {timeObserver}
+        /**
+         * Notifies the observer about a change in the position outside of the regular update.
+         *
+         * @param {number} seekPosition
+         * @returns {timeObserver}
          */
         seek: function seek(seekPosition) {
           position = _seek = seekPosition;

package/dist/mediaplayer/youtubeManager.js

@@ -35,24 +35,24 @@ define(['jquery'], function ($) { 'use strict';
     throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
   }
 
-  /**
-   * CDN for the YouTube API
-   * @type {String}
+  /**
+   * CDN for the YouTube API
+   * @type {String}
    */
 
   var youtubeApi = 'https://www.youtube.com/iframe_api';
-  /**
-   * A Regex to extract ID from Youtube URLs
-   * @type {RegExp}
+  /**
+   * A Regex to extract ID from Youtube URLs
+   * @type {RegExp}
    */
 
   var reYoutube = /([?&\/]v[=\/])([\w-]+)([&\/]?)/;
-  /**
-   * Installs a Youtube player. The Youtube API must be ready
-   * @param {String|jQuery|HTMLElement} elem
-   * @param {Object} player
-   * @param {Object} [options]
-   * @param {Boolean} [options.controls]
+  /**
+   * Installs a Youtube player. The Youtube API must be ready
+   * @param {String|jQuery|HTMLElement} elem
+   * @param {Object} player
+   * @param {Object} [options]
+   * @param {Boolean} [options.controls]
    */
 
   function addYoutubePlayer(elem, player) {
@@ -85,10 +85,10 @@ define(['jquery'], function ($) { 'use strict';
       }
     });
   }
-  /**
-   * A local manager for Youtube players.
-   * Relies on https://developers.google.com/youtube/iframe_api_reference
-   * @type {Object}
+  /**
+   * A local manager for Youtube players.
+   * Relies on https://developers.google.com/youtube/iframe_api_reference
+   * @type {Object}
    */
 
 
@@ -99,9 +99,9 @@ define(['jquery'], function ($) { 'use strict';
     var ready = false; // A list of pending players
 
     var pending = [];
-    /**
-     * Checks if the Youtube API is ready to use
-     * @returns {Boolean}
+    /**
+     * Checks if the Youtube API is ready to use
+     * @returns {Boolean}
      */
 
     function isApiReady() {
@@ -119,8 +119,8 @@ define(['jquery'], function ($) { 'use strict';
 
       return apiReady;
     }
-    /**
-     * Injects the Youtube API into the page
+    /**
+     * Injects the Youtube API into the page
      */
 
 
@@ -141,12 +141,12 @@ define(['jquery'], function ($) { 'use strict';
     }
 
     return {
-      /**
-       * Adds a Youtube player
-       * @param {String|jQuery|HTMLElement} elem
-       * @param {Object} player
-       * @param {Object} [options]
-       * @param {Boolean} [options.controls]
+      /**
+       * Adds a Youtube player
+       * @param {String|jQuery|HTMLElement} elem
+       * @param {Object} player
+       * @param {Object} [options]
+       * @param {Boolean} [options.controls]
        */
       add: function add(elem, player, options) {
         if (ready) {
@@ -160,10 +160,10 @@ define(['jquery'], function ($) { 'use strict';
         }
       },
 
-      /**
-       * Removes a pending Youtube player
-       * @param {String|jQuery|HTMLElement} elem
-       * @param {Object} player
+      /**
+       * Removes a pending Youtube player
+       * @param {String|jQuery|HTMLElement} elem
+       * @param {Object} player
        */
       remove: function remove(elem, player) {
         pending.forEach(function (args, idx) {
@@ -173,10 +173,10 @@ define(['jquery'], function ($) { 'use strict';
         });
       },
 
-      /**
-       * Extracts the ID of a Youtube video from an URL
-       * @param {String} url
-       * @returns {String}
+      /**
+       * Extracts the ID of a Youtube video from an URL
+       * @param {String} url
+       * @returns {String}
        */
       extractYoutubeId: function extractYoutubeId(url) {
         var res = reYoutube.exec(url);