@tinybirdco/sdk 0.0.6 → 0.0.7

package/src/api/deploy.ts

@@ -5,6 +5,7 @@
 
 import type { GeneratedResources } from "../generator/index.js";
 import type { BuildConfig, BuildApiResult } from "./build.js";
+import { tinybirdFetch } from "./fetcher.js";
 
 /**
  * Deployment object returned by the /v1/deploy endpoint
@@ -75,7 +76,12 @@ export interface DeploymentStatusResponse {
 export async function deployToMain(
   config: BuildConfig,
   resources: GeneratedResources,
-  options?: { debug?: boolean; pollIntervalMs?: number; maxPollAttempts?: number }
+  options?: {
+    debug?: boolean;
+    pollIntervalMs?: number;
+    maxPollAttempts?: number;
+    check?: boolean;
+  }
 ): Promise<BuildApiResult> {
   const debug = options?.debug ?? !!process.env.TINYBIRD_DEBUG;
   const pollIntervalMs = options?.pollIntervalMs ?? 1000;
@@ -117,7 +123,7 @@ export async function deployToMain(
   // Step 0: Clean up any stale non-live deployments that might block the new deployment
   try {
     const deploymentsUrl = `${baseUrl}/v1/deployments`;
-    const deploymentsResponse = await fetch(deploymentsUrl, {
+    const deploymentsResponse = await tinybirdFetch(deploymentsUrl, {
       headers: {
         Authorization: `Bearer ${config.token}`,
       },
@@ -133,7 +139,7 @@ export async function deployToMain(
         if (debug) {
           console.log(`[debug] Cleaning up stale deployment: ${stale.id} (status: ${stale.status})`);
         }
-        await fetch(`${baseUrl}/v1/deployments/${stale.id}`, {
+        await tinybirdFetch(`${baseUrl}/v1/deployments/${stale.id}`, {
           method: "DELETE",
           headers: {
             Authorization: `Bearer ${config.token}`,
@@ -149,13 +155,14 @@ export async function deployToMain(
   }
 
   // Step 1: Create deployment via /v1/deploy
-  const deployUrl = `${baseUrl}/v1/deploy`;
+  const deployUrlBase = `${baseUrl}/v1/deploy`;
+  const deployUrl = options?.check ? `${deployUrlBase}?check=true` : deployUrlBase;
 
   if (debug) {
     console.log(`[debug] POST ${deployUrl}`);
   }
 
-  const response = await fetch(deployUrl, {
+  const response = await tinybirdFetch(deployUrl, {
     method: "POST",
     headers: {
       Authorization: `Bearer ${config.token}`,
@@ -205,6 +212,27 @@ export async function deployToMain(
     };
   }
 
+  if (options?.check) {
+    if (body.result === "failed") {
+      return {
+        success: false,
+        result: "failed",
+        error: formatErrors(),
+        datasourceCount: resources.datasources.length,
+        pipeCount: resources.pipes.length,
+        connectionCount: resources.connections?.length ?? 0,
+      };
+    }
+
+    return {
+      success: true,
+      result: body.result ?? "success",
+      datasourceCount: resources.datasources.length,
+      pipeCount: resources.pipes.length,
+      connectionCount: resources.connections?.length ?? 0,
+    };
+  }
+
   // Handle API result
   if (body.result === "failed" || !body.deployment) {
     return {
@@ -236,7 +264,7 @@ export async function deployToMain(
     }
 
     const statusUrl = `${baseUrl}/v1/deployments/${deploymentId}`;
-    const statusResponse = await fetch(statusUrl, {
+    const statusResponse = await tinybirdFetch(statusUrl, {
       headers: {
         Authorization: `Bearer ${config.token}`,
       },
@@ -294,7 +322,7 @@ export async function deployToMain(
     console.log(`[debug] POST ${setLiveUrl}`);
   }
 
-  const setLiveResponse = await fetch(setLiveUrl, {
+  const setLiveResponse = await tinybirdFetch(setLiveUrl, {
     method: "POST",
     headers: {
       Authorization: `Bearer ${config.token}`,

package/src/api/fetcher.ts

@@ -0,0 +1,17 @@
+export const TINYBIRD_FROM_PARAM = "ts-sdk";
+
+export type TinybirdFetch = (url: string, init?: RequestInit) => Promise<Response>;
+
+export function withTinybirdFromParam(url: string): string {
+  const parsedUrl = new URL(url);
+  parsedUrl.searchParams.set("from", TINYBIRD_FROM_PARAM);
+  return parsedUrl.toString();
+}
+
+export function createTinybirdFetcher(fetchFn: typeof fetch): TinybirdFetch {
+  return (url, init) => fetchFn(withTinybirdFromParam(url), init);
+}
+
+export function tinybirdFetch(url: string, init?: RequestInit): Promise<Response> {
+  return fetch(withTinybirdFromParam(url), init);
+}

package/src/api/local.test.ts

@@ -94,15 +94,18 @@ describe("Local API", () => {
   describe("listLocalWorkspaces", () => {
     it("returns list of workspaces", async () => {
       server.use(
-        http.get(`${LOCAL_BASE_URL}/v1/user/workspaces`, () => {
-          return HttpResponse.json({
-            organization_id: "org-123",
-            workspaces: [
-              { id: "ws-1", name: "Workspace1", token: "token-1" },
-              { id: "ws-2", name: "Workspace2", token: "token-2" },
-            ],
-          });
-        })
+        http.get(
+          `${LOCAL_BASE_URL}/v1/user/workspaces`,
+          () => {
+            return HttpResponse.json({
+              organization_id: "org-123",
+              workspaces: [
+                { id: "ws-1", name: "Workspace1", token: "token-1" },
+                { id: "ws-2", name: "Workspace2", token: "token-2" },
+              ],
+            });
+          }
+        )
       );
 
       const result = await listLocalWorkspaces("admin-token");
@@ -118,9 +121,12 @@ describe("Local API", () => {
 
     it("throws LocalApiError on failure", async () => {
       server.use(
-        http.get(`${LOCAL_BASE_URL}/v1/user/workspaces`, () => {
-          return new HttpResponse("Not found", { status: 404 });
-        })
+        http.get(
+          `${LOCAL_BASE_URL}/v1/user/workspaces`,
+          () => {
+            return new HttpResponse("Not found", { status: 404 });
+          }
+        )
       );
 
       await expect(listLocalWorkspaces("admin-token")).rejects.toThrow(LocalApiError);
@@ -170,14 +176,17 @@ describe("Local API", () => {
 
     it("returns existing workspace if found", async () => {
       server.use(
-        http.get(`${LOCAL_BASE_URL}/v1/user/workspaces`, () => {
-          return HttpResponse.json({
-            organization_id: "org-123",
-            workspaces: [
-              { id: "existing-ws", name: "MyWorkspace", token: "existing-token" },
-            ],
-          });
-        })
+        http.get(
+          `${LOCAL_BASE_URL}/v1/user/workspaces`,
+          () => {
+            return HttpResponse.json({
+              organization_id: "org-123",
+              workspaces: [
+                { id: "existing-ws", name: "MyWorkspace", token: "existing-token" },
+              ],
+            });
+          }
+        )
       );
 
       const result = await getOrCreateLocalWorkspace(tokens, "MyWorkspace");
@@ -191,21 +200,24 @@ describe("Local API", () => {
       let createCalled = false;
 
       server.use(
-        http.get(`${LOCAL_BASE_URL}/v1/user/workspaces`, () => {
-          // Return different response based on whether create was called
-          if (createCalled) {
+        http.get(
+          `${LOCAL_BASE_URL}/v1/user/workspaces`,
+          () => {
+            // Return different response based on whether create was called
+            if (createCalled) {
+              return HttpResponse.json({
+                organization_id: "org-123",
+                workspaces: [
+                  { id: "new-ws", name: "NewWorkspace", token: "new-token" },
+                ],
+              });
+            }
             return HttpResponse.json({
               organization_id: "org-123",
-              workspaces: [
-                { id: "new-ws", name: "NewWorkspace", token: "new-token" },
-              ],
+              workspaces: [], // Empty initially
             });
           }
-          return HttpResponse.json({
-            organization_id: "org-123",
-            workspaces: [], // Empty initially
-          });
-        }),
+        ),
         http.post(`${LOCAL_BASE_URL}/v1/workspaces`, () => {
           createCalled = true;
           return HttpResponse.json({

package/src/api/local.ts

@@ -5,6 +5,7 @@
 
 import * as crypto from "crypto";
 import { LOCAL_BASE_URL } from "../cli/config.js";
+import { tinybirdFetch } from "./fetcher.js";
 
 /**
  * Tokens returned by the local /tokens endpoint
@@ -76,7 +77,7 @@ export class LocalApiError extends Error {
  */
 export async function isLocalRunning(): Promise<boolean> {
   try {
-    const response = await fetch(`${LOCAL_BASE_URL}/tokens`, {
+    const response = await tinybirdFetch(`${LOCAL_BASE_URL}/tokens`, {
       method: "GET",
       signal: AbortSignal.timeout(5000),
     });
@@ -94,7 +95,7 @@ export async function isLocalRunning(): Promise<boolean> {
  */
 export async function getLocalTokens(): Promise<LocalTokens> {
   try {
-    const response = await fetch(`${LOCAL_BASE_URL}/tokens`, {
+    const response = await tinybirdFetch(`${LOCAL_BASE_URL}/tokens`, {
       method: "GET",
       signal: AbortSignal.timeout(5000),
     });
@@ -136,7 +137,7 @@ export async function listLocalWorkspaces(
 ): Promise<{ workspaces: LocalWorkspace[]; organizationId?: string }> {
   const url = `${LOCAL_BASE_URL}/v1/user/workspaces?with_organization=true&token=${adminToken}`;
 
-  const response = await fetch(url, {
+  const response = await tinybirdFetch(url, {
     method: "GET",
   });
 
@@ -182,7 +183,7 @@ export async function createLocalWorkspace(
     formData.append("assign_to_organization_id", organizationId);
   }
 
-  const response = await fetch(url, {
+  const response = await tinybirdFetch(url, {
     method: "POST",
     headers: {
       Authorization: `Bearer ${userToken}`,

package/src/api/resources.ts

@@ -4,6 +4,7 @@
  */
 
 import type { WorkspaceApiConfig } from "./workspaces.js";
+import { tinybirdFetch } from "./fetcher.js";
 
 /**
  * Error thrown by resource API operations
@@ -299,7 +300,7 @@ export async function listDatasources(
 ): Promise<string[]> {
   const url = new URL("/v0/datasources", config.baseUrl);
 
-  const response = await fetch(url.toString(), {
+  const response = await tinybirdFetch(url.toString(), {
     method: "GET",
     headers: {
       Authorization: `Bearer ${config.token}`,
@@ -327,7 +328,7 @@ export async function getDatasource(
 ): Promise<DatasourceInfo> {
   const url = new URL(`/v0/datasources/${encodeURIComponent(name)}`, config.baseUrl);
 
-  const response = await fetch(url.toString(), {
+  const response = await tinybirdFetch(url.toString(), {
     method: "GET",
     headers: {
       Authorization: `Bearer ${config.token}`,
@@ -404,7 +405,7 @@ export async function listPipes(
 ): Promise<string[]> {
   const url = new URL("/v0/pipes", config.baseUrl);
 
-  const response = await fetch(url.toString(), {
+  const response = await tinybirdFetch(url.toString(), {
     method: "GET",
     headers: {
       Authorization: `Bearer ${config.token}`,
@@ -432,7 +433,7 @@ export async function getPipe(
 ): Promise<PipeInfo> {
   const url = new URL(`/v0/pipes/${encodeURIComponent(name)}`, config.baseUrl);
 
-  const response = await fetch(url.toString(), {
+  const response = await tinybirdFetch(url.toString(), {
     method: "GET",
     headers: {
       Authorization: `Bearer ${config.token}`,

package/src/api/workspaces.test.ts

@@ -9,6 +9,12 @@ import {
 const mockFetch = vi.fn();
 global.fetch = mockFetch;
 
+function expectFromParam(url: string) {
+  const parsed = new URL(url);
+  expect(parsed.searchParams.get("from")).toBe("ts-sdk");
+  return parsed;
+}
+
 describe("Workspace API client", () => {
   const config: WorkspaceApiConfig = {
     baseUrl: "https://api.tinybird.co",
@@ -38,15 +44,15 @@ describe("Workspace API client", () => {
 
       const result = await getWorkspace(config);
 
-      expect(mockFetch).toHaveBeenCalledWith(
-        "https://api.tinybird.co/v1/workspace",
-        {
-          method: "GET",
-          headers: {
-            Authorization: "Bearer p.test-token",
-          },
-        }
-      );
+      const [url, init] = mockFetch.mock.calls[0];
+      const parsed = expectFromParam(url);
+      expect(parsed.pathname).toBe("/v1/workspace");
+      expect(init).toEqual({
+        method: "GET",
+        headers: {
+          Authorization: "Bearer p.test-token",
+        },
+      });
       expect(result).toEqual(mockWorkspace);
     });
 

package/src/api/workspaces.ts

@@ -2,6 +2,8 @@
  * Tinybird Workspace API client
  */
 
+import { tinybirdFetch } from "./fetcher.js";
+
 /**
  * Workspace information from Tinybird API
  */
@@ -56,7 +58,7 @@ export async function getWorkspace(
 ): Promise<TinybirdWorkspace> {
   const url = new URL("/v1/workspace", config.baseUrl);
 
-  const response = await fetch(url.toString(), {
+  const response = await tinybirdFetch(url.toString(), {
     method: "GET",
     headers: {
       Authorization: `Bearer ${config.token}`,

package/src/cli/auth.ts

@@ -8,6 +8,7 @@ import * as http from "node:http";
 import { spawn } from "node:child_process";
 import { platform } from "node:os";
 import { URL } from "node:url";
+import { tinybirdFetch } from "../api/fetcher.js";
 
 /**
  * Port for the local OAuth callback server
@@ -259,7 +260,7 @@ export async function exchangeCodeForTokens(
   const url = new URL("/api/cli-login", authHost);
   url.searchParams.set("code", code);
 
-  const response = await fetch(url.toString());
+  const response = await tinybirdFetch(url.toString());
 
   if (!response.ok) {
     const body = await response.text();

package/src/cli/commands/deploy.ts

@@ -15,6 +15,8 @@ export interface DeployCommandOptions {
   cwd?: string;
   /** Skip pushing to API (just generate) */
   dryRun?: boolean;
+  /** Validate deploy with Tinybird API without applying */
+  check?: boolean;
 }
 
 /**
@@ -96,7 +98,10 @@ export async function runDeploy(options: DeployCommandOptions = {}): Promise<Dep
         baseUrl: config.baseUrl,
         token: config.token,
       },
-      buildResult.resources
+      buildResult.resources,
+      {
+        check: options.check,
+      }
     );
   } catch (error) {
     return {