Runtime support

Supported runtimes

The SDK runs on Node 24+, Bun, Deno, modern browsers, Cloudflare Workers, and Vercel Edge. It uses fetch, AbortController, web streams for SSE, and crypto.randomUUID where available. On a runtime without fetch in the global scope, pass one in through the fetch constructor option.

Module format

The package ships as ESM and CommonJS with subpath exports and bundled type declarations, and is marked side-effect free for tree shaking.

Types

Every request body and response is exported as a type, so you can annotate your own code against the SDK. Response objects tolerate unknown fields, so a field added server-side will not break parsing. Request bodies are the Create*/Update* types, with required and optional fields encoded in the type, so a mistyped or missing field is a compile error at the call site.

Versioning

Pre-1.0, minor versions may include breaking changes. See the CHANGELOG.md in the package for each release.

Prereleases are published from the staging branch under the beta dist-tag. Install the latest prerelease with:

pnpm add @bimpeai/sdk@beta