@zapier/zapier-sdk-cli 0.9.0 → 0.11.0

package/src/utils/schema-formatter.ts

@@ -1,11 +1,15 @@
 import chalk from "chalk";
 import type { z } from "zod";
+import util from "util";
 // These functions are internal to SDK, implementing basic formatting fallback
 // TODO: Consider exposing these utilities or implementing proper CLI formatting
 
 interface FormattedItem {
   title: string;
-  subtitle?: string;
+  id?: string;
+  key?: string;
+  description?: string;
+  data?: unknown; // Optional: if provided, use formatJsonOutput instead of details
   details: Array<{
     text: string;
     style: "normal" | "dim" | "accent" | "warning" | "success";
@@ -25,17 +29,34 @@ function getOutputSchema(schema: unknown): unknown {
   return (schema as { _def?: { outputSchema?: unknown } })?._def?.outputSchema;
 }
 
+// ============================================================================
+// JSON Formatting
+// ============================================================================
+
+export function formatJsonOutput(data: unknown): void {
+  // Don't print anything for undefined results (commands that just perform actions)
+  if (data === undefined) {
+    return;
+  }
+
+  // Use util.inspect for colored output
+  console.log(
+    util.inspect(data, { colors: true, depth: null, breakLength: 80 }),
+  );
+}
+
 // ============================================================================
 // Generic Schema-Driven Formatter
 // ============================================================================
 
 export function formatItemsFromSchema(
-  inputSchema: z.ZodType,
+  functionInfo: { inputSchema: z.ZodType; outputSchema?: z.ZodType },
   items: unknown[],
   startingNumber: number = 0,
 ): void {
-  // Get the output schema and its format metadata
-  const outputSchema = getOutputSchema(inputSchema);
+  // Get the output schema from function info or fall back to input schema output schema
+  const outputSchema =
+    functionInfo.outputSchema || getOutputSchema(functionInfo.inputSchema);
   if (!outputSchema) {
     // Fallback to generic formatting if no output schema
     formatItemsGeneric(items, startingNumber);
@@ -51,25 +72,35 @@ export function formatItemsFromSchema(
 
   // Format each item using the schema metadata
   items.forEach((item, index) => {
-    formatSingleItem(item, startingNumber + index, formatMeta);
+    const formatted = formatMeta.format(item);
+    formatSingleItem(formatted, startingNumber + index);
   });
 }
 
-function formatSingleItem(
-  item: unknown,
-  itemNumber: number,
-  formatMeta: FormatMetadata,
-): void {
-  // Get the formatted item from the format function
-  const formatted = formatMeta.format(item);
-
-  // Build the main title line
+function formatSingleItem(formatted: FormattedItem, itemNumber: number): void {
+  // Build the main title line with optional subtitle
   let titleLine = `${chalk.gray(`${itemNumber + 1}.`)} ${chalk.cyan(formatted.title)}`;
-  if (formatted.subtitle) {
-    titleLine += ` ${chalk.gray(formatted.subtitle)}`;
+
+  // Generate subtitle from id or key
+  if (formatted.id) {
+    titleLine += ` ${chalk.gray(`(ID: ${formatted.id})`)}`;
+  } else if (formatted.key) {
+    titleLine += ` ${chalk.gray(`(${formatted.key})`)}`;
   }
   console.log(titleLine);
 
+  // Show description if available
+  if (formatted.description) {
+    console.log(`   ${chalk.dim(formatted.description)}`);
+  }
+
+  // If data is provided, use JSON formatting instead of details
+  if (formatted.data !== undefined) {
+    formatJsonOutput(formatted.data);
+    console.log(); // Empty line between items
+    return;
+  }
+
   // Format detail lines
   for (const detail of formatted.details) {
     const styledText = applyStyle(detail.text, detail.style);
@@ -95,27 +126,31 @@ function applyStyle(value: string, style: string): string {
   }
 }
 
+function convertGenericItemToFormattedItem(item: unknown): FormattedItem {
+  const itemObj = item as {
+    title?: string;
+    name?: string;
+    key?: string;
+    id?: string;
+    description?: string;
+  };
+
+  return {
+    title: itemObj.title || itemObj.name || itemObj.key || itemObj.id || "Item",
+    id: itemObj.id,
+    key: itemObj.key,
+    description: itemObj.description,
+    details: [],
+  };
+}
+
 function formatItemsGeneric(
   items: unknown[],
   startingNumber: number = 0,
 ): void {
-  // Fallback formatting for items without schema metadata
+  // Convert generic items to FormattedItem and use formatSingleItem
   items.forEach((item, index) => {
-    const itemObj = item as {
-      title?: string;
-      name?: string;
-      key?: string;
-      id?: string;
-      description?: string;
-    };
-    const name =
-      itemObj.title || itemObj.name || itemObj.key || itemObj.id || "Item";
-    console.log(
-      `${chalk.gray(`${startingNumber + index + 1}.`)} ${chalk.cyan(name)}`,
-    );
-    if (itemObj.description) {
-      console.log(`   ${chalk.dim(itemObj.description)}`);
-    }
-    console.log();
+    const formatted = convertGenericItemToFormattedItem(item);
+    formatSingleItem(formatted, startingNumber + index);
   });
 }