@tinybirdco/sdk 0.0.30 → 0.0.31

package/src/cli/commands/info.test.ts

@@ -3,7 +3,7 @@ import { runInfo } from "./info.js";
 
 // Mock the config module
 vi.mock("../config.js", () => ({
-  loadConfig: vi.fn(),
+  loadConfigAsync: vi.fn(),
   LOCAL_BASE_URL: "http://localhost:7181",
 }));
 
@@ -31,7 +31,7 @@ vi.mock("../../api/local.js", () => ({
 }));
 
 // Import mocked functions
-import { loadConfig } from "../config.js";
+import { loadConfigAsync } from "../config.js";
 import { getWorkspace } from "../../api/workspaces.js";
 import { listBranches, getBranch } from "../../api/branches.js";
 import { getDashboardUrl, getBranchDashboardUrl, getLocalDashboardUrl } from "../../api/dashboard.js";
@@ -42,7 +42,7 @@ import {
   getLocalWorkspaceName,
 } from "../../api/local.js";
 
-const mockedLoadConfig = vi.mocked(loadConfig);
+const mockedLoadConfigAsync = vi.mocked(loadConfigAsync);
 const mockedGetWorkspace = vi.mocked(getWorkspace);
 const mockedListBranches = vi.mocked(listBranches);
 const mockedGetBranch = vi.mocked(getBranch);
@@ -61,9 +61,7 @@ describe("Info Command", () => {
 
   describe("config loading", () => {
     it("returns error when config loading fails", async () => {
-      mockedLoadConfig.mockImplementation(() => {
-        throw new Error("No tinybird.json found");
-      });
+      mockedLoadConfigAsync.mockRejectedValue(new Error("No tinybird.json found"));
 
       const result = await runInfo();
 
@@ -95,7 +93,7 @@ describe("Info Command", () => {
     };
 
     beforeEach(() => {
-      mockedLoadConfig.mockReturnValue(mockConfig);
+      mockedLoadConfigAsync.mockResolvedValue(mockConfig);
       mockedGetWorkspace.mockResolvedValue(mockWorkspace);
       mockedListBranches.mockResolvedValue([]);
       mockedGetDashboardUrl.mockReturnValue("https://cloud.tinybird.co/gcp/europe-west3/test-workspace");
@@ -161,7 +159,7 @@ describe("Info Command", () => {
     });
 
     it("does not return branch info when on main branch", async () => {
-      mockedLoadConfig.mockReturnValue({
+      mockedLoadConfigAsync.mockResolvedValue({
         ...mockConfig,
         gitBranch: "main",
         tinybirdBranch: null,
@@ -212,7 +210,7 @@ describe("Info Command", () => {
     };
 
     beforeEach(() => {
-      mockedLoadConfig.mockReturnValue(mockConfig);
+      mockedLoadConfigAsync.mockResolvedValue(mockConfig);
       mockedGetWorkspace.mockResolvedValue(mockWorkspace);
       mockedGetDashboardUrl.mockReturnValue("https://cloud.tinybird.co/gcp/europe-west3/test-workspace");
     });
@@ -285,7 +283,7 @@ describe("Info Command", () => {
 
   describe("error handling", () => {
     it("returns error when workspace fetch fails", async () => {
-      mockedLoadConfig.mockReturnValue({
+      mockedLoadConfigAsync.mockResolvedValue({
         cwd: "/test",
         configPath: "/test/tinybird.json",
         devMode: "branch" as const,
@@ -306,7 +304,7 @@ describe("Info Command", () => {
     });
 
     it("handles branch fetch error gracefully", async () => {
-      mockedLoadConfig.mockReturnValue({
+      mockedLoadConfigAsync.mockResolvedValue({
         cwd: "/test",
         configPath: "/test/tinybird.json",
         devMode: "branch" as const,
@@ -336,7 +334,7 @@ describe("Info Command", () => {
     });
 
     it("handles branches list fetch error gracefully", async () => {
-      mockedLoadConfig.mockReturnValue({
+      mockedLoadConfigAsync.mockResolvedValue({
         cwd: "/test",
         configPath: "/test/tinybird.json",
         devMode: "branch" as const,
@@ -365,7 +363,7 @@ describe("Info Command", () => {
     });
 
     it("handles local workspace fetch error gracefully", async () => {
-      mockedLoadConfig.mockReturnValue({
+      mockedLoadConfigAsync.mockResolvedValue({
         cwd: "/test",
         configPath: "/test/tinybird.json",
         devMode: "local" as const,

package/src/cli/commands/info.ts

@@ -2,7 +2,7 @@
  * Info command - shows information about the current project and workspace
  */
 
-import { loadConfig, LOCAL_BASE_URL, type ResolvedConfig } from "../config.js";
+import { loadConfigAsync, LOCAL_BASE_URL, type ResolvedConfig } from "../config.js";
 import { getWorkspace, type TinybirdWorkspace } from "../../api/workspaces.js";
 import { listBranches, getBranch, type TinybirdBranch } from "../../api/branches.js";
 import { getDashboardUrl, getBranchDashboardUrl, getLocalDashboardUrl } from "../../api/dashboard.js";
@@ -125,7 +125,7 @@ export async function runInfo(
   // Load config
   let config: ResolvedConfig;
   try {
-    config = loadConfig(cwd);
+    config = await loadConfigAsync(cwd);
   } catch (error) {
     return {
       success: false,

package/src/cli/commands/init.test.ts

@@ -46,45 +46,45 @@ describe("Init Command", () => {
       ).toBe(true);
     });
 
-    it("creates tinybird.json with correct include path for lib/tinybird.ts", async () => {
+    it("creates tinybird.config.json with correct include path for lib/tinybird.ts", async () => {
       const result = await runInit({ cwd: tempDir, skipLogin: true, devMode: "branch", clientPath: "lib/tinybird.ts" });
 
       expect(result.success).toBe(true);
-      expect(result.created).toContain("tinybird.json");
+      expect(result.created).toContain("tinybird.config.json");
 
       const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
+        fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8")
       );
-      expect(config.include).toEqual(["lib/tinybird.ts"]);
+      expect(config.include).toContain("lib/tinybird.ts");
+      expect(config.token).toBe("${TINYBIRD_TOKEN}");
     });
 
-    it("creates tinybird.json with correct include path for src/lib/tinybird.ts", async () => {
+    it("creates tinybird.config.json with correct include path for src/lib/tinybird.ts", async () => {
       fs.mkdirSync(path.join(tempDir, "src"));
 
       const result = await runInit({ cwd: tempDir, skipLogin: true, devMode: "branch", clientPath: "src/lib/tinybird.ts" });
 
       expect(result.success).toBe(true);
 
-      const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
-      );
-      expect(config.include).toEqual(["src/lib/tinybird.ts"]);
+      const content = fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8");
+      expect(content).toContain('"src/lib/tinybird.ts"');
     });
   });
 
   describe("config file creation", () => {
-    it("creates tinybird.json with default values", async () => {
+    it("creates tinybird.config.json with default values", async () => {
       await runInit({ cwd: tempDir, skipLogin: true, devMode: "branch", clientPath: "lib/tinybird.ts" });
 
       const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
+        fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8")
       );
 
       expect(config.token).toBe("${TINYBIRD_TOKEN}");
       expect(config.baseUrl).toBe("https://api.tinybird.co");
+      expect(config.devMode).toBe("branch");
     });
 
-    it("updates tinybird.json if it already exists", async () => {
+    it("updates legacy tinybird.json if it already exists", async () => {
       const existingConfig = {
         include: ["custom.ts"],
         token: "existing",
@@ -109,22 +109,46 @@ describe("Init Command", () => {
       expect(config.token).toBe("existing");
     });
 
-    it("overwrites tinybird.json with force option", async () => {
-      const existingConfig = { include: ["custom.ts"], token: "existing" };
+    it("updates tinybird.config.json if it already exists", async () => {
+      const existingConfig = {
+        include: ["custom.ts"],
+        token: "existing",
+        devMode: "local",
+      };
       fs.writeFileSync(
-        path.join(tempDir, "tinybird.json"),
+        path.join(tempDir, "tinybird.config.json"),
         JSON.stringify(existingConfig)
       );
 
-      const result = await runInit({ cwd: tempDir, skipLogin: true, force: true, devMode: "branch", clientPath: "lib/tinybird.ts" });
+      const result = await runInit({ cwd: tempDir, skipLogin: true, devMode: "branch", clientPath: "lib/tinybird.ts" });
 
       expect(result.success).toBe(true);
-      expect(result.created).toContain("tinybird.json");
+      expect(result.created).toContain("tinybird.config.json (updated)");
 
+      // Verify include/devMode updated but token preserved
       const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
+        fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8")
       );
       expect(config.include).toEqual(["lib/tinybird.ts"]);
+      expect(config.devMode).toBe("branch");
+      expect(config.token).toBe("existing");
+    });
+
+    it("overwrites existing config with force option", async () => {
+      const existingConfig = { include: ["custom.ts"], token: "existing" };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(existingConfig)
+      );
+
+      const result = await runInit({ cwd: tempDir, skipLogin: true, force: true, devMode: "branch", clientPath: "lib/tinybird.ts" });
+
+      expect(result.success).toBe(true);
+      // With force, it creates a new tinybird.config.json
+      expect(result.created).toContain("tinybird.config.json");
+
+      const content = fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8");
+      expect(content).toContain('"lib/tinybird.ts"');
     });
   });
 
@@ -417,11 +441,9 @@ describe("Init Command", () => {
       expect(result.existingDatafiles).toContain("datasources/events.datasource");
       expect(result.existingDatafiles).toContain("pipes/top_events.pipe");
 
-      const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
-      );
-      expect(config.include).toContain("datasources/events.datasource");
-      expect(config.include).toContain("pipes/top_events.pipe");
+      const content = fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8");
+      expect(content).toContain('"datasources/events.datasource"');
+      expect(content).toContain('"pipes/top_events.pipe"');
     });
 
     it("does not include existing datafiles when user opts out", async () => {
@@ -441,11 +463,9 @@ describe("Init Command", () => {
       expect(result.success).toBe(true);
       expect(result.existingDatafiles).toBeUndefined();
 
-      const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
-      );
-      expect(config.include).not.toContain("datasources/events.datasource");
-      expect(config.include).toEqual(["lib/tinybird.ts"]);
+      const content = fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8");
+      expect(content).not.toContain("datasources/events.datasource");
+      expect(content).toContain('"lib/tinybird.ts"');
     });
 
     it("preserves TypeScript include paths alongside datafiles", async () => {
@@ -464,12 +484,10 @@ describe("Init Command", () => {
 
       expect(result.success).toBe(true);
 
-      const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
-      );
+      const content = fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8");
       // Should have both TypeScript file AND datafiles
-      expect(config.include).toContain("lib/tinybird.ts");
-      expect(config.include).toContain("datasources/events.datasource");
+      expect(content).toContain('"lib/tinybird.ts"');
+      expect(content).toContain('"datasources/events.datasource"');
     });
 
     it("handles projects with no existing datafiles", async () => {
@@ -485,10 +503,8 @@ describe("Init Command", () => {
       expect(result.success).toBe(true);
       expect(result.existingDatafiles).toBeUndefined();
 
-      const config = JSON.parse(
-        fs.readFileSync(path.join(tempDir, "tinybird.json"), "utf-8")
-      );
-      expect(config.include).toEqual(["lib/tinybird.ts"]);
+      const content = fs.readFileSync(path.join(tempDir, "tinybird.config.json"), "utf-8");
+      expect(content).toContain('"lib/tinybird.ts"');
     });
   });
 });

package/src/cli/commands/init.ts

@@ -10,8 +10,9 @@ import {
   hasValidToken,
   getRelativeTinybirdDir,
   getConfigPath,
+  findExistingConfigPath,
   updateConfig,
-  loadConfig,
+  loadConfigAsync,
   type DevMode,
 } from "../config.js";
 import { browserLogin } from "../auth.js";
@@ -130,6 +131,7 @@ function generateGithubCiWorkflow(workingDirectory?: string): string {
 on:
   pull_request:
     paths:
+      - "${pathPrefix}tinybird.config.*"
       - "${pathPrefix}tinybird.json"
       - "${pathPrefix}**/*.ts"
 
@@ -176,6 +178,7 @@ on:
     branches:
       - main
     paths:
+      - "${pathPrefix}tinybird.config.*"
       - "${pathPrefix}tinybird.json"
       - "${pathPrefix}**/*.ts"
 
@@ -218,6 +221,7 @@ tinybird_ci:
   image: node:22
   rules:
     - changes:
+        - ${pathPrefix}tinybird.config.*
         - ${pathPrefix}tinybird.json
         - ${pathPrefix}**/*.ts
   script:
@@ -246,6 +250,7 @@ tinybird_cd:
   rules:
     - if: '$CI_COMMIT_BRANCH == "main"'
       changes:
+        - ${pathPrefix}tinybird.config.*
         - ${pathPrefix}tinybird.json
         - ${pathPrefix}**/*.ts
   script:
@@ -258,7 +263,7 @@ tinybird_cd:
 }
 
 /**
- * Default config content generator
+ * Default config content generator (for JSON files)
  */
 function createDefaultConfig(
   tinybirdFilePath: string,
@@ -419,7 +424,7 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
 
   if (!options.devMode) {
     // Show interactive prompt for workflow selection
-    p.intro(pc.cyan("tinybird.json"));
+    p.intro(pc.cyan("tinybird.config.json"));
 
     const workflowChoice = await p.select({
       message: "How do you want to develop with Tinybird?",
@@ -589,43 +594,54 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
   const tinybirdFilePath = path.join(cwd, relativeTinybirdDir);
   const tinybirdDir = path.dirname(tinybirdFilePath);
 
-  // Create config file (tinybird.json)
-  const configPath = getConfigPath(cwd);
-  if (fs.existsSync(configPath) && !force) {
-    try {
-      const config = createDefaultConfig(
-        relativeTinybirdDir,
-        devMode,
-        existingDatafiles
-      );
-      updateConfig(configPath, {
-        include: config.include,
-        devMode: config.devMode,
-      });
-      created.push("tinybird.json (updated)");
-    } catch (error) {
-      return {
-        success: false,
-        created,
-        skipped,
-        error: `Failed to update tinybird.json: ${(error as Error).message}`,
-      };
+  // Create or update config file
+  // Check for any existing config file first
+  const existingConfigPath = findExistingConfigPath(cwd);
+  const newConfigPath = getConfigPath(cwd);
+
+  if (existingConfigPath && !force) {
+    // Update existing config file (only if it's JSON)
+    const configFileName = path.basename(existingConfigPath);
+    if (existingConfigPath.endsWith(".json")) {
+      try {
+        const config = createDefaultConfig(
+          relativeTinybirdDir,
+          devMode,
+          existingDatafiles
+        );
+        updateConfig(existingConfigPath, {
+          include: config.include,
+          devMode: config.devMode,
+        });
+        created.push(`${configFileName} (updated)`);
+      } catch (error) {
+        return {
+          success: false,
+          created,
+          skipped,
+          error: `Failed to update ${configFileName}: ${(error as Error).message}`,
+        };
+      }
+    } else {
+      // JS config file exists - skip and let user update manually
+      skipped.push(`${configFileName} (JS config files must be updated manually)`);
     }
   } else {
+    // Create new config file with JSON format
     try {
       const config = createDefaultConfig(
         relativeTinybirdDir,
         devMode,
         existingDatafiles
       );
-      fs.writeFileSync(configPath, JSON.stringify(config, null, 2) + "\n");
-      created.push("tinybird.json");
+      fs.writeFileSync(newConfigPath, JSON.stringify(config, null, 2) + "\n");
+      created.push("tinybird.config.json");
     } catch (error) {
       return {
         success: false,
         created,
         skipped,
-        error: `Failed to create tinybird.json: ${(error as Error).message}`,
+        error: `Failed to create tinybird.config.json: ${(error as Error).message}`,
       };
     }
   }
@@ -841,10 +857,13 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
           created.push(".env.local");
         }
 
-        // If custom base URL, update tinybird.json
+        // If custom base URL, update config file
         const baseUrl = authResult.baseUrl ?? "https://api.tinybird.co";
         if (baseUrl !== "https://api.tinybird.co") {
-          updateConfig(configPath, { baseUrl });
+          const currentConfigPath = findExistingConfigPath(cwd);
+          if (currentConfigPath && currentConfigPath.endsWith(".json")) {
+            updateConfig(currentConfigPath, { baseUrl });
+          }
         }
 
         // Generate TypeScript from existing Tinybird resources if requested
@@ -916,7 +935,7 @@ export async function runInit(options: InitOptions = {}): Promise<InitResult> {
   // (when user is already logged in)
   if (datafileAction === "codegen" && hasValidToken(cwd)) {
     try {
-      const config = loadConfig(cwd);
+      const config = await loadConfigAsync(cwd);
       const tinybirdDir = path.join(cwd, relativeTinybirdDir);
       await runCodegen(
         config.baseUrl,

package/src/cli/commands/login.test.ts

@@ -35,7 +35,7 @@ describe("Login Command", () => {
       const result = await runLogin({ cwd: tempDir });
 
       expect(result.success).toBe(false);
-      expect(result.error).toContain("No tinybird.json found");
+      expect(result.error).toContain("No tinybird config found");
       expect(result.error).toContain("npx tinybird init");
     });
 

package/src/cli/commands/login.ts

@@ -45,14 +45,15 @@ export async function runLogin(options: RunLoginOptions = {}): Promise<LoginResu
   const cwd = options.cwd ?? process.cwd();
 
   // Find the actual config file (may be in parent directory)
-  const configPath = findConfigFile(cwd);
-  if (!configPath) {
+  const configResult = findConfigFile(cwd);
+  if (!configResult) {
     return {
       success: false,
-      error: "No tinybird.json found. Run 'npx tinybird init' first.",
+      error: "No tinybird config found. Run 'npx tinybird init' first.",
     };
   }
 
+  const configPath = configResult.path;
   // Get the directory containing the config file for .env.local
   const configDir = path.dirname(configPath);
 
@@ -72,12 +73,12 @@ export async function runLogin(options: RunLoginOptions = {}): Promise<LoginResu
     };
   }
 
-  // Save token to .env.local (in same directory as tinybird.json)
+  // Save token to .env.local (in same directory as config file)
   try {
     saveTinybirdToken(configDir, authResult.token);
 
-    // Update baseUrl in tinybird.json if it changed
-    if (authResult.baseUrl) {
+    // Update baseUrl in config file if it changed (only for JSON configs)
+    if (authResult.baseUrl && configPath.endsWith(".json")) {
       updateConfig(configPath, {
         baseUrl: authResult.baseUrl,
       });

package/src/cli/commands/preview.ts

@@ -2,7 +2,7 @@
  * Preview command - creates ephemeral preview branch and deploys resources
  */
 
-import { loadConfig, LOCAL_BASE_URL, type ResolvedConfig, type DevMode } from "../config.js";
+import { loadConfigAsync, LOCAL_BASE_URL, type ResolvedConfig, type DevMode } from "../config.js";
 import { buildFromInclude, type BuildFromIncludeResult } from "../../generator/index.js";
 import { createBranch, deleteBranch, getBranch, type TinybirdBranch } from "../../api/branches.js";
 import { deployToMain } from "../../api/deploy.js";
@@ -90,7 +90,7 @@ export async function runPreview(options: PreviewCommandOptions = {}): Promise<P
   // Load config
   let config: ResolvedConfig;
   try {
-    config = loadConfig(cwd);
+    config = await loadConfigAsync(cwd);
   } catch (error) {
     return {
       success: false,

package/src/cli/config-loader.ts

@@ -0,0 +1,87 @@
+/**
+ * Universal config file loader
+ * Supports .json, .cjs, and .mjs files
+ */
+
+import * as fs from "node:fs/promises";
+import * as path from "node:path";
+import { pathToFileURL } from "node:url";
+
+export type MaybePromise<T> = T | Promise<T>;
+
+export type LoadedConfig<T> = {
+  config: T;
+  filepath: string;
+};
+
+export type LoadConfigOptions = {
+  cwd?: string;
+};
+
+function isObject(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+async function readJsonFile<T>(filepath: string): Promise<T> {
+  const raw = await fs.readFile(filepath, "utf8");
+  return JSON.parse(raw) as T;
+}
+
+/**
+ * Resolve the config export from a module
+ * Supports default export, module.exports, and function configs
+ */
+async function resolveConfigExport(mod: unknown): Promise<unknown> {
+  const moduleObj = mod as Record<string, unknown>;
+  const exported = moduleObj?.default ?? mod;
+
+  // Allow config as function (sync/async)
+  if (typeof exported === "function") {
+    return await (exported as () => MaybePromise<unknown>)();
+  }
+  return exported;
+}
+
+/**
+ * Load a config file from disk
+ * Supports .json, .cjs, and .mjs files
+ */
+export async function loadConfigFile<T = unknown>(
+  configPath: string,
+  opts: LoadConfigOptions = {}
+): Promise<LoadedConfig<T>> {
+  const cwd = opts.cwd ?? process.cwd();
+  const filepath = path.isAbsolute(configPath)
+    ? configPath
+    : path.resolve(cwd, configPath);
+
+  const ext = path.extname(filepath).toLowerCase();
+
+  if (ext === ".json") {
+    const config = await readJsonFile<T>(filepath);
+    return { config, filepath };
+  }
+
+  if (ext === ".mjs" || ext === ".cjs") {
+    // Load JS modules via runtime import for bundler compatibility
+    const url = pathToFileURL(filepath).href;
+    const mod = await import(
+      /* webpackIgnore: true */
+      /* @vite-ignore */
+      url
+    );
+    const config = await resolveConfigExport(mod);
+
+    if (!isObject(config)) {
+      throw new Error(
+        `Config in ${filepath} must export an object (or a function returning an object).`
+      );
+    }
+
+    return { config: config as T, filepath };
+  }
+
+  throw new Error(
+    `Unsupported config extension "${ext}". Use .json, .mjs, or .cjs`
+  );
+}

package/src/cli/config-types.ts

@@ -0,0 +1,29 @@
+/**
+ * Configuration types for tinybird.config.{ts,js,json}
+ *
+ * This file is separate from config.ts to avoid pulling in esbuild
+ * when these types are imported by client code.
+ */
+
+/**
+ * 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
+ */
+export interface TinybirdConfig {
+  /** Array of TypeScript files to scan for datasources and pipes */
+  include?: string[];
+  /** @deprecated Use `include` instead. Path to the TypeScript schema entry point */
+  schema?: string;
+  /** API token (supports ${ENV_VAR} interpolation) */
+  token: string;
+  /** Tinybird API base URL (optional, defaults to EU region) */
+  baseUrl?: string;
+  /** Development mode: "branch" (default) or "local" */
+  devMode?: DevMode;
+}