@chaoslabs/ai-sdk 0.0.3 → 0.0.4

package/README.md

@@ -3,7 +3,12 @@
 Official TypeScript SDK for the Chaos AI API. Build DeFi-aware applications with portfolio analysis, swap operations, lending, and more.
 
 ## Installation
-`TBD`
+
+```bash
+npm install @chaoslabs/ai-sdk
+# or
+bun add @chaoslabs/ai-sdk
+```
 
 ## Quick Start
 
@@ -50,6 +55,36 @@ for (const block of blocks) {
 }
 ```
 
+### 4. Real-Time Streaming (Optional)
+
+Get real-time updates as the AI processes your request:
+
+```typescript
+import { Chaos, WALLET_MODEL, type StreamMessage } from '@chaoslabs/ai-sdk';
+
+const response = await chaos.chat.responses.create({
+  model: WALLET_MODEL,
+  input: [
+    { type: 'message', role: 'user', content: 'What is in my portfolio?' }
+  ],
+  metadata: { user_id: 'user-123', session_id: 'session-abc', wallet_id: '0x...' },
+  onStreamEvent: (msg: StreamMessage) => {
+    // Called immediately as each message arrives from the server
+    console.log(`[${msg.type}]`, msg.content);
+  },
+});
+```
+
+**Stream Message Types:**
+
+| Type | Description |
+|------|-------------|
+| `agent_status_change` | Status updates: `processing`, `done`, `error` |
+| `agent_message` | Progress messages during processing |
+| `report` | Content blocks as they're generated |
+| `follow_up_suggestions` | Suggested follow-up queries |
+| `user_input` | Clarification requests |
+
 ## API Reference
 
 ### Chaos Client
@@ -66,6 +101,15 @@ new Chaos(config: ChaosConfig)
 | `baseUrl` | `string` | `https://ai-staging.chaoslabs.co` | API base URL |
 | `timeout` | `number` | `120000` | Request timeout in milliseconds |
 
+### Request Options
+
+| Option | Type | Description |
+|--------|------|-------------|
+| `model` | `string` | Model to use (e.g., `WALLET_MODEL`) |
+| `input` | `InputItem[]` | Conversation messages |
+| `metadata` | `RequestMetadata` | User, session, and wallet info |
+| `onStreamEvent` | `(msg: StreamMessage) => void` | Real-time streaming callback |
+
 > **Important:** API keys are environment-specific. A staging API key will not work with the production API, and vice versa. Make sure your `apiKey` and `baseUrl` are from the same environment.
 
 **Available Environments:**
@@ -220,6 +264,7 @@ import type {
   Block,
   TableBlock,
   TransactionActionBlock,
+  StreamMessage,
   // ... and more
 } from '@chaoslabs/ai-sdk';
 ```

package/dist/__tests__/http-streaming.test.d.ts

@@ -0,0 +1,15 @@
+/**
+ * HTTP Streaming Tests (TDD - RED Phase)
+ *
+ * These tests verify the http-based streaming implementation that will replace fetch.
+ * Tests are written BEFORE the implementation (TDD RED phase).
+ *
+ * The implementation will use Node's native http/https modules for streaming
+ * instead of fetch to ensure proper incremental streaming behavior.
+ *
+ * KEY TESTS THAT MUST FAIL INITIALLY:
+ * - httpStreamRequest function (doesn't exist yet)
+ * - StreamingHttpClient class (doesn't exist yet)
+ * - useNativeHttp option (doesn't exist yet)
+ */
+export {};