@tinybirdco/sdk 0.0.3 → 0.0.6

package/src/cli/index.ts

@@ -16,6 +16,7 @@ import { dirname, resolve } from "node:path";
 import { Command } from "commander";
 import { runInit } from "./commands/init.js";
 import { runBuild } from "./commands/build.js";
+import { runDeploy } from "./commands/deploy.js";
 import { runDev } from "./commands/dev.js";
 import { runLogin } from "./commands/login.js";
 import {
@@ -23,6 +24,8 @@ import {
   runBranchStatus,
   runBranchDelete,
 } from "./commands/branch.js";
+import { detectPackageManagerRunCmd } from "./utils/package-manager.js";
+import type { DevMode } from "./config.js";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 const packageJson = JSON.parse(
@@ -54,12 +57,20 @@ function createCli(): Command {
     .description("Initialize a new Tinybird TypeScript project")
     .option("-f, --force", "Overwrite existing files")
     .option("--skip-login", "Skip browser login flow")
+    .option("-m, --mode <mode>", "Development mode: 'branch' or 'local'")
+    .option("-p, --path <path>", "Path for Tinybird client files")
     .action(async (options) => {
-      console.log("Initializing Tinybird project...\n");
+      // Validate mode if provided
+      if (options.mode && !["branch", "local"].includes(options.mode)) {
+        console.error(`Error: Invalid mode '${options.mode}'. Use 'branch' or 'local'.`);
+        process.exit(1);
+      }
 
       const result = await runInit({
         force: options.force,
         skipLogin: options.skipLogin,
+        devMode: options.mode,
+        clientPath: options.path,
       });
 
       if (!result.success) {
@@ -81,6 +92,10 @@ function createCli(): Command {
         });
       }
 
+      // Detect package manager for run command
+      const runCmd = detectPackageManagerRunCmd();
+      const clientPath = result.clientPath ?? "tinybird";
+
       if (result.loggedIn) {
         console.log(`\nLogged in successfully!`);
         if (result.workspaceName) {
@@ -89,19 +104,25 @@ function createCli(): Command {
         if (result.userEmail) {
           console.log(`  User: ${result.userEmail}`);
         }
+
+        if (result.existingDatafiles && result.existingDatafiles.length > 0) {
+          console.log(
+            `\nAdded ${result.existingDatafiles.length} existing datafile(s) to tinybird.json.`
+          );
+        }
         console.log("\nDone! Next steps:");
-        console.log("  1. Edit src/tinybird/schema.ts with your schema");
-        console.log("  2. Run 'npx tinybird dev' to start development");
+        console.log(`  1. Edit your schema in ${clientPath}/`);
+        console.log(`  2. Run '${runCmd} tinybird:dev' to start development`);
       } else if (result.loggedIn === false) {
         console.log("\nLogin was skipped or failed.");
         console.log("\nDone! Next steps:");
         console.log("  1. Run 'npx tinybird login' to authenticate");
-        console.log("  2. Edit src/tinybird/schema.ts with your schema");
-        console.log("  3. Run 'npx tinybird dev' to start development");
+        console.log(`  2. Edit your schema in ${clientPath}/`);
+        console.log(`  3. Run '${runCmd} tinybird:dev' to start development`);
       } else {
         console.log("\nDone! Next steps:");
-        console.log("  1. Edit src/tinybird/schema.ts with your schema");
-        console.log("  2. Run 'npx tinybird dev' to start development");
+        console.log(`  1. Edit your schema in ${clientPath}/`);
+        console.log(`  2. Run '${runCmd} tinybird:dev' to start development`);
       }
     });
 
@@ -134,17 +155,27 @@ function createCli(): Command {
   // Build command
   program
     .command("build")
-    .description("Build and push resources to Tinybird")
+    .description("Build and push resources to a Tinybird branch (not main)")
     .option("--dry-run", "Generate without pushing to API")
     .option("--debug", "Show debug output including API requests/responses")
+    .option("--local", "Use local Tinybird container")
     .action(async (options) => {
       if (options.debug) {
         process.env.TINYBIRD_DEBUG = "1";
       }
-      console.log(`[${formatTime()}] Building...\n`);
+
+      // Determine devMode override
+      let devModeOverride: DevMode | undefined;
+      if (options.local) {
+        devModeOverride = "local";
+      }
+
+      const modeLabel = devModeOverride === "local" ? " (local)" : "";
+      console.log(`[${formatTime()}] Building${modeLabel}...\n`);
 
       const result = await runBuild({
         dryRun: options.dryRun,
+        devModeOverride,
       });
 
       if (!result.success) {
@@ -186,16 +217,83 @@ function createCli(): Command {
       console.log(`\n[${formatTime()}] Done in ${result.durationMs}ms`);
     });
 
+  // Deploy command
+  program
+    .command("deploy")
+    .description("Deploy resources to main Tinybird workspace (production)")
+    .option("--dry-run", "Generate without pushing to API")
+    .option("--debug", "Show debug output including API requests/responses")
+    .action(async (options) => {
+      if (options.debug) {
+        process.env.TINYBIRD_DEBUG = "1";
+      }
+
+      console.log(`[${formatTime()}] Deploying to main workspace...\n`);
+
+      const result = await runDeploy({
+        dryRun: options.dryRun,
+      });
+
+      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 (options.dryRun) {
+        console.log("\n[Dry run] Resources not deployed to API");
+
+        // Show generated content
+        if (build) {
+          console.log("\n--- Generated Datasources ---");
+          build.resources.datasources.forEach((ds) => {
+            console.log(`\n${ds.name}.datasource:`);
+            console.log(ds.content);
+          });
+
+          console.log("\n--- Generated Pipes ---");
+          build.resources.pipes.forEach((pipe) => {
+            console.log(`\n${pipe.name}.pipe:`);
+            console.log(pipe.content);
+          });
+        }
+      } else if (deploy) {
+        if (deploy.result === "no_changes") {
+          console.log("No changes detected - already up to date");
+        } else {
+          console.log(`Deployed to main workspace successfully`);
+        }
+      }
+
+      console.log(`\n[${formatTime()}] Done in ${result.durationMs}ms`);
+    });
+
   // Dev command
   program
     .command("dev")
     .description("Watch for changes and sync with Tinybird")
-    .action(async () => {
+    .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";
+      }
+
       console.log(`tinybird dev v${VERSION}`);
       console.log("Loading config from tinybird.json...\n");
 
       try {
         const controller = await runDev({
+          devModeOverride,
           onLoginComplete: (info) => {
             console.log("\nAuthentication successful!");
             if (info.workspaceName) {
@@ -207,7 +305,18 @@ function createCli(): Command {
             console.log("");
           },
           onBranchReady: (info) => {
-            if (info.isMainBranch) {
+            if (info.isLocal) {
+              // Local mode
+              const workspaceName = info.localWorkspace?.name ?? "unknown";
+              if (info.wasCreated) {
+                console.log(`Using local Tinybird container`);
+                console.log(`Creating local workspace '${workspaceName}'...`);
+                console.log("Workspace created.\n");
+              } else {
+                console.log(`Using local Tinybird container`);
+                console.log(`Using existing local workspace '${workspaceName}'\n`);
+              }
+            } else if (info.isMainBranch) {
               console.log("On main branch - deploying to workspace\n");
             } else if (info.gitBranch) {
               const tinybirdName = info.tinybirdBranch?.name ?? info.gitBranch;

package/src/cli/utils/package-manager.test.ts

@@ -0,0 +1,118 @@
+import { describe, it, expect, beforeEach, afterEach } from "vitest";
+import * as fs from "fs";
+import * as path from "path";
+import * as os from "os";
+import { detectPackageManagerRunCmd } from "./package-manager.js";
+
+describe("detectPackageManagerRunCmd", () => {
+  let tempDir: string;
+
+  beforeEach(() => {
+    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), "pkg-manager-test-"));
+  });
+
+  afterEach(() => {
+    try {
+      fs.rmSync(tempDir, { recursive: true });
+    } catch {
+      // Ignore cleanup errors
+    }
+  });
+
+  describe("lockfile detection", () => {
+    it("detects pnpm from pnpm-lock.yaml", () => {
+      fs.writeFileSync(path.join(tempDir, "pnpm-lock.yaml"), "");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("pnpm");
+    });
+
+    it("detects yarn from yarn.lock", () => {
+      fs.writeFileSync(path.join(tempDir, "yarn.lock"), "");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+    });
+
+    it("detects bun from bun.lockb", () => {
+      fs.writeFileSync(path.join(tempDir, "bun.lockb"), "");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("bun run");
+    });
+
+    it("detects npm from package-lock.json", () => {
+      fs.writeFileSync(path.join(tempDir, "package-lock.json"), "{}");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+    });
+
+    it("prioritizes pnpm lockfile over others", () => {
+      fs.writeFileSync(path.join(tempDir, "pnpm-lock.yaml"), "");
+      fs.writeFileSync(path.join(tempDir, "yarn.lock"), "");
+      fs.writeFileSync(path.join(tempDir, "package-lock.json"), "{}");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("pnpm");
+    });
+
+    it("prioritizes yarn lockfile over npm", () => {
+      fs.writeFileSync(path.join(tempDir, "yarn.lock"), "");
+      fs.writeFileSync(path.join(tempDir, "package-lock.json"), "{}");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+    });
+  });
+
+  describe("packageManager field detection", () => {
+    it("detects pnpm from packageManager field", () => {
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ packageManager: "pnpm@9.0.0" })
+      );
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("pnpm");
+    });
+
+    it("detects yarn from packageManager field", () => {
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ packageManager: "yarn@4.0.0" })
+      );
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+    });
+
+    it("detects bun from packageManager field", () => {
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ packageManager: "bun@1.0.0" })
+      );
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("bun run");
+    });
+
+    it("prioritizes lockfile over packageManager field", () => {
+      fs.writeFileSync(path.join(tempDir, "yarn.lock"), "");
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ packageManager: "pnpm@9.0.0" })
+      );
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+    });
+  });
+
+  describe("default behavior", () => {
+    it("defaults to npm run when no indicators found", () => {
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+    });
+
+    it("defaults to npm run when package.json has no packageManager field", () => {
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ name: "test-project" })
+      );
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+    });
+
+    it("defaults to npm run when package.json is invalid JSON", () => {
+      fs.writeFileSync(path.join(tempDir, "package.json"), "not json");
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+    });
+
+    it("defaults to npm run when packageManager is not a string", () => {
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ packageManager: 123 })
+      );
+      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+    });
+  });
+});

package/src/cli/utils/package-manager.ts

@@ -0,0 +1,44 @@
+/**
+ * Package manager detection utilities
+ */
+
+import { existsSync, readFileSync } from "node:fs";
+import { join } from "node:path";
+
+/**
+ * Detect package manager and return the appropriate run command
+ */
+export function detectPackageManagerRunCmd(cwd: string = process.cwd()): string {
+  // Check lockfiles first (most reliable)
+  if (existsSync(join(cwd, "pnpm-lock.yaml"))) {
+    return "pnpm";
+  }
+  if (existsSync(join(cwd, "yarn.lock"))) {
+    return "yarn";
+  }
+  if (existsSync(join(cwd, "bun.lockb"))) {
+    return "bun run";
+  }
+  if (existsSync(join(cwd, "package-lock.json"))) {
+    return "npm run";
+  }
+
+  // Check packageManager field in package.json
+  const packageJsonPath = join(cwd, "package.json");
+  if (existsSync(packageJsonPath)) {
+    try {
+      const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+      const pm = packageJson.packageManager;
+      if (typeof pm === "string") {
+        if (pm.startsWith("pnpm")) return "pnpm";
+        if (pm.startsWith("yarn")) return "yarn";
+        if (pm.startsWith("bun")) return "bun run";
+      }
+    } catch {
+      // Ignore parse errors
+    }
+  }
+
+  // Default to npm
+  return "npm run";
+}