@zlink-systems/zlink 0.17.3

package/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -0,0 +1,198 @@
+# Node Bindings
+
+Aligned Node bindings for `libzlink`.
+
+## Canonical Raw API
+
+- `new PairSocket(ctx)`, `new DealerSocket(ctx)`, `new RouterSocket(ctx)`,
+  `new StreamSocket(ctx)`
+- `new PubSocket(ctx)`, `new XPubSocket(ctx)`
+- `new SubSocket(ctx)`, `new XSubSocket(ctx)`
+- `Context.options: ContextOptions`, `Context.shutdown()`, `Context.close()`
+- connection lifecycle: `bind(endpoint)`, `unbind(endpoint)`
+- connectable sockets: `connect(endpoint)`, `disconnect(endpoint)`
+- discovery attachment: `attachDiscovery(discovery)` on `DealerSocket`,
+  `RouterSocket`, `PubSocket`, `SubSocket`
+- publisher sockets: `publish(topic).message(...).submit()` (synchronous
+  void-or-throw)
+- message sockets: async `send().message(...).submit()` (event-loop-managed
+  backpressure retry Promise) and blocking `submit_sync()`,
+  `recv(flags?)`
+- routed sockets: async `send(routingId).message(...).submit()`
+  (event-loop-managed backpressure retry Promise) and blocking
+  `submit_sync()`, `recv(flags?)`
+- requests: async `request(...).message(...).submit()` returns
+  `Promise<Message[]>`; `submit_sync()` returns `Message[]`. The sync terminal
+  can block the Node event loop, so use it only when another execution context
+  can make reply progress.
+- subscriber sockets: `setSubscription(topicOrPattern)`,
+  `unsetSubscription(topicOrPattern)`, `subscribe(topicMessage, flags?)`
+- `XPubSocket`: `receiveSubscriptionEvent(subscriptionEvent, flags?)`
+- `StreamSocket`: `setRoutingId()`, `getRoutingId()`, managed backpressure-retry
+  `send(routingId)`, `recv(received, flags?)`, and reusable
+  `recvPacket(streamPacket, flags?)`; set `options.recvMode` to
+  `StreamRecvMode.Raw` or `StreamRecvMode.Packet` before bind/connect
+- TLS helpers: `setTlsServer(cert, key, requireClient?)`,
+  `setTlsClient(ca, host, trust?)` on sockets, `Registry`, and `SpotNode`
+- canonical option facades:
+  - `CommonSocketOptions`
+  - `DealerSocketOptions`
+  - `RouterSocketOptions`
+  - `StreamSocketOptions`
+  - `PubSocketOptions`
+  - `SubSocketOptions`
+- context option facade: `ContextOptions`
+- socket option access: `socket.options.*`
+- monitors: `monitorOpen(events?, monitorHwmBytes?)` with default `ALL` events
+  and the Core-default queue HWM; register the monitor with `Poller.add(...,
+  [PollEventFlag.PollIn], slot)` and drain ready events with `recv(DontWait)`
+
+`Context.options` should be configured immediately after constructing the
+context and before creating sockets.
+
+`Message.from(...)` is the canonical from-source factory. `Message.data` and
+`Message.size` expose the canonical payload view. `Message.close()`,
+`Symbol.dispose`, and `Symbol.asyncDispose` are the cleanup hooks.
+`Message.getProperty(name)` and `Message.refCount()` expose diagnostic
+metadata on canonical receive results.
+Canonical raw sockets intentionally hide opposite-direction methods, so
+`PubSocket` does not expose `send()` or `recv()`, `SubSocket` does not expose
+`send()`, and `StreamSocket` does not expose `connect()` or active stream
+helpers on the canonical path.
+
+Canonical receive results are domain objects:
+
+- `Received`: `{ routingId: RoutingId | null, replyToken: ReplyToken | null,
+  parts: Message[] }`, with
+  `send(...)` for sending a normal routed message back over the original
+  receive context and `reply(...)` for request-reply messages
+- `Subscribed`: `{ routingId: Buffer | null, topic: string, parts: Message[] }`
+- `SubscriptionEvent`:
+  `{ routingId: Buffer | null, topic: string, subscribed: boolean }`
+- completion kind ABI values: runtime records use `CompletionKind.Request` and
+  `CompletionKind.Writable`; `CompletionKind.Send` is an ABI-only value
+
+- generic `Socket` / `BaseSocket` are not exported from the aligned public API
+- legacy flags-based send/recv, raw stream attach/detach helpers, and raw
+  socket option bags are not part of the public package surface
+
+Not part of the canonical stream API contract:
+length-prefixed stream framing such as `len32be` is only a sample helper and
+is not exposed as a public `StreamSocket` method.
+
+## Pull Completion
+
+An ordinary successful send has completion ID `0` and produces no SEND
+completion. The async `send(...).submit()` helper first makes a DONTWAIT
+admission attempt. If Core reports `SubmitResult.Backpressured` with `EAGAIN`,
+Core retains only the nonzero wait token, user context, and target; the binding
+retains the submit-time packet snapshot. Later caller-side buffer mutation does
+not change a pending retry. A `Message` input is consumed immediately after the
+binding takes that snapshot, so the retry does not keep the caller's wrapper
+alive until the Promise resolves. When no public poller owns completion
+draining, the runtime watches the socket notification descriptor and pulls the
+socket-local completion queue until no more completion data is available. A
+`CompletionKind.Writable` record must match the token, user context, and target
+routing ID before the runtime submits the same packet again. The Promise
+resolves only after that retry is admitted. This path does not use a worker
+thread, sleep, or timer.
+
+REQUEST uses the same pre-admission WRITABLE-token machine. Core keeps no
+rejected request payload; the binding snapshots it only after backpressure and
+resubmits that request only for its matching token. After admission, the
+nonzero completion ID identifies the reply/timeout terminal
+`CompletionKind.Request`, and the reply timeout starts at admission. A public poller registered
+for `PollEventFlag.PollCompletion` owns completion draining until its
+registration drops that flag, the socket is removed, or the poller is closed.
+The application must keep calling `poller.wait(...)` until its pending SEND and
+REQUEST Promises settle. The raw Core ABI-only options
+`ZLINK_OPT_PENDING_MAX_MSGS` and `ZLINK_OPT_PENDING_MAX_BYTES` retain their ABI
+values and storage but are ignored. The typed Node socket options do not expose
+them.
+Monitor, timer, and STREAM packet delivery also use caller-driven pull APIs.
+
+## Service Surface
+
+- `new Discovery(ctx, serviceType, serviceName)`
+- `new Registry(ctx)` + `registry.bind(pubEndpoint, routerEndpoint)`
+- `new RegistryQueryClient(ctx)`
+- `new SpotNode(ctx)`
+- `new Spot(node)`
+
+`SpotNode` exposes `createRouteBridge()` for caller-owned channel sockets and
+`createPublisher()` for publishing into the local SPOT topic plane.
+
+`Spot` is service-aware and uses explicit service names on the data plane:
+`publish(serviceName, topic, ...)`, `sendChannel(channelName, ...)`,
+`requestChannel(channelName, ...)`, `setSubscription()` /
+`unsetSubscription()`, `subscribe(topicMessage, flags?)`,
+  `receiveSubscriptionEvent(subscriptionEvent, flags?)`, `recvRouted(received, flags?)`,
+  `recvActorLifecycle(flags?)`, and `onDispatchEvent()`.
+
+`Discovery` uses `connectRegistry()`, `setValue()` / `getValue()`,
+`setMetadata()` / `getMetadata()`, `memberPeers()`,
+`memberPeerMetadata()`, `monitorOpen(events?, monitorHwmBytes?)`, `setTlsClient()`.
+
+`SpotNode` uses `setPubBind()`, `setRouterBind()`,
+`connectPeer()` / `disconnectPeer()`,
+`attachDiscovery()`, `status()`, `peers()`,
+`peers(filter)()`, `subjects(filter?)`, `setTlsServer()`,
+`setTlsClient()`.
+
+`Registry` uses `bind()`, `setId()`, `addPeer()`, `setHeartbeat()`,
+`setBroadcastInterval()`, `setTlsServer()`, `setTlsClient()`,
+`status()`,
+  `serviceSummary(filter?)`, `memberPeers()`,
+  `memberPeerMetadata()`, `topology()`, `topology(filter)(filter?)`.
+
+`RegistryQueryClient` uses `connect()` and `snapshot(filter?)`.
+
+`SocketMonitor` uses `recv(flags?)`, `status()`,
+  `close()`.
+
+`*_READY_CHANGED` monitor events are readiness edge/state notifications.
+Node bindings must not interpret `event.value` as an aggregate ready count, and
+`snapshot()` must not be used as a ready-count gate.
+
+`Receiver` is removed from the aligned public API.
+`Discovery` requires a non-empty `serviceName`.
+`Registry.bind()` maps directly to the native bind lifecycle and replaces legacy
+`setEndpoints()` / `start()`.
+`Registry.setSockOpt()` and `SpotNode.setDiscovery()` are not part of the
+aligned canonical surface. `Spot` also does not expose raw `setSockOpt()`;
+raw socket options are exposed through typed `socket.options` facades instead
+of raw option bags or per-socket setter aliases. `Spot` keeps service-level
+typed setters such as `setLinger()` and `setNoDrop()`.
+After `attachDiscovery()`, manual socket/node connect-disconnect entry points
+are blocked by the native lifecycle contract.
+
+## Verification
+
+```bash
+cd bindings/node && npm run build
+cd bindings/node && npm run rebuild-native
+cd bindings/node && npm test
+cd bindings/node && npm run samples
+cd bindings/node && npm run perf:single -- --recv recv --pattern PAIR --warmup 0.2 --duration 0.5
+cd bindings/node && npm run perf:multi -- --recv recv --pattern STREAM --warmup 0.2 --duration 0.5
+```
+
+## Perf Status
+
+- single perf is implemented for `PAIR`, `PUBSUB`, `DEALER_DEALER`,
+  `DEALER_ROUTER`, `ROUTER_ROUTER`, `SPOT`
+- single perf pull-mode migration is tracked with the Phase 7 benchmark work
+- multi perf is implemented for `MULTI_DEALER_DEALER`, `MULTI_PUBSUB`,
+  `STREAM`
+- multi perf supports:
+  - `MULTI_DEALER_DEALER`: `--recv recv`
+  - `MULTI_PUBSUB`: `--recv recv`
+  - `STREAM`: `--recv recv`
+- perf structure and review criteria are defined by
+  [`bindings/README.md`](/home/hep7/project/kairos/zlink/doc/spec/bindings/README.md)
+  and the shared policy docs under
+  [`doc/perf/`](/home/hep7/project/kairos/zlink/doc/perf)
+- readiness gates in binding perf must use low-cost event counting, not
+  aggregate ready counts from monitor payloads or snapshots
+- raw sockets: `CONNECTION_READY` event counting
+- SPOT: explicit benchmark barrier protocol; no separate service-event gate

package/README.typedoc.md

@@ -0,0 +1,56 @@
+# zlink Node Binding API Reference
+
+This reference is generated from the TypeScript source in `bindings/node/src/`.
+
+## Prerequisites
+
+```bash
+npm install --save-dev typedoc
+```
+
+## Generate
+
+```bash
+cd bindings/node
+npx typedoc
+```
+
+Generated HTML entrypoint:
+
+```text
+bindings/node/typedoc/html/index.html
+```
+
+## Scope
+
+- Public exports from `src/index.ts`
+- Socket types and domain objects
+- Message and result types (`Message`, `Received`, `SubmitError`)
+- Constants and enums (`SocketType`, `PollEventFlag`, `CompletionKind`)
+- Internal symbols marked `@internal` are excluded
+
+## Completion and Backpressure
+
+The binding settles managed SEND and REQUEST Promises by pulling Core
+completion records. Managed send uses `submit()`/`submit_sync()`, request uses
+the matching terminals returning reply parts, and STREAM, socket-monitor, and
+timer input uses caller-driven pull APIs.
+
+Successful SEND admission returns completion ID `0` and publishes no SEND
+completion. For async `submit()`, a DONTWAIT `SubmitResult.Backpressured` result
+with `EAGAIN` contains a nonzero wait token while Core retains no payload. The
+Node runtime keeps the submit-time packet snapshot. When no public poller owns
+completion draining, it watches the socket notification descriptor and pulls
+the completion queue. A
+`CompletionKind.Writable` record must match the token, user context, and target
+routing ID before the runtime resubmits that packet. Caller mutation after
+`submit()` does not alter the retry. A `Message` input is consumed as soon as
+the binding takes the back-pressure snapshot; the retry does not retain that
+wrapper until the Promise resolves. REQUEST uses the same WRITABLE-token retry
+before admission, then settles through its matching `CompletionKind.Request`
+reply or timeout. A public poller registered for
+`PollEventFlag.PollCompletion` owns completion draining until its registration
+drops that flag, the socket is removed, or the poller is closed. The application
+must keep calling `poller.wait(...)` until its pending SEND and REQUEST Promises
+settle. The raw Core ABI-only `ZLINK_OPT_PENDING_MAX_*` values and storage are
+retained but ignored. The typed Node socket options do not expose them.