@tinybirdco/sdk 0.0.78 → 0.0.80

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

@@ -64,6 +64,7 @@ describe("Build Command", () => {
         gitBranch: "feature-test",
         tinybirdBranch: "feature_test",
         isMainBranch: false,
+        branchDataMode: null,
       });
 
       vi.mocked(buildFromInclude).mockResolvedValue({
@@ -156,6 +157,7 @@ describe("Build Command", () => {
         gitBranch: "feature-test",
         tinybirdBranch: "feature_test",
         isMainBranch: false,
+        branchDataMode: null,
       });
 
       vi.mocked(buildFromInclude).mockResolvedValue({
@@ -242,6 +244,7 @@ describe("Build Command", () => {
         gitBranch: "feature-test",
         tinybirdBranch: "feature_test",
         isMainBranch: false,
+        branchDataMode: null,
       });
 
       vi.mocked(buildFromInclude).mockResolvedValue({
@@ -307,4 +310,177 @@ describe("Build Command", () => {
       expect(getLocalTokens).toHaveBeenCalled();
     });
   });
+
+  describe("branch_data_mode wiring", () => {
+    it("uses config-only last_partition when flag is absent", async () => {
+      const { loadConfigAsync } = await import("../config.js");
+      const { buildFromInclude } = await import("../../generator/index.js");
+      const { getOrCreateBranch } = await import("../../api/branches.js");
+      const { buildToTinybird } = await import("../../api/build.js");
+      const { getWorkspace } = await import("../../api/workspaces.js");
+      const { getBranchDashboardUrl } = await import("../../api/dashboard.js");
+
+      vi.mocked(loadConfigAsync).mockResolvedValue({
+        include: ["test.ts"],
+        token: "p.test-token",
+        baseUrl: "https://api.tinybird.co",
+        configPath: "/test/tinybird.config.json",
+        devMode: "branch",
+        cwd: "/test",
+        gitBranch: "feature-test",
+        tinybirdBranch: "feature_test",
+        isMainBranch: false,
+        branchDataMode: "last_partition",
+      });
+      vi.mocked(buildFromInclude).mockResolvedValue({
+        resources: { datasources: [], pipes: [], connections: [] },
+        entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
+        stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
+      });
+      vi.mocked(getOrCreateBranch).mockResolvedValue({
+        id: "branch-id",
+        name: "feature_test",
+        token: "branch-token",
+        wasCreated: false,
+        created_at: "2024-01-01",
+      });
+      vi.mocked(getWorkspace).mockResolvedValue({
+        id: "ws-id",
+        name: "test-workspace",
+        user_id: "user-id",
+        user_email: "user@test.com",
+        scope: "USER",
+        main: null,
+      });
+      vi.mocked(getBranchDashboardUrl).mockReturnValue("https://app.tinybird.co/dashboard");
+      vi.mocked(buildToTinybird).mockResolvedValue({
+        success: true,
+        result: "success",
+        datasourceCount: 0,
+        pipeCount: 0,
+        connectionCount: 0,
+      });
+
+      await runBuild();
+      expect(getOrCreateBranch).toHaveBeenCalledWith(
+        expect.any(Object),
+        "feature_test",
+        { branch_data_mode: "last_partition" }
+      );
+    });
+
+    it("keeps CLI --last-partition precedence over config", async () => {
+      const { loadConfigAsync } = await import("../config.js");
+      const { buildFromInclude } = await import("../../generator/index.js");
+      const { getOrCreateBranch } = await import("../../api/branches.js");
+      const { buildToTinybird } = await import("../../api/build.js");
+      const { getWorkspace } = await import("../../api/workspaces.js");
+      const { getBranchDashboardUrl } = await import("../../api/dashboard.js");
+
+      vi.mocked(loadConfigAsync).mockResolvedValue({
+        include: ["test.ts"],
+        token: "p.test-token",
+        baseUrl: "https://api.tinybird.co",
+        configPath: "/test/tinybird.config.json",
+        devMode: "branch",
+        cwd: "/test",
+        gitBranch: "feature-test",
+        tinybirdBranch: "feature_test",
+        isMainBranch: false,
+        branchDataMode: null,
+      });
+      vi.mocked(buildFromInclude).mockResolvedValue({
+        resources: { datasources: [], pipes: [], connections: [] },
+        entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
+        stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
+      });
+      vi.mocked(getOrCreateBranch).mockResolvedValue({
+        id: "branch-id",
+        name: "feature_test",
+        token: "branch-token",
+        wasCreated: false,
+        created_at: "2024-01-01",
+      });
+      vi.mocked(getWorkspace).mockResolvedValue({
+        id: "ws-id",
+        name: "test-workspace",
+        user_id: "user-id",
+        user_email: "user@test.com",
+        scope: "USER",
+        main: null,
+      });
+      vi.mocked(getBranchDashboardUrl).mockReturnValue("https://app.tinybird.co/dashboard");
+      vi.mocked(buildToTinybird).mockResolvedValue({
+        success: true,
+        result: "success",
+        datasourceCount: 0,
+        pipeCount: 0,
+        connectionCount: 0,
+      });
+
+      await runBuild({ lastPartition: true });
+      expect(getOrCreateBranch).toHaveBeenCalledWith(
+        expect.any(Object),
+        "feature_test",
+        { branch_data_mode: "last_partition" }
+      );
+    });
+
+    it("ignores config branch_data_mode in local mode", async () => {
+      const { loadConfigAsync } = await import("../config.js");
+      const { buildFromInclude } = await import("../../generator/index.js");
+      const { getOrCreateBranch } = await import("../../api/branches.js");
+      const { getLocalTokens, getOrCreateLocalWorkspace, getLocalWorkspaceName } = await import("../../api/local.js");
+      const { buildToTinybird } = await import("../../api/build.js");
+      const { getWorkspace } = await import("../../api/workspaces.js");
+      const { getLocalDashboardUrl } = await import("../../api/dashboard.js");
+
+      vi.mocked(loadConfigAsync).mockResolvedValue({
+        include: ["test.ts"],
+        token: "p.test-token",
+        baseUrl: "https://api.tinybird.co",
+        configPath: "/test/tinybird.config.json",
+        devMode: "local",
+        cwd: "/test",
+        gitBranch: "feature-test",
+        tinybirdBranch: "feature_test",
+        isMainBranch: false,
+        branchDataMode: "last_partition",
+      });
+      vi.mocked(buildFromInclude).mockResolvedValue({
+        resources: { datasources: [], pipes: [], connections: [] },
+        entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
+        stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
+      });
+      vi.mocked(getLocalTokens).mockResolvedValue({
+        admin_token: "admin-token",
+        user_token: "user-token",
+        workspace_admin_token: "workspace-admin-token",
+      });
+      vi.mocked(getWorkspace).mockResolvedValue({
+        id: "ws-id",
+        name: "test-workspace",
+        user_id: "user-id",
+        user_email: "user@test.com",
+        scope: "USER",
+        main: null,
+      });
+      vi.mocked(getLocalWorkspaceName).mockReturnValue("feature_test_workspace");
+      vi.mocked(getOrCreateLocalWorkspace).mockResolvedValue({
+        workspace: { id: "local-ws-id", name: "feature_test_workspace", token: "local-token" },
+        wasCreated: false,
+      });
+      vi.mocked(getLocalDashboardUrl).mockReturnValue("http://localhost:7181/dashboard");
+      vi.mocked(buildToTinybird).mockResolvedValue({
+        success: true,
+        result: "success",
+        datasourceCount: 0,
+        pipeCount: 0,
+        connectionCount: 0,
+      });
+
+      await runBuild();
+      expect(getOrCreateBranch).not.toHaveBeenCalled();
+    });
+  });
 });

package/src/cli/commands/build.ts

@@ -2,7 +2,7 @@
  * Build command - generates and pushes resources to Tinybird branches
  */
 
-import { loadConfigAsync, LOCAL_BASE_URL, type ResolvedConfig, type DevMode } from "../config.js";
+import { loadConfigAsync, LOCAL_BASE_URL, type ResolvedConfig, type DevMode, type BranchDataMode } from "../config.js";
 import { buildFromInclude, type BuildFromIncludeResult } from "../../generator/index.js";
 import { buildToTinybird, type BuildApiResult } from "../../api/build.js";
 import { getOrCreateBranch } from "../../api/branches.js";
@@ -225,13 +225,20 @@ export async function runBuild(options: BuildCommandOptions = {}): Promise<Build
         console.log(`[debug] Getting/creating Tinybird branch: ${config.tinybirdBranch}`);
       }
       try {
+        const branchDataMode: BranchDataMode | undefined =
+          options.lastPartition || config.branchDataMode === "last_partition"
+            ? "last_partition"
+            : undefined;
+        const branchOptions = branchDataMode
+          ? { branch_data_mode: branchDataMode }
+          : undefined;
         const tinybirdBranch = await getOrCreateBranch(
           {
             baseUrl: config.baseUrl,
             token: config.token,
           },
           config.tinybirdBranch!,
-          { lastPartition: options.lastPartition }
+          branchOptions
         );
 
         if (!tinybirdBranch.token) {

package/src/cli/commands/clear.ts

@@ -13,6 +13,7 @@ import {
 import {
   clearBranch,
   BranchApiError,
+  type CreateBranchOptions,
 } from "../../api/branches.js";
 import {
   setBranchToken,
@@ -147,12 +148,18 @@ async function clearCloudBranch(config: ResolvedConfig): Promise<ClearResult> {
     });
 
     // Clear the branch (delete and recreate)
+    const branchOptions: CreateBranchOptions | undefined =
+      config.devMode !== "local" && config.branchDataMode === "last_partition"
+        ? { branch_data_mode: "last_partition" }
+        : undefined;
+
     const newBranch = await clearBranch(
       {
         baseUrl: config.baseUrl,
         token: config.token,
       },
-      branchName
+      branchName,
+      branchOptions
     );
 
     // Update the cached token with the new branch token

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

@@ -37,6 +37,7 @@ describe("Deploy command", () => {
       tinybirdBranch: "feature_pro_610",
       isMainBranch: false,
       devMode: "branch",
+      branchDataMode: null,
     });
 
     vi.mocked(buildFromInclude).mockResolvedValue({

package/src/cli/commands/dev.ts

@@ -13,6 +13,7 @@ import {
   LOCAL_BASE_URL,
   type ResolvedConfig,
   type DevMode,
+  type BranchDataMode,
 } from "../config.js";
 import { runBuild, type BuildCommandResult } from "./build.js";
 import { getOrCreateBranch, type TinybirdBranch } from "../../api/branches.js";
@@ -239,6 +240,13 @@ export async function runDev(
     // Use tinybirdBranch (sanitized name) for Tinybird API, gitBranch for display
     if (config.tinybirdBranch) {
       const branchName = config.tinybirdBranch; // Sanitized name for Tinybird
+      const branchDataMode: BranchDataMode | undefined =
+        options.lastPartition || config.branchDataMode === "last_partition"
+          ? "last_partition"
+          : undefined;
+      const branchOptions = branchDataMode
+        ? { branch_data_mode: branchDataMode }
+        : undefined;
 
       // Always fetch fresh from API to avoid stale cache issues
       const tinybirdBranch = await getOrCreateBranch(
@@ -247,7 +255,7 @@ export async function runDev(
           token: config.token,
         },
         branchName,
-        { lastPartition: options.lastPartition }
+        branchOptions
       );
 
       if (!tinybirdBranch.token) {

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

@@ -35,6 +35,7 @@ describe("Generate command", () => {
       tinybirdBranch: "feature_x",
       isMainBranch: false,
       devMode: "branch",
+      branchDataMode: null,
     });
 
     vi.mocked(buildFromInclude).mockResolvedValue({
@@ -108,6 +109,7 @@ describe("Generate command", () => {
       tinybirdBranch: "feature_x",
       isMainBranch: false,
       devMode: "branch",
+      branchDataMode: null,
     });
 
     vi.mocked(buildFromInclude).mockResolvedValue({
@@ -167,6 +169,7 @@ describe("Generate command", () => {
       tinybirdBranch: "feature_x",
       isMainBranch: false,
       devMode: "branch",
+      branchDataMode: null,
     });
     vi.mocked(buildFromInclude).mockRejectedValue(
       new Error("generator failed")

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

@@ -1,7 +1,45 @@
-import { describe, it, expect } from "vitest";
-import { generatePreviewBranchName } from "./preview.js";
+import { describe, it, expect, vi, beforeEach } from "vitest";
+import { generatePreviewBranchName, runPreview } from "./preview.js";
+
+vi.mock("../config.js", () => ({
+  loadConfigAsync: vi.fn(),
+  LOCAL_BASE_URL: "http://localhost:7181",
+}));
+
+vi.mock("../../generator/index.js", () => ({
+  buildFromInclude: vi.fn(),
+}));
+
+vi.mock("../../api/branches.js", () => ({
+  createBranch: vi.fn(),
+  deleteBranch: vi.fn(),
+  getBranch: vi.fn(),
+}));
+
+vi.mock("../../api/deploy.js", () => ({
+  deployToMain: vi.fn(),
+}));
+
+vi.mock("../../api/build.js", () => ({
+  buildToTinybird: vi.fn(),
+}));
+
+vi.mock("../../api/local.js", () => ({
+  getLocalTokens: vi.fn(),
+  getOrCreateLocalWorkspace: vi.fn(),
+  LocalNotRunningError: class LocalNotRunningError extends Error {},
+}));
+
+vi.mock("../git.js", () => ({
+  sanitizeBranchName: (value: string) => value.replace(/[^a-zA-Z0-9]/g, "_"),
+  getCurrentGitBranch: vi.fn(() => "feature/test"),
+}));
 
 describe("Preview command", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
   describe("generatePreviewBranchName", () => {
     it("generates name with tmp_ci prefix", () => {
       const result = generatePreviewBranchName("feature-branch");
@@ -34,4 +72,97 @@ describe("Preview command", () => {
       expect(result1).toBe(result2);
     });
   });
+
+  describe("branch_data_mode wiring", () => {
+    it("uses config-only last_partition when creating cloud preview branch", async () => {
+      const { loadConfigAsync } = await import("../config.js");
+      const { buildFromInclude } = await import("../../generator/index.js");
+      const { getBranch, createBranch } = await import("../../api/branches.js");
+      const { deployToMain } = await import("../../api/deploy.js");
+
+      vi.mocked(loadConfigAsync).mockResolvedValue({
+        include: ["test.ts"],
+        token: "p.test-token",
+        baseUrl: "https://api.tinybird.co",
+        configPath: "/test/tinybird.config.json",
+        devMode: "branch",
+        cwd: "/test",
+        gitBranch: "feature-test",
+        tinybirdBranch: "feature_test",
+        isMainBranch: false,
+        branchDataMode: "last_partition",
+      });
+      vi.mocked(buildFromInclude).mockResolvedValue({
+        resources: { datasources: [], pipes: [], connections: [] },
+        entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
+        stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
+      });
+      vi.mocked(getBranch).mockRejectedValue(new Error("not found"));
+      vi.mocked(createBranch).mockResolvedValue({
+        id: "b1",
+        name: "tmp_ci_feature_test",
+        token: "p.branch",
+        created_at: "2024-01-01T00:00:00Z",
+      });
+      vi.mocked(deployToMain).mockResolvedValue({
+        success: true,
+        result: "success",
+        datasourceCount: 0,
+        pipeCount: 0,
+        connectionCount: 0,
+      });
+
+      await runPreview();
+      expect(createBranch).toHaveBeenCalledWith(
+        expect.any(Object),
+        "tmp_ci_feature_test",
+        { branch_data_mode: "last_partition" }
+      );
+    });
+
+    it("ignores config branch_data_mode in local mode", async () => {
+      const { loadConfigAsync } = await import("../config.js");
+      const { buildFromInclude } = await import("../../generator/index.js");
+      const { createBranch } = await import("../../api/branches.js");
+      const { getLocalTokens, getOrCreateLocalWorkspace } = await import("../../api/local.js");
+      const { buildToTinybird } = await import("../../api/build.js");
+
+      vi.mocked(loadConfigAsync).mockResolvedValue({
+        include: ["test.ts"],
+        token: "p.test-token",
+        baseUrl: "https://api.tinybird.co",
+        configPath: "/test/tinybird.config.json",
+        devMode: "local",
+        cwd: "/test",
+        gitBranch: "feature-test",
+        tinybirdBranch: "feature_test",
+        isMainBranch: false,
+        branchDataMode: "last_partition",
+      });
+      vi.mocked(buildFromInclude).mockResolvedValue({
+        resources: { datasources: [], pipes: [], connections: [] },
+        entities: { datasources: {}, pipes: {}, connections: {}, rawDatasources: [], rawPipes: [], sourceFiles: [] },
+        stats: { datasourceCount: 0, pipeCount: 0, connectionCount: 0 },
+      });
+      vi.mocked(getLocalTokens).mockResolvedValue({
+        admin_token: "admin-token",
+        user_token: "user-token",
+        workspace_admin_token: "workspace-admin-token",
+      });
+      vi.mocked(getOrCreateLocalWorkspace).mockResolvedValue({
+        workspace: { id: "lw1", name: "tmp_ci_feature_test", token: "local-token" },
+        wasCreated: true,
+      });
+      vi.mocked(buildToTinybird).mockResolvedValue({
+        success: true,
+        result: "success",
+        datasourceCount: 0,
+        pipeCount: 0,
+        connectionCount: 0,
+      });
+
+      await runPreview();
+      expect(createBranch).not.toHaveBeenCalled();
+    });
+  });
 });

package/src/cli/commands/preview.ts

@@ -4,7 +4,7 @@
 
 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 { createBranch, deleteBranch, getBranch, type CreateBranchOptions, type TinybirdBranch } from "../../api/branches.js";
 import { deployToMain } from "../../api/deploy.js";
 import { buildToTinybird } from "../../api/build.js";
 import {
@@ -226,6 +226,10 @@ export async function runPreview(options: PreviewCommandOptions = {}): Promise<P
   let branch: TinybirdBranch;
   try {
     const apiConfig = { baseUrl: config.baseUrl, token: config.token };
+    const branchOptions: CreateBranchOptions | undefined =
+      config.branchDataMode === "last_partition"
+        ? { branch_data_mode: "last_partition" }
+        : undefined;
 
     // Check if branch already exists and delete it for a fresh start
     try {
@@ -250,7 +254,7 @@ export async function runPreview(options: PreviewCommandOptions = {}): Promise<P
       console.log(`[debug] Creating preview branch: ${previewBranchName}`);
     }
 
-    branch = await createBranch(apiConfig, previewBranchName);
+    branch = await createBranch(apiConfig, previewBranchName, branchOptions);
 
     if (debug) {
       console.log(`[debug] Branch created: ${branch.name} (${branch.id})`);

package/src/cli/config-types.ts

@@ -11,6 +11,8 @@
  * - "local": Use local Tinybird container at localhost:7181
  */
 export type DevMode = "branch" | "local";
+export type BranchDataMode = "last_partition";
+export const BRANCH_DATA_MODE_VALUES = ["last_partition"] as const satisfies readonly BranchDataMode[];
 
 /**
  * Tinybird configuration file structure
@@ -26,4 +28,6 @@ export interface TinybirdConfig {
   baseUrl?: string;
   /** Development mode: "branch" (default) or "local" */
   devMode?: DevMode;
+  /** Branch data mode applied on cloud branch creation (shared snake_case key) */
+  branch_data_mode?: BranchDataMode;
 }

package/src/cli/config.test.ts

@@ -327,6 +327,129 @@ describe("Config", () => {
 
       expect(result.devMode).toBe("local");
     });
+
+    it("resolves branch_data_mode as last_partition", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        branch_data_mode: "last_partition",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      const result = loadConfig(tempDir);
+      expect(result.branchDataMode).toBe("last_partition");
+    });
+
+    it("defaults branch_data_mode to last_partition when missing", () => {
+      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.branchDataMode).toBe("last_partition");
+    });
+
+    it("defaults empty branch_data_mode to last_partition", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        branch_data_mode: "   ",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      const result = loadConfig(tempDir);
+      expect(result.branchDataMode).toBe("last_partition");
+    });
+
+    it("throws when branch_data_mode is all_partitions", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        branch_data_mode: "all_partitions",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      expect(() => loadConfig(tempDir)).toThrow("Invalid branch_data_mode");
+    });
+
+    it("throws when branch_data_mode is invalid", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        branch_data_mode: "invalid",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      expect(() => loadConfig(tempDir)).toThrow("Invalid branch_data_mode");
+    });
+
+    it("warns when branch_data_mode is set with devMode local", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        devMode: "local",
+        branch_data_mode: "last_partition",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+      const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+
+      loadConfig(tempDir);
+
+      expect(warnSpy).toHaveBeenCalledWith(
+        expect.stringContaining("branch_data_mode is set")
+      );
+    });
+
+    it("does not warn when branch_data_mode is implicit in local mode", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        devMode: "local",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+      const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+
+      loadConfig(tempDir);
+
+      expect(warnSpy).not.toHaveBeenCalled();
+    });
+
+    it("throws when legacy branch_data_on_create key is used", () => {
+      const config = {
+        include: ["lib/datasources.ts"],
+        token: "test-token",
+        branch_data_on_create: "last_partition",
+      };
+      fs.writeFileSync(
+        path.join(tempDir, "tinybird.json"),
+        JSON.stringify(config)
+      );
+
+      expect(() => loadConfig(tempDir)).toThrow("renamed to `branch_data_mode`");
+    });
   });
 
   describe("loadConfigAsync", () => {