Changes to NodeWire are recorded here. Entries describe the published package's public API and behavior; internal refactors are included when they affect users.

Versioning and compatibility

  • Before 1.0, minor releases may introduce breaking changes to the documented public API. Patch releases preserve that API. Review this changelog before upgrading to a new minor release.
  • The Hex package version tracks the library API. Each NodeWire.Protocol version tracks an application's message contract; incompatible message changes require a new protocol version. Both peers must offer a matching version and codec, with the required capabilities.
  • The NodeWire wire envelope has its own version, currently 1. A package update does not by itself change application protocol versions or the wire envelope.
  • Functions and modules hidden from the API documentation are implementation details and are not covered by the public API compatibility policy.

0.1.0

Initial release.

Added

  • TLS client and server endpoints with server certificate verification and hostname matching enabled by default on clients, and application-defined authentication.
  • Compile-time protocol declarations, version and capability negotiation, and Erlang external term format (ETF) and JSON application codecs. Endpoints support up to eight configured protocol versions and reject larger sets at startup.
  • Handler callbacks for authentication, payload validation, messages and lifecycle events, with ordered send, phase-transition and close actions.
  • Explicit application phases, readiness deadlines and heartbeat timers.
  • Supervised server connections with identity routing and duplicate-identity rejection; persistent clients with configurable reconnect behavior and fresh handler state for each connection attempt.
  • Per-connection message and byte admission limits shared by public sends and instance-scoped asynchronous notifications. Sends distinguish local write success, pre-write rejection and unknown delivery outcomes. Application messages are never automatically replayed.
  • Structured failure metadata, lifecycle observation, and telemetry for admission, queue wait, callbacks and socket writes, excluding payloads and credentials from emitted metadata.
  • Public API documentation and types, a local TLS quickstart, and MIT licensing.

Requirements

  • Elixir 1.18 or later and Erlang/OTP 27 or later.
  • The :telemetry package. JSON uses OTP's built-in :json module, including for control messages when the application codec is ETF.

Before publishing 0.1.0, replace “Unreleased” with its release date and tag the verified release commit as v0.1.0, matching the package version and HexDocs source reference.