Documentation Index
Fetch the complete documentation index at: https://docs.auvy.ai/llms.txt
Use this file to discover all available pages before exploring further.
SDK compatibility
Runtime
| Package | Minimum Node |
|---|
@auvy-synapse/client | 18+ |
@auvy-synapse/connect-client | 18+ |
.mjs) and CJS (.cjs) builds. "type": "module" projects should use default imports; CommonJS can require() the CJS artifacts.
Peer dependencies
| Package | Peers | Notes |
|---|
@auvy-synapse/client | (none required) | Standalone |
@auvy-synapse/connect-client | @auvy-synapse/client (optional) | Required for browser transport; server subpath uses kernel only |
npm install @auvy-synapse/client @auvy-synapse/connect-client
Entry points
| Import path | Build output | Use |
|---|
@auvy-synapse/client | dist/index.mjs | Synapse product API |
@auvy-synapse/connect-client | dist/index.mjs | connectFromSession, public types |
@auvy-synapse/connect-client/advanced | dist/advanced.mjs | Full IntegrationsClient |
@auvy-synapse/connect-client/server | dist/server/index.mjs | S2S execute |
@auvy-synapse/connect-client/server/env | dist/server/env.mjs | URL/secret env helpers |
Transitive kernel
@auvy-synapse/kernel is a dependency (not a peer) of both published SDK packages. Types and small isomorphic helpers resolve through kernel subpaths. Do not depend on kernel directly unless you need shared schemas outside the client facades.
Browser bundlers
- Vite / Nuxt / Next: default ESM imports work
- Set public env vars (
NEXT_PUBLIC_*, NUXT_PUBLIC_*) for baseUrl and publishable keys
- Never embed API keys or Connect internal secrets in frontend bundles
Version alignment
Keep @auvy-synapse/client and @auvy-synapse/connect-client on the same minor release when using both in one app (e.g. 0.6.x).