@tinybirdco/sdk 0.0.7 → 0.0.9

package/src/cli/config.test.ts

@@ -4,10 +4,8 @@ import * as path from "path";
 import * as os from "os";
 import {
   hasSrcFolder,
-  getLibDir,
-  getRelativeLibDir,
-  getTinybirdSchemaPath,
-  getRelativeSchemaPath,
+  getTinybirdDir,
+  getRelativeTinybirdDir,
   findConfigFile,
   loadConfig,
   getConfigPath,
@@ -50,55 +48,27 @@ describe("Config", () => {
     });
   });
 
-  describe("getLibDir", () => {
-    it("returns src/tinybird when project has src folder", () => {
+  describe("getTinybirdDir", () => {
+    it("returns src/lib when project has src folder", () => {
       fs.mkdirSync(path.join(tempDir, "src"));
 
-      expect(getLibDir(tempDir)).toBe(path.join(tempDir, "src", "tinybird"));
+      expect(getTinybirdDir(tempDir)).toBe(path.join(tempDir, "src", "lib"));
     });
 
-    it("returns tinybird when project does not have src folder", () => {
-      expect(getLibDir(tempDir)).toBe(path.join(tempDir, "tinybird"));
+    it("returns lib when project does not have src folder", () => {
+      expect(getTinybirdDir(tempDir)).toBe(path.join(tempDir, "lib"));
     });
   });
 
-  describe("getRelativeLibDir", () => {
-    it("returns src/tinybird when project has src folder", () => {
+  describe("getRelativeTinybirdDir", () => {
+    it("returns src/lib/tinybird.ts when project has src folder", () => {
       fs.mkdirSync(path.join(tempDir, "src"));
 
-      expect(getRelativeLibDir(tempDir)).toBe("src/tinybird");
+      expect(getRelativeTinybirdDir(tempDir)).toBe("src/lib/tinybird.ts");
     });
 
-    it("returns tinybird when project does not have src folder", () => {
-      expect(getRelativeLibDir(tempDir)).toBe("tinybird");
-    });
-  });
-
-  describe("getTinybirdSchemaPath", () => {
-    it("returns src/tinybird/datasources.ts when project has src folder", () => {
-      fs.mkdirSync(path.join(tempDir, "src"));
-
-      expect(getTinybirdSchemaPath(tempDir)).toBe(
-        path.join(tempDir, "src", "tinybird", "datasources.ts")
-      );
-    });
-
-    it("returns tinybird/datasources.ts when project does not have src folder", () => {
-      expect(getTinybirdSchemaPath(tempDir)).toBe(
-        path.join(tempDir, "tinybird", "datasources.ts")
-      );
-    });
-  });
-
-  describe("getRelativeSchemaPath", () => {
-    it("returns src/tinybird/datasources.ts when project has src folder", () => {
-      fs.mkdirSync(path.join(tempDir, "src"));
-
-      expect(getRelativeSchemaPath(tempDir)).toBe("src/tinybird/datasources.ts");
-    });
-
-    it("returns tinybird/datasources.ts when project does not have src folder", () => {
-      expect(getRelativeSchemaPath(tempDir)).toBe("tinybird/datasources.ts");
+    it("returns lib/tinybird.ts when project does not have src folder", () => {
+      expect(getRelativeTinybirdDir(tempDir)).toBe("lib/tinybird.ts");
     });
   });
 

package/src/cli/config.ts

@@ -69,9 +69,9 @@ export const LOCAL_BASE_URL = "http://localhost:7181";
 const CONFIG_FILE = "tinybird.json";
 
 /**
- * Tinybird folder name
+ * Tinybird file path within lib folder
  */
-const TINYBIRD_FOLDER = "tinybird";
+const TINYBIRD_FILE = "lib/tinybird.ts";
 
 /**
  * Detect if project has a src folder
@@ -82,18 +82,20 @@ export function hasSrcFolder(cwd: string): boolean {
 }
 
 /**
- * Get the tinybird directory path based on project structure
- * Returns 'src/tinybird' if project has src folder, otherwise 'tinybird'
+ * Get the tinybird file path based on project structure
+ * Returns 'src/lib/tinybird.ts' if project has src folder, otherwise 'lib/tinybird.ts'
  */
 export function getTinybirdDir(cwd: string): string {
-  return hasSrcFolder(cwd) ? path.join(cwd, "src", TINYBIRD_FOLDER) : path.join(cwd, TINYBIRD_FOLDER);
+  return hasSrcFolder(cwd)
+    ? path.join(cwd, "src", "lib")
+    : path.join(cwd, "lib");
 }
 
 /**
- * Get the relative tinybird directory path based on project structure
+ * Get the relative tinybird file path based on project structure
  */
 export function getRelativeTinybirdDir(cwd: string): string {
-  return hasSrcFolder(cwd) ? `src/${TINYBIRD_FOLDER}` : TINYBIRD_FOLDER;
+  return hasSrcFolder(cwd) ? `src/${TINYBIRD_FILE}` : TINYBIRD_FILE;
 }
 
 /**
@@ -117,22 +119,6 @@ export function getClientPath(cwd: string): string {
   return path.join(getTinybirdDir(cwd), "client.ts");
 }
 
-// Legacy exports for backwards compatibility
-export function getLibDir(cwd: string): string {
-  return getTinybirdDir(cwd);
-}
-
-export function getRelativeLibDir(cwd: string): string {
-  return getRelativeTinybirdDir(cwd);
-}
-
-export function getTinybirdSchemaPath(cwd: string): string {
-  return getDatasourcesPath(cwd);
-}
-
-export function getRelativeSchemaPath(cwd: string): string {
-  return `${getRelativeTinybirdDir(cwd)}/datasources.ts`;
-}
 
 /**
  * Interpolate environment variables in a string

package/src/cli/git.ts

@@ -97,6 +97,21 @@ export function isGitRepo(): boolean {
   }
 }
 
+/**
+ * Get the root directory of the git repository
+ * Returns null if not in a git repo
+ */
+export function getGitRoot(): string | null {
+  try {
+    return execSync("git rev-parse --show-toplevel", {
+      encoding: "utf-8",
+      stdio: ["pipe", "pipe", "pipe"],
+    }).trim();
+  } catch {
+    return null;
+  }
+}
+
 /**
  * Sanitize a git branch name for use as a Tinybird branch name
  * Tinybird only accepts alphanumeric characters and underscores

package/src/cli/index.ts

@@ -12,7 +12,7 @@ config({ path: ".env" });
 
 import { readFileSync } from "node:fs";
 import { fileURLToPath } from "node:url";
-import { dirname, resolve } from "node:path";
+import { dirname, join, resolve } from "node:path";
 import { Command } from "commander";
 import { runInit } from "./commands/init.js";
 import { runBuild } from "./commands/build.js";
@@ -24,7 +24,11 @@ import {
   runBranchStatus,
   runBranchDelete,
 } from "./commands/branch.js";
-import { detectPackageManagerRunCmd } from "./utils/package-manager.js";
+import {
+  detectPackageManagerInstallCmd,
+  detectPackageManagerRunCmd,
+  hasTinybirdSdkDependency,
+} from "./utils/package-manager.js";
 import type { DevMode } from "./config.js";
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
@@ -80,23 +84,14 @@ function createCli(): Command {
         process.exit(1);
       }
 
-      if (result.created.length > 0) {
-        console.log("Created:");
-        result.created.forEach((file) => {
-          console.log(`  - ${file}`);
-        });
-      }
-
-      if (result.skipped.length > 0) {
-        console.log("\nSkipped (already exists):");
-        result.skipped.forEach((file) => {
-          console.log(`  - ${file}`);
-        });
-      }
-
       // Detect package manager for run command
-      const runCmd = detectPackageManagerRunCmd();
       const clientPath = result.clientPath ?? "tinybird";
+      const sdkCheckDir = result.clientPath
+        ? dirname(join(process.cwd(), clientPath))
+        : process.cwd();
+      const runCmd = detectPackageManagerRunCmd(sdkCheckDir);
+      const installCmd = detectPackageManagerInstallCmd(sdkCheckDir);
+      const needsInstallStep = !hasTinybirdSdkDependency(sdkCheckDir);
 
       if (result.loggedIn) {
         console.log(`\nLogged in successfully!`);
@@ -112,19 +107,43 @@ function createCli(): Command {
             `\nAdded ${result.existingDatafiles.length} existing datafile(s) to tinybird.json.`
           );
         }
-        console.log("\nDone! Next steps:");
-        console.log(`  1. Edit your schema in ${clientPath}/`);
-        console.log(`  2. Run '${runCmd} tinybird:dev' to start development`);
+        console.log("\nNext steps:");
+        const steps = [
+          needsInstallStep
+            ? `Install dependencies with '${installCmd}'`
+            : undefined,
+          `Edit your schema in ${clientPath}`,
+          `Run '${runCmd} tinybird:dev' to start development`,
+        ].filter(Boolean);
+        steps.forEach((step, index) => {
+          console.log(`  ${index + 1}. ${step}`);
+        });
       } 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 your schema in ${clientPath}/`);
-        console.log(`  3. Run '${runCmd} tinybird:dev' to start development`);
+        console.log("\nNext steps:");
+        const steps = [
+          "Run 'npx tinybird login' to authenticate",
+          needsInstallStep
+            ? `Install dependencies with '${installCmd}'`
+            : undefined,
+          `Edit your schema in ${clientPath}`,
+          `Run '${runCmd} tinybird:dev' to start development`,
+        ].filter(Boolean);
+        steps.forEach((step, index) => {
+          console.log(`  ${index + 1}. ${step}`);
+        });
       } else {
-        console.log("\nDone! Next steps:");
-        console.log(`  1. Edit your schema in ${clientPath}/`);
-        console.log(`  2. Run '${runCmd} tinybird:dev' to start development`);
+        console.log("\nNext steps:");
+        const steps = [
+          needsInstallStep
+            ? `Install dependencies with '${installCmd}'`
+            : undefined,
+          `Edit your schema in ${clientPath}`,
+          `Run '${runCmd} tinybird:dev' to start development`,
+        ].filter(Boolean);
+        steps.forEach((step, index) => {
+          console.log(`  ${index + 1}. ${step}`);
+        });
       }
     });
 

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

@@ -2,55 +2,62 @@ 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-"));
-  });
+import {
+  detectPackageManager,
+  detectPackageManagerInstallCmd,
+  detectPackageManagerRunCmd,
+  getPackageManagerInstallCmd,
+  getPackageManagerRunCmd,
+  hasTinybirdSdkDependency,
+} from "./package-manager.js";
+
+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
-    }
-  });
+afterEach(() => {
+  try {
+    fs.rmSync(tempDir, { recursive: true });
+  } catch {
+    // Ignore cleanup errors
+  }
+});
 
+describe("detectPackageManager", () => {
   describe("lockfile detection", () => {
     it("detects pnpm from pnpm-lock.yaml", () => {
       fs.writeFileSync(path.join(tempDir, "pnpm-lock.yaml"), "");
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("pnpm");
+      expect(detectPackageManager(tempDir)).toBe("pnpm");
     });
 
     it("detects yarn from yarn.lock", () => {
       fs.writeFileSync(path.join(tempDir, "yarn.lock"), "");
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+      expect(detectPackageManager(tempDir)).toBe("yarn");
     });
 
     it("detects bun from bun.lockb", () => {
       fs.writeFileSync(path.join(tempDir, "bun.lockb"), "");
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("bun run");
+      expect(detectPackageManager(tempDir)).toBe("bun");
     });
 
     it("detects npm from package-lock.json", () => {
       fs.writeFileSync(path.join(tempDir, "package-lock.json"), "{}");
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+      expect(detectPackageManager(tempDir)).toBe("npm");
     });
 
     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");
+      expect(detectPackageManager(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");
+      expect(detectPackageManager(tempDir)).toBe("yarn");
     });
   });
 
@@ -60,7 +67,7 @@ describe("detectPackageManagerRunCmd", () => {
         path.join(tempDir, "package.json"),
         JSON.stringify({ packageManager: "pnpm@9.0.0" })
       );
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("pnpm");
+      expect(detectPackageManager(tempDir)).toBe("pnpm");
     });
 
     it("detects yarn from packageManager field", () => {
@@ -68,7 +75,7 @@ describe("detectPackageManagerRunCmd", () => {
         path.join(tempDir, "package.json"),
         JSON.stringify({ packageManager: "yarn@4.0.0" })
       );
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+      expect(detectPackageManager(tempDir)).toBe("yarn");
     });
 
     it("detects bun from packageManager field", () => {
@@ -76,7 +83,15 @@ describe("detectPackageManagerRunCmd", () => {
         path.join(tempDir, "package.json"),
         JSON.stringify({ packageManager: "bun@1.0.0" })
       );
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("bun run");
+      expect(detectPackageManager(tempDir)).toBe("bun");
+    });
+
+    it("detects npm from packageManager field", () => {
+      fs.writeFileSync(
+        path.join(tempDir, "package.json"),
+        JSON.stringify({ packageManager: "npm@10.0.0" })
+      );
+      expect(detectPackageManager(tempDir)).toBe("npm");
     });
 
     it("prioritizes lockfile over packageManager field", () => {
@@ -85,34 +100,151 @@ describe("detectPackageManagerRunCmd", () => {
         path.join(tempDir, "package.json"),
         JSON.stringify({ packageManager: "pnpm@9.0.0" })
       );
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("yarn");
+      expect(detectPackageManager(tempDir)).toBe("yarn");
+    });
+  });
+
+  describe("monorepo detection", () => {
+    it("detects pnpm from workspace root when inside a package", () => {
+      const repoRoot = path.join(tempDir, "repo");
+      const packageDir = path.join(repoRoot, "packages", "app");
+      fs.mkdirSync(packageDir, { recursive: true });
+      fs.writeFileSync(path.join(repoRoot, "pnpm-workspace.yaml"), "packages:\n  - packages/*\n");
+      fs.writeFileSync(path.join(repoRoot, "pnpm-lock.yaml"), "");
+      expect(detectPackageManager(packageDir)).toBe("pnpm");
+    });
+
+    it("detects pnpm from workspace config even without a lockfile", () => {
+      const repoRoot = path.join(tempDir, "repo");
+      const packageDir = path.join(repoRoot, "packages", "app");
+      fs.mkdirSync(packageDir, { recursive: true });
+      fs.writeFileSync(path.join(repoRoot, "pnpm-workspace.yaml"), "packages:\n  - packages/*\n");
+      expect(detectPackageManager(packageDir)).toBe("pnpm");
+    });
+
+    it("prefers the nearest lockfile in nested packages", () => {
+      const repoRoot = path.join(tempDir, "repo");
+      const packageDir = path.join(repoRoot, "packages", "app");
+      fs.mkdirSync(packageDir, { recursive: true });
+      fs.writeFileSync(path.join(repoRoot, "pnpm-lock.yaml"), "");
+      fs.writeFileSync(path.join(packageDir, "yarn.lock"), "");
+      expect(detectPackageManager(packageDir)).toBe("yarn");
     });
   });
 
   describe("default behavior", () => {
-    it("defaults to npm run when no indicators found", () => {
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+    it("defaults to npm when no indicators found", () => {
+      expect(detectPackageManager(tempDir)).toBe("npm");
     });
 
-    it("defaults to npm run when package.json has no packageManager field", () => {
+    it("defaults to npm 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");
+      expect(detectPackageManager(tempDir)).toBe("npm");
     });
 
-    it("defaults to npm run when package.json is invalid JSON", () => {
+    it("defaults to npm when package.json is invalid JSON", () => {
       fs.writeFileSync(path.join(tempDir, "package.json"), "not json");
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+      expect(detectPackageManager(tempDir)).toBe("npm");
     });
 
-    it("defaults to npm run when packageManager is not a string", () => {
+    it("defaults to npm when packageManager is not a string", () => {
       fs.writeFileSync(
         path.join(tempDir, "package.json"),
         JSON.stringify({ packageManager: 123 })
       );
-      expect(detectPackageManagerRunCmd(tempDir)).toBe("npm run");
+      expect(detectPackageManager(tempDir)).toBe("npm");
     });
   });
 });
+
+describe("getPackageManagerRunCmd", () => {
+  it("maps npm to npm run", () => {
+    expect(getPackageManagerRunCmd("npm")).toBe("npm run");
+  });
+
+  it("maps pnpm to pnpm run", () => {
+    expect(getPackageManagerRunCmd("pnpm")).toBe("pnpm run");
+  });
+
+  it("maps yarn to yarn", () => {
+    expect(getPackageManagerRunCmd("yarn")).toBe("yarn");
+  });
+
+  it("maps bun to bun run", () => {
+    expect(getPackageManagerRunCmd("bun")).toBe("bun run");
+  });
+});
+
+describe("getPackageManagerInstallCmd", () => {
+  it("maps npm to npm install", () => {
+    expect(getPackageManagerInstallCmd("npm")).toBe("npm install");
+  });
+
+  it("maps pnpm to pnpm install", () => {
+    expect(getPackageManagerInstallCmd("pnpm")).toBe("pnpm install");
+  });
+
+  it("maps yarn to yarn install", () => {
+    expect(getPackageManagerInstallCmd("yarn")).toBe("yarn install");
+  });
+
+  it("maps bun to bun install", () => {
+    expect(getPackageManagerInstallCmd("bun")).toBe("bun install");
+  });
+});
+
+describe("detectPackageManagerInstallCmd", () => {
+  it("detects install command based on lockfile", () => {
+    fs.writeFileSync(path.join(tempDir, "yarn.lock"), "");
+    expect(detectPackageManagerInstallCmd(tempDir)).toBe("yarn install");
+  });
+});
+
+describe("hasTinybirdSdkDependency", () => {
+  it("returns true when sdk is in dependencies", () => {
+    fs.writeFileSync(
+      path.join(tempDir, "package.json"),
+      JSON.stringify({ dependencies: { "@tinybirdco/sdk": "^1.0.0" } })
+    );
+    expect(hasTinybirdSdkDependency(tempDir)).toBe(true);
+  });
+
+  it("returns true when sdk is in devDependencies", () => {
+    fs.writeFileSync(
+      path.join(tempDir, "package.json"),
+      JSON.stringify({ devDependencies: { "@tinybirdco/sdk": "^1.0.0" } })
+    );
+    expect(hasTinybirdSdkDependency(tempDir)).toBe(true);
+  });
+
+  it("returns false when package.json is missing or invalid", () => {
+    expect(hasTinybirdSdkDependency(tempDir)).toBe(false);
+    fs.writeFileSync(path.join(tempDir, "package.json"), "not json");
+    expect(hasTinybirdSdkDependency(tempDir)).toBe(false);
+  });
+
+  it("checks the nearest package.json", () => {
+    const repoRoot = path.join(tempDir, "repo");
+    const packageDir = path.join(repoRoot, "packages", "app");
+    fs.mkdirSync(packageDir, { recursive: true });
+    fs.writeFileSync(
+      path.join(repoRoot, "package.json"),
+      JSON.stringify({ dependencies: { "@tinybirdco/sdk": "^1.0.0" } })
+    );
+    fs.writeFileSync(
+      path.join(packageDir, "package.json"),
+      JSON.stringify({ dependencies: { other: "^1.0.0" } })
+    );
+    expect(hasTinybirdSdkDependency(packageDir)).toBe(false);
+  });
+});
+
+describe("detectPackageManagerRunCmd", () => {
+  it("uses the package manager detection and mapping", () => {
+    fs.writeFileSync(path.join(tempDir, "pnpm-lock.yaml"), "");
+    expect(detectPackageManagerRunCmd(tempDir)).toBe("pnpm run");
+  });
+});