@orz/query 0.0.0-stage → 0.0.0

package/dist/completion.js

@@ -0,0 +1,400 @@
+/**
+ * Completion at the caret, the pure half: what is being typed, where it
+ * starts and ends, and which values fit. Fetching and rendering stay with
+ * the editor that asks — a search box and a CodeMirror panel read the same
+ * slot.
+ */
+import { rawWord } from "./commands.js";
+import { quoteQueryValue, } from "./query.js";
+import { quoteShellWord, segmentValue, shellWords, } from "./shell-words.js";
+const EMPTY = { matched: false, rows: [] };
+function unitsOf(word, from) {
+    const units = [];
+    for (const segment of word.segments) {
+        if (segment.end <= from)
+            continue;
+        if (segment.quoted !== "none") {
+            units.push({
+                start: segment.start,
+                end: segment.end,
+                bare: null,
+                text: segmentValue(word, segment),
+            });
+            continue;
+        }
+        for (let i = Math.max(segment.start, from); i < segment.end; i += 1) {
+            const ch = word.raw[i - word.start] ?? "";
+            units.push({ start: i, end: i + 1, bare: ch, text: ch });
+        }
+    }
+    return units;
+}
+/**
+ * Where the current alternative of the innermost brace group still open at
+ * the end of `units` starts, or null when no group is open: then a brace is
+ * an ordinary character of the value being typed.
+ */
+function openAlternative(units) {
+    const stack = [];
+    for (const unit of units) {
+        if (unit.bare === "{")
+            stack.push(unit.end);
+        else if (unit.bare === "}")
+            stack.pop();
+        else if (unit.bare === "," && stack.length > 0) {
+            stack[stack.length - 1] = unit.end;
+        }
+    }
+    return stack.at(-1) ?? null;
+}
+const decode = (units, from) => units
+    .filter((u) => u.start >= from)
+    .map((u) => u.text)
+    .join("");
+/**
+ * The rest of an alternative past the caret, so accepting `ui` in
+ * `{web,u|i}` replaces `ui` rather than leaving an `i` behind. Only bare
+ * characters count; a quote or a separator ends it.
+ */
+function alternativeTail(text, caret) {
+    const match = /^[^\s,{}'"\\]*/.exec(text.slice(caret));
+    return caret + (match?.[0].length ?? 0);
+}
+/**
+ * Plain mode: the units of a filter's values up to the caret. A quoted run
+ * only opens where a value (or an alternative) starts, which is the only
+ * place plain mode reads one; null when the caret is inside it.
+ */
+function plainUnits(query, from, caret) {
+    const units = [];
+    let i = from;
+    let valueStart = from;
+    const stack = [];
+    while (i < caret) {
+        const ch = query[i];
+        if (ch === '"' && (i === valueStart || i === stack.at(-1))) {
+            const close = query.indexOf('"', i + 1);
+            if (close === -1 || close >= caret)
+                return null;
+            units.push({
+                start: i,
+                end: close + 1,
+                bare: null,
+                text: query.slice(i + 1, close),
+            });
+            i = close + 1;
+            continue;
+        }
+        units.push({ start: i, end: i + 1, bare: ch, text: ch });
+        if (ch === "{")
+            stack.push(i + 1);
+        else if (ch === "}")
+            stack.pop();
+        else if (ch === ",") {
+            if (stack.length > 0)
+                stack[stack.length - 1] = i + 1;
+            else
+                valueStart = i + 1;
+        }
+        i += 1;
+    }
+    return units;
+}
+function queryAlternative(schema, query, part, caret) {
+    const valuesFrom = part.keyEnd + 1;
+    let units;
+    let open = false;
+    if (schema.escapes === "shell") {
+        const word = shellWords(query.slice(part.start, caret), part.start)[0];
+        if (word === undefined)
+            return null;
+        units = unitsOf(word, valuesFrom);
+        open = word.unclosed === true;
+    }
+    else {
+        units = plainUnits(query, valuesFrom, caret);
+    }
+    if (units === null)
+        return null;
+    const from = openAlternative(units);
+    if (from === null)
+        return null;
+    const to = open ? caret : alternativeTail(query, caret);
+    return { from, to, typed: decode(units, from) + query.slice(caret, to) };
+}
+/**
+ * The slot under the caret in a query: a value where the caret stands after
+ * a known key's colon, else the bare word the caret stands in (or an empty
+ * one where it stands) as a key. Null where a key cannot go at all: inside a
+ * filter's key, and inside quotes, which is how one asks for a literal.
+ */
+export function queryCompletionSlot(schema, parts, query, caret) {
+    for (const part of parts) {
+        if (caret < part.start || caret > part.end)
+            continue;
+        if (part.kind === "filter") {
+            const valuesFrom = part.keyEnd + 1;
+            if (caret < valuesFrom)
+                return null;
+            const spec = schema.qualifiers[part.key]?.value;
+            if (spec === undefined)
+                return null;
+            const group = schema.braces
+                ? queryAlternative(schema, query, part, caret)
+                : null;
+            if (group !== null) {
+                return { kind: "value", ...group, spec, key: part.key, inBraces: true };
+            }
+            // The value the caret is inside, or the empty one it is sitting at.
+            const on = part.values.find((v) => caret >= v.start && caret <= v.end);
+            return {
+                kind: "value",
+                from: on?.start ?? caret,
+                to: on?.end ?? caret,
+                typed: on?.value ?? "",
+                spec,
+                key: part.key,
+                inBraces: false,
+            };
+        }
+        if (part.kind === "text") {
+            if (part.raw.startsWith('"'))
+                return null;
+            if (schema.escapes === "shell" && part.raw.startsWith("'"))
+                return null;
+            const text = query.slice(part.start, caret);
+            const negated = text.startsWith("-");
+            return {
+                kind: "key",
+                from: part.start,
+                to: caret,
+                typed: negated ? text.slice(1) : text,
+                negated,
+            };
+        }
+    }
+    return { kind: "key", from: caret, to: caret, typed: "", negated: false };
+}
+const FIRST_LEVEL = /^\/([a-z0-9-]*)$/;
+const ARGUMENT_LEVEL = /^\/([a-z0-9-]+)[ \t]/;
+/**
+ * The slot at the end of `lineBeforeCaret`: the command word itself, or the
+ * argument the caret is in. Null where the line cannot be a command, past
+ * the last argument, and for a command that takes none.
+ */
+export function commandCompletionSlot(registry, lineBeforeCaret) {
+    const line = lineBeforeCaret;
+    const first = FIRST_LEVEL.exec(line);
+    if (first !== null) {
+        return {
+            kind: "command",
+            from: 0,
+            to: line.length,
+            typed: first[1],
+        };
+    }
+    const head = ARGUMENT_LEVEL.exec(line);
+    if (head === null)
+        return null;
+    const command = registry.byName.get(head[1]);
+    if (command === undefined || command.args.length === 0)
+        return null;
+    const nameEnd = head[1].length + 1;
+    const caret = line.length;
+    const words = shellWords(line.slice(nameEnd), nameEnd);
+    // A word that ends before the caret is finished; the caret starts the next.
+    if (words.length > 0 && words.at(-1).end < caret) {
+        words.push(rawWord(line, caret));
+    }
+    else if (words.length === 0) {
+        words.push(rawWord(line, caret));
+    }
+    const last = command.args.length - 1;
+    let rest = false;
+    const restHead = words[last];
+    if (command.args[last]?.rest &&
+        restHead !== undefined &&
+        !/^['"]/.test(restHead.raw)) {
+        words.splice(last, words.length - last, rawWord(line, restHead.start));
+        rest = true;
+    }
+    const index = words.length - 1;
+    const spec = command.args[index];
+    if (spec === undefined)
+        return null;
+    const word = words[index];
+    let from = word.start;
+    let typed = word.value;
+    let inBraces = false;
+    if (spec.multiple) {
+        const units = unitsOf(word, word.start);
+        const alternative = openAlternative(units);
+        if (alternative !== null) {
+            from = alternative;
+            typed = decode(units, alternative);
+            inBraces = true;
+        }
+    }
+    return {
+        kind: "argument",
+        from,
+        to: caret,
+        typed,
+        spec: spec.value,
+        command: command.name,
+        index,
+        last: index === last,
+        optional: spec.optional === true,
+        rest,
+        inBraces,
+    };
+}
+/**
+ * The values a slot can take: the enum's set, the specials, and the
+ * provider's snapshot, in that order. `"fetch"` tells the caller to ask a
+ * `search` provider for `slot.typed` and call again with what it answered.
+ */
+export function slotValues(slot, provider, fetched) {
+    const spec = slot.spec;
+    const builtins = [
+        ...(spec.kind === "enum" ? spec.values : []),
+        ...(spec.special ?? []),
+    ].map((value) => ({ value }));
+    if (provider === undefined)
+        return builtins;
+    if ("search" in provider) {
+        return fetched === undefined ? "fetch" : [...builtins, ...fetched];
+    }
+    return [...builtins, ...(provider.options ?? [])];
+}
+/** Options that `typed` prefixes, case-insensitively. */
+export function filterOptions(options, typed) {
+    const lower = typed.toLowerCase();
+    return options.filter((o) => o.value.toLowerCase().startsWith(lower));
+}
+/** Splice `text` over `[start, end)` and put the caret after it. */
+export function splice(query, start, end, text) {
+    return {
+        value: query.slice(0, start) + text + query.slice(end),
+        caret: start + text.length,
+    };
+}
+/**
+ * Splice, and leave the caret past a space, so that taking an offer ends a
+ * word rather than parking the caret against the next one.
+ *
+ * Only values do this. A key is completed to its colon and the value comes
+ * next with nothing in between, so a space there would have to be deleted
+ * again.
+ *
+ * The cost, taken deliberately: a value can be a comma-separated list, and
+ * closing it after one value means a second one needs a backspace. That is
+ * the rare path; ending a word is every time.
+ */
+export function spliceThenSpace(query, start, end, text) {
+    const spliced = splice(query, start, end, text);
+    const after = spliced.value.slice(spliced.caret);
+    return {
+        value: /^\s/.test(after)
+            ? spliced.value
+            : `${spliced.value.slice(0, spliced.caret)} ${after}`,
+        caret: spliced.caret + 1,
+    };
+}
+/**
+ * How a value is spelled into a command argument: as one shell word, except
+ * in a rest argument's raw remainder, where quotes would be read literally.
+ */
+export function quoteArgument(slot, value) {
+    return slot.rest ? value : quoteShellWord(value);
+}
+/**
+ * Keys, offered against the word the caret is in. Only a non-empty prefix of
+ * a real key counts as a match; a bare space lists them all, below submit.
+ */
+export function keyRows(schema, query, slot) {
+    if (slot?.kind !== "key")
+        return EMPTY;
+    const typed = slot.typed.toLowerCase();
+    if (typed.includes(":"))
+        return EMPTY;
+    const keys = schema.keys.filter((k) => k.toLowerCase().startsWith(typed));
+    const minus = slot.negated ? "-" : "";
+    return {
+        matched: typed !== "" && keys.length > 0,
+        rows: keys.map((key) => {
+            const hint = schema.qualifiers[key]?.hint;
+            return {
+                id: `key:${key}`,
+                text: `${minus}${key}:`,
+                ...(hint === undefined ? {} : { hint }),
+                icon: "key",
+                apply: splice(query, slot.from, slot.to, `${minus}${key}:`),
+            };
+        }),
+    };
+}
+/**
+ * Values, offered whenever the caret stands where one goes. The colon is
+ * already typed by then, so the intent is not in doubt and this always counts
+ * as a match — including on an empty value, where the whole list is what the
+ * reader is asking for. `options` are offered as given; narrow them with
+ * `filterOptions` first. Inside a brace group no space follows, since the
+ * group is still open.
+ */
+export function valueRows(schema, query, slot, options) {
+    if (slot?.kind !== "value")
+        return EMPTY;
+    return {
+        matched: true,
+        rows: options.map((o) => {
+            const text = quoteQueryValue(schema, o.value);
+            return {
+                id: `value:${slot.key}:${o.value}`,
+                text,
+                ...(o.hint === undefined ? {} : { hint: o.hint }),
+                icon: "value",
+                apply: slot.inBraces
+                    ? splice(query, slot.from, slot.to, text)
+                    : spliceThenSpace(query, slot.from, slot.to, text),
+            };
+        }),
+    };
+}
+/**
+ * The offered rows, in order: **the submit row is first** unless something
+ * is genuinely being completed.
+ *
+ * The reader is typing a query, not filling in a form. Putting a completion
+ * above the submit row means Enter submits something they did not ask for,
+ * and the only evidence that they wanted one is that what they typed
+ * actually prefixes something. Everything else — the full list of keys after
+ * a space, say — is still shown, because that is how the syntax is
+ * discovered, but it waits below.
+ *
+ * `limit` is spent here rather than inside each source, so that a source
+ * added later lands in the same budget without having to remember one. The
+ * matched rows spend it first — they are what the reader is completing — the
+ * submit row is never spent, and whatever is left goes to the rest.
+ *
+ * A source marked `yields` waits for both of those to be served and takes
+ * only the remainder. History is the one that does in todou (T-270): a
+ * completion or a jump answers the string being typed right now, history
+ * answers what was searched before, and the keys are the only place the
+ * syntax can be discovered — so history is what gives way when the panel is
+ * full.
+ */
+export function orderRows(results, submit, limit = 20) {
+    const band = (yields, matched) => results
+        .filter((r) => (r.yields ?? false) === yields && r.matched === matched)
+        .flatMap((r) => r.rows);
+    const firmMatched = band(false, true);
+    const firmRest = band(false, false);
+    const room = Math.max(0, limit - firmMatched.length - firmRest.length);
+    const softMatched = band(true, true).slice(0, room);
+    const softRest = band(true, false).slice(0, room - softMatched.length);
+    const matched = [...firmMatched, ...softMatched].slice(0, limit);
+    const rest = [...firmRest, ...softRest].slice(0, limit - matched.length);
+    return [...matched, submit, ...rest];
+}
+//# sourceMappingURL=completion.js.map

package/dist/completion.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"completion.js","sourceRoot":"","sources":["../src/completion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAwB,OAAO,EAAE,MAAM,eAAe,CAAC;AAC9D,OAAO,EAGL,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EAEd,YAAY,EACZ,UAAU,GACX,MAAM,kBAAkB,CAAC;AAiE1B,MAAM,KAAK,GAAgC,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AAKxE,SAAS,OAAO,CAAC,IAAe,EAAE,IAAY;IAC5C,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QACpC,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI;YAAE,SAAS;QAClC,IAAI,OAAO,CAAC,MAAM,KAAK,MAAM,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC;gBACT,KAAK,EAAE,OAAO,CAAC,KAAK;gBACpB,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC;aAClC,CAAC,CAAC;YACH,SAAS;QACX,CAAC;QACD,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACpE,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;YAC1C,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3D,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,eAAe,CAAC,KAAsB;IAC7C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;YAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;aACvC,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG;YAAE,KAAK,CAAC,GAAG,EAAE,CAAC;aACnC,IAAI,IAAI,CAAC,IAAI,KAAK,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC/C,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACrC,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC9B,CAAC;AAED,MAAM,MAAM,GAAG,CAAC,KAAsB,EAAE,IAAY,EAAU,EAAE,CAC9D,KAAK;KACF,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,CAAC;KAC9B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;KAClB,IAAI,CAAC,EAAE,CAAC,CAAC;AAEd;;;;GAIG;AACH,SAAS,eAAe,CAAC,IAAY,EAAE,KAAa;IAClD,MAAM,KAAK,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IACvD,OAAO,KAAK,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC;AAC1C,CAAC;AAED;;;;GAIG;AACH,SAAS,UAAU,CAAC,KAAa,EAAE,IAAY,EAAE,KAAa;IAC5D,MAAM,KAAK,GAAW,EAAE,CAAC;IACzB,IAAI,CAAC,GAAG,IAAI,CAAC;IACb,IAAI,UAAU,GAAG,IAAI,CAAC;IACtB,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,OAAO,CAAC,GAAG,KAAK,EAAE,CAAC;QACjB,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,CAAW,CAAC;QAC9B,IAAI,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC,KAAK,UAAU,IAAI,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAC3D,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;YACxC,IAAI,KAAK,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI,KAAK;gBAAE,OAAO,IAAI,CAAC;YAChD,KAAK,CAAC,IAAI,CAAC;gBACT,KAAK,EAAE,CAAC;gBACR,GAAG,EAAE,KAAK,GAAG,CAAC;gBACd,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;aAChC,CAAC,CAAC;YACH,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;YACd,SAAS;QACX,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QACzD,IAAI,EAAE,KAAK,GAAG;YAAE,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;aAC7B,IAAI,EAAE,KAAK,GAAG;YAAE,KAAK,CAAC,GAAG,EAAE,CAAC;aAC5B,IAAI,EAAE,KAAK,GAAG,EAAE,CAAC;YACpB,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;gBAAE,KAAK,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;;gBACjD,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1B,CAAC;QACD,CAAC,IAAI,CAAC,CAAC;IACT,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,gBAAgB,CACvB,MAA2B,EAC3B,KAAa,EACb,IAA4C,EAC5C,KAAa;IAEb,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IACnC,IAAI,KAAoB,CAAC;IACzB,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QAC/B,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACvE,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,IAAI,CAAC;QACpC,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAClC,IAAI,GAAG,IAAI,CAAC,QAAQ,KAAK,IAAI,CAAC;IAChC,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,UAAU,CAAC,KAAK,EAAE,UAAU,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAChC,MAAM,IAAI,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IACpC,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC/B,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACxD,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CACjC,MAA2B,EAC3B,KAA2B,EAC3B,KAAa,EACb,KAAa;IAEb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,KAAK,GAAG,IAAI,CAAC,GAAG;YAAE,SAAS;QACrD,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;YACnC,IAAI,KAAK,GAAG,UAAU;gBAAE,OAAO,IAAI,CAAC;YACpC,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;YAChD,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,IAAI,CAAC;YACpC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM;gBACzB,CAAC,CAAC,gBAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC;gBAC9C,CAAC,CAAC,IAAI,CAAC;YACT,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;gBACnB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;YAC1E,CAAC;YACD,oEAAoE;YACpE,MAAM,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,IAAI,CAAC,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC;YACvE,OAAO;gBACL,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,EAAE,EAAE,KAAK,IAAI,KAAK;gBACxB,EAAE,EAAE,EAAE,EAAE,GAAG,IAAI,KAAK;gBACpB,KAAK,EAAE,EAAE,EAAE,KAAK,IAAI,EAAE;gBACtB,IAAI;gBACJ,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,QAAQ,EAAE,KAAK;aAChB,CAAC;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC;YAC1C,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,IAAI,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;gBAAE,OAAO,IAAI,CAAC;YACxE,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;YACrC,OAAO;gBACL,IAAI,EAAE,KAAK;gBACX,IAAI,EAAE,IAAI,CAAC,KAAK;gBAChB,EAAE,EAAE,KAAK;gBACT,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;gBACrC,OAAO;aACR,CAAC;QACJ,CAAC;IACH,CAAC;IACD,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5E,CAAC;AAED,MAAM,WAAW,GAAG,kBAAkB,CAAC;AACvC,MAAM,cAAc,GAAG,sBAAsB,CAAC;AAE9C;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAA4B,EAC5B,eAAuB;IAEvB,MAAM,IAAI,GAAG,eAAe,CAAC;IAC7B,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO;YACL,IAAI,EAAE,SAAS;YACf,IAAI,EAAE,CAAC;YACP,EAAE,EAAE,IAAI,CAAC,MAAM;YACf,KAAK,EAAE,KAAK,CAAC,CAAC,CAAW;SAC1B,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC/B,MAAM,OAAO,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC,CAAC;IACvD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpE,MAAM,OAAO,GAAI,IAAI,CAAC,CAAC,CAAY,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;IAC1B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;IACvD,4EAA4E;IAC5E,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,IAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAe,CAAC,GAAG,GAAG,KAAK,EAAE,CAAC;QAChE,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACnC,CAAC;SAAM,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC;IACnC,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;IACrC,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,IACE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI;QACxB,QAAQ,KAAK,SAAS;QACtB,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAC3B,CAAC;QACD,KAAK,CAAC,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,GAAG,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;QACvE,IAAI,GAAG,IAAI,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAc,CAAC;IAEvC,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC;IACtB,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACvB,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QAC3C,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;YACzB,IAAI,GAAG,WAAW,CAAC;YACnB,KAAK,GAAG,MAAM,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YACnC,QAAQ,GAAG,IAAI,CAAC;QAClB,CAAC;IACH,CAAC;IACD,OAAO;QACL,IAAI,EAAE,UAAU;QAChB,IAAI;QACJ,EAAE,EAAE,KAAK;QACT,KAAK;QACL,IAAI,EAAE,IAAI,CAAC,KAAK;QAChB,OAAO,EAAE,OAAO,CAAC,IAAI;QACrB,KAAK;QACL,IAAI,EAAE,KAAK,KAAK,IAAI;QACpB,QAAQ,EAAE,IAAI,CAAC,QAAQ,KAAK,IAAI;QAChC,IAAI;QACJ,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CACxB,IAAe,EACf,QAAwB,EACxB,OAAgC;IAEhC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;IACvB,MAAM,QAAQ,GAAkB;QAC9B,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;QAC5C,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;KACxB,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IAC9B,IAAI,QAAQ,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC;IAC5C,IAAI,QAAQ,IAAI,QAAQ,EAAE,CAAC;QACzB,OAAO,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,aAAa,CAC3B,OAA+B,EAC/B,KAAa;IAEb,MAAM,KAAK,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC;IAClC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;AACxE,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,MAAM,CACpB,KAAa,EACb,KAAa,EACb,GAAW,EACX,IAAY;IAEZ,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC;QACtD,KAAK,EAAE,KAAK,GAAG,IAAI,CAAC,MAAM;KAC3B,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAa,EACb,KAAa,EACb,GAAW,EACX,IAAY;IAEZ,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IAChD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACjD,OAAO;QACL,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YACtB,CAAC,CAAC,OAAO,CAAC,KAAK;YACf,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,EAAE;QACvD,KAAK,EAAE,OAAO,CAAC,KAAK,GAAG,CAAC;KACzB,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAC3B,IAAmD,EACnD,KAAa;IAEb,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;AACnD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CACrB,MAA2B,EAC3B,KAAa,EACb,IAA2B;IAE3B,IAAI,IAAI,EAAE,IAAI,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACvC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IACvC,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC;QAAE,OAAO,KAAK,CAAC;IACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACtC,OAAO;QACL,OAAO,EAAE,KAAK,KAAK,EAAE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;QACxC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;YACrB,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC;YAC1C,OAAO;gBACL,EAAE,EAAE,OAAO,GAAG,EAAE;gBAChB,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG;gBACvB,GAAG,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;gBACvC,IAAI,EAAE,KAAc;gBACpB,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,GAAG,KAAK,GAAG,GAAG,GAAG,CAAC;aAC5D,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,SAAS,CACvB,MAA2B,EAC3B,KAAa,EACb,IAA2B,EAC3B,OAA+B;IAE/B,IAAI,IAAI,EAAE,IAAI,KAAK,OAAO;QAAE,OAAO,KAAK,CAAC;IACzC,OAAO;QACL,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACtB,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;YAC9C,OAAO;gBACL,EAAE,EAAE,SAAS,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,EAAE;gBAClC,IAAI;gBACJ,GAAG,CAAC,CAAC,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;gBACjD,IAAI,EAAE,OAAgB;gBACtB,KAAK,EAAE,IAAI,CAAC,QAAQ;oBAClB,CAAC,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;oBACzC,CAAC,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC;aACrD,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,SAAS,CACvB,OAAqC,EACrC,MAAW,EACX,KAAK,GAAG,EAAE;IAEV,MAAM,IAAI,GAAG,CAAC,MAAe,EAAE,OAAgB,EAAE,EAAE,CACjD,OAAO;SACJ,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,KAAK,CAAC,KAAK,MAAM,IAAI,CAAC,CAAC,OAAO,KAAK,OAAO,CAAC;SACtE,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAE5B,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IACtC,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACpC,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,GAAG,WAAW,CAAC,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvE,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IAEvE,MAAM,OAAO,GAAG,CAAC,GAAG,WAAW,EAAE,GAAG,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IACjE,MAAM,IAAI,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzE,OAAO,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC"}

package/dist/diagnostics.d.ts

@@ -0,0 +1,20 @@
+import type { CompiledQuerySchema, QueryPart } from "./query.ts";
+import { type ValueProviders } from "./values.ts";
+export type QueryDiagnostic = {
+    key: string;
+    value: string;
+    start: number;
+    end: number;
+    /** `"opne" is not a state (open, closed)` */
+    message: string;
+    suggestion: string | null;
+};
+/**
+ * What a query gets wrong that this package can tell without the app:
+ * enum values outside their set, `named` values an `options` provider does
+ * not hold, failed brace expansions and too many qualifiers. A value whose
+ * verdict is `unknown` is never reported; the app's server, which can see
+ * its own rows, stays the authority for those.
+ */
+export declare function diagnoseQuery(schema: CompiledQuerySchema, parts: readonly QueryPart[], providers?: ValueProviders): QueryDiagnostic[];
+//# sourceMappingURL=diagnostics.d.ts.map

package/dist/diagnostics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics.d.ts","sourceRoot":"","sources":["../src/diagnostics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAEjE,OAAO,EAGL,KAAK,cAAc,EAEpB,MAAM,aAAa,CAAC;AAErB,MAAM,MAAM,eAAe,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,6CAA6C;IAC7C,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B,CAAC;AAKF;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,mBAAmB,EAC3B,KAAK,EAAE,SAAS,SAAS,EAAE,EAC3B,SAAS,CAAC,EAAE,cAAc,GACzB,eAAe,EAAE,CAgDnB"}

package/dist/diagnostics.js

@@ -0,0 +1,63 @@
+import { didYouMean } from "./suggest.js";
+import { providerOf, suggestionCandidates, valueVerdict, } from "./values.js";
+const article = (word) => /^[aeiou]/i.test(word) ? `an ${word}` : `a ${word}`;
+/**
+ * What a query gets wrong that this package can tell without the app:
+ * enum values outside their set, `named` values an `options` provider does
+ * not hold, failed brace expansions and too many qualifiers. A value whose
+ * verdict is `unknown` is never reported; the app's server, which can see
+ * its own rows, stays the authority for those.
+ */
+export function diagnoseQuery(schema, parts, providers) {
+    const diagnostics = [];
+    let filters = 0;
+    for (const part of parts) {
+        if (part.kind !== "filter")
+            continue;
+        filters += 1;
+        if (schema.maxFilters !== undefined && filters === schema.maxFilters + 1) {
+            const count = parts.filter((p) => p.kind === "filter").length;
+            diagnostics.push({
+                key: part.key,
+                value: part.raw,
+                start: part.start,
+                end: part.end,
+                message: `${count} qualifiers (at most ${schema.maxFilters})`,
+                suggestion: null,
+            });
+        }
+        const spec = schema.qualifiers[part.key]?.value;
+        if (spec === undefined)
+            continue;
+        const provider = providerOf(spec, providers);
+        for (const value of part.values) {
+            const where = { key: part.key, start: value.start, end: value.end };
+            if (value.error !== undefined) {
+                diagnostics.push({
+                    ...where,
+                    value: value.value,
+                    message: `"${value.value}" ${value.error}`,
+                    suggestion: null,
+                });
+                continue;
+            }
+            for (const each of value.expanded) {
+                if (each === "")
+                    continue;
+                if (valueVerdict(spec, each, provider) !== "invalid")
+                    continue;
+                const message = spec.kind === "enum"
+                    ? `"${each}" is not ${article(part.key)} (${spec.values.join(", ")})`
+                    : `no ${part.key} named "${each}"`;
+                diagnostics.push({
+                    ...where,
+                    value: each,
+                    message,
+                    suggestion: didYouMean(each, suggestionCandidates(spec, provider)),
+                });
+            }
+        }
+    }
+    return diagnostics;
+}
+//# sourceMappingURL=diagnostics.js.map

package/dist/diagnostics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"diagnostics.js","sourceRoot":"","sources":["../src/diagnostics.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACL,UAAU,EACV,oBAAoB,EAEpB,YAAY,GACb,MAAM,aAAa,CAAC;AAYrB,MAAM,OAAO,GAAG,CAAC,IAAY,EAAU,EAAE,CACvC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;AAEtD;;;;;;GAMG;AACH,MAAM,UAAU,aAAa,CAC3B,MAA2B,EAC3B,KAA2B,EAC3B,SAA0B;IAE1B,MAAM,WAAW,GAAsB,EAAE,CAAC;IAC1C,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;YAAE,SAAS;QACrC,OAAO,IAAI,CAAC,CAAC;QACb,IAAI,MAAM,CAAC,UAAU,KAAK,SAAS,IAAI,OAAO,KAAK,MAAM,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;YACzE,MAAM,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,MAAM,CAAC;YAC9D,WAAW,CAAC,IAAI,CAAC;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,KAAK,EAAE,IAAI,CAAC,GAAG;gBACf,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,OAAO,EAAE,GAAG,KAAK,wBAAwB,MAAM,CAAC,UAAU,GAAG;gBAC7D,UAAU,EAAE,IAAI;aACjB,CAAC,CAAC;QACL,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;QAChD,IAAI,IAAI,KAAK,SAAS;YAAE,SAAS;QACjC,MAAM,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAC7C,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,GAAG,EAAE,CAAC;YACpE,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBAC9B,WAAW,CAAC,IAAI,CAAC;oBACf,GAAG,KAAK;oBACR,KAAK,EAAE,KAAK,CAAC,KAAK;oBAClB,OAAO,EAAE,IAAI,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,KAAK,EAAE;oBAC1C,UAAU,EAAE,IAAI;iBACjB,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YACD,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;gBAClC,IAAI,IAAI,KAAK,EAAE;oBAAE,SAAS;gBAC1B,IAAI,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,CAAC,KAAK,SAAS;oBAAE,SAAS;gBAC/D,MAAM,OAAO,GACX,IAAI,CAAC,IAAI,KAAK,MAAM;oBAClB,CAAC,CAAC,IAAI,IAAI,YAAY,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;oBACrE,CAAC,CAAC,MAAM,IAAI,CAAC,GAAG,WAAW,IAAI,GAAG,CAAC;gBACvC,WAAW,CAAC,IAAI,CAAC;oBACf,GAAG,KAAK;oBACR,KAAK,EAAE,IAAI;oBACX,OAAO;oBACP,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE,oBAAoB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;iBACnE,CAAC,CAAC;YACL,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,WAAW,CAAC;AACrB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { BRACE_LIMIT, type BraceExpansion, expandBraces, } from "./braces.ts";
+export { type ArgSpec, type ArgValue, type CommandDef, type CommandRegistry, commandLinesOf, createCommandRegistry, type ParsedDraft, parseCommandLines, type RecognizedLine, recognizeCommandLine, slugifyCommandName, summarizeCommands, } from "./commands.ts";
+export { type CompletionRow, type CompletionSlot, commandCompletionSlot, filterOptions, keyRows, orderRows, queryCompletionSlot, quoteArgument, type SourceResult, slotValues, splice, spliceThenSpace, type ValueSlot, valueRows, } from "./completion.ts";
+export { diagnoseQuery, type QueryDiagnostic } from "./diagnostics.ts";
+export { type CompiledQuerySchema, defineQuerySchema, parseQuery, type QualifierSpec, type QueryFilter, type QueryPart, type QuerySchema, type QueryValue, queryFilters, queryTerms, quoteQueryValue, } from "./query.ts";
+export { quoteShellWord, type ShellSegment, type ShellWord, segmentValue, shellWords, } from "./shell-words.ts";
+export { didYouMean } from "./suggest.ts";
+export { canonicalValue, providerOf, specialValue, type ValueOption, type ValueProvider, type ValueProviders, type ValueSpec, type ValueVerdict, valueVerdict, worstVerdict, } from "./values.ts";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,KAAK,cAAc,EACnB,YAAY,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EACL,KAAK,OAAO,EACZ,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,KAAK,eAAe,EACpB,cAAc,EACd,qBAAqB,EACrB,KAAK,WAAW,EAChB,iBAAiB,EACjB,KAAK,cAAc,EACnB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,qBAAqB,EACrB,aAAa,EACb,OAAO,EACP,SAAS,EACT,mBAAmB,EACnB,aAAa,EACb,KAAK,YAAY,EACjB,UAAU,EACV,MAAM,EACN,eAAe,EACf,KAAK,SAAS,EACd,SAAS,GACV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAE,KAAK,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EACL,KAAK,mBAAmB,EACxB,iBAAiB,EACjB,UAAU,EACV,KAAK,aAAa,EAClB,KAAK,WAAW,EAChB,KAAK,SAAS,EACd,KAAK,WAAW,EAChB,KAAK,UAAU,EACf,YAAY,EACZ,UAAU,EACV,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EACd,KAAK,YAAY,EACjB,KAAK,SAAS,EACd,YAAY,EACZ,UAAU,GACX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACL,cAAc,EACd,UAAU,EACV,YAAY,EACZ,KAAK,WAAW,EAChB,KAAK,aAAa,EAClB,KAAK,cAAc,EACnB,KAAK,SAAS,EACd,KAAK,YAAY,EACjB,YAAY,EACZ,YAAY,GACb,MAAM,aAAa,CAAC"}

package/dist/index.js

@@ -0,0 +1,9 @@
+export { BRACE_LIMIT, expandBraces, } from "./braces.js";
+export { commandLinesOf, createCommandRegistry, parseCommandLines, recognizeCommandLine, slugifyCommandName, summarizeCommands, } from "./commands.js";
+export { commandCompletionSlot, filterOptions, keyRows, orderRows, queryCompletionSlot, quoteArgument, slotValues, splice, spliceThenSpace, valueRows, } from "./completion.js";
+export { diagnoseQuery } from "./diagnostics.js";
+export { defineQuerySchema, parseQuery, queryFilters, queryTerms, quoteQueryValue, } from "./query.js";
+export { quoteShellWord, segmentValue, shellWords, } from "./shell-words.js";
+export { didYouMean } from "./suggest.js";
+export { canonicalValue, providerOf, specialValue, valueVerdict, worstVerdict, } from "./values.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EAEX,YAAY,GACb,MAAM,aAAa,CAAC;AACrB,OAAO,EAKL,cAAc,EACd,qBAAqB,EAErB,iBAAiB,EAEjB,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,GAClB,MAAM,eAAe,CAAC;AACvB,OAAO,EAGL,qBAAqB,EACrB,aAAa,EACb,OAAO,EACP,SAAS,EACT,mBAAmB,EACnB,aAAa,EAEb,UAAU,EACV,MAAM,EACN,eAAe,EAEf,SAAS,GACV,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,aAAa,EAAwB,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAEL,iBAAiB,EACjB,UAAU,EAMV,YAAY,EACZ,UAAU,EACV,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EACL,cAAc,EAGd,YAAY,EACZ,UAAU,GACX,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EACL,cAAc,EACd,UAAU,EACV,YAAY,EAMZ,YAAY,EACZ,YAAY,GACb,MAAM,aAAa,CAAC"}

package/dist/query.d.ts

@@ -0,0 +1,119 @@
+/**
+ * A search query grammar over a schema the app supplies. The app's server
+ * parses `q` and executes it (authoritative); its web box parses the same
+ * string to colour it and to place completions; a CLI parses it to re-quote
+ * the values that carry spaces. One string carries the whole query, so "the
+ * same query gives the same results in the CLI and on the web" holds
+ * structurally instead of being a discipline two implementations have to
+ * keep.
+ *
+ * Nothing here decides whether a `named` value exists: `label:kind:bug`
+ * parses the same in a project that has that label and in one that does
+ * not. Names are resolved by the caller, which keeps this module a pure
+ * function on either side of the wire.
+ */
+import type { ValueSpec } from "./values.ts";
+export type QualifierSpec = {
+    value: ValueSpec;
+    /** Other spellings of the key itself: `meta` for `metadata`. */
+    keyAliases?: readonly string[];
+    /** One-line inline reminder in the completion row: "open or closed". */
+    hint?: string;
+};
+export type QuerySchema<K extends string = string> = {
+    qualifiers: Readonly<Record<K, QualifierSpec>>;
+    /** How quotes and backslashes read. `"plain"` unless set. */
+    escapes?: "plain" | "shell";
+    /** Brace expansion inside qualifier values. Off unless set. */
+    braces?: boolean;
+    /** More qualifier expressions than this is a diagnostic. */
+    maxFilters?: number;
+};
+export type CompiledQuerySchema<K extends string = string> = {
+    readonly qualifiers: Readonly<Record<K, QualifierSpec>>;
+    /** Canonical keys, in declaration order. */
+    readonly keys: readonly K[];
+    /**
+     * Every spelling of a key, lowercase, canonical ones included, mapping to
+     * the canonical one. Completion offers only `keys`, so an alias is offered
+     * under its canonical spelling and still parses when typed.
+     */
+    readonly spellings: ReadonlyMap<string, K>;
+    readonly escapes: "plain" | "shell";
+    readonly braces: boolean;
+    readonly maxFilters: number | undefined;
+};
+/**
+ * Throws on a malformed table: these are programmer errors in static data,
+ * caught at module load rather than on some reader's query.
+ */
+export declare function defineQuerySchema<K extends string>(schema: QuerySchema<K>): CompiledQuerySchema<K>;
+export type QueryValue = {
+    start: number;
+    end: number;
+    /** The source slice, quotes included. */
+    raw: string;
+    /** What the value means, quotes removed. */
+    value: string;
+    /** `[value]` unless braces expanded it. */
+    expanded: string[];
+    /** Why brace expansion failed (over the limit). */
+    error?: string;
+};
+/**
+ * A span of the query string. Offsets are UTF-16 indices into the original
+ * `q`, so the colouring layer, the diagnostics and the completions all point
+ * at the same characters without re-scanning.
+ */
+export type QueryPart<K extends string = string> = {
+    kind: "space";
+    start: number;
+    end: number;
+} | {
+    kind: "text";
+    start: number;
+    end: number;
+    raw: string;
+    term: string;
+} | {
+    kind: "filter";
+    start: number;
+    end: number;
+    raw: string;
+    /** Canonical. */
+    key: K;
+    negated: boolean;
+    /** The key as typed, `-` and `:` excluded. */
+    keyStart: number;
+    keyEnd: number;
+    values: QueryValue[];
+};
+export type QueryFilter<K extends string = string> = {
+    key: K;
+    negated: boolean;
+    /** Unquoted, expanded and in source order; empty values never reach here. */
+    values: string[];
+};
+/**
+ * `q` split into spans that tile it completely — every character of the input
+ * belongs to exactly one part, which is what lets a mirror layer render the
+ * string by walking this list.
+ *
+ * Never throws: a half-typed query is the normal case for a search box, and
+ * every shape of input has a reading.
+ */
+export declare function parseQuery<K extends string>(schema: CompiledQuerySchema<K>, q: string): QueryPart<K>[];
+/** The free-text terms, in source order; an empty `""` contributes nothing. */
+export declare function queryTerms(parts: readonly QueryPart[]): string[];
+/**
+ * Brace expansions are flattened, so `label:area:{web,ui}` reaches a server
+ * as `label:area:web,area:ui`, which it already reads as an OR.
+ */
+export declare function queryFilters<K extends string>(parts: readonly QueryPart<K>[]): QueryFilter<K>[];
+/**
+ * A value spelled so it reads back as one value. Plain mode has no way to
+ * spell a quote inside a value — a bare one ends the value — so inner quotes
+ * are dropped rather than preserved.
+ */
+export declare function quoteQueryValue(schema: CompiledQuerySchema, value: string): string;
+//# sourceMappingURL=query.d.ts.map