@kvman/testkit 0.1.0

package/dist/check/timer-scan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"timer-scan.js","sourceRoot":"","sources":["../../src/check/timer-scan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAChE,OAAO,IAAI,MAAM,WAAW,CAAC;AAG7B,8GAA8G;AAC9G,+FAA+F;AAC/F,+GAA+G;AAE/G,MAAM,IAAI,GAAG;IACX,QAAQ,EAAE,6EAA6E;IACvF,OAAO,EAAE,gGAAgG;CAC1G,CAAC;AAEF,SAAS,UAAU,CAAC,MAAc,EAAE,KAAa;IAC/C,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;QACxC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;IAC1C,CAAC;IACD,IAAI,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;QAC5C,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,uBAAuB,CAAC,MAAc;IACpD,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,OAAO,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QAC7B,MAAM,GAAG,GAAG,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QACtC,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACjB,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;YAC1D,KAAK,GAAG,GAAG,CAAC;YACZ,SAAS;QACX,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;QACjC,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,GAAG,EAAE,CAAC;YACjD,IAAI,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC;YACtB,OAAO,KAAK,GAAG,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI;gBAAE,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAChG,MAAM,IAAI,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAC7G,KAAK,GAAG,KAAK,GAAG,CAAC,CAAC;YAClB,SAAS;QACX,CAAC;QACD,MAAM,IAAI,IAAI,CAAC;QACf,KAAK,IAAI,CAAC,CAAC;IACb,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,EAAU;IAC9C,IAAI,KAAK,GAAG,EAAE,CAAC;IACf,OAAO,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;QAAE,KAAK,IAAI,CAAC,CAAC;IACvE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;AAC3C,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY,EAAE,EAAU;IACxC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7C,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC;AAChF,CAAC;AAED,MAAM,UAAU,UAAU,CAAC,IAAY,EAAE,MAAc;IACrD,MAAM,IAAI,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,QAAQ,GAAqB,EAAE,CAAC;IACtC,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,+BAA+B,CAAC,EAAE,CAAC;QACnE,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC;QACzC,IAAI,CAAC,QAAQ,IAAI,cAAc,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC;YAAE,SAAS;QACjF,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,CAAC;QACrD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,YAAY,IAAI,2CAA2C,CAAC,CAAC,CAAC,yBAAyB,IAAI,wBAAwB,CAAC;QAC/I,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;IAC3I,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,WAAW,CAAC,MAAc,EAAE,QAAgB;IACnD,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/H,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,KAAK,CAAC,WAAW,EAAE;YAAE,OAAO,KAAK,CAAC,IAAI,KAAK,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAChG,OAAO,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACnD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,qFAAqF;AACrF,MAAM,UAAU,iBAAiB,CAAC,MAAc;IAC9C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAAE,OAAO,EAAE,CAAC;IACrD,OAAO,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;AACvH,CAAC"}

package/dist/check/ui-keys.d.ts

@@ -0,0 +1,3 @@
+export declare function viewKeys(view: unknown): string[];
+export declare function uiKeys(answer: unknown): string[];
+//# sourceMappingURL=ui-keys.d.ts.map

package/dist/check/ui-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-keys.d.ts","sourceRoot":"","sources":["../../src/check/ui-keys.ts"],"names":[],"mappings":"AAyCA,wBAAgB,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,EAAE,CAYhD;AAED,wBAAgB,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,EAAE,CAShD"}

package/dist/check/ui-keys.js

@@ -0,0 +1,58 @@
+// The translation keys a `<namespace>.ui.get` answer uses (plan 06 §6.3–6.4): page, nav, and panel titles, status
+// texts, and every text of a view tree (headings, texts, translated Markdown, card titles, columns and their badges,
+// empty texts, buttons and their confirms, links, form submits, and toasts).
+function isObject(value) {
+    return typeof value === 'object' && value !== null && !Array.isArray(value);
+}
+function objects(value) {
+    return Array.isArray(value) ? value.filter(isObject) : [];
+}
+function strings(object, fields) {
+    return fields.flatMap((field) => {
+        const value = object[field];
+        return typeof value === 'string' ? [value] : [];
+    });
+}
+const textFields = {
+    heading: ['text'],
+    text: ['text'],
+    markdown: ['text'],
+    card: ['title'],
+    link: ['text'],
+    button: ['text', 'confirm'],
+    form: ['submit'],
+    table: ['empty'],
+    list: ['empty'],
+};
+function columnKeys(columns) {
+    return objects(columns).flatMap((column) => [...strings(column, ['title']), ...(isObject(column['badges']) ? Object.values(column['badges']).filter(isObject).flatMap((badge) => strings(badge, ['text'])) : [])]);
+}
+function thenKeys(then) {
+    return isObject(then) ? strings(then, ['toast']) : [];
+}
+export function viewKeys(view) {
+    if (!isObject(view))
+        return [];
+    const type = typeof view['type'] === 'string' ? view['type'] : '';
+    return [
+        ...strings(view, textFields[type] ?? []),
+        ...thenKeys(view['then']),
+        ...columnKeys(view['columns']),
+        ...columnKeys(view['fields']),
+        ...objects(view['rowActions']).flatMap(viewKeys),
+        ...objects(view['children']).flatMap(viewKeys),
+        ...viewKeys(view['item']),
+    ];
+}
+export function uiKeys(answer) {
+    if (!isObject(answer))
+        return [];
+    return [
+        ...objects(answer['pages']).flatMap((page) => [...strings(page, ['title']), ...viewKeys(page['view'])]),
+        ...objects(answer['nav']).flatMap((item) => strings(item, ['title'])),
+        ...objects(answer['panels']).flatMap((panel) => [...strings(panel, ['title']), ...viewKeys(panel['view'])]),
+        ...objects(answer['status']).flatMap((item) => strings(item, ['text'])),
+        ...viewKeys(answer['configuration']),
+    ];
+}
+//# sourceMappingURL=ui-keys.js.map

package/dist/check/ui-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ui-keys.js","sourceRoot":"","sources":["../../src/check/ui-keys.ts"],"names":[],"mappings":"AAAA,kHAAkH;AAClH,qHAAqH;AACrH,6EAA6E;AAI7E,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,OAAO,CAAC,KAAc;IAC7B,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC5D,CAAC;AAED,SAAS,OAAO,CAAC,MAAkB,EAAE,MAAyB;IAC5D,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;QAC9B,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAClD,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,GAAgD;IAC9D,OAAO,EAAE,CAAC,MAAM,CAAC;IACjB,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,IAAI,EAAE,CAAC,OAAO,CAAC;IACf,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,MAAM,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,IAAI,EAAE,CAAC,QAAQ,CAAC;IAChB,KAAK,EAAE,CAAC,OAAO,CAAC;IAChB,IAAI,EAAE,CAAC,OAAO,CAAC;CAChB,CAAC;AAEF,SAAS,UAAU,CAAC,OAAgB;IAClC,OAAO,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACrN,CAAC;AAED,SAAS,QAAQ,CAAC,IAAa;IAC7B,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,IAAa;IACpC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAAE,OAAO,EAAE,CAAC;IAC/B,MAAM,IAAI,GAAG,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAClE,OAAO;QACL,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACxC,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACzB,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,GAAG,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,GAAG,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QAChD,GAAG,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;QAC9C,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;KAC1B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAe;IACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,OAAO;QACL,GAAG,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACvG,GAAG,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;QACrE,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,OAAO,CAAC,CAAC,EAAE,GAAG,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QAC3G,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,GAAG,QAAQ,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;KACrC,CAAC;AACJ,CAAC"}

package/dist/check-bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=check-bin.d.ts.map

package/dist/check-bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-bin.d.ts","sourceRoot":"","sources":["../src/check-bin.ts"],"names":[],"mappings":""}

package/dist/check-bin.js

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+import { checkExtension } from "./check/check-extension.js";
+import { jsonFindings, readableFindings } from "./check/check-output.js";
+// The `kvman-check` bin (plan 10, ADR 0009, 116): run in an extension project, as its `npm run check`. It exits 1 when
+// it finds an error and 0 when it finds only warnings.
+const options = process.argv.slice(2);
+const unknown = options.filter((option) => option !== '--json');
+if (unknown.length > 0) {
+    process.stderr.write(`kvman-check: unknown option ${unknown.join(' ')}; the only option is --json.\n`);
+    process.exitCode = 1;
+}
+else {
+    const findings = await checkExtension(process.cwd());
+    process.stdout.write(`${options.includes('--json') ? jsonFindings(findings) : readableFindings(findings)}\n`);
+    process.exitCode = findings.some((finding) => !finding.warning) ? 1 : 0;
+}
+//# sourceMappingURL=check-bin.js.map

package/dist/check-bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-bin.js","sourceRoot":"","sources":["../src/check-bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEzE,uHAAuH;AACvH,uDAAuD;AAEvD,MAAM,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACtC,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC;AAChE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;IACvB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;IACvG,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC;KAAM,CAAC;IACN,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9G,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1E,CAAC"}

package/dist/docs/built-in-guides.d.ts

@@ -0,0 +1,12 @@
+/** A built-in guide: `extension` is always `"kvman"`. */
+export type BuiltInGuide = {
+    extension: 'kvman';
+    topic: string;
+    title: string;
+    markdown: string;
+};
+/** The three built-in guides, sorted by topic. */
+export declare function listBuiltInGuides(): BuiltInGuide[];
+/** The built-in guide on a topic, or `undefined` for any other topic. */
+export declare function readBuiltInGuide(topic: string): BuiltInGuide | undefined;
+//# sourceMappingURL=built-in-guides.d.ts.map

package/dist/docs/built-in-guides.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"built-in-guides.d.ts","sourceRoot":"","sources":["../../src/docs/built-in-guides.ts"],"names":[],"mappings":"AAKA,yDAAyD;AACzD,MAAM,MAAM,YAAY,GAAG;IAAE,SAAS,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAclG,kDAAkD;AAClD,wBAAgB,iBAAiB,IAAI,YAAY,EAAE,CAElD;AAED,yEAAyE;AACzE,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAGxE"}

package/dist/docs/built-in-guides.js

@@ -0,0 +1,20 @@
+import { readFileSync } from 'node:fs';
+const builtInTopics = ['i18n', 'presets', 'sdk'];
+function titleOf(topic, markdown) {
+    const first = markdown.split('\n', 1)[0];
+    return first !== undefined && first.startsWith('# ') ? first.slice(2) : topic;
+}
+function readGuide(topic) {
+    const markdown = readFileSync(new URL(`../../docs/${topic}.md`, import.meta.url), 'utf8');
+    return { extension: 'kvman', topic, title: titleOf(topic, markdown), markdown };
+}
+/** The three built-in guides, sorted by topic. */
+export function listBuiltInGuides() {
+    return builtInTopics.map((topic) => readGuide(topic));
+}
+/** The built-in guide on a topic, or `undefined` for any other topic. */
+export function readBuiltInGuide(topic) {
+    const known = builtInTopics.includes(topic);
+    return known ? readGuide(topic) : undefined;
+}
+//# sourceMappingURL=built-in-guides.js.map

package/dist/docs/built-in-guides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"built-in-guides.js","sourceRoot":"","sources":["../../src/docs/built-in-guides.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAQvC,MAAM,aAAa,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,KAAK,CAAU,CAAC;AAE1D,SAAS,OAAO,CAAC,KAAa,EAAE,QAAgB;IAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACzC,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;AAChF,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,GAAG,CAAC,cAAc,KAAK,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1F,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC;AAClF,CAAC;AAED,kDAAkD;AAClD,MAAM,UAAU,iBAAiB;IAC/B,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,yEAAyE;AACzE,MAAM,UAAU,gBAAgB,CAAC,KAAa;IAC5C,MAAM,KAAK,GAAI,aAAmC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IACnE,OAAO,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AAC9C,CAAC"}

package/dist/docs/docs-bin.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=docs-bin.d.ts.map

package/dist/docs/docs-bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-bin.d.ts","sourceRoot":"","sources":["../../src/docs/docs-bin.ts"],"names":[],"mappings":""}

package/dist/docs/docs-bin.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+import { parseArgs } from 'node:util';
+import { BinFailure, printFailure } from "../bin/bin-failure.js";
+import { listDocsPages } from "./docs-list.js";
+import { readDocsPage } from "./docs-get.js";
+import { findRunningKvman } from "../running/running-kvman.js";
+// The `kvman-docs` bin (plan 09 §9.5, plan 10, ADR 0010, 17): reads the docs of the extensions a running kvman has
+// loaded over HTTP, plus the three built-in guides with no kvman running. With `--json` it prints the data as one
+// JSON line.
+const usage = 'Usage: kvman-docs list [--json] [--home <dir>] [--url <url>]\nUsage: kvman-docs get <extension> <topic> [--json] [--home <dir>] [--url <url>]';
+function parseOptions(argv) {
+    let parsed;
+    try {
+        parsed = parseArgs({
+            args: argv,
+            allowPositionals: true,
+            options: {
+                json: { type: 'boolean', default: false },
+                home: { type: 'string' },
+                url: { type: 'string' },
+            },
+        });
+    }
+    catch (error) {
+        const reason = error instanceof Error ? error.message : String(error);
+        throw new BinFailure('VALIDATION_FAILED', `${reason} ${usage}`);
+    }
+    const flags = {
+        json: parsed.values.json ?? false,
+        home: typeof parsed.values.home === 'string' ? parsed.values.home : undefined,
+        url: typeof parsed.values.url === 'string' ? parsed.values.url : undefined,
+    };
+    const [subcommand, ...rest] = parsed.positionals;
+    if (subcommand === 'list' && rest.length === 0)
+        return { kind: 'list', ...flags };
+    if (subcommand === 'get' && rest.length === 2 && rest[0] !== undefined && rest[1] !== undefined) {
+        return { kind: 'get', extension: rest[0], topic: rest[1], ...flags };
+    }
+    if (subcommand === undefined)
+        throw new BinFailure('VALIDATION_FAILED', `A subcommand is required. ${usage}`);
+    if (subcommand !== 'list' && subcommand !== 'get')
+        throw new BinFailure('VALIDATION_FAILED', `Unknown subcommand ${JSON.stringify(subcommand)}; give list or get. ${usage}`);
+    if (subcommand === 'list')
+        throw new BinFailure('VALIDATION_FAILED', `list takes no arguments. ${usage}`);
+    throw new BinFailure('VALIDATION_FAILED', `get takes <extension> and <topic>. ${usage}`);
+}
+function readableListing(listing) {
+    const lines = [];
+    let current;
+    for (const page of listing.pages) {
+        if (page.extension !== current) {
+            current = page.extension;
+            lines.push(current);
+        }
+        lines.push(`  ${page.topic}: ${page.title}`);
+    }
+    if (listing.problems.length > 0) {
+        lines.push('Problems:');
+        for (const problem of listing.problems)
+            lines.push(`${problem.extension}: ${problem.problem.message}`);
+    }
+    return `${lines.join('\n')}\n`;
+}
+const json = process.argv.includes('--json');
+try {
+    const command = parseOptions(process.argv.slice(2));
+    const locate = {};
+    if (command.home !== undefined)
+        locate.home = command.home;
+    if (command.url !== undefined)
+        locate.url = command.url;
+    const running = findRunningKvman(locate);
+    if (command.kind === 'list') {
+        const listing = await listDocsPages(running);
+        if (command.json) {
+            process.stdout.write(`${JSON.stringify({ pages: listing.pages, problems: listing.problems })}\n`);
+        }
+        else {
+            process.stdout.write(readableListing(listing));
+        }
+        if (!listing.running)
+            process.stderr.write("kvman isn't running; start it to read the extensions' docs.\n");
+    }
+    else {
+        const page = await readDocsPage(running, command.extension, command.topic);
+        if (command.json) {
+            process.stdout.write(`${JSON.stringify({ extension: page.extension, topic: page.topic, title: page.title, markdown: page.markdown })}\n`);
+        }
+        else {
+            process.stdout.write(`${page.markdown}\n`);
+        }
+    }
+}
+catch (error) {
+    printFailure(error, json);
+    process.exitCode = 1;
+}
+//# sourceMappingURL=docs-bin.js.map

package/dist/docs/docs-bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-bin.js","sourceRoot":"","sources":["../../src/docs/docs-bin.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EAAE,aAAa,EAAoB,MAAM,gBAAgB,CAAC;AACjE,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE/D,mHAAmH;AACnH,kHAAkH;AAClH,aAAa;AAEb,MAAM,KAAK,GAAG,+IAA+I,CAAC;AAM9J,SAAS,YAAY,CAAC,IAAc;IAClC,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,SAAS,CAAC;YACjB,IAAI,EAAE,IAAI;YACV,gBAAgB,EAAE,IAAI;YACtB,OAAO,EAAE;gBACP,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;gBACzC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;gBACxB,GAAG,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;aACxB;SACF,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACtE,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC,CAAC;IAClE,CAAC;IACD,MAAM,KAAK,GAAc;QACvB,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,IAAI,KAAK;QACjC,IAAI,EAAE,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS;QAC7E,GAAG,EAAE,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS;KAC3E,CAAC;IACF,MAAM,CAAC,UAAU,EAAE,GAAG,IAAI,CAAC,GAAG,MAAM,CAAC,WAAW,CAAC;IACjD,IAAI,UAAU,KAAK,MAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IAClF,IAAI,UAAU,KAAK,KAAK,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;QAChG,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,CAAC;IACvE,CAAC;IACD,IAAI,UAAU,KAAK,SAAS;QAAE,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,6BAA6B,KAAK,EAAE,CAAC,CAAC;IAC9G,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,KAAK;QAAE,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,sBAAsB,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,uBAAuB,KAAK,EAAE,CAAC,CAAC;IAC7K,IAAI,UAAU,KAAK,MAAM;QAAE,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,4BAA4B,KAAK,EAAE,CAAC,CAAC;IAC1G,MAAM,IAAI,UAAU,CAAC,mBAAmB,EAAE,sCAAsC,KAAK,EAAE,CAAC,CAAC;AAC3F,CAAC;AAED,SAAS,eAAe,CAAC,OAAoB;IAC3C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,OAA2B,CAAC;IAChC,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;YAC/B,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC;YACzB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtB,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QACxB,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,SAAS,KAAK,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IACD,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AACjC,CAAC;AAED,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7C,IAAI,CAAC;IACH,MAAM,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACpD,MAAM,MAAM,GAAoC,EAAE,CAAC;IACnD,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3D,IAAI,OAAO,CAAC,GAAG,KAAK,SAAS;QAAE,MAAM,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IACxD,MAAM,OAAO,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IACzC,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;QAC7C,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;QACpG,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,OAAO;YAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,+DAA+D,CAAC,CAAC;IAC9G,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAC3E,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;QAC5I,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;AACH,CAAC;AAAC,OAAO,KAAK,EAAE,CAAC;IACf,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;IAC1B,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC"}

package/dist/docs/docs-get.d.ts

@@ -0,0 +1,11 @@
+import { type RunningKvman } from '../running/running-kvman.ts';
+/** A docs page. */
+export type DocsPage = {
+    extension: string;
+    topic: string;
+    title: string;
+    markdown: string;
+};
+/** Reads one docs page. */
+export declare function readDocsPage(running: RunningKvman | undefined, extension: string, topic: string): Promise<DocsPage>;
+//# sourceMappingURL=docs-get.d.ts.map

package/dist/docs/docs-get.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-get.d.ts","sourceRoot":"","sources":["../../src/docs/docs-get.ts"],"names":[],"mappings":"AAGA,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAMvF,mBAAmB;AACnB,MAAM,MAAM,QAAQ,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAS7F,2BAA2B;AAC3B,wBAAsB,YAAY,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiCzH"}

package/dist/docs/docs-get.js

@@ -0,0 +1,54 @@
+import { ProblemError, extensionInfoSchema, z } from '@kvman/sdk';
+import { readBuiltInGuide } from "./built-in-guides.js";
+import { callQuery } from "../running/call-query.js";
+import { KvmanUnreachableError } from "../running/running-kvman.js";
+import { BinFailure } from "../bin/bin-failure.js";
+const docsPageSchema = z.strictObject({ topic: z.string(), title: z.string(), markdown: z.string() });
+const extensionsListSchema = z.array(extensionInfoSchema);
+function notRunning(extension) {
+    return new BinFailure('NOT_RUNNING', `kvman isn't running; start it to read ${extension}'s docs.`);
+}
+/** Reads one docs page. */
+export async function readDocsPage(running, extension, topic) {
+    if (extension === 'kvman') {
+        const guide = readBuiltInGuide(topic);
+        if (guide === undefined)
+            throw new BinFailure('NOT_FOUND', `kvman has no guide on ${topic}.`);
+        return { extension: guide.extension, topic: guide.topic, title: guide.title, markdown: guide.markdown };
+    }
+    if (running === undefined)
+        throw notRunning(extension);
+    let extensions;
+    try {
+        extensions = await callQuery(running, 'kernel.extensions.list', {}, extensionsListSchema);
+    }
+    catch (error) {
+        if (error instanceof KvmanUnreachableError)
+            throw notRunning(extension);
+        throw error;
+    }
+    const documented = extensions.find((entry) => entry.name === extension);
+    if (documented === undefined)
+        throw new BinFailure('NOT_FOUND', `${extension} isn't loaded or doesn't serve docs.`);
+    const servesDocs = [`${documented.namespace}.docs.list`, `${documented.namespace}.docs.get`].every((wanted) => documented.queries.some((query) => query.name === wanted && query.public));
+    if (!servesDocs)
+        throw new BinFailure('NOT_FOUND', `${extension} isn't loaded or doesn't serve docs.`);
+    const namespace = documented.namespace;
+    try {
+        const page = await callQuery(running, `${namespace}.docs.get`, { topic }, docsPageSchema);
+        return { extension, topic: page.topic, title: page.title, markdown: page.markdown };
+    }
+    catch (error) {
+        if (error instanceof KvmanUnreachableError)
+            throw notRunning(extension);
+        if (error instanceof ProblemError && (error.problem.code === 'NOT_FOUND' || error.problem.code.endsWith('/NOT_FOUND'))) {
+            throw new BinFailure('NOT_FOUND', error.problem.message);
+        }
+        if (error instanceof ProblemError)
+            throw new Error(`${error.problem.code}: ${error.problem.message}`);
+        if (error instanceof z.ZodError)
+            throw new Error(`${namespace}.docs.get answered something other than a page.`);
+        throw error;
+    }
+}
+//# sourceMappingURL=docs-get.js.map

package/dist/docs/docs-get.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-get.js","sourceRoot":"","sources":["../../src/docs/docs-get.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,CAAC,EAAE,MAAM,YAAY,CAAC;AAClE,OAAO,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAqB,MAAM,6BAA6B,CAAC;AACvF,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AAQnD,MAAM,cAAc,GAAG,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACtG,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAE1D,SAAS,UAAU,CAAC,SAAiB;IACnC,OAAO,IAAI,UAAU,CAAC,aAAa,EAAE,yCAAyC,SAAS,UAAU,CAAC,CAAC;AACrG,CAAC;AAED,2BAA2B;AAC3B,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,OAAiC,EAAE,SAAiB,EAAE,KAAa;IACpG,IAAI,SAAS,KAAK,OAAO,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;QACtC,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,UAAU,CAAC,WAAW,EAAE,yBAAyB,KAAK,GAAG,CAAC,CAAC;QAC9F,OAAO,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC;IAC1G,CAAC;IACD,IAAI,OAAO,KAAK,SAAS;QAAE,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC;IACvD,IAAI,UAAiD,CAAC;IACtD,IAAI,CAAC;QACH,UAAU,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,oBAAoB,CAAC,CAAC;IAC5F,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,qBAAqB;YAAE,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC;QACxE,MAAM,KAAK,CAAC;IACd,CAAC;IACD,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IACxE,IAAI,UAAU,KAAK,SAAS;QAAE,MAAM,IAAI,UAAU,CAAC,WAAW,EAAE,GAAG,SAAS,sCAAsC,CAAC,CAAC;IACpH,MAAM,UAAU,GAAG,CAAC,GAAG,UAAU,CAAC,SAAS,YAAY,EAAE,GAAG,UAAU,CAAC,SAAS,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAC5G,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAC1E,CAAC;IACF,IAAI,CAAC,UAAU;QAAE,MAAM,IAAI,UAAU,CAAC,WAAW,EAAE,GAAG,SAAS,sCAAsC,CAAC,CAAC;IACvG,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC;IACvC,IAAI,CAAC;QACH,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,GAAG,SAAS,WAAW,EAAE,EAAE,KAAK,EAAE,EAAE,cAAc,CAAC,CAAC;QAC1F,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;IACtF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,qBAAqB;YAAE,MAAM,UAAU,CAAC,SAAS,CAAC,CAAC;QACxE,IAAI,KAAK,YAAY,YAAY,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,EAAE,CAAC;YACvH,MAAM,IAAI,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAC3D,CAAC;QACD,IAAI,KAAK,YAAY,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;QACtG,IAAI,KAAK,YAAY,CAAC,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,GAAG,SAAS,iDAAiD,CAAC,CAAC;QAChH,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/docs/docs-list.d.ts

@@ -0,0 +1,22 @@
+import { type Problem } from '@kvman/sdk';
+import { type RunningKvman } from '../running/running-kvman.ts';
+/** A docs page in the listing. */
+export type DocsListPage = {
+    extension: string;
+    topic: string;
+    title: string;
+};
+/** An extension whose docs failed, with its Problem. */
+export type DocsListProblem = {
+    extension: string;
+    problem: Problem;
+};
+/** The listing: the pages, the per-extension problems, and whether a kvman answered. */
+export type DocsListing = {
+    pages: DocsListPage[];
+    problems: DocsListProblem[];
+    running: boolean;
+};
+/** Lists the docs pages, reading only the built-in guides when no kvman runs. */
+export declare function listDocsPages(running: RunningKvman | undefined): Promise<DocsListing>;
+//# sourceMappingURL=docs-list.d.ts.map

package/dist/docs/docs-list.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-list.d.ts","sourceRoot":"","sources":["../../src/docs/docs-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwC,KAAK,OAAO,EAAE,MAAM,YAAY,CAAC;AAGhF,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAKvF,kCAAkC;AAClC,MAAM,MAAM,YAAY,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE/E,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtE,wFAAwF;AACxF,MAAM,MAAM,WAAW,GAAG;IAAE,KAAK,EAAE,YAAY,EAAE,CAAC;IAAC,QAAQ,EAAE,eAAe,EAAE,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC;AAcnG,iFAAiF;AACjF,wBAAsB,aAAa,CAAC,OAAO,EAAE,YAAY,GAAG,SAAS,GAAG,OAAO,CAAC,WAAW,CAAC,CA6B3F"}

package/dist/docs/docs-list.js

@@ -0,0 +1,51 @@
+import { ProblemError, extensionInfoSchema, z } from '@kvman/sdk';
+import { listBuiltInGuides } from "./built-in-guides.js";
+import { callQuery } from "../running/call-query.js";
+import { KvmanUnreachableError } from "../running/running-kvman.js";
+const docsListSchema = z.array(z.strictObject({ topic: z.string(), title: z.string() }));
+const extensionsListSchema = z.array(extensionInfoSchema);
+function documented(extensions) {
+    return extensions
+        .filter((extension) => [`${extension.namespace}.docs.list`, `${extension.namespace}.docs.get`].every((wanted) => extension.queries.some((query) => query.name === wanted && query.public)))
+        .map((extension) => ({ name: extension.name, namespace: extension.namespace }))
+        .sort((left, right) => (left.name < right.name ? -1 : left.name > right.name ? 1 : 0));
+}
+/** Lists the docs pages, reading only the built-in guides when no kvman runs. */
+export async function listDocsPages(running) {
+    const builtIn = listBuiltInGuides().map((guide) => ({ extension: guide.extension, topic: guide.topic, title: guide.title }));
+    if (running === undefined)
+        return { pages: builtIn, problems: [], running: false };
+    let extensions;
+    try {
+        extensions = await callQuery(running, 'kernel.extensions.list', {}, extensionsListSchema);
+    }
+    catch (error) {
+        if (error instanceof KvmanUnreachableError)
+            return { pages: builtIn, problems: [], running: false };
+        throw error;
+    }
+    const pages = [...builtIn];
+    const problems = [];
+    for (const extension of documented(extensions)) {
+        let entries;
+        try {
+            entries = await callQuery(running, `${extension.namespace}.docs.list`, {}, docsListSchema);
+        }
+        catch (error) {
+            if (error instanceof KvmanUnreachableError)
+                return { pages: builtIn, problems: [], running: false };
+            if (error instanceof ProblemError) {
+                problems.push({ extension: extension.name, problem: error.problem });
+                continue;
+            }
+            if (!(error instanceof z.ZodError))
+                throw error;
+            problems.push({ extension: extension.name, problem: { code: 'VALIDATION_FAILED', message: `${extension.namespace}.docs.list answered something other than a list of pages.` } });
+            continue;
+        }
+        for (const entry of entries)
+            pages.push({ extension: extension.name, topic: entry.topic, title: entry.title });
+    }
+    return { pages, problems, running: true };
+}
+//# sourceMappingURL=docs-list.js.map

package/dist/docs/docs-list.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-list.js","sourceRoot":"","sources":["../../src/docs/docs-list.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,CAAC,EAAgB,MAAM,YAAY,CAAC;AAChF,OAAO,EAAE,iBAAiB,EAAE,MAAM,sBAAsB,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAqB,MAAM,6BAA6B,CAAC;AAcvF,MAAM,cAAc,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,YAAY,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;AACzF,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;AAI1D,SAAS,UAAU,CAAC,UAAiD;IACnE,OAAO,UAAU;SACd,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,SAAS,YAAY,EAAE,GAAG,SAAS,CAAC,SAAS,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;SAC1L,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,CAAC,CAAC;SAC9E,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3F,CAAC;AAED,iFAAiF;AACjF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,OAAiC;IACnE,MAAM,OAAO,GAAmB,iBAAiB,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;IAC7I,IAAI,OAAO,KAAK,SAAS;QAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;IACnF,IAAI,UAAiD,CAAC;IACtD,IAAI,CAAC;QACH,UAAU,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,oBAAoB,CAAC,CAAC;IAC5F,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,qBAAqB;YAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QACpG,MAAM,KAAK,CAAC;IACd,CAAC;IACD,MAAM,KAAK,GAAmB,CAAC,GAAG,OAAO,CAAC,CAAC;IAC3C,MAAM,QAAQ,GAAsB,EAAE,CAAC;IACvC,KAAK,MAAM,SAAS,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;QAC/C,IAAI,OAAwC,CAAC;QAC7C,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,SAAS,CAAC,OAAO,EAAE,GAAG,SAAS,CAAC,SAAS,YAAY,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;QAC7F,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,qBAAqB;gBAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;YACpG,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;gBAClC,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;gBACrE,SAAS;YACX,CAAC;YACD,IAAI,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC,QAAQ,CAAC;gBAAE,MAAM,KAAK,CAAC;YAChD,QAAQ,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC,SAAS,2DAA2D,EAAE,EAAE,CAAC,CAAC;YACjL,SAAS;QACX,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,OAAO;YAAE,KAAK,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;IACjH,CAAC;IACD,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;AAC5C,CAAC"}

package/dist/fake-clock.d.ts

@@ -0,0 +1,16 @@
+import type { Clock } from '@kvman/kernel';
+/** The test kernel's clock: it moves only when a test advances it. */
+export type TestClock = {
+    /** The current fake time, in milliseconds since the epoch. */
+    now(): number;
+    /** Moves the time forward, firing due retries and schedules, and resolves once no job is running or due. */
+    advance(milliseconds: number): Promise<void>;
+};
+export type FakeClock = {
+    kernelClock: Clock;
+    testClock: TestClock;
+    settleWith(settle: () => Promise<void>): void;
+    moveWhileStopped(milliseconds: number): void;
+};
+export declare function createFakeClock(start: number): FakeClock;
+//# sourceMappingURL=fake-clock.d.ts.map

package/dist/fake-clock.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fake-clock.d.ts","sourceRoot":"","sources":["../src/fake-clock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C,sEAAsE;AACtE,MAAM,MAAM,SAAS,GAAG;IACtB,8DAA8D;IAC9D,GAAG,IAAI,MAAM,CAAC;IACd,4GAA4G;IAC5G,OAAO,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC9C,CAAC;AAIF,MAAM,MAAM,SAAS,GAAG;IAAE,WAAW,EAAE,KAAK,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC;IAAC,UAAU,CAAC,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAAC,gBAAgB,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAIlK,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CA4CxD"}

package/dist/fake-clock.js

@@ -0,0 +1,47 @@
+// Each advance fires the due timers one by one, letting the kernel settle after each, so work that a timer starts and
+// the timers that work sets (a retry's backoff, a cron's next run) are seen within the same advance (ADR 0009, 15).
+export function createFakeClock(start) {
+    let time = start;
+    let order = 0;
+    let timers = [];
+    let settle = async () => undefined;
+    const nextDue = (until) => timers.filter((timer) => timer.at <= until).sort((left, right) => left.at - right.at || left.order - right.order)[0];
+    const kernelClock = {
+        now: () => time,
+        setTimer: (delayMs, run) => {
+            order += 1;
+            const timer = { at: time + delayMs, order, run };
+            timers.push(timer);
+            return () => {
+                timers = timers.filter((entry) => entry !== timer);
+            };
+        },
+    };
+    return {
+        kernelClock,
+        testClock: {
+            now: () => time,
+            advance: async (milliseconds) => {
+                const target = time + milliseconds;
+                await settle();
+                for (let timer = nextDue(target); timer !== undefined; timer = nextDue(target)) {
+                    const due = timer;
+                    timers = timers.filter((entry) => entry !== due);
+                    time = due.at;
+                    due.run();
+                    await settle();
+                }
+                time = target;
+                await settle();
+            },
+        },
+        settleWith: (next) => {
+            settle = next;
+        },
+        // A stopped kernel has cancelled its timers, so the time simply moves.
+        moveWhileStopped: (milliseconds) => {
+            time += milliseconds;
+        },
+    };
+}
+//# sourceMappingURL=fake-clock.js.map

package/dist/fake-clock.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fake-clock.js","sourceRoot":"","sources":["../src/fake-clock.ts"],"names":[],"mappings":"AAcA,sHAAsH;AACtH,oHAAoH;AACpH,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,IAAI,MAAM,GAAY,EAAE,CAAC;IACzB,IAAI,MAAM,GAAwB,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC;IACxD,MAAM,OAAO,GAAG,CAAC,KAAa,EAAqB,EAAE,CACnD,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,GAAG,KAAK,CAAC,EAAE,IAAI,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACvH,MAAM,WAAW,GAAU;QACzB,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI;QACf,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,EAAE;YACzB,KAAK,IAAI,CAAC,CAAC;YACX,MAAM,KAAK,GAAG,EAAE,EAAE,EAAE,IAAI,GAAG,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;YACjD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,GAAG,EAAE;gBACV,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;YACrD,CAAC,CAAC;QACJ,CAAC;KACF,CAAC;IACF,OAAO;QACL,WAAW;QACX,SAAS,EAAE;YACT,GAAG,EAAE,GAAG,EAAE,CAAC,IAAI;YACf,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE;gBAC9B,MAAM,MAAM,GAAG,IAAI,GAAG,YAAY,CAAC;gBACnC,MAAM,MAAM,EAAE,CAAC;gBACf,KAAK,IAAI,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,KAAK,KAAK,SAAS,EAAE,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC/E,MAAM,GAAG,GAAG,KAAK,CAAC;oBAClB,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC;oBACjD,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;oBACd,GAAG,CAAC,GAAG,EAAE,CAAC;oBACV,MAAM,MAAM,EAAE,CAAC;gBACjB,CAAC;gBACD,IAAI,GAAG,MAAM,CAAC;gBACd,MAAM,MAAM,EAAE,CAAC;YACjB,CAAC;SACF;QACD,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;YACnB,MAAM,GAAG,IAAI,CAAC;QAChB,CAAC;QACD,uEAAuE;QACvE,gBAAgB,EAAE,CAAC,YAAY,EAAE,EAAE;YACjC,IAAI,IAAI,YAAY,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC"}

package/dist/fake-openai.d.ts

@@ -0,0 +1,55 @@
+/** A tool call: its arguments in one piece, or as the pieces of their JSON text (which together are valid JSON). */
+export type FakeToolCall = {
+    id: string;
+    name: string;
+} & ({
+    arguments: Record<string, unknown>;
+} | {
+    argumentPieces: readonly string[];
+});
+/** A piece of a scripted stream: text, thinking, a tool call, or a pause until the promise settles. */
+export type FakeChunk = {
+    text: string;
+} | {
+    thinking: string;
+} | {
+    toolCall: FakeToolCall;
+} | {
+    wait: Promise<void>;
+};
+/** The tokens the fake server reports, counted as pi-ai counts them: `input` excludes cache reads and writes. */
+export type FakeUsage = {
+    input: number;
+    output: number;
+    cacheRead?: number;
+    cacheWrite?: number;
+};
+/** One scripted answer: a stream (its finish defaults to `tool_calls` when it calls a tool, else `stop`), or an error. */
+export type FakeReply = {
+    chunks: readonly FakeChunk[];
+    finish?: 'stop' | 'length' | 'tool_calls';
+    usage?: FakeUsage;
+} | {
+    status: number;
+    body: unknown;
+};
+/** A request the fake server got; `state` becomes `aborted` when the client closes it before the answer ends. */
+export type FakeRequest = {
+    authorization: string | undefined;
+    body: unknown;
+    state: 'answering' | 'answered' | 'aborted';
+};
+/** The fake server. */
+export type FakeOpenAI = {
+    /** The base URL to add as a provider's `baseUrl`. */
+    baseUrl: string;
+    /** Queues replies; each answers the next request. */
+    reply(...replies: FakeReply[]): void;
+    /** Every request so far, oldest first. */
+    requests(): readonly FakeRequest[];
+    /** Stops the server and drops open connections. */
+    close(): Promise<void>;
+};
+/** Starts a fake OpenAI-compatible streaming server on 127.0.0.1 for LLM tests. */
+export declare function startFakeOpenAI(): Promise<FakeOpenAI>;
+//# sourceMappingURL=fake-openai.d.ts.map

package/dist/fake-openai.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fake-openai.d.ts","sourceRoot":"","sources":["../src/fake-openai.ts"],"names":[],"mappings":"AAKA,oHAAoH;AACpH,MAAM,MAAM,YAAY,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAAE,GAAG;IAAE,cAAc,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,CAAC,CAAC;AAE3I,uGAAuG;AACvG,MAAM,MAAM,SAAS,GAAG;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,QAAQ,EAAE,YAAY,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,CAAA;CAAE,CAAC;AAEvH,iHAAiH;AACjH,MAAM,MAAM,SAAS,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnG,0HAA0H;AAC1H,MAAM,MAAM,SAAS,GACjB;IAAE,MAAM,EAAE,SAAS,SAAS,EAAE,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,YAAY,CAAC;IAAC,KAAK,CAAC,EAAE,SAAS,CAAA;CAAE,GAC9F;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,OAAO,CAAA;CAAE,CAAC;AAEtC,iHAAiH;AACjH,MAAM,MAAM,WAAW,GAAG;IAAE,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,WAAW,GAAG,UAAU,GAAG,SAAS,CAAA;CAAE,CAAC;AAE5H,uBAAuB;AACvB,MAAM,MAAM,UAAU,GAAG;IACvB,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC;IAChB,qDAAqD;IACrD,KAAK,CAAC,GAAG,OAAO,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;IACrC,0CAA0C;IAC1C,QAAQ,IAAI,SAAS,WAAW,EAAE,CAAC;IACnC,mDAAmD;IACnD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB,CAAC;AAwFF,mFAAmF;AACnF,wBAAsB,eAAe,IAAI,OAAO,CAAC,UAAU,CAAC,CAuB3D"}