@vibesdotdev/client 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,22 @@
+# @vibesdotdev/client
+
+Base API client utilities with Vibes runtime integration.
+
+This package is part of the public Vibes framework package set. The source repository is private while the public repository split is being prepared, so package documentation is published on the Vibes docs site.
+
+## Install
+
+```sh
+bun add @vibesdotdev/client
+# or
+npm install @vibesdotdev/client
+```
+
+## Documentation
+
+- Package guide: https://docs.vibes.dev/packages/client
+- Vibes docs: https://docs.vibes.dev
+
+## License
+
+MIT

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vibesdotdev/client",
-  "version": "0.1.0",
-  "description": "Base API client with runtime kind integration and per-app client factories",
+  "version": "0.1.1",
+  "description": "Base API client utilities with Vibes runtime integration.",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -53,14 +53,9 @@
     "registry": "https://registry.npmjs.org",
     "access": "public"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/vibesdotdev/monorepo.git",
-    "directory": "packages/client"
-  },
   "dependencies": {
-    "@vibesdotdev/runtime": "0.0.1",
-    "@vibesdotdev/logging": "0.0.1",
+    "@vibesdotdev/runtime": "0.0.2",
+    "@vibesdotdev/logging": "0.0.2",
     "zod": "^4.3.6"
   },
   "scripts": {
@@ -74,7 +69,6 @@
     "src",
     "bin",
     "README.md",
-    "SPEC.md",
     "LICENSE",
     "!src/**/__tests__/**",
     "!src/**/__stubs__/**",
@@ -95,5 +89,9 @@
   ],
   "vibes": {
     "visibility": "public-framework"
+  },
+  "homepage": "https://docs.vibes.dev/packages/client",
+  "bugs": {
+    "url": "https://docs.vibes.dev/packages/client#support"
   }
 }

package/SPEC.md

@@ -1,107 +0,0 @@
-# Client Package SPEC
-
-**Status:** Production
-**Package:** `@vibesdotdev/client`
-**Location:** `packages/client`
-
-## Overview
-
-Base API client with runtime kind integration and per-app client factories. Wraps `@vibesdotdev/kit`'s VibesClient with a standardized `ApiClientImplementation` interface and registers `api/client` as a runtime kind for descriptor-based client resolution.
-
-## Architecture
-
-```
-+-----------------------------------------------------------------------+
-|                        Client Package                                 |
-+-----------------------------------------------------------------------+
-|  FACTORY                                                              |
-|  -------                                                              |
-|  vibesApiClient(config)    -> Create API client from config           |
-|  fromVibesClient(client)   -> Wrap existing VibesClient               |
-|  ApiClientConfig           -> baseUrl, auth, fetch, timeout, headers  |
-+-----------------------------------------------------------------------+
-|  SCHEMAS                                                              |
-|  -------                                                              |
-|  ApiClientDescriptor       -> Runtime descriptor for api/client kind  |
-|    kind: 'api/client'      -> Runtime kind identifier                 |
-|    baseUrl, timeout, debug -> Per-client configuration                |
-|  ApiClientImplementation   -> Standard interface: get/post/put/delete |
-|  ApiRequestOptions         -> query, headers, timeout, params         |
-+-----------------------------------------------------------------------+
-|  RUNTIME PLUGIN                                                       |
-|  --------------                                                       |
-|  clientPlugin              -> Registers 'api/client' kind             |
-|  DefaultApiClient          -> Default implementation from descriptor  |
-|  Runtime query:                                                       |
-|    runtime.query('api/client').withId('auth').resolve()               |
-+-----------------------------------------------------------------------+
-```
-
-## Key Exports
-
-### Factory (`@vibesdotdev/client` or `@vibesdotdev/client/factory`)
-- `vibesApiClient(config?)` -- Create new API client instance
-- `fromVibesClient(client)` -- Wrap existing VibesClient
-- `ApiClientConfig` -- Configuration type
-
-### Schemas (`@vibesdotdev/client/schemas`)
-- `ApiClientDescriptor` -- Runtime descriptor interface
-- `ApiClientDescriptorSchema` -- Zod validation schema
-- `ApiClientImplementation` -- Standard client interface (get/post/put/delete/request)
-- `ApiRequestOptions` -- Per-request options (query, headers, timeout, params)
-
-### Plugin (`@vibesdotdev/client/plugin`)
-- `clientPlugin` -- Runtime plugin registering `api/client` kind
-- Enables `runtime.query('api/client').withId('auth').resolve()`
-
-## ApiClientImplementation Interface
-
-```typescript
-interface ApiClientImplementation {
-  get<T>(endpoint: string, options?: ApiRequestOptions): Promise<T>;
-  post<T>(endpoint: string, body?: unknown, options?: ApiRequestOptions): Promise<T>;
-  put<T>(endpoint: string, body?: unknown, options?: ApiRequestOptions): Promise<T>;
-  delete<T>(endpoint: string, options?: ApiRequestOptions): Promise<T>;
-  request<T>(endpoint: string, options?: ApiRequestOptions & { method?: string; body?: unknown }): Promise<T>;
-}
-```
-
-## Runtime Integration
-
-The plugin registers `api/client` as a runtime kind. Apps register descriptors:
-
-```typescript
-// auth-client.client-api.descriptor.ts
-export default {
-  id: 'auth',
-  kind: 'api/client',
-  baseUrl: 'https://auth.vibes.dev',
-  timeout: 10000
-};
-```
-
-Other packages resolve clients via the runtime:
-
-```typescript
-const authClient = await runtime.query('api/client').withId('auth').resolve();
-const session = await authClient.get('/api/session');
-```
-
-## Done Means
-
-- [ ] `vibesApiClient` creates working clients with proper auth, headers, and timeout
-- [ ] `fromVibesClient` correctly wraps VibesClient to ApiClientImplementation
-- [ ] Custom headers hook applies headers to all requests
-- [ ] Runtime plugin registers `api/client` kind and resolves descriptors
-- [ ] DefaultApiClient constructs from descriptor config (baseUrl, timeout, debug)
-- [ ] All HTTP methods (GET, POST, PUT, DELETE, generic request) work correctly
-- [ ] ApiRequestOptions supports query params, custom headers, and timeout override
-- [ ] Error handling propagates HTTP errors with useful context
-- [ ] Tests cover factory creation, plugin registration, and request lifecycle
-
-## Dependencies
-
-- `@vibesdotdev/kit` -- VibesClient base class and client types
-- `@vibesdotdev/runtime` -- Runtime plugin registration and kind system
-- `@vibesdotdev/logging` -- Structured logging
-- `zod` -- Schema validation for descriptors