Skip to content

SDK compatibility matrix

This matrix describes the supported runtime surface for @dlbr/eid-sdk@0.1.0-beta.2. The SDK is a server-side package: API keys must remain in runtime secrets and must never be bundled into browser code.

Runtime or frameworkSupportRequirements and notes
Node.jsSupportedNode.js 20+; ESM import; global fetch is required. Provide a WebSocket constructor when the runtime does not expose one and sessions.events is used.
BunSupportedCurrent Bun 1.x; use the native fetch and WebSocket implementations.
DenoSupportedCurrent Deno release; import through npm:@dlbr/eid-sdk and grant --allow-env --allow-net.
Cloudflare WorkersSupportedUse Worker secrets/bindings for credentials; the runtime provides fetch and WebSocket support.
Express / FastifySupportedRun on a supported Node.js runtime; keep one SDK client per credential set.
HonoSupportedSupported on Node.js and Cloudflare Workers with server-side bindings.
Next.js App RouterSupportedUse a server route with runtime = "nodejs"; never expose values through NEXT_PUBLIC_*.
Browser / React clientNot supportedThe SDK requires a trusted server boundary because API keys are bearer credentials. Return only the session data the browser needs from your backend.

Runtime requirements

  • ESM is the supported module format. The package does not publish a CommonJS entry point.
  • fetch can be replaced with the constructor's fetch option for test harnesses or runtimes with a compatible implementation.
  • sessions.events.connect() additionally requires a WebSocket implementation; pass webSocket when the runtime does not provide a global constructor.
  • Node.js, Bun, Deno, and Workers examples are maintained in packages/sdk/examples and linked from the quickstarts.

Environment compatibility

The SDK uses the same resource API in both environments. Select the matching pair explicitly:

Gateway environmentKey prefixmode
Sandbox / stagingsk_test_test
Live / productionsk_live_live

The client rejects an explicit mode/key mismatch and requires an HTTPS base URL for live mode.

Support policy

Compatibility is evaluated against the matrix when a release is cut. Runtime minimums and framework behavior are public compatibility claims; changes to them follow the SemVer and deprecation policy. If a runtime falls out of vendor support, it moves to a documented maintenance state before removal from this matrix.

Built for developers integrating privacy-preserving identity verification.