@tinybirdco/sdk 0.0.11 → 0.0.13

package/src/cli/index.ts

@@ -24,12 +24,14 @@ import {
   runBranchStatus,
   runBranchDelete,
 } from "./commands/branch.js";
+import { runClear } from "./commands/clear.js";
 import {
   detectPackageManagerInstallCmd,
   detectPackageManagerRunCmd,
   hasTinybirdSdkDependency,
 } from "./utils/package-manager.js";
 import type { DevMode } from "./config.js";
+import { output } from "./output.js";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const packageJson = JSON.parse(
@@ -37,13 +39,6 @@ const packageJson = JSON.parse(
 ) as { version: string };
 const VERSION = packageJson.version;
 
-/**
- * Format timestamp for console output
- */
-function formatTime(): string {
-  return new Date().toLocaleTimeString("en-US", { hour12: false });
-}
-
 /**
  * Create and configure the CLI
  */
@@ -192,24 +187,24 @@ function createCli(): Command {
       }
 
       const modeLabel = devModeOverride === "local" ? " (local)" : "";
-      console.log(`[${formatTime()}] Building${modeLabel}...\n`);
+      output.highlight(`Building${modeLabel}...`);
 
       const result = await runBuild({
         dryRun: options.dryRun,
         devModeOverride,
       });
 
-      if (!result.success) {
-        console.error(`Error: ${result.error}`);
-        process.exit(1);
-      }
-
       const { build, deploy } = result;
 
-      if (build) {
-        console.log(
-          `Generated ${build.stats.datasourceCount} datasource(s), ${build.stats.pipeCount} pipe(s)`
-        );
+      if (!result.success) {
+        // Show detailed errors if available
+        if (deploy?.errors && deploy.errors.length > 0) {
+          output.showBuildErrors(deploy.errors);
+        } else if (result.error) {
+          output.error(result.error);
+        }
+        output.showBuildFailure();
+        process.exit(1);
       }
 
       if (options.dryRun) {
@@ -229,15 +224,40 @@ function createCli(): Command {
             console.log(pipe.content);
           });
         }
+        output.showBuildSuccess(result.durationMs);
       } else if (deploy) {
         if (deploy.result === "no_changes") {
-          console.log("No changes detected - already up to date");
+          output.showNoChanges();
         } else {
-          console.log(`Deployed to Tinybird successfully`);
+          // Show datasource changes
+          if (deploy.datasources) {
+            for (const name of deploy.datasources.created) {
+              output.showResourceChange(`${name}.datasource`, "created");
+            }
+            for (const name of deploy.datasources.changed) {
+              output.showResourceChange(`${name}.datasource`, "changed");
+            }
+            for (const name of deploy.datasources.deleted) {
+              output.showResourceChange(`${name}.datasource`, "deleted");
+            }
+          }
+
+          // Show pipe changes
+          if (deploy.pipes) {
+            for (const name of deploy.pipes.created) {
+              output.showResourceChange(`${name}.pipe`, "created");
+            }
+            for (const name of deploy.pipes.changed) {
+              output.showResourceChange(`${name}.pipe`, "changed");
+            }
+            for (const name of deploy.pipes.deleted) {
+              output.showResourceChange(`${name}.pipe`, "deleted");
+            }
+          }
+
+          output.showBuildSuccess(result.durationMs);
         }
       }
-
-      console.log(`\n[${formatTime()}] Done in ${result.durationMs}ms`);
     });
 
   // Deploy command
@@ -252,24 +272,24 @@ function createCli(): Command {
         process.env.TINYBIRD_DEBUG = "1";
       }
 
-      console.log(`[${formatTime()}] Deploying to main workspace...\n`);
+      output.highlight("Deploying to main workspace...");
 
       const result = await runDeploy({
         dryRun: options.dryRun,
         check: options.check,
       });
 
-      if (!result.success) {
-        console.error(`Error: ${result.error}`);
-        process.exit(1);
-      }
-
       const { build, deploy } = result;
 
-      if (build) {
-        console.log(
-          `Generated ${build.stats.datasourceCount} datasource(s), ${build.stats.pipeCount} pipe(s)`
-        );
+      if (!result.success) {
+        // Show detailed errors if available
+        if (deploy?.errors && deploy.errors.length > 0) {
+          output.showBuildErrors(deploy.errors);
+        } else if (result.error) {
+          output.error(result.error);
+        }
+        output.showBuildFailure();
+        process.exit(1);
       }
 
       if (options.dryRun) {
@@ -289,17 +309,43 @@ function createCli(): Command {
             console.log(pipe.content);
           });
         }
+        output.showBuildSuccess(result.durationMs);
       } else if (options.check) {
         console.log("\n[Check] Resources validated with Tinybird API");
+        output.showBuildSuccess(result.durationMs);
       } else if (deploy) {
         if (deploy.result === "no_changes") {
-          console.log("No changes detected - already up to date");
+          output.showNoChanges();
         } else {
-          console.log(`Deployed to main workspace successfully`);
+          // Show datasource changes
+          if (deploy.datasources) {
+            for (const name of deploy.datasources.created) {
+              output.showResourceChange(`${name}.datasource`, "created");
+            }
+            for (const name of deploy.datasources.changed) {
+              output.showResourceChange(`${name}.datasource`, "changed");
+            }
+            for (const name of deploy.datasources.deleted) {
+              output.showResourceChange(`${name}.datasource`, "deleted");
+            }
+          }
+
+          // Show pipe changes
+          if (deploy.pipes) {
+            for (const name of deploy.pipes.created) {
+              output.showResourceChange(`${name}.pipe`, "created");
+            }
+            for (const name of deploy.pipes.changed) {
+              output.showResourceChange(`${name}.pipe`, "changed");
+            }
+            for (const name of deploy.pipes.deleted) {
+              output.showResourceChange(`${name}.pipe`, "deleted");
+            }
+          }
+
+          output.showBuildSuccess(result.durationMs);
         }
       }
-
-      console.log(`\n[${formatTime()}] Done in ${result.durationMs}ms`);
     });
 
   // Dev command
@@ -317,9 +363,6 @@ function createCli(): Command {
         devModeOverride = "branch";
       }
 
-      console.log(`tinybird dev v${VERSION}`);
-      console.log("Loading config from tinybird.json...\n");
-
       try {
         const controller = await runDev({
           devModeOverride,
@@ -366,11 +409,18 @@ function createCli(): Command {
             }
           },
           onBuildStart: () => {
-            console.log(`[${formatTime()}] Building...`);
+            output.highlight("Building...");
           },
           onBuildComplete: (result) => {
             if (!result.success) {
-              console.error(`[${formatTime()}] Build failed: ${result.error}`);
+              // Show detailed errors if available
+              const { deploy } = result;
+              if (deploy?.errors && deploy.errors.length > 0) {
+                output.showBuildErrors(deploy.errors);
+              } else if (result.error) {
+                output.error(result.error);
+              }
+              output.showBuildFailure(true);
               return;
             }
 
@@ -378,56 +428,52 @@ function createCli(): Command {
 
             if (deploy) {
               if (deploy.result === "no_changes") {
-                console.log(`[${formatTime()}] No changes detected`);
+                output.showNoChanges();
               } else {
-                console.log(
-                  `[${formatTime()}] Built in ${result.durationMs}ms`
-                );
-
                 // Show datasource changes
                 if (deploy.datasources) {
                   for (const name of deploy.datasources.created) {
-                    console.log(`  + datasource ${name} (created)`);
+                    output.showResourceChange(`${name}.datasource`, "created");
                   }
                   for (const name of deploy.datasources.changed) {
-                    console.log(`  ~ datasource ${name} (changed)`);
+                    output.showResourceChange(`${name}.datasource`, "changed");
                   }
                   for (const name of deploy.datasources.deleted) {
-                    console.log(`  - datasource ${name} (deleted)`);
+                    output.showResourceChange(`${name}.datasource`, "deleted");
                   }
                 }
 
                 // Show pipe changes
                 if (deploy.pipes) {
                   for (const name of deploy.pipes.created) {
-                    console.log(`  + pipe ${name} (created)`);
+                    output.showResourceChange(`${name}.pipe`, "created");
                   }
                   for (const name of deploy.pipes.changed) {
-                    console.log(`  ~ pipe ${name} (changed)`);
+                    output.showResourceChange(`${name}.pipe`, "changed");
                   }
                   for (const name of deploy.pipes.deleted) {
-                    console.log(`  - pipe ${name} (deleted)`);
+                    output.showResourceChange(`${name}.pipe`, "deleted");
                   }
                 }
+
+                output.showBuildSuccess(result.durationMs, true);
               }
             }
           },
           onSchemaValidation: (validation) => {
             if (validation.issues.length > 0) {
-              console.log(`[${formatTime()}] Schema validation:`);
+              output.info("Schema validation:");
               for (const issue of validation.issues) {
                 if (issue.type === "error") {
-                  console.error(
-                    `  ERROR [${issue.pipeName}]: ${issue.message}`
-                  );
+                  output.error(`  ERROR [${issue.pipeName}]: ${issue.message}`);
                 } else {
-                  console.warn(`  WARN [${issue.pipeName}]: ${issue.message}`);
+                  output.warning(`  WARN [${issue.pipeName}]: ${issue.message}`);
                 }
               }
             }
           },
-          onError: (error) => {
-            console.error(`[${formatTime()}] Error: ${error.message}`);
+          onError: (err) => {
+            output.error(err.message);
           },
         });
 
@@ -532,6 +578,61 @@ function createCli(): Command {
 
   program.addCommand(branchCommand);
 
+  // Clear command
+  program
+    .command("clear")
+    .description("Clear the workspace or branch by deleting and recreating it")
+    .option("-y, --yes", "Skip confirmation prompt")
+    .option("--local", "Use local Tinybird container")
+    .option("--branch", "Use Tinybird cloud with branches")
+    .action(async (options) => {
+      // Determine devMode override
+      let devModeOverride: DevMode | undefined;
+      if (options.local) {
+        devModeOverride = "local";
+      } else if (options.branch) {
+        devModeOverride = "branch";
+      }
+
+      const modeLabel = devModeOverride === "local" ? "local workspace" : "branch";
+
+      // Confirmation prompt unless --yes is passed
+      if (!options.yes) {
+        const readline = await import("readline");
+        const rl = readline.createInterface({
+          input: process.stdin,
+          output: process.stdout,
+        });
+
+        const answer = await new Promise<string>((resolve) => {
+          rl.question(
+            `Are you sure you want to clear the ${modeLabel}? This will delete all resources. [y/N]: `,
+            (ans) => {
+              rl.close();
+              resolve(ans);
+            }
+          );
+        });
+
+        if (answer.toLowerCase() !== "y" && answer.toLowerCase() !== "yes") {
+          console.log("Aborted.");
+          return;
+        }
+      }
+
+      console.log(`Clearing ${modeLabel}...`);
+
+      const result = await runClear({ devModeOverride });
+
+      if (!result.success) {
+        console.error(`Error: ${result.error}`);
+        process.exit(1);
+      }
+
+      const typeLabel = result.isLocal ? "Workspace" : "Branch";
+      console.log(`${typeLabel} '${result.name}' cleared successfully.`);
+    });
+
   return program;
 }
 

package/src/cli/output.test.ts

@@ -0,0 +1,144 @@
+/**
+ * Tests for CLI output utilities
+ */
+
+import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
+import {
+  formatDuration,
+  showResourceChange,
+  showBuildErrors,
+  showBuildSuccess,
+  showBuildFailure,
+  showNoChanges,
+} from "./output.js";
+
+describe("output utilities", () => {
+  let consoleLogSpy: ReturnType<typeof vi.spyOn>;
+  let consoleErrorSpy: ReturnType<typeof vi.spyOn>;
+
+  beforeEach(() => {
+    consoleLogSpy = vi.spyOn(console, "log").mockImplementation(() => {});
+    consoleErrorSpy = vi.spyOn(console, "error").mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    consoleLogSpy.mockRestore();
+    consoleErrorSpy.mockRestore();
+  });
+
+  describe("formatDuration", () => {
+    it("formats milliseconds for durations under 1 second", () => {
+      expect(formatDuration(500)).toBe("500ms");
+      expect(formatDuration(0)).toBe("0ms");
+      expect(formatDuration(999)).toBe("999ms");
+    });
+
+    it("formats seconds for durations 1 second or more", () => {
+      expect(formatDuration(1000)).toBe("1.0s");
+      expect(formatDuration(1500)).toBe("1.5s");
+      expect(formatDuration(2345)).toBe("2.3s");
+      expect(formatDuration(10000)).toBe("10.0s");
+    });
+  });
+
+  describe("showResourceChange", () => {
+    it("shows created resource", () => {
+      showResourceChange("events.datasource", "created");
+      expect(consoleLogSpy).toHaveBeenCalledWith("✓ events.datasource created");
+    });
+
+    it("shows changed resource", () => {
+      showResourceChange("top_pages.pipe", "changed");
+      expect(consoleLogSpy).toHaveBeenCalledWith("✓ top_pages.pipe changed");
+    });
+
+    it("shows deleted resource", () => {
+      showResourceChange("old_data.datasource", "deleted");
+      expect(consoleLogSpy).toHaveBeenCalledWith("✓ old_data.datasource deleted");
+    });
+  });
+
+  describe("showBuildErrors", () => {
+    it("shows errors with filename", () => {
+      showBuildErrors([
+        { filename: "events.datasource", error: "Invalid column type" },
+      ]);
+      expect(consoleErrorSpy).toHaveBeenCalledWith("events.datasource");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("  Invalid column type");
+    });
+
+    it("shows errors without filename", () => {
+      showBuildErrors([{ error: "General build error" }]);
+      expect(consoleErrorSpy).toHaveBeenCalledWith("General build error");
+    });
+
+    it("shows multiple errors", () => {
+      showBuildErrors([
+        { filename: "a.datasource", error: "Error A" },
+        { filename: "b.pipe", error: "Error B" },
+      ]);
+      expect(consoleErrorSpy).toHaveBeenCalledWith("a.datasource");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("  Error A");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("b.pipe");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("  Error B");
+    });
+
+    it("handles multi-line errors", () => {
+      showBuildErrors([
+        { filename: "test.pipe", error: "Line 1\nLine 2\nLine 3" },
+      ]);
+      expect(consoleErrorSpy).toHaveBeenCalledWith("test.pipe");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("  Line 1");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("  Line 2");
+      expect(consoleErrorSpy).toHaveBeenCalledWith("  Line 3");
+    });
+  });
+
+  describe("showBuildSuccess", () => {
+    it("shows build success with duration in ms", () => {
+      showBuildSuccess(500);
+      expect(consoleLogSpy).toHaveBeenCalled();
+      const call = consoleLogSpy.mock.calls[0][0];
+      expect(call).toContain("✓");
+      expect(call).toContain("Build completed in 500ms");
+    });
+
+    it("shows build success with duration in seconds", () => {
+      showBuildSuccess(2500);
+      expect(consoleLogSpy).toHaveBeenCalled();
+      const call = consoleLogSpy.mock.calls[0][0];
+      expect(call).toContain("Build completed in 2.5s");
+    });
+
+    it("shows rebuild success when isRebuild is true", () => {
+      showBuildSuccess(1000, true);
+      expect(consoleLogSpy).toHaveBeenCalled();
+      const call = consoleLogSpy.mock.calls[0][0];
+      expect(call).toContain("Rebuild completed in 1.0s");
+    });
+  });
+
+  describe("showBuildFailure", () => {
+    it("shows build failure", () => {
+      showBuildFailure();
+      expect(consoleErrorSpy).toHaveBeenCalled();
+      const call = consoleErrorSpy.mock.calls[0][0];
+      expect(call).toContain("✗");
+      expect(call).toContain("Build failed");
+    });
+
+    it("shows rebuild failure when isRebuild is true", () => {
+      showBuildFailure(true);
+      expect(consoleErrorSpy).toHaveBeenCalled();
+      const call = consoleErrorSpy.mock.calls[0][0];
+      expect(call).toContain("Rebuild failed");
+    });
+  });
+
+  describe("showNoChanges", () => {
+    it("shows no changes message", () => {
+      showNoChanges();
+      expect(consoleLogSpy).toHaveBeenCalledWith("No changes. Build skipped.");
+    });
+  });
+});

package/src/cli/output.ts

@@ -0,0 +1,173 @@
+/**
+ * Console output utilities with color support
+ * Provides consistent formatting similar to the Python CLI
+ */
+
+// ANSI color codes
+const colors = {
+  reset: "\x1b[0m",
+  bold: "\x1b[1m",
+  red: "\x1b[91m",
+  green: "\x1b[92m",
+  yellow: "\x1b[38;5;208m",
+  blue: "\x1b[94m",
+  gray: "\x1b[90m",
+} as const;
+
+// Check if colors should be disabled
+const noColor = process.env.NO_COLOR !== undefined || !process.stdout.isTTY;
+
+function colorize(text: string, color: keyof typeof colors): string {
+  if (noColor) return text;
+  return `${colors[color]}${text}${colors.reset}`;
+}
+
+/**
+ * Output a success message (green)
+ */
+export function success(message: string): void {
+  console.log(colorize(message, "green"));
+}
+
+/**
+ * Output an error message (red)
+ */
+export function error(message: string): void {
+  console.error(colorize(message, "red"));
+}
+
+/**
+ * Output a warning message (yellow/orange)
+ */
+export function warning(message: string): void {
+  console.log(colorize(message, "yellow"));
+}
+
+/**
+ * Output an info message (default color)
+ */
+export function info(message: string): void {
+  console.log(message);
+}
+
+/**
+ * Output a highlighted message (blue)
+ */
+export function highlight(message: string): void {
+  console.log(colorize(message, "blue"));
+}
+
+/**
+ * Output a gray message (dimmed)
+ */
+export function gray(message: string): void {
+  console.log(colorize(message, "gray"));
+}
+
+/**
+ * Output a bold message
+ */
+export function bold(message: string): void {
+  console.log(colorize(message, "bold"));
+}
+
+/**
+ * Format a timestamp for console output
+ */
+export function formatTime(): string {
+  return new Date().toLocaleTimeString("en-US", { hour12: false });
+}
+
+/**
+ * Format duration in human-readable format
+ */
+export function formatDuration(ms: number): string {
+  if (ms < 1000) {
+    return `${ms}ms`;
+  }
+  return `${(ms / 1000).toFixed(1)}s`;
+}
+
+/**
+ * Show a resource change (checkmark + path + status)
+ */
+export function showResourceChange(
+  path: string,
+  status: "created" | "changed" | "deleted"
+): void {
+  console.log(`✓ ${path} ${status}`);
+}
+
+/**
+ * Show a warning for a resource
+ */
+export function showResourceWarning(
+  level: string,
+  resource: string,
+  message: string
+): void {
+  warning(`△ ${level}: ${resource}: ${message}`);
+}
+
+/**
+ * Show build errors in formatted style
+ */
+export function showBuildErrors(errors: Array<{ filename?: string; error: string }>): void {
+  for (const err of errors) {
+    if (err.filename) {
+      error(`${err.filename}`);
+      // Indent the error message
+      const lines = err.error.split("\n");
+      for (const line of lines) {
+        error(`  ${line}`);
+      }
+    } else {
+      error(err.error);
+    }
+    console.log(); // Empty line between errors
+  }
+}
+
+/**
+ * Show final build success message
+ */
+export function showBuildSuccess(durationMs: number, isRebuild = false): void {
+  const prefix = isRebuild ? "Rebuild" : "Build";
+  success(`\n✓ ${prefix} completed in ${formatDuration(durationMs)}`);
+}
+
+/**
+ * Show final build failure message
+ */
+export function showBuildFailure(isRebuild = false): void {
+  const prefix = isRebuild ? "Rebuild" : "Build";
+  error(`\n✗ ${prefix} failed`);
+}
+
+/**
+ * Show no changes message
+ */
+export function showNoChanges(): void {
+  info("No changes. Build skipped.");
+}
+
+/**
+ * Output object containing all output functions
+ */
+export const output = {
+  success,
+  error,
+  warning,
+  info,
+  highlight,
+  gray,
+  bold,
+  formatTime,
+  formatDuration,
+  showResourceChange,
+  showResourceWarning,
+  showBuildErrors,
+  showBuildSuccess,
+  showBuildFailure,
+  showNoChanges,
+};