@moqtap/codec 0.4.3 → 0.6.0

package/src/drafts/draft19/types.ts

@@ -0,0 +1,368 @@
+// Draft-19 specific message types
+
+// Unknown parameter for passthrough
+export interface UnknownParam {
+  readonly id: string // e.g. "0x21"
+  readonly length: number
+  readonly raw_hex: string
+}
+
+// Authorization token parameter (nested structure within length-prefixed param)
+export interface AuthorizationToken {
+  readonly alias_type: bigint // 0=DELETE, 1=REGISTER, 2=USE_ALIAS, 3=USE_VALUE
+  readonly token_alias?: bigint // present for DELETE(0), REGISTER(1), USE_ALIAS(2)
+  readonly token_type?: bigint // present for REGISTER(1), USE_VALUE(3)
+  readonly token_value?: Uint8Array // present for REGISTER(1), USE_VALUE(3)
+}
+
+// Setup options (KVP encoding, no count prefix)
+export interface Draft19SetupOptions {
+  path?: string // 0x01 odd
+  authorization_token?: AuthorizationToken // 0x03 odd
+  max_auth_token_cache_size?: bigint // 0x04 even
+  authority?: string // 0x05 odd
+  max_filter_ranges?: bigint // 0x06 even (NEW in draft-19)
+  moqt_implementation?: string // 0x07 odd
+  max_request_updates?: bigint // 0x08 even (NEW in draft-19)
+  unknown?: UnknownParam[]
+}
+
+// Location filter parameter (renamed from SubscriptionFilter in draft-19)
+export interface LocationFilter {
+  readonly filter_type: bigint
+  readonly start_group?: bigint
+  readonly start_object?: bigint
+  readonly end_group?: bigint
+}
+
+// Range Filter parameter (NEW in draft-19). Selects Objects/Tracks by integer
+// ranges over Object header fields or Property values.
+export interface RangeFilterRange {
+  readonly start: bigint
+  readonly end?: bigint // omitted on the final Range = open-ended (no upper bound)
+}
+
+export interface RangeFilter {
+  readonly set_id?: bigint
+  readonly property_type?: bigint // only for OBJECT_PROPERTY_FILTER / TRACK_PROPERTY_FILTER
+  readonly ranges?: RangeFilterRange[]
+  readonly removed?: boolean // REQUEST_UPDATE length-0 form: remove this filter
+}
+
+// Largest object location parameter
+export interface LargestObject {
+  readonly group: bigint
+  readonly object: bigint
+}
+
+// Version-specific parameters (delta-encoded types, count-prefixed)
+export interface Draft19Params {
+  object_delivery_timeout?: bigint // 0x02 varint (renamed from delivery_timeout in draft-17)
+  authorization_token?: AuthorizationToken // 0x03 length-prefixed nested
+  rendezvous_timeout?: bigint // 0x04 varint
+  subgroup_delivery_timeout?: bigint // 0x06 varint (NEW in draft-18)
+  expires?: bigint // 0x08 varint
+  largest_object?: LargestObject // 0x09 Location (2 bare varints)
+  fill_timeout?: bigint // 0x0a varint (NEW in draft-18)
+  forward?: bigint // 0x10 uint8 (was varint in draft-17)
+  subscriber_priority?: bigint // 0x20 uint8
+  location_filter?: LocationFilter // 0x21 length-prefixed (renamed from subscription_filter in draft-19)
+  group_order?: bigint // 0x22 uint8
+  subgroup_filter?: RangeFilter // 0x25 length-prefixed (NEW in draft-19)
+  objectid_filter?: RangeFilter // 0x26 length-prefixed (NEW in draft-19)
+  priority_filter?: RangeFilter // 0x27 length-prefixed (NEW in draft-19)
+  object_property_filter?: RangeFilter // 0x28 length-prefixed (NEW in draft-19)
+  track_property_filter?: RangeFilter // 0x29 length-prefixed (NEW in draft-19)
+  new_group_request?: bigint // 0x32 varint
+  track_namespace_prefix?: string[] // 0x34 Track Namespace encoding (NEW in draft-18)
+  unknown?: UnknownParam[]
+}
+
+// Track properties (KVP encoding, no count prefix, read until end of payload)
+export interface Draft19TrackProperties {
+  object_delivery_timeout?: bigint // 0x02 even varint (renamed from delivery_timeout)
+  max_cache_duration?: bigint // 0x04 even varint
+  subgroup_delivery_timeout?: bigint // 0x06 even varint (NEW in draft-18)
+  immutable_properties?: Uint8Array // 0x0b odd length-prefixed
+  default_publisher_priority?: bigint // 0x0e even varint
+  default_publisher_group_order?: bigint // 0x22 even varint
+  dynamic_groups?: bigint // 0x30 even varint
+  unknown?: UnknownParam[]
+}
+
+// Draft-19 message type tag union
+export type Draft19MessageType =
+  | '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'
+
+// Base
+export interface Draft19BaseMessage {
+  readonly type: Draft19MessageType
+}
+
+// Setup — single unified message (0x2F00)
+export interface Draft19Setup extends Draft19BaseMessage {
+  readonly type: 'setup'
+  readonly options: Draft19SetupOptions
+}
+
+// Subscribe — Required Request ID Delta REMOVED in draft-18
+export interface Draft19Subscribe extends Draft19BaseMessage {
+  readonly type: 'subscribe'
+  readonly request_id: bigint
+  readonly track_namespace: string[]
+  readonly track_name: string
+  readonly parameters: Draft19Params
+}
+
+export interface Draft19SubscribeOk extends Draft19BaseMessage {
+  readonly type: 'subscribe_ok'
+  readonly track_alias: bigint
+  readonly parameters: Draft19Params
+  readonly track_properties: Draft19TrackProperties
+}
+
+export interface Draft19RequestUpdate extends Draft19BaseMessage {
+  readonly type: 'request_update'
+  readonly request_id: bigint
+  readonly parameters: Draft19Params
+}
+
+// Publish
+export interface Draft19Publish extends Draft19BaseMessage {
+  readonly type: 'publish'
+  readonly request_id: bigint
+  readonly track_namespace: string[]
+  readonly track_name: string
+  readonly track_alias: bigint
+  readonly parameters: Draft19Params
+  readonly track_properties: Draft19TrackProperties
+}
+
+export interface Draft19PublishDone extends Draft19BaseMessage {
+  readonly type: 'publish_done'
+  readonly status_code: bigint
+  readonly stream_count: bigint
+  readonly reason_phrase: string
+}
+
+// Namespace
+export interface Draft19PublishNamespace extends Draft19BaseMessage {
+  readonly type: 'publish_namespace'
+  readonly request_id: bigint
+  readonly track_namespace: string[]
+  readonly parameters: Draft19Params
+}
+
+export interface Draft19Namespace extends Draft19BaseMessage {
+  readonly type: 'namespace'
+  readonly namespace_suffix: string[]
+}
+
+export interface Draft19NamespaceDone extends Draft19BaseMessage {
+  readonly type: 'namespace_done'
+  readonly namespace_suffix: string[]
+}
+
+// SUBSCRIBE_NAMESPACE — type 0x50, subscribe_options field removed in draft-18
+export interface Draft19SubscribeNamespace extends Draft19BaseMessage {
+  readonly type: 'subscribe_namespace'
+  readonly request_id: bigint
+  readonly namespace_prefix: string[]
+  readonly parameters: Draft19Params
+}
+
+// SUBSCRIBE_TRACKS — NEW in draft-18, type 0x51
+export interface Draft19SubscribeTracks extends Draft19BaseMessage {
+  readonly type: 'subscribe_tracks'
+  readonly request_id: bigint
+  readonly namespace_prefix: string[]
+  readonly parameters: Draft19Params
+}
+
+export interface Draft19PublishSkipped extends Draft19BaseMessage {
+  readonly type: 'publish_skipped'
+  readonly namespace_suffix: string[]
+  readonly track_name: string
+}
+
+// Fetch
+export interface StandaloneFetch {
+  readonly track_namespace: string[]
+  readonly track_name: string
+  readonly start_group: bigint
+  readonly start_object: bigint
+  readonly end_group: bigint
+  readonly end_object: bigint
+}
+
+export interface JoiningFetch {
+  readonly joining_request_id: bigint
+  readonly joining_start: bigint
+}
+
+export interface Draft19Fetch extends Draft19BaseMessage {
+  readonly type: 'fetch'
+  readonly request_id: bigint
+  readonly fetch_type: bigint
+  readonly standalone?: StandaloneFetch
+  readonly joining?: JoiningFetch
+  readonly parameters: Draft19Params
+}
+
+export interface Draft19FetchOk extends Draft19BaseMessage {
+  readonly type: 'fetch_ok'
+  readonly end_of_track: number // uint8
+  readonly end_group: bigint
+  readonly end_object: bigint
+  readonly parameters: Draft19Params
+  readonly track_properties: Draft19TrackProperties
+}
+
+// Track Status — same format as subscribe in draft-18 (without required_request_id_delta)
+export interface Draft19TrackStatus extends Draft19BaseMessage {
+  readonly type: 'track_status'
+  readonly request_id: bigint
+  readonly track_namespace: string[]
+  readonly track_name: string
+  readonly parameters: Draft19Params
+}
+
+// REQUEST_OK — gained trailing Track Properties in draft-18
+export interface Draft19RequestOk extends Draft19BaseMessage {
+  readonly type: 'request_ok'
+  readonly parameters: Draft19Params
+  readonly track_properties: Draft19TrackProperties
+}
+
+// Redirect structure (used inside REQUEST_ERROR when error_code = REDIRECT 0x34)
+export interface Redirect {
+  readonly connect_uri: string
+  readonly track_namespace: string[]
+  readonly track_name: string
+}
+
+export interface Draft19RequestError extends Draft19BaseMessage {
+  readonly type: 'request_error'
+  readonly error_code: bigint
+  readonly retry_interval: bigint
+  readonly reason_phrase: string
+  readonly redirect?: Redirect
+}
+
+// Session Control
+export interface Draft19GoAway extends Draft19BaseMessage {
+  readonly type: 'goaway'
+  readonly new_session_uri: string
+  readonly timeout: bigint
+  // Request ID removed from GOAWAY in draft-19 — control and request streams share one format
+}
+
+// Union of all draft-18 control messages
+export type Draft19Message =
+  | Draft19Setup
+  | Draft19Subscribe
+  | Draft19SubscribeOk
+  | Draft19RequestUpdate
+  | Draft19Publish
+  | Draft19PublishDone
+  | Draft19PublishNamespace
+  | Draft19Namespace
+  | Draft19NamespaceDone
+  | Draft19SubscribeNamespace
+  | Draft19SubscribeTracks
+  | Draft19PublishSkipped
+  | Draft19Fetch
+  | Draft19FetchOk
+  | Draft19TrackStatus
+  | Draft19RequestOk
+  | Draft19RequestError
+  | Draft19GoAway
+
+// Data stream types
+export interface ObjectPayload {
+  readonly type: 'object'
+  readonly byteOffset: number
+  readonly payloadByteOffset: number
+  readonly objectId: bigint
+  readonly payloadLength: number
+  readonly status?: bigint
+  readonly extensionData: Uint8Array
+  readonly objectProperties?: Record<string, bigint>
+  readonly payload: Uint8Array
+}
+
+export interface SubgroupStream {
+  readonly type: 'subgroup'
+  readonly headerType: number
+  readonly trackAlias: bigint
+  readonly groupId: bigint
+  readonly subgroupId: bigint
+  readonly publisherPriority: number
+  readonly endOfGroup?: boolean
+  readonly firstObject?: boolean
+  readonly objects: ObjectPayload[]
+}
+
+export interface DatagramObject {
+  readonly type: 'datagram'
+  readonly datagramType: number
+  readonly trackAlias: bigint
+  readonly groupId: bigint
+  readonly objectId: bigint
+  readonly publisherPriority: number
+  readonly endOfGroup?: boolean
+  readonly objectStatus?: bigint
+  readonly objectProperties?: Record<string, bigint>
+  readonly payloadLength: number
+  readonly payload: Uint8Array
+}
+
+export interface FetchObjectPayload extends ObjectPayload {
+  readonly serializationFlags: number
+  readonly groupId: bigint
+  readonly subgroupId: bigint
+  readonly publisherPriority: number
+  readonly objectProperties?: Record<string, bigint>
+}
+
+export interface FetchStream {
+  readonly type: 'fetch'
+  readonly requestId: bigint
+  readonly objects: FetchObjectPayload[]
+}
+
+export type Draft19DataStream = SubgroupStream | DatagramObject | FetchStream
+
+// Streaming data stream decoder types
+export interface SubgroupStreamHeader {
+  readonly type: 'subgroup_header'
+  readonly trackAlias: bigint
+  readonly groupId: bigint
+  readonly subgroupId: bigint
+  readonly publisherPriority: number
+}
+
+export interface FetchStreamHeader {
+  readonly type: 'fetch_header'
+  readonly requestId: bigint
+}
+
+export type DataStreamHeader = SubgroupStreamHeader | FetchStreamHeader
+export type DataStreamEvent = DataStreamHeader | ObjectPayload

package/src/index.ts

@@ -34,6 +34,10 @@ import type { Draft16Codec } from './drafts/draft16/codec.js'
 import { createDraft16Codec } from './drafts/draft16/codec.js'
 import type { Draft17Codec } from './drafts/draft17/codec.js'
 import { createDraft17Codec } from './drafts/draft17/codec.js'
+import type { Draft18Codec } from './drafts/draft18/codec.js'
+import { createDraft18Codec } from './drafts/draft18/codec.js'
+import type { Draft19Codec } from './drafts/draft19/codec.js'
+import { createDraft19Codec } from './drafts/draft19/codec.js'
 
 /**
  * Wire version numbers for each MoQT draft, keyed by short aliases.
@@ -50,6 +54,8 @@ export const DRAFT_VERSIONS: Record<string, bigint> = {
   '15': 0xff00000fn,
   '16': 0xff000010n,
   '17': 0xff000011n,
+  '18': 0xff000012n,
+  '19': 0xff000013n,
 }
 
 export function createCodec(options: CodecOptions & { draft: '07' }): Draft07Codec
@@ -63,6 +69,8 @@ export function createCodec(options: CodecOptions & { draft: '14' }): Draft14Cod
 export function createCodec(options: CodecOptions & { draft: '15' }): Draft15Codec
 export function createCodec(options: CodecOptions & { draft: '16' }): Draft16Codec
 export function createCodec(options: CodecOptions & { draft: '17' }): Draft17Codec
+export function createCodec(options: CodecOptions & { draft: '18' }): Draft18Codec
+export function createCodec(options: CodecOptions & { draft: '19' }): Draft19Codec
 
 /**
  * Create a codec for the specified draft version.
@@ -84,6 +92,8 @@ export function createCodec(
   | Draft15Codec
   | Draft16Codec
   | Draft17Codec
+  | Draft18Codec
+  | Draft19Codec
 export function createCodec(
   options: CodecOptions,
 ):
@@ -97,7 +107,9 @@ export function createCodec(
   | Draft14Codec
   | Draft15Codec
   | Draft16Codec
-  | Draft17Codec {
+  | Draft17Codec
+  | Draft18Codec
+  | Draft19Codec {
   const draft = DRAFT_VERSIONS[options.draft]
   if (!draft) {
     throw new Error(
@@ -130,6 +142,10 @@ export function createCodec(
       return createDraft16Codec()
     case '17':
       return createDraft17Codec()
+    case '18':
+      return createDraft18Codec()
+    case '19':
+      return createDraft19Codec()
     default:
       throw new Error(`Unsupported draft: ${draft}`)
   }

package/src/session.ts

@@ -30,6 +30,10 @@ import { createDraft16SessionState } from './drafts/draft16/session.js'
 import type { Draft16Message, Draft16MessageType } from './drafts/draft16/types.js'
 import { createDraft17SessionState } from './drafts/draft17/session.js'
 import type { Draft17Message, Draft17MessageType } from './drafts/draft17/types.js'
+import { createDraft18SessionState } from './drafts/draft18/session.js'
+import type { Draft18Message, Draft18MessageType } from './drafts/draft18/types.js'
+import { createDraft19SessionState } from './drafts/draft19/session.js'
+import type { Draft19Message, Draft19MessageType } from './drafts/draft19/types.js'
 
 type DraftSessionStateMap = {
   '07': SessionState<Draft07Message, Draft07MessageType>
@@ -43,6 +47,8 @@ type DraftSessionStateMap = {
   '15': SessionState<Draft15Message, Draft15MessageType>
   '16': SessionState<Draft16Message, Draft16MessageType>
   '17': SessionState<Draft17Message, Draft17MessageType>
+  '18': SessionState<Draft18Message, Draft18MessageType>
+  '19': SessionState<Draft19Message, Draft19MessageType>
 }
 
 /**
@@ -65,6 +71,8 @@ export function createSessionState<T extends Draft>(
     '15': createDraft15SessionState,
     '16': createDraft16SessionState,
     '17': createDraft17SessionState,
+    '18': createDraft18SessionState,
+    '19': createDraft19SessionState,
   }
 
   const factory = factories[draft]