@vibesdotdev/client 0.1.1 → 1.0.0-rc.3

package/src/lib/client/types.ts

@@ -1,156 +0,0 @@
-/**
- * Vibes Client Types
- *
- * Configuration, errors, and type contracts for the VibesClient HTTP API client.
- * Extracted from libraries/vibeskit (PR #447 migration) to canonicalize as a
- * pure-isomorphic @vibesdotdev/client surface.
- */
-
-/** Authentication configuration */
-export interface AuthConfig {
-	/** Authentication type */
-	type: 'apiKey' | 'session' | 'bearer' | 'none';
-	/** Static credentials */
-	credentials?: string;
-	/** Dynamic token provider */
-	tokenProvider?: () => Promise<string | null>;
-	/** Session refresh handler for expired sessions */
-	refreshHandler?: () => Promise<AuthConfig | null>;
-}
-
-/** Client lifecycle hooks */
-export interface ClientHooks {
-	/** Called before each request */
-	beforeRequest?: (request: Request) => Promise<Request> | Request;
-	/** Called after each response */
-	afterResponse?: (response: Response) => Promise<Response> | Response;
-	/** Called on request error */
-	onError?: (error: ClientError) => Promise<void> | void;
-}
-
-/** Request options */
-export interface RequestOptions {
-	/** HTTP method */
-	method: string;
-	/** Request path (will be appended to baseUrl) */
-	path: string;
-	/** URL parameters */
-	params?: Record<string, string | number | boolean>;
-	/** Query parameters */
-	query?: Record<string, string | number | boolean | string[] | undefined>;
-	/** Request body */
-	body?: unknown;
-	/** Additional headers */
-	headers?: Record<string, string>;
-	/** Override timeout for this request */
-	timeout?: number;
-}
-
-/** Client configuration options */
-export interface ClientConfig {
-	/** Base URL for API requests */
-	baseUrl?: string;
-	/** Authentication configuration */
-	auth?: AuthConfig;
-	/** Custom fetch implementation */
-	fetch?: typeof fetch;
-	/** Request/response hooks */
-	hooks?: ClientHooks;
-	/** Request timeout in milliseconds */
-	timeout?: number;
-	/** Enable debug logging */
-	debug?: boolean;
-}
-
-/** Client error with additional context */
-export class ClientError extends Error {
-	constructor(
-		message: string,
-		public status?: number,
-		public response?: Response,
-		public request?: RequestOptions
-	) {
-		super(message);
-		this.name = 'ClientError';
-	}
-}
-
-/** Paginated response wrapper */
-export interface PaginatedResponse<T> {
-	data: T[];
-	total: number;
-	page: number;
-	pageSize: number;
-	hasMore: boolean;
-}
-
-/** Standard list parameters */
-export interface ListParams {
-	/** Page number (1-based) */
-	page?: number;
-	/** Items per page */
-	limit?: number;
-	/** Sort field */
-	sortBy?: string;
-	/** Sort direction */
-	sortOrder?: 'asc' | 'desc';
-	/** Search query */
-	search?: string;
-	/** Additional filters */
-	filters?: Record<string, unknown>;
-}
-
-/** OpenAPI path info (generic -- no openapi-types dependency) */
-export interface PathInfo {
-	path: string;
-	method: string;
-	operationId?: string;
-	parameters?: Record<string, unknown>[];
-	requestBody?: Record<string, unknown>;
-	responses?: Record<string, unknown>;
-	tags?: string[];
-	summary?: string;
-	description?: string;
-}
-
-/** Grouped API resources */
-export interface APIResource {
-	name: string;
-	basePath: string;
-	operations: Map<string, PathInfo>;
-}
-
-/**
- * Migration debt: ClientUser is an auth-domain type owned by @vibesdotdev/auth.
- * Defined here temporarily so @vibesdotdev/kit/client consumers can migrate.
- * Target: move to packages/auth/src/shared/client-user.ts and re-export from client/core.
- */
-export interface ClientUser {
-	id: string;
-	email: string;
-	displayName?: string | null;
-	avatarUrl?: string | null;
-	isSuperuser?: boolean;
-	roles?: Array<{
-		id: string;
-		name: string;
-		description: string | null;
-		isSystemRole: boolean;
-	}>;
-	permissions?: string[];
-}
-
-/**
- * Type helpers for schema conversion
- */
-export type SchemaToType<T> = T extends { type: 'string' }
-	? string
-	: T extends { type: 'number' }
-		? number
-		: T extends { type: 'boolean' }
-			? boolean
-			: T extends { type: 'array'; items: infer I }
-				? Array<SchemaToType<I>>
-				: T extends { type: 'object'; properties: infer P }
-					? { [K in keyof P]: SchemaToType<P[K]> }
-						: unknown;

package/src/plugin.ts

@@ -1,104 +0,0 @@
-import { createRuntimePlugin, loader } from '@vibesdotdev/runtime';
-import type { RuntimeDescriptor } from '@vibesdotdev/runtime/schemas/descriptor';
-import {
-	ApiClientDescriptorSchema,
-	type ApiClientDescriptor,
-	type ApiClientImplementation,
-	type ApiStreamEvent
-} from './schemas.ts';
-import { vibesApiClient } from './factory.ts';
-import type { KindContext, RuntimeKindDescriptorRecord } from '@vibesdotdev/runtime/schemas/kind';
-import apiRequestToolDescriptor from './tools/api-request/api-request.descriptor.ts';
-
-function isApiClientDescriptor(descriptor: RuntimeDescriptor): descriptor is ApiClientDescriptor {
-	return descriptor.kind === 'api/client' && typeof descriptor.id === 'string';
-}
-
-/**
- * Default API client implementation.
- *
- * When no specific client implementation is registered for a descriptor,
- * this default constructs a client using the descriptor's baseUrl.
- */
-class DefaultApiClient implements ApiClientImplementation {
-	private client: ApiClientImplementation;
-
-	constructor(descriptor: RuntimeDescriptor, _context: KindContext) {
-		if (!isApiClientDescriptor(descriptor)) {
-			throw new Error(`Invalid api/client descriptor '${descriptor.id ?? 'unknown'}'`);
-		}
-
-		this.client = vibesApiClient({
-			id: descriptor.id,
-			baseUrl: descriptor.baseUrl,
-			timeout: descriptor.timeout,
-			debug: descriptor.debug
-		});
-	}
-
-	get<T = unknown>(endpoint: string, options?: Parameters<ApiClientImplementation['get']>[1]): Promise<T> {
-		return this.client.get<T>(endpoint, options);
-	}
-
-	post<T = unknown>(endpoint: string, body?: unknown, options?: Parameters<ApiClientImplementation['post']>[2]): Promise<T> {
-		return this.client.post<T>(endpoint, body, options);
-	}
-
-	put<T = unknown>(endpoint: string, body?: unknown, options?: Parameters<ApiClientImplementation['put']>[2]): Promise<T> {
-		return this.client.put<T>(endpoint, body, options);
-	}
-
-	patch<T = unknown>(endpoint: string, body?: unknown, options?: Parameters<ApiClientImplementation['patch']>[2]): Promise<T> {
-		return this.client.patch<T>(endpoint, body, options);
-	}
-
-	delete<T = unknown>(endpoint: string, options?: Parameters<ApiClientImplementation['delete']>[1]): Promise<T> {
-		return this.client.delete<T>(endpoint, options);
-	}
-
-	request<T = unknown>(endpoint: string, options?: Parameters<ApiClientImplementation['request']>[1]): Promise<T> {
-		return this.client.request<T>(endpoint, options);
-	}
-
-	stream<T = unknown>(
-		endpoint: string,
-		options?: Parameters<ApiClientImplementation['stream']>[1]
-	): AsyncIterableIterator<ApiStreamEvent<T>> {
-		return this.client.stream<T>(endpoint, options) as AsyncIterableIterator<ApiStreamEvent<T>>;
-	}
-}
-
-const apiClientKind = {
-	id: 'api/client',
-	descriptorSchema: ApiClientDescriptorSchema,
-	defaultImplementation: DefaultApiClient
-} satisfies RuntimeKindDescriptorRecord<ApiClientImplementation>;
-
-/**
- * Client plugin — registers the `api/client` kind with the runtime.
- *
- * @example
- * ```ts
- * import { getVibesRuntime } from '@vibesdotdev/runtime';
- * import clientPlugin from '@vibesdotdev/client/plugin';
- *
- * const runtime = getVibesRuntime();
- * await runtime.registerPlugin(clientPlugin);
- *
- * // Query a registered API client
- * const authClient = await runtime.query('api/client').withId('auth').resolve();
- * await authClient.get('/api/health');
- * ```
- */
-export default createRuntimePlugin({
-	id: 'client',
-	name: 'API Client Module',
-	description: 'Runtime API client kind with environment-aware factories',
-	kinds: [apiClientKind],
-	descriptors: [apiRequestToolDescriptor],
-	loaders: [
-		loader('api-request', { kind: 'tools/tool', scope: 'consumer' }, () =>
-			import('./tools/api-request/api-request.impl.consumer.js')
-		)
-	]
-});

package/src/schemas.ts

@@ -1,91 +0,0 @@
-import * as z from 'zod/v4';
-import {
-	RuntimeDescriptorSchema,
-	type RuntimeDescriptor
-} from '@vibesdotdev/runtime/schemas/descriptor';
-
-/**
- * API Client descriptor — metadata for a registered API client asset.
- */
-export interface ApiClientDescriptor extends RuntimeDescriptor {
-	kind: 'api/client';
-	/** Base URL for this client's API */
-	baseUrl?: string;
-	/** Default timeout in milliseconds */
-	timeout?: number;
-	/** Whether to enable debug logging */
-	debug?: boolean;
-}
-
-export const ApiClientDescriptorSchema = RuntimeDescriptorSchema.extend({
-	kind: z.literal('api/client'),
-	baseUrl: z.string().optional(),
-	timeout: z.number().int().positive().optional(),
-	debug: z.boolean().optional()
-});
-
-/**
- * API Client implementation interface.
- *
- * Any runtime API client implementation must satisfy this contract.
- */
-export interface ApiClientImplementation {
-	/** Make a GET request */
-	get<T = unknown>(endpoint: string, options?: ApiRequestOptions): Promise<T>;
-	/** Make a POST request */
-	post<T = unknown>(endpoint: string, body?: unknown, options?: ApiRequestOptions): Promise<T>;
-	/** Make a PUT request */
-	put<T = unknown>(endpoint: string, body?: unknown, options?: ApiRequestOptions): Promise<T>;
-	/** Make a PATCH request */
-	patch<T = unknown>(endpoint: string, body?: unknown, options?: ApiRequestOptions): Promise<T>;
-	/** Make a DELETE request */
-	delete<T = unknown>(endpoint: string, options?: ApiRequestOptions): Promise<T>;
-	/** Make a generic request */
-	request<T = unknown>(
-		endpoint: string,
-		options?: ApiRequestOptions & { method?: string; body?: unknown }
-	): Promise<T>;
-	/**
-	 * Stream Server-Sent Events from an endpoint.
-	 *
-	 * Yields parsed SSE frames as they arrive. Each frame has already been
-	 * split into event/data/id/retry fields and the data payload is
-	 * JSON-parsed when possible. Returning from the generator — or the
-	 * server closing the stream — ends iteration; an explicit `[DONE]`
-	 * sentinel in the data stream also terminates.
-	 *
-	 * Use this instead of manually parsing SSE-wrapped POST bodies — the
-	 * raw-fetch workaround (line-split + regex for `data: ...` lines) is
-	 * brittle and fails on multi-line data, retry hints, and reconnects.
-	 */
-	stream<T = unknown>(
-		endpoint: string,
-		options?: ApiStreamOptions
-	): AsyncIterableIterator<ApiStreamEvent<T>>;
-}
-
-export interface ApiRequestOptions {
-	query?: Record<string, string | number | boolean | string[] | undefined>;
-	headers?: Record<string, string>;
-	timeout?: number;
-	params?: Record<string, string | number | boolean>;
-}
-
-export interface ApiStreamOptions extends ApiRequestOptions {
-	method?: string;
-	body?: unknown;
-}
-
-/**
- * A single Server-Sent Event frame.
- *
- * `data` is JSON-parsed when the frame payload is valid JSON, otherwise
- * the raw string is returned. `event`, `id`, and `retry` map to the
- * corresponding SSE fields when present.
- */
-export interface ApiStreamEvent<T = unknown> {
-	event?: string;
-	data: T;
-	id?: string;
-	retry?: number;
-}

package/src/sse-client.ts

@@ -1,155 +0,0 @@
-/**
- * Client-side SSE (Server-Sent Events) client.
- *
- * Provides a typed interface for connecting to SSE endpoints,
- * handling reconnection, and dispatching events.
- */
-
-export type SSEConnectionStatus =
-	| 'connecting'
-	| 'connected'
-	| 'reconnecting'
-	| 'disconnected'
-	| 'error';
-
-export interface SSEClientOptions {
-	url: string;
-	reconnectDelay?: number;
-	maxReconnectAttempts?: number;
-	onStatusChange?: (status: SSEConnectionStatus) => void;
-	onError?: (error: string) => void;
-}
-
-type EventHandler = (data: unknown) => void;
-
-export class SSEClient {
-	private url: string;
-	private reconnectDelay: number;
-	private maxReconnectAttempts: number;
-	private onStatusChange?: (status: SSEConnectionStatus) => void;
-	private onError?: (error: string) => void;
-
-	private eventSource: EventSource | null = null;
-	private handlers = new Map<string, Set<EventHandler>>();
-	private reconnectAttempts = 0;
-	private reconnectTimer: ReturnType<typeof setTimeout> | null = null;
-	private _status: SSEConnectionStatus = 'disconnected';
-
-	constructor(options: SSEClientOptions) {
-		this.url = options.url;
-		this.reconnectDelay = options.reconnectDelay ?? 5000;
-		this.maxReconnectAttempts = options.maxReconnectAttempts ?? 5;
-		this.onStatusChange = options.onStatusChange;
-		this.onError = options.onError;
-	}
-
-	get status(): SSEConnectionStatus {
-		return this._status;
-	}
-
-	connect(): void {
-		this.setStatus('connecting');
-
-		try {
-			const EventSourceCtor = globalThis.EventSource as {
-				new (url: string): EventSource;
-			};
-			this.eventSource = new EventSourceCtor(this.url);
-
-			this.eventSource.onopen = () => {
-				this.reconnectAttempts = 0;
-				this.setStatus('connected');
-			};
-
-			this.eventSource.onerror = () => {
-				const error = `SSE connection error`;
-				this.onError?.(error);
-
-				if (this.reconnectAttempts < this.maxReconnectAttempts) {
-					this.setStatus('reconnecting');
-					this.reconnectAttempts++;
-					this.scheduleReconnect();
-				} else {
-					this.setStatus('error');
-					this.cleanup();
-				}
-			};
-
-			// Dispatch events to registered handlers
-			this.eventSource.onmessage = (event) => {
-				this.dispatch('message', event.data);
-			};
-
-			// Listen for named events by iterating registered handlers
-			for (const eventName of this.handlers.keys()) {
-				if (eventName === 'message') continue;
-				this.eventSource.addEventListener(eventName, (event) => {
-					try {
-						const data = JSON.parse((event as MessageEvent).data);
-						this.dispatch(eventName, data);
-					} catch {
-						this.dispatch(eventName, (event as MessageEvent).data);
-					}
-				});
-			}
-		} catch (e) {
-			const error = e instanceof Error ? e.message : 'Failed to create SSE connection';
-			this.onError?.(error);
-			this.setStatus('error');
-		}
-	}
-
-	disconnect(): void {
-		this.cleanup();
-		this.setStatus('disconnected');
-	}
-
-	on(event: string, handler: EventHandler): () => void {
-		if (!this.handlers.has(event)) {
-			this.handlers.set(event, new Set());
-		}
-		this.handlers.get(event)!.add(handler);
-
-		// Return unsubscribe function
-		return () => {
-			this.handlers.get(event)?.delete(handler);
-		};
-	}
-
-	private dispatch(event: string, data: unknown): void {
-		this.handlers.get(event)?.forEach((handler) => {
-			try {
-				handler(data);
-			} catch (e) {
-				console.error(`[SSEClient] Error in handler for "${event}":`, e);
-			}
-		});
-	}
-
-	private setStatus(status: SSEConnectionStatus): void {
-		this._status = status;
-		this.onStatusChange?.(status);
-	}
-
-	private scheduleReconnect(): void {
-		if (this.reconnectTimer) clearTimeout(this.reconnectTimer);
-		this.reconnectTimer = setTimeout(() => {
-			this.connect();
-		}, this.reconnectDelay);
-	}
-
-	private cleanup(): void {
-		if (this.reconnectTimer) {
-			clearTimeout(this.reconnectTimer);
-			this.reconnectTimer = null;
-		}
-		if (this.eventSource) {
-			this.eventSource.close();
-			this.eventSource = null;
-		}
-	}
-}
-
-export function createSSEClient(options: SSEClientOptions): SSEClient {
-	return new SSEClient(options);
-}

package/src/tools/api-request/api-request.descriptor.ts

@@ -1,28 +0,0 @@
-/**
- * api-request Tool Descriptor
- *
- * Metadata for the api-request tool. Safe to import anywhere.
- */
-
-import { createRuntimeAsset } from '@vibesdotdev/runtime/factory';
-import { apiRequestInputSchema, apiRequestOutputSchema } from './schemas/index.ts';
-
-export default createRuntimeAsset({
-	kind: 'tools/tool',
-	id: 'api-request',
-	name: 'API Request',
-	description: 'Make an authenticated API request to any Vibes endpoint.',
-	mcpDescription: 'Make authenticated API request to Vibes endpoints. Ex: {method:"GET",path:"/api/health"}.',
-	hardware: ['consumer'],
-	purpose: ['direct', 'worker', 'mcp', 'agent'],
-	category: 'execution',
-	subcategory: 'api-request',
-	tags: ['api', 'network'],
-	safety: 'write',
-	requiresApproval: true,
-	permissions: ['canAccessNetwork'],
-	schemas: {
-		input: apiRequestInputSchema,
-		output: apiRequestOutputSchema
-	}
-});

package/src/tools/api-request/api-request.impl.consumer.ts

@@ -1,66 +0,0 @@
-/**
- * api-request Tool Implementation (Consumer)
- *
- * Consumer-scoped implementation for making authenticated API requests.
- * Resolves the `api/client` runtime kind and delegates to its `.request()`.
- */
-
-import type { VibesRuntime, ToolCallContext } from '@vibesdotdev/runtime';
-import type { ApiClientImplementation } from '../../schemas.ts';
-import type { ApiRequestInput, ApiRequestOutput } from './schemas/index.ts';
-
-async function resolveApiClient(runtime: VibesRuntime): Promise<ApiClientImplementation> {
-	try {
-		const apiClient = (await runtime.query('api/client').resolve()) as
-			| ApiClientImplementation
-			| undefined;
-		if (apiClient) {
-			return apiClient;
-		}
-	} catch {
-		// Query failed, fall through
-	}
-
-	throw new Error(
-		'API client not available in runtime context. Ensure api/client kind is registered.'
-	);
-}
-
-export default {
-	async execute(
-		input: ApiRequestInput,
-		runtime: VibesRuntime,
-		_ctx: ToolCallContext
-	): Promise<ApiRequestOutput> {
-		const method = input.method;
-		const path = input.path;
-		const query = input.query ?? {};
-		const body = input.body ?? undefined;
-		const headers = input.headers ?? {};
-
-		try {
-			const apiClient = await resolveApiClient(runtime);
-
-			const response = await apiClient.request(path, {
-				method,
-				query,
-				body,
-				headers
-			});
-
-			return {
-				status: 'success',
-				response
-			};
-		} catch (error) {
-			const message = error instanceof Error ? error.message : String(error);
-			return {
-				status: 'error',
-				error: {
-					message,
-					code: 'API_REQUEST_FAILED'
-				}
-			};
-		}
-	}
-};

package/src/tools/api-request/index.ts

@@ -1,4 +0,0 @@
-export { default as apiRequestToolDescriptor } from './api-request.descriptor.ts';
-export { default as apiRequestToolImplementation } from './api-request.impl.consumer.ts';
-export { apiRequestInputSchema, apiRequestOutputSchema } from './schemas/index.ts';
-export type { ApiRequestInput, ApiRequestOutput } from './schemas/index.ts';

package/src/tools/api-request/schemas/index.ts

@@ -1,29 +0,0 @@
-/**
- * API Request Tool Schemas
- *
- * Input/output schemas for the api-request tool.
- */
-
-import * as z from 'zod/v4';
-
-export const apiRequestInputSchema = z.object({
-	method: z.enum(['GET', 'POST', 'PUT', 'PATCH', 'DELETE']),
-	path: z.string().min(1),
-	query: z.record(z.string(), z.any()).optional(),
-	body: z.any().optional(),
-	headers: z.record(z.string(), z.string()).optional()
-});
-
-export const apiRequestOutputSchema = z.object({
-	status: z.enum(['success', 'error']),
-	response: z.unknown().optional(),
-	error: z
-		.object({
-			message: z.string(),
-			code: z.string().optional()
-		})
-		.optional()
-});
-
-export type ApiRequestInput = z.infer<typeof apiRequestInputSchema>;
-export type ApiRequestOutput = z.infer<typeof apiRequestOutputSchema>;