Reference

The API surface, organized by primitive and by package.

Primitives

The define* functions that domain code uses every day. Each has its own page with signature, params, return type, runtime semantics, and a working example.

Core

• defineHandler — operation primitive (transport-agnostic)
• defineEvent — past-tense fact with a Zod schema
• createApp — build an App (bounded context with container + plugins + wires)
• definePlugin — cross-cutting plugin
• defineResource — public response shape (field allowlist)
• defineError — typed throwable error

Forge (CQRS battery, opt-in)

• defineAction — user-visible command, validated input, emits events
• defineActor — aggregate root with state, methods, optional state machine
• defineWorkflow — reaction + saga unified
• defineProjection — fold events into a read model
• defineQuery — projection-backed read function
• defineSchema — data shape + lifecycle states

Orchestrator

• defineCron — scheduled action runner
• defineInbox — inbound message deduplicator
• defineOutbox — at-least-once publisher
• defineExternalCall — typed outbound HTTP/RPC
• defineInboundWebhook — signature-verified webhook receiver

HTTP

• Route bindings — get / post / put / patch / del from @nwire/wires/http
• endpoint() + lifecycle — graceful shutdown
  • K8s probes; .use(adopter).mount(app).run()
• @nwire/koa README — the canonical HTTP adopter
• @nwire/express README — Express-backed adopter + foreign mount helpers

Other

• Packages — every @nwire/* package with a one-liner
• CLI — nwire dev, nwire run, nwire studio, nwire please, …
• Runtime API — runtime.execute, runtime.query, runtime.publish, …
• Telemetry kinds — every record the telemetry stream emits

Conventions

• All primitives accept an object literal as their primary argument. Some accept a positional name string first.
• Names use kebab-case prefixed by the bounded context: orders.place-order.
• Exported symbols use PascalCase: OrderWasPlaced.
• Cross-App events that flow over a bus carry an explicit version number.