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

package/dist/taskQueue/taskQueueModel.js

@@ -61,11 +61,11 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
     } //infinite
     ]
   };
-  /**
-   * Check if two tasks have equivalent task status
-   * @param {Object} task1 - a task object to be compared
-   * @param {Object} task2 - another task object to be compared
-   * @returns {Boolean}
+  /**
+   * Check if two tasks have equivalent task status
+   * @param {Object} task1 - a task object to be compared
+   * @param {Object} task2 - another task object to be compared
+   * @returns {Boolean}
    */
 
   function hasSameState(task1, task2) {
@@ -91,36 +91,36 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
       return item;
     });
   }
-  /**
-   * Create a task queue model to communicates with the server REST API
-   *
-   * @param {Object} config
-   * @param {Object} config.url - the list of server endpoints
-   * @param {String} config.url.get - the url to get the status log for a single task
-   * @param {String} config.url.archive - the url to archive a task
-   * @param {String} config.url.all - the url to get the status for all tasks for the current user
-   * @param {String} config.url.download - the url to download a file created by the task
-   * @param {Array} config.pollSingleIntervals - the array of poll intervals that will be used to regulate the polling speed for a simple task
-   *         e.g. {iteration: 4, interval:1000} means that it will poll up to four times every 1000ms.
-   * @param {Array} config.pollAllIntervals - the array of poll intervals that will be used to regulate the main polling speed.
-   *         e.g. {iteration: 10, interval:1000} means that it will poll up to 10 times every 5000ms.
-   *         e.g. {iteration: 0, interval:10000} means that it will poll up to 10000ms indefinitely
-   *
-   * @return {taskQueueModel}
+  /**
+   * Create a task queue model to communicates with the server REST API
+   *
+   * @param {Object} config
+   * @param {Object} config.url - the list of server endpoints
+   * @param {String} config.url.get - the url to get the status log for a single task
+   * @param {String} config.url.archive - the url to archive a task
+   * @param {String} config.url.all - the url to get the status for all tasks for the current user
+   * @param {String} config.url.download - the url to download a file created by the task
+   * @param {Array} config.pollSingleIntervals - the array of poll intervals that will be used to regulate the polling speed for a simple task
+   *         e.g. {iteration: 4, interval:1000} means that it will poll up to four times every 1000ms.
+   * @param {Array} config.pollAllIntervals - the array of poll intervals that will be used to regulate the main polling speed.
+   *         e.g. {iteration: 10, interval:1000} means that it will poll up to 10 times every 5000ms.
+   *         e.g. {iteration: 0, interval:10000} means that it will poll up to 10000ms indefinitely
+   *
+   * @return {taskQueueModel}
    */
 
 
   function taskQueueModel(config) {
     var model;
-    /**
-     * cached array of task data
-     * @type {Object}
+    /**
+     * cached array of task data
+     * @type {Object}
      */
 
     var _cache;
-    /**
-     * store instance of single polling
-     * @type {Object}
+    /**
+     * store instance of single polling
+     * @type {Object}
      */
 
 
@@ -139,15 +139,15 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
     };
 
     config = _.defaults(config || {}, _defaults);
-    /**
-     * @typedef taskQueueModel - central model to query the backend's REST API for task queue
+    /**
+     * @typedef taskQueueModel - central model to query the backend's REST API for task queue
      */
 
     model = eventifier({
-      /**
-       * Modify the task queue REST API endpoints
-       * @param urls - the new endpoints
-       * @returns {taskQueueModel}
+      /**
+       * Modify the task queue REST API endpoints
+       * @param urls - the new endpoints
+       * @returns {taskQueueModel}
        */
       setEndpoints: function setEndpoints(urls) {
         _.assign(config.url, urls || {});
@@ -155,11 +155,11 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return this;
       },
 
-      /**
-       * Get the status of a task identified by its unique task id
-       *
-       * @param {String} taskId - unique task identifier
-       * @returns {Promise}
+      /**
+       * Get the status of a task identified by its unique task id
+       *
+       * @param {String} taskId - unique task identifier
+       * @returns {Promise}
        */
       get: function get(taskId) {
         var status;
@@ -202,9 +202,9 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return status;
       },
 
-      /**
-       * Get the task data, but try the cache first!
-       * @returns {Promise}
+      /**
+       * Get the task data, but try the cache first!
+       * @returns {Promise}
        */
       getCached: function getCached(taskId) {
         if (_cache && _cache[taskId]) {
@@ -214,10 +214,10 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return this.get(taskId);
       },
 
-      /**
-       * Get the status of all task identified by their unique task id
-       *
-       * @returns {Promise} - resolved when the server response has been received
+      /**
+       * Get the status of all task identified by their unique task id
+       *
+       * @returns {Promise} - resolved when the server response has been received
        */
       getAll: function getAll() {
         var status;
@@ -269,11 +269,11 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return status;
       },
 
-      /**
-       * Remove a task identified by its unique task id
-       *
-       * @param {String} taskId - the task id
-       * @returns {Promise} - resolved when achive action done
+      /**
+       * Remove a task identified by its unique task id
+       *
+       * @param {String} taskId - the task id
+       * @returns {Promise} - resolved when achive action done
        */
       archive: function archive(taskId) {
         var status;
@@ -291,19 +291,19 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return status;
       },
 
-      /**
-       * Poll status for all tasks
-       * @param {Boolean} [immediate] - tells if the polling should immediately start (otherwise, will wait until the next iteration)
-       * @returns {taskQueueModel}
+      /**
+       * Poll status for all tasks
+       * @param {Boolean} [immediate] - tells if the polling should immediately start (otherwise, will wait until the next iteration)
+       * @returns {taskQueueModel}
        */
       pollAll: function pollAll(immediate) {
         var self = this;
         var loop = 0;
         var pollingIntervals = getPollAllIntervals();
-        /**
-         * gradually increase the polling interval to ease server load
-         * @private
-         * @param {Object} pollingInstance - a poll object
+        /**
+         * gradually increase the polling interval to ease server load
+         * @private
+         * @param {Object} pollingInstance - a poll object
          */
 
         var _updateInterval = function _updateInterval(pollingInstance) {
@@ -367,9 +367,9 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return model;
       },
 
-      /**
-       * Stop the main polling action
-       * @returns {taskQueueModel}
+      /**
+       * Stop the main polling action
+       * @returns {taskQueueModel}
        */
       pollAllStop: function pollAllStop() {
         if (this.globalPolling) {
@@ -380,19 +380,19 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return this;
       },
 
-      /**
-       * Start a single fast polling for a single task id
-       * @param {String} taskId - the task id
-       * @returns {Promise} resolved when the single polling action finishes
+      /**
+       * Start a single fast polling for a single task id
+       * @param {String} taskId - the task id
+       * @returns {Promise} resolved when the single polling action finishes
        */
       pollSingle: function pollSingle(taskId) {
         var self = this;
         var loop = 0;
         var pollingIntervals = getPollSingleIntervals();
-        /**
-         * gradually increase the polling interval to ease server load
-         * @private
-         * @param {Object} pollingInstance - a poll object
+        /**
+         * gradually increase the polling interval to ease server load
+         * @private
+         * @param {Object} pollingInstance - a poll object
          */
 
         var _updateInterval = function _updateInterval(pollingInstance) {
@@ -461,10 +461,10 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         });
       },
 
-      /**
-       * Interrupt a single polling action
-       * @param {String} taskId - the task id
-       * @returns {model}
+      /**
+       * Interrupt a single polling action
+       * @param {String} taskId - the task id
+       * @returns {model}
        */
       pollSingleStop: function pollSingleStop(taskId) {
         if (singlePollings && singlePollings[taskId]) {
@@ -475,11 +475,11 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return this;
       },
 
-      /**
-       * Call a task creation url
-       * @param {String} url - the server side task queue creation service
-       * @param {Object} [data] - request data
-       * @returns {promise} - resolved when task creation response is sent back by the server
+      /**
+       * Call a task creation url
+       * @param {String} url - the server side task queue creation service
+       * @param {Object} [data] - request data
+       * @returns {promise} - resolved when task creation response is sent back by the server
        */
       create: function create(url, data) {
         var taskCreate,
@@ -513,10 +513,10 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         return taskCreate;
       },
 
-      /**
-       * Call the task result file download endpoint
-       * @param {String} taskId - the task id
-       * @returns {promise} - resolved when the download popup is shown
+      /**
+       * Call the task result file download endpoint
+       * @param {String} taskId - the task id
+       * @returns {promise} - resolved when the download popup is shown
        */
       download: function download(taskId) {
         if (!config.url || !config.url.download) {
@@ -539,10 +539,10 @@ define(['jquery', 'lodash', 'i18n', 'core/eventifier', 'core/polling', 'core/dat
         });
       },
 
-      /**
-       * Call the task result redirection endpoint
-       * @param {String} taskId - the task id
-       * @returns {Promise}
+      /**
+       * Call the task result redirection endpoint
+       * @param {String} taskId - the task id
+       * @returns {Promise}
        */
       redirect: function redirect(taskId) {
         return this.getCached(taskId).then(function (taskData) {

package/dist/taskQueue.js

@@ -5,34 +5,34 @@ define(['lodash', 'core/eventifier', 'core/dataProvider/request', 'core/polling'
     request = request && Object.prototype.hasOwnProperty.call(request, 'default') ? request['default'] : request;
     polling = polling && Object.prototype.hasOwnProperty.call(polling, 'default') ? polling['default'] : polling;
 
-    /**
-     * 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) 2017 (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) 2017 (original work) Open Assessment Technologies SA ;
      */
     var _defaults = {
       url: {}
     };
-    /**
-     * Builds a task queue management API
-     *
-     * @param {Object} config - the API config
-     * @param {Object} [config.url] - The list of task queue endpoints
-     * @param {String} [config.url.status] - the get status endpoint
-     * @param {String} [config.url.remove] - the remove task endpoint
-     * @returns {taskQueueApi}
+    /**
+     * Builds a task queue management API
+     *
+     * @param {Object} config - the API config
+     * @param {Object} [config.url] - The list of task queue endpoints
+     * @param {String} [config.url.status] - the get status endpoint
+     * @param {String} [config.url.remove] - the remove task endpoint
+     * @returns {taskQueueApi}
      */
 
     function taskQueueApi(config) {
@@ -52,11 +52,11 @@ define(['lodash', 'core/eventifier', 'core/dataProvider/request', 'core/polling'
       }];
       var poll;
       var api = eventifier({
-        /**
-         * Get the status of a task identified by its unique task id
-         *
-         * @param {String} taskId - unique task identifier
-         * @returns {Promise}
+        /**
+         * Get the status of a task identified by its unique task id
+         *
+         * @param {String} taskId - unique task identifier
+         * @returns {Promise}
          */
         getStatus: function getStatus(taskId) {
           var status;
@@ -81,11 +81,11 @@ define(['lodash', 'core/eventifier', 'core/dataProvider/request', 'core/polling'
           return status;
         },
 
-        /**
-         * Poll the status of a task
-         *
-         * @param {String} taskId - unique task identifier
-         * @returns {taskQueueApi}
+        /**
+         * Poll the status of a task
+         *
+         * @param {String} taskId - unique task identifier
+         * @returns {taskQueueApi}
          */
         pollStatus: function pollStatus(taskId) {
           var loop = 0;
@@ -93,10 +93,10 @@ define(['lodash', 'core/eventifier', 'core/dataProvider/request', 'core/polling'
           if (!config.url || !config.url.status) {
             throw new TypeError('config.url.status is not configured while getStatus() is being called');
           }
-          /**
-           * gradually increase the polling interval to ease server load
-           * @private
-           * @param {Object} pollingInstance - a poll object
+          /**
+           * gradually increase the polling interval to ease server load
+           * @private
+           * @param {Object} pollingInstance - a poll object
            */
 
 
@@ -144,10 +144,10 @@ define(['lodash', 'core/eventifier', 'core/dataProvider/request', 'core/polling'
           return api;
         },
 
-        /**
-         * Stop the current polling
-         *
-         * @returns {taskQueueApi}
+        /**
+         * Stop the current polling
+         *
+         * @returns {taskQueueApi}
          */
         pollStop: function pollStop() {
           if (poll) {
@@ -158,11 +158,11 @@ define(['lodash', 'core/eventifier', 'core/dataProvider/request', 'core/polling'
           return api;
         },
 
-        /**
-         * Remove a task identified by its unique task id
-         *
-         * @param {String} taskId - unique task identifier
-         * @returns {Promise}
+        /**
+         * Remove a task identified by its unique task id
+         *
+         * @param {String} taskId - unique task identifier
+         * @returns {Promise}
          */
         remove: function remove(taskId) {
           var status;

package/dist/taskQueueButton/css/taskable.css

@@ -1,14 +1,14 @@
-/*
-Usage:
-- linear-gradient((color1, color2, color3)) - returns linear-gradient with evenly distributed colors,
-   if 3 colors used then the position of each will be 33,33%
-- linear-gradient((color1 0%, color2 30%, color3 80%)) - returns linear-gradient with manually distributed colors,
-   first param - color, second - position. Also you can use px or other valid units for set position.
+/*
+Usage:
+- linear-gradient((color1, color2, color3)) - returns linear-gradient with evenly distributed colors,
+   if 3 colors used then the position of each will be 33,33%
+- linear-gradient((color1 0%, color2 30%, color3 80%)) - returns linear-gradient with manually distributed colors,
+   first param - color, second - position. Also you can use px or other valid units for set position.
 */
 /* based on "visually-hidden" mixin in LDS for accessibility goals */
 /* Do not edit */
 div.task-report-container {
     width: 100%;
 }
-
+
 /*# sourceMappingURL=taskable.css.map */

package/dist/taskQueueButton/css/treeButton.css

@@ -1,9 +1,9 @@
-/*
-Usage:
-- linear-gradient((color1, color2, color3)) - returns linear-gradient with evenly distributed colors,
-   if 3 colors used then the position of each will be 33,33%
-- linear-gradient((color1 0%, color2 30%, color3 80%)) - returns linear-gradient with manually distributed colors,
-   first param - color, second - position. Also you can use px or other valid units for set position.
+/*
+Usage:
+- linear-gradient((color1, color2, color3)) - returns linear-gradient with evenly distributed colors,
+   if 3 colors used then the position of each will be 33,33%
+- linear-gradient((color1 0%, color2 30%, color3 80%)) - returns linear-gradient with manually distributed colors,
+   first param - color, second - position. Also you can use px or other valid units for set position.
 */
 /* based on "visually-hidden" mixin in LDS for accessibility goals */
 /* Do not edit */
@@ -44,5 +44,5 @@ Usage:
 .tree-button-component.started .start-icon {
     display: none !important;
 }
-
+
 /*# sourceMappingURL=treeButton.css.map */

package/dist/taskQueueButton/standardButton.js

@@ -4,44 +4,44 @@ define(['lodash', 'ui/loadingButton/loadingButton', 'ui/taskQueueButton/taskable
     loadingButton = loadingButton && Object.prototype.hasOwnProperty.call(loadingButton, 'default') ? loadingButton['default'] : loadingButton;
     makeTaskable = makeTaskable && Object.prototype.hasOwnProperty.call(makeTaskable, 'default') ? makeTaskable['default'] : makeTaskable;
 
-    /**
-     * 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) 2017 (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) 2017 (original work) Open Assessment Technologies SA;
      */
     var defaultConfig = {};
-    /**
-     * Builds a standard task creation button
-     *
-     * @param {Object} config - the component config
-     * @param {String} config.type - the icon type (info, success, error)
-     * @param {String} config.icon - the button icon
-     * @param {String} config.label - the button's label
-     * @param {String} [config.title] - the button's title
-     * @param {String} [config.terminatedLabel] - the button's label when terminated
-     * @param {Object} config.taskQueue - the task queue model to be used
-     * @param {String} config.taskCreationUrl - endpoint to create a task
-     * @param {Object|Function} [config.taskCreationData] - the parameters that will be send to the task creation request
-     * @param {JQuery} [config.taskReportContainer] - the container where the inline report can be printed to
-     * @returns {standardTaskButton} the component
-     *
-     * @event started - Emitted when the button is clicked and the triggered action supposed to be started
-     * @event terminated - Emitted when the button action is stopped, interrupted
-     * @event reset - Emitted when the button revert from the terminated stated to the initial one
-     * @event finished - When task is finished within the polling duration allowed by the task queue model
-     * @event enqueued - when task has not time to finish within the polling duration allowed by the task queue model
+    /**
+     * Builds a standard task creation button
+     *
+     * @param {Object} config - the component config
+     * @param {String} config.type - the icon type (info, success, error)
+     * @param {String} config.icon - the button icon
+     * @param {String} config.label - the button's label
+     * @param {String} [config.title] - the button's title
+     * @param {String} [config.terminatedLabel] - the button's label when terminated
+     * @param {Object} config.taskQueue - the task queue model to be used
+     * @param {String} config.taskCreationUrl - endpoint to create a task
+     * @param {Object|Function} [config.taskCreationData] - the parameters that will be send to the task creation request
+     * @param {JQuery} [config.taskReportContainer] - the container where the inline report can be printed to
+     * @returns {standardTaskButton} the component
+     *
+     * @event started - Emitted when the button is clicked and the triggered action supposed to be started
+     * @event terminated - Emitted when the button action is stopped, interrupted
+     * @event reset - Emitted when the button revert from the terminated stated to the initial one
+     * @event finished - When task is finished within the polling duration allowed by the task queue model
+     * @event enqueued - when task has not time to finish within the polling duration allowed by the task queue model
      */
 
     function standardTaskButtonFactory(config) {
@@ -50,9 +50,9 @@ define(['lodash', 'ui/loadingButton/loadingButton', 'ui/taskQueueButton/taskable
       config = _.defaults(config || {}, defaultConfig); //create the base loading button and make it taskable
 
       component = makeTaskable(loadingButton(config));
-      /**
-       * The component
-       * @typedef {ui/component} standardTaskButton
+      /**
+       * The component
+       * @typedef {ui/component} standardTaskButton
        */
 
       return component.on('started', function () {