@puku-ai/sdk 3.0.5 → 4.0.1

package/README.md

@@ -25,6 +25,7 @@ console.log(msg.content[0].text);
 
 - [Install](#install)
 - [Configuration](#configuration)
+- [Supported models](#supported-models)
 - [Usage](#usage)
 - [Working features](#working-features)
 - [Namespace](#namespace)
@@ -65,6 +66,20 @@ const client = new PukuAI({
 });
 ```
 
+Defaults: `maxRetries = 2`, `timeout = 600_000` ms (10 min). 
+
+## Supported models
+
+Exactly three model names are accepted by the Puku gateway. Any other string
+returns a model-not-found error.
+
+| Model         | Family   | Notes |
+|---------------|----------|-------|
+| `puku-ai-2.7` | Puku AI  | Cheaper, lower-latency. |
+| `puku-ai-2.8` | Puku AI  | Default for most workloads. |
+| `opus-4.8`    | Opus     | Strongest reasoning; pick this for fallbacks (`fallbacks: [{ model: "opus-4.8" }]`). |
+
+
 ## Usage
 
 ### Blocking
@@ -140,12 +155,8 @@ All error classes are static members of the `PukuAI` class,
 ## Working features
 
 Every feature below was exercised against the live Puku gateway at
-
-
-```bash
-PUKU_BASE_URL="" \
-PUKU_API_KEY=pk_live_... \
-```
+`PUKU_BASE_URL=` with a `pk_live_*` API key (see
+`.env` and `.env.staging.example`). 
 
 ### Verified against the live gateway
 
@@ -168,6 +179,14 @@ PUKU_API_KEY=pk_live_... \
 |--------------------------------------|--------|------|
 | `client.messages.countTokens`        | ⚠ 404  | SDK POSTs to `/v1/messages/count_tokens` exactly like upstream. Puku's gateway does not proxy this endpoint. |
 | `client.messages.batches.create`     | ⚠ 404  | SDK POSTs to `/v1/messages/batches` exactly like upstream. Puku's gateway does not proxy this endpoint. |
+| `client.beta.agents.*`               | ⚠ 404  | SDK POSTs to `/v1/agents/*` exactly like upstream. Puku's gateway does not proxy these endpoints yet. |
+| `client.beta.environments.*`         | ⚠ 404  | SDK POSTs to `/v1/environments/*` exactly like upstream. Puku's gateway does not proxy these endpoints yet. |
+| `client.beta.sessions.*`             | ⚠ 404  | SDK POSTs to `/v1/sessions/*` exactly like upstream. Puku's gateway does not proxy these endpoints yet. |
+| `client.beta.vaults.*`               | ⚠ 404  | SDK POSTs to `/v1/vaults/*` exactly like upstream. Puku's gateway does not proxy these endpoints yet. |
+| `client.beta.skills.{listVersions, retrieve, delete}` | ⚠ 404 | SDK POSTs/GETs to `/v1/skills/{id}/versions/...` exactly like upstream. Puku's gateway does not proxy these endpoints yet. The pure archive-validation helpers (`assertSafeMemberNames`, `assertNoSpecialMembers`, `runArchiveTool`, `archiveTopDir`, `readHead`) remain usable. |
+| `client.messages.batches.results`    | ⚠ n/a  | Not exercised against the live gateway because `batches.create` already 404s. |
+| Structured-outputs JSON parser (`output_format` / `output_config.format`) | ⚠ not wired | The SDK accepts the option but no structured-outputs parser is hooked into the stream finalizer. The `JSONOutputFormat` shape exists in types only. |
+| Server-side `web_search` tool result | ⚠ not proxied | The SDK forwards a `web_search_20250305` tool definition; the gateway does not execute the search and returns the placeholder shape. Use the agent toolset + your own search client instead. |
 
 
 
@@ -198,7 +217,7 @@ const getWeather = {
 
 const finalMessage = await client.beta.messages
   .toolRunner({
-    model: "puku-ai--2.8",
+    model: "puku-ai-2.8",
     max_tokens: 512,
     messages: [{ role: "user", content: "What's the weather in Tokyo?" }],
     tools: [getWeather],
@@ -220,7 +239,7 @@ import PukuAI from "@puku-ai/sdk";
 const client = new PukuAI();
 
 const stream = client.messages.stream({
-  model: "puku-ai--2.8",
+  model: "puku-ai-2.8",
   max_tokens: 128,
   messages: [{ role: "user", content: "Say hello in three languages." }],
 });
@@ -255,7 +274,7 @@ await mcp.connect(clientT);
 const tools = await mcpTools({ mcpClient: mcp });
 
 const reply = await client.beta.messages.create({
-  model: "puku-ai--2.8",
+  model: "puku-ai-2.8",
   max_tokens: 512,
   mcp_servers: [{ type: "url", url: "https://mcp.example.com/sse", name: "example" }],
   messages: [{ role: "user", content: "Find any open PRs." }],
@@ -334,7 +353,7 @@ PukuAI.VERSION;          // SDK version
 ### CJS / ESM shim
 
 When you `require('@puku-ai/sdk')`, the default export is a callable function
-that instantiates `PukuAI` — matching the `@anthropic-ai/sdk` convention:
+that instantiates `PukuAI`:
 
 ```ts
 // CJS or ESM-from-CJS:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@puku-ai/sdk",
-  "version": "3.0.5",
+  "version": "4.0.1",
   "description": "PukuAI client SDK",
   "type": "module",
   "main": "./sdk.cjs",
@@ -13,7 +13,23 @@
       "require": "./sdk.cjs",
       "default": "./sdk.mjs"
     },
-    "./package.json": "./package.json"
+    "./package.json": "./package.json",
+    "./*.mjs": {
+      "types": "./sdk.d.ts",
+      "import": "./sdk.mjs",
+      "default": "./sdk.mjs"
+    },
+    "./*.js": {
+      "types": "./sdk.d.ts",
+      "require": "./sdk.cjs",
+      "default": "./sdk.cjs"
+    },
+    "./*": {
+      "types": "./sdk.d.ts",
+      "import": "./sdk.mjs",
+      "require": "./sdk.cjs",
+      "default": "./sdk.mjs"
+    }
   },
   "files": [
     "sdk.mjs",
@@ -42,7 +58,8 @@
   },
   "homepage": "https://github.com/puku-ai/puku-ai-sdk#readme",
   "dependencies": {
-    "json-schema-to-ts": "^3.1.1"
+    "json-schema-to-ts": "^3.1.1",
+    "standardwebhooks": "^1.0.0"
   },
   "peerDependencies": {
     "zod": "^3.25.0 || ^4.0.0"
@@ -55,16 +72,18 @@
   "scripts": {
     "build": "bun run scripts/build.ts",
     "smoke": "node scripts/smoke-offline.mjs",
-    "smoke:brand": "node scripts/smoke-anthropic-free.mjs",
+    "smoke:brand": "node scripts/smoke-puku-brand.mjs",
     "smoke:live": "bun run build && node --experimental-vm-modules scripts/smoke.mjs",
     "integration": "bun run build && node scripts/integration.mjs",
-    "parity": "bun run build && node tests/parity/run-all.mjs",
+    "parity": "node tests/parity/run-all.mjs",
+    "test": "jest --config jest.config.cjs",
     "type-check": "tsc --noEmit",
     "prepack": "bun run build"
   },
   "devDependencies": {
     "@types/node": "^22.10.0",
     "bun-types": "^1.1.0",
-    "typescript": "^5.6.0"
+    "typescript": "^5.6.0",
+    "zod": "^4.0.0"
   }
 }