@procedures/cli-kit 0.0.0-stage → 0.35.1

package/dist/fields.js

@@ -0,0 +1,339 @@
+/**
+ * The fields of a procedure input, as a command line sees them.
+ *
+ * This module reads the field types of an input schema from its JSON Schema, converts the text of
+ * the command line to those types, and merges repeated values. The schema validates the result.
+ */
+import { jsonSchemaOf } from "@procedures/client";
+/** True for the JSON Schema of `null` (a nullable field is `anyOf: [T, null]`). */
+function isNull(node) {
+    return node.type === "null" || (node.const === null && node.type === undefined);
+}
+/** The members of a union, without `null` (a nullable value is the type itself on the CLI). */
+function unionMembers(node) {
+    const members = node.anyOf ?? node.oneOf;
+    return members?.filter((member) => !isNull(member));
+}
+/**
+ * The CLI type of a JSON Schema node.
+ */
+function fieldTypeOfJson(node) {
+    if (!node || typeof node !== "object") {
+        return { kind: "any" };
+    }
+    const members = unionMembers(node);
+    if (members) {
+        if (members.length === 1)
+            return fieldTypeOfJson(members[0]);
+        // A union of string constants is an enum on the CLI
+        if (members.length > 1 && members.every((member) => typeof member.const === "string")) {
+            return { kind: "enum", values: members.map((member) => member.const) };
+        }
+        return { kind: "union", options: members.map((member) => fieldTypeOfJson(member)) };
+    }
+    if (node.allOf?.length === 1) {
+        return fieldTypeOfJson(node.allOf[0]);
+    }
+    if (Array.isArray(node.enum)) {
+        return node.enum.every((value) => typeof value === "string")
+            ? { kind: "enum", values: node.enum }
+            : { kind: "any" };
+    }
+    if ("const" in node && node.const !== undefined) {
+        return { kind: "literal", literal: node.const };
+    }
+    const types = Array.isArray(node.type) ? node.type.filter((type) => type !== "null") : node.type ? [node.type] : [];
+    if (types.length > 1) {
+        return { kind: "union", options: types.map((type) => fieldTypeOfJson({ ...node, type })) };
+    }
+    switch (types[0]) {
+        case "string":
+            return node.format === "date-time" || node.format === "date" ? { kind: "date" } : { kind: "string" };
+        case "number":
+        case "integer":
+            return { kind: "number" };
+        case "boolean":
+            return { kind: "boolean" };
+        case "array":
+            return { kind: "array", item: fieldTypeOfJson(Array.isArray(node.items) ? undefined : node.items) };
+        case "object": {
+            const extra = node.additionalProperties;
+            const hasFields = node.properties && Object.keys(node.properties).length > 0;
+            if (!hasFields && extra && typeof extra === "object") {
+                return { kind: "record", value: fieldTypeOfJson(extra) };
+            }
+            return { kind: "object" };
+        }
+        default:
+            return { kind: "any" };
+    }
+}
+/**
+ * The JSON Schema of a procedure schema (or a JSON Schema itself, as the manifest stores it).
+ */
+function asJsonSchema(schema) {
+    if (!schema || typeof schema !== "object") {
+        return undefined;
+    }
+    // A JSON Schema already (from the manifest): it has no validator
+    const props = schema;
+    if (!("~standard" in props) && typeof props["safeParse"] !== "function" && typeof props["parse"] !== "function") {
+        return schema;
+    }
+    return jsonSchemaOf(schema);
+}
+/**
+ * The CLI type of a schema: a procedure schema (a Standard Schema such as zod 4) or its JSON
+ * Schema. The type comes from the JSON Schema, so every schema library works. (Before, the
+ * parser read the private fields of zod 3.)
+ */
+export function fieldTypeOf(schema) {
+    return fieldTypeOfJson(asJsonSchema(schema));
+}
+/**
+ * The display name of a type, for the help text
+ */
+export function typeName(type) {
+    switch (type.kind) {
+        case "array":
+            return `${typeName(type.item ?? { kind: "any" })}[]`;
+        case "record":
+            return "key=value";
+        case "object":
+        case "any":
+            return "json";
+        case "union":
+            return (type.options ?? []).map(typeName).join("|");
+        case "literal":
+            return JSON.stringify(type.literal);
+        default:
+            return type.kind;
+    }
+}
+/**
+ * Extract field information from a schema: a procedure schema or its JSON Schema. A schema that
+ * is not an object (or that has no JSON Schema) gives no fields: the CLI then passes its flags
+ * through.
+ */
+export function extractSchemaFields(schema) {
+    const json = asJsonSchema(schema);
+    const object = json && !json.properties ? unionMembers(json)?.find((member) => member.properties) : json;
+    if (!object?.properties) {
+        return [];
+    }
+    const required = new Set(object.required ?? []);
+    const fields = [];
+    for (const [name, field] of Object.entries(object.properties)) {
+        if (!field || typeof field !== "object") {
+            continue;
+        }
+        const fieldType = fieldTypeOfJson(field);
+        const description = field.description ?? unionMembers(field)?.find((member) => member.description)?.description;
+        fields.push({
+            name,
+            type: fieldType.kind === "enum" ? "enum" : typeName(fieldType),
+            fieldType,
+            required: required.has(name) && field.default === undefined,
+            description,
+            defaultValue: field.default,
+            enumValues: fieldType.kind === "enum" ? fieldType.values : undefined,
+        });
+    }
+    return fields;
+}
+// The digits before the point and the digits after it are two groups, so each text has one match
+const NUMBER_TEXT = /^[-+]?(?:\d+(?:\.\d*)?|\.\d+)(?:[eE][-+]?\d+)?$|^0[xX][0-9a-fA-F]+$/;
+const SAFE_INTEGER_LIMIT = BigInt(Number.MAX_SAFE_INTEGER);
+/**
+ * Text as a JSON value, when it is JSON. A whole number that a JavaScript number cannot hold
+ * exactly stays text. Anything that is not JSON stays text.
+ */
+function jsonOrText(text) {
+    const trimmed = text.trim();
+    if (/^-?\d+$/.test(trimmed)) {
+        const big = BigInt(trimmed);
+        if (big > SAFE_INTEGER_LIMIT || big < -SAFE_INTEGER_LIMIT) {
+            return text;
+        }
+    }
+    try {
+        return JSON.parse(trimmed);
+    }
+    catch {
+        return text;
+    }
+}
+/**
+ * Convert the CLI text of one value to a field type
+ */
+export function convertValue(text, type, label) {
+    switch (type.kind) {
+        case "string":
+        case "date":
+            return { ok: true, value: text };
+        case "enum":
+            return { ok: true, value: text };
+        case "number": {
+            if (!NUMBER_TEXT.test(text.trim())) {
+                return { ok: false, error: `${label} needs a number, not "${text}"` };
+            }
+            return { ok: true, value: Number(text) };
+        }
+        case "bigint":
+            try {
+                return { ok: true, value: BigInt(text) };
+            }
+            catch {
+                return { ok: false, error: `${label} needs a whole number, not "${text}"` };
+            }
+        case "boolean":
+            if (text === "true")
+                return { ok: true, value: true };
+            if (text === "false")
+                return { ok: true, value: false };
+            return { ok: false, error: `${label} needs true or false, not "${text}"` };
+        case "literal": {
+            const literal = type.literal;
+            if (typeof literal === "number")
+                return convertValue(text, { kind: "number" }, label);
+            if (typeof literal === "boolean")
+                return convertValue(text, { kind: "boolean" }, label);
+            return { ok: true, value: text };
+        }
+        case "array": {
+            const item = type.item ?? { kind: "any" };
+            if (text.trimStart().startsWith("[")) {
+                const parsed = jsonOrText(text);
+                if (Array.isArray(parsed)) {
+                    return { ok: true, value: parsed };
+                }
+            }
+            const converted = convertValue(text, item, label);
+            return converted.ok ? { ok: true, value: [converted.value] } : converted;
+        }
+        case "record": {
+            if (text.trimStart().startsWith("{")) {
+                const parsed = jsonOrText(text);
+                if (parsed && typeof parsed === "object" && !Array.isArray(parsed)) {
+                    return { ok: true, value: parsed };
+                }
+                return { ok: false, error: `${label} needs key=value or a JSON object` };
+            }
+            const eq = text.indexOf("=");
+            if (eq <= 0) {
+                return { ok: false, error: `${label} needs key=value, not "${text}"` };
+            }
+            const converted = convertValue(text.slice(eq + 1), type.value ?? { kind: "any" }, label);
+            return converted.ok ? { ok: true, value: { [text.slice(0, eq)]: converted.value } } : converted;
+        }
+        case "object": {
+            const parsed = jsonOrText(text);
+            if (parsed && typeof parsed === "object" && !Array.isArray(parsed)) {
+                return { ok: true, value: parsed };
+            }
+            return { ok: false, error: `${label} needs a JSON object, not "${text}"` };
+        }
+        case "union": {
+            const options = type.options ?? [];
+            // Zod tries the members in order: a member that takes text takes the text as it is
+            for (const option of options) {
+                if (option.kind === "string" || option.kind === "date")
+                    return { ok: true, value: text };
+                if (option.kind === "enum" && option.values?.includes(text))
+                    return { ok: true, value: text };
+                if (option.kind === "literal" && String(option.literal) === text) {
+                    return { ok: true, value: option.literal };
+                }
+            }
+            for (const option of options) {
+                if (option.kind === "enum" || option.kind === "literal")
+                    continue;
+                const converted = convertValue(text, option, label);
+                if (converted.ok)
+                    return converted;
+            }
+            return { ok: true, value: jsonOrText(text) };
+        }
+        case "any":
+        default:
+            return { ok: true, value: jsonOrText(text) };
+    }
+}
+/**
+ * Add a converted value to a field that already has one. Arrays collect and records merge,
+ * so a repeated flag adds to the field. Other fields take the last value.
+ */
+export function mergeValue(previous, next, type) {
+    if (previous === undefined) {
+        return next;
+    }
+    if (type.kind === "array" && Array.isArray(previous) && Array.isArray(next)) {
+        return [...previous, ...next];
+    }
+    if (type.kind === "record" &&
+        previous && typeof previous === "object" && !Array.isArray(previous) &&
+        next && typeof next === "object" && !Array.isArray(next)) {
+        return { ...previous, ...next };
+    }
+    return next;
+}
+/**
+ * Convert camelCase to kebab-case
+ */
+export function toKebab(str) {
+    return str.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
+}
+/**
+ * Convert kebab-case to camelCase
+ */
+export function toCamel(str) {
+    return str.replace(/-([a-zA-Z0-9])/g, (_, c) => c.toUpperCase());
+}
+/** This function gives the fields of the input of a command: from its description, or read from its schema. */
+export function fieldsOf(command) {
+    return command.fields ? [...command.fields] : extractSchemaFields(command.input);
+}
+/**
+ * The fields of the result of a procedure, from its output schema: only for a result that is an
+ * object (a union, a stream item or a pass-through schema gives none).
+ */
+export function resultFieldsOfSchema(output) {
+    const json = output ? jsonSchemaOf(output, { io: "output" }) : undefined;
+    if (!json)
+        return [];
+    if (json.type === "object")
+        return extractSchemaFields(json);
+    // A number, a string, a boolean or an array: the help shows the one value
+    if (typeof json.type === "string" && ["number", "integer", "string", "boolean", "array"].includes(json.type)) {
+        const fieldType = fieldTypeOfJson(json);
+        return [
+            {
+                name: "value",
+                type: typeName(fieldType),
+                fieldType,
+                required: true,
+                description: json.description,
+                defaultValue: undefined,
+                enumValues: undefined,
+            },
+        ];
+    }
+    return [];
+}
+/** This function gives the fields of the result of a command: from its description, or read from its output schema. */
+export function resultFieldsOf(command) {
+    return command.resultFields ? [...command.resultFields] : resultFieldsOfSchema(command.output);
+}
+/** A field that only the metadata names (the schema has no readable shape) */
+export function fieldWithoutSchema(name) {
+    return {
+        name,
+        type: "json",
+        fieldType: { kind: "any" },
+        required: false,
+        description: undefined,
+        defaultValue: undefined,
+        enumValues: undefined,
+    };
+}
+//# sourceMappingURL=fields.js.map

package/dist/fields.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.js","sourceRoot":"","sources":["../src/fields.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,YAAY,EAAwB,MAAM,oBAAoB,CAAC;AAuFxE,mFAAmF;AACnF,SAAS,MAAM,CAAC,IAAc;IAC5B,OAAO,IAAI,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,KAAK,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;AAClF,CAAC;AAED,+FAA+F;AAC/F,SAAS,YAAY,CAAC,IAAc;IAClC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;IACzC,OAAO,OAAO,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;AACtD,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,IAA0B;IACjD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACtC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACzB,CAAC;IACD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,OAAO,EAAE,CAAC;QACZ,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7D,oDAAoD;QACpD,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,CAAC,KAAK,KAAK,QAAQ,CAAC,EAAE,CAAC;YACtF,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAe,CAAC,EAAE,CAAC;QACnF,CAAC;QACD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;IACtF,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC;YAC1D,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,IAAgB,EAAE;YACjD,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IACtB,CAAC;IACD,IAAI,OAAO,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAChD,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,IAAI,CAAC,KAAK,EAAE,CAAC;IAClD,CAAC;IACD,MAAM,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IACpH,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,eAAe,CAAC,EAAE,GAAG,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC;IAC7F,CAAC;IACD,QAAQ,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,IAAI,CAAC,MAAM,KAAK,WAAW,IAAI,IAAI,CAAC,MAAM,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QACvG,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7B,KAAK,OAAO;YACV,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;QACtG,KAAK,QAAQ,EAAE,CAAC;YACd,MAAM,KAAK,GAAG,IAAI,CAAC,oBAAoB,CAAC;YACxC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;YAC7E,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,eAAe,CAAC,KAAK,CAAC,EAAE,CAAC;YAC3D,CAAC;YACD,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,CAAC;QACD;YACE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC3B,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,YAAY,CAAC,MAAe;IACnC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,iEAAiE;IACjE,MAAM,KAAK,GAAG,MAAiC,CAAC;IAChD,IAAI,CAAC,CAAC,WAAW,IAAI,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,UAAU,IAAI,OAAO,KAAK,CAAC,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;QAChH,OAAO,MAAkB,CAAC;IAC5B,CAAC;IACD,OAAO,YAAY,CAAC,MAAyB,CAAyB,CAAC;AACzE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAe;IACzC,OAAO,eAAe,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAe;IACtC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,OAAO;YACV,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,IAAI,CAAC;QACvD,KAAK,QAAQ;YACX,OAAO,WAAW,CAAC;QACrB,KAAK,QAAQ,CAAC;QACd,KAAK,KAAK;YACR,OAAO,MAAM,CAAC;QAChB,KAAK,OAAO;YACV,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACtD,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACtC;YACE,OAAO,IAAI,CAAC,IAAI,CAAC;IACrB,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,MAAe;IACjD,MAAM,IAAI,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IACzG,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;IAChD,MAAM,MAAM,GAAsB,EAAE,CAAC;IACrC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9D,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACxC,SAAS;QACX,CAAC;QACD,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;QACzC,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC;QAChH,MAAM,CAAC,IAAI,CAAC;YACV,IAAI;YACJ,IAAI,EAAE,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC;YAC9D,SAAS;YACT,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS;YAC3D,WAAW;YACX,YAAY,EAAE,KAAK,CAAC,OAAO;YAC3B,UAAU,EAAE,SAAS,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS;SACrE,CAAC,CAAC;IACL,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AASD,iGAAiG;AACjG,MAAM,WAAW,GAAG,qEAAqE,CAAC;AAC1F,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;GAGG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC;IAC5B,IAAI,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,GAAG,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC5B,IAAI,GAAG,GAAG,kBAAkB,IAAI,GAAG,GAAG,CAAC,kBAAkB,EAAE,CAAC;YAC1D,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,IAAe,EAAE,KAAa;IACvE,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM;YACT,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnC,KAAK,MAAM;YACT,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnC,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;gBACnC,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,yBAAyB,IAAI,GAAG,EAAE,CAAC;YACxE,CAAC;YACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,CAAC;QACD,KAAK,QAAQ;YACX,IAAI,CAAC;gBACH,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,+BAA+B,IAAI,GAAG,EAAE,CAAC;YAC9E,CAAC;QACH,KAAK,SAAS;YACZ,IAAI,IAAI,KAAK,MAAM;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;YACtD,IAAI,IAAI,KAAK,OAAO;gBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;YACxD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,8BAA8B,IAAI,GAAG,EAAE,CAAC;QAC7E,KAAK,SAAS,EAAE,CAAC;YACf,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;YAC7B,IAAI,OAAO,OAAO,KAAK,QAAQ;gBAAE,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAC;YACtF,IAAI,OAAO,OAAO,KAAK,SAAS;gBAAE,OAAO,YAAY,CAAC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,KAAK,CAAC,CAAC;YACxF,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;QACnC,CAAC;QACD,KAAK,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;YAC1C,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAChC,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC1B,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBACrC,CAAC;YACH,CAAC;YACD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;YAClD,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrC,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;gBAChC,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;oBACnE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;gBACrC,CAAC;gBACD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,mCAAmC,EAAE,CAAC;YAC3E,CAAC;YACD,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;gBACZ,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,0BAA0B,IAAI,GAAG,EAAE,CAAC;YACzE,CAAC;YACD,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,CAAC,CAAC;YACzF,OAAO,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAClG,CAAC;QACD,KAAK,QAAQ,EAAE,CAAC;YACd,MAAM,MAAM,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;YAChC,IAAI,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACnE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YACrC,CAAC;YACD,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,KAAK,8BAA8B,IAAI,GAAG,EAAE,CAAC;QAC7E,CAAC;QACD,KAAK,OAAO,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;YACnC,mFAAmF;YACnF,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM;oBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBACzF,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC;oBAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;gBAC9F,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;oBACjE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;gBAC7C,CAAC;YACH,CAAC;YACD,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;oBAAE,SAAS;gBAClE,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;gBACpD,IAAI,SAAS,CAAC,EAAE;oBAAE,OAAO,SAAS,CAAC;YACrC,CAAC;YACD,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/C,CAAC;QACD,KAAK,KAAK,CAAC;QACX;YACE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;IACjD,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,QAAiB,EAAE,IAAa,EAAE,IAAe;IAC1E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC5E,OAAO,CAAC,GAAG,QAAQ,EAAE,GAAG,IAAI,CAAC,CAAC;IAChC,CAAC;IACD,IACE,IAAI,CAAC,IAAI,KAAK,QAAQ;QACtB,QAAQ,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC;QACpE,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EACxD,CAAC;QACD,OAAO,EAAE,GAAG,QAAQ,EAAE,GAAG,IAAI,EAAE,CAAC;IAClC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,CAAC,OAAO,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC,WAAW,EAAE,CAAC;AAClE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,GAAG,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC,EAAE,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC;AAC3E,CAAC;AAmBD,+GAA+G;AAC/G,MAAM,UAAU,QAAQ,CAAC,OAAoB;IAC3C,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,mBAAmB,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACnF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAe;IAClD,MAAM,IAAI,GAAG,MAAM,CAAC,CAAC,CAAE,YAAY,CAAC,MAAyB,EAAE,EAAE,EAAE,EAAE,QAAQ,EAAE,CAA0B,CAAC,CAAC,CAAC,SAAS,CAAC;IACtH,IAAI,CAAC,IAAI;QAAE,OAAO,EAAE,CAAC;IACrB,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ;QAAE,OAAO,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC7D,0EAA0E;IAC1E,IAAI,OAAO,IAAI,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7G,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QACxC,OAAO;YACL;gBACE,IAAI,EAAE,OAAO;gBACb,IAAI,EAAE,QAAQ,CAAC,SAAS,CAAC;gBACzB,SAAS;gBACT,QAAQ,EAAE,IAAI;gBACd,WAAW,EAAE,IAAI,CAAC,WAAW;gBAC7B,YAAY,EAAE,SAAS;gBACvB,UAAU,EAAE,SAAS;aACtB;SACF,CAAC;IACJ,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,uHAAuH;AACvH,MAAM,UAAU,cAAc,CAAC,OAAoB;IACjD,OAAO,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AACjG,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO;QACL,IAAI;QACJ,IAAI,EAAE,MAAM;QACZ,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QAC1B,QAAQ,EAAE,KAAK;QACf,WAAW,EAAE,SAAS;QACtB,YAAY,EAAE,SAAS;QACvB,UAAU,EAAE,SAAS;KACtB,CAAC;AACJ,CAAC"}

package/dist/format.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Output Formatting
+ *
+ * Formats procedure results for CLI output based on metadata hints.
+ */
+export type OutputFormat = "text" | "json" | "table" | "streaming";
+/**
+ * Print interface (used by formatOutput)
+ */
+export interface Print {
+    info: (message: string) => void;
+    error: (message: string) => void;
+    success: (message: string) => void;
+    warning: (message: string) => void;
+    table: (data: string[][], options?: {
+        format?: string;
+    }) => void;
+    spin: (message: string) => Spinner;
+}
+export interface Spinner {
+    stop: () => void;
+    succeed: (message?: string) => void;
+    fail: (message?: string) => void;
+    text: string;
+}
+/**
+ * Format and print the result based on output format hint
+ */
+export declare function formatOutput(print: Print, result: unknown, format?: OutputFormat): void;
+/**
+ * This function gives a `Print` that writes plain text to the console: messages to stdout,
+ * errors to stderr, a table as columns. Its spinner shows nothing.
+ */
+export declare function plainPrint(): Print;
+//# sourceMappingURL=format.d.ts.map

package/dist/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,WAAW,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IAChC,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAC;IACnC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,IAAI,CAAC;IACjE,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACpC,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,KAAK,EACZ,MAAM,EAAE,OAAO,EACf,MAAM,GAAE,YAAqB,GAC5B,IAAI,CAoBN;AA4HD;;;GAGG;AACH,wBAAgB,UAAU,IAAI,KAAK,CAalC"}

package/dist/format.js

@@ -0,0 +1,145 @@
+/**
+ * Output Formatting
+ *
+ * Formats procedure results for CLI output based on metadata hints.
+ */
+/**
+ * Format and print the result based on output format hint
+ */
+export function formatOutput(print, result, format = "text") {
+    if (result === undefined || result === null) {
+        return;
+    }
+    switch (format) {
+        case "json":
+            print.info(JSON.stringify(result, null, 2));
+            break;
+        case "table":
+            formatTable(print, result);
+            break;
+        case "text":
+        case "streaming":
+        default:
+            formatText(print, result);
+            break;
+    }
+}
+/**
+ * Format as text - handles common result shapes
+ */
+function formatText(print, result) {
+    // String output
+    if (typeof result === "string") {
+        print.info(result);
+        return;
+    }
+    // Result with output field (common pattern)
+    if (isObjectWithOutput(result)) {
+        print.info(result.output);
+        return;
+    }
+    // Result with message field
+    if (isObjectWithMessage(result)) {
+        if (result.success === false) {
+            print.error(result.message);
+        }
+        else {
+            print.success(result.message);
+        }
+        return;
+    }
+    // Result with error field
+    if (isObjectWithError(result)) {
+        print.error(result.error);
+        return;
+    }
+    // Array of items
+    if (Array.isArray(result)) {
+        for (const item of result) {
+            formatText(print, item);
+        }
+        return;
+    }
+    // Fallback to JSON
+    print.info(JSON.stringify(result, null, 2));
+}
+/**
+ * Format as table - handles arrays of objects
+ */
+function formatTable(print, result) {
+    // Result with rows/headers
+    if (isTableResult(result)) {
+        const headers = result.headers ?? Object.keys(result.rows[0] ?? {});
+        const data = [headers];
+        for (const row of result.rows) {
+            if (Array.isArray(row)) {
+                data.push(row.map(String));
+            }
+            else if (typeof row === "object" && row !== null) {
+                data.push(headers.map((h) => String(row[h] ?? "")));
+            }
+        }
+        print.table(data);
+        return;
+    }
+    // Plain array of objects
+    if (Array.isArray(result) && result.length > 0 && typeof result[0] === "object") {
+        const headers = Object.keys(result[0]);
+        const data = [headers];
+        for (const row of result) {
+            if (typeof row === "object" && row !== null) {
+                data.push(headers.map((h) => String(row[h] ?? "")));
+            }
+        }
+        print.table(data);
+        return;
+    }
+    // Fallback to text
+    formatText(print, result);
+}
+// Type guards
+function isObjectWithOutput(val) {
+    return (typeof val === "object" &&
+        val !== null &&
+        "output" in val &&
+        typeof val.output === "string");
+}
+function isObjectWithMessage(val) {
+    return (typeof val === "object" &&
+        val !== null &&
+        "message" in val &&
+        typeof val.message === "string");
+}
+function isObjectWithError(val) {
+    return (typeof val === "object" &&
+        val !== null &&
+        "error" in val &&
+        typeof val.error === "string");
+}
+function isTableResult(val) {
+    return (typeof val === "object" &&
+        val !== null &&
+        "rows" in val &&
+        Array.isArray(val.rows));
+}
+/**
+ * This function gives a `Print` that writes plain text to the console: messages to stdout,
+ * errors to stderr, a table as columns. Its spinner shows nothing.
+ */
+export function plainPrint() {
+    return {
+        info: (message) => console.log(message),
+        error: (message) => console.error(message),
+        success: (message) => console.log(message),
+        warning: (message) => console.error(message),
+        table: (data) => {
+            const widths = [];
+            for (const row of data)
+                row.forEach((cell, i) => (widths[i] = Math.max(widths[i] ?? 0, cell.length)));
+            for (const row of data)
+                console.log(row.map((cell, i) => cell.padEnd(widths[i] ?? 0)).join("  ").trimEnd());
+        },
+        spin: (message) => ({ stop: () => { }, succeed: () => { }, fail: () => { }, text: message }),
+    };
+}
+//# sourceMappingURL=format.js.map

package/dist/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAuBH;;GAEG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAY,EACZ,MAAe,EACf,MAAM,GAAiB,MAAM;IAE7B,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QAC5C,OAAO;IACT,CAAC;IAED,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM;YACT,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YAC5C,MAAM;QAER,KAAK,OAAO;YACV,WAAW,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC3B,MAAM;QAER,KAAK,MAAM,CAAC;QACZ,KAAK,WAAW,CAAC;QACjB;YACE,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC1B,MAAM;IACV,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,KAAY,EAAE,MAAe;IAC/C,gBAAgB;IAChB,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnB,OAAO;IACT,CAAC;IAED,4CAA4C;IAC5C,IAAI,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,4BAA4B;IAC5B,IAAI,mBAAmB,CAAC,MAAM,CAAC,EAAE,CAAC;QAChC,IAAI,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAC7B,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAChC,CAAC;QACD,OAAO;IACT,CAAC;IAED,0BAA0B;IAC1B,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC1B,OAAO;IACT,CAAC;IAED,iBAAiB;IACjB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;YAC1B,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC1B,CAAC;QACD,OAAO;IACT,CAAC;IAED,mBAAmB;IACnB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED;;GAEG;AACH,SAAS,WAAW,CAAC,KAAY,EAAE,MAAe;IAChD,2BAA2B;IAC3B,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QACpE,MAAM,IAAI,GAAe,CAAC,OAAO,CAAC,CAAC;QAEnC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAC9B,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC;YAC7B,CAAC;iBAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBACnD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAE,GAA+B,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO;IACT,CAAC;IAED,yBAAyB;IACzB,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,MAAM,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QAChF,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAW,CAAC,CAAC;QACjD,MAAM,IAAI,GAAe,CAAC,OAAO,CAAC,CAAC;QAEnC,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;YACzB,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;gBAC5C,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAE,GAA+B,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;QAED,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO;IACT,CAAC;IAED,mBAAmB;IACnB,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AAC5B,CAAC;AAED,cAAc;AAEd,SAAS,kBAAkB,CAAC,GAAY;IACtC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,QAAQ,IAAI,GAAG;QACf,OAAQ,GAA2B,CAAC,MAAM,KAAK,QAAQ,CACxD,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,GAAY;IACvC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,SAAS,IAAI,GAAG;QAChB,OAAQ,GAA4B,CAAC,OAAO,KAAK,QAAQ,CAC1D,CAAC;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,GAAY;IACrC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,OAAO,IAAI,GAAG;QACd,OAAQ,GAA0B,CAAC,KAAK,KAAK,QAAQ,CACtD,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,GAAY;IACjC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,GAAG,KAAK,IAAI;QACZ,MAAM,IAAI,GAAG;QACb,KAAK,CAAC,OAAO,CAAE,GAAyB,CAAC,IAAI,CAAC,CAC/C,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU;IACxB,OAAO;QACL,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QACvC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QAC1C,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;QAC1C,OAAO,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QAC5C,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE;YACd,MAAM,MAAM,GAAa,EAAE,CAAC;YAC5B,KAAK,MAAM,GAAG,IAAI,IAAI;gBAAE,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;YACtG,KAAK,MAAM,GAAG,IAAI,IAAI;gBAAE,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC9G,CAAC;QACD,IAAI,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,GAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;KAC1F,CAAC;AACJ,CAAC"}

package/dist/help.d.ts

@@ -0,0 +1,42 @@
+/**
+ * The help text of a command line: the help of one command, of a group of commands and of the
+ * whole program.
+ *
+ * Each function gives the text and prints nothing. The caller prints it.
+ */
+import type { GlobalFlag } from "./args.js";
+import { type CLIMeta, type CommandLike, type SchemaFieldInfo } from "./fields.js";
+/** The options of the help text. */
+export interface HelpOptions {
+    /** The name of the program, as a person types it, for example `mark`. */
+    name: string;
+    /** The global flags that the help lists. The help lists each flag that is not `hidden`. */
+    globals?: readonly GlobalFlag[] | undefined;
+}
+/**
+ * This function gives the help text of one command. `schema` is the input schema, or the fields
+ * of the input. `result` gives the fields of the result. The help lists them after the options.
+ */
+export declare function generateHelp(path: readonly string[], meta: CLIMeta, schema: unknown, result: readonly SchemaFieldInfo[], options: HelpOptions): string;
+/**
+ * This function gives the help of a group of commands: one message for each line. It gives
+ * undefined when no command is in the group. A message can contain a line break.
+ */
+export declare function groupHelp(name: string, commands: readonly CommandLike[], path: readonly string[]): string[] | undefined;
+/** The options of the help of the whole program. */
+export interface RootHelpOptions {
+    /** The name of the program. */
+    name: string;
+    /** The first line of the help. The default is the name. */
+    title?: string | undefined;
+    /** The lines after the list of the commands. */
+    footer?: readonly string[] | undefined;
+}
+/**
+ * This function gives the help of the whole program: the commands by their first word. It gives
+ * one message for each line. A message can contain a line break.
+ */
+export declare function rootHelp(commands: readonly CommandLike[], options: RootHelpOptions): string[];
+/** This function gives the message of a validation error: one line for each issue of a Zod error. */
+export declare function validationMessage(error: unknown): string;
+//# sourceMappingURL=help.d.ts.map

package/dist/help.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.d.ts","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAKL,KAAK,OAAO,EACZ,KAAK,WAAW,EAChB,KAAK,eAAe,EACrB,MAAM,aAAa,CAAC;AAErB,oCAAoC;AACpC,MAAM,WAAW,WAAW;IAC1B,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,2FAA2F;IAC3F,OAAO,CAAC,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,CAAC;CAC7C;AAsBD;;;GAGG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,SAAS,MAAM,EAAE,EACvB,IAAI,EAAE,OAAO,EACb,MAAM,EAAE,OAAO,EACf,MAAM,EAAE,SAAS,eAAe,EAAE,EAClC,OAAO,EAAE,WAAW,GACnB,MAAM,CAiGR;AAED;;;GAGG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,SAAS,WAAW,EAAE,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,GAAG,SAAS,CA6BvH;AAED,oDAAoD;AACpD,MAAM,WAAW,eAAe;IAC9B,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,gDAAgD;IAChD,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;CACxC;AAED;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,SAAS,WAAW,EAAE,EAAE,OAAO,EAAE,eAAe,GAAG,MAAM,EAAE,CAwB7F;AAED,qGAAqG;AACrG,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAQxD"}