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

package/src/form/validator/validator.js

@@ -1,220 +1,220 @@
-/**
- * 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 Open Assessment Technologies SA ;
- */
-/**
- * Simple validator engine. Apply a collection of validation rules on a value.
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-
-import _ from 'lodash';
-import __ from 'i18n';
-
-/**
- * @typedef {Object} validationRule Defines a validation rule to apply on a value.
- * @property {String} id - The validation identifier
- * @property {RegExp|Function|String|String[]} predicate - The validation rule to apply on the value.
- *                                                         It could be either a RegExp or a Function.
- *                                                         The function must return a boolean value,
- *                                                         it can wrap it in a Promise too.
- * @property {String} [message] - The message returned in case of failed validation
- * @property {Number} [precedence] - The precedence order for sorting
- */
-
-/**
- * @typedef {Object} validatorConfig Defines the config entries available to setup a form widget validator
- * @property {validationRule[]} validations - The list of validations to apply
- * @property {String} defaultMessage - The default message returned when a validation fails and no message is set
- */
-
-/**
- * Defaults config for the validator
- * @type {validatorConfig}
- */
-const defaults = {
-    defaultMessage: __('Invalid input')
-};
-
-/**
- * Validates a value
- * @param {String} value
- * @param {validationRule} validation
- * @returns {Boolean|Promise}
- */
-function validateValue(value, validation) {
-    if (validation.predicate instanceof RegExp) {
-        return validation.predicate.test(value);
-    } else if (_.isFunction(validation.predicate)) {
-        return validation.predicate(value);
-    } else if (_.isArray(validation.predicate)) {
-        return _.indexOf(validation.predicate, value) > -1;
-    }
-    return validation.predicate === value;
-}
-
-/**
- * Compares validation rules
- * @param {validationRule} a
- * @param {validationRule} b
- * @returns {Number}
- */
-function compareRule(a, b) {
-    return ((a && a.precedence) || 0) - ((b && b.precedence) || 0);
-}
-
-/**
- * Creates a simple form widget's validator.
- * It manages and applies a collection of validation rules on a value.
- *
- * @example
- *  const validator = validatorFactory({
- *      defaultMessage: 'An error occurred!',
- *      validations: [{
- *          id: 'numeric',
- *          message: 'This field must be numerical',
- *          predicate: /^\d+$/,
- *          precedence: 2
- *      }, {
- *          id: 'required',
- *          message: 'This field is required',
- *          predicate:  value => value.length > 0,
- *          precedence: 1
- *      }, {
- *          id: 'domain',
- *          predicate: value => (parseInt(value, 10) || 0) <= 10,
- *          precedence: 3
- *      }]
- *  });
- *
- *  validator.validate('100')
- *      .then(() => {
- *          // ...
- *      })
- *      .catch(messages => {
- *          // ...
- *      });
- *
- * @param {validatorConfig} config
- * @param {validationRule[]} [config.validations] - The list of validation rules to apply
- * @param {String} [config.defaultMessage] - The default message returned when a validation fails and no message is set
- * @returns {validator}
- */
-function validatorFactory(config) {
-    const validations = new Map();
-
-    /**
-     * @typedef {Object} validator
-     */
-    const validator = {
-        /**
-         * Runs all validation rules on a value
-         * @param {String} value
-         * @returns {Promise} Will provide the list of error messages if the validation failed.
-         */
-        validate(value) {
-            const rules = this.getValidations();
-            rules.sort(compareRule);
-
-            return Promise
-                .all(rules.map(validation => Promise.resolve(validateValue(value, validation))))
-                .then(results => {
-                    const errors = _.reduce(results, (list, result, index) => {
-                        if (!result) {
-                            list.push(rules[index].message || config.defaultMessage);
-                        }
-                        return list;
-                    }, []);
-
-                    if (errors.length) {
-                        return Promise.reject(errors);
-                    }
-                });
-        },
-
-        /**
-         * Adds a validation rule
-         * @param {validationRule} validation
-         * @returns {validator}
-         * @throws {TypeError} if the validation object is not valid
-         */
-        addValidation(validation) {
-            if (!_.isPlainObject(validation)) {
-                throw new TypeError('The validation must be an object');
-            }
-            if (!_.isString(validation.id) || !validation.id) {
-                throw new TypeError('The validation must contain an identifier');
-            }
-            if (!_.isFunction(validation.predicate) &&
-                !_.isRegExp(validation.predicate) &&
-                !_.isString(validation.predicate) &&
-                !_.isArray(validation.predicate)) {
-                throw new TypeError('The validation must provide a predicate');
-            }
-
-            validations.set(validation.id, validation);
-
-            return this;
-        },
-
-        /**
-         * Gets a validation rule by its identifier
-         * @param {String} id
-         * @returns {validationRule|null}
-         */
-        getValidation(id) {
-            return validations.get(id) || null;
-        },
-
-        /**
-         * Gets the list of validation rules.
-         * @returns {validationRule[]}
-         */
-        getValidations() {
-            const list = [];
-            for(let validation of validations.values()) {
-                list.push(validation);
-            }
-            return list;
-        },
-
-        /**
-         * Removes a validation rule
-         * @param {String} id
-         * @returns {validator}
-         */
-        removeValidation(id) {
-            validations.delete(id);
-            return this;
-        },
-
-        /**
-         * Removes all validation rules
-         * @returns {validator}
-         */
-        removeValidations() {
-            validations.clear();
-
-            return this;
-        }
-    };
-
-    config = _.defaults(_.clone(config) || {}, defaults);
-    _.forEach(config.validations, validator.addValidation);
-
-    return validator;
-}
-
-export default validatorFactory;
+/**
+ * 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 Open Assessment Technologies SA ;
+ */
+/**
+ * Simple validator engine. Apply a collection of validation rules on a value.
+ * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
+ */
+
+import _ from 'lodash';
+import __ from 'i18n';
+
+/**
+ * @typedef {Object} validationRule Defines a validation rule to apply on a value.
+ * @property {String} id - The validation identifier
+ * @property {RegExp|Function|String|String[]} predicate - The validation rule to apply on the value.
+ *                                                         It could be either a RegExp or a Function.
+ *                                                         The function must return a boolean value,
+ *                                                         it can wrap it in a Promise too.
+ * @property {String} [message] - The message returned in case of failed validation
+ * @property {Number} [precedence] - The precedence order for sorting
+ */
+
+/**
+ * @typedef {Object} validatorConfig Defines the config entries available to setup a form widget validator
+ * @property {validationRule[]} validations - The list of validations to apply
+ * @property {String} defaultMessage - The default message returned when a validation fails and no message is set
+ */
+
+/**
+ * Defaults config for the validator
+ * @type {validatorConfig}
+ */
+const defaults = {
+    defaultMessage: __('Invalid input')
+};
+
+/**
+ * Validates a value
+ * @param {String} value
+ * @param {validationRule} validation
+ * @returns {Boolean|Promise}
+ */
+function validateValue(value, validation) {
+    if (validation.predicate instanceof RegExp) {
+        return validation.predicate.test(value);
+    } else if (_.isFunction(validation.predicate)) {
+        return validation.predicate(value);
+    } else if (_.isArray(validation.predicate)) {
+        return _.indexOf(validation.predicate, value) > -1;
+    }
+    return validation.predicate === value;
+}
+
+/**
+ * Compares validation rules
+ * @param {validationRule} a
+ * @param {validationRule} b
+ * @returns {Number}
+ */
+function compareRule(a, b) {
+    return ((a && a.precedence) || 0) - ((b && b.precedence) || 0);
+}
+
+/**
+ * Creates a simple form widget's validator.
+ * It manages and applies a collection of validation rules on a value.
+ *
+ * @example
+ *  const validator = validatorFactory({
+ *      defaultMessage: 'An error occurred!',
+ *      validations: [{
+ *          id: 'numeric',
+ *          message: 'This field must be numerical',
+ *          predicate: /^\d+$/,
+ *          precedence: 2
+ *      }, {
+ *          id: 'required',
+ *          message: 'This field is required',
+ *          predicate:  value => value.length > 0,
+ *          precedence: 1
+ *      }, {
+ *          id: 'domain',
+ *          predicate: value => (parseInt(value, 10) || 0) <= 10,
+ *          precedence: 3
+ *      }]
+ *  });
+ *
+ *  validator.validate('100')
+ *      .then(() => {
+ *          // ...
+ *      })
+ *      .catch(messages => {
+ *          // ...
+ *      });
+ *
+ * @param {validatorConfig} config
+ * @param {validationRule[]} [config.validations] - The list of validation rules to apply
+ * @param {String} [config.defaultMessage] - The default message returned when a validation fails and no message is set
+ * @returns {validator}
+ */
+function validatorFactory(config) {
+    const validations = new Map();
+
+    /**
+     * @typedef {Object} validator
+     */
+    const validator = {
+        /**
+         * Runs all validation rules on a value
+         * @param {String} value
+         * @returns {Promise} Will provide the list of error messages if the validation failed.
+         */
+        validate(value) {
+            const rules = this.getValidations();
+            rules.sort(compareRule);
+
+            return Promise
+                .all(rules.map(validation => Promise.resolve(validateValue(value, validation))))
+                .then(results => {
+                    const errors = _.reduce(results, (list, result, index) => {
+                        if (!result) {
+                            list.push(rules[index].message || config.defaultMessage);
+                        }
+                        return list;
+                    }, []);
+
+                    if (errors.length) {
+                        return Promise.reject(errors);
+                    }
+                });
+        },
+
+        /**
+         * Adds a validation rule
+         * @param {validationRule} validation
+         * @returns {validator}
+         * @throws {TypeError} if the validation object is not valid
+         */
+        addValidation(validation) {
+            if (!_.isPlainObject(validation)) {
+                throw new TypeError('The validation must be an object');
+            }
+            if (!_.isString(validation.id) || !validation.id) {
+                throw new TypeError('The validation must contain an identifier');
+            }
+            if (!_.isFunction(validation.predicate) &&
+                !_.isRegExp(validation.predicate) &&
+                !_.isString(validation.predicate) &&
+                !_.isArray(validation.predicate)) {
+                throw new TypeError('The validation must provide a predicate');
+            }
+
+            validations.set(validation.id, validation);
+
+            return this;
+        },
+
+        /**
+         * Gets a validation rule by its identifier
+         * @param {String} id
+         * @returns {validationRule|null}
+         */
+        getValidation(id) {
+            return validations.get(id) || null;
+        },
+
+        /**
+         * Gets the list of validation rules.
+         * @returns {validationRule[]}
+         */
+        getValidations() {
+            const list = [];
+            for(let validation of validations.values()) {
+                list.push(validation);
+            }
+            return list;
+        },
+
+        /**
+         * Removes a validation rule
+         * @param {String} id
+         * @returns {validator}
+         */
+        removeValidation(id) {
+            validations.delete(id);
+            return this;
+        },
+
+        /**
+         * Removes all validation rules
+         * @returns {validator}
+         */
+        removeValidations() {
+            validations.clear();
+
+            return this;
+        }
+    };
+
+    config = _.defaults(_.clone(config) || {}, defaults);
+    _.forEach(config.validations, validator.addValidation);
+
+    return validator;
+}
+
+export default validatorFactory;

package/src/form/widget/css/widget.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 */
@@ -60,5 +60,5 @@ Usage:
     border-color: #ba122b;
     color: #ba122b;
 }
-
+
 /*# sourceMappingURL=widget.css.map */

package/src/form/widget/definitions.js

@@ -1,51 +1,51 @@
-/**
- * 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 Open Assessment Technologies SA ;
- */
-/**
- * Defines constants that match the form widget types available by default
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-
-/**
- * Defines the URI of each available widget
- * @type {Object}
- */
-const widgetDefinitions = {
-    TEXTBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#TextBox',
-    TEXTAREA: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#TextArea',
-    HIDDEN: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#Hidden',
-    HIDDENBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#HiddenBox',
-    RADIOBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#RadioBox',
-    COMBOBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#ComboBox',
-    CHECKBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#CheckBox'
-
-    /* @todo implement the remaining form widgets */
-    // HTMLAREA: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#HTMLArea',
-    // PASSWORD: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#Password',
-    // CALENDAR: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#Calendar',
-    // TREEBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#TreeBox',
-    // FILE: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#AsyncFile',
-    // VERSIONEDFILE: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#VersionedFile',
-    // JSONOBJECT: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#JsonObject',
-};
-
-/**
- * Designates the default widget applied when the URI is missing
- */
-widgetDefinitions.DEFAULT = widgetDefinitions.TEXTBOX;
-
-export default widgetDefinitions;
+/**
+ * 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 Open Assessment Technologies SA ;
+ */
+/**
+ * Defines constants that match the form widget types available by default
+ * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
+ */
+
+/**
+ * Defines the URI of each available widget
+ * @type {Object}
+ */
+const widgetDefinitions = {
+    TEXTBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#TextBox',
+    TEXTAREA: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#TextArea',
+    HIDDEN: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#Hidden',
+    HIDDENBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#HiddenBox',
+    RADIOBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#RadioBox',
+    COMBOBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#ComboBox',
+    CHECKBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#CheckBox'
+
+    /* @todo implement the remaining form widgets */
+    // HTMLAREA: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#HTMLArea',
+    // PASSWORD: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#Password',
+    // CALENDAR: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#Calendar',
+    // TREEBOX: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#TreeBox',
+    // FILE: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#AsyncFile',
+    // VERSIONEDFILE: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#VersionedFile',
+    // JSONOBJECT: 'http://www.tao.lu/datatypes/WidgetDefinitions.rdf#JsonObject',
+};
+
+/**
+ * Designates the default widget applied when the URI is missing
+ */
+widgetDefinitions.DEFAULT = widgetDefinitions.TEXTBOX;
+
+export default widgetDefinitions;

package/src/form/widget/loader.js

@@ -1,40 +1,40 @@
-/**
- * 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 Open Assessment Technologies SA ;
- */
-/**
- * Register common form widgets
- * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
- */
-import widgetFactory from 'ui/form/widget/widget';
-import widgetDefinitions from 'ui/form/widget/definitions';
-import widgetCheckBoxProvider from 'ui/form/widget/providers/checkBox';
-import widgetComboBoxProvider from 'ui/form/widget/providers/comboBox';
-import widgetHiddenProvider from 'ui/form/widget/providers/hidden';
-import widgetHiddenBoxProvider from 'ui/form/widget/providers/hiddenBox';
-import widgetRadioBoxProvider from 'ui/form/widget/providers/radioBox';
-import widgetTextAreaProvider from 'ui/form/widget/providers/textArea';
-import widgetTextBoxProvider from 'ui/form/widget/providers/textBox';
-
-widgetFactory.registerProvider(widgetDefinitions.CHECKBOX, widgetCheckBoxProvider);
-widgetFactory.registerProvider(widgetDefinitions.COMBOBOX, widgetComboBoxProvider);
-widgetFactory.registerProvider(widgetDefinitions.HIDDEN, widgetHiddenProvider);
-widgetFactory.registerProvider(widgetDefinitions.HIDDENBOX, widgetHiddenBoxProvider);
-widgetFactory.registerProvider(widgetDefinitions.RADIOBOX, widgetRadioBoxProvider);
-widgetFactory.registerProvider(widgetDefinitions.TEXTAREA, widgetTextAreaProvider);
-widgetFactory.registerProvider(widgetDefinitions.TEXTBOX, widgetTextBoxProvider);
-
-export default widgetFactory;
+/**
+ * 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 Open Assessment Technologies SA ;
+ */
+/**
+ * Register common form widgets
+ * @author Jean-Sébastien Conan <jean-sebastien@taotesting.com>
+ */
+import widgetFactory from 'ui/form/widget/widget';
+import widgetDefinitions from 'ui/form/widget/definitions';
+import widgetCheckBoxProvider from 'ui/form/widget/providers/checkBox';
+import widgetComboBoxProvider from 'ui/form/widget/providers/comboBox';
+import widgetHiddenProvider from 'ui/form/widget/providers/hidden';
+import widgetHiddenBoxProvider from 'ui/form/widget/providers/hiddenBox';
+import widgetRadioBoxProvider from 'ui/form/widget/providers/radioBox';
+import widgetTextAreaProvider from 'ui/form/widget/providers/textArea';
+import widgetTextBoxProvider from 'ui/form/widget/providers/textBox';
+
+widgetFactory.registerProvider(widgetDefinitions.CHECKBOX, widgetCheckBoxProvider);
+widgetFactory.registerProvider(widgetDefinitions.COMBOBOX, widgetComboBoxProvider);
+widgetFactory.registerProvider(widgetDefinitions.HIDDEN, widgetHiddenProvider);
+widgetFactory.registerProvider(widgetDefinitions.HIDDENBOX, widgetHiddenBoxProvider);
+widgetFactory.registerProvider(widgetDefinitions.RADIOBOX, widgetRadioBoxProvider);
+widgetFactory.registerProvider(widgetDefinitions.TEXTAREA, widgetTextAreaProvider);
+widgetFactory.registerProvider(widgetDefinitions.TEXTBOX, widgetTextBoxProvider);
+
+export default widgetFactory;