Merge pull request #293 from cloudflare/fix/sdk-fixes

Fix: SDK functionalities addition + Auth redesign

Author: AshishKumar4

sdk/README.md

@@ -1,38 +1,35 @@
 {
 	"name": "@cf-vibesdk/sdk",
-	"version": "0.0.3",
+	"version": "0.0.4",
 	"type": "module",
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
 			"default": "./dist/index.js"
-		},
-		"./node": {
-			"types": "./dist/node.d.ts",
-			"default": "./dist/node.js"
 		}
 	},
 	"files": [
 		"dist"
 	],
+	"engines": {
+		"node": ">=22"
+	},
 	"publishConfig": {
 		"access": "public"
 	},
 	"scripts": {
-		"build": "rm -rf ./dist && bun build ./src/index.ts ./src/node.ts --outdir ./dist --target bun",
-		"bundle-types": "dts-bundle-generator --export-referenced-types false --project ./tsconfig.protocol.json -o ./dist/index.d.ts ./src/index.ts && dts-bundle-generator --export-referenced-types false --project ./tsconfig.protocol.json -o ./dist/node.d.ts ./src/node.ts",
+		"build": "rm -rf ./dist && bun build ./src/index.ts --outdir ./dist --target browser",
+		"bundle-types": "dts-bundle-generator --export-referenced-types false --project ./tsconfig.protocol.json -o ./dist/index.d.ts ./src/index.ts",
 		"typecheck": "tsc -p ./tsconfig.json --noEmit",
 		"test": "bun test test/*.test.ts",
 		"test:integration": "bun test --timeout 600000 test/integration/*.test.ts"
 	},
-	"dependencies": {
-		"ws": "^8.18.3"
-	},
 	"devDependencies": {
-		"@types/ws": "^8.18.1",
+		"@cloudflare/workers-types": "^4.20241218.0",
+		"@types/node": "^25.0.3",
 		"dts-bundle-generator": "^9.5.1",
-		"typescript": "^5.9.3"
+		"miniflare": "^4.20251217.0",
+		"typescript": "^5.9.3",
+		"wrangler": "^4.14.1"
 	}
 }
-
-

sdk/bun.lock

@@ -1,9 +1,4 @@
-/**
- * Utility for checking if a value is a plain object.
- */
-export function isRecord(v: unknown): v is Record<string, unknown> {
-	return Boolean(v) && typeof v === 'object' && !Array.isArray(v);
-}
+import { isRecord } from './utils';
 
 /**
  * Blueprint structure as streamed from the agent.

sdk/package.json

@@ -2,11 +2,16 @@ import type {
 	ApiResponse,
 	AppDetails,
 	AppListItem,
+	AppVisibility,
+	AppWithFavoriteStatus,
 	BuildOptions,
 	BuildStartEvent,
 	Credentials,
+	DeleteResult,
 	PublicAppsQuery,
+	ToggleResult,
 	VibeClientOptions,
+	VisibilityUpdateResult,
 } from './types';
 import { HttpClient } from './http';
 import { parseNdjsonStream } from './ndjson';
@@ -25,7 +30,7 @@ function toQueryString(query: Record<string, string | number | undefined>): stri
 export class VibeClient {
 	private http: HttpClient;
 
-	constructor(private options: VibeClientOptions) {
+	constructor(options: VibeClientOptions) {
 		this.http = new HttpClient(options);
 	}
 
@@ -35,9 +40,6 @@ export class VibeClient {
 
 	/**
 	 * Creates a new agent/app from a prompt and returns a BuildSession.
-	 *
-	 * Current platform requirement: `token` must be a valid JWT access token.
-	 * Later: `apiKey` will be exchanged for a short-lived JWT.
 	 */
 	async build(prompt: string, options: BuildOptions = {}): Promise<BuildSession> {
 		const body = {
@@ -48,7 +50,6 @@ export class VibeClient {
 			behaviorType: options.behaviorType,
 			projectType: options.projectType,
 			images: options.images,
-			// Future: credentials
 			credentials: options.credentials,
 		};
 
@@ -79,12 +80,13 @@ export class VibeClient {
 			throw new Error('No start event received from /api/agent');
 		}
 
-		const session = new BuildSession(this.options, start, {
-			getAuthToken: () => this.http.getToken(),
+		const session = new BuildSession(start, {
+			httpClient: this.http,
 			...(options.credentials ? { defaultCredentials: options.credentials } : {}),
 		});
+
 		if (options.autoConnect ?? true) {
-			session.connect();
+			await session.connect();
 			if (options.autoGenerate ?? true) {
 				session.startGeneration();
 			}
@@ -109,13 +111,14 @@ export class VibeClient {
 			websocketUrl: data.data.websocketUrl,
 		};
 
-		return new BuildSession(this.options, start, {
-			getAuthToken: () => this.http.getToken(),
+		return new BuildSession(start, {
+			httpClient: this.http,
 			...(options.credentials ? { defaultCredentials: options.credentials } : {}),
 		});
 	}
 
 	apps = {
+		/** List public apps with optional filtering and pagination. */
 		listPublic: async (query: PublicAppsQuery = {}) => {
 			const qs = toQueryString({
 				limit: query.limit,
@@ -132,20 +135,72 @@ export class VibeClient {
 			);
 		},
 
+		/** List all apps owned by the authenticated user. */
 		listMine: async () => {
-			return this.http.fetchJson<ApiResponse<{ apps: AppListItem[] }>>('/api/apps', {
+			return this.http.fetchJson<ApiResponse<{ apps: AppWithFavoriteStatus[] }>>('/api/apps', {
+				method: 'GET',
+				headers: await this.http.headers(),
+			});
+		},
+
+		/** List recent apps (last 10) for the authenticated user. */
+		listRecent: async () => {
+			return this.http.fetchJson<ApiResponse<{ apps: AppWithFavoriteStatus[] }>>('/api/apps/recent', {
 				method: 'GET',
 				headers: await this.http.headers(),
 			});
 		},
 
+		/** List favorite apps for the authenticated user. */
+		listFavorites: async () => {
+			return this.http.fetchJson<ApiResponse<{ apps: AppWithFavoriteStatus[] }>>('/api/apps/favorites', {
+				method: 'GET',
+				headers: await this.http.headers(),
+			});
+		},
+
+		/** Get detailed information about a specific app. */
 		get: async (appId: string) => {
 			return this.http.fetchJson<ApiResponse<AppDetails>>(`/api/apps/${appId}`, {
 				method: 'GET',
 				headers: await this.http.headers(),
 			});
 		},
 
+		/** Delete an app (owner only). */
+		delete: async (appId: string) => {
+			return this.http.fetchJson<ApiResponse<DeleteResult>>(`/api/apps/${appId}`, {
+				method: 'DELETE',
+				headers: await this.http.headers(),
+			});
+		},
+
+		/** Update app visibility (owner only). */
+		setVisibility: async (appId: string, visibility: AppVisibility) => {
+			return this.http.fetchJson<ApiResponse<VisibilityUpdateResult>>(`/api/apps/${appId}/visibility`, {
+				method: 'PUT',
+				headers: await this.http.headers({ 'Content-Type': 'application/json' }),
+				body: JSON.stringify({ visibility }),
+			});
+		},
+
+		/** Toggle star/bookmark status on an app. */
+		toggleStar: async (appId: string) => {
+			return this.http.fetchJson<ApiResponse<ToggleResult>>(`/api/apps/${appId}/star`, {
+				method: 'POST',
+				headers: await this.http.headers(),
+			});
+		},
+
+		/** Toggle favorite status on an app. */
+		toggleFavorite: async (appId: string) => {
+			return this.http.fetchJson<ApiResponse<ToggleResult>>(`/api/apps/${appId}/favorite`, {
+				method: 'POST',
+				headers: await this.http.headers(),
+			});
+		},
+
+		/** Generate a git clone token for an app (owner only). */
 		getGitCloneToken: async (appId: string) => {
 			return this.http.fetchJson<
 				ApiResponse<{ token: string; expiresIn: number; expiresAt: string; cloneUrl: string }>

sdk/src/blueprint.ts

@@ -37,7 +37,9 @@ export class HttpClient {
 	}
 
 	private get fetchFn(): typeof fetch {
-		return this.opts.fetchFn ?? fetch;
+		// Wrap global fetch to preserve context in Workers runtime
+		// See: https://developers.cloudflare.com/workers/observability/errors/#illegal-invocation-errors
+		return this.opts.fetchFn ?? ((...args: Parameters<typeof fetch>) => fetch(...args));
 	}
 
 	getToken(): string | undefined {
@@ -158,4 +160,25 @@ export class HttpClient {
 
 		throw lastError ?? new Error(`Failed after ${this.retryCfg.maxRetries} retries`);
 	}
+
+	/**
+	 * Request a WebSocket ticket for secure agent connection.
+	 * Tickets are single-use and short-lived (15 seconds).
+	 */
+	async getWsTicket(agentId: string): Promise<{ ticket: string; expiresIn: number; expiresAt: string }> {
+		const resp = await this.fetchJson<ApiResponse<{ ticket: string; expiresIn: number; expiresAt: string }>>(
+			'/api/ws-ticket',
+			{
+				method: 'POST',
+				headers: await this.headers({ 'Content-Type': 'application/json' }),
+				body: JSON.stringify({ resourceType: 'agent', resourceId: agentId }),
+			},
+		);
+
+		if (!resp.success) {
+			throw new Error(resp.error.message || 'Failed to get WebSocket ticket');
+		}
+
+		return resp.data;
+	}
 }

sdk/src/client.ts

@@ -5,10 +5,10 @@ export { BuildSession } from './session';
 export { WorkspaceStore } from './workspace';
 export { SessionStateStore } from './state';
 
-export { isRecord, blueprintToMarkdown, BlueprintStreamParser } from './blueprint';
+export { blueprintToMarkdown, BlueprintStreamParser } from './blueprint';
 export type { Blueprint } from './blueprint';
 
-export { withTimeout, TimeoutError } from './utils';
+export { isRecord, withTimeout, TimeoutError } from './utils';
 
 export type {
 	AgentConnection,
@@ -18,18 +18,24 @@ export type {
 	ApiResponse,
 	AppDetails,
 	AppListItem,
+	AppVisibility,
+	AppWithFavoriteStatus,
 	BehaviorType,
 	BuildOptions,
 	BuildStartEvent,
 	CodeGenArgs,
 	Credentials,
+	DeleteResult,
 	FileTreeNode,
 	PhaseEventType,
 	ProjectType,
 	PublicAppsQuery,
 	SessionDeployable,
 	SessionFiles,
+	ToggleResult,
+	UrlProvider,
 	VibeClientOptions,
+	VisibilityUpdateResult,
 	WaitForPhaseOptions,
 	WaitOptions,
 } from './types';

sdk/src/http.ts

@@ -23,3 +23,5 @@ export type {
 	CodeGenArgs as PlatformCodeGenArgs,
 	AgentPreviewResponse,
 } from '../../worker/api/controllers/agent/types';
+
+export type { ImageAttachment } from '../../worker/types/image-attachment';