@wave-av/sdk 2.0.11 → 2.0.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +43 -1
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -400,10 +400,52 @@ wave.client.on("rate_limit.hit", (retryAfter) => {
400
400
  });
401
401
  ```
402
402
 
403
+ ## Troubleshooting
404
+
405
+ ### Types not resolving from subpath imports
406
+
407
+ Ensure your `tsconfig.json` uses `"moduleResolution": "node16"` or `"nodenext"`:
408
+
409
+ ```json
410
+ {
411
+ "compilerOptions": {
412
+ "module": "node16",
413
+ "moduleResolution": "node16"
414
+ }
415
+ }
416
+ ```
417
+
418
+ ### Rate limit errors
419
+
420
+ The SDK retries automatically with exponential backoff. To handle rate limits explicitly:
421
+
422
+ ```typescript
423
+ wave.client.on("rate_limit.hit", (retryAfter) => {
424
+ console.log(`Rate limited. Retry in ${retryAfter}ms`);
425
+ });
426
+ ```
427
+
428
+ ### ESM vs CJS
429
+
430
+ The SDK supports both ESM and CJS. If using CommonJS, ensure you're importing correctly:
431
+
432
+ ```javascript
433
+ const { Wave } = require("@wave-av/sdk");
434
+ ```
435
+
403
436
  ## Requirements
404
437
 
405
438
  - Node.js 18+
406
- - TypeScript 5.0+ (for TypeScript users)
439
+ - TypeScript 5.0+ (recommended 5.5+ for best subpath support)
440
+
441
+ ## Related packages
442
+
443
+ - [@wave-av/adk](https://www.npmjs.com/package/@wave-av/adk) — Agent Developer Kit for building AI video agents
444
+ - [@wave-av/mcp-server](https://www.npmjs.com/package/@wave-av/mcp-server) — MCP server for Claude, Cursor, Windsurf
445
+ - [@wave-av/cli](https://www.npmjs.com/package/@wave-av/cli) — Command-line interface
446
+ - [@wave-av/create-app](https://www.npmjs.com/package/@wave-av/create-app) — Scaffold a new project
447
+ - [@wave-av/workflow-sdk](https://www.npmjs.com/package/@wave-av/workflow-sdk) — Workflow orchestration
448
+ - [OpenAPI spec](https://github.com/wave-av/api-spec) — Full API specification
407
449
 
408
450
  ## License
409
451
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wave-av/sdk",
3
- "version": "2.0.11",
4
- "description": "Official WAVE SDK - 34 API modules covering streaming, production, device management, analytics, content, monetization, and more",
3
+ "version": "2.0.13",
4
+ "description": "Official WAVE SDK for TypeScript and Node.js \u2014 34 API modules for live video streaming, production, analytics, voice, captions, and more",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",
7
7
  "types": "./dist/index.d.ts",