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

package/dist/helpers/markdownText.js

@@ -0,0 +1,160 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.plainTextNode = exports.markdownToProse = exports.markdownToPlainText = void 0;
+// Copyright 2026 Qore Technologies, s.r.o.
+var react_1 = require("react");
+/**
+ * Markdown as the text it renders to: the words, without the marks.
+ *
+ * A description from the server is markdown. Where the host supplies a renderer, it draws it; where none is
+ * supplied, reqraft does not draw it in a dialect of its own, but it does not print its punctuation either: a
+ * card that read "The **customer's** full name, from `customer.name`" showed the reader the marks the list beside
+ * it did not. This is what such a place shows instead.
+ */
+/** The ASCII punctuation a backslash escapes, as CommonMark has it: `\*` is a star, not emphasis. */
+var ESCAPABLE = /[!-/:-@[-`{-~]/;
+/** Where a literal (a code span, an escaped mark) waits while the marks are taken off: characters no text holds. */
+var LITERAL = /\uE000(\d+)\uE001/g;
+/**
+ * A line with what markdown takes literally lifted out: each code span and each backslash-escaped mark becomes
+ * a placeholder, and `literals` holds the text it stands for. Read left to right, as CommonMark reads them: a
+ * backslash before ASCII punctuation is that punctuation; a run of backticks opens a code span that a later run
+ * of the same length closes, and the span holds its text exactly (backslashes too), one space trimmed from each
+ * end when both ends have one; a run nothing closes is just backticks.
+ */
+var liftLiterals = function (line) {
+    var literals = [];
+    var placeholder = function (literal) {
+        literals.push(literal);
+        return "\uE000".concat(literals.length - 1, "\uE001");
+    };
+    var text = '';
+    var at = 0;
+    while (at < line.length) {
+        var char = line[at];
+        if (char === '\\' && at + 1 < line.length && ESCAPABLE.test(line[at + 1])) {
+            text += placeholder(line[at + 1]);
+            at += 2;
+            continue;
+        }
+        if (char === '`') {
+            var end = at;
+            while (line[end] === '`') {
+                end++;
+            }
+            var fence = line.slice(at, end);
+            // the closing run: the same number of backticks, no more and no fewer
+            var closer = new RegExp("(?<!`)".concat(fence, "(?!`)"), 'g');
+            closer.lastIndex = end;
+            var close_1 = closer.exec(line);
+            if (close_1) {
+                var content = line.slice(end, close_1.index);
+                text += placeholder(content.length > 2 && content.startsWith(' ') && content.endsWith(' ') && content.trim() ?
+                    content.slice(1, -1)
+                    : content);
+                at = close_1.index + fence.length;
+            }
+            else {
+                // nothing closes it: the backticks are text, and so is any span a shorter run might open inside it
+                text += placeholder(fence);
+                at = end;
+            }
+            continue;
+        }
+        text += char;
+        at++;
+    }
+    return { text: text, literals: literals };
+};
+/**
+ * Markdown inline marks taken off a line, its literals kept as written.
+ *
+ * Deliberately not a markdown parser. The inline rules are CommonMark-shaped on purpose, because the naive
+ * versions corrupt exactly the text these descriptions are full of: `(\*|_)(.*?)\1` turns "2 * 3 * 4 items" into
+ * "2 3 4 items" and `retry_count_max` into `retrycountmax`. Emphasis delimiters have to hug the text they wrap,
+ * and an underscore must not be intraword, or an option key loses its underscores.
+ *
+ * What markdown takes literally - a code span, a backslash-escaped mark - is lifted out first and put back last,
+ * so no emphasis pass reads it (qorus#646): a sentence that quotes `__other__` as code said "other".
+ */
+var stripInline = function (line) {
+    var _a = liftLiterals(line), text = _a.text, literals = _a.literals;
+    return (text
+        // images before links - an image's `!` prefix would otherwise survive
+        .replace(/!\[([^\]]*)\]\([^)]*\)/g, '$1')
+        .replace(/\[([^\]]*)\]\([^)]*\)/g, '$1')
+        // autolinks: <https://example.com> -> https://example.com
+        .replace(/<((?:https?|mailto):[^>\s]+)>/g, '$1')
+        .replace(/(\*\*\*)(?=\S)([\s\S]+?)(?<=\S)\1/g, '$2')
+        .replace(/(?<![A-Za-z0-9])(___)(?=\S)([\s\S]+?)(?<=\S)\1(?![A-Za-z0-9])/g, '$2')
+        .replace(/(\*\*)(?=\S)([\s\S]+?)(?<=\S)\1/g, '$2')
+        .replace(/(?<![A-Za-z0-9])(__)(?=\S)([\s\S]+?)(?<=\S)\1(?![A-Za-z0-9])/g, '$2')
+        .replace(/(\*)(?=\S)([\s\S]+?)(?<=\S)\1/g, '$2')
+        .replace(/(?<![A-Za-z0-9])(_)(?=\S)([\s\S]+?)(?<=\S)\1(?![A-Za-z0-9])/g, '$2')
+        .replace(/~~(?=\S)([\s\S]+?)(?<=\S)~~/g, '$1')
+        .replace(LITERAL, function (_placeholder, index) { return literals[Number(index)]; }));
+};
+/** A line's block marker: a heading's hashes, a quote's caret, a list item's bullet or number. */
+var BLOCK_MARKER = /^\s{0,3}(?:#{1,6}\s+|>\s?|[-*+]\s+|\d+[.)]\s+)/;
+/** A list item's own marker, which keeps it on a line of its own. */
+var LIST_ITEM = /^\s{0,3}(?:[-*+]|\d+[.)])\s+/;
+/** A setext underline or a thematic break: no words. */
+var RULE = /^\s{0,3}(?:={2,}|-{2,}|\*{3,}|_{3,})\s*$/;
+/**
+ * Markdown as plain text: its words, with no marks, a blank line between its paragraphs and a line of its own for
+ * each list item. A fenced code block keeps its lines. Empty for anything but a string.
+ */
+var markdownToPlainText = function (value) {
+    if (typeof value !== 'string') {
+        return '';
+    }
+    var paragraphs = [];
+    for (var _i = 0, _a = value.replace(/\r\n?/g, '\n').split(/\n\s*\n/); _i < _a.length; _i++) {
+        var block = _a[_i];
+        var fenced = /^\s{0,3}```[^\n]*\n([\s\S]*?)\n?\s{0,3}```\s*$/.exec(block);
+        if (fenced) {
+            paragraphs.push(fenced[1]);
+            continue;
+        }
+        var lines = [];
+        for (var _b = 0, _c = block.split('\n'); _b < _c.length; _b++) {
+            var line = _c[_b];
+            if (RULE.test(line)) {
+                continue;
+            }
+            var text = stripInline(line.replace(BLOCK_MARKER, '')).replace(/\s+/g, ' ').trim();
+            if (!text) {
+                continue;
+            }
+            // a list item starts a line; any other line continues the one before, as markdown joins them
+            if (LIST_ITEM.test(line) || !lines.length) {
+                lines.push(text);
+            }
+            else {
+                lines[lines.length - 1] += " ".concat(text);
+            }
+        }
+        if (lines.length) {
+            paragraphs.push(lines.join('\n'));
+        }
+    }
+    return paragraphs.join('\n\n');
+};
+exports.markdownToPlainText = markdownToPlainText;
+/** Markdown as prose on one line: `markdownToPlainText` with its breaks run together. */
+var markdownToProse = function (value) {
+    return (0, exports.markdownToPlainText)(value).replace(/\s+/g, ' ').trim();
+};
+exports.markdownToProse = markdownToProse;
+/**
+ * Markdown as plain text to show: the text alone when it is one line, or a block that keeps its paragraph and
+ * line breaks (`white-space: pre-line`) when it has more.
+ */
+var plainTextNode = function (value) {
+    var text = (0, exports.markdownToPlainText)(value);
+    return text.includes('\n') ?
+        (0, react_1.createElement)('div', { className: 'reqraft-plain-description', style: { whiteSpace: 'pre-line' } }, text)
+        : text;
+};
+exports.plainTextNode = plainTextNode;
+//# sourceMappingURL=markdownText.js.map

package/dist/helpers/markdownText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownText.js","sourceRoot":"","sources":["../../src/helpers/markdownText.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AAC3C,+BAAiD;AAEjD;;;;;;;GAOG;AACH,qGAAqG;AACrG,IAAM,SAAS,GAAG,gBAAgB,CAAC;AACnC,oHAAoH;AACpH,IAAM,OAAO,GAAG,oBAAoB,CAAC;AAErC;;;;;;GAMG;AACH,IAAM,YAAY,GAAG,UAAC,IAAY;IAChC,IAAM,QAAQ,GAAa,EAAE,CAAC;IAC9B,IAAM,WAAW,GAAG,UAAC,OAAe;QAClC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO,gBAAS,QAAQ,CAAC,MAAM,GAAG,CAAC,WAAQ,CAAC;IAC9C,CAAC,CAAC;IACF,IAAI,IAAI,GAAG,EAAE,CAAC;IACd,IAAI,EAAE,GAAG,CAAC,CAAC;IACX,OAAO,EAAE,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;QACxB,IAAM,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;QACtB,IAAI,IAAI,KAAK,IAAI,IAAI,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YAC1E,IAAI,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC;YAClC,EAAE,IAAI,CAAC,CAAC;YACR,SAAS;QACX,CAAC;QACD,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjB,IAAI,GAAG,GAAG,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,EAAE,CAAC;gBACzB,GAAG,EAAE,CAAC;YACR,CAAC;YACD,IAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;YAClC,sEAAsE;YACtE,IAAM,MAAM,GAAG,IAAI,MAAM,CAAC,gBAAU,KAAK,UAAQ,EAAE,GAAG,CAAC,CAAC;YACxD,MAAM,CAAC,SAAS,GAAG,GAAG,CAAC;YACvB,IAAM,OAAK,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,OAAK,EAAE,CAAC;gBACV,IAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,OAAK,CAAC,KAAK,CAAC,CAAC;gBAC7C,IAAI,IAAI,WAAW,CACjB,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;oBACxF,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;oBACtB,CAAC,CAAC,OAAO,CACV,CAAC;gBACF,EAAE,GAAG,OAAK,CAAC,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,mGAAmG;gBACnG,IAAI,IAAI,WAAW,CAAC,KAAK,CAAC,CAAC;gBAC3B,EAAE,GAAG,GAAG,CAAC;YACX,CAAC;YACD,SAAS;QACX,CAAC;QACD,IAAI,IAAI,IAAI,CAAC;QACb,EAAE,EAAE,CAAC;IACP,CAAC;IACD,OAAO,EAAE,IAAI,MAAA,EAAE,QAAQ,UAAA,EAAE,CAAC;AAC5B,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACH,IAAM,WAAW,GAAG,UAAC,IAAY;IACzB,IAAA,KAAqB,YAAY,CAAC,IAAI,CAAC,EAArC,IAAI,UAAA,EAAE,QAAQ,cAAuB,CAAC;IAC9C,OAAO,CACL,IAAI;QACF,sEAAsE;SACrE,OAAO,CAAC,yBAAyB,EAAE,IAAI,CAAC;SACxC,OAAO,CAAC,wBAAwB,EAAE,IAAI,CAAC;QACxC,0DAA0D;SACzD,OAAO,CAAC,gCAAgC,EAAE,IAAI,CAAC;SAC/C,OAAO,CAAC,oCAAoC,EAAE,IAAI,CAAC;SACnD,OAAO,CAAC,gEAAgE,EAAE,IAAI,CAAC;SAC/E,OAAO,CAAC,kCAAkC,EAAE,IAAI,CAAC;SACjD,OAAO,CAAC,+DAA+D,EAAE,IAAI,CAAC;SAC9E,OAAO,CAAC,gCAAgC,EAAE,IAAI,CAAC;SAC/C,OAAO,CAAC,8DAA8D,EAAE,IAAI,CAAC;SAC7E,OAAO,CAAC,8BAA8B,EAAE,IAAI,CAAC;SAC7C,OAAO,CAAC,OAAO,EAAE,UAAC,YAAY,EAAE,KAAa,IAAK,OAAA,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAvB,CAAuB,CAAC,CAC9E,CAAC;AACJ,CAAC,CAAC;AAEF,kGAAkG;AAClG,IAAM,YAAY,GAAG,gDAAgD,CAAC;AACtE,qEAAqE;AACrE,IAAM,SAAS,GAAG,8BAA8B,CAAC;AACjD,wDAAwD;AACxD,IAAM,IAAI,GAAG,0CAA0C,CAAC;AAExD;;;GAGG;AACI,IAAM,mBAAmB,GAAG,UAAC,KAAc;IAChD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAM,UAAU,GAAa,EAAE,CAAC;IAChC,KAAoB,UAA8C,EAA9C,KAAA,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,EAA9C,cAA8C,EAA9C,IAA8C,EAAE,CAAC;QAAhE,IAAM,KAAK,SAAA;QACd,IAAM,MAAM,GAAG,gDAAgD,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC5E,IAAI,MAAM,EAAE,CAAC;YACX,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;YAC3B,SAAS;QACX,CAAC;QACD,IAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,KAAmB,UAAiB,EAAjB,KAAA,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,EAAjB,cAAiB,EAAjB,IAAiB,EAAE,CAAC;YAAlC,IAAM,IAAI,SAAA;YACb,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACpB,SAAS;YACX,CAAC;YACD,IAAM,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;YACrF,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,SAAS;YACX,CAAC;YACD,6FAA6F;YAC7F,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC1C,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,IAAI,WAAI,IAAI,CAAE,CAAC;YACxC,CAAC;QACH,CAAC;QACD,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;YACjB,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC,CAAC;AAjCW,QAAA,mBAAmB,uBAiC9B;AAEF,yFAAyF;AAClF,IAAM,eAAe,GAAG,UAAC,KAAc;IAC5C,OAAA,IAAA,2BAAmB,EAAC,KAAK,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE;AAAtD,CAAsD,CAAC;AAD5C,QAAA,eAAe,mBAC6B;AAEzD;;;GAGG;AACI,IAAM,aAAa,GAAG,UAAC,KAAc;IAC1C,IAAM,IAAI,GAAG,IAAA,2BAAmB,EAAC,KAAK,CAAC,CAAC;IACxC,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;QACxB,IAAA,qBAAa,EACX,KAAK,EACL,EAAE,SAAS,EAAE,2BAA2B,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,EAAE,EAC7E,IAAI,CACL;QACH,CAAC,CAAC,IAAI,CAAC;AACX,CAAC,CAAC;AATW,QAAA,aAAa,iBASxB"}

package/dist/helpers/noDescription.d.ts

@@ -0,0 +1,9 @@
+/**
+ * What a hover or help says where what it is about has no description: why there is none, in plain words, never a
+ * blank (qorus#646, David: "in such cases there should be a reason given why there is no description in the
+ * hover"). A host can say it in its own words (`ITemplateReferenceNames.noDescription`).
+ */
+export declare const NO_VALUE_DESCRIPTION = "No description was given for this value.";
+export declare const NO_OPTION_DESCRIPTION = "No description was given for this option.";
+export declare const NO_FIELD_DESCRIPTION = "No description was given for this field.";
+//# sourceMappingURL=noDescription.d.ts.map

package/dist/helpers/noDescription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"noDescription.d.ts","sourceRoot":"","sources":["../../src/helpers/noDescription.ts"],"names":[],"mappings":"AACA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,6CAA6C,CAAC;AAC/E,eAAO,MAAM,qBAAqB,8CAA8C,CAAC;AACjF,eAAO,MAAM,oBAAoB,6CAA6C,CAAC"}

package/dist/helpers/noDescription.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NO_FIELD_DESCRIPTION = exports.NO_OPTION_DESCRIPTION = exports.NO_VALUE_DESCRIPTION = void 0;
+// Copyright 2026 Qore Technologies, s.r.o.
+/**
+ * What a hover or help says where what it is about has no description: why there is none, in plain words, never a
+ * blank (qorus#646, David: "in such cases there should be a reason given why there is no description in the
+ * hover"). A host can say it in its own words (`ITemplateReferenceNames.noDescription`).
+ */
+exports.NO_VALUE_DESCRIPTION = 'No description was given for this value.';
+exports.NO_OPTION_DESCRIPTION = 'No description was given for this option.';
+exports.NO_FIELD_DESCRIPTION = 'No description was given for this field.';
+//# sourceMappingURL=noDescription.js.map

package/dist/helpers/noDescription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"noDescription.js","sourceRoot":"","sources":["../../src/helpers/noDescription.ts"],"names":[],"mappings":";;;AAAA,2CAA2C;AAC3C;;;;GAIG;AACU,QAAA,oBAAoB,GAAG,0CAA0C,CAAC;AAClE,QAAA,qBAAqB,GAAG,2CAA2C,CAAC;AACpE,QAAA,oBAAoB,GAAG,0CAA0C,CAAC"}

package/dist/helpers/optionUiTypes.d.ts

@@ -24,9 +24,9 @@ export declare const LEGACY_FIELD_UI_TYPES: readonly ["api-manager", "array", "a
 export declare const KNOWN_QORUS_UI_TYPES: readonly ["string", "long-string", "data", "binary", "richtext", "bool", "boolean", "date", "int", "integer", "float", "number", "byte-size", "timeout", "url", "code-editor", "rgbcolor", "any", "auto", "email", "uri", "uuid", "hostname", "ipv4", "ipv6", "phone", "hash", "free-hash", "list", "free-list", "option_hash", "file", "file-as-string", "collection-documents", "enum", "select-string", "select-array", "multi-select", "workflow", "service", "job", "connection", "mapper", "class", "value-map", "fsm", "qog", "api-schema", "auth-profile", "ai-collection", "ai-endpoint", "ai-guardrail", "ml-model", "release-config", "alertrule", "alertsilence", "installed-release", "business-process", "schema", "test", "processor", "processor-mappings", "data-provider", "tool-catalog", "schema-definition", "test-cases", "test-value-contract", "dpql", "active-windows", "api-manager", "array", "array-auto", "array-of-pairs", "class-array", "class-connectors", "constant-array", "context-selector", "cron", "data-provider-options", "file-array", "fsm-list", "function-array", "http-content", "method-name", "opcua-method-arguments", "opcua-write-values", "options", "select", "service-events", "service-webhooks", "type-selector"];
 export type TLegacyFieldUiType = (typeof LEGACY_FIELD_UI_TYPES)[number];
 export type TKnownQorusUiType = (typeof KNOWN_QORUS_UI_TYPES)[number];
-export declare const isOptionUiType: (type: unknown) => type is "string" | "number" | "boolean" | "file" | "data" | "date" | "email" | "url" | "list" | "auto" | "richtext" | "uri" | "dpql" | "mapper" | "workflow" | "service" | "job" | "connection" | "class" | "fsm" | "value-map" | "qog" | "ai-collection" | "ai-endpoint" | "ai-guardrail" | "alertrule" | "alertsilence" | "api-schema" | "auth-profile" | "business-process" | "installed-release" | "ml-model" | "release-config" | "schema" | "test" | "binary" | "long-string" | "enum" | "select-string" | "file-as-string" | "int" | "integer" | "float" | "free-list" | "select-array" | "multi-select" | "hash" | "rgbcolor" | "free-hash" | "any" | "bool" | "data-provider" | "processor-mappings" | "tool-catalog" | "code-editor" | "byte-size" | "timeout" | "uuid" | "hostname" | "ipv4" | "ipv6" | "phone" | "option_hash" | "collection-documents" | "processor" | "schema-definition" | "test-cases" | "test-value-contract" | "active-windows";
+export declare const isOptionUiType: (type: unknown) => type is "string" | "number" | "boolean" | "file" | "data" | "date" | "email" | "url" | "list" | "auto" | "mapper" | "workflow" | "service" | "job" | "connection" | "class" | "fsm" | "value-map" | "qog" | "ai-collection" | "ai-endpoint" | "ai-guardrail" | "alertrule" | "alertsilence" | "api-schema" | "auth-profile" | "business-process" | "installed-release" | "ml-model" | "release-config" | "schema" | "test" | "binary" | "long-string" | "enum" | "select-string" | "file-as-string" | "int" | "integer" | "float" | "free-list" | "select-array" | "multi-select" | "hash" | "rgbcolor" | "free-hash" | "any" | "bool" | "richtext" | "data-provider" | "processor-mappings" | "tool-catalog" | "code-editor" | "uri" | "uuid" | "hostname" | "ipv4" | "ipv6" | "phone" | "byte-size" | "timeout" | "option_hash" | "collection-documents" | "processor" | "schema-definition" | "test-cases" | "test-value-contract" | "dpql" | "active-windows";
 export declare const isOptionInterfaceUiType: (type: unknown) => type is "mapper" | "workflow" | "service" | "job" | "connection" | "class" | "fsm" | "value-map" | "qog" | "ai-collection" | "ai-endpoint" | "ai-guardrail" | "alertrule" | "alertsilence" | "api-schema" | "auth-profile" | "business-process" | "installed-release" | "ml-model" | "release-config" | "schema" | "test";
-export declare const isKnownQorusUiType: (type: unknown) => type is "string" | "number" | "boolean" | "file" | "data" | "select" | "date" | "email" | "url" | "list" | "auto" | "richtext" | "uri" | "dpql" | "mapper" | "workflow" | "service" | "job" | "connection" | "class" | "fsm" | "value-map" | "qog" | "ai-collection" | "ai-endpoint" | "ai-guardrail" | "alertrule" | "alertsilence" | "api-schema" | "auth-profile" | "business-process" | "installed-release" | "ml-model" | "release-config" | "schema" | "test" | "binary" | "long-string" | "enum" | "select-string" | "file-as-string" | "int" | "integer" | "float" | "free-list" | "select-array" | "multi-select" | "hash" | "rgbcolor" | "free-hash" | "any" | "bool" | "data-provider" | "processor-mappings" | "tool-catalog" | "code-editor" | "options" | "byte-size" | "timeout" | "uuid" | "hostname" | "ipv4" | "ipv6" | "phone" | "option_hash" | "collection-documents" | "processor" | "schema-definition" | "test-cases" | "test-value-contract" | "active-windows" | "api-manager" | "array" | "array-auto" | "array-of-pairs" | "class-array" | "class-connectors" | "constant-array" | "context-selector" | "cron" | "data-provider-options" | "file-array" | "fsm-list" | "function-array" | "http-content" | "method-name" | "opcua-method-arguments" | "opcua-write-values" | "service-events" | "service-webhooks" | "type-selector";
+export declare const isKnownQorusUiType: (type: unknown) => type is "string" | "number" | "boolean" | "file" | "data" | "select" | "date" | "email" | "url" | "list" | "auto" | "mapper" | "workflow" | "service" | "job" | "connection" | "class" | "fsm" | "value-map" | "qog" | "ai-collection" | "ai-endpoint" | "ai-guardrail" | "alertrule" | "alertsilence" | "api-schema" | "auth-profile" | "business-process" | "installed-release" | "ml-model" | "release-config" | "schema" | "test" | "binary" | "long-string" | "enum" | "select-string" | "file-as-string" | "int" | "integer" | "float" | "free-list" | "select-array" | "multi-select" | "hash" | "rgbcolor" | "free-hash" | "any" | "bool" | "richtext" | "data-provider" | "processor-mappings" | "tool-catalog" | "code-editor" | "uri" | "uuid" | "hostname" | "ipv4" | "ipv6" | "phone" | "byte-size" | "timeout" | "option_hash" | "collection-documents" | "processor" | "schema-definition" | "test-cases" | "test-value-contract" | "dpql" | "active-windows" | "api-manager" | "array" | "array-auto" | "array-of-pairs" | "class-array" | "class-connectors" | "constant-array" | "context-selector" | "cron" | "data-provider-options" | "file-array" | "fsm-list" | "function-array" | "http-content" | "method-name" | "opcua-method-arguments" | "opcua-write-values" | "options" | "service-events" | "service-webhooks" | "type-selector";
 /** The spellings that mean "no concrete type" wherever they appear. */
 export declare const UNTYPED_OPTION_TYPES: readonly ["any", "auto"];
 export type TUntypedOptionType = (typeof UNTYPED_OPTION_TYPES)[number];

package/dist/helpers/qorusTypeCatalogue.d.ts

@@ -0,0 +1,147 @@
+import { IReqoreIconName } from '@qoretechnologies/reqore/dist/types/icons';
+import { TQorusType } from '@qoretechnologies/ts-toolkit';
+export interface IQorusTypeObject {
+    /** The type's name as a label: in a picker, a form, a list ("Whole number"). */
+    display_name: string;
+    /**
+     * The type's name inside a sentence ("a whole number": "The expression gives a whole number"). A server before
+     * qorus c6b3fb97c gives none; see `qorusTypeSentenceForm`.
+     */
+    sentence_form?: string;
+    name: TQorusType | string;
+    desc?: string;
+    short_desc?: string;
+    icon?: IReqoreIconName;
+    types_accepted: (TQorusType | string)[];
+    exact_match?: (TQorusType | string)[];
+    /**
+     * Whether a picker that lists every type offers it as a choice. A type that is not offered (the string format
+     * types, a file) names a field or an option whose UI type it is, and says what values it takes, but nobody
+     * chooses it for a value; see `offeredQorusTypes`. A server before qorus 974643455 says nothing: offered.
+     */
+    offered?: boolean;
+}
+/**
+ * The types a value's own type menu offers ("Set Custom Value"), in the order it lists them: text first. The menu
+ * follows this order, not the catalogue's, so the server moving a type in its catalogue does not move it in the menu
+ * (richtext, which follows the Qorus object types in the catalogue since qorus ed0f9ba62).
+ */
+export declare const compactTypesList: string[];
+/** The types `compactTypesList` names, in its order, as the catalogue describes them; one it lacks is left out. */
+export declare const compactQorusTypes: (types: IQorusTypeObject[] | undefined) => IQorusTypeObject[];
+/**
+ * reqraft's copy of the server's type catalogue (GET /system/qorus-type-info), used until the server answers: the
+ * same types, in the same order, with the same fields. __tests__/qorusTypeCatalogue.test.ts compares it with a
+ * recorded response (__tests__/fixtures/qorusTypeInfo.json), so a copy that drifts from the server fails.
+ */
+export declare const defaultQorusTypes: IQorusTypeObject[];
+/**
+ * The type catalogue for code outside a component: the server's answer once a `useQorusTypes` has it, reqraft's
+ * copy (`defaultQorusTypes`) until then. It gave reqraft's copy always, so a type or a conversion only the server
+ * knows was never seen by the checks that decide which values and templates fit a field (qorus#646). A component
+ * gives the checks `useQorusTypes().value` instead, so that it draws again when the answer comes.
+ */
+export declare const getQorusTypes: () => IQorusTypeObject[];
+/**
+ * The types a picker that lists every type offers: the ones the catalogue offers (`offered` is not false), and the
+ * type a value already has (`held`), so that a value of a type that is not offered still shows what it is. In the
+ * catalogue's order.
+ */
+export declare const offeredQorusTypes: (types: IQorusTypeObject[] | undefined, held?: string | string[]) => IQorusTypeObject[];
+/** Keeps the server's answer for `getQorusTypes`; `useQorusTypes` gives it each answer it has. */
+export declare const setServerQorusTypes: (types: IQorusTypeObject[] | undefined) => void;
+/** Forgets the server's answer, so that a test or a story starts without one. */
+export declare const _resetServerQorusTypesForTests: () => void;
+/**
+ * A type's name as the catalogue lists it: Qore's other name for a type (`integer`, `boolean`) is the type it names
+ * (`int`, `bool`). The server's catalogue knows each type by one name only, and says which it converts by that name.
+ */
+export declare const catalogueTypeName: (typeName: string) => string;
+/**
+ * The catalogue's entry for a type (the server's catalogue, or reqraft's copy until it answers).
+ *
+ * The catalogue lists each type once, by its own name, and the catalogue's own entry for a name always wins. A type
+ * named another way is the type it is, as the server names it (qorus c6b3fb97c): `boolean` and `integer` are `bool`
+ * and `int`; an optional type (`*string`) and a soft one (`softint`, a declaration that converts a value to its base
+ * type) are their base type; a complex one (`hash<auto>`, `list<string>`) is its kind.
+ *
+ * A type the catalogue lists under none of those names is the type of its `baseType`: the base data type that
+ * Qorus gives with every field, option and argument (`base_type`), so that a type the catalogue does not list (a
+ * user type, a type of a newer server) is the kind of value it holds. Undefined where neither is listed.
+ */
+export declare const qorusTypeEntry: (types: IQorusTypeObject[] | undefined, typeName: string | undefined, baseType?: string) => IQorusTypeObject | undefined;
+/** The name of a type no catalogue entry names: a user type by its path, anything else as unknown. */
+export declare const UNKNOWN_TYPE_NAME = "Unknown type";
+/**
+ * What a type is called as a label ("Whole number"), by the type catalogue, or by its `baseType` where the
+ * catalogue lists it under no name (see `qorusTypeEntry`). A type named by neither is never named by its code: a
+ * user type is named by its path, anything else is "Unknown type" (qorus#646).
+ *
+ * No type (`undefined` or an empty name: a place whose type is not known yet) has no name: `undefined`, and the
+ * caller draws or words its text without one (qorus#646).
+ */
+export declare const qorusTypeDisplayName: (types: IQorusTypeObject[] | undefined, typeName: string | undefined, baseType?: string) => string | undefined;
+/**
+ * What a type is called inside a sentence ("a whole number": "The expression gives a whole number"), by the type
+ * catalogue - its sentence form, which the server gives in the language it is asked for (qorus#646, c6b3fb97c).
+ *
+ * A catalogue with no sentence form for it (a server before c6b3fb97c) gives a wording that needs no article -
+ * "a value of type Whole number" - with its display name. An English article is never built from a display name:
+ * "a Exact number", "a Whole number" in a sentence of another language. A type named neither by the catalogue
+ * nor by its `baseType` is "a value of type" its path where it is a user type, else "a value of an unknown type".
+ *
+ * No type (`undefined` or an empty name) has no sentence form: `undefined`, and the caller words its sentence
+ * without a type ("This expression gives nothing", "Converted to a whole number") rather than "a value of type
+ * undefined" (qorus#646).
+ */
+export declare const qorusTypeSentenceForm: (types: IQorusTypeObject[] | undefined, typeName: string | undefined, baseType?: string) => string | undefined;
+/** What a type is called inside a sentence ("a whole number"), by a catalogue: `useQorusTypes().getTypeSentenceForm`. */
+export type TTypeSentenceForm = (typeName: string | undefined, baseType?: string) => string | undefined;
+/** The built-in catalogue's sentence form of a type, for a surface no form has given the server's catalogue to. */
+export declare const builtInTypeSentenceForm: TTypeSentenceForm;
+/**
+ * A type's name as a label - its display name ("Whole number") - only where the catalogue lists it, else
+ * undefined: a type it does not list is not named by its code (`<string>`), which is no word for a reader
+ * (qorus#646, IDE rule: no raw data).
+ */
+export declare const qorusTypeKnownName: (types: IQorusTypeObject[] | undefined, typeName: string | undefined, baseType?: string) => string | undefined;
+/** A type's name as a label where the catalogue lists it, by a catalogue (`qorusTypeKnownName`). */
+export type TTypeName = (typeName: string | undefined, baseType?: string) => string | undefined;
+/** The built-in catalogue's name for a type, for a surface no form has given the server's catalogue to. */
+export declare const builtInTypeName: TTypeName;
+/**
+ * A type's name as a label that is never its code (`qorusTypeDisplayName`): what a list of templates badges a
+ * template with - a user type with no base type by its path, any other unknown type "Unknown type".
+ */
+export type TTypeLabel = (typeName: string | undefined, baseType?: string) => string | undefined;
+/** The built-in catalogue's label for a type, for a list no form has given the server's catalogue to. */
+export declare const builtInTypeLabel: TTypeLabel;
+/**
+ * What kind of value an option takes, in words: its kind of control's name where the catalogue names it (a
+ * color), else its type's ("Whole number"), with what a list holds after it ("List (Text)"). Undefined where the
+ * catalogue names neither: nothing is said rather than the type's code.
+ */
+export declare const optionTypeWords: (schema: {
+    type?: unknown;
+    ui_type?: unknown;
+    ui_element_type?: unknown;
+    base_type?: unknown;
+    element_base_type?: unknown;
+} | undefined, typeName: TTypeName) => string | undefined;
+/**
+ * What kind of value an option takes, inside a sentence ("a whole number": "Takes a whole number."), by its kind of
+ * control where the catalogue names it, else by its type. Undefined where the catalogue names neither.
+ */
+export declare const optionTypeSentence: (schema: {
+    type?: unknown;
+    ui_type?: unknown;
+    base_type?: unknown;
+} | undefined, typeName: TTypeName, typeSentenceForm: TTypeSentenceForm) => string | undefined;
+/**
+ * Whether a place of type `typeName` (its base type `baseType`) takes a record whole - a hash, a Qog state's data:
+ * where the catalogue lists it as a hash, or as taking a hash in its own right (qorus#646, David's review: "Any or
+ * hash yes, scalar no"). Text, which converts any value, is not a place for a record; a place of any type is
+ * judged by its caller (`isUntypedOptionType`), as the catalogue names no such type.
+ */
+export declare const qorusTypeTakesRecords: (types: IQorusTypeObject[] | undefined, typeName: string | undefined, baseType?: string) => boolean;
+//# sourceMappingURL=qorusTypeCatalogue.d.ts.map

package/dist/helpers/qorusTypeCatalogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"qorusTypeCatalogue.d.ts","sourceRoot":"","sources":["../../src/helpers/qorusTypeCatalogue.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,eAAe,EAAE,MAAM,2CAA2C,CAAC;AAC5E,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAE1D,MAAM,WAAW,gBAAgB;IAC/B,gFAAgF;IAChF,YAAY,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,cAAc,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAAC;IACxC,WAAW,CAAC,EAAE,CAAC,UAAU,GAAG,MAAM,CAAC,EAAE,CAAC;IACtC;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,UAAkE,CAAC;AAEhG,mHAAmH;AACnH,eAAO,MAAM,iBAAiB,UAAW,gBAAgB,EAAE,GAAG,SAAS,KAAG,gBAAgB,EACL,CAAC;AAEtF;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,gBAAgB,EAoT/C,CAAC;AAKF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAO,gBAAgB,EAA2C,CAAC;AAE7F;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,UACrB,gBAAgB,EAAE,GAAG,SAAS,SAC9B,MAAM,GAAG,MAAM,EAAE,KACvB,gBAAgB,EAKlB,CAAC;AAEF,kGAAkG;AAClG,eAAO,MAAM,mBAAmB,UAAW,gBAAgB,EAAE,GAAG,SAAS,KAAG,IAE3E,CAAC;AAEF,iFAAiF;AACjF,eAAO,MAAM,8BAA8B,QAAO,IAAsC,CAAC;AAKzF;;;GAGG;AACH,eAAO,MAAM,iBAAiB,aAAc,MAAM,KAAG,MACZ,CAAC;AAE1C;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc,UAClB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,aACjB,MAAM,KAChB,gBAAgB,GAAG,SAkBrB,CAAC;AAEF,sGAAsG;AACtG,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAIhD;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,UACxB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,aACjB,MAAM,KAChB,MAAM,GAAG,SAGC,CAAC;AAEd;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,UACzB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,aACjB,MAAM,KAChB,MAAM,GAAG,SASX,CAAC;AAEF,yHAAyH;AACzH,MAAM,MAAM,iBAAiB,GAAG,CAC9B,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,QAAQ,CAAC,EAAE,MAAM,KACd,MAAM,GAAG,SAAS,CAAC;AAExB,mHAAmH;AACnH,eAAO,MAAM,uBAAuB,EAAE,iBACwB,CAAC;AAE/D;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,UACtB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,aACjB,MAAM,KAChB,MAAM,GAAG,SAAiF,CAAC;AAE9F,oGAAoG;AACpG,MAAM,MAAM,SAAS,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;AAEhG,2GAA2G;AAC3G,eAAO,MAAM,eAAe,EAAE,SAC6B,CAAC;AAE5D;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;AAEjG,yGAAyG;AACzG,eAAO,MAAM,gBAAgB,EAAE,UAC8B,CAAC;AAE9D;;;;GAIG;AACH,eAAO,MAAM,eAAe,WAEtB;IACE,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B,GACD,SAAS,YACH,SAAS,KAClB,MAAM,GAAG,SAUX,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,WACrB;IAAE,IAAI,CAAC,EAAE,OAAO,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,YACpE,SAAS,oBACD,iBAAiB,KAClC,MAAM,GAAG,SAQX,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,UACzB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,aACjB,MAAM,KAChB,OAGF,CAAC"}