@moqtap/codec 0.2.3 → 0.3.0

package/src/drafts/draft07/index.ts

@@ -1,89 +1,124 @@
-// Re-export types consumers need
-export type {
-  Announce,
-  AnnounceCancel,
-  AnnounceError,
-  AnnounceOk,
-  ClientSetup,
-  DecodeErrorCode,
-  DecodeResult,
-  Fetch,
-  FetchCancel,
-  FetchError,
-  FetchOk,
-  FilterType,
-  GoAway,
-  GroupOrderValue,
-  MaxSubscribeId,
-  MoqtMessage,
-  MoqtMessageType,
-  ObjectDatagram,
-  ServerSetup,
-  StreamHeaderSubgroup,
-  Subscribe,
-  SubscribeAnnounces,
-  SubscribeAnnouncesError,
-  SubscribeAnnouncesOk,
-  SubscribeDone,
-  SubscribeError,
-  SubscribeOk,
-  SubscribeUpdate,
-  TrackStatus,
-  TrackStatusRequest,
-  Unannounce,
-  Unsubscribe,
-  UnsubscribeAnnounces,
-} from "../../core/types.js";
-export { DecodeError } from "../../core/types.js";
-export type { Draft07Codec } from "./codec.js";
-export {
-  createDraft07Codec,
-  decodeDatagram,
-  decodeFetchStream,
-  decodeSubgroupStream,
-  encodeDatagram,
-  encodeFetchStream,
-  encodeSubgroupStream,
-} from "./codec.js";
-export { MESSAGE_ID_TO_TYPE, MESSAGE_TYPE_IDS } from "./messages.js";
-export { decodeParameters, encodeParameters } from "./parameters.js";
-export {
-  CLIENT_ONLY_MESSAGES,
-  CONTROL_MESSAGES,
-  DATA_MESSAGES,
-  getLegalIncoming,
-  getLegalOutgoing,
-  SERVER_ONLY_MESSAGES,
-} from "./rules.js";
-export { decodeVarInt, encodeVarInt } from "./varint.js";
-export type {
-  DatagramObject as Draft07DatagramObject,
-  DataStreamEvent,
-  DataStreamHeader,
-  Draft07DataStream,
-  FetchObjectPayload,
-  FetchStream,
-  FetchStreamHeader,
-  ObjectPayload,
-  SubgroupStream,
-  SubgroupStreamHeader,
-} from "./types.js";
-
-import type { DecodeResult, MoqtMessage } from "../../core/types.js";
-import type { FetchStream, SubgroupStream } from "./types.js";
-import type { DatagramObject } from "./types.js";
-import { createDraft07Codec } from "./codec.js";
-
-const defaultCodec = createDraft07Codec();
-
-export function encodeMessage(message: MoqtMessage): Uint8Array {
-  return defaultCodec.encodeMessage(message);
-}
-
-export function decodeMessage(bytes: Uint8Array): DecodeResult<MoqtMessage> {
-  return defaultCodec.decodeMessage(bytes);
-}
-
-export function createStreamDecoder(): TransformStream<Uint8Array, MoqtMessage> {
-  return defaultCodec.createStreamDecoder();
-}
+export const DRAFT_VERSION = 0xff000007n
+
+export type { DecodeErrorCode, DecodeResult } from '../../core/types.js'
+// Re-export types consumers need
+export { DecodeError } from '../../core/types.js'
+export type { Draft07Codec } from './codec.js'
+export {
+  createDraft07Codec,
+  decodeDatagram,
+  decodeFetchStream,
+  decodeSubgroupStream,
+  encodeDatagram,
+  encodeFetchStream,
+  encodeSubgroupStream,
+} from './codec.js'
+export {
+  MESSAGE_ID_MAP,
+  MESSAGE_TYPE_MAP,
+  MSG_ANNOUNCE,
+  MSG_ANNOUNCE_CANCEL,
+  MSG_ANNOUNCE_ERROR,
+  MSG_ANNOUNCE_OK,
+  MSG_CLIENT_SETUP,
+  MSG_FETCH,
+  MSG_FETCH_CANCEL,
+  MSG_FETCH_ERROR,
+  MSG_FETCH_HEADER,
+  MSG_FETCH_OK,
+  MSG_GOAWAY,
+  MSG_MAX_SUBSCRIBE_ID,
+  MSG_OBJECT_DATAGRAM,
+  MSG_SERVER_SETUP,
+  MSG_STREAM_HEADER_SUBGROUP,
+  MSG_SUBSCRIBE,
+  MSG_SUBSCRIBE_ANNOUNCES,
+  MSG_SUBSCRIBE_ANNOUNCES_ERROR,
+  MSG_SUBSCRIBE_ANNOUNCES_OK,
+  MSG_SUBSCRIBE_DONE,
+  MSG_SUBSCRIBE_ERROR,
+  MSG_SUBSCRIBE_OK,
+  MSG_SUBSCRIBE_UPDATE,
+  MSG_TRACK_STATUS,
+  MSG_TRACK_STATUS_REQUEST,
+  MSG_UNANNOUNCE,
+  MSG_UNSUBSCRIBE,
+  MSG_UNSUBSCRIBE_ANNOUNCES,
+  PARAM_AUTHORIZATION_INFO,
+  PARAM_DELIVERY_TIMEOUT,
+  PARAM_MAX_CACHE_DURATION,
+  SETUP_PARAM_MAX_SUBSCRIBE_ID,
+  SETUP_PARAM_PATH,
+  SETUP_PARAM_ROLE,
+} from './messages.js'
+export {
+  CLIENT_ONLY_MESSAGES,
+  CONTROL_MESSAGES,
+  DATA_MESSAGES,
+  getLegalIncoming,
+  getLegalOutgoing,
+  SERVER_ONLY_MESSAGES,
+} from './rules.js'
+export type {
+  Announce,
+  AnnounceCancel,
+  AnnounceError,
+  AnnounceOk,
+  ClientSetup,
+  DatagramObject as Draft07DatagramObject,
+  DataStreamEvent,
+  DataStreamHeader,
+  Draft07DataStream,
+  Draft07Message,
+  Draft07MessageType,
+  Draft07Params,
+  Draft07SetupParams,
+  Fetch,
+  FetchCancel,
+  FetchError,
+  FetchObjectPayload,
+  FetchOk,
+  FetchStream,
+  FetchStreamHeader,
+  GoAway,
+  MaxSubscribeId,
+  ObjectDatagram,
+  ObjectPayload,
+  ServerSetup,
+  StreamHeaderSubgroup,
+  SubgroupStream,
+  SubgroupStreamHeader,
+  Subscribe,
+  SubscribeAnnounces,
+  SubscribeAnnouncesError,
+  SubscribeAnnouncesOk,
+  SubscribeDone,
+  SubscribeError,
+  SubscribeOk,
+  SubscribeUpdate,
+  TrackStatus,
+  TrackStatusRequest,
+  Unannounce,
+  UnknownParam,
+  Unsubscribe,
+  UnsubscribeAnnounces,
+} from './types.js'
+export { decodeVarInt, encodeVarInt } from './varint.js'
+
+import type { DecodeResult } from '../../core/types.js'
+import { createDraft07Codec } from './codec.js'
+import type { Draft07Message } from './types.js'
+
+const defaultCodec = createDraft07Codec()
+
+export function encodeMessage(message: Draft07Message): Uint8Array {
+  return defaultCodec.encodeMessage(message)
+}
+
+export function decodeMessage(bytes: Uint8Array): DecodeResult<Draft07Message> {
+  return defaultCodec.decodeMessage(bytes)
+}
+
+export function createStreamDecoder(): TransformStream<Uint8Array, Draft07Message> {
+  return defaultCodec.createStreamDecoder()
+}

package/src/drafts/draft07/messages.ts

@@ -1,42 +1,76 @@
-// MoQT draft-ietf-moq-transport-07 message type IDs (wire format)
-export const MESSAGE_TYPE_IDS = {
-  // Control messages (on control stream)
-  subscribe_update: 0x02n,
-  subscribe: 0x03n,
-  subscribe_ok: 0x04n,
-  subscribe_error: 0x05n,
-  announce: 0x06n,
-  announce_ok: 0x07n,
-  announce_error: 0x08n,
-  unannounce: 0x09n,
-  unsubscribe: 0x0an,
-  subscribe_done: 0x0bn,
-  announce_cancel: 0x0cn,
-  track_status_request: 0x0dn,
-  track_status: 0x0en,
-  goaway: 0x10n,
-  subscribe_announces: 0x11n,
-  subscribe_announces_ok: 0x12n,
-  subscribe_announces_error: 0x13n,
-  unsubscribe_announces: 0x14n,
-  max_subscribe_id: 0x15n,
-  fetch: 0x16n,
-  fetch_cancel: 0x17n,
-  fetch_ok: 0x18n,
-  fetch_error: 0x19n,
-  client_setup: 0x40n,
-  server_setup: 0x41n,
-  // Data stream messages (Section 7, Table 5)
-  object_datagram: 0x01n,
-  stream_header_subgroup: 0x04n, // Note: same ID as subscribe_ok but used on data streams, context disambiguates
-  fetch_header: 0x05n, // Note: same ID as subscribe_error but used on data streams, context disambiguates
-} as const;
-
-// Reverse map: wire ID -> message type name
-export const MESSAGE_ID_TO_TYPE = new Map<bigint, string>();
-for (const [name, id] of Object.entries(MESSAGE_TYPE_IDS)) {
-  // For duplicate IDs, control stream messages take priority in the reverse map
-  if (!MESSAGE_ID_TO_TYPE.has(id) || name !== "stream_header_subgroup") {
-    MESSAGE_ID_TO_TYPE.set(id, name);
-  }
-}
+// Draft-07 message type wire IDs
+
+export const MSG_SUBSCRIBE_UPDATE = 0x02n
+export const MSG_SUBSCRIBE = 0x03n
+export const MSG_SUBSCRIBE_OK = 0x04n
+export const MSG_SUBSCRIBE_ERROR = 0x05n
+export const MSG_ANNOUNCE = 0x06n
+export const MSG_ANNOUNCE_OK = 0x07n
+export const MSG_ANNOUNCE_ERROR = 0x08n
+export const MSG_UNANNOUNCE = 0x09n
+export const MSG_UNSUBSCRIBE = 0x0an
+export const MSG_SUBSCRIBE_DONE = 0x0bn
+export const MSG_ANNOUNCE_CANCEL = 0x0cn
+export const MSG_TRACK_STATUS_REQUEST = 0x0dn
+export const MSG_TRACK_STATUS = 0x0en
+export const MSG_GOAWAY = 0x10n
+export const MSG_SUBSCRIBE_ANNOUNCES = 0x11n
+export const MSG_SUBSCRIBE_ANNOUNCES_OK = 0x12n
+export const MSG_SUBSCRIBE_ANNOUNCES_ERROR = 0x13n
+export const MSG_UNSUBSCRIBE_ANNOUNCES = 0x14n
+export const MSG_MAX_SUBSCRIBE_ID = 0x15n
+export const MSG_FETCH = 0x16n
+export const MSG_FETCH_CANCEL = 0x17n
+export const MSG_FETCH_OK = 0x18n
+export const MSG_FETCH_ERROR = 0x19n
+export const MSG_CLIENT_SETUP = 0x40n
+export const MSG_SERVER_SETUP = 0x41n
+
+// Setup parameter type IDs
+export const SETUP_PARAM_ROLE = 0x00n
+export const SETUP_PARAM_PATH = 0x01n
+export const SETUP_PARAM_MAX_SUBSCRIBE_ID = 0x02n
+
+// Version-specific parameter type IDs
+export const PARAM_AUTHORIZATION_INFO = 0x02n
+export const PARAM_DELIVERY_TIMEOUT = 0x03n
+export const PARAM_MAX_CACHE_DURATION = 0x04n
+
+// Data stream type IDs (context disambiguates from control messages with same IDs)
+export const MSG_OBJECT_DATAGRAM = 0x01n
+export const MSG_STREAM_HEADER_SUBGROUP = 0x04n
+export const MSG_FETCH_HEADER = 0x05n
+
+// Map from wire ID to message type name
+export const MESSAGE_TYPE_MAP: ReadonlyMap<bigint, string> = new Map([
+  [MSG_CLIENT_SETUP, 'client_setup'],
+  [MSG_SERVER_SETUP, 'server_setup'],
+  [MSG_SUBSCRIBE, 'subscribe'],
+  [MSG_SUBSCRIBE_OK, 'subscribe_ok'],
+  [MSG_SUBSCRIBE_ERROR, 'subscribe_error'],
+  [MSG_SUBSCRIBE_UPDATE, 'subscribe_update'],
+  [MSG_SUBSCRIBE_DONE, 'subscribe_done'],
+  [MSG_UNSUBSCRIBE, 'unsubscribe'],
+  [MSG_ANNOUNCE, 'announce'],
+  [MSG_ANNOUNCE_OK, 'announce_ok'],
+  [MSG_ANNOUNCE_ERROR, 'announce_error'],
+  [MSG_UNANNOUNCE, 'unannounce'],
+  [MSG_ANNOUNCE_CANCEL, 'announce_cancel'],
+  [MSG_SUBSCRIBE_ANNOUNCES, 'subscribe_announces'],
+  [MSG_SUBSCRIBE_ANNOUNCES_OK, 'subscribe_announces_ok'],
+  [MSG_SUBSCRIBE_ANNOUNCES_ERROR, 'subscribe_announces_error'],
+  [MSG_UNSUBSCRIBE_ANNOUNCES, 'unsubscribe_announces'],
+  [MSG_FETCH, 'fetch'],
+  [MSG_FETCH_OK, 'fetch_ok'],
+  [MSG_FETCH_ERROR, 'fetch_error'],
+  [MSG_FETCH_CANCEL, 'fetch_cancel'],
+  [MSG_TRACK_STATUS_REQUEST, 'track_status_request'],
+  [MSG_TRACK_STATUS, 'track_status'],
+  [MSG_GOAWAY, 'goaway'],
+  [MSG_MAX_SUBSCRIBE_ID, 'max_subscribe_id'],
+])
+
+// Reverse map
+export const MESSAGE_ID_MAP: ReadonlyMap<string, bigint> = new Map(
+  [...MESSAGE_TYPE_MAP.entries()].map(([id, name]) => [name, id]),
+)

package/src/drafts/draft07/rules.ts

@@ -1,101 +1,107 @@
-import type { MoqtMessageType } from "../../core/types.js";
-
-export const CONTROL_MESSAGES: ReadonlySet<MoqtMessageType> = new Set([
-  "client_setup",
-  "server_setup",
-  "subscribe",
-  "subscribe_ok",
-  "subscribe_error",
-  "subscribe_done",
-  "subscribe_update",
-  "unsubscribe",
-  "announce",
-  "announce_ok",
-  "announce_error",
-  "announce_cancel",
-  "unannounce",
-  "track_status_request",
-  "track_status",
-  "goaway",
-  "subscribe_announces",
-  "subscribe_announces_ok",
-  "subscribe_announces_error",
-  "unsubscribe_announces",
-  "max_subscribe_id",
-  "fetch",
-  "fetch_ok",
-  "fetch_error",
-  "fetch_cancel",
-]);
-
-export const DATA_MESSAGES: ReadonlySet<MoqtMessageType> = new Set([
-  "object_datagram",
-  "stream_header_subgroup",
-]);
-
-// Messages that only a client can send
-export const CLIENT_ONLY_MESSAGES: ReadonlySet<MoqtMessageType> = new Set([
-  "client_setup",
-  "subscribe",
-  "subscribe_update",
-  "unsubscribe",
-  "announce",
-  "unannounce",
-  "subscribe_announces",
-  "unsubscribe_announces",
-  "fetch",
-  "fetch_cancel",
-  "track_status_request",
-]);
-
-// Messages that only a server can send
-export const SERVER_ONLY_MESSAGES: ReadonlySet<MoqtMessageType> = new Set([
-  "server_setup",
-  "subscribe_ok",
-  "subscribe_error",
-  "subscribe_done",
-  "announce_ok",
-  "announce_error",
-  "announce_cancel",
-  "subscribe_announces_ok",
-  "subscribe_announces_error",
-  "max_subscribe_id",
-  "fetch_ok",
-  "fetch_error",
-  "track_status",
-  "goaway",
-]);
-
-// Messages legal in each session phase -- for outbound validation
-export function getLegalOutgoing(phase: string, role: "client" | "server"): Set<MoqtMessageType> {
-  const legal = new Set<MoqtMessageType>();
-
-  switch (phase) {
-    case "idle":
-      if (role === "client") legal.add("client_setup");
-      break;
-    case "setup":
-      if (role === "server") legal.add("server_setup");
-      break;
-    case "ready": {
-      const roleMessages = role === "client" ? CLIENT_ONLY_MESSAGES : SERVER_ONLY_MESSAGES;
-      for (const msg of roleMessages) {
-        if (msg !== "client_setup" && msg !== "server_setup") {
-          legal.add(msg);
-        }
-      }
-      break;
-    }
-    case "draining":
-      // Limited set during draining - can still finish active operations
-      break;
-  }
-
-  return legal;
-}
-
-export function getLegalIncoming(phase: string, role: "client" | "server"): Set<MoqtMessageType> {
-  // Incoming from remote = the other role's outgoing
-  const remoteRole = role === "client" ? "server" : "client";
-  return getLegalOutgoing(phase, remoteRole);
-}
+import type { Draft07MessageType } from './types.js'
+
+export const CONTROL_MESSAGES: ReadonlySet<Draft07MessageType> = new Set([
+  'client_setup',
+  'server_setup',
+  'subscribe',
+  'subscribe_ok',
+  'subscribe_error',
+  'subscribe_done',
+  'subscribe_update',
+  'unsubscribe',
+  'announce',
+  'announce_ok',
+  'announce_error',
+  'announce_cancel',
+  'unannounce',
+  'track_status_request',
+  'track_status',
+  'goaway',
+  'subscribe_announces',
+  'subscribe_announces_ok',
+  'subscribe_announces_error',
+  'unsubscribe_announces',
+  'max_subscribe_id',
+  'fetch',
+  'fetch_ok',
+  'fetch_error',
+  'fetch_cancel',
+])
+
+export const DATA_MESSAGES: ReadonlySet<Draft07MessageType> = new Set([
+  'object_datagram',
+  'stream_header_subgroup',
+])
+
+// Messages that only a client can send
+export const CLIENT_ONLY_MESSAGES: ReadonlySet<Draft07MessageType> = new Set([
+  'client_setup',
+  'subscribe',
+  'subscribe_update',
+  'unsubscribe',
+  'announce',
+  'unannounce',
+  'subscribe_announces',
+  'unsubscribe_announces',
+  'fetch',
+  'fetch_cancel',
+  'track_status_request',
+])
+
+// Messages that only a server can send
+export const SERVER_ONLY_MESSAGES: ReadonlySet<Draft07MessageType> = new Set([
+  'server_setup',
+  'subscribe_ok',
+  'subscribe_error',
+  'subscribe_done',
+  'announce_ok',
+  'announce_error',
+  'announce_cancel',
+  'subscribe_announces_ok',
+  'subscribe_announces_error',
+  'max_subscribe_id',
+  'fetch_ok',
+  'fetch_error',
+  'track_status',
+  'goaway',
+])
+
+// Messages legal in each session phase -- for outbound validation
+export function getLegalOutgoing(
+  phase: string,
+  role: 'client' | 'server',
+): Set<Draft07MessageType> {
+  const legal = new Set<Draft07MessageType>()
+
+  switch (phase) {
+    case 'idle':
+      if (role === 'client') legal.add('client_setup')
+      break
+    case 'setup':
+      if (role === 'server') legal.add('server_setup')
+      break
+    case 'ready': {
+      const roleMessages = role === 'client' ? CLIENT_ONLY_MESSAGES : SERVER_ONLY_MESSAGES
+      for (const msg of roleMessages) {
+        if (msg !== 'client_setup' && msg !== 'server_setup') {
+          legal.add(msg)
+        }
+      }
+      break
+    }
+    case 'draining':
+      // Limited set during draining - can still finish active operations
+      break
+  }
+
+  return legal
+}
+
+export function getLegalIncoming(
+  phase: string,
+  role: 'client' | 'server',
+): Set<Draft07MessageType> {
+  // Incoming from remote = the other role's outgoing
+  const remoteRole = role === 'client' ? 'server' : 'client'
+  return getLegalOutgoing(phase, remoteRole)
+}