ts-procedures 5.3.0 → 5.4.0

package/src/implementations/http/README.md

@@ -21,12 +21,21 @@ For procedures created with `CreateStream()` - server-sent events and streaming
 |-----------|---------|-------------|
 | [Hono Stream](./hono-stream/README.md) | `hono-stream` | SSE and text streaming for async generators |
 
+### API (REST-style)
+
+For procedures using `schema.input` — per-channel input validation with standard HTTP methods.
+
+| Framework | Package | Description |
+|-----------|---------|-------------|
+| [Hono API](./hono-api/) | `hono-api` | REST-style routing by HTTP method (GET, POST, PUT, DELETE, PATCH, HEAD) |
+
 ## Procedure Types
 
 | Type | Created With | Handler Return | HTTP Methods | Use Case |
 |------|--------------|----------------|--------------|----------|
 | RPC | `Create()` | `Promise<T>` | POST | Standard request/response |
 | Stream | `CreateStream()` | `AsyncGenerator<T>` | GET, POST | Real-time updates, SSE |
+| API | `Create()` | `Promise<T>` | GET, POST, PUT, DELETE, PATCH, HEAD | REST-style endpoints with per-channel input |
 
 ## Core Concepts
 
@@ -41,6 +50,18 @@ interface RPCConfig {
 }
 ```
 
+#### APIConfig (REST-style)
+
+```typescript
+interface APIConfig {
+  path: string              // Route path with Hono params (e.g., '/users/:id')
+  method: HttpMethod        // 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head'
+  successStatus?: number    // Default: POST→201, DELETE→204, others→200
+}
+```
+
+API routes use developer-defined paths — no auto-generation from scope/version.
+
 ### Path Generation
 
 Routes are generated using kebab-case conversion:
@@ -127,8 +148,8 @@ onRequestStart → onStreamStart → [yields...] → onStreamEnd → onRequestEn
 |------|--------------|---------|
 | `onRequestStart` | Both | Before route handler |
 | `onRequestEnd` | Both | After response sent |
-| `onSuccess` | RPC | After successful handler |
-| `onError` | RPC | On handler error |
+| `onSuccess` | RPC, API | After successful handler |
+| `onError` | RPC, API | On handler error |
 | `onStreamStart` | Stream | Before first yield |
 | `onStreamEnd` | Stream | After stream completes |
 | `onPreStreamError` | Stream | On pre-stream error (validation, auth) |
@@ -172,6 +193,25 @@ interface StreamHttpRouteDoc {
 }
 ```
 
+**API Documentation (`APIHttpRouteDoc`):**
+
+```typescript
+interface APIHttpRouteDoc {
+  name: string
+  path: string
+  method: HttpMethod
+  fullPath: string
+  successStatus?: number
+  jsonSchema: {
+    pathParams?: object    // From schema.input.pathParams
+    query?: object         // From schema.input.query
+    body?: object          // From schema.input.body
+    headers?: object       // From schema.input.headers
+    response?: object      // From schema.returnType
+  }
+}
+```
+
 ### Builder Pattern
 
 All implementations follow the same builder pattern:
@@ -185,6 +225,8 @@ const app = builder.build()
 const docs = builder.docs
 ```
 
+**Note:** `HonoAPIAppBuilder.build()` is async (resolves query parser on first call).
+
 **Key methods:**
 
 | Method | Returns | Description |
@@ -214,4 +256,5 @@ const docs = builder.docs
 
 ```typescript
 import { RPCConfig, RPCHttpRouteDoc, StreamHttpRouteDoc, StreamMode } from 'ts-procedures/implementations/types'
+import type { APIConfig, APIHttpRouteDoc, APIInput, HttpMethod } from 'ts-procedures/http'
 ```