@qoretechnologies/reqraft 0.10.62 → 0.10.63-pr.142.g0b675cd

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/qorusTypeCatalogue.d.ts

@@ -0,0 +1,53 @@
+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)[];
+}
+export declare const compactTypesList: string[];
+/**
+ * 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[];
+export declare const getQorusTypes: () => IQorusTypeObject[];
+/**
+ * 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;
+/**
+ * What a type is called as a label ("Whole number"), by the type catalogue; a type it lists under no name keeps its
+ * name. See `qorusTypeEntry` for the names a type goes by.
+ *
+ * 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) => 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, or the type's own name where the catalogue lists it under
+ * none. An English article is never built from a display name: "a Exact number", "a Whole number" in a sentence
+ * of another language.
+ *
+ * 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) => string | undefined;
+//# 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;CACvC;AAED,eAAO,MAAM,gBAAgB,UAAkE,CAAC;AAEhG;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,EAAE,gBAAgB,EA8L/C,CAAC;AAEF,eAAO,MAAM,aAAa,QAAO,gBAAgB,EAAuB,CAAC;AAKzE;;;GAGG;AACH,eAAO,MAAM,iBAAiB,aAAc,MAAM,KAAG,MAAiD,CAAC;AA+BvG;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,UACxB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,KAC3B,MAAM,GAAG,SACwE,CAAC;AAErF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,UACzB,gBAAgB,EAAE,GAAG,SAAS,YAC3B,MAAM,GAAG,SAAS,KAC3B,MAAM,GAAG,SAMX,CAAC"}

package/dist/helpers/qorusTypeCatalogue.js

@@ -0,0 +1,262 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.qorusTypeSentenceForm = exports.qorusTypeDisplayName = exports.catalogueTypeName = exports.getQorusTypes = exports.defaultQorusTypes = exports.compactTypesList = void 0;
+exports.compactTypesList = ['richtext', 'float', 'hash', 'list', 'bool', 'date', 'binary'];
+/**
+ * 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.
+ */
+exports.defaultQorusTypes = [
+    {
+        name: 'any',
+        display_name: 'Any',
+        sentence_form: 'any value',
+        short_desc: 'Any data type',
+        desc: 'Any data type',
+        types_accepted: ['any'],
+        exact_match: ['any'],
+    },
+    {
+        name: 'context',
+        display_name: 'Context',
+        sentence_form: "a value of the context's type",
+        short_desc: 'The data type is determined by the context value chosen',
+        desc: 'The data type is determined by the context value chosen',
+        types_accepted: ['any'],
+        exact_match: ['any'],
+    },
+    {
+        name: 'string',
+        display_name: 'Text',
+        sentence_form: 'text',
+        short_desc: 'Text',
+        desc: 'Text',
+        types_accepted: ['any'],
+        exact_match: ['string', 'richtext'],
+    },
+    {
+        name: 'richtext',
+        display_name: 'Rich text',
+        sentence_form: 'formatted text',
+        short_desc: 'Text with formatting',
+        desc: 'Text with formatting',
+        types_accepted: ['any'],
+        exact_match: ['string', 'richtext'],
+    },
+    {
+        name: 'int',
+        display_name: 'Whole number',
+        sentence_form: 'a whole number',
+        short_desc: 'A whole number (64-bit)',
+        desc: 'A whole number (64-bit)',
+        types_accepted: ['int', 'float', 'number'],
+        exact_match: ['int', 'float', 'number'],
+    },
+    {
+        name: 'float',
+        display_name: 'Number',
+        sentence_form: 'a number',
+        short_desc: 'A number with a fractional part (double precision)',
+        desc: 'A number with a fractional part (double precision)',
+        types_accepted: ['float', 'int', 'number'],
+        exact_match: ['float', 'int', 'number'],
+    },
+    {
+        name: 'number',
+        display_name: 'Exact number',
+        sentence_form: 'an exact number',
+        short_desc: 'A decimal number kept exactly',
+        desc: 'A decimal number kept exactly',
+        types_accepted: ['number', 'float', 'int'],
+        exact_match: ['number', 'float', 'int'],
+    },
+    {
+        name: 'bool',
+        display_name: 'True or false',
+        sentence_form: 'true or false',
+        short_desc: 'True or false',
+        desc: 'True or false',
+        types_accepted: ['bool'],
+        exact_match: ['bool'],
+    },
+    {
+        name: 'date',
+        display_name: 'Date',
+        sentence_form: 'a date and time',
+        short_desc: 'A date and time',
+        desc: 'A date and time',
+        types_accepted: ['date'],
+        exact_match: ['date'],
+    },
+    {
+        name: 'time',
+        display_name: 'Time',
+        sentence_form: 'a time of day',
+        short_desc: 'A time of day',
+        desc: 'A time of day',
+        types_accepted: ['date'],
+        exact_match: ['date'],
+    },
+    {
+        name: 'binary',
+        display_name: 'Binary data',
+        sentence_form: 'binary data',
+        short_desc: 'Binary data',
+        desc: 'Binary data',
+        types_accepted: ['binary'],
+        exact_match: ['binary'],
+    },
+    {
+        name: 'data',
+        display_name: 'Text or binary data',
+        sentence_form: 'text or binary data',
+        short_desc: 'Text or binary data',
+        desc: 'Text or binary data',
+        types_accepted: ['string', 'richtext', 'binary', 'data'],
+        exact_match: ['string', 'richtext', 'binary', 'data'],
+    },
+    {
+        name: 'hash',
+        display_name: 'Key-value pairs (hash)',
+        sentence_form: 'key-value pairs (a hash)',
+        short_desc: 'Key-value pairs (hash)',
+        desc: 'Key-value pairs (a hash): each value is stored under a named key',
+        types_accepted: ['hash'],
+        exact_match: ['hash'],
+    },
+    {
+        name: 'list',
+        display_name: 'List',
+        sentence_form: 'a list',
+        short_desc: 'List',
+        desc: 'List',
+        types_accepted: ['list'],
+        exact_match: ['list'],
+    },
+    {
+        name: 'rgbcolor',
+        display_name: 'Color',
+        sentence_form: 'a color',
+        short_desc: 'A color: red, green and blue from 0 to 255 and an opacity from 0 to 1',
+        desc: 'A color, stored as a hash: r, g and b are integers from 0 to 255, and a is the opacity, from 0 (transparent) to 1 (opaque); a missing or null a is opaque. A hex code such as #ff0000 is not a stored color.',
+        types_accepted: ['rgbcolor'],
+        exact_match: ['rgbcolor'],
+    },
+    {
+        name: 'workflow',
+        display_name: 'Workflow',
+        sentence_form: 'a workflow',
+        short_desc: 'Qorus workflow',
+        desc: 'Qorus workflow',
+        types_accepted: ['workflow', 'string', 'richtext'],
+        exact_match: ['workflow', 'string', 'richtext'],
+    },
+    {
+        name: 'service',
+        display_name: 'Service',
+        sentence_form: 'a service',
+        short_desc: 'Qorus service',
+        desc: 'Qorus service',
+        types_accepted: ['service', 'string', 'richtext'],
+        exact_match: ['service', 'string', 'richtext'],
+    },
+    {
+        name: 'job',
+        display_name: 'Job',
+        sentence_form: 'a job',
+        short_desc: 'Qorus job',
+        desc: 'Qorus job',
+        types_accepted: ['job', 'string', 'richtext'],
+        exact_match: ['job', 'string', 'richtext'],
+    },
+    {
+        name: 'mapper',
+        display_name: 'Mapper',
+        sentence_form: 'a mapper',
+        short_desc: 'Qorus mapper',
+        desc: 'Qorus mapper',
+        types_accepted: ['mapper', 'string', 'richtext'],
+        exact_match: ['mapper', 'string', 'richtext'],
+    },
+    {
+        name: 'data-provider',
+        display_name: 'Data provider',
+        sentence_form: 'a data provider',
+        short_desc: 'Qorus data provider',
+        desc: 'Qorus data provider',
+        types_accepted: ['data-provider'],
+        exact_match: ['data-provider'],
+    },
+    {
+        name: 'connection',
+        display_name: 'Connection',
+        sentence_form: 'a connection',
+        short_desc: 'Qorus connection',
+        desc: 'Qorus connection',
+        types_accepted: ['connection', 'string', 'richtext'],
+        exact_match: ['connection', 'string', 'richtext'],
+    },
+];
+var getQorusTypes = function () { return exports.defaultQorusTypes; };
+exports.getQorusTypes = getQorusTypes;
+/** Qore's other names for a type the catalogue lists under its own (qorus#646). */
+var QORE_TYPE_ALIASES = { boolean: 'bool', integer: 'int' };
+/**
+ * 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.
+ */
+var catalogueTypeName = function (typeName) { var _a; return (_a = QORE_TYPE_ALIASES[typeName]) !== null && _a !== void 0 ? _a : typeName; };
+exports.catalogueTypeName = catalogueTypeName;
+/**
+ * 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. Undefined for a type the
+ * catalogue lists under no name.
+ */
+var qorusTypeEntry = function (types, typeName) {
+    var _a, _b, _c, _d, _e, _f;
+    // a place with no type yet is named by nothing
+    if (!typeName) {
+        return undefined;
+    }
+    var listed = function (name) { return types === null || types === void 0 ? void 0 : types.find(function (type) { return type.name === name; }); };
+    var base = typeName.replace(/^\*/, '').replace(/<.*$/, '');
+    var unsoft = /^soft[a-z]/.test(base) ? base.slice(4) : base;
+    return ((_e = (_d = (_b = (_a = listed(typeName)) !== null && _a !== void 0 ? _a : listed(base)) !== null && _b !== void 0 ? _b : listed((_c = QORE_TYPE_ALIASES[base]) !== null && _c !== void 0 ? _c : '')) !== null && _d !== void 0 ? _d : listed(unsoft)) !== null && _e !== void 0 ? _e : listed((_f = QORE_TYPE_ALIASES[unsoft]) !== null && _f !== void 0 ? _f : ''));
+};
+/**
+ * What a type is called as a label ("Whole number"), by the type catalogue; a type it lists under no name keeps its
+ * name. See `qorusTypeEntry` for the names a type goes by.
+ *
+ * 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).
+ */
+var qorusTypeDisplayName = function (types, typeName) { var _a, _b; return typeName ? ((_b = (_a = qorusTypeEntry(types, typeName)) === null || _a === void 0 ? void 0 : _a.display_name) !== null && _b !== void 0 ? _b : typeName) : undefined; };
+exports.qorusTypeDisplayName = qorusTypeDisplayName;
+/**
+ * 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, or the type's own name where the catalogue lists it under
+ * none. An English article is never built from a display name: "a Exact number", "a Whole number" in a sentence
+ * of another language.
+ *
+ * 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).
+ */
+var qorusTypeSentenceForm = function (types, typeName) {
+    var _a;
+    if (!typeName) {
+        return undefined;
+    }
+    var entry = qorusTypeEntry(types, typeName);
+    return (entry === null || entry === void 0 ? void 0 : entry.sentence_form) || "a value of type ".concat((_a = entry === null || entry === void 0 ? void 0 : entry.display_name) !== null && _a !== void 0 ? _a : typeName);
+};
+exports.qorusTypeSentenceForm = qorusTypeSentenceForm;
+//# sourceMappingURL=qorusTypeCatalogue.js.map

package/dist/helpers/qorusTypeCatalogue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"qorusTypeCatalogue.js","sourceRoot":"","sources":["../../src/helpers/qorusTypeCatalogue.ts"],"names":[],"mappings":";;;AAuBa,QAAA,gBAAgB,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEhG;;;;GAIG;AACU,QAAA,iBAAiB,GAAuB;IACnD;QACE,IAAI,EAAE,KAAK;QACX,YAAY,EAAE,KAAK;QACnB,aAAa,EAAE,WAAW;QAC1B,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,eAAe;QACrB,cAAc,EAAE,CAAC,KAAK,CAAC;QACvB,WAAW,EAAE,CAAC,KAAK,CAAC;KACrB;IACD;QACE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,SAAS;QACvB,aAAa,EAAE,+BAA+B;QAC9C,UAAU,EAAE,yDAAyD;QACrE,IAAI,EAAE,yDAAyD;QAC/D,cAAc,EAAE,CAAC,KAAK,CAAC;QACvB,WAAW,EAAE,CAAC,KAAK,CAAC;KACrB;IACD;QACE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,MAAM;QACpB,aAAa,EAAE,MAAM;QACrB,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,MAAM;QACZ,cAAc,EAAE,CAAC,KAAK,CAAC;QACvB,WAAW,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;KACpC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,WAAW;QACzB,aAAa,EAAE,gBAAgB;QAC/B,UAAU,EAAE,sBAAsB;QAClC,IAAI,EAAE,sBAAsB;QAC5B,cAAc,EAAE,CAAC,KAAK,CAAC;QACvB,WAAW,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;KACpC;IACD;QACE,IAAI,EAAE,KAAK;QACX,YAAY,EAAE,cAAc;QAC5B,aAAa,EAAE,gBAAgB;QAC/B,UAAU,EAAE,yBAAyB;QACrC,IAAI,EAAE,yBAAyB;QAC/B,cAAc,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,WAAW,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;KACxC;IACD;QACE,IAAI,EAAE,OAAO;QACb,YAAY,EAAE,QAAQ;QACtB,aAAa,EAAE,UAAU;QACzB,UAAU,EAAE,oDAAoD;QAChE,IAAI,EAAE,oDAAoD;QAC1D,cAAc,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC;QAC1C,WAAW,EAAE,CAAC,OAAO,EAAE,KAAK,EAAE,QAAQ,CAAC;KACxC;IACD;QACE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,cAAc;QAC5B,aAAa,EAAE,iBAAiB;QAChC,UAAU,EAAE,+BAA+B;QAC3C,IAAI,EAAE,+BAA+B;QACrC,cAAc,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC;QAC1C,WAAW,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC;KACxC;IACD;QACE,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,eAAe;QAC7B,aAAa,EAAE,eAAe;QAC9B,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,eAAe;QACrB,cAAc,EAAE,CAAC,MAAM,CAAC;QACxB,WAAW,EAAE,CAAC,MAAM,CAAC;KACtB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,MAAM;QACpB,aAAa,EAAE,iBAAiB;QAChC,UAAU,EAAE,iBAAiB;QAC7B,IAAI,EAAE,iBAAiB;QACvB,cAAc,EAAE,CAAC,MAAM,CAAC;QACxB,WAAW,EAAE,CAAC,MAAM,CAAC;KACtB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,MAAM;QACpB,aAAa,EAAE,eAAe;QAC9B,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,eAAe;QACrB,cAAc,EAAE,CAAC,MAAM,CAAC;QACxB,WAAW,EAAE,CAAC,MAAM,CAAC;KACtB;IACD;QACE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,aAAa;QAC3B,aAAa,EAAE,aAAa;QAC5B,UAAU,EAAE,aAAa;QACzB,IAAI,EAAE,aAAa;QACnB,cAAc,EAAE,CAAC,QAAQ,CAAC;QAC1B,WAAW,EAAE,CAAC,QAAQ,CAAC;KACxB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,qBAAqB;QACnC,aAAa,EAAE,qBAAqB;QACpC,UAAU,EAAE,qBAAqB;QACjC,IAAI,EAAE,qBAAqB;QAC3B,cAAc,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC;QACxD,WAAW,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,CAAC;KACtD;IACD;QACE,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,wBAAwB;QACtC,aAAa,EAAE,0BAA0B;QACzC,UAAU,EAAE,wBAAwB;QACpC,IAAI,EAAE,kEAAkE;QACxE,cAAc,EAAE,CAAC,MAAM,CAAC;QACxB,WAAW,EAAE,CAAC,MAAM,CAAC;KACtB;IACD;QACE,IAAI,EAAE,MAAM;QACZ,YAAY,EAAE,MAAM;QACpB,aAAa,EAAE,QAAQ;QACvB,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE,MAAM;QACZ,cAAc,EAAE,CAAC,MAAM,CAAC;QACxB,WAAW,EAAE,CAAC,MAAM,CAAC;KACtB;IACD;QACE,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,OAAO;QACrB,aAAa,EAAE,SAAS;QACxB,UAAU,EAAE,uEAAuE;QACnF,IAAI,EAAE,8MAA8M;QACpN,cAAc,EAAE,CAAC,UAAU,CAAC;QAC5B,WAAW,EAAE,CAAC,UAAU,CAAC;KAC1B;IACD;QACE,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,UAAU;QACxB,aAAa,EAAE,YAAY;QAC3B,UAAU,EAAE,gBAAgB;QAC5B,IAAI,EAAE,gBAAgB;QACtB,cAAc,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC;QAClD,WAAW,EAAE,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC;KAChD;IACD;QACE,IAAI,EAAE,SAAS;QACf,YAAY,EAAE,SAAS;QACvB,aAAa,EAAE,WAAW;QAC1B,UAAU,EAAE,eAAe;QAC3B,IAAI,EAAE,eAAe;QACrB,cAAc,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC;QACjD,WAAW,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC;KAC/C;IACD;QACE,IAAI,EAAE,KAAK;QACX,YAAY,EAAE,KAAK;QACnB,aAAa,EAAE,OAAO;QACtB,UAAU,EAAE,WAAW;QACvB,IAAI,EAAE,WAAW;QACjB,cAAc,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC;QAC7C,WAAW,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,UAAU,CAAC;KAC3C;IACD;QACE,IAAI,EAAE,QAAQ;QACd,YAAY,EAAE,QAAQ;QACtB,aAAa,EAAE,UAAU;QACzB,UAAU,EAAE,cAAc;QAC1B,IAAI,EAAE,cAAc;QACpB,cAAc,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC;QAChD,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,UAAU,CAAC;KAC9C;IACD;QACE,IAAI,EAAE,eAAe;QACrB,YAAY,EAAE,eAAe;QAC7B,aAAa,EAAE,iBAAiB;QAChC,UAAU,EAAE,qBAAqB;QACjC,IAAI,EAAE,qBAAqB;QAC3B,cAAc,EAAE,CAAC,eAAe,CAAC;QACjC,WAAW,EAAE,CAAC,eAAe,CAAC;KAC/B;IACD;QACE,IAAI,EAAE,YAAY;QAClB,YAAY,EAAE,YAAY;QAC1B,aAAa,EAAE,cAAc;QAC7B,UAAU,EAAE,kBAAkB;QAC9B,IAAI,EAAE,kBAAkB;QACxB,cAAc,EAAE,CAAC,YAAY,EAAE,QAAQ,EAAE,UAAU,CAAC;QACpD,WAAW,EAAE,CAAC,YAAY,EAAE,QAAQ,EAAE,UAAU,CAAC;KAClD;CACF,CAAC;AAEK,IAAM,aAAa,GAAG,cAA0B,OAAA,yBAAiB,EAAjB,CAAiB,CAAC;AAA5D,QAAA,aAAa,iBAA+C;AAEzE,mFAAmF;AACnF,IAAM,iBAAiB,GAA2B,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAEtF;;;GAGG;AACI,IAAM,iBAAiB,GAAG,UAAC,QAAgB,YAAa,OAAA,MAAA,iBAAiB,CAAC,QAAQ,CAAC,mCAAI,QAAQ,CAAA,EAAA,CAAC;AAA1F,QAAA,iBAAiB,qBAAyE;AAEvG;;;;;;;;GAQG;AACH,IAAM,cAAc,GAAG,UACrB,KAAqC,EACrC,QAA4B;;IAE5B,+CAA+C;IAC/C,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAM,MAAM,GAAG,UAAC,IAAY,IAAK,OAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,KAAK,IAAI,EAAlB,CAAkB,CAAC,EAAzC,CAAyC,CAAC;IAC3E,IAAM,IAAI,GAAG,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC7D,IAAM,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC9D,OAAO,CACL,MAAA,MAAA,MAAA,MAAA,MAAM,CAAC,QAAQ,CAAC,mCAChB,MAAM,CAAC,IAAI,CAAC,mCACZ,MAAM,CAAC,MAAA,iBAAiB,CAAC,IAAI,CAAC,mCAAI,EAAE,CAAC,mCACrC,MAAM,CAAC,MAAM,CAAC,mCACd,MAAM,CAAC,MAAA,iBAAiB,CAAC,MAAM,CAAC,mCAAI,EAAE,CAAC,CACxC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;GAMG;AACI,IAAM,oBAAoB,GAAG,UAClC,KAAqC,EACrC,QAA4B,gBAE5B,OAAA,QAAQ,CAAC,CAAC,CAAC,CAAC,MAAA,MAAA,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,0CAAE,YAAY,mCAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA,EAAA,CAAC;AAJxE,QAAA,oBAAoB,wBAIoD;AAErF;;;;;;;;;;;;GAYG;AACI,IAAM,qBAAqB,GAAG,UACnC,KAAqC,EACrC,QAA4B;;IAE5B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,IAAM,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IAC9C,OAAO,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,aAAa,KAAI,0BAAmB,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,YAAY,mCAAI,QAAQ,CAAE,CAAC;AACtF,CAAC,CAAC;AATW,QAAA,qBAAqB,yBAShC"}

package/dist/helpers/readableColors.d.ts

@@ -0,0 +1,36 @@
+import { IReqoreTheme } from '@qoretechnologies/reqore/dist/constants/theme';
+/**
+ * Colors that stand out from what they are drawn on (WCAG 2.1 AA, qorus#646): 4.5:1 for text, 3:1 for icons and
+ * large text. Reqore has these from qoretechnologies/reqore#708 on (`getReadableAccentColorOn`, `getReadableAlpha`);
+ * until reqraft builds on that release, the read-first form picks its own colors with these.
+ */
+export declare const READABLE_TEXT = 4.5;
+export declare const READABLE_ICON = 3;
+export declare const READABLE_MARGIN = 0.1;
+/** The WCAG contrast ratio of two opaque colors, unrounded (polished's getContrast rounds 4.495 up to 4.5). */
+export declare const contrastRatio: (a: string, b: string) => number;
+/**
+ * `color` in the shade of it that stands out by `minContrast` from every one of `backgrounds` (opaque): the color
+ * itself when it does, else moved toward white or black - whichever stands out more from the worst of them - only
+ * as far as it takes. The hue is kept: a warning stays amber, only lighter on a dark surface. `alpha` is how faded
+ * it is drawn: a mark that something else draws at 70% (reqore's panel and button icons) needs a stronger shade.
+ */
+export declare const getReadableShade: (color: string, backgrounds: string[], minContrast?: number, alpha?: number) => string;
+/**
+ * How faded `color` can be drawn on every one of `backgrounds` (opaque) and still stand out by `minContrast`:
+ * `alpha`, or as little more as it takes (1 when even that does not).
+ */
+export declare const getReadableOpacity: (color: string, backgrounds: string[], alpha: number, minContrast?: number) => number;
+/** A translucent `color` (rgba) at `alpha` that still stands out from `backgrounds` (see `getReadableOpacity`). */
+export declare const getReadableFaded: (color: string, backgrounds: string[], alpha: number, minContrast?: number) => string;
+/**
+ * What reqraft's components are drawn on in `theme`: its background, and a shade darker and lighter, as the page
+ * or a panel around them may be.
+ */
+export declare const getThemeSurfaces: (theme: IReqoreTheme) => string[];
+/**
+ * How faded the theme's text can be drawn (`opacity`, a softer note) and still read on what it is drawn on in
+ * the theme (`getThemeSurfaces`): `opacity`, or as little more as it takes. An icon needs 3:1 (`READABLE_ICON`).
+ */
+export declare const getReadableTextOpacity: (theme: IReqoreTheme, opacity: number, minContrast?: number) => number;
+//# sourceMappingURL=readableColors.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readableColors.d.ts","sourceRoot":"","sources":["../../src/helpers/readableColors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,+CAA+C,CAAC;AAS7E;;;;GAIG;AACH,eAAO,MAAM,aAAa,MAAM,CAAC;AACjC,eAAO,MAAM,aAAa,IAAI,CAAC;AAI/B,eAAO,MAAM,eAAe,MAAM,CAAC;AAEnC,+GAA+G;AAC/G,eAAO,MAAM,aAAa,MAAO,MAAM,KAAK,MAAM,KAAG,MAIpD,CAAC;AAYF;;;;;GAKG;AACH,eAAO,MAAM,gBAAgB,UACpB,MAAM,eACA,MAAM,EAAE,gBACR,MAAM,UACZ,MAAM,KACZ,MA0BF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,UACtB,MAAM,eACA,MAAM,EAAE,SACd,MAAM,gBACA,MAAM,KAClB,MA6BF,CAAC;AAEF,mHAAmH;AACnH,eAAO,MAAM,gBAAgB,UACpB,MAAM,eACA,MAAM,EAAE,SACd,MAAM,gBACA,MAAM,KAClB,MAAiF,CAAC;AAErF;;;GAGG;AACH,eAAO,MAAM,gBAAgB,UAAW,YAAY,KAAG,MAAM,EAI5D,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,sBAAsB,UAC1B,YAAY,WACV,MAAM,gBACF,MAAM,KAClB,MACyF,CAAC"}