Skip to content

README.md

Latest commit

 

History

History
30 lines (24 loc) · 2.08 KB

README.md

File metadata and controls

30 lines (24 loc) · 2.08 KB
Raw

TypeScript SDK Reference

Start with the localized Quickstart before using this API map. These pages describe exact TypeScript SDK surfaces; runnable end-to-end code lives in the TypeScript tutorial.

Read by task

Task Reference
Understand server/WAM package boundaries Architecture
Configure credentials, signatures, and token scope Authentication and tokens
Define and register an Extension Extensions and family index
Call Channel operations from the server Native Functions
Build a React WAM WAM SDK
Use WAM layout, states, and Bezier presets WAM UI
Generate a starter project CLI
Inspect the shared wire envelope Cross-language protocol

Recommended implementation order

  1. Define shared Zod contracts for server and WAM data.
  2. Configure ChannelAppModule, raw-body capture, SignatureGuard, and auto-registration.
  3. Implement typed Functions and one Extension family.
  4. Add a React WAM only when the flow needs UI.
  5. Use TokenManager plus typed native clients for server-side Channel operations.
  6. Test schema failures, permissions, retries, and the installed app flow.

The installed package exports are authoritative when prose and code disagree. Public JSON payloads use camelCase.