Files
alknet/docs/architecture/decisions/016-napi-expose-connect-and-serve.md
glm-5.1 596c89ce24 refactor!: rebrand wraith to alknet
Rename all crates, CLI commands, constants, type names, doc comments,
and documentation from wraith to alknet. Includes wire-protocol changes:
ALPN wraith-ssh -> alknet-ssh, reserved destination prefix wraith- ->
alknet-, SSH auth username wraith -> alknet.
2026-06-05 10:04:32 +00:00

2.5 KiB

ADR-016: NAPI Exposes Both connect() and serve()

Status

Accepted

Context

The NAPI wrapper needs to provide TypeScript/Node.js consumers with access to alknet's functionality. The primary use case is @alkdev/pubsub's event target system, which needs both directions:

  1. connect(): Establish a client connection to a alknet server. Used by workers/spokes that need to tunnel events through a alknet server.
  2. serve(): Start a alknet server from Node.js. Used by hubs that want to accept alknet connections and route events.

The previous decision (ADR-007) was to expose only connect() for MVP, deferring serve(). However, the pubsub integration requires both: a spoke needs connect() to reach a hub, and a hub could use serve() to accept connections without running a separate alknet serve process.

More importantly, both connect() and serve() are fundamental operations of the alknet library. Since the NAPI wrapper is a thin layer over alknet-core, exposing both is straightforward — they're just Rust functions behind #[napi] attributes.

Decision

The NAPI wrapper exposes both connect() and serve() from the start:

// @alkdev/alknet
function connect(options: AlknetConnectOptions): Promise<Duplex>;
function serve(options: AlknetServeOptions): Promise<AlknetServer>;
  • connect() returns a Duplex stream (as per ADR-007)
  • serve() returns a AlknetServer object with a close() method and events for new connections

The NAPI layer is transport-agnostic — it doesn't know about pubsub's EventEnvelope. The pubsub event target adapter wraps the Duplex stream to implement TypedEventTarget. This separation ensures the NAPI wrapper is reusable for any stream-based protocol, not just pubsub.

Consequences

  • Positive: Pubsub can use both directions without running a separate binary for the server side.
  • Positive: The NAPI wrapper becomes a complete bridge — any Node.js process can be either a client or server.
  • Positive: Implementation is still minimal — serve() is just alknet_core::server::run() behind #[napi].
  • Negative: Slightly larger API surface (two functions + AlknetServer type instead of just connect()).
  • Negative: Server-side NAPI needs to handle multiple concurrent connections, which adds complexity to AlknetServer.

References