@amigo-ai/sdk 1.0.0 → 1.1.1

package/README.md

@@ -1,10 +1,6 @@
-<p align="center">
-  <img src="./assets/readme/amigo-banner.png" alt="Amigo banner" width="100%" />
-</p>
-
 <h1 align="center">@amigo-ai/sdk</h1>
 
-<p align="center">Official TypeScript SDK for the classic Amigo API.</p>
+<p align="center">Official TypeScript SDK for the Amigo classic and Platform APIs.</p>
 
 <p align="center">
   <a href="https://docs.amigo.ai">Product Docs</a>
@@ -25,36 +21,36 @@
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="MIT License" /></a>
 </p>
 
-Typed from the committed classic OpenAPI snapshot, shipped as ESM and CommonJS, and used by current org-scoped Amigo integrations.
+Typed from the Amigo OpenAPI schemas, shipped as ESM and CommonJS, and used by current org-scoped and workspace-scoped Amigo integrations.
 
-## Classic API Context
+## Product Status
 
-The classic SDK is the typed client boundary between your application and the org-scoped Amigo API. It remains the right fit for current integrations that depend on the classic resource model while platform-native coverage expands.
+`@amigo-ai/sdk` remains the supported TypeScript client for the classic Amigo API and now also ships the Platform API client from the `@amigo-ai/sdk/platform` subpath.
 
-![Classic TypeScript SDK architecture](./assets/readme/classic-ts-architecture.png)
+The Platform API is the long-term home for new workspace-scoped capabilities. Classic customers are not being asked to make an abrupt rewrite: the root package export continues to target the current org-scoped API, while new platform integrations can use the platform subpath from the same package.
 
-## Product Status
+## Choose The Right SDK
 
-`@amigo-ai/sdk` remains the supported TypeScript client for the classic Amigo API.
+| If you need | Use |
+| --- | --- |
+| The current org-scoped Amigo API used by existing integrations | `@amigo-ai/sdk` |
+| New workspace-scoped Platform API integrations | `@amigo-ai/sdk/platform` |
 
-The Platform API is the long-term home for new workspace-scoped capabilities, but classic customers are not being asked to make an abrupt rewrite. As equivalent platform surfaces become available, Amigo will publish a migration path and upgrade guidance before recommending a move.
+## API Context
 
-## Choose The Right SDK
+This SDK is the typed client boundary between your application and the classic Amigo API at `https://api.amigo.ai`. It covers the current org-scoped resources used by existing Amigo deployments: conversations, services, organizations, users, agents, context graphs, webhooks, and streaming events.
 
-| If you need                                                    | Use                                                                                   |
-| -------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| The current org-scoped Amigo API used by existing integrations | `@amigo-ai/sdk`                                                                       |
-| New workspace-scoped Platform API integrations                 | [`@amigo-ai/platform-sdk`](https://github.com/amigo-ai/amigo-platform-typescript-sdk) |
+The platform subpath is the typed client boundary for the Platform API at `https://api.platform.amigo.ai`. It includes a raw OpenAPI-typed fetch client, workspace-scoped resources, SSE helpers for streaming turns and workspace events, and WebSocket helpers for public text sessions.
 
 ## Documentation
 
-| Need                                    | Best entry point                                                                            |
-| --------------------------------------- | ------------------------------------------------------------------------------------------- |
-| Product overview and deployment context | [docs.amigo.ai](https://docs.amigo.ai/)                                                     |
-| Integration guidance and developer docs | [Developer Guide](https://docs.amigo.ai/developer-guide)                                    |
-| Generated API reference                 | [amigo-ai.github.io/amigo-typescript-sdk](https://amigo-ai.github.io/amigo-typescript-sdk/) |
-| Runnable examples                       | [examples/](https://github.com/amigo-ai/amigo-typescript-sdk/tree/main/examples)            |
-| Release history                         | [CHANGELOG.md](https://github.com/amigo-ai/amigo-typescript-sdk/blob/main/CHANGELOG.md)     |
+| Need | Best entry point |
+| --- | --- |
+| Product overview and deployment context | [docs.amigo.ai](https://docs.amigo.ai/) |
+| Integration guidance and developer docs | [Developer Guide](https://docs.amigo.ai/developer-guide) |
+| Generated API reference | [amigo-ai.github.io/amigo-typescript-sdk](https://amigo-ai.github.io/amigo-typescript-sdk/) |
+| Runnable examples | [examples/](https://github.com/amigo-ai/amigo-typescript-sdk/tree/main/examples) |
+| Release history | [CHANGELOG.md](https://github.com/amigo-ai/amigo-typescript-sdk/blob/main/CHANGELOG.md) |
 
 ## Installation
 
@@ -62,7 +58,7 @@ The Platform API is the long-term home for new workspace-scoped capabilities, bu
 npm install @amigo-ai/sdk
 ```
 
-## Quick Start
+## Classic Quick Start
 
 ```typescript
 import { AmigoClient } from '@amigo-ai/sdk'
@@ -79,19 +75,33 @@ const conversations = await client.conversations.getConversations({
   sort_by: ['-created_at'],
 })
 
-console.log(conversations.conversations.map(conversation => conversation.id))
+console.log(conversations.conversations.map((conversation) => conversation.id))
+```
+
+## Platform Quick Start
+
+```typescript
+import { PlatformClient } from '@amigo-ai/sdk/platform'
+
+const platform = new PlatformClient({
+  apiKey: 'your-platform-api-key',
+  workspaceId: 'your-workspace-id',
+})
+
+const agents = await platform.agents.list({ query: { limit: 10 } })
+console.log(agents.items.map((agent) => agent.id))
 ```
 
 ## Configuration
 
-| Option     | Type           | Required | Description                                                   |
-| ---------- | -------------- | -------- | ------------------------------------------------------------- |
-| `apiKey`   | `string`       | Yes      | API key from the Amigo dashboard                              |
-| `apiKeyId` | `string`       | Yes      | API key ID paired with `apiKey`                               |
-| `userId`   | `string`       | Yes      | User ID on whose behalf the request is made                   |
-| `orgId`    | `string`       | Yes      | Organization ID for the classic API                           |
-| `baseUrl`  | `string`       | No       | Override the API base URL. Defaults to `https://api.amigo.ai` |
-| `retry`    | `RetryOptions` | No       | Retry policy overrides for transient HTTP failures            |
+| Option | Type | Required | Description |
+| --- | --- | --- | --- |
+| `apiKey` | `string` | Yes | API key from the Amigo dashboard |
+| `apiKeyId` | `string` | Yes | API key ID paired with `apiKey` |
+| `userId` | `string` | Yes | User ID on whose behalf the request is made |
+| `orgId` | `string` | Yes | Organization ID for the classic API |
+| `baseUrl` | `string` | No | Override the API base URL. Defaults to `https://api.amigo.ai` |
+| `retry` | `RetryOptions` | No | Retry policy overrides for transient HTTP failures |
 
 ### Runtime Requirements
 
@@ -108,10 +118,13 @@ type Conversation = components['schemas']['ConversationInstance']
 type GetConversationsQuery = operations['get-conversations']['parameters']['query']
 ```
 
-Public builds are generated from the committed [`specs/openapi-baseline.json`](./specs/openapi-baseline.json) snapshot in this repo so type output stays deterministic across machines and CI runs. When you need to refresh that snapshot, run:
+Platform OpenAPI types are exported from the platform subpath:
 
-```bash
-npm run openapi:sync
+```typescript
+import type { components, operations, paths } from '@amigo-ai/sdk/platform'
+
+type PlatformAgent = components['schemas']['AgentResponse']
+type ListAgentsQuery = operations['list-agents']['parameters']['query']
 ```
 
 ## Retries

package/dist/index.cjs

@@ -193,21 +193,50 @@ var AmigoError = class extends Error {
     };
   }
 };
+function isAmigoErrorOptions(value) {
+  if (!value || typeof value !== "object") return false;
+  const options = value;
+  return "statusCode" in options && (typeof options.statusCode === "number" || options.statusCode === void 0) || "errorCode" in options && (typeof options.errorCode === "string" || options.errorCode === void 0) || "context" in options && (typeof options.context === "object" || options.context === void 0);
+}
 var BadRequestError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 400 });
+  }
 };
 var AuthenticationError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 401 });
+  }
 };
 var PermissionError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 403 });
+  }
 };
 var NotFoundError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 404 });
+  }
 };
 var ConflictError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 409 });
+  }
 };
 var RateLimitError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 429 });
+  }
 };
 var ServerError = class extends AmigoError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 500 });
+  }
 };
 var ServiceUnavailableError = class extends ServerError {
+  constructor(message, options) {
+    super(message, { ...options, statusCode: options?.statusCode ?? 503 });
+  }
 };
 var ConfigurationError = class extends AmigoError {
   constructor(message, field) {
@@ -216,9 +245,14 @@ var ConfigurationError = class extends AmigoError {
   }
 };
 var ValidationError = class extends BadRequestError {
-  constructor(msg, fieldErrors) {
-    super(msg);
+  constructor(msg, optionsOrFieldErrors, fieldErrors) {
+    const isErrorOptions = isAmigoErrorOptions(optionsOrFieldErrors);
+    super(
+      msg,
+      isErrorOptions ? { ...optionsOrFieldErrors, statusCode: optionsOrFieldErrors.statusCode ?? 422 } : { statusCode: 422 }
+    );
     this.fieldErrors = fieldErrors;
+    this.fieldErrors = isErrorOptions ? fieldErrors : optionsOrFieldErrors;
   }
 };
 var NetworkError = class extends AmigoError {