@qoretechnologies/reqraft 0.10.66-pr.145.gcb1e59d → 0.10.66

package/dist/helpers/validations.js

@@ -23,8 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasAllDependenciesFullfilled = exports.parseDependency = exports.getUnresolvedRequiredOptions = exports.getUnresolvedRequiredOptionReason = exports.validateOptionWithRequiredGroups = exports.unsatisfiedRequiredGroups = exports.getTypeFromValue = exports.getValueOrDefaultValue = exports.isValueSet = exports.maybeParseYaml = exports.validateField = exports.validateFieldWithResult = exports.readArgValue = exports._validateField = exports.setExpressionCatalogueReader = exports.cronExpressionFromValue = void 0;
-var colors_1 = require("@qoretechnologies/reqore/dist/helpers/colors");
+exports.hasAllDependenciesFullfilled = exports.parseDependency = exports.getUnresolvedRequiredOptions = exports.getUnresolvedRequiredOptionReason = exports.validateOptionWithRequiredGroups = exports.unsatisfiedRequiredGroups = exports.getTypeFromValue = exports.getValueOrDefaultValue = exports.isValueSet = exports.maybeParseYaml = exports.validateField = exports.validateFieldWithResult = exports.readArgValue = exports._validateField = exports.isOptionValueEmpty = exports.patternMismatchReason = exports.setExpressionCatalogueReader = exports.cronExpressionFromValue = void 0;
 var cron_validator_1 = require("cron-validator");
 var js_yaml_1 = __importDefault(require("js-yaml"));
 var lodash_1 = require("lodash");
@@ -35,6 +34,7 @@ var isNaN_1 = __importDefault(require("lodash/isNaN"));
 var isNumber_1 = __importDefault(require("lodash/isNumber"));
 var isPlainObject_1 = __importDefault(require("lodash/isPlainObject"));
 var size_1 = __importDefault(require("lodash/size"));
+var qorusTypeCatalogue_1 = require("./qorusTypeCatalogue");
 var uniqWith_1 = __importDefault(require("lodash/uniqWith"));
 var common_1 = require("./common");
 var optionUiTypes_1 = require("./optionUiTypes");
@@ -42,6 +42,8 @@ var options_1 = require("./options");
 var providerValue_1 = require("./providerValue");
 var templates_1 = require("./templates");
 var allowedValues_1 = require("./allowedValues");
+var colorValue_1 = require("../components/colorValue/colorValue");
+var loneValue_1 = require("../components/form/expressions/loneValue");
 /** The five cron fields, in order, as a schedule hash may name them. */
 var CRON_FIELDS = [
     ['minutes', 'minute'],
@@ -105,6 +107,28 @@ var SEMANTIC_FORMAT_PATTERNS = {
     phone: /^\+?[0-9 ().-]{3,}$/,
 };
 var validResult = function () { return ({ isValid: true, reasons: [] }); };
+/**
+ * Why a value its field's pattern refuses is refused, in words the author can act on: what the pattern accepts,
+ * as the server says it ("Must be a host name and a port."); else the form a value must have, by the field's
+ * example; the pattern itself last, as a detail (qorus#646, David: "we need to tell the user why there's an error -
+ * i.e. what doesn't match the pattern - what is the pattern"). It said "Value does not match validation pattern".
+ */
+var patternMismatchReason = function (field) {
+    var sentence = function (text) { return (/[.!?]$/.test(text) ? text : "".concat(text, ".")); };
+    var desc = typeof (field === null || field === void 0 ? void 0 : field.validation_regex_desc) === 'string' ? field.validation_regex_desc.trim() : '';
+    if (desc) {
+        return sentence("Must be ".concat(desc));
+    }
+    var example = field === null || field === void 0 ? void 0 : field.example_value;
+    var exampleText = typeof example === 'string' ? example.trim()
+        : typeof example === 'number' || typeof example === 'boolean' ? String(example)
+            : '';
+    var main = exampleText ?
+        "Must match the expected form, for example ".concat(exampleText, ".")
+        : 'Must match the expected form.';
+    return (field === null || field === void 0 ? void 0 : field.validation_regex) ? "".concat(main, " Pattern: ").concat(field.validation_regex) : main;
+};
+exports.patternMismatchReason = patternMismatchReason;
 var invalidResult = function (reason, childReasons) {
     if (childReasons === void 0) { childReasons = []; }
     var reasons = __spreadArray(__spreadArray([], (Array.isArray(reason) ? reason.filter(Boolean) : reason ? [reason] : []), true), childReasons, true);
@@ -166,14 +190,86 @@ var isRichTextWithoutValue = function (value) {
         value === '' ||
         JSON.stringify(value) === '[{"type":"paragraph","children":[{"text":""}]}]');
 };
+/**
+ * A value that sets nothing: none, `null`, empty text or an empty list.
+ *
+ * The one rule for "is this field set" - the form's read-first status reads it (an empty list files the field
+ * under Optional, not Set), and so does validation. The two used to disagree on an empty list: the status said an
+ * optional Authors field holding `[]` was not set, while validation checked it as a value and found it wanting
+ * ("At least one value is required"), so the form was invalid with nothing on screen saying why.
+ */
+var isOptionValueEmpty = function (value) {
+    return value === undefined ||
+        value === null ||
+        value === '' ||
+        (Array.isArray(value) && value.length === 0);
+};
+exports.isOptionValueEmpty = isOptionValueEmpty;
 var isValueDefined = function (type, value) {
     if (type === 'richtext') {
         return !isRichTextWithoutValue(value);
     }
-    return value !== undefined && value !== '';
+    return !(0, exports.isOptionValueEmpty)(value);
+};
+/**
+ * A type named inside a sentence: its sentence form in the server's type catalogue ("a whole number"), as reqraft
+ * keeps it - the form's own words, said before and without any server (qorus#646).
+ */
+var typeInSentence = function (type) {
+    return (0, qorusTypeCatalogue_1.qorusTypeSentenceForm)(qorusTypeCatalogue_1.defaultQorusTypes, type);
+};
+/** What is said of a value that is not of its field's type, the type named where there is one (qorus#646). */
+var valueMustBe = function (type) {
+    var named = typeInSentence(type);
+    return named ? "Value must be ".concat(named) : "Value must be of this field's type";
+};
+/** The types a value is written as text in, where text around a template makes it text and not one of them. */
+var NOT_TEXT_WITH_A_TEMPLATE = new Set([
+    'int',
+    'integer',
+    'softint',
+    'number',
+    'float',
+    'softfloat',
+    'softnumber',
+    'bool',
+    'boolean',
+    'softbool',
+    'date',
+    'softdate',
+]);
+/**
+ * What is said of a value of a type that is not text, written with text around a template: what makes it
+ * text, and what to do about it (qlip build 20261008-083118: "How does the user fix this? Why has this
+ * happened?"). `undefined` where the type is text, or the value is not text around a template.
+ */
+var textAroundATemplateReason = function (type, value) {
+    var _a;
+    var notA = NOT_TEXT_WITH_A_TEMPLATE.has(type)
+        ? ((_a = typeInSentence(type)) !== null && _a !== void 0 ? _a : "of this field's type")
+        : undefined;
+    var around = notA ? (0, templates_1.textAroundATemplate)(value) : undefined;
+    if (!around) {
+        return undefined;
+    }
+    if (around.templates > 1) {
+        return around.text.length
+            ? "Text and more than one template make this text, not ".concat(notA, ". Keep one template alone.")
+            : "Templates side by side make this text, not ".concat(notA, ". Keep one of them alone.");
+    }
+    return "\"".concat(around.text.join(' … '), "\" makes this text, not ").concat(notA, ". Delete it to keep the template alone.");
+};
+/** 1st, 2nd, 3rd, 4th, … 11th, 12th, 13th, … 21st: a position as it is written. */
+var ordinal = function (n) {
+    var _a;
+    var tens = n % 100;
+    if (tens >= 11 && tens <= 13) {
+        return "".concat(n, "th");
+    }
+    return "".concat(n).concat((_a = { 1: 'st', 2: 'nd', 3: 'rd' }[n % 10]) !== null && _a !== void 0 ? _a : 'th');
 };
 var _validateField = function (type, value, field, canBeNull) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
     if (!type) {
         if (value === undefined || value === null) {
             return invalidResult('Missing value');
@@ -194,6 +290,14 @@ var _validateField = function (type, value, field, canBeNull) {
     if (pos > 0) {
         type = type.slice(0, pos);
     }
+    /* A value whose type is not text, written with text around a template, is not of that type: a whole
+       number written as "$record:{pos} Stk." passed as a template - anything starting with `$` and holding
+       a `:` did - and the form could be saved with a value its type cannot hold (qorus#646). A template
+       alone, a literal and an expression are judged as before. */
+    var textAroundReason = textAroundATemplateReason(type, value);
+    if (textAroundReason) {
+        return invalidResult(textAroundReason);
+    }
     // Check if the value is a template string
     if ((0, templates_1.isValueTemplate)(value)) {
         var hasKey = !!(0, templates_1.getTemplateKey)(value);
@@ -253,13 +357,13 @@ var _validateField = function (type, value, field, canBeNull) {
         case 'boolean':
             return resultFromBoolean(value === true ||
                 value === false ||
-                (value === undefined && (field === null || field === void 0 ? void 0 : field.has_to_have_value) === false), 'Value must be a True or False value');
+                (value === undefined && (field === null || field === void 0 ? void 0 : field.has_to_have_value) === false), valueMustBe('bool'));
         case 'connection': {
             if (!value) {
                 return invalidResult('Connection value is missing');
             }
             if (field === null || field === void 0 ? void 0 : field.allowed_values) {
-                var allowedValue = field.allowed_values.find(function (val) { var _a; return ((_a = val.value) === null || _a === void 0 ? void 0 : _a.value) === value || val.name === value; });
+                var allowedValue = field.allowed_values.find(function (val) { return (0, allowedValues_1.allowedValueOf)(val) === value || val.name === value; });
                 if (!allowedValue) {
                     return invalidResult('Connection is not allowed');
                 }
@@ -285,7 +389,7 @@ var _validateField = function (type, value, field, canBeNull) {
                 return invalidResult('Value must be a non-empty text');
             }
             if ((field === null || field === void 0 ? void 0 : field.validation_regex) && !value.match(field.validation_regex)) {
-                return invalidResult('Value does not match the required format');
+                return invalidResult((0, exports.patternMismatchReason)(field));
             }
             return resultFromBoolean(SEMANTIC_FORMAT_PATTERNS[type].test(value), "Value is not a valid ".concat(type));
         }
@@ -326,7 +430,7 @@ var _validateField = function (type, value, field, canBeNull) {
             }
             var reasons = [];
             if ((field === null || field === void 0 ? void 0 : field.validation_regex) && !value.match(field.validation_regex)) {
-                reasons.push('Value does not match validation pattern');
+                reasons.push((0, exports.patternMismatchReason)(field));
             }
             // Server `rules[]` contract: 'valid_identifier' is the only rule the
             // server sends today; unknown rule strings are deliberately ignored
@@ -485,18 +589,18 @@ var _validateField = function (type, value, field, canBeNull) {
         }
         case 'number': {
             if (!isNumericValue(value)) {
-                return invalidResult('Value must be a number');
+                return invalidResult(valueMustBe('number'));
             }
             return checkNumericBounds(value, field);
         }
         case 'int':
             if (!(!Number.isNaN(value) && (0, exports.getTypeFromValue)(value) === 'int')) {
-                return invalidResult('Value must be an integer');
+                return invalidResult(valueMustBe('int'));
             }
             return checkNumericBounds(value, field);
         case 'float':
             if (!isNumericValue(value)) {
-                return invalidResult('Value must be a float');
+                return invalidResult(valueMustBe('float'));
             }
             return checkNumericBounds(value, field);
         case 'select-array':
@@ -539,15 +643,14 @@ var _validateField = function (type, value, field, canBeNull) {
                 return resultFromBoolean(result, 'Hash arguments are invalid');
             }
             if (!parsedValue_1 || !(0, isPlainObject_1.default)(parsedValue_1)) {
-                return invalidResult('Hash value must be an object');
+                return invalidResult(valueMustBe('hash'));
             }
             return validResult();
         }
         case 'rgbcolor': {
-            return resultFromBoolean((0, colors_1.isValidSixCharHex)(value === null || value === void 0 ? void 0 : value.hex) ||
-                (((value === null || value === void 0 ? void 0 : value.r) || (value === null || value === void 0 ? void 0 : value.r) === 0) &&
-                    ((value === null || value === void 0 ? void 0 : value.g) || (value === null || value === void 0 ? void 0 : value.g) === 0) &&
-                    ((value === null || value === void 0 ? void 0 : value.b) || (value === null || value === void 0 ? void 0 : value.b) === 0)), 'RGB color is invalid');
+            // the hash { r, g, b, a? } (qorus#646, David): a hex code, bare or as { hex }, is shown but not stored
+            var problem = (0, colorValue_1.storedColorProblem)(value);
+            return problem ? invalidResult(problem) : validResult();
         }
         case 'list':
         case 'free-list': {
@@ -598,7 +701,7 @@ var _validateField = function (type, value, field, canBeNull) {
                 return invalidResult('Mapper code is required');
             }
             // Split the value
-            var _u = value.split('::'), code = _u[0], method = _u[1];
+            var _s = value.split('::'), code = _s[0], method = _s[1];
             // Both fields need to be strings & filled
             var codeResult = (0, exports.validateFieldWithResult)('string', code);
             if (!codeResult.isValid) {
@@ -930,13 +1033,14 @@ var _validateField = function (type, value, field, canBeNull) {
             return validResult();
         }
         case 'fsm-list': {
+            // users call FSMs Qogs: this is said to them
             if (!(0, isArray_1.default)(value)) {
-                return invalidResult('FSM list must be an array');
+                return invalidResult('Qog list must be an array');
             }
             for (var i = 0; i < value.length; i++) {
                 var itemResult = (0, exports.validateFieldWithResult)('string', (_f = value[i]) === null || _f === void 0 ? void 0 : _f.name);
                 if (!itemResult.isValid) {
-                    return withContext(itemResult, "FSM entry ".concat(i, " name is invalid"));
+                    return withContext(itemResult, "Qog entry ".concat(i, " name is invalid"));
                 }
             }
             return validResult();
@@ -1106,7 +1210,7 @@ var _validateField = function (type, value, field, canBeNull) {
         case 'byte-size': {
             if (typeof value !== 'string')
                 return invalidResult('Byte size must be a string');
-            var _v = (0, common_1.splitByteSize)(value), bytes = _v[0], sizeUnit = _v[1];
+            var _t = (0, common_1.splitByteSize)(value), bytes = _t[0], sizeUnit = _t[1];
             var bytesResult = (0, exports.validateFieldWithResult)('number', bytes);
             if (!bytesResult.isValid) {
                 return withContext(bytesResult, 'Byte size numeric part is invalid');
@@ -1167,10 +1271,10 @@ var _validateField = function (type, value, field, canBeNull) {
             // the field's own "show invalid only" filter listed a different set of
             // rows on a fast machine than on a slow one.
             if (!castedValue_1) {
-                return invalidResult('Expression value is empty');
+                return invalidResult('Fill in this expression.');
             }
             if (!((_j = castedValue_1.value) === null || _j === void 0 ? void 0 : _j.exp)) {
-                return invalidResult('Expression operation is required');
+                return invalidResult('Choose what this expression does.');
             }
             // Everything past this point needs the expression's definition, which
             // only the catalogue can supply. Until it loads there is nothing to check
@@ -1179,34 +1283,50 @@ var _validateField = function (type, value, field, canBeNull) {
             if (!(0, size_1.default)(expressions)) {
                 return validResult();
             }
-            // Get the expression definition from the catalogue
-            var expressionDefinition = expressions.find(function (expr) { var _a; return expr.name === ((_a = castedValue_1.value) === null || _a === void 0 ? void 0 : _a.exp); });
-            if (!expressionDefinition) {
-                return invalidResult("Expression definition ".concat(String((_k = castedValue_1.value) === null || _k === void 0 ? void 0 : _k.exp), " not found"));
+            // Get the expression definition from the catalogue - a lone template's as the lone value it is (`asLoneValue`)
+            var expressionDefinition_1 = expressions.find(function (expr) { var _a; return expr.name === ((_a = (0, loneValue_1.asLoneValue)(castedValue_1.value)) === null || _a === void 0 ? void 0 : _a.exp); });
+            if (!expressionDefinition_1) {
+                return invalidResult("Qorus has no operation ".concat(String((_k = castedValue_1.value) === null || _k === void 0 ? void 0 : _k.exp), "."));
             }
             // If the expression has no required args, we can consider it valid
-            var hasRequiredArgs = (_l = expressionDefinition.args) === null || _l === void 0 ? void 0 : _l.some(function (arg) { return arg.required; });
+            var hasRequiredArgs = (_l = expressionDefinition_1.args) === null || _l === void 0 ? void 0 : _l.some(function (arg) { return arg.required; });
             if (!hasRequiredArgs && (0, size_1.default)(((_m = castedValue_1.value) === null || _m === void 0 ? void 0 : _m.args) || []) === 0) {
                 return validResult();
             }
             // If there are no args provided but the expression requires some (normal expressions require at least 1 arg
             // because we checked for required args earlier), or min_args is set
-            if ((0, size_1.default)(((_o = castedValue_1.value) === null || _o === void 0 ? void 0 : _o.args) || []) < (expressionDefinition.min_args || 1)) {
+            if ((0, size_1.default)(((_o = castedValue_1.value) === null || _o === void 0 ? void 0 : _o.args) || []) < (expressionDefinition_1.min_args || 1)) {
                 return invalidResult('Not enough arguments provided');
             }
             // Now we need to validate each argument, either as a normal value or as a sub-expression
             var args = (_q = (_p = castedValue_1.value) === null || _p === void 0 ? void 0 : _p.args) !== null && _q !== void 0 ? _q : [];
-            for (var index = 0; index < args.length; index++) {
+            // each operand's name, as the editor shows it
+            var argLabels = args.map(function (_arg, index) {
+                var _a, _b;
+                var definition = expressionDefinition_1.varargs
+                    ? expressionDefinition_1.args[0]
+                    : expressionDefinition_1.args[index];
+                return (_b = (_a = definition === null || definition === void 0 ? void 0 : definition.display_name) !== null && _a !== void 0 ? _a : definition === null || definition === void 0 ? void 0 : definition.name) !== null && _b !== void 0 ? _b : "argument ".concat(index + 1);
+            });
+            var _loop_1 = function (index) {
                 var argValue = args[index];
-                var argDefinition = expressionDefinition.varargs
-                    ? expressionDefinition.args[0]
-                    : expressionDefinition.args[index];
+                var argDefinition = expressionDefinition_1.varargs
+                    ? expressionDefinition_1.args[0]
+                    : expressionDefinition_1.args[index];
                 /* The argument's name for the message.
                 
                    `display_name` is what a catalogue MAY carry; the served one carries
                    `name`, so every message about an argument read "argument 1
                    ("undefined") is invalid" and named a field that does not exist. */
-                var argLabel = (_s = (_r = argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.display_name) !== null && _r !== void 0 ? _r : argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.name) !== null && _s !== void 0 ? _s : "argument ".concat(index + 1);
+                var argLabel = argLabels[index];
+                /* Which operand, where its name alone does not say: every operand of a call taking any number of
+                   them is "Value" (qlip build 20261008-083118: "which "value" is the message mentioning"). Said by
+                   its position too, as the editor shows them, left to right - and so is a lone operand of a call that
+                   can take more (David, qorus#646), as the operands that join it will be. */
+                var operand = expressionDefinition_1.varargs ||
+                    argLabels.some(function (label, other) { return other !== index && label === argLabel; })
+                    ? "the ".concat(ordinal(index + 1), " \"").concat(argLabel, "\"")
+                    : undefined;
                 /* An explicit null is a VALUE, and DPQL says so: `null` is a literal
                    that parses, serializes and round-trips like any other.
                 
@@ -1222,10 +1342,10 @@ var _validateField = function (type, value, field, canBeNull) {
                    an envelope holding `undefined`, is still missing — which is the
                    distinction the author is making when they write it. */
                 if (argValue === null || ((0, isPlainObject_1.default)(argValue) && argValue.value === null)) {
-                    continue;
+                    return "continue";
                 }
                 if (!(argValue === null || argValue === void 0 ? void 0 : argValue.value) && !(argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.required)) {
-                    continue;
+                    return "continue";
                 }
                 if (argValue === null || argValue === void 0 ? void 0 : argValue.is_expression) {
                     var result_1 = (0, exports.validateFieldWithResult)('expression', argValue, {
@@ -1233,9 +1353,9 @@ var _validateField = function (type, value, field, canBeNull) {
                         has_to_have_value: argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.required,
                     });
                     if (!result_1.isValid) {
-                        return withContext(result_1, "Sub-expression for argument ".concat(index + 1, " (\"").concat(argLabel, "\") is invalid"));
+                        return { value: withContext(result_1, "The expression in ".concat(operand !== null && operand !== void 0 ? operand : "\"".concat(argLabel, "\""), " has an error")) };
                     }
-                    continue;
+                    return "continue";
                 }
                 /* A slot with no operand at all is judged as what it is — a missing
                    value — rather than read for a `type` it does not have.
@@ -1245,7 +1365,7 @@ var _validateField = function (type, value, field, canBeNull) {
                    without a `ui_type`, a slot reset by a type change) — by the type the
                    catalogue declares. Without that fallback `_validateField` refuses it
                    for "Missing type" however right the value is. */
-                var operandType = (_t = argValue === null || argValue === void 0 ? void 0 : argValue.type) !== null && _t !== void 0 ? _t : ((argValue === null || argValue === void 0 ? void 0 : argValue.value) === undefined ? undefined : argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.ui_type);
+                var operandType = (_r = argValue === null || argValue === void 0 ? void 0 : argValue.type) !== null && _r !== void 0 ? _r : ((argValue === null || argValue === void 0 ? void 0 : argValue.value) === undefined ? undefined : argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.ui_type);
                 var result = (0, exports.validateFieldWithResult)(operandType, argValue === null || argValue === void 0 ? void 0 : argValue.value, {
                     expressions: expressions,
                     allowed_values: argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.allowed_values,
@@ -1253,8 +1373,18 @@ var _validateField = function (type, value, field, canBeNull) {
                     has_to_have_value: argDefinition === null || argDefinition === void 0 ? void 0 : argDefinition.required,
                 });
                 if (!result.isValid) {
-                    return withContext(result, "Value for argument ".concat(index + 1, " (\"").concat(argLabel, "\") is invalid"));
+                    // an operand not filled in yet says what to do; one that is wrong says which and why (David's
+                    // review of qorus#646: "Value for argument 1 ("Value") is invalid: Missing value" while building)
+                    if ((argValue === null || argValue === void 0 ? void 0 : argValue.value) === undefined || (argValue === null || argValue === void 0 ? void 0 : argValue.value) === null || (argValue === null || argValue === void 0 ? void 0 : argValue.value) === '') {
+                        return { value: invalidResult(operand ? "Enter ".concat(operand) : "Enter a value for \"".concat(argLabel, "\"")) };
+                    }
+                    return { value: withContext(result, operand ? "".concat((0, lodash_1.upperFirst)(operand), " is invalid") : "\"".concat(argLabel, "\" is invalid")) };
                 }
+            };
+            for (var index = 0; index < args.length; index++) {
+                var state_1 = _loop_1(index);
+                if (typeof state_1 === "object")
+                    return state_1.value;
             }
             return validResult();
         }