npm - @tinybirdco/sdk - Versions diffs - 0.0.1 - Mend

@tinybirdco/sdk 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (258) hide show

package/README.md +518 -0
package/bin/tinybird.js +7 -0
package/dist/api/branches.d.ts +98 -0
package/dist/api/branches.d.ts.map +1 -0
package/dist/api/branches.js +203 -0
package/dist/api/branches.js.map +1 -0
package/dist/api/branches.test.d.ts +2 -0
package/dist/api/branches.test.d.ts.map +1 -0
package/dist/api/branches.test.js +286 -0
package/dist/api/branches.test.js.map +1 -0
package/dist/api/build.d.ts +130 -0
package/dist/api/build.d.ts.map +1 -0
package/dist/api/build.js +143 -0
package/dist/api/build.js.map +1 -0
package/dist/api/build.test.d.ts +2 -0
package/dist/api/build.test.d.ts.map +1 -0
package/dist/api/build.test.js +138 -0
package/dist/api/build.test.js.map +1 -0
package/dist/api/deploy.d.ts +39 -0
package/dist/api/deploy.d.ts.map +1 -0
package/dist/api/deploy.js +135 -0
package/dist/api/deploy.js.map +1 -0
package/dist/api/deploy.test.d.ts +2 -0
package/dist/api/deploy.test.d.ts.map +1 -0
package/dist/api/deploy.test.js +118 -0
package/dist/api/deploy.test.js.map +1 -0
package/dist/api/workspaces.d.ts +46 -0
package/dist/api/workspaces.d.ts.map +1 -0
package/dist/api/workspaces.js +39 -0
package/dist/api/workspaces.js.map +1 -0
package/dist/api/workspaces.test.d.ts +2 -0
package/dist/api/workspaces.test.d.ts.map +1 -0
package/dist/api/workspaces.test.js +65 -0
package/dist/api/workspaces.test.js.map +1 -0
package/dist/cli/auth.d.ts +86 -0
package/dist/cli/auth.d.ts.map +1 -0
package/dist/cli/auth.js +284 -0
package/dist/cli/auth.js.map +1 -0
package/dist/cli/branch-store.d.ts +53 -0
package/dist/cli/branch-store.d.ts.map +1 -0
package/dist/cli/branch-store.js +91 -0
package/dist/cli/branch-store.js.map +1 -0
package/dist/cli/branch-store.test.d.ts +2 -0
package/dist/cli/branch-store.test.d.ts.map +1 -0
package/dist/cli/branch-store.test.js +115 -0
package/dist/cli/branch-store.test.js.map +1 -0
package/dist/cli/commands/branch.d.ts +82 -0
package/dist/cli/commands/branch.d.ts.map +1 -0
package/dist/cli/commands/branch.js +215 -0
package/dist/cli/commands/branch.js.map +1 -0
package/dist/cli/commands/build.d.ts +43 -0
package/dist/cli/commands/build.d.ts.map +1 -0
package/dist/cli/commands/build.js +138 -0
package/dist/cli/commands/build.js.map +1 -0
package/dist/cli/commands/dev.d.ts +78 -0
package/dist/cli/commands/dev.d.ts.map +1 -0
package/dist/cli/commands/dev.js +226 -0
package/dist/cli/commands/dev.js.map +1 -0
package/dist/cli/commands/init.d.ts +45 -0
package/dist/cli/commands/init.d.ts.map +1 -0
package/dist/cli/commands/init.js +277 -0
package/dist/cli/commands/init.js.map +1 -0
package/dist/cli/commands/init.test.d.ts +2 -0
package/dist/cli/commands/init.test.d.ts.map +1 -0
package/dist/cli/commands/init.test.js +158 -0
package/dist/cli/commands/init.test.js.map +1 -0
package/dist/cli/commands/login.d.ts +37 -0
package/dist/cli/commands/login.d.ts.map +1 -0
package/dist/cli/commands/login.js +64 -0
package/dist/cli/commands/login.js.map +1 -0
package/dist/cli/config.d.ts +114 -0
package/dist/cli/config.d.ts.map +1 -0
package/dist/cli/config.js +258 -0
package/dist/cli/config.js.map +1 -0
package/dist/cli/config.test.d.ts +2 -0
package/dist/cli/config.test.d.ts.map +1 -0
package/dist/cli/config.test.js +243 -0
package/dist/cli/config.test.js.map +1 -0
package/dist/cli/env.d.ts +29 -0
package/dist/cli/env.d.ts.map +1 -0
package/dist/cli/env.js +66 -0
package/dist/cli/env.js.map +1 -0
package/dist/cli/git.d.ts +29 -0
package/dist/cli/git.d.ts.map +1 -0
package/dist/cli/git.js +114 -0
package/dist/cli/git.js.map +1 -0
package/dist/cli/git.test.d.ts +2 -0
package/dist/cli/git.test.d.ts.map +1 -0
package/dist/cli/git.test.js +125 -0
package/dist/cli/git.test.js.map +1 -0
package/dist/cli/index.d.ts +7 -0
package/dist/cli/index.d.ts.map +1 -0
package/dist/cli/index.js +337 -0
package/dist/cli/index.js.map +1 -0
package/dist/cli/utils/schema-validation.d.ts +95 -0
package/dist/cli/utils/schema-validation.d.ts.map +1 -0
package/dist/cli/utils/schema-validation.js +175 -0
package/dist/cli/utils/schema-validation.js.map +1 -0
package/dist/cli/utils/schema-validation.test.d.ts +5 -0
package/dist/cli/utils/schema-validation.test.d.ts.map +1 -0
package/dist/cli/utils/schema-validation.test.js +173 -0
package/dist/cli/utils/schema-validation.test.js.map +1 -0
package/dist/client/base.d.ts +116 -0
package/dist/client/base.d.ts.map +1 -0
package/dist/client/base.js +328 -0
package/dist/client/base.js.map +1 -0
package/dist/client/types.d.ts +137 -0
package/dist/client/types.d.ts.map +1 -0
package/dist/client/types.js +43 -0
package/dist/client/types.js.map +1 -0
package/dist/generator/client.d.ts +44 -0
package/dist/generator/client.d.ts.map +1 -0
package/dist/generator/client.js +144 -0
package/dist/generator/client.js.map +1 -0
package/dist/generator/datasource.d.ts +57 -0
package/dist/generator/datasource.d.ts.map +1 -0
package/dist/generator/datasource.js +169 -0
package/dist/generator/datasource.js.map +1 -0
package/dist/generator/datasource.test.d.ts +2 -0
package/dist/generator/datasource.test.d.ts.map +1 -0
package/dist/generator/datasource.test.js +254 -0
package/dist/generator/datasource.test.js.map +1 -0
package/dist/generator/index.d.ts +131 -0
package/dist/generator/index.d.ts.map +1 -0
package/dist/generator/index.js +121 -0
package/dist/generator/index.js.map +1 -0
package/dist/generator/index.test.d.ts +2 -0
package/dist/generator/index.test.d.ts.map +1 -0
package/dist/generator/index.test.js +175 -0
package/dist/generator/index.test.js.map +1 -0
package/dist/generator/loader.d.ts +156 -0
package/dist/generator/loader.d.ts.map +1 -0
package/dist/generator/loader.js +295 -0
package/dist/generator/loader.js.map +1 -0
package/dist/generator/pipe.d.ts +72 -0
package/dist/generator/pipe.d.ts.map +1 -0
package/dist/generator/pipe.js +174 -0
package/dist/generator/pipe.js.map +1 -0
package/dist/generator/pipe.test.d.ts +2 -0
package/dist/generator/pipe.test.d.ts.map +1 -0
package/dist/generator/pipe.test.js +393 -0
package/dist/generator/pipe.test.js.map +1 -0
package/dist/index.d.ts +74 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +73 -0
package/dist/index.js.map +1 -0
package/dist/infer/index.d.ts +202 -0
package/dist/infer/index.d.ts.map +1 -0
package/dist/infer/index.js +5 -0
package/dist/infer/index.js.map +1 -0
package/dist/schema/datasource.d.ts +135 -0
package/dist/schema/datasource.d.ts.map +1 -0
package/dist/schema/datasource.js +105 -0
package/dist/schema/datasource.js.map +1 -0
package/dist/schema/datasource.test.d.ts +2 -0
package/dist/schema/datasource.test.d.ts.map +1 -0
package/dist/schema/datasource.test.js +142 -0
package/dist/schema/datasource.test.js.map +1 -0
package/dist/schema/engines.d.ts +157 -0
package/dist/schema/engines.d.ts.map +1 -0
package/dist/schema/engines.js +155 -0
package/dist/schema/engines.js.map +1 -0
package/dist/schema/engines.test.d.ts +2 -0
package/dist/schema/engines.test.d.ts.map +1 -0
package/dist/schema/engines.test.js +221 -0
package/dist/schema/engines.test.js.map +1 -0
package/dist/schema/params.d.ts +106 -0
package/dist/schema/params.d.ts.map +1 -0
package/dist/schema/params.js +138 -0
package/dist/schema/params.js.map +1 -0
package/dist/schema/params.test.d.ts +2 -0
package/dist/schema/params.test.d.ts.map +1 -0
package/dist/schema/params.test.js +175 -0
package/dist/schema/params.test.js.map +1 -0
package/dist/schema/pipe.d.ts +436 -0
package/dist/schema/pipe.d.ts.map +1 -0
package/dist/schema/pipe.js +484 -0
package/dist/schema/pipe.js.map +1 -0
package/dist/schema/pipe.test.d.ts +2 -0
package/dist/schema/pipe.test.d.ts.map +1 -0
package/dist/schema/pipe.test.js +488 -0
package/dist/schema/pipe.test.js.map +1 -0
package/dist/schema/project.d.ts +202 -0
package/dist/schema/project.d.ts.map +1 -0
package/dist/schema/project.js +188 -0
package/dist/schema/project.js.map +1 -0
package/dist/schema/project.test.d.ts +2 -0
package/dist/schema/project.test.d.ts.map +1 -0
package/dist/schema/project.test.js +180 -0
package/dist/schema/project.test.js.map +1 -0
package/dist/schema/types.d.ts +140 -0
package/dist/schema/types.d.ts.map +1 -0
package/dist/schema/types.js +174 -0
package/dist/schema/types.js.map +1 -0
package/dist/schema/types.test.d.ts +2 -0
package/dist/schema/types.test.d.ts.map +1 -0
package/dist/schema/types.test.js +176 -0
package/dist/schema/types.test.js.map +1 -0
package/dist/test/handlers.d.ts +58 -0
package/dist/test/handlers.d.ts.map +1 -0
package/dist/test/handlers.js +62 -0
package/dist/test/handlers.js.map +1 -0
package/dist/test/setup.d.ts +5 -0
package/dist/test/setup.d.ts.map +1 -0
package/dist/test/setup.js +11 -0
package/dist/test/setup.js.map +1 -0
package/package.json +57 -0
package/src/api/branches.test.ts +377 -0
package/src/api/branches.ts +334 -0
package/src/api/build.test.ts +216 -0
package/src/api/build.ts +266 -0
package/src/api/deploy.test.ts +193 -0
package/src/api/deploy.ts +163 -0
package/src/api/workspaces.test.ts +81 -0
package/src/api/workspaces.ts +77 -0
package/src/cli/auth.ts +358 -0
package/src/cli/branch-store.test.ts +139 -0
package/src/cli/branch-store.ts +137 -0
package/src/cli/commands/branch.ts +306 -0
package/src/cli/commands/build.ts +183 -0
package/src/cli/commands/dev.ts +334 -0
package/src/cli/commands/init.test.ts +249 -0
package/src/cli/commands/init.ts +323 -0
package/src/cli/commands/login.ts +98 -0
package/src/cli/config.test.ts +359 -0
package/src/cli/config.ts +335 -0
package/src/cli/env.ts +86 -0
package/src/cli/git.test.ts +147 -0
package/src/cli/git.ts +125 -0
package/src/cli/index.ts +382 -0
package/src/cli/utils/schema-validation.test.ts +222 -0
package/src/cli/utils/schema-validation.ts +272 -0
package/src/client/base.ts +414 -0
package/src/client/types.ts +165 -0
package/src/generator/client.ts +194 -0
package/src/generator/datasource.test.ts +297 -0
package/src/generator/datasource.ts +217 -0
package/src/generator/index.test.ts +209 -0
package/src/generator/index.ts +203 -0
package/src/generator/loader.ts +406 -0
package/src/generator/pipe.test.ts +441 -0
package/src/generator/pipe.ts +220 -0
package/src/index.ts +191 -0
package/src/infer/index.ts +247 -0
package/src/schema/datasource.test.ts +187 -0
package/src/schema/datasource.ts +195 -0
package/src/schema/engines.test.ts +247 -0
package/src/schema/engines.ts +271 -0
package/src/schema/params.test.ts +208 -0
package/src/schema/params.ts +249 -0
package/src/schema/pipe.test.ts +588 -0
package/src/schema/pipe.ts +832 -0
package/src/schema/project.test.ts +236 -0
package/src/schema/project.ts +394 -0
package/src/schema/types.test.ts +212 -0
package/src/schema/types.ts +366 -0
package/src/test/handlers.ts +79 -0
package/src/test/setup.ts +13 -0

package/src/api/workspaces.ts ADDED Viewed

@@ -0,0 +1,77 @@
+/**
+ * Tinybird Workspace API client
+ */
+/**
+ * Workspace information from Tinybird API
+ */
+export interface TinybirdWorkspace {
+  /** Workspace ID (UUID) */
+  id: string;
+  /** Workspace name */
+  name: string;
+  /** User ID of the workspace owner */
+  user_id: string;
+  /** Email of the workspace owner */
+  user_email: string;
+  /** Workspace scope */
+  scope: string;
+  /** Main branch (null for main workspace) */
+  main: string | null;
+}
+/**
+ * API configuration for workspace operations
+ */
+export interface WorkspaceApiConfig {
+  /** Tinybird API base URL */
+  baseUrl: string;
+  /** Workspace token */
+  token: string;
+}
+/**
+ * Error thrown by workspace API operations
+ */
+export class WorkspaceApiError extends Error {
+  constructor(
+    message: string,
+    public readonly status: number,
+    public readonly body?: unknown
+  ) {
+    super(message);
+    this.name = "WorkspaceApiError";
+  }
+}
+/**
+ * Get workspace information
+ * GET /v1/workspace
+ *
+ * @param config - API configuration
+ * @returns Workspace information
+ */
+export async function getWorkspace(
+  config: WorkspaceApiConfig
+): Promise<TinybirdWorkspace> {
+  const url = new URL("/v1/workspace", config.baseUrl);
+  const response = await fetch(url.toString(), {
+    method: "GET",
+    headers: {
+      Authorization: `Bearer ${config.token}`,
+    },
+  });
+  if (!response.ok) {
+    const body = await response.text();
+    throw new WorkspaceApiError(
+      `Failed to get workspace: ${response.status} ${response.statusText}`,
+      response.status,
+      body
+    );
+  }
+  const data = (await response.json()) as TinybirdWorkspace;
+  return data;
+}

package/src/cli/auth.ts ADDED Viewed

@@ -0,0 +1,358 @@
+/**
+ * Browser-based authentication for Tinybird CLI
+ *
+ * Implements OAuth flow via local HTTP server callback
+ */
+import * as http from "node:http";
+import { spawn } from "node:child_process";
+import { platform } from "node:os";
+import { URL } from "node:url";
+/**
+ * Port for the local OAuth callback server
+ */
+export const AUTH_SERVER_PORT = 49160;
+/**
+ * Default auth host (Tinybird cloud)
+ */
+export const DEFAULT_AUTH_HOST = "https://cloud.tinybird.co";
+/**
+ * Default API host (EU region)
+ */
+export const DEFAULT_API_HOST = "https://api.tinybird.co";
+/**
+ * Maximum time to wait for authentication (in seconds)
+ */
+export const SERVER_MAX_WAIT_TIME = 180;
+/**
+ * Get the auth host from environment or use default
+ */
+export function getAuthHost(): string {
+  return process.env.TINYBIRD_AUTH_HOST ?? DEFAULT_AUTH_HOST;
+}
+/**
+ * Result of a login attempt
+ */
+export interface AuthResult {
+  success: boolean;
+  token?: string;
+  baseUrl?: string;
+  workspaceName?: string;
+  userEmail?: string;
+  error?: string;
+}
+/**
+ * Options for the browser login flow
+ */
+export interface LoginOptions {
+  /** Override the default auth host */
+  authHost?: string;
+  /** Override the API host (region) */
+  apiHost?: string;
+}
+/**
+ * Token response from Tinybird auth API
+ */
+interface TokenResponse {
+  workspace_token: string;
+  user_token: string;
+  api_host: string;
+  workspace_name?: string;
+  user_email?: string;
+}
+/**
+ * Generate the HTML callback page served by the local server
+ *
+ * This page extracts the code from the query string and POSTs it back to the server
+ *
+ * NOTE: State parameter validation is disabled until Tinybird backend supports it.
+ * TODO: Re-enable state validation once /api/cli-login echoes back the state parameter.
+ */
+function getCallbackHtml(authHost: string): string {
+  return `<!DOCTYPE html>
+<html>
+<head>
+  <style>
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
+      background: #f5f5f5;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      height: 100vh;
+      margin: 0;
+    }
+    .container {
+      text-align: center;
+      padding: 2rem;
+    }
+    .spinner {
+      border: 3px solid #e0e0e0;
+      border-top: 3px solid #333;
+      border-radius: 50%;
+      width: 30px;
+      height: 30px;
+      animation: spin 1s linear infinite;
+      margin: 0 auto 1rem;
+    }
+    @keyframes spin {
+      0% { transform: rotate(0deg); }
+      100% { transform: rotate(360deg); }
+    }
+  </style>
+</head>
+<body>
+  <div class="container">
+    <div class="spinner"></div>
+    <p>Completing authentication...</p>
+  </div>
+  <script>
+    const searchParams = new URLSearchParams(window.location.search);
+    const code = searchParams.get('code');
+    const workspace = searchParams.get('workspace');
+    const region = searchParams.get('region');
+    const provider = searchParams.get('provider');
+    const host = "${authHost}";
+    if (!code) {
+      document.querySelector('.container').innerHTML = '<p>Missing authentication code. Please try again.</p>';
+    } else {
+      fetch('/?code=' + encodeURIComponent(code), { method: 'POST' })
+        .then(() => {
+          if (provider && region && workspace) {
+            window.location.href = host + "/" + provider + "/" + region + "/cli-login?workspace=" + workspace;
+          } else {
+            document.querySelector('.container').innerHTML = '<p>Authentication successful! You can close this tab.</p>';
+          }
+        })
+        .catch(() => {
+          document.querySelector('.container').innerHTML = '<p>Authentication failed. Please try again.</p>';
+        });
+    }
+  </script>
+</body>
+</html>`;
+}
+/**
+ * Start a local HTTP server to receive the OAuth callback
+ *
+ * @param onCode - Callback invoked when auth code is received
+ * @param authHost - Auth host for redirect URL in HTML
+ * @returns Promise that resolves to the server instance
+ *
+ * NOTE: State parameter validation is disabled until Tinybird backend supports it.
+ */
+function startAuthServer(
+  onCode: (code: string) => void,
+  authHost: string
+): Promise<http.Server> {
+  return new Promise((resolve, reject) => {
+    const server = http.createServer((req, res) => {
+      const url = new URL(req.url ?? "/", `http://localhost:${AUTH_SERVER_PORT}`);
+      if (req.method === "GET") {
+        // Serve the callback HTML page
+        res.writeHead(200, { "Content-Type": "text/html" });
+        res.end(getCallbackHtml(authHost));
+      } else if (req.method === "POST") {
+        // Receive the auth code
+        const code = url.searchParams.get("code");
+        if (!code) {
+          res.writeHead(400);
+          res.end("Missing code parameter");
+          return;
+        }
+        onCode(code);
+        res.writeHead(200);
+        res.end();
+      } else {
+        res.writeHead(405);
+        res.end("Method not allowed");
+      }
+    });
+    server.on("error", (err) => {
+      reject(new Error(`Failed to start auth server: ${err.message}`));
+    });
+    // Bind to localhost only for security (prevents network access)
+    server.listen(AUTH_SERVER_PORT, "127.0.0.1", () => {
+      resolve(server);
+    });
+  });
+}
+/**
+ * Open a URL in the user's default browser
+ *
+ * Cross-platform support for macOS, Linux, and Windows
+ *
+ * @param url - URL to open
+ * @returns Promise that resolves to true if browser was opened successfully
+ */
+export async function openBrowser(url: string): Promise<boolean> {
+  const os = platform();
+  let command: string;
+  let args: string[];
+  switch (os) {
+    case "darwin":
+      command = "open";
+      args = [url];
+      break;
+    case "win32":
+      command = "cmd";
+      args = ["/c", "start", "", url];
+      break;
+    default:
+      // Linux and others
+      command = "xdg-open";
+      args = [url];
+      break;
+  }
+  return new Promise((resolve) => {
+    try {
+      const child = spawn(command, args, {
+        detached: true,
+        stdio: "ignore",
+      });
+      child.unref();
+      child.on("error", () => {
+        resolve(false);
+      });
+      // Give it a moment to potentially fail
+      setTimeout(() => resolve(true), 500);
+    } catch {
+      resolve(false);
+    }
+  });
+}
+/**
+ * Exchange an authorization code for tokens
+ *
+ * @param code - Authorization code from OAuth callback
+ * @param authHost - Auth host URL
+ * @returns Promise that resolves to token response
+ */
+export async function exchangeCodeForTokens(
+  code: string,
+  authHost: string
+): Promise<TokenResponse> {
+  const url = new URL("/api/cli-login", authHost);
+  url.searchParams.set("code", code);
+  const response = await fetch(url.toString());
+  if (!response.ok) {
+    const body = await response.text();
+    throw new Error(
+      `Token exchange failed: ${response.status} ${response.statusText}\n${body}`
+    );
+  }
+  return (await response.json()) as TokenResponse;
+}
+/**
+ * Perform browser-based login flow
+ *
+ * 1. Starts a local HTTP server for OAuth callback
+ * 2. Opens the user's browser to the auth URL
+ * 3. Waits for the callback with auth code
+ * 4. Exchanges the code for tokens
+ *
+ * @param options - Login options
+ * @returns Promise that resolves to auth result
+ */
+export async function browserLogin(
+  options: LoginOptions = {}
+): Promise<AuthResult> {
+  const authHost = options.authHost ?? getAuthHost();
+  const apiHost = options.apiHost ?? DEFAULT_API_HOST;
+  let server: http.Server | null = null;
+  let timeoutId: ReturnType<typeof setTimeout> | null = null;
+  try {
+    // Start the server first
+    const serverPromise = new Promise<{ server: http.Server; code: string }>((resolve, reject) => {
+      // Set up timeout
+      timeoutId = setTimeout(() => {
+        reject(new Error("Authentication timed out after 180 seconds"));
+      }, SERVER_MAX_WAIT_TIME * 1000);
+      startAuthServer(
+        (code) => {
+          if (timeoutId) clearTimeout(timeoutId);
+          if (server) {
+            resolve({ server, code });
+          }
+        },
+        authHost
+      )
+        .then((srv) => {
+          server = srv;
+        })
+        .catch(reject);
+    });
+    // Wait for server to start
+    await new Promise<void>((resolve) => setTimeout(resolve, 100));
+    // Build auth URL
+    const authUrl = new URL("/api/cli-login", authHost);
+    authUrl.searchParams.set("apiHost", apiHost);
+    console.log("Opening browser for authentication...");
+    // Open browser
+    await openBrowser(authUrl.toString());
+    console.log("\nIf the browser doesn't open, please visit:");
+    console.log(authUrl.toString());
+    // Wait for auth code
+    const { code } = await serverPromise;
+    // Exchange code for tokens
+    console.log("\nExchanging code for tokens...");
+    const tokens = await exchangeCodeForTokens(code, authHost);
+    return {
+      success: true,
+      token: tokens.workspace_token,
+      baseUrl: tokens.api_host,
+      workspaceName: tokens.workspace_name,
+      userEmail: tokens.user_email,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      error: (error as Error).message,
+    };
+  } finally {
+    // Clean up
+    if (timeoutId) clearTimeout(timeoutId);
+    if (server) {
+      (server as http.Server).close();
+    }
+  }
+}

package/src/cli/branch-store.test.ts ADDED Viewed

@@ -0,0 +1,139 @@
+import { describe, it, expect, beforeEach, afterEach } from "vitest";
+import * as fs from "fs";
+import * as path from "path";
+import * as os from "os";
+import {
+  loadBranchStore,
+  saveBranchStore,
+  getBranchToken,
+  setBranchToken,
+  removeBranch,
+  listCachedBranches,
+  type BranchStore,
+} from "./branch-store.js";
+describe("Branch store", () => {
+  let originalHome: string | undefined;
+  let testHomeDir: string;
+  beforeEach(() => {
+    // Create unique test directory for each test
+    testHomeDir = path.join(os.tmpdir(), ".tinybird-test-" + Date.now() + "-" + Math.random().toString(36).slice(2));
+    fs.mkdirSync(testHomeDir, { recursive: true });
+    // Mock HOME to use test directory
+    originalHome = process.env.HOME;
+    process.env.HOME = testHomeDir;
+  });
+  afterEach(() => {
+    // Restore original HOME
+    if (originalHome !== undefined) {
+      process.env.HOME = originalHome;
+    }
+    // Clean up test directory
+    try {
+      fs.rmSync(testHomeDir, { recursive: true });
+    } catch {
+      // Ignore cleanup errors
+    }
+  });
+  describe("loadBranchStore", () => {
+    it("returns empty store when file does not exist", () => {
+      const store = loadBranchStore();
+      expect(store).toEqual({ workspaces: {} });
+    });
+  });
+  describe("saveBranchStore and loadBranchStore", () => {
+    it("round-trips store data", () => {
+      const store: BranchStore = {
+        workspaces: {
+          ws_123: {
+            branches: {
+              "feature-a": {
+                id: "branch-id-1",
+                token: "p.token1",
+                createdAt: "2024-01-01T00:00:00Z",
+              },
+            },
+          },
+        },
+      };
+      saveBranchStore(store);
+      const loaded = loadBranchStore();
+      expect(loaded).toEqual(store);
+    });
+  });
+  describe("getBranchToken and setBranchToken", () => {
+    it("returns null for non-existent branch", () => {
+      const result = getBranchToken("ws_123", "non-existent");
+      expect(result).toBeNull();
+    });
+    it("sets and gets branch token", () => {
+      const info = {
+        id: "branch-id-2",
+        token: "p.token2",
+        createdAt: "2024-01-02T00:00:00Z",
+      };
+      setBranchToken("ws_456", "feature-b", info);
+      const result = getBranchToken("ws_456", "feature-b");
+      expect(result).toEqual(info);
+    });
+  });
+  describe("removeBranch", () => {
+    it("removes a cached branch", () => {
+      const info = {
+        id: "branch-id-3",
+        token: "p.token3",
+        createdAt: "2024-01-03T00:00:00Z",
+      };
+      setBranchToken("ws_789", "feature-c", info);
+      expect(getBranchToken("ws_789", "feature-c")).toEqual(info);
+      removeBranch("ws_789", "feature-c");
+      expect(getBranchToken("ws_789", "feature-c")).toBeNull();
+    });
+    it("does nothing for non-existent branch", () => {
+      // Should not throw
+      removeBranch("ws_nonexistent", "no-branch");
+    });
+  });
+  describe("listCachedBranches", () => {
+    it("returns empty object for workspace with no branches", () => {
+      const result = listCachedBranches("ws_empty");
+      expect(result).toEqual({});
+    });
+    it("returns all branches for a workspace", () => {
+      const info1 = {
+        id: "branch-id-4",
+        token: "p.token4",
+        createdAt: "2024-01-04T00:00:00Z",
+      };
+      const info2 = {
+        id: "branch-id-5",
+        token: "p.token5",
+        createdAt: "2024-01-05T00:00:00Z",
+      };
+      setBranchToken("ws_list", "feature-d", info1);
+      setBranchToken("ws_list", "feature-e", info2);
+      const result = listCachedBranches("ws_list");
+      expect(result).toEqual({
+        "feature-d": info1,
+        "feature-e": info2,
+      });
+    });
+  });
+});

package/src/cli/branch-store.ts ADDED Viewed

@@ -0,0 +1,137 @@
+/**
+ * Branch token storage in ~/.tinybird/branches.json
+ */
+import * as fs from "fs";
+import * as path from "path";
+import * as os from "os";
+/**
+ * Information about a cached branch
+ */
+export interface BranchInfo {
+  /** Branch ID from Tinybird */
+  id: string;
+  /** Branch token for API access */
+  token: string;
+  /** When the branch was created/cached */
+  createdAt: string;
+}
+/**
+ * Structure of the branches.json file
+ */
+export interface BranchStore {
+  workspaces: Record<
+    string,
+    {
+      branches: Record<string, BranchInfo>;
+    }
+  >;
+}
+/**
+ * Get the path to the branches.json file
+ */
+export function getBranchStorePath(): string {
+  return path.join(os.homedir(), ".tinybird", "branches.json");
+}
+/**
+ * Ensure the ~/.tinybird directory exists
+ */
+function ensureTinybirdDir(): void {
+  const tinybirdDir = path.join(os.homedir(), ".tinybird");
+  if (!fs.existsSync(tinybirdDir)) {
+    try {
+      fs.mkdirSync(tinybirdDir, { recursive: true });
+    } catch (error) {
+      const message = error instanceof Error ? error.message : String(error);
+      throw new Error(
+        `Failed to create Tinybird config directory at ${tinybirdDir}: ${message}. ` +
+          `Please ensure you have write permissions to your home directory.`
+      );
+    }
+  }
+}
+/**
+ * Load the branch store from disk
+ * Returns an empty store if the file doesn't exist
+ */
+export function loadBranchStore(): BranchStore {
+  const storePath = getBranchStorePath();
+  if (!fs.existsSync(storePath)) {
+    return { workspaces: {} };
+  }
+  try {
+    const content = fs.readFileSync(storePath, "utf-8");
+    return JSON.parse(content) as BranchStore;
+  } catch {
+    // If the file is corrupted, return empty store
+    return { workspaces: {} };
+  }
+}
+/**
+ * Save the branch store to disk
+ */
+export function saveBranchStore(store: BranchStore): void {
+  ensureTinybirdDir();
+  const storePath = getBranchStorePath();
+  fs.writeFileSync(storePath, JSON.stringify(store, null, 2), "utf-8");
+}
+/**
+ * Get a cached branch token
+ * Returns null if not cached
+ */
+export function getBranchToken(
+  workspaceId: string,
+  branchName: string
+): BranchInfo | null {
+  const store = loadBranchStore();
+  return store.workspaces[workspaceId]?.branches[branchName] ?? null;
+}
+/**
+ * Cache a branch token
+ */
+export function setBranchToken(
+  workspaceId: string,
+  branchName: string,
+  info: BranchInfo
+): void {
+  const store = loadBranchStore();
+  if (!store.workspaces[workspaceId]) {
+    store.workspaces[workspaceId] = { branches: {} };
+  }
+  store.workspaces[workspaceId].branches[branchName] = info;
+  saveBranchStore(store);
+}
+/**
+ * Remove a cached branch
+ */
+export function removeBranch(workspaceId: string, branchName: string): void {
+  const store = loadBranchStore();
+  if (store.workspaces[workspaceId]?.branches[branchName]) {
+    delete store.workspaces[workspaceId].branches[branchName];
+    saveBranchStore(store);
+  }
+}
+/**
+ * List all cached branches for a workspace
+ */
+export function listCachedBranches(
+  workspaceId: string
+): Record<string, BranchInfo> {
+  const store = loadBranchStore();
+  return store.workspaces[workspaceId]?.branches ?? {};
+}