@statewalker/webrun-msgpack 0.1.1 → 0.3.0

package/src/port-codec.ts

@@ -0,0 +1,66 @@
+import type { PortCodec, PortEnvelope } from "@statewalker/webrun-rpc";
+import { deserialize, serialize } from "./msgpack-core.js";
+
+/**
+ * Same shape check as `structuredCodec`'s, applied after decoding. A shared
+ * transport carries traffic that is not ours, and layer 1 must not mistake it
+ * for an envelope.
+ */
+function isEnvelope(value: unknown): value is PortEnvelope {
+  if (typeof value !== "object" || value === null) return false;
+  const candidate = value as { type?: unknown; id?: unknown };
+  if (typeof candidate.id !== "number") return false;
+  if (!Number.isInteger(candidate.id) || candidate.id < 0) return false;
+  return candidate.type === "open" || candidate.type === "message" || candidate.type === "close";
+}
+
+/** Accept whatever byte shape a transport pump hands over. */
+function toBytes(data: unknown): Uint8Array | undefined {
+  if (data instanceof Uint8Array) return data;
+  if (data instanceof ArrayBuffer) return new Uint8Array(data);
+  if (ArrayBuffer.isView(data)) {
+    const view = data as ArrayBufferView;
+    return new Uint8Array(view.buffer, view.byteOffset, view.byteLength);
+  }
+  return undefined;
+}
+
+/**
+ * For ports whose messages are bytes — a WebSocket, a WebRTC data channel, a
+ * LiveKit data packet.
+ *
+ * One envelope becomes one msgpack frame and one `postMessage`. There is no
+ * length prefix, because every transport this codec targets preserves message
+ * boundaries; adding one would be redundant framing on a transport that
+ * already frames. (`encodeMsgpack`/`decodeMsgpack` in this package *do* carry
+ * a length prefix — they are a stream codec for a transport with no
+ * boundaries, and are a different thing.)
+ *
+ * The transfer list is deliberately ignored: after encoding, the payload is
+ * inside the bytes, so there is nothing left to hand over.
+ *
+ * **Not interchangeable with `structuredCodec` in one respect:** msgpack drops
+ * object keys whose value is `undefined`, where structured clone preserves
+ * them. Nothing layer 2 sends depends on that distinction today, and it must
+ * not come to — see spec D16.
+ */
+export const msgpackCodec: PortCodec = {
+  post(port, envelope) {
+    port.postMessage(serialize(envelope));
+  },
+
+  read(event) {
+    const bytes = toBytes(event.data);
+    if (!bytes || bytes.byteLength === 0) return undefined;
+    let decoded: unknown;
+    try {
+      decoded = deserialize(bytes);
+    } catch {
+      // A malformed frame is a peer bug or hostile traffic. Dropping it keeps
+      // layer 1's drop-never-queue posture; throwing here would escape into
+      // the raw port's own listener, outside any consumer's reach.
+      return undefined;
+    }
+    return isEnvelope(decoded) ? decoded : undefined;
+  },
+};

package/dist/index.d.mts

@@ -1,23 +0,0 @@
-//#region src/msgpack.d.ts
-/**
- * Encode each value as a length-prefixed msgpack frame.
- * Frame format: [4-byte big-endian length][msgpack bytes]
- */
-declare function encodeMsgpack<T>(input: AsyncIterable<T>): AsyncGenerator<Uint8Array>;
-/**
- * Decode length-prefixed msgpack frames, reassembling across chunk boundaries.
- */
-declare function decodeMsgpack<T>(input: AsyncIterable<Uint8Array>): AsyncGenerator<T>;
-/**
- * Encode each Float32Array as a msgpack frame.
- * The Float32Array is converted to a Uint8Array view (zero-copy) before encoding as msgpack bin.
- */
-declare function encodeFloat32Arrays(input: AsyncIterable<Float32Array>): AsyncGenerator<Uint8Array>;
-/**
- * Decode msgpack frames back to Float32Array.
- * Each frame contains a msgpack bin value (Uint8Array), reinterpreted as Float32Array.
- */
-declare function decodeFloat32Arrays(input: AsyncIterable<Uint8Array>): AsyncGenerator<Float32Array>;
-//#endregion
-export { decodeFloat32Arrays, decodeMsgpack, encodeFloat32Arrays, encodeMsgpack };
-//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/msgpack.ts"],"mappings":";;;;;iBAQuB,cAAc,GAAG,OAAO,cAAc,KAAK,eAAe;;;;iBAc1D,cAAc,GAAG,OAAO,cAAc,cAAc,eAAe;;;;;iBAsBnE,oBACrB,OAAO,cAAc,gBACpB,eAAe;;;;;iBAgBK,oBACrB,OAAO,cAAc,cACpB,eAAe"}

package/dist/index.mjs

@@ -1,76 +0,0 @@
-import msgpack from "@ygoe/msgpack";
-//#region src/msgpack.ts
-const { serialize, deserialize } = msgpack;
-/**
-* Encode each value as a length-prefixed msgpack frame.
-* Frame format: [4-byte big-endian length][msgpack bytes]
-*/
-async function* encodeMsgpack(input) {
-	for await (const item of input) {
-		const payload = serialize(item);
-		const frame = new Uint8Array(4 + payload.length);
-		new DataView(frame.buffer).setUint32(0, payload.length, false);
-		frame.set(payload, 4);
-		yield frame;
-	}
-}
-/**
-* Decode length-prefixed msgpack frames, reassembling across chunk boundaries.
-*/
-async function* decodeMsgpack(input) {
-	let buffer = /* @__PURE__ */ new Uint8Array(0);
-	for await (const chunk of input) {
-		buffer = concat(buffer, chunk);
-		while (buffer.length >= 4) {
-			const frameLen = new DataView(buffer.buffer, buffer.byteOffset, buffer.byteLength).getUint32(0, false);
-			if (buffer.length < 4 + frameLen) break;
-			const payload = buffer.subarray(4, 4 + frameLen);
-			buffer = buffer.subarray(4 + frameLen);
-			yield deserialize(Uint8Array.from(payload));
-		}
-	}
-}
-/**
-* Encode each Float32Array as a msgpack frame.
-* The Float32Array is converted to a Uint8Array view (zero-copy) before encoding as msgpack bin.
-*/
-async function* encodeFloat32Arrays(input) {
-	for await (const arr of input) {
-		const bytes = new Uint8Array(arr.buffer, arr.byteOffset, arr.byteLength);
-		const payload = serialize(bytes);
-		const frame = new Uint8Array(4 + payload.length);
-		new DataView(frame.buffer).setUint32(0, payload.length, false);
-		frame.set(payload, 4);
-		yield frame;
-	}
-}
-/**
-* Decode msgpack frames back to Float32Array.
-* Each frame contains a msgpack bin value (Uint8Array), reinterpreted as Float32Array.
-*/
-async function* decodeFloat32Arrays(input) {
-	for await (const item of decodeMsgpack(wrapIterable(input))) {
-		const aligned = alignBuffer(item);
-		yield new Float32Array(aligned.buffer, aligned.byteOffset, aligned.byteLength / 4);
-	}
-}
-function alignBuffer(bytes) {
-	if (bytes.byteOffset % 4 === 0) return bytes;
-	const aligned = new Uint8Array(bytes.length);
-	aligned.set(bytes);
-	return aligned;
-}
-function concat(a, b) {
-	if (a.length === 0) return b;
-	const result = new Uint8Array(a.length + b.length);
-	result.set(a, 0);
-	result.set(b, a.length);
-	return result;
-}
-async function* wrapIterable(input) {
-	yield* input;
-}
-//#endregion
-export { decodeFloat32Arrays, decodeMsgpack, encodeFloat32Arrays, encodeMsgpack };
-
-//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../src/msgpack.ts"],"sourcesContent":["import msgpack from \"@ygoe/msgpack\";\n\nconst { serialize, deserialize } = msgpack;\n\n/**\n * Encode each value as a length-prefixed msgpack frame.\n * Frame format: [4-byte big-endian length][msgpack bytes]\n */\nexport async function* encodeMsgpack<T>(input: AsyncIterable<T>): AsyncGenerator<Uint8Array> {\n  for await (const item of input) {\n    const payload = serialize(item);\n    const frame = new Uint8Array(4 + payload.length);\n    const view = new DataView(frame.buffer);\n    view.setUint32(0, payload.length, false);\n    frame.set(payload, 4);\n    yield frame;\n  }\n}\n\n/**\n * Decode length-prefixed msgpack frames, reassembling across chunk boundaries.\n */\nexport async function* decodeMsgpack<T>(input: AsyncIterable<Uint8Array>): AsyncGenerator<T> {\n  let buffer: Uint8Array = new Uint8Array(0);\n\n  for await (const chunk of input) {\n    buffer = concat(buffer, chunk);\n\n    while (buffer.length >= 4) {\n      const view = new DataView(buffer.buffer, buffer.byteOffset, buffer.byteLength);\n      const frameLen = view.getUint32(0, false);\n      if (buffer.length < 4 + frameLen) break;\n\n      const payload = buffer.subarray(4, 4 + frameLen);\n      buffer = buffer.subarray(4 + frameLen);\n      yield deserialize(Uint8Array.from(payload)) as T;\n    }\n  }\n}\n\n/**\n * Encode each Float32Array as a msgpack frame.\n * The Float32Array is converted to a Uint8Array view (zero-copy) before encoding as msgpack bin.\n */\nexport async function* encodeFloat32Arrays(\n  input: AsyncIterable<Float32Array>,\n): AsyncGenerator<Uint8Array> {\n  for await (const arr of input) {\n    const bytes = new Uint8Array(arr.buffer, arr.byteOffset, arr.byteLength);\n    const payload = serialize(bytes);\n    const frame = new Uint8Array(4 + payload.length);\n    const view = new DataView(frame.buffer);\n    view.setUint32(0, payload.length, false);\n    frame.set(payload, 4);\n    yield frame;\n  }\n}\n\n/**\n * Decode msgpack frames back to Float32Array.\n * Each frame contains a msgpack bin value (Uint8Array), reinterpreted as Float32Array.\n */\nexport async function* decodeFloat32Arrays(\n  input: AsyncIterable<Uint8Array>,\n): AsyncGenerator<Float32Array> {\n  for await (const item of decodeMsgpack<Uint8Array>(wrapIterable(input))) {\n    const aligned = alignBuffer(item);\n    yield new Float32Array(aligned.buffer, aligned.byteOffset, aligned.byteLength / 4);\n  }\n}\n\nfunction alignBuffer(bytes: Uint8Array): Uint8Array {\n  if (bytes.byteOffset % 4 === 0) return bytes;\n  const aligned = new Uint8Array(bytes.length);\n  aligned.set(bytes);\n  return aligned;\n}\n\nfunction concat(a: Uint8Array, b: Uint8Array): Uint8Array {\n  if (a.length === 0) return b;\n  const result = new Uint8Array(a.length + b.length);\n  result.set(a, 0);\n  result.set(b, a.length);\n  return result;\n}\n\nasync function* wrapIterable<T>(input: AsyncIterable<T>): AsyncGenerator<T> {\n  yield* input;\n}\n"],"mappings":";;AAEA,MAAM,EAAE,WAAW,gBAAgB;;;;;AAMnC,gBAAuB,cAAiB,OAAqD;CAC3F,WAAW,MAAM,QAAQ,OAAO;EAC9B,MAAM,UAAU,UAAU,IAAI;EAC9B,MAAM,QAAQ,IAAI,WAAW,IAAI,QAAQ,MAAM;EAE/C,IADiB,SAAS,MAAM,MAC7B,CAAC,CAAC,UAAU,GAAG,QAAQ,QAAQ,KAAK;EACvC,MAAM,IAAI,SAAS,CAAC;EACpB,MAAM;CACR;AACF;;;;AAKA,gBAAuB,cAAiB,OAAqD;CAC3F,IAAI,yBAAqB,IAAI,WAAW,CAAC;CAEzC,WAAW,MAAM,SAAS,OAAO;EAC/B,SAAS,OAAO,QAAQ,KAAK;EAE7B,OAAO,OAAO,UAAU,GAAG;GAEzB,MAAM,WAAW,IADA,SAAS,OAAO,QAAQ,OAAO,YAAY,OAAO,UAC/C,CAAC,CAAC,UAAU,GAAG,KAAK;GACxC,IAAI,OAAO,SAAS,IAAI,UAAU;GAElC,MAAM,UAAU,OAAO,SAAS,GAAG,IAAI,QAAQ;GAC/C,SAAS,OAAO,SAAS,IAAI,QAAQ;GACrC,MAAM,YAAY,WAAW,KAAK,OAAO,CAAC;EAC5C;CACF;AACF;;;;;AAMA,gBAAuB,oBACrB,OAC4B;CAC5B,WAAW,MAAM,OAAO,OAAO;EAC7B,MAAM,QAAQ,IAAI,WAAW,IAAI,QAAQ,IAAI,YAAY,IAAI,UAAU;EACvE,MAAM,UAAU,UAAU,KAAK;EAC/B,MAAM,QAAQ,IAAI,WAAW,IAAI,QAAQ,MAAM;EAE/C,IADiB,SAAS,MAAM,MAC7B,CAAC,CAAC,UAAU,GAAG,QAAQ,QAAQ,KAAK;EACvC,MAAM,IAAI,SAAS,CAAC;EACpB,MAAM;CACR;AACF;;;;;AAMA,gBAAuB,oBACrB,OAC8B;CAC9B,WAAW,MAAM,QAAQ,cAA0B,aAAa,KAAK,CAAC,GAAG;EACvE,MAAM,UAAU,YAAY,IAAI;EAChC,MAAM,IAAI,aAAa,QAAQ,QAAQ,QAAQ,YAAY,QAAQ,aAAa,CAAC;CACnF;AACF;AAEA,SAAS,YAAY,OAA+B;CAClD,IAAI,MAAM,aAAa,MAAM,GAAG,OAAO;CACvC,MAAM,UAAU,IAAI,WAAW,MAAM,MAAM;CAC3C,QAAQ,IAAI,KAAK;CACjB,OAAO;AACT;AAEA,SAAS,OAAO,GAAe,GAA2B;CACxD,IAAI,EAAE,WAAW,GAAG,OAAO;CAC3B,MAAM,SAAS,IAAI,WAAW,EAAE,SAAS,EAAE,MAAM;CACjD,OAAO,IAAI,GAAG,CAAC;CACf,OAAO,IAAI,GAAG,EAAE,MAAM;CACtB,OAAO;AACT;AAEA,gBAAgB,aAAgB,OAA4C;CAC1E,OAAO;AACT"}