@norskvideo/moq-net 0.1.8 → 0.2.1

package/stream.d.ts

@@ -1,4 +1,6 @@
 import type { IetfVersion } from "./ietf/version";
+import { type Version as LiteVersion } from "./lite/version";
+import { U64 } from "./util/u64";
 /**
  * Options handed to the transport for one outgoing stream.
  *
@@ -9,6 +11,16 @@ import type { IetfVersion } from "./ietf/version";
 export declare function sendOptions(options?: OpenOptions): WebTransportSendStreamOptions & {
     waitUntilAvailable?: boolean;
 };
+/**
+ * The version a stream's bytes follow: a moq-transport draft or a moq-lite draft. Required on
+ * every stream so the varint form never defaults silently; a stream opened before negotiation
+ * names the version its handshake is encoded with.
+ */
+export type StreamVersion = IetfVersion | LiteVersion;
+/** The moq-transport draft a stream follows, or undefined on moq-lite, whose stream codes are the same on every draft. */
+export declare function asIetf(version: StreamVersion): IetfVersion | undefined;
+/** Encode one varint in the form `version` uses, for a body written outside a {@link Writer}. */
+export declare function encodeVarint(v: number | bigint, version: StreamVersion): Uint8Array;
 /**
  * The `WebTransportSendStream` that every outgoing stream is, narrowed to the one attribute
  * this package uses. The DOM types available here still describe them as plain
@@ -24,8 +36,8 @@ export type SendStream = WritableStream<Uint8Array> & {
 };
 /** Options for opening an outgoing stream. */
 export interface OpenOptions {
-    /** The negotiated IETF version, which selects the varint encoding. */
-    version?: IetfVersion;
+    /** The negotiated version, which selects the varint encoding. */
+    version: StreamVersion;
     /**
      * The transport send order, where HIGHER values are transmitted first.
      * Left to the transport's default when unset.
@@ -50,8 +62,8 @@ export interface OpenOptions {
 }
 /** Options for {@link Writer.tryOpen}. */
 export interface TryOpenOptions extends OpenOptions {
-    /** Give up once this settles, however it settles. */
-    cancel: Promise<unknown>;
+    /** Give up once this resolves. */
+    cancel: Promise<void>;
 }
 export declare class Stream {
     reader: Reader;
@@ -60,45 +72,91 @@ export declare class Stream {
     constructor(props: {
         writable: WritableStream<Uint8Array>;
         readable: ReadableStream<Uint8Array>;
-        version?: IetfVersion;
+        version: StreamVersion;
     });
     /** Pair halves that were opened separately, as the SETUP exchange does. */
     constructor(props: {
         writer: Writer;
         reader: Reader;
     });
-    static accept(quic: WebTransport, version?: IetfVersion): Promise<Stream | undefined>;
+    static accept(quic: WebTransport, version: StreamVersion): Promise<Stream | undefined>;
     /**
      * Open an outgoing bidirectional stream.
      * @param quic - The session to open it on
      * @param options - The version its varints encode with, and the send order ranking it
      *   against the session's other streams
      */
-    static open(quic: WebTransport, options?: OpenOptions): Promise<Stream>;
+    static open(quic: WebTransport, options: OpenOptions): Promise<Stream>;
     close(): void;
     abort(reason: Error): void;
 }
 export declare class Reader {
     #private;
-    version?: IetfVersion;
-    constructor(stream: ReadableStream<Uint8Array>, buffer?: Uint8Array, version?: IetfVersion);
-    constructor(stream: undefined, buffer: Uint8Array, version?: IetfVersion);
+    version: StreamVersion;
+    constructor(stream: ReadableStream<Uint8Array>, buffer: Uint8Array | undefined, version: StreamVersion);
+    constructor(stream: undefined, buffer: Uint8Array, version: StreamVersion);
+    /**
+     * Run a synchronous decode over the buffered bytes and consume what it read.
+     *
+     * Returns undefined and consumes nothing when the decode ran past the buffered bytes, so a
+     * caller can drain every complete message already here without waiting on the stream.
+     */
+    tryDecode<T extends NonNullable<unknown>>(decode: (c: Cursor) => T): T | undefined;
+    /** Run a synchronous decode, filling from the stream until it has the bytes it needs. */
+    decode<T>(decode: (c: Cursor) => T): Promise<T>;
+    /** Like {@link decode}, but returns undefined if the stream ends cleanly first. */
+    decodeMaybe<T>(decode: (c: Cursor) => T): Promise<T | undefined>;
     read(size: number): Promise<Uint8Array>;
     readAll(): Promise<Uint8Array>;
+    discard(): Promise<void>;
     string(): Promise<string>;
     bool(): Promise<boolean>;
     u8(): Promise<number>;
     u16(): Promise<number>;
     u53(): Promise<number>;
     u62(): Promise<bigint>;
+    varint(): Promise<U64>;
     done(): Promise<boolean>;
     stop(reason: unknown): void;
     get closed(): Promise<void>;
 }
+/**
+ * A synchronous view over a {@link Reader}'s buffered bytes, handed to {@link Reader.decode}.
+ *
+ * A read past the buffered bytes throws an internal signal that the Reader catches: it consumes
+ * nothing, fills, and runs the decode again from the start. A decode must therefore not mutate
+ * anything before its last read, must not swallow what it throws, and must read at least a byte.
+ */
+export declare class Cursor {
+    #private;
+    readonly version: StreamVersion;
+    constructor(buffer: Uint8Array, version: StreamVersion);
+    /** How many bytes have been read. */
+    get offset(): number;
+    /** How many buffered bytes are left to read. */
+    get remaining(): number;
+    /**
+     * Decode the next `size` bytes on their own. Running past them, or leaving any unread, is
+     * malformed rather than a reason to wait for more.
+     */
+    exact<T>(size: number, decode: (c: Cursor) => T): T;
+    /** Read `size` bytes, as a view onto the buffer rather than a copy. */
+    read(size: number): Uint8Array;
+    string(): string;
+    bool(): boolean;
+    u8(): number;
+    u16(): number;
+    /** Read a varint as a `number`, throwing if it is above `Number.MAX_SAFE_INTEGER`. */
+    u53(): number;
+    /** Read a varint as a bigint. A leading-ones varint may exceed 62 bits. */
+    u62(): bigint;
+    /** Read a varint. */
+    varint(): U64;
+}
 export declare class Writer {
     #private;
-    version?: IetfVersion;
-    constructor(stream: WritableStream<Uint8Array>, version?: IetfVersion);
+    version: StreamVersion;
+    constructor(stream: WritableStream<Uint8Array>, version: StreamVersion);
     /**
      * Rank this stream against the session's others, where HIGHER values are sent first.
      *
@@ -116,6 +174,7 @@ export declare class Writer {
     i32(v: number): Promise<void>;
     u53(v: number): Promise<void>;
     u62(v: bigint): Promise<void>;
+    varint(v: U64): Promise<void>;
     write(v: Uint8Array): Promise<void>;
     string(str: string): Promise<void>;
     close(): void;
@@ -127,7 +186,7 @@ export declare class Writer {
      * @param options - The version its varints encode with, and the send order ranking it
      *   against the session's other streams
      */
-    static open(quic: WebTransport, options?: OpenOptions): Promise<Writer>;
+    static open(quic: WebTransport, options: OpenOptions): Promise<Writer>;
     /**
      * Like {@link Writer.open}, but gives up when `cancel` settles or `timeout` elapses,
      * returning undefined so the caller can drop whatever it meant to send. A stream that
@@ -140,7 +199,7 @@ export declare class Writer {
 }
 export declare class Readers {
     #private;
-    constructor(quic: WebTransport, version?: IetfVersion);
+    constructor(quic: WebTransport, version: StreamVersion);
     next(): Promise<Reader | undefined>;
     close(): void;
 }

package/stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AASrD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,6BAA6B,GAAG;IAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAAE,CAEnH;AA+BD;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7E,8CAA8C;AAC9C,MAAM,WAAW,WAAW;IAC3B,sEAAsE;IACtE,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,0CAA0C;AAC1C,MAAM,WAAW,cAAe,SAAQ,WAAW;IAClD,qDAAqD;IACrD,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CACzB;AAED,qBAAa,MAAM;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IAEf,iDAAiD;IACjD,YAAY,KAAK,EAAE;QAClB,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;QACrC,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;QACrC,OAAO,CAAC,EAAE,WAAW,CAAC;KACtB,EAAE;IACH,2EAA2E;IAC3E,YAAY,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE;IAgBvD,OAAa,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAW1F;IAED;;;;;OAKG;IACH,OAAa,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAU5E;IAED,KAAK,SAGJ;IAED,KAAK,CAAC,MAAM,EAAE,KAAK,QAGlB;CACD;AAID,qBAAa,MAAM;;IAKlB,OAAO,CAAC,EAAE,WAAW,CAAC;IAGtB,YAAY,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE;IAC5F,YAAY,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE;IAmEpE,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAK5C;IAEK,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAKnC;IAEK,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAI9B;IAEK,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAK7B;IAEK,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAG1B;IAEK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAM3B;IAGK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAO3B;IAGK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAK3B;IA6DK,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAG7B;IAED,IAAI,CAAC,MAAM,EAAE,OAAO,QAEnB;IAID,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAK1B;CACD;AAGD,qBAAa,MAAM;;IASlB,OAAO,CAAC,EAAE,WAAW,CAAC;IAEtB,YAAY,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,EAKpE;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,QAE5B;IAEK,IAAI,CAAC,CAAC,EAAE,OAAO,iBAEpB;IAEK,EAAE,CAAC,CAAC,EAAE,MAAM,iBAEjB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAElB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAQlB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAalB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAMlB;IAEK,KAAK,CAAC,CAAC,EAAE,UAAU,iBAMxB;IAEK,MAAM,CAAC,GAAG,EAAE,MAAM,iBAIvB;IAED,KAAK,SAEJ;IAID,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAK1B;IAED,KAAK,CAAC,MAAM,EAAE,OAAO,QAEpB;IAED;;;;;OAKG;IACH,OAAa,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAQ5E;IAED;;;;;;;OAOG;IACH,OAAa,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAuB7F;CACD;AAqBD,qBAAa,OAAO;;IAInB,YAAY,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,WAAW,EAKpD;IAEK,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAIxC;IAED,KAAK,SAEJ;CACD"}
+{"version":3,"file":"stream.d.ts","sourceRoot":"","sources":["../src/stream.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAAmB,KAAK,OAAO,IAAI,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEjF,OAAO,EAA6B,GAAG,EAAE,MAAM,eAAe,CAAC;AA2B/D;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,WAAW,GAAG,6BAA6B,GAAG;IAAE,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAAE,CAEnH;AAsBD;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,WAAW,GAAG,WAAW,CAAC;AAQtD,0HAA0H;AAC1H,wBAAgB,MAAM,CAAC,OAAO,EAAE,aAAa,GAAG,WAAW,GAAG,SAAS,CAEtE;AAiCD,iGAAiG;AACjG,wBAAgB,YAAY,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,UAAU,CAGnF;AAED;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAE7E,8CAA8C;AAC9C,MAAM,WAAW,WAAW;IAC3B,iEAAiE;IACjE,OAAO,EAAE,aAAa,CAAC;IAEvB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;;OAQG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,0CAA0C;AAC1C,MAAM,WAAW,cAAe,SAAQ,WAAW;IAClD,kCAAkC;IAClC,MAAM,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;CACtB;AAED,qBAAa,MAAM;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IAEf,iDAAiD;IACjD,YAAY,KAAK,EAAE;QAClB,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;QACrC,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,CAAC;QACrC,OAAO,EAAE,aAAa,CAAC;KACvB,EAAE;IACH,2EAA2E;IAC3E,YAAY,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE;IAkBvD,OAAa,MAAM,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAW3F;IAED;;;;;OAKG;IACH,OAAa,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAU3E;IAED,KAAK,SAMJ;IAED,KAAK,CAAC,MAAM,EAAE,KAAK,QAGlB;CACD;AAID,qBAAa,MAAM;;IAWlB,OAAO,EAAE,aAAa,CAAC;IAGvB,YAAY,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,MAAM,EAAE,UAAU,GAAG,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE;IACxG,YAAY,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAAE;IAwF3E;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,SAAS,CAGjF;IAED,yFAAyF;IACnF,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAMpD;IAED,mFAAmF;IAC7E,WAAW,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC,CAGrE;IA0BK,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC,CAG5C;IAEK,OAAO,IAAI,OAAO,CAAC,UAAU,CAAC,CAMnC;IAGK,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAM7B;IAEK,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAE9B;IAEK,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAE7B;IAEK,EAAE,IAAI,OAAO,CAAC,MAAM,CAAC,CAE1B;IAEK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAE3B;IAGK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAE3B;IAGK,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAE3B;IAEK,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,CAE3B;IAGK,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC,CAG7B;IAED,IAAI,CAAC,MAAM,EAAE,OAAO,QAEnB;IAID,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAK1B;CACD;AAeD;;;;;;GAMG;AACH,qBAAa,MAAM;;IAClB,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC;IAWhC,YAAY,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,aAAa,EAMrD;IAED,qCAAqC;IACrC,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,gDAAgD;IAChD,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED;;;OAGG;IACH,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,CAWlD;IAUD,uEAAuE;IACvE,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAK7B;IAED,MAAM,IAAI,MAAM,CAEf;IAED,IAAI,IAAI,OAAO,CAKd;IAED,EAAE,IAAI,MAAM,CAGX;IAED,GAAG,IAAI,MAAM,CAMZ;IAED,sFAAsF;IACtF,GAAG,IAAI,MAAM,CAyBZ;IAED,2EAA2E;IAC3E,GAAG,IAAI,MAAM,CAGZ;IAED,qBAAqB;IACrB,MAAM,IAAI,GAAG,CAGZ;CAuBD;AAYD,qBAAa,MAAM;;IAQlB,OAAO,EAAE,aAAa,CAAC;IAEvB,YAAY,MAAM,EAAE,cAAc,CAAC,UAAU,CAAC,EAAE,OAAO,EAAE,aAAa,EAKrE;IAED;;;;;;;;;OASG;IACH,WAAW,CAAC,SAAS,EAAE,MAAM,QAE5B;IAEK,IAAI,CAAC,CAAC,EAAE,OAAO,iBAEpB;IAEK,EAAE,CAAC,CAAC,EAAE,MAAM,iBAKjB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAElB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAQlB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAKlB;IAEK,GAAG,CAAC,CAAC,EAAE,MAAM,iBAGlB;IAEK,MAAM,CAAC,CAAC,EAAE,GAAG,iBAElB;IAMK,KAAK,CAAC,CAAC,EAAE,UAAU,iBAMxB;IAEK,MAAM,CAAC,GAAG,EAAE,MAAM,iBAIvB;IAED,KAAK,SAEJ;IAID,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAK1B;IAED,KAAK,CAAC,MAAM,EAAE,OAAO,QAEpB;IAED;;;;;OAKG;IACH,OAAa,IAAI,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,CAQ3E;IAED;;;;;;;OAOG;IACH,OAAa,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAyB7F;CACD;AAqBD,qBAAa,OAAO;;IAInB,YAAY,IAAI,EAAE,YAAY,EAAE,OAAO,EAAE,aAAa,EAKrD;IAEK,IAAI,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAIxC;IAED,KAAK,SAEJ;CACD"}