@dojo-ng/websocket 0.1.0 → 0.1.1

package/README.md

@@ -2,9 +2,8 @@
 
 A framework-agnostic WebSocket client: a raw-socket wrapper (`WSocket`) and a convenience
 dispatcher on top of it (`WSDispatcher`) with request/response correlation, an offline send
-queue, reconnect with backoff, and a heartbeat watchdog. Ported from app3's `core/socket`,
-de-Holmesed — see `websocket-spec.md` in the project root for the full task-by-task history and
-the reasoning behind every non-obvious decision below.
+queue, reconnect with backoff, and a heartbeat watchdog. The reasoning behind each non-obvious
+behavior below is in the header comments of `src/wsocket.ts` and `src/wsdispatcher.ts`.
 
 Part of the [Dojo NG framework](../../README.md) monorepo (the non-Lit runtime that complements
 `components`). BSD-3-Clause.
@@ -75,11 +74,11 @@ affordance; the playground (below) uses it.
 
 `schema/envelope.schema.json` (JSON Schema draft-07) specifies the `{action, id, data}` frame
 `WSDispatcher` sends and receives, independently of the TypeScript `Envelope` type that binds it
-— the schema is the source of truth, the type is one binding of it. Chosen over app3's original
-positional-array form by measurement, not argument: compressed (raw DEFLATE, context carried
-across a session — the realistic case), the object form is only 3.4% larger than positional over
-a representative session. See `websocket-spec.md` T5's dated note for the full byte counts and
-methodology.
+— the schema is the source of truth, the type is one binding of it. The object form was chosen
+over a positional-array form (`[action, id, data]`) by measurement, not argument: compressed (raw
+DEFLATE, context carried across a session — the realistic case), the object form is only 3.4%
+larger than positional over a representative session. `spike/measure-envelope.mjs` reproduces
+the measurement.
 
 ## Playground
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dojo-ng/websocket",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Dojo NG websocket client",
   "type": "module",
   "main": "./dist/index.js",
@@ -12,7 +12,7 @@
   ],
   "license": "BSD-3-Clause",
   "dependencies": {
-    "@dojo-ng/pubsub": "^0.1.0"
+    "@dojo-ng/pubsub": "^0.1.1"
   },
   "devDependencies": {
     "ajv": "^8.20.0",

package/schema/envelope.schema.json

@@ -2,7 +2,7 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "$id": "https://dojo-ng.dev/schemas/websocket-envelope.schema.json",
   "title": "Dojo NG WebSocket envelope",
-  "description": "The wire frame WSDispatcher (websocket-spec.md T4) sends and receives, specified independently of the TypeScript types that bind it (src/wsdispatcher.ts's Envelope interface is one binding of this, not the source of truth). Documented as a T4-local working assumption pending T5's own measurement — see the dated note in websocket-spec.md T5 for the byte-count comparison against a positional-array alternative and why this object shape was kept. Every field is always present; there is no undefined-vs-missing distinction on the wire, only JSON-representable values, so this survives JSON.stringify/json.loads round-trips without losing meaning.",
+  "description": "The wire frame WSDispatcher sends and receives, specified independently of the TypeScript types that bind it (src/wsdispatcher.ts's Envelope interface is one binding of this, not the source of truth). The object shape was chosen over a positional array by measuring compressed bytes on the wire; spike/measure-envelope.mjs reproduces the measurement. Every field is always present; there is no undefined-vs-missing distinction on the wire, only JSON-representable values, so this survives JSON.stringify/json.loads round-trips without losing meaning.",
   "type": "object",
   "additionalProperties": false,
   "required": ["action", "id", "data"],