@vafast/api-client 0.1.1 → 0.1.3

package/example/auto-infer.ts

@@ -0,0 +1,223 @@
+/**
+ * ✨ 自动从 vafast 路由推断契约
+ * 
+ * 特性：
+ * 1. 使用 defineRoutes() 自动保留字面量类型
+ * 2. 支持 SSE 流式响应
+ * 3. 完整的类型推断
+ */
+
+import { 
+  defineRoutes, 
+  createHandler, 
+  createSSEHandler,
+  Type 
+} from 'vafast'
+import { eden, InferEden } from '../src'
+
+// ============= 业务类型定义 =============
+
+interface User {
+  id: string
+  name: string
+  email: string
+}
+
+interface ChatMessage {
+  text: string
+  timestamp?: number
+}
+
+// ============= 服务端：定义路由 =============
+
+/**
+ * ✨ defineRoutes() 自动保留字面量类型，无需 as const！
+ */
+const routes = defineRoutes([
+  // GET /users - 获取用户列表
+  {
+    method: 'GET',
+    path: '/users',
+    handler: createHandler(
+      { 
+        query: Type.Object({ 
+          page: Type.Optional(Type.Number({ default: 1 })), 
+          limit: Type.Optional(Type.Number({ default: 10 })) 
+        })
+      },
+      async ({ query }) => ({ 
+        users: [] as User[], 
+        total: 0,
+        page: query.page ?? 1,
+        limit: query.limit ?? 10
+      })
+    )
+  },
+  
+  // POST /users - 创建用户
+  {
+    method: 'POST',
+    path: '/users',
+    handler: createHandler(
+      { body: Type.Object({ name: Type.String(), email: Type.String() }) },
+      async ({ body }) => ({ 
+        id: crypto.randomUUID(), 
+        name: body.name, 
+        email: body.email 
+      } as User)
+    )
+  },
+  
+  // GET /users/:id - 获取单个用户
+  {
+    method: 'GET',
+    path: '/users/:id',
+    handler: createHandler(
+      { params: Type.Object({ id: Type.String() }) },
+      async ({ params }) => ({ 
+        id: params.id, 
+        name: 'User', 
+        email: 'user@example.com' 
+      } as User | null)
+    )
+  },
+  
+  // PUT /users/:id - 更新用户
+  {
+    method: 'PUT',
+    path: '/users/:id',
+    handler: createHandler(
+      { 
+        params: Type.Object({ id: Type.String() }), 
+        body: Type.Object({ 
+          name: Type.Optional(Type.String()), 
+          email: Type.Optional(Type.String()) 
+        }) 
+      },
+      async ({ params, body }) => ({ 
+        id: params.id, 
+        name: body?.name ?? 'User', 
+        email: body?.email ?? 'user@example.com' 
+      } as User)
+    )
+  },
+  
+  // DELETE /users/:id - 删除用户
+  {
+    method: 'DELETE',
+    path: '/users/:id',
+    handler: createHandler(
+      { params: Type.Object({ id: Type.String() }) },
+      async () => ({ success: true, deletedAt: new Date().toISOString() })
+    )
+  },
+
+  // 🌊 GET /chat/stream - SSE 流式响应
+  {
+    method: 'GET',
+    path: '/chat/stream',
+    handler: createSSEHandler(
+      { query: Type.Object({ prompt: Type.String() }) },
+      async function* ({ query }) {
+        // 模拟 AI 流式响应
+        yield { event: 'start', data: { message: 'Starting...' } }
+        
+        const words = `Hello! You said: "${query.prompt}"`.split(' ')
+        for (const word of words) {
+          yield { data: { text: word + ' ' } as ChatMessage }
+          await new Promise(r => setTimeout(r, 100))
+        }
+        
+        yield { event: 'end', data: { message: 'Done!' } }
+      }
+    )
+  }
+])
+
+// ============= 🎉 自动推断契约类型！=============
+
+/**
+ * 从路由定义自动推断 API 契约
+ * 无需手动定义任何接口！无需 as const！
+ */
+type Api = InferEden<typeof routes>
+
+// ============= 客户端：完全类型安全的调用 =============
+
+const api = eden<Api>('http://localhost:3000', {
+  headers: {
+    'Authorization': 'Bearer your-token-here'
+  },
+  timeout: 5000,
+  onError: (error) => {
+    console.error('API Error:', error.message)
+  }
+})
+
+async function main() {
+  console.log('=== 自动推断契约示例（无需 as const）===\n')
+
+  // ✅ GET /users?page=1&limit=10
+  const usersResult = await api.users.get({ page: 1, limit: 10 })
+  if (usersResult.data) {
+    console.log('📋 用户列表:', usersResult.data.users)
+    console.log('   总数:', usersResult.data.total)
+  }
+
+  // ✅ POST /users
+  const newUserResult = await api.users.post({ 
+    name: 'John Doe', 
+    email: 'john@example.com' 
+  })
+  if (newUserResult.data) {
+    console.log('\n✨ 新用户:', newUserResult.data.name)
+  }
+
+  // ✅ GET /users/:id
+  const userResult = await api.users({ id: '123' }).get()
+  if (userResult.data) {
+    console.log('\n👤 用户详情:', userResult.data.name)
+  }
+
+  // ✅ PUT /users/:id
+  const updateResult = await api.users({ id: '123' }).put({ name: 'Jane' })
+  if (updateResult.data) {
+    console.log('\n📝 更新后:', updateResult.data.name)
+  }
+
+  // ✅ DELETE /users/:id
+  const deleteResult = await api.users({ id: '123' }).delete()
+  if (deleteResult.data) {
+    console.log('\n🗑️ 删除成功:', deleteResult.data.success)
+  }
+
+  // 🌊 SSE 流式响应
+  console.log('\n=== SSE 流式响应 ===\n')
+  
+  // SSE 返回类型目前是 unknown，需要手动断言
+  // 未来版本会改进 SSE 返回类型推断
+  const subscription = api.chat.stream.subscribe(
+    { prompt: 'Hello AI!' },
+    {
+      onOpen: () => console.log('📡 连接已建立'),
+      onMessage: (data: unknown) => {
+        console.log('收到消息:', data)
+      },
+      onError: (err) => console.error('❌ 错误:', err.message),
+      onClose: () => console.log('📴 连接已关闭')
+    }
+  )
+
+  // 5 秒后取消订阅
+  setTimeout(() => {
+    subscription.unsubscribe()
+    console.log('\n\n=== 示例完成 ===')
+  }, 5000)
+}
+
+main().catch(console.error)
+
+// ============= 导出 =============
+
+export { routes, api }
+export type { Api }

package/example/test-sse.ts

@@ -0,0 +1,192 @@
+/**
+ * SSE 端到端测试
+ * 测试功能：
+ * 1. 请求取消 (AbortController)
+ * 2. SSE 自动重连
+ */
+
+import { 
+  defineRoutes, 
+  route, 
+  createHandler, 
+  createSSEHandler,
+  Type,
+  serve
+} from 'vafast'
+import { eden, InferEden } from '../src'
+
+// 定义路由
+const routes = defineRoutes([
+  // 普通 GET 请求
+  route('GET', '/hello', createHandler(
+    { query: Type.Object({ name: Type.Optional(Type.String()) }) },
+    async ({ query }) => ({ message: `Hello, ${query.name || 'World'}!` })
+  )),
+  
+  // 慢请求（用于测试取消）
+  route('GET', '/slow', createHandler(
+    {},
+    async () => {
+      await new Promise(r => setTimeout(r, 5000))
+      return { message: 'Slow response' }
+    }
+  )),
+  
+  // SSE 流式响应
+  route('GET', '/stream', createSSEHandler(
+    { query: Type.Object({ count: Type.Optional(Type.Number({ default: 5 })) }) },
+    async function* ({ query }) {
+      const count = query.count ?? 5
+      
+      yield { event: 'start', data: { message: '开始流式传输...' } }
+      
+      for (let i = 1; i <= count; i++) {
+        yield { id: String(i), data: { index: i, text: `消息 ${i}/${count}` } }
+        await new Promise(r => setTimeout(r, 200))
+      }
+      
+      yield { event: 'end', data: { message: '传输完成!' } }
+    }
+  ))
+])
+
+type Api = InferEden<typeof routes>
+
+async function main() {
+  // 启动服务器
+  console.log('🚀 启动服务器...')
+  const server = serve({
+    fetch: (req) => {
+      const url = new URL(req.url)
+      
+      // 简单路由
+      if (url.pathname === '/hello') {
+        const name = url.searchParams.get('name') || 'World'
+        return new Response(JSON.stringify({ message: `Hello, ${name}!` }), {
+          headers: { 'Content-Type': 'application/json' }
+        })
+      }
+      
+      // 慢请求
+      if (url.pathname === '/slow') {
+        return new Promise(resolve => {
+          setTimeout(() => {
+            resolve(new Response(JSON.stringify({ message: 'Slow response' }), {
+              headers: { 'Content-Type': 'application/json' }
+            }))
+          }, 5000)
+        })
+      }
+      
+      if (url.pathname === '/stream') {
+        const count = parseInt(url.searchParams.get('count') || '5')
+        
+        const stream = new ReadableStream({
+          async start(controller) {
+            const encoder = new TextEncoder()
+            
+            controller.enqueue(encoder.encode(`event: start\ndata: ${JSON.stringify({ message: '开始流式传输...' })}\n\n`))
+            
+            for (let i = 1; i <= count; i++) {
+              controller.enqueue(encoder.encode(`id: ${i}\ndata: ${JSON.stringify({ index: i, text: `消息 ${i}/${count}` })}\n\n`))
+              await new Promise(r => setTimeout(r, 200))
+            }
+            
+            controller.enqueue(encoder.encode(`event: end\ndata: ${JSON.stringify({ message: '传输完成!' })}\n\n`))
+            controller.close()
+          }
+        })
+        
+        return new Response(stream, {
+          headers: {
+            'Content-Type': 'text/event-stream',
+            'Cache-Control': 'no-cache',
+            'Connection': 'keep-alive'
+          }
+        })
+      }
+      
+      return new Response('Not Found', { status: 404 })
+    },
+    port: 3456
+  })
+  
+  console.log('✅ 服务器启动在 http://localhost:3456\n')
+  
+  // 等待服务器启动
+  await new Promise(r => setTimeout(r, 500))
+  
+  // 创建客户端
+  const api = eden<Api>('http://localhost:3456')
+  
+  // ============= 测试 1: 请求取消 =============
+  console.log('🧪 测试 1: 请求取消')
+  
+  const controller = new AbortController()
+  
+  // 发起慢请求
+  const slowPromise = api.slow.get(undefined, { signal: controller.signal })
+  
+  // 100ms 后取消
+  setTimeout(() => {
+    controller.abort()
+    console.log('   ⏹️ 请求已取消')
+  }, 100)
+  
+  const result = await slowPromise
+  // 取消后 status 为 0，error 可能是 AbortError 或 "This operation was aborted"
+  if (result.status === 0 && result.error) {
+    console.log('   ✅ 请求取消成功 (error:', result.error.message || result.error.name, ')\n')
+  } else {
+    console.log('   ❌ 请求取消失败: status=', result.status, '\n')
+  }
+  
+  // ============= 测试 2: 普通请求 =============
+  console.log('🧪 测试 2: 普通请求')
+  const helloResult = await api.hello.get({ name: 'TypeScript' })
+  console.log('   响应:', helloResult.data)
+  console.log()
+  
+  // ============= 测试 3: SSE 流式响应 =============
+  console.log('🧪 测试 3: SSE 流式响应')
+  
+  await new Promise<void>((resolve) => {
+    const sub = api.stream.subscribe(
+      { count: 3 },
+      {
+        onOpen: () => console.log('   📡 连接已建立'),
+        onMessage: (data: unknown) => {
+          console.log('   📨', data)
+        },
+        onError: (err) => console.log('   ❌ 错误:', err.message),
+        onClose: () => {
+          console.log('   📴 连接已关闭')
+          resolve()
+        },
+        onReconnect: (attempt, max) => {
+          console.log(`   🔄 重连中 (${attempt}/${max})...`)
+        },
+        onMaxReconnects: () => {
+          console.log('   ⚠️ 达到最大重连次数')
+        }
+      },
+      {
+        reconnectInterval: 1000,
+        maxReconnects: 3
+      }
+    )
+    
+    // 5 秒超时
+    setTimeout(() => {
+      sub.unsubscribe()
+      resolve()
+    }, 5000)
+  })
+  
+  console.log('\n✅ 所有测试完成!')
+  
+  // 关闭服务器
+  server.stop()
+}
+
+main().catch(console.error)

package/package.json

@@ -1,23 +1,22 @@
 {
   "name": "@vafast/api-client",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Type-safe API client for Vafast framework",
   "license": "MIT",
   "scripts": {
-    "build": "tsup",
-    "dev": "npx tsx watch example/index.ts",
+    "build": "tsdown",
+    "dev": "npx tsx watch example/auto-infer.ts",
     "test": "npx vitest run",
     "release": "npm run build && npm run test && npx bumpp && npm publish --access=public"
   },
   "peerDependencies": {
-    "vafast": ">= 0.1.12"
+    "vafast": ">=0.3.11"
   },
   "devDependencies": {
-    "@types/bun": "1.1.14",
-    "eslint": "9.6.0",
-    "vafast": "^0.1.13",
-    "tsup": "^8.1.0",
-    "typescript": "^5.5.3"
+    "vafast": ">=0.3.11",
+    "tsdown": "^0.19.0-beta.4",
+    "typescript": "^5.5.3",
+    "vitest": "^2.1.8"
   },
   "main": "./dist/cjs/index.js",
   "module": "./dist/index.mjs",
@@ -41,13 +40,13 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/vafastjs/vafast-api-client"
+    "url": "https://github.com/vafast/vafast-api-client"
   },
   "author": {
     "name": "Vafast Team",
-    "url": "https://github.com/vafastjs",
+    "url": "https://github.com/vafast",
     "email": "team@vafast.dev"
   },
-  "homepage": "https://github.com/vafastjs/vafast-api-client",
-  "bugs": "https://github.com/vafastjs/vafast-api-client/issues"
+  "homepage": "https://github.com/vafast/vafast-api-client",
+  "bugs": "https://github.com/vafast/vafast-api-client/issues"
 }