polymorph-sdk 0.1.0 → 0.2.2

package/README.md

@@ -1,102 +1,76 @@
-# Polymorph SDK for TypeScript
+# polymorph-sdk
 
-Tool logging wrapper for Vercel AI SDK. Automatically logs tool calls to the Polymorph API for monitoring and analytics.
+Embeddable voice AI widget for your website.
 
 ## Installation
 
 ```bash
-npm install polymorph-sdk ai
+npm install polymorph-sdk
 ```
 
-## Usage
-
-```typescript
-import { streamText, tool } from "ai";
-import { anthropic } from "@ai-sdk/anthropic";
-import { z } from "zod";
-import { PolymorphConfig, createPolymorphAIClient } from "polymorph-sdk";
-
-// Create Polymorph config
-const config = new PolymorphConfig({
-  role: "user",
-  apiKey: "your-api-key", // or set POLYMORPH_API_KEY env var
-  baseUrl: "https://api.polymorph.dev", // or set POLYMORPH_BASE_URL env var
-});
-
-// Create Polymorph client
-const polymorph = createPolymorphAIClient({ config });
-
-// Define your tools
-const tools = {
-  getWeather: tool({
-    description: "Get the weather for a location",
-    parameters: z.object({
-      location: z.string().describe("The location to get weather for"),
-    }),
-    execute: async ({ location }) => {
-      // Your tool implementation
-      return { temperature: 72, condition: "sunny" };
-    },
-  }),
-};
-
-// Wrap tools with Polymorph logging
-const wrappedTools = polymorph.wrapTools(tools);
-
-// Use with streamText
-const result = await streamText({
-  model: anthropic("claude-sonnet-4-20250514"),
-  tools: wrappedTools,
-  messages: [{ role: "user", content: "What's the weather in San Francisco?" }],
-});
-```
-
-### Alternative: Wrap streamText/generateText
-
-You can also wrap the AI SDK functions directly:
-
-```typescript
-import { streamText, generateText } from "ai";
-import { PolymorphConfig, createPolymorphAIClient } from "polymorph-sdk";
+> Requires `react` and `react-dom` as peer dependencies (`^18.0.0 || ^19.0.0`).
 
-const config = new PolymorphConfig({ role: "user" });
-const polymorph = createPolymorphAIClient({ config });
-
-// Create wrapped versions of streamText and generateText
-const polymorphStreamText = polymorph.streamText(streamText);
-const polymorphGenerateText = polymorph.generateText(generateText);
+## Usage
 
-// Now use these wrapped functions - tools will be automatically logged
-const result = await polymorphStreamText({
-  model: anthropic("claude-sonnet-4-20250514"),
-  tools: myTools, // Tools are automatically wrapped
-  messages: [...],
-});
+```tsx
+import { PolymorphWidget } from "polymorph-sdk";
+
+function App() {
+  return (
+    <PolymorphWidget
+      apiBaseUrl="https://api.polymorph.dev"
+      apiKey="pm_live_your_api_key_here"
+      branding={{
+        title: "Need help?",
+        subtitle: "Chat with us",
+        primaryColor: "#171717",
+      }}
+    />
+  );
+}
 ```
 
 ## Configuration
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `role` | `string` | (required) | User role for RBAC functionality |
-| `apiKey` | `string` | `POLYMORPH_API_KEY` env var | API key for authentication |
-| `baseUrl` | `string` | `POLYMORPH_BASE_URL` env var | Base URL for Polymorph API |
-| `httpTimeout` | `number` | `10000` | HTTP request timeout in milliseconds |
-| `httpEnabled` | `boolean` | `true` | Whether HTTP logging is enabled |
-
-## Environment Variables
-
-- `POLYMORPH_API_KEY` - API key for authentication
-- `POLYMORPH_BASE_URL` - Base URL for Polymorph API
+| Prop | Type | Required | Description |
+|------|------|----------|-------------|
+| `apiBaseUrl` | `string` | Yes | Your Polymorph API base URL |
+| `apiKey` | `string` | Yes | API key from Settings > API Keys |
+| `agentName` | `string` | No | LiveKit agent name to dispatch (default: `"custom-voice-agent"`) |
+| `metadata` | `Record<string, string>` | No | Custom metadata passed to the agent |
+| `branding` | `WidgetBranding` | No | Customize widget appearance |
+| `position` | `"bottom-right" \| "bottom-left"` | No | Widget position (default: `"bottom-right"`) |
+| `enableVoice` | `boolean` | No | Enable voice calls (default: `true`) |
+| `fetchOptions` | `RequestInit` | No | Extra options passed to fetch |
+
+### Branding
+
+```tsx
+interface WidgetBranding {
+  primaryColor?: string;  // FAB and accent color (default: "#171717")
+  title?: string;         // Panel header title (default: "Hi there")
+  subtitle?: string;      // Panel subheader
+  greeting?: string;      // Initial message before agent connects
+}
+```
 
-## API Endpoints
+## Hooks
 
-The SDK sends events to the following endpoints:
+For custom UIs, use the session hook directly:
 
-- `POST /sdk/init` - Called on client initialization
-- `POST /sdk/tool/pre` - Called before tool execution
-- `POST /sdk/tool/post` - Called after tool execution
+```tsx
+import { usePolymorphSession } from "polymorph-sdk";
 
-## License
+function CustomWidget() {
+  const session = usePolymorphSession({
+    apiBaseUrl: "https://api.polymorph.dev",
+    apiKey: "pm_live_...",
+  });
 
-MIT
+  return (
+    <button onClick={session.connect}>
+      {session.status === "idle" ? "Start" : session.status}
+    </button>
+  );
+}
+```