/** * Local Tinybird container API client * For use with tinybird-local Docker image */ /** * Tokens returned by the local /tokens endpoint */ export interface LocalTokens { /** User token for user-level operations */ user_token: string; /** Admin token for admin operations like listing workspaces */ admin_token: string; /** Default workspace admin token */ workspace_admin_token: string; } /** * Workspace info from local Tinybird */ export interface LocalWorkspace { /** Workspace ID */ id: string; /** Workspace name */ name: string; /** Workspace token */ token: string; } /** * Error thrown when local container is not running */ export declare class LocalNotRunningError extends Error { constructor(); } /** * Error thrown by local API operations */ export declare class LocalApiError extends Error { readonly status?: number | undefined; readonly body?: unknown | undefined; constructor(message: string, status?: number | undefined, body?: unknown | undefined); } /** * Check if local Tinybird container is running * * @returns true if container is running and healthy */ export declare function isLocalRunning(): Promise; /** * Get tokens from local Tinybird container * * @returns Local tokens * @throws LocalNotRunningError if container is not running */ export declare function getLocalTokens(): Promise; /** * List workspaces in local Tinybird * * @param adminToken - Admin token from getLocalTokens() * @returns List of workspaces with their info */ export declare function listLocalWorkspaces(adminToken: string): Promise<{ workspaces: LocalWorkspace[]; organizationId?: string; }>; /** * Create a workspace in local Tinybird * * @param userToken - User token from getLocalTokens() * @param workspaceName - Name for the new workspace * @param organizationId - Organization ID to assign workspace to * @returns Created workspace info */ export declare function createLocalWorkspace(userToken: string, workspaceName: string, organizationId?: string): Promise; /** * Get or create a workspace in local Tinybird * * @param tokens - Tokens from getLocalTokens() * @param workspaceName - Name of the workspace to get or create * @returns Workspace info and whether it was newly created */ export declare function getOrCreateLocalWorkspace(tokens: LocalTokens, workspaceName: string): Promise<{ workspace: LocalWorkspace; wasCreated: boolean; }>; /** * Get workspace name for local mode based on git branch or path * * @param tinybirdBranch - Sanitized git branch name (or null if not in git) * @param cwd - Current working directory (used for hash if no branch) * @returns Workspace name to use */ export declare function getLocalWorkspaceName(tinybirdBranch: string | null, cwd: string): string; /** * Delete a workspace in local Tinybird * * @param userToken - User token from getLocalTokens() * @param workspaceId - ID of the workspace to delete */ export declare function deleteLocalWorkspace(userToken: string, workspaceId: string): Promise; /** * Clear a workspace in local Tinybird by deleting and recreating it * * @param tokens - Tokens from getLocalTokens() * @param workspaceName - Name of the workspace to clear * @returns The recreated workspace */ export declare function clearLocalWorkspace(tokens: LocalTokens, workspaceName: string): Promise; //# sourceMappingURL=local.d.ts.map