@moqtap/codec 0.1.0 → 0.2.0

package/src/drafts/draft12/index.ts

@@ -0,0 +1,130 @@
+export type { Draft12Codec } from "./codec.js";
+export {
+  createDraft12Codec,
+  createStreamDecoder,
+  decodeDatagram,
+  decodeDataStream,
+  decodeFetchStream,
+  decodeMessage,
+  decodeSubgroupStream,
+  encodeDatagram,
+  encodeFetchStream,
+  encodeMessage,
+  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_OK,
+  MSG_GOAWAY,
+  MSG_MAX_REQUEST_ID,
+  MSG_PUBLISH,
+  MSG_PUBLISH_ERROR,
+  MSG_PUBLISH_OK,
+  MSG_REQUESTS_BLOCKED,
+  MSG_SERVER_SETUP,
+  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_TOKEN,
+  PARAM_DELIVERY_TIMEOUT,
+  SETUP_PARAM_MAX_REQUEST_ID,
+  SETUP_PARAM_PATH,
+  VARINT_FRAMED_MESSAGES,
+} from "./messages.js";
+export {
+  BIDIRECTIONAL_MESSAGES,
+  CLIENT_ONLY_MESSAGES,
+  CONTROL_MESSAGES,
+  getLegalIncoming,
+  getLegalOutgoing,
+  SERVER_ONLY_MESSAGES,
+} from "./rules.js";
+export type {
+  AnnouncePhase,
+  AnnounceState,
+  FetchPhase,
+  FetchState,
+  ProtocolViolation,
+  ProtocolViolationCode,
+  SessionPhase,
+  SessionState,
+  SessionStateOptions,
+  SideEffect,
+  SubscriptionPhase,
+  SubscriptionState,
+  TransitionResult,
+  ValidationResult,
+} from "./session.js";
+// Session state machine
+export { createDraft12SessionState } from "./session.js";
+export { Draft12SessionFSM } from "./session-fsm.js";
+export type {
+  AuthorizationToken,
+  DatagramObject,
+  DataStreamEvent,
+  DataStreamHeader,
+  Draft12Announce,
+  Draft12AnnounceCancel,
+  Draft12AnnounceError,
+  Draft12AnnounceOk,
+  Draft12BaseMessage,
+  Draft12ClientSetup,
+  Draft12DataStream,
+  Draft12Fetch,
+  Draft12FetchCancel,
+  Draft12FetchError,
+  Draft12FetchOk,
+  Draft12GoAway,
+  Draft12MaxRequestId,
+  Draft12Message,
+  Draft12MessageType,
+  Draft12Params,
+  Draft12Publish,
+  Draft12PublishError,
+  Draft12PublishOk,
+  Draft12RequestsBlocked,
+  Draft12ServerSetup,
+  Draft12SetupParams,
+  Draft12Subscribe,
+  Draft12SubscribeAnnounces,
+  Draft12SubscribeAnnouncesError,
+  Draft12SubscribeAnnouncesOk,
+  Draft12SubscribeDone,
+  Draft12SubscribeError,
+  Draft12SubscribeOk,
+  Draft12SubscribeUpdate,
+  Draft12TrackStatus,
+  Draft12TrackStatusRequest,
+  Draft12Unannounce,
+  Draft12Unsubscribe,
+  Draft12UnsubscribeAnnounces,
+  FetchObjectPayload,
+  FetchStream,
+  FetchStreamHeader,
+  JoiningFetch,
+  LargestLocation,
+  ObjectPayload,
+  StandaloneFetch,
+  SubgroupStream,
+  SubgroupStreamHeader,
+  UnknownParam,
+} from "./types.js";

package/src/drafts/draft12/messages.ts

@@ -0,0 +1,84 @@
+// Draft-12 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_REQUEST_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_REQUESTS_BLOCKED = 0x1an;
+export const MSG_PUBLISH = 0x1dn;
+export const MSG_PUBLISH_OK = 0x1en;
+export const MSG_PUBLISH_ERROR = 0x1fn;
+export const MSG_CLIENT_SETUP = 0x20n;
+export const MSG_SERVER_SETUP = 0x21n;
+
+// Setup parameter type IDs (even/odd encoding)
+export const SETUP_PARAM_PATH = 0x01n; // odd: length-prefixed
+export const SETUP_PARAM_MAX_REQUEST_ID = 0x02n; // even: varint
+
+// Version-specific parameter type IDs (both odd → length-prefixed)
+export const PARAM_AUTHORIZATION_TOKEN = 0x01n;
+export const PARAM_DELIVERY_TIMEOUT = 0x03n;
+
+// Messages that use varint length framing (instead of uint16 BE)
+export const VARINT_FRAMED_MESSAGES: ReadonlySet<bigint> = new Set([
+  MSG_PUBLISH,
+  MSG_PUBLISH_OK,
+  MSG_PUBLISH_ERROR,
+]);
+
+// 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_PUBLISH, "publish"],
+  [MSG_PUBLISH_OK, "publish_ok"],
+  [MSG_PUBLISH_ERROR, "publish_error"],
+  [MSG_TRACK_STATUS_REQUEST, "track_status_request"],
+  [MSG_TRACK_STATUS, "track_status"],
+  [MSG_GOAWAY, "goaway"],
+  [MSG_MAX_REQUEST_ID, "max_request_id"],
+  [MSG_REQUESTS_BLOCKED, "requests_blocked"],
+]);
+
+// Reverse map
+export const MESSAGE_ID_MAP: ReadonlyMap<string, bigint> = new Map(
+  [...MESSAGE_TYPE_MAP.entries()].map(([id, name]) => [name, id]),
+);

package/src/drafts/draft12/rules.ts

@@ -0,0 +1,106 @@
+import type { Draft12MessageType } from "./types.js";
+
+// All draft-12 control messages
+export const CONTROL_MESSAGES: ReadonlySet<Draft12MessageType> = new Set([
+  "client_setup",
+  "server_setup",
+  "subscribe",
+  "subscribe_ok",
+  "subscribe_error",
+  "subscribe_update",
+  "subscribe_done",
+  "unsubscribe",
+  "announce",
+  "announce_ok",
+  "announce_error",
+  "unannounce",
+  "announce_cancel",
+  "subscribe_announces",
+  "subscribe_announces_ok",
+  "subscribe_announces_error",
+  "unsubscribe_announces",
+  "publish",
+  "publish_ok",
+  "publish_error",
+  "fetch",
+  "fetch_ok",
+  "fetch_error",
+  "fetch_cancel",
+  "track_status_request",
+  "track_status",
+  "goaway",
+  "max_request_id",
+  "requests_blocked",
+]);
+
+// Draft-12 is symmetric: only setup messages are role-restricted.
+export const CLIENT_ONLY_MESSAGES: ReadonlySet<Draft12MessageType> = new Set(["client_setup"]);
+
+export const SERVER_ONLY_MESSAGES: ReadonlySet<Draft12MessageType> = new Set(["server_setup"]);
+
+// Messages that are bidirectional (both client and server can send)
+export const BIDIRECTIONAL_MESSAGES: ReadonlySet<Draft12MessageType> = new Set([
+  "subscribe",
+  "subscribe_ok",
+  "subscribe_error",
+  "subscribe_update",
+  "subscribe_done",
+  "unsubscribe",
+  "announce",
+  "announce_ok",
+  "announce_error",
+  "unannounce",
+  "announce_cancel",
+  "subscribe_announces",
+  "subscribe_announces_ok",
+  "subscribe_announces_error",
+  "unsubscribe_announces",
+  "publish",
+  "publish_ok",
+  "publish_error",
+  "fetch",
+  "fetch_ok",
+  "fetch_error",
+  "fetch_cancel",
+  "track_status_request",
+  "track_status",
+  "goaway",
+  "max_request_id",
+  "requests_blocked",
+]);
+
+// Messages legal in each session phase -- for outbound validation
+export function getLegalOutgoing(
+  phase: string,
+  role: "client" | "server",
+): Set<Draft12MessageType> {
+  const legal = new Set<Draft12MessageType>();
+
+  switch (phase) {
+    case "idle":
+      if (role === "client") legal.add("client_setup");
+      break;
+    case "setup":
+      if (role === "server") legal.add("server_setup");
+      break;
+    case "ready": {
+      legal.add("goaway");
+      for (const msg of BIDIRECTIONAL_MESSAGES) {
+        legal.add(msg);
+      }
+      break;
+    }
+    case "draining":
+      break;
+  }
+
+  return legal;
+}
+
+export function getLegalIncoming(
+  phase: string,
+  role: "client" | "server",
+): Set<Draft12MessageType> {
+  const remoteRole = role === "client" ? "server" : "client";
+  return getLegalOutgoing(phase, remoteRole);
+}