@moqtap/codec 0.8.0 → 0.9.0

package/dist/{chunk-IEJULBKB.cjs → chunk-UA5XFP4O.cjs}

@@ -987,112 +987,135 @@ function decodeTrackExtensions(reader) {
   return result;
 }
 function encodeParams(params, writer) {
-  let count = params.unknown ? params.unknown.length : 0;
-  if (params.delivery_timeout !== void 0) count++;
-  if (params.authorization_token !== void 0) count++;
-  if (params.max_cache_duration !== void 0) count++;
-  if (params.expires !== void 0) count++;
-  if (params.largest_object !== void 0) count++;
-  if (params.publisher_priority !== void 0) count++;
-  if (params.forward !== void 0) count++;
-  if (params.subscriber_priority !== void 0) count++;
-  if (params.subscription_filter !== void 0) count++;
-  if (params.group_order !== void 0) count++;
-  if (params.dynamic_groups !== void 0) count++;
-  if (params.new_group_request !== void 0) count++;
-  writer.writeVarInt(count);
+  const entries = [];
   if (params.delivery_timeout !== void 0) {
-    writer.writeVarInt(PARAM_DELIVERY_TIMEOUT);
-    writer.writeVarInt(params.delivery_timeout);
+    entries.push({
+      type: PARAM_DELIVERY_TIMEOUT,
+      encode: (w) => w.writeVarInt(params.delivery_timeout)
+    });
   }
   if (params.authorization_token !== void 0) {
-    writer.writeVarInt(PARAM_AUTHORIZATION_TOKEN);
-    const tmpW = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(64);
-    encodeAuthorizationToken(params.authorization_token, tmpW);
-    const raw = tmpW.finish();
-    writer.writeVarInt(raw.byteLength);
-    writer.writeBytes(raw);
+    entries.push({
+      type: PARAM_AUTHORIZATION_TOKEN,
+      encode: (w) => {
+        const tmpW = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(64);
+        encodeAuthorizationToken(params.authorization_token, tmpW);
+        const raw = tmpW.finish();
+        w.writeVarInt(raw.byteLength);
+        w.writeBytes(raw);
+      }
+    });
   }
   if (params.max_cache_duration !== void 0) {
-    writer.writeVarInt(PARAM_MAX_CACHE_DURATION);
-    writer.writeVarInt(params.max_cache_duration);
+    entries.push({
+      type: PARAM_MAX_CACHE_DURATION,
+      encode: (w) => w.writeVarInt(params.max_cache_duration)
+    });
   }
   if (params.expires !== void 0) {
-    writer.writeVarInt(PARAM_EXPIRES);
-    writer.writeVarInt(params.expires);
+    entries.push({ type: PARAM_EXPIRES, encode: (w) => w.writeVarInt(params.expires) });
   }
   if (params.largest_object !== void 0) {
-    writer.writeVarInt(PARAM_LARGEST_OBJECT);
-    const tmpW = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(16);
-    tmpW.writeVarInt(params.largest_object.group);
-    tmpW.writeVarInt(params.largest_object.object);
-    const raw = tmpW.finish();
-    writer.writeVarInt(raw.byteLength);
-    writer.writeBytes(raw);
+    entries.push({
+      type: PARAM_LARGEST_OBJECT,
+      // Draft-16 has no per-parameter value encoding: a Key-Value-Pair whose
+      // Type is odd carries a Length, and 0x09 is odd. Drafts 17 and later
+      // replaced that with "the encoding is specified by each parameter
+      // definition", which is where the same field loses its length.
+      encode: (w) => {
+        const tmpW = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(16);
+        tmpW.writeVarInt(params.largest_object.group);
+        tmpW.writeVarInt(params.largest_object.object);
+        const raw = tmpW.finish();
+        w.writeVarInt(raw.byteLength);
+        w.writeBytes(raw);
+      }
+    });
   }
   if (params.publisher_priority !== void 0) {
-    writer.writeVarInt(PARAM_PUBLISHER_PRIORITY);
-    writer.writeVarInt(params.publisher_priority);
+    entries.push({
+      type: PARAM_PUBLISHER_PRIORITY,
+      encode: (w) => w.writeVarInt(params.publisher_priority)
+    });
   }
   if (params.forward !== void 0) {
-    writer.writeVarInt(PARAM_FORWARD);
-    writer.writeVarInt(params.forward);
+    entries.push({ type: PARAM_FORWARD, encode: (w) => w.writeVarInt(params.forward) });
   }
   if (params.subscriber_priority !== void 0) {
-    writer.writeVarInt(PARAM_SUBSCRIBER_PRIORITY);
-    writer.writeVarInt(params.subscriber_priority);
+    entries.push({
+      type: PARAM_SUBSCRIBER_PRIORITY,
+      encode: (w) => w.writeVarInt(params.subscriber_priority)
+    });
   }
   if (params.subscription_filter !== void 0) {
-    writer.writeVarInt(PARAM_SUBSCRIPTION_FILTER);
-    const tmpW = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(32);
-    const f = params.subscription_filter;
-    tmpW.writeVarInt(f.filter_type);
-    if (f.filter_type === 3n || f.filter_type === 4n) {
-      tmpW.writeVarInt(f.start_group);
-      tmpW.writeVarInt(f.start_object);
-    }
-    if (f.filter_type === 4n) {
-      tmpW.writeVarInt(f.end_group);
-    }
-    const raw = tmpW.finish();
-    writer.writeVarInt(raw.byteLength);
-    writer.writeBytes(raw);
+    entries.push({
+      type: PARAM_SUBSCRIPTION_FILTER,
+      encode: (w) => {
+        const tmpW = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(32);
+        const f = params.subscription_filter;
+        tmpW.writeVarInt(f.filter_type);
+        if (f.filter_type === 3n || f.filter_type === 4n) {
+          tmpW.writeVarInt(f.start_group);
+          tmpW.writeVarInt(f.start_object);
+        }
+        if (f.filter_type === 4n) {
+          tmpW.writeVarInt(f.end_group);
+        }
+        const raw = tmpW.finish();
+        w.writeVarInt(raw.byteLength);
+        w.writeBytes(raw);
+      }
+    });
   }
   if (params.group_order !== void 0) {
-    writer.writeVarInt(PARAM_GROUP_ORDER);
-    writer.writeVarInt(params.group_order);
+    entries.push({ type: PARAM_GROUP_ORDER, encode: (w) => w.writeVarInt(params.group_order) });
   }
   if (params.dynamic_groups !== void 0) {
-    writer.writeVarInt(PARAM_DYNAMIC_GROUPS);
-    writer.writeVarInt(params.dynamic_groups);
+    entries.push({
+      type: PARAM_DYNAMIC_GROUPS,
+      encode: (w) => w.writeVarInt(params.dynamic_groups)
+    });
   }
   if (params.new_group_request !== void 0) {
-    writer.writeVarInt(PARAM_NEW_GROUP_REQUEST);
-    writer.writeVarInt(params.new_group_request);
+    entries.push({
+      type: PARAM_NEW_GROUP_REQUEST,
+      encode: (w) => w.writeVarInt(params.new_group_request)
+    });
   }
   if (params.unknown) {
     for (const u of params.unknown) {
       const id = BigInt(u.id);
-      writer.writeVarInt(id);
-      if (id % 2n === 0n) {
-        const raw = _chunk4XLYCT5Qcjs.hexToBytes.call(void 0, u.raw_hex);
-        const tmpReader = new (0, _chunk4XLYCT5Qcjs.BufferReader)(raw);
-        const value = tmpReader.readVarInt();
-        writer.writeVarInt(value);
-      } else {
-        const raw = _chunk4XLYCT5Qcjs.hexToBytes.call(void 0, u.raw_hex);
-        writer.writeVarInt(raw.byteLength);
-        writer.writeBytes(raw);
-      }
+      entries.push({
+        type: id,
+        encode: (w) => {
+          const raw = _chunk4XLYCT5Qcjs.hexToBytes.call(void 0, u.raw_hex);
+          if (id % 2n === 0n) {
+            w.writeVarInt(new (0, _chunk4XLYCT5Qcjs.BufferReader)(raw).readVarInt());
+          } else {
+            w.writeVarInt(raw.byteLength);
+            w.writeBytes(raw);
+          }
+        }
+      });
     }
   }
+  entries.sort((a, b) => a.type < b.type ? -1 : a.type > b.type ? 1 : 0);
+  writer.writeVarInt(entries.length);
+  let prevType = 0n;
+  for (const entry of entries) {
+    writer.writeVarInt(entry.type - prevType);
+    entry.encode(writer);
+    prevType = entry.type;
+  }
 }
 function decodeParams(reader) {
   const count = Number(reader.readVarInt());
   const result = {};
-  const unknown = [];
+  let prevType = 0n;
   for (let i = 0; i < count; i++) {
-    const paramType = reader.readVarInt();
+    const delta = reader.readVarInt();
+    const paramType = prevType + delta;
+    prevType = paramType;
     if (paramType === PARAM_DELIVERY_TIMEOUT) {
       result.delivery_timeout = reader.readVarInt();
     } else if (paramType === PARAM_AUTHORIZATION_TOKEN) {
@@ -1138,29 +1161,14 @@ function decodeParams(reader) {
       const consumed = reader.offset - startOff;
       if (consumed < length) reader.readBytes(length - consumed);
       result.subscription_filter = filter;
-    } else if (paramType % 2n === 0n) {
-      const value = reader.readVarInt();
-      const tmpWriter = new (0, _chunk4XLYCT5Qcjs.BufferWriter)(16);
-      tmpWriter.writeVarInt(value);
-      const raw = tmpWriter.finish();
-      unknown.push({
-        id: `0x${paramType.toString(16)}`,
-        length: raw.byteLength,
-        raw_hex: _chunk4XLYCT5Qcjs.bytesToHex.call(void 0, raw)
-      });
     } else {
-      const length = Number(reader.readVarInt());
-      const bytes = reader.readBytes(length);
-      unknown.push({
-        id: `0x${paramType.toString(16)}`,
-        length,
-        raw_hex: _chunk4XLYCT5Qcjs.bytesToHex.call(void 0, bytes)
-      });
+      throw new (0, _chunk4XLYCT5Qcjs.DecodeError)(
+        "INVALID_PARAMETER",
+        `Unknown Message Parameter type 0x${paramType.toString(16)}`,
+        reader.offset
+      );
     }
   }
-  if (unknown.length > 0) {
-    result.unknown = unknown;
-  }
   return result;
 }
 function encodeClientSetupPayload(msg, w) {

package/dist/{chunk-KTVN4P6J.cjs → chunk-UZO5Z2XT.cjs}

@@ -1103,6 +1103,33 @@ var PARAM_SUBSCRIPTION_FILTER = 0x21n;
 var PARAM_GROUP_ORDER = 0x22n;
 var PARAM_NEW_GROUP_REQUEST = 0x32n;
 var PARAM_TRACK_NAMESPACE_PREFIX = 0x34n;
+var PARAMETER_SCOPE = /* @__PURE__ */ new Map([
+  [0x02n, /* @__PURE__ */ new Set(["request_ok", "subscribe", "request_update"])],
+  [
+    0x03n,
+    /* @__PURE__ */ new Set([
+      "publish",
+      "subscribe",
+      "request_update",
+      "subscribe_namespace",
+      "subscribe_tracks",
+      "publish_namespace",
+      "track_status",
+      "fetch"
+    ])
+  ],
+  [0x04n, /* @__PURE__ */ new Set(["subscribe"])],
+  [0x06n, /* @__PURE__ */ new Set(["request_ok", "subscribe", "request_update"])],
+  [0x08n, /* @__PURE__ */ new Set(["subscribe_ok", "publish", "request_ok"])],
+  [0x09n, /* @__PURE__ */ new Set(["subscribe_ok", "publish", "request_ok"])],
+  [0x0an, /* @__PURE__ */ new Set(["fetch"])],
+  [0x10n, /* @__PURE__ */ new Set(["subscribe", "request_update", "publish", "request_ok", "subscribe_tracks"])],
+  [0x20n, /* @__PURE__ */ new Set(["subscribe", "fetch", "request_update", "request_ok"])],
+  [0x21n, /* @__PURE__ */ new Set(["subscribe", "request_ok", "request_update"])],
+  [0x22n, /* @__PURE__ */ new Set(["subscribe", "request_ok", "fetch"])],
+  [0x32n, /* @__PURE__ */ new Set(["request_ok", "subscribe", "request_update"])],
+  [0x34n, /* @__PURE__ */ new Set(["request_update"])]
+]);
 function encodeParams(params, writer) {
   const entries = [];
   if (params.object_delivery_timeout !== void 0) {
@@ -1144,13 +1171,12 @@ function encodeParams(params, writer) {
   if (params.largest_object !== void 0) {
     entries.push({
       type: PARAM_LARGEST_OBJECT,
+      // A Location is "Two consecutive varints (Group, Object)", which is a
+      // different value encoding from "Length-prefixed". Nothing states the
+      // length, so nothing writes one.
       encode: (w) => {
-        const tmpW = new (0, _chunk4XLYCT5Qcjs.MoqtBufferWriter)(16);
-        tmpW.writeVarInt(params.largest_object.group);
-        tmpW.writeVarInt(params.largest_object.object);
-        const raw = tmpW.finish();
-        w.writeVarInt(BigInt(raw.byteLength));
-        w.writeBytes(raw);
+        w.writeVarInt(params.largest_object.group);
+        w.writeVarInt(params.largest_object.object);
       }
     });
   }
@@ -1207,12 +1233,11 @@ function encodeParams(params, writer) {
   if (params.track_namespace_prefix !== void 0) {
     entries.push({
       type: PARAM_TRACK_NAMESPACE_PREFIX,
+      // The parameter "uses the Track Namespace encoding", which is a tuple
+      // that states its own field count. That is not the Length-prefixed
+      // encoding, so there is no byte length ahead of it.
       encode: (w) => {
-        const tmpW = new (0, _chunk4XLYCT5Qcjs.MoqtBufferWriter)(32);
-        encodeNamespaceTuple(params.track_namespace_prefix, tmpW);
-        const raw = tmpW.finish();
-        w.writeVarInt(BigInt(raw.byteLength));
-        w.writeBytes(raw);
+        encodeNamespaceTuple(params.track_namespace_prefix, w);
       }
     });
   }
@@ -1237,15 +1262,22 @@ function encodeParams(params, writer) {
     prevType = entry.type;
   }
 }
-function decodeParams(reader) {
+function decodeParams(reader, messageType) {
   const count = Number(reader.readVarInt());
   const result = {};
-  const unknown = [];
   let prevType = 0n;
   for (let i = 0; i < count; i++) {
     const delta = reader.readVarInt();
     const paramType = prevType + delta;
     prevType = paramType;
+    const scope = PARAMETER_SCOPE.get(paramType);
+    if (scope !== void 0 && !scope.has(messageType)) {
+      throw new (0, _chunk4XLYCT5Qcjs.DecodeError)(
+        "CONSTRAINT_VIOLATION",
+        `Message Parameter 0x${paramType.toString(16)} may not appear in ${messageType}`,
+        reader.offset
+      );
+    }
     if (paramType === PARAM_OBJECT_DELIVERY_TIMEOUT) {
       result.object_delivery_timeout = reader.readVarInt();
     } else if (paramType === PARAM_AUTHORIZATION_TOKEN) {
@@ -1259,12 +1291,8 @@ function decodeParams(reader) {
     } else if (paramType === PARAM_EXPIRES) {
       result.expires = reader.readVarInt();
     } else if (paramType === PARAM_LARGEST_OBJECT) {
-      const length = Number(reader.readVarInt());
-      const startOff = reader.offset;
       const group = reader.readVarInt();
       const object = reader.readVarInt();
-      const consumed = reader.offset - startOff;
-      if (consumed < length) reader.readBytes(length - consumed);
       result.largest_object = { group, object };
     } else if (paramType === PARAM_FILL_TIMEOUT) {
       result.fill_timeout = reader.readVarInt();
@@ -1292,32 +1320,15 @@ function decodeParams(reader) {
     } else if (paramType === PARAM_NEW_GROUP_REQUEST) {
       result.new_group_request = reader.readVarInt();
     } else if (paramType === PARAM_TRACK_NAMESPACE_PREFIX) {
-      const length = Number(reader.readVarInt());
-      const bytes = reader.readBytes(length);
-      result.track_namespace_prefix = decodeNamespaceTuple(new (0, _chunk4XLYCT5Qcjs.MoqtBufferReader)(bytes));
+      result.track_namespace_prefix = decodeNamespaceTuple(reader);
     } else {
-      if (paramType % 2n === 0n) {
-        const value = reader.readVarInt();
-        const tmpWriter = new (0, _chunk4XLYCT5Qcjs.MoqtBufferWriter)(16);
-        tmpWriter.writeVarInt(value);
-        const raw = tmpWriter.finish();
-        unknown.push({
-          id: `0x${paramType.toString(16)}`,
-          length: raw.byteLength,
-          raw_hex: _chunk4XLYCT5Qcjs.bytesToHex.call(void 0, raw)
-        });
-      } else {
-        const length = Number(reader.readVarInt());
-        const bytes = reader.readBytes(length);
-        unknown.push({
-          id: `0x${paramType.toString(16)}`,
-          length,
-          raw_hex: _chunk4XLYCT5Qcjs.bytesToHex.call(void 0, bytes)
-        });
-      }
+      throw new (0, _chunk4XLYCT5Qcjs.DecodeError)(
+        "INVALID_PARAMETER",
+        `Unknown Message Parameter type 0x${paramType.toString(16)}`,
+        reader.offset
+      );
     }
   }
-  if (unknown.length > 0) result.unknown = unknown;
   return result;
 }
 var TPROP_OBJECT_DELIVERY_TIMEOUT = 0x02n;
@@ -1579,7 +1590,7 @@ function decodeSubscribePayload(r) {
   const request_id = r.readVarInt();
   const track_namespace = r.readTuple();
   const track_name = r.readString();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "subscribe");
   return {
     type: "subscribe",
     request_id,
@@ -1590,13 +1601,13 @@ function decodeSubscribePayload(r) {
 }
 function decodeSubscribeOkPayload(r, payloadEnd) {
   const track_alias = r.readVarInt();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "subscribe_ok");
   const track_properties = decodeTrackProperties(r, payloadEnd);
   return { type: "subscribe_ok", track_alias, parameters, track_properties };
 }
 function decodeRequestUpdatePayload(r) {
   const request_id = r.readVarInt();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "request_update");
   return {
     type: "request_update",
     request_id,
@@ -1608,7 +1619,7 @@ function decodePublishPayload(r, payloadEnd) {
   const track_namespace = r.readTuple();
   const track_name = r.readString();
   const track_alias = r.readVarInt();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "publish");
   const track_properties = decodeTrackProperties(r, payloadEnd);
   return {
     type: "publish",
@@ -1629,7 +1640,7 @@ function decodePublishDonePayload(r) {
 function decodePublishNamespacePayload(r) {
   const request_id = r.readVarInt();
   const track_namespace = r.readTuple();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "publish_namespace");
   return {
     type: "publish_namespace",
     request_id,
@@ -1648,7 +1659,7 @@ function decodeNamespaceDonePayload(r) {
 function decodeSubscribeNamespacePayload(r) {
   const request_id = r.readVarInt();
   const namespace_prefix = r.readTuple();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "subscribe_namespace");
   return {
     type: "subscribe_namespace",
     request_id,
@@ -1659,7 +1670,7 @@ function decodeSubscribeNamespacePayload(r) {
 function decodeSubscribeTracksPayload(r) {
   const request_id = r.readVarInt();
   const namespace_prefix = r.readTuple();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "subscribe_tracks");
   return {
     type: "subscribe_tracks",
     request_id,
@@ -1701,7 +1712,7 @@ function decodeFetchPayload(r) {
     const joining_start = r.readVarInt();
     joining = { joining_request_id, joining_start };
   }
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "fetch");
   return {
     type: "fetch",
     request_id,
@@ -1715,7 +1726,7 @@ function decodeFetchOkPayload(r, payloadEnd) {
   const end_of_track = r.readUint8();
   const end_group = r.readVarInt();
   const end_object = r.readVarInt();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "fetch_ok");
   const track_properties = decodeTrackProperties(r, payloadEnd);
   return {
     type: "fetch_ok",
@@ -1730,7 +1741,7 @@ function decodeTrackStatusPayload(r) {
   const request_id = r.readVarInt();
   const track_namespace = r.readTuple();
   const track_name = r.readString();
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "track_status");
   return {
     type: "track_status",
     request_id,
@@ -1740,7 +1751,7 @@ function decodeTrackStatusPayload(r) {
   };
 }
 function decodeRequestOkPayload(r, payloadEnd) {
-  const parameters = decodeParams(r);
+  const parameters = decodeParams(r, "request_ok");
   const track_properties = decodeTrackProperties(r, payloadEnd);
   return { type: "request_ok", parameters, track_properties };
 }