@moqtap/codec 0.4.3 → 0.6.0

package/src/drafts/draft19/error-codes.ts

@@ -0,0 +1,78 @@
+export const SessionTerminationCode = {
+  NoError: 0x0n,
+  InternalError: 0x1n,
+  Unauthorized: 0x2n,
+  ProtocolViolation: 0x3n,
+  InvalidRequestId: 0x4n,
+  DuplicateTrackAlias: 0x5n,
+  KeyValueFormattingError: 0x6n,
+  InvalidPath: 0x8n,
+  MalformedPath: 0x9n,
+  GoawayTimeout: 0x10n,
+  ControlMessageTimeout: 0x11n,
+  DataStreamTimeout: 0x12n,
+  AuthTokenCacheOverflow: 0x13n,
+  DuplicateAuthTokenAlias: 0x14n,
+  VersionNegotiationFailed: 0x15n,
+  MalformedAuthToken: 0x16n,
+  UnknownAuthTokenAlias: 0x17n,
+  ExpiredAuthToken: 0x18n,
+  InvalidAuthority: 0x19n,
+  MalformedAuthority: 0x1an,
+  TooManyRequestUpdates: 0x1bn, // NEW in draft-19
+} as const
+export type SessionTerminationCodeValue =
+  (typeof SessionTerminationCode)[keyof typeof SessionTerminationCode]
+
+export const RequestErrorCode = {
+  InternalError: 0x0n,
+  Unauthorized: 0x1n,
+  Timeout: 0x2n,
+  NotSupported: 0x3n,
+  MalformedAuthToken: 0x4n,
+  ExpiredAuthToken: 0x5n,
+  GoingAway: 0x6n,
+  ExcessiveLoad: 0x9n,
+  DoesNotExist: 0x10n,
+  InvalidRange: 0x11n,
+  MalformedTrack: 0x12n,
+  // DuplicateSubscription (0x19) removed in draft-19 — multiple concurrent subscriptions per Track are now allowed
+  Uninterested: 0x20n,
+  PrefixOverlap: 0x30n,
+  NamespaceTooLarge: 0x31n,
+  InvalidJoiningRequestId: 0x32n,
+  UnsupportedExtension: 0x33n,
+  Redirect: 0x34n,
+  ConflictingFilters: 0x35n, // NEW in draft-19
+  InvalidFilter: 0x36n, // NEW in draft-19
+} as const
+export type RequestErrorCodeValue = (typeof RequestErrorCode)[keyof typeof RequestErrorCode]
+
+export const PublishDoneCode = {
+  InternalError: 0x0n,
+  Unauthorized: 0x1n,
+  TrackEnded: 0x2n,
+  SubscriptionEnded: 0x3n,
+  GoingAway: 0x4n,
+  TooFarBehind: 0x5n,
+  Expired: 0x6n,
+  UpdateFailed: 0x8n,
+  ExcessiveLoad: 0x9n,
+  MalformedTrack: 0x12n,
+} as const
+export type PublishDoneCodeValue = (typeof PublishDoneCode)[keyof typeof PublishDoneCode]
+
+export const DataStreamResetCode = {
+  InternalError: 0x0n,
+  Cancelled: 0x1n,
+  DeliveryTimeout: 0x2n,
+  SessionClosed: 0x3n,
+  GoingAway: 0x4n,
+  TooFarBehind: 0x5n,
+  UnknownObjectStatus: 0x6n,
+  ExpiredAuthToken: 0x7n,
+  ExcessiveLoad: 0x9n,
+  MalformedTrack: 0x12n,
+} as const
+export type DataStreamResetCodeValue =
+  (typeof DataStreamResetCode)[keyof typeof DataStreamResetCode]

package/src/drafts/draft19/index.ts

@@ -0,0 +1,126 @@
+// Draft-19 codec entry point
+
+export const DRAFT_VERSION = 0xff000013n
+
+export type { Draft19Codec } from './codec.js'
+export {
+  createDataStreamDecoder,
+  createDraft19Codec,
+  createFetchStreamDecoder,
+  createStreamDecoder,
+  createSubgroupStreamDecoder,
+  decodeDatagram,
+  decodeDataStream,
+  decodeFetchStream,
+  decodeMessage,
+  decodeSubgroupStream,
+  encodeDatagram,
+  encodeFetchStream,
+  encodeMessage,
+  encodeSubgroupStream,
+} from './codec.js'
+export type {
+  DataStreamResetCodeValue,
+  PublishDoneCodeValue,
+  RequestErrorCodeValue,
+  SessionTerminationCodeValue,
+} from './error-codes.js'
+export {
+  DataStreamResetCode,
+  PublishDoneCode,
+  RequestErrorCode,
+  SessionTerminationCode,
+} from './error-codes.js'
+
+export {
+  MESSAGE_ID_MAP,
+  MESSAGE_TYPE_MAP,
+  MSG_FETCH,
+  MSG_FETCH_OK,
+  MSG_GOAWAY,
+  MSG_NAMESPACE,
+  MSG_NAMESPACE_DONE,
+  MSG_PUBLISH,
+  MSG_PUBLISH_DONE,
+  MSG_PUBLISH_NAMESPACE,
+  MSG_PUBLISH_OK,
+  MSG_PUBLISH_SKIPPED,
+  MSG_REQUEST_ERROR,
+  MSG_REQUEST_OK,
+  MSG_REQUEST_UPDATE,
+  MSG_SETUP,
+  MSG_SUBSCRIBE,
+  MSG_SUBSCRIBE_NAMESPACE,
+  MSG_SUBSCRIBE_OK,
+  MSG_SUBSCRIBE_TRACKS,
+  MSG_TRACK_STATUS,
+  SETUP_OPT_AUTHORITY,
+  SETUP_OPT_AUTHORIZATION_TOKEN,
+  SETUP_OPT_MAX_AUTH_TOKEN_CACHE_SIZE,
+  SETUP_OPT_MAX_FILTER_RANGES,
+  SETUP_OPT_MAX_REQUEST_UPDATES,
+  SETUP_OPT_MOQT_IMPLEMENTATION,
+  SETUP_OPT_PATH,
+} from './messages.js'
+
+export {
+  BIDIRECTIONAL_MESSAGES,
+  CLIENT_ONLY_MESSAGES,
+  CONTROL_MESSAGES,
+  getLegalIncoming,
+  getLegalOutgoing,
+  SERVER_ONLY_MESSAGES,
+} from './rules.js'
+export type {
+  ProtocolViolation,
+  SessionPhase,
+  SideEffect,
+  TransitionResult,
+  ValidationResult,
+} from './session.js'
+export { createDraft19SessionState, Draft19SessionFSM } from './session.js'
+
+export type {
+  DatagramObject,
+  DataStreamEvent,
+  DataStreamHeader,
+  Draft19BaseMessage,
+  Draft19DataStream,
+  Draft19Fetch,
+  Draft19FetchOk,
+  Draft19GoAway,
+  Draft19Message,
+  Draft19MessageType,
+  Draft19Namespace,
+  Draft19NamespaceDone,
+  Draft19Params,
+  Draft19Publish,
+  Draft19PublishDone,
+  Draft19PublishNamespace,
+  Draft19PublishSkipped,
+  Draft19RequestError,
+  Draft19RequestOk,
+  Draft19RequestUpdate,
+  Draft19Setup,
+  Draft19SetupOptions,
+  Draft19Subscribe,
+  Draft19SubscribeNamespace,
+  Draft19SubscribeOk,
+  Draft19SubscribeTracks,
+  Draft19TrackProperties,
+  Draft19TrackStatus,
+  FetchObjectPayload,
+  FetchStream,
+  FetchStreamHeader,
+  JoiningFetch,
+  LargestObject,
+  LocationFilter,
+  ObjectPayload,
+  RangeFilter,
+  RangeFilterRange,
+  Redirect,
+  StandaloneFetch,
+  SubgroupStream,
+  SubgroupStreamHeader,
+  UnknownParam,
+} from './types.js'

package/src/drafts/draft19/messages.ts

@@ -0,0 +1,58 @@
+// Draft-19 message type wire IDs
+
+export const MSG_REQUEST_UPDATE = 0x02n
+export const MSG_SUBSCRIBE = 0x03n
+export const MSG_SUBSCRIBE_OK = 0x04n
+export const MSG_REQUEST_ERROR = 0x05n
+export const MSG_PUBLISH_NAMESPACE = 0x06n
+export const MSG_REQUEST_OK = 0x07n
+export const MSG_NAMESPACE = 0x08n
+export const MSG_PUBLISH_DONE = 0x0bn
+export const MSG_TRACK_STATUS = 0x0dn
+export const MSG_NAMESPACE_DONE = 0x0en
+export const MSG_PUBLISH_SKIPPED = 0x0fn
+export const MSG_GOAWAY = 0x10n
+export const MSG_FETCH = 0x16n
+export const MSG_FETCH_OK = 0x18n
+export const MSG_PUBLISH = 0x1dn
+// In draft-18 PUBLISH_OK is an alias for REQUEST_OK (0x07). Kept as alias.
+export const MSG_PUBLISH_OK = MSG_REQUEST_OK
+export const MSG_SUBSCRIBE_NAMESPACE = 0x50n
+export const MSG_SUBSCRIBE_TRACKS = 0x51n
+export const MSG_SETUP = 0x2f00n
+
+// Setup option type IDs (KVP encoding, constant across versions)
+export const SETUP_OPT_PATH = 0x01n
+export const SETUP_OPT_AUTHORIZATION_TOKEN = 0x03n
+export const SETUP_OPT_MAX_AUTH_TOKEN_CACHE_SIZE = 0x04n
+export const SETUP_OPT_AUTHORITY = 0x05n
+export const SETUP_OPT_MAX_FILTER_RANGES = 0x06n // NEW in draft-19
+export const SETUP_OPT_MOQT_IMPLEMENTATION = 0x07n
+export const SETUP_OPT_MAX_REQUEST_UPDATES = 0x08n // NEW in draft-19
+
+// Map from wire ID to message type name
+export const MESSAGE_TYPE_MAP: ReadonlyMap<bigint, string> = new Map([
+  [MSG_SETUP, 'setup'],
+  [MSG_SUBSCRIBE, 'subscribe'],
+  [MSG_SUBSCRIBE_OK, 'subscribe_ok'],
+  [MSG_REQUEST_UPDATE, 'request_update'],
+  [MSG_PUBLISH, 'publish'],
+  [MSG_PUBLISH_DONE, 'publish_done'],
+  [MSG_PUBLISH_NAMESPACE, 'publish_namespace'],
+  [MSG_NAMESPACE, 'namespace'],
+  [MSG_NAMESPACE_DONE, 'namespace_done'],
+  [MSG_SUBSCRIBE_NAMESPACE, 'subscribe_namespace'],
+  [MSG_SUBSCRIBE_TRACKS, 'subscribe_tracks'],
+  [MSG_PUBLISH_SKIPPED, 'publish_skipped'],
+  [MSG_FETCH, 'fetch'],
+  [MSG_FETCH_OK, 'fetch_ok'],
+  [MSG_TRACK_STATUS, 'track_status'],
+  [MSG_REQUEST_OK, 'request_ok'],
+  [MSG_REQUEST_ERROR, 'request_error'],
+  [MSG_GOAWAY, 'goaway'],
+])
+
+// Reverse map from message type name to wire ID
+export const MESSAGE_ID_MAP: ReadonlyMap<string, bigint> = new Map(
+  [...MESSAGE_TYPE_MAP.entries()].map(([id, name]) => [name, id]),
+)

package/src/drafts/draft19/rules.ts

@@ -0,0 +1,85 @@
+import type { Draft19MessageType } from './types.js'
+
+// All draft-18 control messages
+export const CONTROL_MESSAGES: ReadonlySet<Draft19MessageType> = new Set([
+  'setup',
+  'subscribe',
+  'subscribe_ok',
+  'request_update',
+  'publish',
+  'publish_done',
+  'publish_namespace',
+  'namespace',
+  'namespace_done',
+  'subscribe_namespace',
+  'subscribe_tracks',
+  'publish_skipped',
+  'fetch',
+  'fetch_ok',
+  'track_status',
+  'request_ok',
+  'request_error',
+  'goaway',
+])
+
+// Draft-19 has a single SETUP message — both roles can send it
+export const CLIENT_ONLY_MESSAGES: ReadonlySet<Draft19MessageType> = new Set<Draft19MessageType>()
+
+export const SERVER_ONLY_MESSAGES: ReadonlySet<Draft19MessageType> = new Set<Draft19MessageType>()
+
+// Messages that are bidirectional (both client and server can send)
+export const BIDIRECTIONAL_MESSAGES: ReadonlySet<Draft19MessageType> = new Set([
+  'setup',
+  'subscribe',
+  'subscribe_ok',
+  'request_update',
+  'publish',
+  'publish_done',
+  'publish_namespace',
+  'namespace',
+  'namespace_done',
+  'subscribe_namespace',
+  'subscribe_tracks',
+  'publish_skipped',
+  'fetch',
+  'fetch_ok',
+  'track_status',
+  'request_ok',
+  'request_error',
+  'goaway',
+])
+
+// Messages legal in each session phase
+export function getLegalOutgoing(
+  phase: string,
+  _role: 'client' | 'server',
+): Set<Draft19MessageType> {
+  const legal = new Set<Draft19MessageType>()
+
+  switch (phase) {
+    case 'idle':
+      legal.add('setup')
+      break
+    case 'setup':
+      legal.add('setup')
+      break
+    case 'ready': {
+      for (const msg of BIDIRECTIONAL_MESSAGES) {
+        legal.add(msg)
+      }
+      break
+    }
+    case 'draining':
+      break
+  }
+
+  return legal
+}
+
+export function getLegalIncoming(
+  phase: string,
+  role: 'client' | 'server',
+): Set<Draft19MessageType> {
+  const remoteRole = role === 'client' ? 'server' : 'client'
+  return getLegalOutgoing(phase, remoteRole)
+}