@oat-sa/tao-core-ui 1.60.2 → 1.61.0

package/dist/lock.js

@@ -23,24 +23,24 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
     hb.registerHelper('__', function (key) {
       return __(key);
     });
-    /**
-     * Register dompurify helper
-     *
-     * https://github.com/cure53/DOMPurify
-     * with config SAFE_FOR_TEMPLATES: true
-     * to make output safe for template systems
+    /**
+     * Register dompurify helper
+     *
+     * https://github.com/cure53/DOMPurify
+     * with config SAFE_FOR_TEMPLATES: true
+     * to make output safe for template systems
      */
 
     hb.registerHelper('dompurify', function (context) {
       return DOMPurify.sanitize(context);
     });
-    /**
-     * Register join helper
-     *
-     * Example :
-     * var values = {a:v1, b:v2, c:v3};
-     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
-     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
+    /**
+     * Register join helper
+     *
+     * Example :
+     * var values = {a:v1, b:v2, c:v3};
+     * Using {{{join attributes '=' ' ' '"'}}} will return : a="v1" b="v2" c="v3"
+     * Using {{{join values null ' or ' '*'}}} will return : *v1* or *v2* or *v3*
      */
 
     hb.registerHelper('join', function (arr, keyValueGlue, fragmentGlue, wrapper) {
@@ -123,7 +123,7 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
     if (helper = helpers.level) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.level); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\">\r\n<span class=\"icon-lock ";
+      + "\">\n<span class=\"icon-lock ";
     if (helper = helpers.level) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.level); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
@@ -131,19 +131,19 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
     if (helper = helpers.level) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.level); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\"></span>\r\n    ";
+      + "\"></span>\n    ";
     if (helper = helpers.msg) { stack1 = helper.call(depth0, {hash:{},data:data}); }
     else { helper = (depth0 && depth0.msg); stack1 = typeof helper === functionType ? helper.call(depth0, {hash:{},data:data}) : helper; }
     buffer += escapeExpression(stack1)
-      + "\r\n    <div class=\"txt-rgt button-container\">\r\n        <button class=\"btn btn-info small check-in\"><span class=\"icon-unlock info\"></span>"
+      + "\n    <div class=\"txt-rgt button-container\">\n        <button class=\"btn btn-info small check-in\"><span class=\"icon-unlock info\"></span>"
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Check-in", options) : helperMissing.call(depth0, "__", "Check-in", options)))
-      + "</button>\r\n        <button class=\"btn btn-info small release\"><span class=\"icon-result-nok info\"></span>"
+      + "</button>\n        <button class=\"btn btn-info small release\"><span class=\"icon-result-nok info\"></span>"
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Release", options) : helperMissing.call(depth0, "__", "Release", options)))
-      + "</button>\r\n    </div>\r\n\r\n    <div class=\"message-container button-container\" style=\"display: none;\">\r\n            <label>\r\n                "
+      + "</button>\n    </div>\n\n    <div class=\"message-container button-container\" style=\"display: none;\">\n            <label>\n                "
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Message", options) : helperMissing.call(depth0, "__", "Message", options)))
-      + "\r\n            </label>\r\n            <input type=\"text\" name=\"message\" class=\"message\">\r\n            <button class=\"btn-info small commit\">"
+      + "\n            </label>\n            <input type=\"text\" name=\"message\" class=\"message\">\n            <button class=\"btn-info small commit\">"
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Commit", options) : helperMissing.call(depth0, "__", "Commit", options)))
-      + "</button>\r\n    </div>\r\n</div>\r\n";
+      + "</button>\n    </div>\n</div>\n";
     return buffer;
     });
   function tpl(data, options, asString) {
@@ -151,24 +151,24 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
     return (asString || true) ? html : $(html);
   }
 
-  /**
-   * 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) 2015 (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) 2015 (original work) Open Assessment Technologies SA;
+   *
+   *
    */
 
   var currents = []; //contains the reference to the main lock box. We expect other containers to be only edge cases.
@@ -191,13 +191,13 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
     releaseUrl: helpers._url('release', 'Lock', 'tao'),
     commitUrl: helpers._url('commitResource', 'History', 'taoRevision')
   };
-  /**
-   * Object delegation. This enables us to separate the instance from Api.
-   * An instance can call methods from the API like it was it, so each object will not contain the function definition.
-   * @private
-   * @param {Object} receiver - the object that receive the methods
-   * @param {Object} provider - it provides the methods to the receiver
-   * @returns {Object} the receiver augmented by the provider's methods.
+  /**
+   * Object delegation. This enables us to separate the instance from Api.
+   * An instance can call methods from the API like it was it, so each object will not contain the function definition.
+   * @private
+   * @param {Object} receiver - the object that receive the methods
+   * @param {Object} provider - it provides the methods to the receiver
+   * @returns {Object} the receiver augmented by the provider's methods.
    */
 
   function delegate(receiver, provider) {
@@ -209,15 +209,15 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
 
     return receiver;
   }
-  /**
-   * It provides the lock behavior
-   * @typedef lockApi
-   *
-   *
-   * @param {Object} [options] - the plugin options
-   * @param {String} [options.uri =  ''] - The uri of the selected resource
-   * @param {String} [options.releaseUrl =  ''] - The url to call to release the lock
-   * @param {String} [options.commitUrl =  ''] - The url to call to commit the resource
+  /**
+   * It provides the lock behavior
+   * @typedef lockApi
+   *
+   *
+   * @param {Object} [options] - the plugin options
+   * @param {String} [options.uri =  ''] - The uri of the selected resource
+   * @param {String} [options.releaseUrl =  ''] - The url to call to release the lock
+   * @param {String} [options.commitUrl =  ''] - The url to call to commit the resource
    */
 
 
@@ -225,15 +225,15 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
     level: null,
     category: null,
 
-    /**
-     * generate the lock with the right options
-     *
-     * @example lock().message();
-     * @param {String} [category] - the category of the lock (hasLock or locked)
-     * @param {String} [msg] - the message to display
-     * @param {Object} [options] - the plugin options
-     * @fires create.lock
-     * @returns {lockApi}
+    /**
+     * generate the lock with the right options
+     *
+     * @example lock().message();
+     * @param {String} [category] - the category of the lock (hasLock or locked)
+     * @param {String} [msg] - the message to display
+     * @param {Object} [options] - the plugin options
+     * @fires create.lock
+     * @returns {lockApi}
      */
     message: function message(category, msg, options) {
       if (!category || !_.contains(_.keys(categories), category)) {
@@ -254,35 +254,35 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       return this;
     },
 
-    /**
-     * generate the lock with the right options and open it
-     *
-     * @example lock().hasLock();
-     * @param {String} [msg] - the message to display
-     * @param {Object} [options] - the plugin options
-     * @returns {lockApi}
+    /**
+     * generate the lock with the right options and open it
+     *
+     * @example lock().hasLock();
+     * @param {String} [msg] - the message to display
+     * @param {Object} [options] - the plugin options
+     * @returns {lockApi}
      */
     hasLock: function hasLock(msg, options) {
       return this.message('hasLock', msg, options).open();
     },
 
-    /**
-     * generate the lock with the right options and open it
-     *
-     * @example lock().locked();
-     * @param {String} [msg] - the message to display
-     * @param {Object} [options] - the plugin options
-     * @returns {lockApi}
+    /**
+     * generate the lock with the right options and open it
+     *
+     * @example lock().locked();
+     * @param {String} [msg] - the message to display
+     * @param {Object} [options] - the plugin options
+     * @returns {lockApi}
      */
     locked: function locked(msg, options) {
       return this.message('locked', msg, options).open();
     },
 
-    /**
-     * open the lock
-     * @example lock().message().open();
-     * @fires open.lock
-     * @returns {lockApi}
+    /**
+     * open the lock
+     * @example lock().message().open();
+     * @fires open.lock
+     * @returns {lockApi}
      */
     open: function open() {
       this._trigger('open'); // display me
@@ -292,10 +292,10 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       return this;
     },
 
-    /**
-     * close the lock
-     * @example lock().close();
-     * @fires close.lock
+    /**
+     * close the lock
+     * @example lock().close();
+     * @fires close.lock
      */
     close: function close() {
       if (this.isInState(states.displayed)) {
@@ -311,11 +311,11 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       }
     },
 
-    /**
-     * display the lock
-     * @example lock().display();
-     * @fires display.lock
-     * @returns {lockApi}
+    /**
+     * display the lock
+     * @example lock().display();
+     * @fires display.lock
+     * @returns {lockApi}
      */
     display: function display() {
       var self = this;
@@ -342,12 +342,12 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       return self;
     },
 
-    /**
-     * call the url to release the lock
-     * @example lock().release();
-     * @fires released.lock
-     * @fires failed.lock
-     * @returns {lockApi}
+    /**
+     * call the url to release the lock
+     * @example lock().release();
+     * @fires released.lock
+     * @fires failed.lock
+     * @returns {lockApi}
      */
     release: function release() {
       var self = this;
@@ -378,11 +378,11 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       return this;
     },
 
-    /**
-     * ask a message and call the url to commit the resource
-     * @example lock().commit();
-     * @fires commit.lock
-     * @returns {lockApi}
+    /**
+     * ask a message and call the url to commit the resource
+     * @example lock().commit();
+     * @fires commit.lock
+     * @returns {lockApi}
      */
     commit: function commit() {
       var self = this;
@@ -425,8 +425,8 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       return this;
     },
 
-    /**
-     * Default behaviour
+    /**
+     * Default behaviour
      */
     register: function register() {
       var msg = this._container.data('msg') || defaultOptions.msg;
@@ -453,9 +453,9 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       }).open();
     },
 
-    /**
-     * trigger the event and the callback if exists
-     * @param {String} [eventName] - the name of the event, use the caller name if not set
+    /**
+     * trigger the event and the callback if exists
+     * @param {String} [eventName] - the name of the event, use the caller name if not set
      */
     _trigger: function _trigger(eventName, data) {
       //trigger the related event
@@ -467,19 +467,19 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       }
     }
   };
-  /**
-   * Contains the current state of the lock and accessors
-   * @typedef lockState
+  /**
+   * Contains the current state of the lock and accessors
+   * @typedef lockState
    */
 
   var lockState = {
     //the current state
     _state: null,
 
-    /**
-     * Check if the current state is one of the given values
-     * @param {String|Array} verify - the statue to check
-     * @returns {Boolean} true if the object is in the state to verify
+    /**
+     * Check if the current state is one of the given values
+     * @param {String|Array} verify - the statue to check
+     * @returns {Boolean} true if the object is in the state to verify
      */
     isInState: function isInState(verify) {
       if (_.isString(verify)) {
@@ -489,10 +489,10 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       return _.contains(verify, this._state);
     },
 
-    /**
-     * Change the current state
-     * @param {String} state - the new state
-     * @throws {Error} if we try to set an invalid state
+    /**
+     * Change the current state
+     * @param {String} state - the new state
+     * @throws {Error} if we try to set an invalid state
      */
     setState: function setState(state) {
       if (!_.contains(states, state)) {
@@ -502,13 +502,13 @@ define(['jquery', 'lodash', 'i18n', 'handlebars', 'lib/dompurify/purify', 'helpe
       this._state = state;
     }
   };
-  /**
-   * Enables you to create a new lock.
-   * example lock().error("content");
-   * @exports ui/lock
-   * @param {jQUeryElement} [$container] - only to specify another container
-   * @returns {Object} the lock object
-   * @throws {Error} if the container isn't found
+  /**
+   * Enables you to create a new lock.
+   * example lock().error("content");
+   * @exports ui/lock
+   * @param {jQUeryElement} [$container] - only to specify another container
+   * @returns {Object} the lock object
+   * @throws {Error} if the container isn't found
    */
 
   var lockFactory = function lockFactory($container) {