SDK compatibility
Node versions, peer dependencies, package entry points, and prior npm names.
SDK compatibility
Current packages (npm)
| Package | Minimum Node |
|---|---|
@auvy-os/client | 18+ |
@auvy-os/connect-client | 18+ |
Both ship ESM (.mjs) and CJS (.cjs) builds. "type": "module" projects should use default imports; CommonJS can require() the CJS artifacts.
Prior npm package names
Older releases and some examples may still reference @auvy-synapse/client and @auvy-synapse/connect-client. Treat them as aliases for the same surfaces documented on this site — prefer @auvy-os/* for new work.
| Prior name | Current |
|---|---|
@auvy-synapse/client | @auvy-os/client |
@auvy-synapse/connect-client | @auvy-os/connect-client |
@auvy-synapse/kernel (transitive) | @auvy-os/kernel (transitive) |
Peer dependencies
| Package | Peers | Notes |
|---|---|---|
@auvy-os/client | (none required) | Standalone |
@auvy-os/connect-client | @auvy-os/client (optional) | Required for browser transport; server subpath uses kernel only |
Install both for browser Connect:
npm install @auvy-os/client @auvy-os/connect-clientEntry points
| Import path | Build output | Use |
|---|---|---|
@auvy-os/client | dist/index.mjs | AUVY OS product API |
@auvy-os/connect-client | dist/index.mjs | connectFromSession, public types |
@auvy-os/connect-client/advanced | dist/advanced.mjs | Full IntegrationsClient |
@auvy-os/connect-client/server | dist/server/index.mjs | S2S execute |
@auvy-os/connect-client/server/env | dist/server/env.mjs | URL/secret env helpers |
Transitive kernel
@auvy-os/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_*) forbaseUrland publishable keys - Never embed API keys or Connect internal secrets in frontend bundles
Version alignment
Keep @auvy-os/client and @auvy-os/connect-client on the same minor release when using both in one app (e.g. 0.6.x).
Related
- SDK introduction — install
- SDK introduction — package map