Skip to content

Public API and import paths

The supported package entry points, compatibility aliases, and advanced escape hatches.

Use package roots for application code. These entry points contain the stable definitions, clients, servers, carriers, runtime coordinates, and error domains used in the guides.

PackageRoot surfaceSupported subpaths
@nice-code/wireRuntimeCoordinate, createWireClient, serveWire, carriers, connection status and errors/advanced for protocol and secure-session primitives; /platform/cloudflare for Durable Object hosting
@nice-code/actiondomains, schemas, runtimes, channels, carriers, serving and connecting/advanced, /testing, /testing-transport, /react-query, /platform/cloudflare, /devtools/browser, /devtools/server
@nice-code/realmdefinitions, clients, engines and protocol adapters/testing, /predict, /react, /platform/cloudflare, /devtools/browser, /devtools/server

@nice-code/wire/internals and @nice-code/realm/internals are available to the Nice Code packages themselves. Consumer code should not depend on them because their exports can change without a migration alias.

This release retains the previous root exports and renamed members as deprecated compatibility aliases. In particular, serveRealmDurableObject, IRealmDurableObjectHost, peerClient, runtimeCoordinate, keepLinkAlive, and linkKeepalive continue to work. New code should use createRealmHost, IRealmHost, peer, reconnect, and heartbeat. The compatibility aliases do not change wire bytes or persisted formats.