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

package/dist/datetime/picker.js

@@ -24,24 +24,24 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
     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) {
@@ -182,15 +182,15 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
   function program15(depth0,data) {
     
     var buffer = "", helper, options;
-    buffer += "\r\n    <button type=\"button\" disabled class=\"picker-toggle\" title=\""
+    buffer += "\n    <button type=\"button\" disabled class=\"picker-toggle\" title=\""
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Toggle the date time picker", options) : helperMissing.call(depth0, "__", "Toggle the date time picker", options)))
       + "\" aria-label=\""
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Toggle the date time picker", options) : helperMissing.call(depth0, "__", "Toggle the date time picker", options)))
-      + "\" >\r\n        <span class=\"icon-calendar\" role=\"img\"></span>\r\n    </button>\r\n    <button type=\"button\" disabled class=\"picker-clear\" title=\""
+      + "\" >\n        <span class=\"icon-calendar\" role=\"img\"></span>\n    </button>\n    <button type=\"button\" disabled class=\"picker-clear\" title=\""
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Clear the date time picker", options) : helperMissing.call(depth0, "__", "Clear the date time picker", options)))
       + "\" aria-label=\""
       + escapeExpression((helper = helpers.__ || (depth0 && depth0.__),options={hash:{},data:data},helper ? helper.call(depth0, "Clear the date time picker", options) : helperMissing.call(depth0, "__", "Clear the date time picker", options)))
-      + "\">\r\n        <span class=\"icon-reset\" role=\"img\"></span>\r\n    </button>\r\n    ";
+      + "\">\n        <span class=\"icon-reset\" role=\"img\"></span>\n    </button>\n    ";
     return buffer;
     }
 
@@ -201,28 +201,28 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
       + " ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.controlButtons), {hash:{},inverse:self.noop,fn:self.program(1, program1, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\">\r\n    <input type=\"text\" disabled\r\n        ";
+    buffer += "\">\n    <input type=\"text\" disabled\n        ";
     stack1 = helpers['if'].call(depth0, ((stack1 = (depth0 && depth0.field)),stack1 == null || stack1 === false ? stack1 : stack1.id), {hash:{},inverse:self.noop,fn:self.program(3, program3, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n        ";
+    buffer += "\n        ";
     stack1 = helpers['if'].call(depth0, ((stack1 = (depth0 && depth0.field)),stack1 == null || stack1 === false ? stack1 : stack1.name), {hash:{},inverse:self.noop,fn:self.program(5, program5, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n        ";
+    buffer += "\n        ";
     stack1 = helpers['if'].call(depth0, ((stack1 = (depth0 && depth0.field)),stack1 == null || stack1 === false ? stack1 : stack1.value), {hash:{},inverse:self.noop,fn:self.program(7, program7, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n        ";
+    buffer += "\n        ";
     stack1 = helpers['if'].call(depth0, ((stack1 = (depth0 && depth0.field)),stack1 == null || stack1 === false ? stack1 : stack1.placeholder), {hash:{},inverse:self.noop,fn:self.program(9, program9, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n        ";
+    buffer += "\n        ";
     stack1 = helpers['if'].call(depth0, ((stack1 = (depth0 && depth0.field)),stack1 == null || stack1 === false ? stack1 : stack1.pattern), {hash:{},inverse:self.noop,fn:self.program(11, program11, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n        ";
+    buffer += "\n        ";
     stack1 = helpers['if'].call(depth0, ((stack1 = (depth0 && depth0.field)),stack1 == null || stack1 === false ? stack1 : stack1.label), {hash:{},inverse:self.noop,fn:self.program(13, program13, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n    />\r\n    ";
+    buffer += "\n    />\n    ";
     stack1 = helpers['if'].call(depth0, (depth0 && depth0.controlButtons), {hash:{},inverse:self.noop,fn:self.program(15, program15, data),data:data});
     if(stack1 || stack1 === 0) { buffer += stack1; }
-    buffer += "\r\n</div>\r\n";
+    buffer += "\n</div>\n";
     return buffer;
     });
   function dateTimePickerTpl(data, options, asString) {
@@ -230,26 +230,26 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
     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) 2019 (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) 2019 (original work) Open Assessment Technologies SA
+   *
    */
-  /**
-   * The supported formats
+  /**
+   * The supported formats
    */
 
   var formats = {
@@ -266,8 +266,8 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
       localized: 'L LT'
     }
   };
-  /**
-   * Possible setups for the picker
+  /**
+   * Possible setups for the picker
    */
 
   var setups = {
@@ -300,23 +300,23 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
       format: formats.datetime
     }
   };
-  /**
-   * List of supported constraints
+  /**
+   * List of supported constraints
    */
 
   var supportedConstraints = ['minDate', 'maxDate', 'enable', 'disable'];
-  /**
-   * Checks translation existing for given locale
-   * @param {String} locale
-   * @returns {Boolean}
+  /**
+   * Checks translation existing for given locale
+   * @param {String} locale
+   * @returns {Boolean}
    */
 
   var hasTranslationsForLocale = function hasTranslationsForLocale(locale) {
     return _.isObject(flatpickrLocalization[locale]);
   };
-  /**
-   * Detects document language
-   * @returns {String | undefined}
+  /**
+   * Detects document language
+   * @returns {String | undefined}
    */
 
 
@@ -328,9 +328,9 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
       return documentLocale;
     }
   };
-  /**
-   * The default configuration
-   * @see dateTimePickerFactory
+  /**
+   * The default configuration
+   * @see dateTimePickerFactory
    */
 
 
@@ -341,11 +341,11 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
     useLocalizedFormat: false,
     constraints: {}
   };
-  /**
-   * Get the long date/time format from the localized format (LT to 'DD/MM/YYYY HH:mm')
-   * @param {String} locale - 2 digits locale code (en, fr, de, etc.)
-   * @param {String} localizedFormat - see moment's localized format (L, LT, LLLL, ...)
-   * @returns {String|boolean} the long date/time format
+  /**
+   * Get the long date/time format from the localized format (LT to 'DD/MM/YYYY HH:mm')
+   * @param {String} locale - 2 digits locale code (en, fr, de, etc.)
+   * @param {String} localizedFormat - see moment's localized format (L, LT, LLLL, ...)
+   * @returns {String|boolean} the long date/time format
    */
 
   var getLongLocalizedFormat = function getLongLocalizedFormat(locale, localizedFormat) {
@@ -357,67 +357,67 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
 
     return false;
   };
-  /**
-   * Does the given date/time format uses the am/pm pattern ?
-   * @param {String} format - moment format
-   * @returns {Boolean} true if the contains am/pm
+  /**
+   * Does the given date/time format uses the am/pm pattern ?
+   * @param {String} format - moment format
+   * @returns {Boolean} true if the contains am/pm
    */
 
 
   var isFormatAmPm = function isFormatAmPm(format) {
     return format && /a$/i.test(format);
   };
-  /**
-   * Does the given date/time format contains seconds ?
-   * @param {String} format - moment format
-   * @returns {Boolean} true if the format contains seconds
+  /**
+   * Does the given date/time format contains seconds ?
+   * @param {String} format - moment format
+   * @returns {Boolean} true if the format contains seconds
    */
 
 
   var isFormatInSeconds = function isFormatInSeconds(format) {
     return format && /(:ss)+/i.test(format);
   };
-  /**
-   * The component factory
-   *
-   * @param {HTMLElement|jQuery} container - where to append the component
-   * @param {Object} [config]
-   * @param {String} [config.setup = date] - the picker setup in date-range, datetime-range, date, time and datetime
-   * @param {String} [config.locale] - the picker local
-   * @param {String} [config.useLocalzedFormat = false] - does the locale is used to define the format
-   * @param {String} [config.format] - define your own date/time format for the instance
-   * @param {Boolean} [config.controlButtons = false] - does the field have controls to trigger opening and reset
-   * @param {Object} [config.constraints] - date time selection constraints
-   * @param {Object} [config.constraints] - date time selection constraints
-   * @param {Array<String|Date>} [config.constraints.disable] - list of dates to disable
-   * @param {Array<String|Date>} [config.constraints.enable] - list of dates to enable (if some are disabled)
-   * @param {String|Date} [config.constraints.minDate] - minimum date to start picking from
-   * @param {String|Date} [config.constraints.maxDate] - maximum date to start picking from
-   *
-   * @param {HTMLInputElement} [config.replaceField] - an input field to replace. The field attr are taken instead of config.field
-   * @param {Object} [config.field] - the input field configuration
-   * @param {String} [config.field.name] - the input field name
-   * @param {String} [config.field.id] - the input field id
-   * @param {String} [config.field.placeholder] - the input field placeholder
-   * @param {String} [config.field.pattern] - the input field pattern mask
-   * @param {String} [config.field.value] - the input field value
-   * @param {String} [config.field.label] - label the field for a11y
-   *
-   * @returns {dateTimePickerComponent} the component instance
+  /**
+   * The component factory
+   *
+   * @param {HTMLElement|jQuery} container - where to append the component
+   * @param {Object} [config]
+   * @param {String} [config.setup = date] - the picker setup in date-range, datetime-range, date, time and datetime
+   * @param {String} [config.locale] - the picker local
+   * @param {String} [config.useLocalzedFormat = false] - does the locale is used to define the format
+   * @param {String} [config.format] - define your own date/time format for the instance
+   * @param {Boolean} [config.controlButtons = false] - does the field have controls to trigger opening and reset
+   * @param {Object} [config.constraints] - date time selection constraints
+   * @param {Object} [config.constraints] - date time selection constraints
+   * @param {Array<String|Date>} [config.constraints.disable] - list of dates to disable
+   * @param {Array<String|Date>} [config.constraints.enable] - list of dates to enable (if some are disabled)
+   * @param {String|Date} [config.constraints.minDate] - minimum date to start picking from
+   * @param {String|Date} [config.constraints.maxDate] - maximum date to start picking from
+   *
+   * @param {HTMLInputElement} [config.replaceField] - an input field to replace. The field attr are taken instead of config.field
+   * @param {Object} [config.field] - the input field configuration
+   * @param {String} [config.field.name] - the input field name
+   * @param {String} [config.field.id] - the input field id
+   * @param {String} [config.field.placeholder] - the input field placeholder
+   * @param {String} [config.field.pattern] - the input field pattern mask
+   * @param {String} [config.field.value] - the input field value
+   * @param {String} [config.field.label] - label the field for a11y
+   *
+   * @returns {dateTimePickerComponent} the component instance
    */
 
 
   function dateTimePickerFactory(container, options) {
     var format = '';
     var value = '';
-    /**
-     * @typedef {Object} dateTimePicker
+    /**
+     * @typedef {Object} dateTimePicker
      */
 
     var dateTimePicker = component({
-      /**
-       * Get the current value
-       * @returns {String} the field value, null if none
+      /**
+       * Get the current value
+       * @returns {String} the field value, null if none
        */
       getValue: function getValue() {
         if (this.is('rendered')) {
@@ -427,9 +427,9 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return null;
       },
 
-      /**
-       * Set the current value
-       * @param {String|Date} newValue - the new value matching the format
+      /**
+       * Set the current value
+       * @param {String|Date} newValue - the new value matching the format
        */
       setValue: function setValue(newValue) {
         if (this.is('ready')) {
@@ -445,10 +445,10 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return null;
       },
 
-      /**
-       * Get the dates currently selected.
-       * Usefull for the range mode to get the date list
-       * @returns {Array<[Date|String]>|boolean} the selected dates
+      /**
+       * Get the dates currently selected.
+       * Usefull for the range mode to get the date list
+       * @returns {Array<[Date|String]>|boolean} the selected dates
        */
       getSelectedDates: function getSelectedDates() {
         var selection;
@@ -466,18 +466,18 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return false;
       },
 
-      /**
-       * Get the date/time format description, ie. 'YYYY-MM-DD'
-       * @returns {String} the format
+      /**
+       * Get the date/time format description, ie. 'YYYY-MM-DD'
+       * @returns {String} the format
        */
       getFormat: function getFormat() {
         return format;
       },
 
-      /**
-       * Open the picker
-       * @returns {dateTimePicker} chains
-       * @fires dateTimePicker#open
+      /**
+       * Open the picker
+       * @returns {dateTimePicker} chains
+       * @fires dateTimePicker#open
        */
       open: function open() {
         if (this.is('ready')) {
@@ -487,10 +487,10 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return this;
       },
 
-      /**
-       * Close the picker
-       * @returns {dateTimePicker} chains
-       * @fires dateTimePicker#close
+      /**
+       * Close the picker
+       * @returns {dateTimePicker} chains
+       * @fires dateTimePicker#close
        */
       close: function close() {
         if (this.is('ready')) {
@@ -500,20 +500,20 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return this;
       },
 
-      /**
-       * Clear the field content and close the picker
-       * @returns {dateTimePicker} chains
-       * @fires dateTimePicker#close
-       * @fires dateTimePicker#clear
+      /**
+       * Clear the field content and close the picker
+       * @returns {dateTimePicker} chains
+       * @fires dateTimePicker#close
+       * @fires dateTimePicker#clear
        */
       clear: function clear() {
         if (this.is('ready')) {
           value = '';
           this.picker.close();
           this.picker.clear();
-          /**
-           * The picker get cleared
-           * @event dateTimePicker#clear
+          /**
+           * The picker get cleared
+           * @event dateTimePicker#clear
            */
 
           this.trigger('clear');
@@ -522,11 +522,11 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return this;
       },
 
-      /**
-       * Clear the field content and close the picker
-       * @returns {dateTimePicker} chains
-       * @fires dateTimePicker#open
-       * @fires dateTimePicker#close
+      /**
+       * Clear the field content and close the picker
+       * @returns {dateTimePicker} chains
+       * @fires dateTimePicker#open
+       * @fires dateTimePicker#close
        */
       toggle: function toogle() {
         if (this.is('ready')) {
@@ -536,13 +536,13 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         return this;
       },
 
-      /**
-       * Update constraints on a running instance
-       * @param {String} constraint - the constraint name in minDate, maxDate, enable, disable
-       * @param {*} constraintValue - the constraint value to update
-       * @returns {dateTimePicker} chains
-       * @fires dateTimePicker#open
-       * @fires dateTimePicker#close
+      /**
+       * Update constraints on a running instance
+       * @param {String} constraint - the constraint name in minDate, maxDate, enable, disable
+       * @param {*} constraintValue - the constraint value to update
+       * @returns {dateTimePicker} chains
+       * @fires dateTimePicker#open
+       * @fires dateTimePicker#close
        */
       updateConstraints: function updateConstraints(constraint, constraintValue) {
         if (this.is('ready')) {
@@ -592,9 +592,9 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
       if (!this.config.field.label) {
         this.config.field.label = setup.label;
       }
-      /**
-       * Build the configuration of the picker
-       * @see https://flatpickr.js.org/options/
+      /**
+       * Build the configuration of the picker
+       * @see https://flatpickr.js.org/options/
        */
 
 
@@ -608,51 +608,51 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
         clickOpens: !this.config.controlButtons,
         disableMobile: true,
 
-        /**
-         * How flatpickr will format the given date
-         * @param {Date} date
-         * @returns {String} the formatted date
+        /**
+         * How flatpickr will format the given date
+         * @param {Date} date
+         * @returns {String} the formatted date
          */
         formatDate: function formatDate(date) {
           return moment(date).format(format);
         },
 
-        /**
-         * How flatpickr parse the given input
-         * @param {String} dateString
-         * @returns {Date}
+        /**
+         * How flatpickr parse the given input
+         * @param {String} dateString
+         * @returns {Date}
          */
         parseDate: function parseDate(dateString) {
           return moment(dateString, format).toDate();
         },
 
-        /**
-         * When the picker is opened
-         * @fires dateTimePicker#open
+        /**
+         * When the picker is opened
+         * @fires dateTimePicker#open
          */
         onOpen: function onOpen() {
-          /**
-           * The picker get opened
-           * @event dateTimePicker#open
+          /**
+           * The picker get opened
+           * @event dateTimePicker#open
            */
           self.trigger('open');
         },
 
-        /**
-         * When the picker is opened
-         * @fires dateTimePicker#close
+        /**
+         * When the picker is opened
+         * @fires dateTimePicker#close
          */
         onClose: function onClose() {
-          /**
-           * The picker get closed
-           * @event dateTimePicker#close
+          /**
+           * The picker get closed
+           * @event dateTimePicker#close
            */
           self.trigger('close');
         },
 
-        /**
-         * Hook flatpickr error handler
-         * @param {Error} err - the thrown error
+        /**
+         * Hook flatpickr error handler
+         * @param {Error} err - the thrown error
          */
         errorHandler: function errorHandler(err) {
           if (err instanceof Error) {
@@ -665,10 +665,10 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
                 self.controls.input.classList.remove('error');
               }, 1000);
             } else {
-              /**
-               * Unexpected error
-               * @event dateTimePicker#error
-               * @param {Error} err
+              /**
+               * Unexpected error
+               * @event dateTimePicker#error
+               * @param {Error} err
                */
               self.trigger('error', err);
             }
@@ -726,10 +726,10 @@ define(['lodash', 'i18n', 'moment', 'ui/component', 'lib/flatpickr/flatpickr', '
           self.clear();
         } else if (value !== newValue) {
           value = newValue;
-          /**
-           * A value get changed
-           * @event dateTimePicker#change
-           * @param {String} value - the date/time value
+          /**
+           * A value get changed
+           * @event dateTimePicker#change
+           * @param {String} value - the date/time value
            */
 
           self.trigger('change', value);