deepline 0.3.372 → 0.3.374

package/dist/cli/{chunk-3GK3SH3G.mjs → chunk-E6BZWURC.mjs}

@@ -4,6 +4,21 @@ import {
 
 // src/cli/described.ts
 var SHAPE = "{}";
+function byokLines(byok) {
+  if (typeof byok.supported !== "boolean") {
+    return ["BYOK: unknown (this server does not report it)"];
+  }
+  if (!byok.supported) {
+    return [
+      "BYOK: not supported. Deepline runs this tool with its own credentials."
+    ];
+  }
+  return [
+    byok.required === true ? "BYOK: required. This tool runs only on your own provider credentials." : "BYOK: supported (optional).",
+    ...byok.setup ? [`Setup: ${byok.setup}`] : [],
+    ...byok.setupUrl ? [`Connect: ${byok.setupUrl}`] : []
+  ];
+}
 var SCHEMA_LINE_LIMIT = 100;
 function isRecord(value) {
   return typeof value === "object" && value !== null && !Array.isArray(value);
@@ -69,7 +84,9 @@ function schemaField(name, node, required) {
     required,
     ...example !== void 0 ? { example } : {},
     ...typeof schema.description === "string" && schema.description ? { description: schema.description } : {},
-    ...fields ? { fields } : {}
+    ...fields ? { fields } : {},
+    ...schema.secondary === true ? { secondary: true } : {},
+    ...typeof schema.means === "string" ? { means: schema.means } : {}
   };
 }
 function withoutRefs(node, root, depth = 0) {
@@ -167,6 +184,7 @@ function namedShapes(roots) {
       under: field.name
     };
     entry.count += 1;
+    entry.shape ??= field.shape;
     entry.descriptions.add(field.description ?? "");
     seen.set(key, entry);
     field.fields.forEach(visit);
@@ -175,12 +193,12 @@ function namedShapes(roots) {
   const taken = /* @__PURE__ */ new Set();
   const named = /* @__PURE__ */ new Map();
   for (const [key, entry] of seen) {
-    if (entry.count < 2) continue;
+    if (entry.count < 2 && !entry.shape) continue;
     const [description] = entry.descriptions.size === 1 ? [...entry.descriptions] : [""];
     const title = (description ?? "").split(/[.:]/)[0].trim();
-    const base = pascalCase(
+    const base = entry.shape ?? (pascalCase(
       title && title.split(/\s+/).length <= 3 ? title : entry.fields.length <= 3 ? entry.fields.map((field) => field.name).join(" ") : entry.under
-    ) || "Shape";
+    ) || "Shape");
     let name = base;
     for (let n = 2; taken.has(name); n += 1) name = `${base}${n}`;
     taken.add(name);
@@ -213,23 +231,27 @@ function schemaBlocks(described, maxDepth, everyField = false) {
     const example = field.example === void 0 ? void 0 : JSON.stringify(field.example);
     const start = `${indent}${JSON.stringify(field.name)}${field.required ? "" : "?"}: `;
     if (!field.fields) {
-      return [`${start}${field.type},${comment([example, field.description])}`];
+      return [
+        `${start}${field.type},${comment([field.means, example, field.description])}`
+      ];
     }
     const [before, after] = field.type.split(SHAPE);
     const shape = shapes.get(shapeKey(field.fields));
     if (shape) {
       if (!used.includes(shape)) used.push(shape);
       const own = field.description === shape.description ? void 0 : field.description;
-      return [`${start}${before}${shape.name}${after},${comment([own])}`];
+      return [
+        `${start}${before}${shape.name}${after},${comment([field.means, own])}`
+      ];
     }
     if (depth >= maxDepth || field.summarized && !everyField) {
       const names = field.fields.map((child) => child.name).join(", ");
       return [
-        `${start}${before}{ ${names} }${after},${comment([field.description])}`
+        `${start}${before}{ ${names} }${after},${comment([field.means, field.description])}`
       ];
     }
     return [
-      `${start}${before}{${comment([field.description])}`,
+      `${start}${before}{${comment([field.means, field.description])}`,
       ...field.fields.flatMap(
         (child) => fieldLines(child, `${indent}  `, depth + 1)
       ),
@@ -255,8 +277,70 @@ function schemaBlocks(described, maxDepth, everyField = false) {
   }
   return [...lines, ...types.length ? ["", "Types:", ...types] : []];
 }
-function schemaLines(described, options) {
-  if (options.full) return schemaBlocks(described, Infinity, true);
+function selectFields(described, wanted) {
+  const hidden = [];
+  const keep = (fields, isInput, path = []) => fields.flatMap((field) => {
+    const name = [...path, field.name];
+    if (!(isInput && field.required) && !wanted(field, path.length)) {
+      hidden.push(name.join("."));
+      return [];
+    }
+    return [
+      field.fields ? { ...field, fields: keep(field.fields, isInput, name) } : field
+    ];
+  });
+  const inputs = keep(described.inputs, true);
+  const rowInputs = described.rowInputs && keep(described.rowInputs, true);
+  const outputs = keep(described.outputs, false);
+  const rowOutputs = described.rowOutputs && keep(described.rowOutputs, false);
+  return {
+    selected: {
+      ...described,
+      inputs,
+      outputs,
+      ...rowInputs ? { rowInputs } : {},
+      ...rowOutputs ? { rowOutputs } : {}
+    },
+    hidden
+  };
+}
+function schemaLines(described, view) {
+  const count = (names) => `${names.length} ${names.length === 1 ? "field" : "fields"}`;
+  if (view.fields) {
+    const names = view.fields;
+    const { selected, hidden } = selectFields(
+      described,
+      (field, depth) => depth > 0 || names.includes(field.name)
+    );
+    const known = new Set(
+      [
+        described.inputs,
+        described.outputs,
+        described.rowInputs ?? [],
+        described.rowOutputs ?? []
+      ].flatMap((fields) => fields.map((field) => field.name))
+    );
+    const unknown = names.filter((name) => !known.has(name));
+    return [
+      ...schemaLines(selected, { full: true, secondary: true }),
+      ...unknown.length ? ["", `No field named: ${unknown.join(", ")}.`] : [],
+      ...hidden.length ? ["", `${count(hidden)} not shown: ${hidden.join(", ")}.`] : []
+    ];
+  }
+  if (!view.full && !view.secondary) {
+    const { selected, hidden } = selectFields(
+      described,
+      (field) => !field.secondary
+    );
+    return [
+      ...schemaLines(selected, { ...view, secondary: true }),
+      ...hidden.length ? [
+        "",
+        `${count(hidden).replace(" ", " secondary ")} hidden: ${hidden.join(", ")}. --verbose shows ${hidden.length === 1 ? "it" : "them"}.`
+      ] : []
+    ];
+  }
+  if (view.full) return schemaBlocks(described, Infinity, true);
   const raw = described.rawResponse?.length ? [
     "",
     `Other response fields (${described.rawResponse.map((field) => field.name).join(", ")}) are in result.toolResponse.rawV2. --full-schema lists them.`
@@ -284,7 +368,7 @@ function examples(described, options) {
   const input = JSON.stringify(
     Object.fromEntries(shown.map((field) => [field.name, exampleValue(field)]))
   );
-  const read = options.verbose ? described.outputs : described.outputs.slice(0, 1);
+  const read = options.verbose ? described.outputs : described.outputs.filter((field) => !field.secondary).slice(0, 1);
   const reads = (expression) => read.flatMap((field) => {
     const source = expression(field);
     return source ? [`const ${safeIdentifier(field.name)} = ${source};`] : [];
@@ -338,7 +422,17 @@ function describedLines(described, view) {
     ...described.cost ? [`Cost: ${described.cost}`] : [],
     ...described.guidance.map((line) => `Guidance: ${line}`),
     ...described.rateLimit ? [`Rate limit: ${described.rateLimit}`] : [],
-    ...schemaLines(described, { full: view.fullSchema }),
+    ...described.byok ? byokLines(described.byok) : [],
+    ...schemaLines(described, {
+      full: view.fullSchema,
+      secondary: view.verbose,
+      ...view.fields ? { fields: view.fields } : {}
+    }),
+    ...section(
+      described.exclusive ? [
+        `Give "${described.exclusive.field}" or ${described.exclusive.with.map((name) => `"${name}"`).join(", ")}, not both: per-row values go in the CSV.`
+      ] : []
+    ),
     ...section(
       view.cli ? [
         "Run from the CLI:",
@@ -361,6 +455,88 @@ function describedLines(described, view) {
 function topLevelField({ fields: _fields, ...field }) {
   return { ...field, type: field.type.replace(SHAPE, "object") };
 }
+function jsonFields(fields, options) {
+  return Object.fromEntries(
+    fields.filter(
+      (field) => options.secondary || !field.secondary || options.input && field.required
+    ).map((field) => {
+      const shape = field.fields && options.shapes.get(shapeKey(field.fields));
+      if (shape) options.used.add(shape);
+      return [
+        field.name,
+        {
+          type: field.type.replace(SHAPE, shape?.name ?? "object"),
+          ...options.input ? { required: field.required } : {},
+          ...field.means ? { means: field.means } : {},
+          ...field.example !== void 0 ? { example: field.example } : {},
+          ...field.description && field.description !== shape?.description ? { description: field.description } : {},
+          ...field.secondary ? { secondary: true } : {},
+          ...field.read ? { read: field.read } : {},
+          ...field.in ? { in: field.in } : {},
+          ...field.paths?.length ? { paths: field.paths } : {},
+          ...field.fields && !shape ? { fields: jsonFields(field.fields, options) } : {}
+        }
+      ];
+    })
+  );
+}
+function describedJson(described, view) {
+  const sections = [
+    ["inputs", described.inputs, true],
+    ["rowInputs", described.rowInputs, true],
+    ["outputs", described.outputs, false],
+    ["rowOutputs", described.rowOutputs, false]
+  ];
+  const hidden = view.secondary ? [] : sections.flatMap(
+    ([, fields, input]) => (fields ?? []).filter((field) => field.secondary && !(input && field.required)).map((field) => field.name)
+  );
+  const shapes = namedShapes(sections.flatMap(([, fields]) => fields ?? []));
+  const used = /* @__PURE__ */ new Set();
+  const blocks = Object.fromEntries(
+    sections.flatMap(
+      ([key, fields, input]) => fields?.length ? [
+        [
+          key,
+          jsonFields(fields, {
+            input,
+            secondary: view.secondary,
+            shapes,
+            used
+          })
+        ]
+      ] : []
+    )
+  );
+  const types = {};
+  for (const shape of used) {
+    types[shape.name] = {
+      ...shape.description ? { description: shape.description } : {},
+      fields: jsonFields(shape.fields, {
+        input: false,
+        secondary: true,
+        shapes,
+        used
+      })
+    };
+  }
+  const { cli, play } = examples(described, { verbose: view.verbose });
+  return {
+    kind: described.kind,
+    id: described.id,
+    ...described.displayName ? { displayName: described.displayName } : {},
+    ...described.description ? { description: described.description } : {},
+    ...described.cost ? { cost: described.cost } : {},
+    ...described.rateLimit ? { rateLimit: described.rateLimit } : {},
+    ...described.byok ? { byok: described.byok } : {},
+    ...described.guidance.length ? { guidance: described.guidance } : {},
+    ...blocks,
+    ...used.size ? { types } : {},
+    ...described.exclusive ? { exclusive: described.exclusive } : {},
+    run: { cli, ...play ? { play } : {} },
+    ...described.source ? { source: described.source } : {},
+    ...hidden.length ? { hidden } : {}
+  };
+}
 
 // src/cli/execution-observation.ts
 import { writeFileSync, renameSync } from "fs";
@@ -406,7 +582,7 @@ function addDescribeOptions(command, options = {}) {
     "Show the Deepline tool or play, not a play your workspace created under the same name"
   ).option("--tool", "Same as --prebuilt").option(
     "--verbose",
-    "Examples fill in every input and read every output, not only required ones"
+    "Show secondary fields, and fill in every input and read every output in the examples"
   ).option(
     "--cli-example",
     "Show only the CLI example, and explain how it takes inputs and returns outputs"
@@ -416,6 +592,9 @@ function addDescribeOptions(command, options = {}) {
   ).option("--no-example", "Hide the run examples").option(
     "--full-schema",
     `Print every field: a long schema unfolded (over ${SCHEMA_LINE_LIMIT} lines), list rows, and a tool's raw response`
+  ).option(
+    "--fields <names>",
+    "Show only these fields, comma-separated, plus every required input"
   ).option(
     "-o, --out <path>",
     "Save the output to this file instead of printing it"
@@ -426,6 +605,12 @@ function addDescribeOptions(command, options = {}) {
       "Print only the schema, with every field, and nothing else"
     );
   }
+  if (options.byok !== false) {
+    command.option(
+      "--byok",
+      "For a tool, also show whether it can run on your own provider credentials, and how to connect them (always shown when it must)"
+    );
+  }
   if (options.json !== false) {
     command.option(
       "--json",
@@ -436,6 +621,7 @@ function addDescribeOptions(command, options = {}) {
 }
 
 export {
+  byokLines,
   SCHEMA_LINE_LIMIT,
   schemaField,
   schemaFields,
@@ -444,6 +630,7 @@ export {
   examples,
   describedLines,
   topLevelField,
+  describedJson,
   recordApiResponse,
   recordPlayTermination,
   addDescribeOptions