@waitroom-io/sdk 0.0.1 → 0.0.4

package/README.md

@@ -0,0 +1,195 @@
+# @waitroom-io/sdk
+
+TypeScript SDK for the [Waitroom](https://waitroom.io) API — the coordination layer between AI agents and humans.
+
+## Install
+
+```bash
+npm install @waitroom-io/sdk
+```
+
+## Quick Start
+
+```typescript
+import { WaitroomClient } from '@waitroom-io/sdk';
+
+const client = new WaitroomClient({
+  apiKey: 'wr_your_api_key',
+  baseUrl: 'https://api.waitroom.io', // optional, defaults to http://localhost:3001
+});
+
+// Create a check-in and wait for approval
+const checkIn = await client.checkIns.checkInAndWait('general', {
+  action: 'Deploy to production',
+  risk_level: 'high',
+  description: 'Deploying v2.1.0 with database migrations',
+});
+
+if (checkIn.status === 'approved') {
+  console.log('Approved! Proceeding with deployment...');
+} else if (checkIn.status === 'modified') {
+  console.log('Modified:', checkIn.modifications);
+} else {
+  console.log('Rejected:', checkIn.decision_reason);
+}
+```
+
+## Resources
+
+### Check-Ins
+
+```typescript
+// Create a check-in
+const checkIn = await client.checkIns.create('room-slug', {
+  action: 'Deploy API',
+  risk_level: 'medium',       // low | medium | high | critical
+  urgency: 'normal',          // low | normal | high | urgent
+  description: 'Optional details',
+  context: { pr: '#123' },
+  timeout_minutes: 60,
+  timeout_action: 'cancel',   // auto_approve | cancel | hold
+});
+
+// Create and wait for decision (polls with exponential backoff)
+const result = await client.checkIns.checkInAndWait('room-slug', {
+  action: 'Deploy API',
+}, { maxWaitMs: 300000 }); // 5 min default
+
+// Poll status
+const status = await client.checkIns.getStatus('ci_abc123');
+
+// Approve / Reject / Modify
+await client.checkIns.approve('ci_abc123', { reason: 'Looks good' });
+await client.checkIns.reject('ci_abc123', { reason: 'Too risky' });
+await client.checkIns.modify('ci_abc123', {
+  reason: 'Use staging first',
+  modifications: { environment: 'staging' },
+});
+
+// Withdraw a pending check-in
+await client.checkIns.withdraw('ci_abc123');
+
+// List pending check-ins in a room
+const pending = await client.checkIns.listPending('room-slug');
+```
+
+### Rooms
+
+```typescript
+const rooms = await client.rooms.list();
+const room = await client.rooms.get('room-slug');
+const created = await client.rooms.create({ name: 'Deployments', slug: 'deployments' });
+await client.rooms.update('room-slug', { description: 'Production deploys' });
+await client.rooms.delete('room-slug');
+
+// Policies
+await client.rooms.updatePolicies('room-slug', {
+  policies: {
+    default_action: 'require_approval',
+    timeout_minutes: 30,
+    timeout_action: 'cancel',
+    rules: [
+      { action: 'auto_approve', conditions: { risk_level: ['low'] } },
+      { action: 'forbid', conditions: { risk_level: ['critical'] } },
+    ],
+    trust_thresholds: { auto_approve_low: 80, auto_approve_medium: 60 },
+  },
+});
+
+// Room audit trail
+const events = await client.rooms.getAudit('room-slug');
+```
+
+### Agents
+
+```typescript
+const agents = await client.agents.list();
+const agent = await client.agents.get('agent-id');
+const me = await client.agents.me();
+
+// Register (human-initiated)
+const { agent, api_key } = await client.agents.register({
+  name: 'Deploy Bot',
+  platform: 'github-actions',
+});
+
+// Self-register (no auth required)
+const { agent, api_key, claim_token } = await client.agents.selfRegister({
+  name: 'My Agent',
+});
+
+// Claim a self-registered agent
+await client.agents.claim('wr_claim_abc123');
+
+// Update / Delete
+await client.agents.update('agent-id', { name: 'New Name' });
+await client.agents.delete('agent-id');
+
+// Regenerate API key
+const { api_key } = await client.agents.regenerateKey('agent-id');
+
+// Trust scores
+const scores = await client.agents.getTrust('agent-id');
+
+// Agent audit trail
+const events = await client.agents.getAudit('agent-id');
+```
+
+### Signals
+
+```typescript
+await client.signals.broadcast('room-slug', {
+  type: 'deployment.started',
+  payload: { version: '2.1.0', environment: 'production' },
+});
+```
+
+### Watchers
+
+```typescript
+const watcher = await client.watchers.create('room-slug', {
+  event_types: ['check_in.created', 'check_in.decided'],
+  webhook_url: 'https://example.com/webhook', // optional
+});
+
+await client.watchers.remove('w_abc123');
+```
+
+### Audit
+
+```typescript
+const { events, cursor } = await client.audit.list({
+  event_type: 'check_in.created',
+  limit: 50,
+});
+```
+
+### Home
+
+```typescript
+// Agent dashboard summary
+const dashboard = await client.home();
+```
+
+## Error Handling
+
+```typescript
+import { WaitroomError } from '@waitroom-io/sdk';
+
+try {
+  await client.checkIns.approve('ci_abc123');
+} catch (err) {
+  if (err instanceof WaitroomError) {
+    console.error(err.code);       // 'NOT_FOUND'
+    console.error(err.statusCode); // 404
+    console.error(err.message);    // 'Check-in not found'
+    console.error(err.details);    // validation errors, if any
+  }
+}
+```
+
+## Links
+
+- [Documentation](https://waitroom.io/docs)
+- [CLI](https://www.npmjs.com/package/@waitroom-io/cli)
+- [GitHub](https://github.com/anthropics/waitroom)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waitroom-io/sdk",
-  "version": "0.0.1",
+  "version": "0.0.4",
   "description": "TypeScript SDK for the Waitroom API — coordination layer between AI agents and humans",
   "type": "module",
   "main": "./dist/index.js",