@tinybirdco/sdk 0.0.3 → 0.0.6

package/src/cli/commands/init.ts

@@ -4,12 +4,14 @@
 
 import * as fs from "fs";
 import * as path from "path";
+import * as p from "@clack/prompts";
+import pc from "picocolors";
 import {
   hasValidToken,
-  getTinybirdDir,
   getRelativeTinybirdDir,
   getConfigPath,
   updateConfig,
+  type DevMode,
 } from "../config.js";
 import { browserLogin } from "../auth.js";
 import { saveTinybirdToken } from "../env.js";
@@ -40,9 +42,9 @@ export type PageViewsRow = InferRow<typeof pageViews>;
 `;
 
 /**
- * Default starter content for pipes.ts
+ * Default starter content for endpoints.ts
  */
-const PIPES_CONTENT = `import { defineEndpoint, node, t, p, type InferParams, type InferOutputRow } from "@tinybirdco/sdk";
+const ENDPOINTS_CONTENT = `import { defineEndpoint, node, t, p, type InferParams, type InferOutputRow } from "@tinybirdco/sdk";
 
 /**
  * Top pages endpoint - get the most visited pages
@@ -88,7 +90,7 @@ const CLIENT_CONTENT = `/**
  * Tinybird Client
  *
  * This file defines the typed Tinybird client for your project.
- * Add your datasources and pipes here as you create them.
+ * Add your datasources and endpoints here as you create them.
  */
 
 import { createTinybirdClient } from "@tinybirdco/sdk";
@@ -97,7 +99,7 @@ import { createTinybirdClient } from "@tinybirdco/sdk";
 import { pageViews, type PageViewsRow } from "./datasources";
 
 // Import endpoints and their types
-import { topPages, type TopPagesParams, type TopPagesOutput } from "./pipes";
+import { topPages, type TopPagesParams, type TopPagesOutput } from "./endpoints";
 
 // Create the typed Tinybird client
 export const tinybird = createTinybirdClient({
@@ -115,14 +117,21 @@ export { pageViews, topPages };
 /**
  * Default config content generator
  */
-function createDefaultConfig(tinybirdDir: string) {
+function createDefaultConfig(
+  tinybirdDir: string,
+  devMode: DevMode,
+  additionalIncludes: string[] = []
+) {
+  const include = [
+    `${tinybirdDir}/datasources.ts`,
+    `${tinybirdDir}/endpoints.ts`,
+    ...additionalIncludes,
+  ];
   return {
-    include: [
-      `${tinybirdDir}/datasources.ts`,
-      `${tinybirdDir}/pipes.ts`,
-    ],
+    include,
     token: "${TINYBIRD_TOKEN}",
     baseUrl: "https://api.tinybird.co",
+    devMode,
   };
 }
 
@@ -136,6 +145,14 @@ export interface InitOptions {
   force?: boolean;
   /** Skip the login flow */
   skipLogin?: boolean;
+  /** Development mode - if provided, skip interactive prompt */
+  devMode?: DevMode;
+  /** Client path - if provided, skip interactive prompt */
+  clientPath?: string;
+  /** Skip prompts for existing datafiles - for testing */
+  skipDatafilePrompt?: boolean;
+  /** Auto-include existing datafiles without prompting - for testing */
+  includeExistingDatafiles?: boolean;
 }
 
 /**
@@ -156,6 +173,66 @@ export interface InitResult {
   workspaceName?: string;
   /** User email after login */
   userEmail?: string;
+  /** Selected development mode */
+  devMode?: DevMode;
+  /** Selected client path */
+  clientPath?: string;
+  /** Existing datafiles that were added to config */
+  existingDatafiles?: string[];
+}
+
+/**
+ * Find existing .datasource and .pipe files in the repository
+ *
+ * @param cwd - Working directory to search from
+ * @param maxDepth - Maximum directory depth to search (default: 5)
+ * @returns Array of relative file paths
+ */
+export function findExistingDatafiles(
+  cwd: string,
+  maxDepth: number = 5
+): string[] {
+  const files: string[] = [];
+
+  function searchDir(dir: string, depth: number): void {
+    if (depth > maxDepth) return;
+
+    let entries: fs.Dirent[];
+    try {
+      entries = fs.readdirSync(dir, { withFileTypes: true });
+    } catch {
+      return; // Skip directories we can't read
+    }
+
+    for (const entry of entries) {
+      const fullPath = path.join(dir, entry.name);
+
+      // Skip node_modules and hidden directories
+      if (
+        entry.isDirectory() &&
+        (entry.name === "node_modules" ||
+          entry.name.startsWith(".") ||
+          entry.name === "dist" ||
+          entry.name === "build")
+      ) {
+        continue;
+      }
+
+      if (entry.isDirectory()) {
+        searchDir(fullPath, depth + 1);
+      } else if (
+        entry.isFile() &&
+        (entry.name.endsWith(".datasource") || entry.name.endsWith(".pipe"))
+      ) {
+        // Convert to relative path
+        const relativePath = path.relative(cwd, fullPath);
+        files.push(relativePath);
+      }
+    }
+  }
+
+  searchDir(cwd, 0);
+  return files.sort();
 }
 
 /**
@@ -163,7 +240,7 @@ export interface InitResult {
  *
  * Creates:
  * - tinybird.json in the project root
- * - src/tinybird/ folder with datasources.ts, pipes.ts, and client.ts
+ * - src/tinybird/ folder with datasources.ts, endpoints.ts, and client.ts
  *
  * @param options - Init options
  * @returns Init result
@@ -175,14 +252,90 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
 
   const created: string[] = [];
   const skipped: string[] = [];
+  let existingDatafiles: string[] = [];
+
+  // Check for existing .datasource and .pipe files
+  const foundDatafiles = findExistingDatafiles(cwd);
+
+  // Determine devMode - prompt if not provided
+  let devMode: DevMode = options.devMode ?? "branch";
+
+  if (!options.devMode) {
+    // Show interactive prompt for workflow selection
+    p.intro(pc.cyan("tinybird init"));
+
+    const workflowChoice = await p.select({
+      message: "How do you want to develop with Tinybird?",
+      options: [
+        {
+          value: "branch",
+          label: "Branches",
+          hint: "Use Tinybird Cloud with git-based branching",
+        },
+        {
+          value: "local",
+          label: "Tinybird Local",
+          hint: "Run your own Tinybird instance locally",
+        },
+      ],
+    });
+
+    if (p.isCancel(workflowChoice)) {
+      p.cancel("Init cancelled.");
+      return {
+        success: false,
+        created: [],
+        skipped: [],
+        error: "Cancelled by user",
+      };
+    }
+
+    devMode = workflowChoice as DevMode;
+  }
 
   // Determine tinybird folder path based on project structure
-  const tinybirdDir = getTinybirdDir(cwd);
-  const relativeTinybirdDir = getRelativeTinybirdDir(cwd);
+  const defaultRelativePath = getRelativeTinybirdDir(cwd);
+  let relativeTinybirdDir = options.clientPath ?? defaultRelativePath;
+
+  if (!options.clientPath && !options.devMode) {
+    // Ask user to confirm or change the client path
+    const clientPathChoice = await p.text({
+      message: "Where should we generate the Tinybird client?",
+      placeholder: defaultRelativePath,
+      defaultValue: defaultRelativePath,
+    });
+
+    if (p.isCancel(clientPathChoice)) {
+      p.cancel("Init cancelled.");
+      return {
+        success: false,
+        created: [],
+        skipped: [],
+        error: "Cancelled by user",
+      };
+    }
+
+    relativeTinybirdDir = clientPathChoice || defaultRelativePath;
+  }
+
+  // Ask about existing datafiles if found
+  if (foundDatafiles.length > 0 && !options.skipDatafilePrompt) {
+    const includeDatafiles =
+      options.includeExistingDatafiles ??
+      (await promptForExistingDatafiles(foundDatafiles));
+
+    if (includeDatafiles) {
+      existingDatafiles = foundDatafiles;
+    }
+  } else if (options.includeExistingDatafiles && foundDatafiles.length > 0) {
+    existingDatafiles = foundDatafiles;
+  }
+
+  const tinybirdDir = path.join(cwd, relativeTinybirdDir);
 
   // File paths
   const datasourcesPath = path.join(tinybirdDir, "datasources.ts");
-  const pipesPath = path.join(tinybirdDir, "pipes.ts");
+  const endpointsPath = path.join(tinybirdDir, "endpoints.ts");
   const clientPath = path.join(tinybirdDir, "client.ts");
 
   // Create config file (tinybird.json)
@@ -191,7 +344,11 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
     skipped.push("tinybird.json");
   } else {
     try {
-      const config = createDefaultConfig(relativeTinybirdDir);
+      const config = createDefaultConfig(
+        relativeTinybirdDir,
+        devMode,
+        existingDatafiles
+      );
       fs.writeFileSync(configPath, JSON.stringify(config, null, 2) + "\n");
       created.push("tinybird.json");
     } catch (error) {
@@ -212,7 +369,9 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
       success: false,
       created,
       skipped,
-      error: `Failed to create ${relativeTinybirdDir} folder: ${(error as Error).message}`,
+      error: `Failed to create ${relativeTinybirdDir} folder: ${
+        (error as Error).message
+      }`,
     };
   }
 
@@ -233,19 +392,19 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
     }
   }
 
-  // Create pipes.ts
-  if (fs.existsSync(pipesPath) && !force) {
-    skipped.push(`${relativeTinybirdDir}/pipes.ts`);
+  // Create endpoints.ts
+  if (fs.existsSync(endpointsPath) && !force) {
+    skipped.push(`${relativeTinybirdDir}/endpoints.ts`);
   } else {
     try {
-      fs.writeFileSync(pipesPath, PIPES_CONTENT);
-      created.push(`${relativeTinybirdDir}/pipes.ts`);
+      fs.writeFileSync(endpointsPath, ENDPOINTS_CONTENT);
+      created.push(`${relativeTinybirdDir}/endpoints.ts`);
     } catch (error) {
       return {
         success: false,
         created,
         skipped,
-        error: `Failed to create pipes.ts: ${(error as Error).message}`,
+        error: `Failed to create endpoints.ts: ${(error as Error).message}`,
       };
     }
   }
@@ -288,8 +447,16 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
         modified = true;
       }
 
+      if (!packageJson.scripts["tinybird:deploy"]) {
+        packageJson.scripts["tinybird:deploy"] = "tinybird deploy";
+        modified = true;
+      }
+
       if (modified) {
-        fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + "\n");
+        fs.writeFileSync(
+          packageJsonPath,
+          JSON.stringify(packageJson, null, 2) + "\n"
+        );
         created.push("package.json (added tinybird scripts)");
       }
     } catch {
@@ -312,8 +479,9 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
         }
 
         // If custom base URL, update tinybird.json
-        if (authResult.baseUrl && authResult.baseUrl !== "https://api.tinybird.co") {
-          updateConfig(configPath, { baseUrl: authResult.baseUrl });
+        const baseUrl = authResult.baseUrl ?? "https://api.tinybird.co";
+        if (baseUrl !== "https://api.tinybird.co") {
+          updateConfig(configPath, { baseUrl });
         }
 
         return {
@@ -323,15 +491,25 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
           loggedIn: true,
           workspaceName: authResult.workspaceName,
           userEmail: authResult.userEmail,
+          devMode,
+          clientPath: relativeTinybirdDir,
+          existingDatafiles:
+            existingDatafiles.length > 0 ? existingDatafiles : undefined,
         };
       } catch (error) {
         // Login succeeded but saving credentials failed
-        console.error(`Warning: Failed to save credentials: ${(error as Error).message}`);
+        console.error(
+          `Warning: Failed to save credentials: ${(error as Error).message}`
+        );
         return {
           success: true,
           created,
           skipped,
           loggedIn: false,
+          devMode,
+          clientPath: relativeTinybirdDir,
+          existingDatafiles:
+            existingDatafiles.length > 0 ? existingDatafiles : undefined,
         };
       }
     } else {
@@ -341,6 +519,10 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
         created,
         skipped,
         loggedIn: false,
+        devMode,
+        clientPath: relativeTinybirdDir,
+        existingDatafiles:
+          existingDatafiles.length > 0 ? existingDatafiles : undefined,
       };
     }
   }
@@ -349,5 +531,40 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
     success: true,
     created,
     skipped,
+    devMode,
+    clientPath: relativeTinybirdDir,
+    existingDatafiles:
+      existingDatafiles.length > 0 ? existingDatafiles : undefined,
   };
 }
+
+/**
+ * Prompt user about including existing datafiles
+ */
+async function promptForExistingDatafiles(
+  datafiles: string[]
+): Promise<boolean> {
+  const datasourceCount = datafiles.filter((f) =>
+    f.endsWith(".datasource")
+  ).length;
+  const pipeCount = datafiles.filter((f) => f.endsWith(".pipe")).length;
+
+  const parts: string[] = [];
+  if (datasourceCount > 0) {
+    parts.push(`${datasourceCount} .datasource file${datasourceCount > 1 ? "s" : ""}`);
+  }
+  if (pipeCount > 0) {
+    parts.push(`${pipeCount} .pipe file${pipeCount > 1 ? "s" : ""}`);
+  }
+
+  const confirmInclude = await p.confirm({
+    message: `Found ${parts.join(" and ")} in your project. Include them in tinybird.json?`,
+    initialValue: true,
+  });
+
+  if (p.isCancel(confirmInclude)) {
+    return false;
+  }
+
+  return confirmInclude;
+}

package/src/cli/config.test.ts

@@ -267,6 +267,53 @@ describe("Config", () => {
 
       expect(() => loadConfig(tempDir)).toThrow("Failed to parse");
     });
+
+    it("defaults devMode to branch when not specified", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      const result = loadConfig(tempDir);
+
+      expect(result.devMode).toBe("branch");
+    });
+
+    it("loads devMode as branch when explicitly set", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        devMode: "branch",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      const result = loadConfig(tempDir);
+
+      expect(result.devMode).toBe("branch");
+    });
+
+    it("loads devMode as local when set", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        devMode: "local",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      const result = loadConfig(tempDir);
+
+      expect(result.devMode).toBe("local");
+    });
   });
 
   describe("updateConfig", () => {

package/src/cli/config.ts

@@ -6,6 +6,13 @@ import * as fs from "fs";
 import * as path from "path";
 import { getCurrentGitBranch, isMainBranch, getTinybirdBranchName } from "./git.js";
 
+/**
+ * Development mode options
+ * - "branch": Use Tinybird cloud with branches (default)
+ * - "local": Use local Tinybird container at localhost:7181
+ */
+export type DevMode = "branch" | "local";
+
 /**
  * Tinybird configuration file structure
  */
@@ -18,6 +25,8 @@ export interface TinybirdConfig {
   token: string;
   /** Tinybird API base URL (optional, defaults to EU region) */
   baseUrl?: string;
+  /** Development mode: "branch" (default) or "local" */
+  devMode?: DevMode;
 }
 
 /**
@@ -40,6 +49,8 @@ export interface ResolvedConfig {
   tinybirdBranch: string | null;
   /** Whether we're on the main/master branch */
   isMainBranch: boolean;
+  /** Development mode: "branch" or "local" */
+  devMode: DevMode;
 }
 
 /**
@@ -47,6 +58,11 @@ export interface ResolvedConfig {
  */
 const DEFAULT_BASE_URL = "https://api.tinybird.co";
 
+/**
+ * Local Tinybird base URL
+ */
+export const LOCAL_BASE_URL = "http://localhost:7181";
+
 /**
  * Config file name
  */
@@ -243,6 +259,9 @@ export function loadConfig(cwd: string = process.cwd()): ResolvedConfig {
   const gitBranch = getCurrentGitBranch();
   const tinybirdBranch = getTinybirdBranchName();
 
+  // Resolve devMode (default to "branch")
+  const devMode: DevMode = config.devMode ?? "branch";
+
   return {
     include,
     token: resolvedToken,
@@ -252,6 +271,7 @@ export function loadConfig(cwd: string = process.cwd()): ResolvedConfig {
     gitBranch,
     tinybirdBranch,
     isMainBranch: isMainBranch(),
+    devMode,
   };
 }