@webda/core 4.0.0-beta.6 → 4.0.0-beta.8

package/lib/contexts/streamingcontext.d.ts

@@ -0,0 +1,71 @@
+import { WebContext } from "./webcontext.js";
+/**
+ * A value as clients may see it: plain JSON without `__` keys
+ * @param value - an operation result or streamed chunk
+ * @returns the copy (undefined stays undefined), or null when the value is not JSON-serializable (function, symbol)
+ */
+export declare function toPublicChunk(value: unknown): unknown;
+/**
+ * The shared part of a context serving a streaming operation over a transport (gRPC, WebSocket, GraphQL
+ * subscription, ...):
+ *
+ * - a non-streamed result is buffered as usual (`writeResult()`)
+ * - a streamed chunk is sent right away (`sendChunk()`), `write()` returning false under backpressure
+ * - `drained()` waits for the transport (`waitForDrain()`) without leaving listeners behind: the signal it gets is
+ *   aborted once the wait is over
+ * - once cancelled (the client went away) or once the connection is over (`connectionEnded`), `write()` and
+ *   `drained()` throw `OperationCancelledError`
+ *
+ * The transport calls `cancel()` when the client leaves, and also ends the operation's input queue so its pending read
+ * returns and its `finally` blocks run.
+ */
+export declare abstract class StreamingOperationContext extends WebContext {
+    private cancelled;
+    /**
+     * @returns whether the client went away
+     */
+    get isCancelled(): boolean;
+    /** The client went away: the next write or drain throws. */
+    cancel(): void;
+    /**
+     * @returns true when nothing can be sent anymore although the context was not cancelled (response or socket over)
+     */
+    protected abstract get connectionEnded(): boolean;
+    /**
+     * Send one streamed chunk now
+     * @param chunk - what the operation wrote
+     * @returns false when the transport asks the operation to wait for `drained()`
+     */
+    protected abstract sendChunk(chunk: any): boolean;
+    /**
+     * Wait until the transport can take more output
+     * @param signal - aborted once the wait is over: listeners registered with it are removed
+     * @throws any error when the transport failed or closed (reported as `OperationCancelledError`)
+     */
+    protected abstract waitForDrain(signal: AbortSignal): Promise<void>;
+    /**
+     * Keep a non-streamed result
+     * @param output - the result
+     * @param encoding - the encoding to use
+     * @param cb - the callback function
+     * @returns true
+     */
+    protected writeResult(output: any, encoding?: string, cb?: (error: Error) => void): boolean;
+    /**
+     * @throws OperationCancelledError when the client went away or the connection is over
+     */
+    protected assertAlive(): void;
+    /**
+     * Streamed chunks go out immediately; a non-streamed result is buffered
+     * @override
+     * @throws OperationCancelledError when streaming and the client went away or the connection is over
+     */
+    write(output: any, encoding?: string, cb?: (error: Error) => void): boolean;
+    /**
+     * Wait for the transport to take more output, without leaving listeners behind
+     * @override
+     * @throws OperationCancelledError when the client went away, the connection is over or the transport failed
+     */
+    drained(): Promise<void>;
+}
+//# sourceMappingURL=streamingcontext.d.ts.map

package/lib/contexts/streamingcontext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamingcontext.d.ts","sourceRoot":"","sources":["../../src/contexts/streamingcontext.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAG7C;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAIrD;AAED;;;;;;;;;;;;;GAaG;AACH,8BAAsB,yBAA0B,SAAQ,UAAU;IAChE,OAAO,CAAC,SAAS,CAAS;IAE1B;;OAEG;IACH,IAAI,WAAW,IAAI,OAAO,CAEzB;IAED,4DAA4D;IAC5D,MAAM,IAAI,IAAI,CAEb;IAED;;OAEG;IACH,SAAS,CAAC,QAAQ,KAAK,eAAe,IAAI,OAAO,CAAC;IAElD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC;IAElD;;;;OAIG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpE;;;;;;OAMG;IACH,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAE1F;IAED;;OAEG;IACH,SAAS,CAAC,WAAW,IAAI,IAAI,CAI5B;IAED;;;;OAIG;IAEI,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAIjF;IAED;;;;OAIG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAY7B;CACF"}

package/lib/contexts/streamingcontext.js

@@ -0,0 +1,93 @@
+import { JSONUtils } from "@webda/utils";
+import { WebContext } from "./webcontext.js";
+import * as WebdaError from "../errors/errors.js";
+/**
+ * A value as clients may see it: plain JSON without `__` keys
+ * @param value - an operation result or streamed chunk
+ * @returns the copy (undefined stays undefined), or null when the value is not JSON-serializable (function, symbol)
+ */
+export function toPublicChunk(value) {
+    if (value === undefined)
+        return undefined;
+    const json = JSONUtils.stringify(value, undefined, 0, true);
+    return json === undefined ? null : JSON.parse(json);
+}
+/**
+ * The shared part of a context serving a streaming operation over a transport (gRPC, WebSocket, GraphQL
+ * subscription, ...):
+ *
+ * - a non-streamed result is buffered as usual (`writeResult()`)
+ * - a streamed chunk is sent right away (`sendChunk()`), `write()` returning false under backpressure
+ * - `drained()` waits for the transport (`waitForDrain()`) without leaving listeners behind: the signal it gets is
+ *   aborted once the wait is over
+ * - once cancelled (the client went away) or once the connection is over (`connectionEnded`), `write()` and
+ *   `drained()` throw `OperationCancelledError`
+ *
+ * The transport calls `cancel()` when the client leaves, and also ends the operation's input queue so its pending read
+ * returns and its `finally` blocks run.
+ */
+export class StreamingOperationContext extends WebContext {
+    cancelled = false;
+    /**
+     * @returns whether the client went away
+     */
+    get isCancelled() {
+        return this.cancelled;
+    }
+    /** The client went away: the next write or drain throws. */
+    cancel() {
+        this.cancelled = true;
+    }
+    /**
+     * Keep a non-streamed result
+     * @param output - the result
+     * @param encoding - the encoding to use
+     * @param cb - the callback function
+     * @returns true
+     */
+    writeResult(output, encoding, cb) {
+        return super.write(output, encoding, cb);
+    }
+    /**
+     * @throws OperationCancelledError when the client went away or the connection is over
+     */
+    assertAlive() {
+        if (this.cancelled || this.connectionEnded) {
+            throw new WebdaError.OperationCancelledError();
+        }
+    }
+    /**
+     * Streamed chunks go out immediately; a non-streamed result is buffered
+     * @override
+     * @throws OperationCancelledError when streaming and the client went away or the connection is over
+     */
+    // @ts-ignore same signature as WebContext.write
+    write(output, encoding, cb) {
+        if (!this.getExtension("operationStreaming"))
+            return this.writeResult(output, encoding, cb);
+        this.assertAlive();
+        return this.sendChunk(output);
+    }
+    /**
+     * Wait for the transport to take more output, without leaving listeners behind
+     * @override
+     * @throws OperationCancelledError when the client went away, the connection is over or the transport failed
+     */
+    async drained() {
+        this.assertAlive();
+        const controller = new AbortController();
+        try {
+            await this.waitForDrain(controller.signal);
+        }
+        catch (err) {
+            if (err instanceof WebdaError.OperationCancelledError)
+                throw err;
+            throw new WebdaError.OperationCancelledError();
+        }
+        finally {
+            controller.abort();
+        }
+        this.assertAlive();
+    }
+}
+//# sourceMappingURL=streamingcontext.js.map

package/lib/contexts/streamingcontext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streamingcontext.js","sourceRoot":"","sources":["../../src/contexts/streamingcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAElD;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc;IAC1C,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;IAC5D,OAAO,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACtD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAgB,yBAA0B,SAAQ,UAAU;IACxD,SAAS,GAAG,KAAK,CAAC;IAE1B;;OAEG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,4DAA4D;IAC5D,MAAM;QACJ,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;IACxB,CAAC;IAqBD;;;;;;OAMG;IACO,WAAW,CAAC,MAAW,EAAE,QAAiB,EAAE,EAA2B;QAC/E,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;OAEG;IACO,WAAW;QACnB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC3C,MAAM,IAAI,UAAU,CAAC,uBAAuB,EAAE,CAAC;QACjD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,gDAAgD;IACzC,KAAK,CAAC,MAAW,EAAE,QAAiB,EAAE,EAA2B;QACtE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC;YAAE,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC5F,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,WAAW,EAAE,CAAC;QACnB,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC7C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,GAAG,YAAY,UAAU,CAAC,uBAAuB;gBAAE,MAAM,GAAG,CAAC;YACjE,MAAM,IAAI,UAAU,CAAC,uBAAuB,EAAE,CAAC;QACjD,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,WAAW,EAAE,CAAC;IACrB,CAAC;CACF"}

package/lib/contexts/webcontext.d.ts

@@ -35,6 +35,10 @@ export declare class WebContext<T = any, P = any, U = any> extends OperationCont
     headers: Map<string, string>;
     _route: any;
     _ended: Promise<any>;
+    /**
+     * Whether the session was already saved
+     */
+    protected _sessionSaved: boolean;
     /**
      * If headers were flushed
      */
@@ -51,6 +55,11 @@ export declare class WebContext<T = any, P = any, U = any> extends OperationCont
      */
     getHttpContext(): HttpContext;
     /**
+     * Get the raw input as string
+     *
+     * Any WHATWG Encoding Standard label is accepted as encoding (utf-8, iso-8859-1, shift_jis, ...)
+     * If no encoding is given, the charset of the Content-Type header is used, falling back to UTF-8
+     *
      * @override
      */
     getRawInputAsString(limit?: number, timeout?: number, encoding?: string): Promise<string>;
@@ -114,6 +123,11 @@ export declare class WebContext<T = any, P = any, U = any> extends OperationCont
      * @returns the result map
      */
     getResponseCookies(): Map<string, Cookie>;
+    /**
+     * The Set-Cookie header values of the response, one per cookie
+     * @returns the serialized cookies
+     */
+    getSetCookieHeaders(): string[];
     /**
      * Whether the response has been ended
      * @returns the result
@@ -142,6 +156,12 @@ export declare class WebContext<T = any, P = any, U = any> extends OperationCont
      * @returns the result
      */
     getResponseSize(): number | undefined;
+    /**
+     * Save the session through the SessionManager, once
+     *
+     * The SessionManager writes the session cookie: call it before the headers are flushed
+     */
+    saveSession(): Promise<void>;
     /**
      * Flush the request
      *

package/lib/contexts/webcontext.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"webcontext.d.ts","sourceRoot":"","sources":["../../src/contexts/webcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAIjD;;GAEG;AACH,cAAM,MAAM;IACV,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,GAAG,CAAC;CACd;AAED;;;;;GAKG;AACH,qBAAa,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAClF;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC;IAEnD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,MAAM,EAAE,GAAG,CAAC;IAEZ,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAa;IAEjC;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC;IAElC,OAAO,CAAC,KAAK,CAAgB;IAE7B;;;OAGG;IACI,cAAc,CAAC,WAAW,EAAE,WAAW,QAG7C;IAED;;;OAGG;IACI,cAAc,IAAI,WAAW,CAEnC;IAED;;OAEG;IACG,mBAAmB,CACvB,KAAK,GAAE,MAAyB,EAChC,OAAO,GAAE,MAAc,EACvB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAEjB;IAED;;;;;OAKG;IACG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAKzF;IAED;;OAEG;IACG,WAAW,CAAC,KAAK,GAAE,MAAyB,EAAE,OAAO,GAAE,MAAc,oCAE1E;IAED;;OAEG;IACH,YAAY,IAAI,QAAQ,CAEvB;IAED;;OAEG;IACI,aAAa,SAGnB;IAED;;;;;;;;OAQG;IAEI,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAQ/E;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,mBAA+B,GAAG,IAAI,CAQjF;IAED;;;OAGG;IACH,eAAe,WAEd;IAED;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,QAEnB;IACD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,KAAA,EAAE,KAAK,KAAA,EAAE,OAAO,MAAY,QAMvC;IAED;;;OAGG;IACH,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAExC;IAED;;;OAGG;IACH,OAAO,iBAEN;IAED;;;;oCAIgC;IAEhC;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAGhC;IAED;;;;;OAKG;IACI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAG1B;IAED;;;OAGG;IACH,eAAe,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;;;;;OAMG;IACG,GAAG,iBA8BR;IAED;;;;OAIG;IACG,cAAc,CAClB,gBAAgB,GAAE,GAGjB,GACA,OAAO,CAAC,CAAC,CAAC,CAEZ;IAED;;;OAGG;IACH,eAAe,QAKd;IAED;;;;;OAKG;IACH,UAAU,IAAI,IAAI,CAAC,eAAe,CAoBjC;IAED;;;OAGG;IACH,SAAS,WAQR;IAED;;;OAGG;IACH,iBAAiB,YAEhB;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAAM,GAAE,OAAc,QAEvC;IAED;;;;OAIG;IACH;;;;;;;;OAQG;IACM,kBAAkB,IAAI,IAAI,CAAC,mBAAmB,CAEtD;IAED;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAUlC;IAED;;;OAGG;IACH,YACE,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,QAAoB,EAC5B,cAAc,GAAE,IAAI,CAAC,mBAA+B,EAYrD;IAED;;;;OAIG;IACG,IAAI,CAAC,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAchD;CACF"}
+{"version":3,"file":"webcontext.d.ts","sourceRoot":"","sources":["../../src/contexts/webcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAEzD,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAKjD;;GAEG;AACH,cAAM,MAAM;IACV,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,GAAG,CAAC;CACd;AAED;;;;;GAKG;AACH,qBAAa,UAAU,CAAC,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,GAAG,GAAG,CAAE,SAAQ,gBAAgB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;IAClF;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC;IAEnD;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7B,MAAM,EAAE,GAAG,CAAC;IAEZ,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,CAAa;IACjC;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,OAAO,CAAS;IAEzC;;OAEG;IACH,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC;IAElC,OAAO,CAAC,KAAK,CAAgB;IAE7B;;;OAGG;IACI,cAAc,CAAC,WAAW,EAAE,WAAW,QAG7C;IAED;;;OAGG;IACI,cAAc,IAAI,WAAW,CAEnC;IAED;;;;;;;OAOG;IACG,mBAAmB,CACvB,KAAK,GAAE,MAAyB,EAChC,OAAO,GAAE,MAAc,EACvB,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,MAAM,CAAC,CAEjB;IAED;;;;;OAKG;IACG,QAAQ,CAAC,gBAAgB,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAKzF;IAED;;OAEG;IACG,WAAW,CAAC,KAAK,GAAE,MAAyB,EAAE,OAAO,GAAE,MAAc,oCAE1E;IAED;;OAEG;IACH,YAAY,IAAI,QAAQ,CAEvB;IAED;;OAEG;IACI,aAAa,SAGnB;IAED;;;;;;;;OAQG;IAEI,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,OAAO,CAQ/E;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,GAAE,IAAI,CAAC,mBAA+B,GAAG,IAAI,CAQjF;IAED;;;OAGG;IACH,eAAe,WAEd;IAED;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,QAEnB;IACD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,KAAA,EAAE,KAAK,KAAA,EAAE,OAAO,MAAY,QAMvC;IAED;;;OAGG;IACH,kBAAkB,IAAI,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAExC;IAED;;;OAGG;IACH,mBAAmB,IAAI,MAAM,EAAE,CAE9B;IAED;;;OAGG;IACH,OAAO,iBAEN;IAED;;;;oCAIgC;IAEhC;;;;OAIG;IACI,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAGhC;IAED;;;;;OAKG;IACI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI,CAG1B;IAED;;;OAGG;IACH,eAAe,IAAI,MAAM,GAAG,SAAS,CAEpC;IAED;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC,CAWjC;IAED;;;;;;OAMG;IACG,GAAG,iBAuBR;IAED;;;;OAIG;IACG,cAAc,CAClB,gBAAgB,GAAE,GAGjB,GACA,OAAO,CAAC,CAAC,CAAC,CAEZ;IAED;;;OAGG;IACH,eAAe,QAKd;IAED;;;;;OAKG;IACH,UAAU,IAAI,IAAI,CAAC,eAAe,CAoBjC;IAED;;;OAGG;IACH,SAAS,WAQR;IAED;;;OAGG;IACH,iBAAiB,YAEhB;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAAM,GAAE,OAAc,QAEvC;IAED;;;;OAIG;IACH;;;;;;;;OAQG;IACM,kBAAkB,IAAI,IAAI,CAAC,mBAAmB,CAEtD;IAED;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAgBlC;IAED;;;OAGG;IACH,YACE,WAAW,EAAE,WAAW,EACxB,MAAM,GAAE,QAAoB,EAC5B,cAAc,GAAE,IAAI,CAAC,mBAA+B,EAYrD;IAED;;;;OAIG;IACG,IAAI,CAAC,KAAK,GAAE,OAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAchD;CACF"}

package/lib/contexts/webcontext.js

@@ -2,6 +2,7 @@ import { OperationContext } from "./operationcontext.js";
 import acceptLanguage from "accept-language";
 import { Readable } from "node:stream";
 import { WritableStreamBuffer } from "stream-buffers";
+import { serialize as cookieSerialize } from "cookie";
 import { useCore, useDynamicService, useService } from "../core/hooks.js";
 /**
  * @category CoreFeatures
@@ -36,6 +37,10 @@ export class WebContext extends OperationContext {
     headers;
     _route;
     _ended = undefined;
+    /**
+     * Whether the session was already saved
+     */
+    _sessionSaved = false;
     /**
      * If headers were flushed
      */
@@ -57,6 +62,11 @@ export class WebContext extends OperationContext {
         return this.getExtension("http");
     }
     /**
+     * Get the raw input as string
+     *
+     * Any WHATWG Encoding Standard label is accepted as encoding (utf-8, iso-8859-1, shift_jis, ...)
+     * If no encoding is given, the charset of the Content-Type header is used, falling back to UTF-8
+     *
      * @override
      */
     async getRawInputAsString(limit = 1024 * 1024 * 10, timeout = 60000, encoding) {
@@ -163,6 +173,13 @@ export class WebContext extends OperationContext {
     getResponseCookies() {
         return this._cookie;
     }
+    /**
+     * The Set-Cookie header values of the response, one per cookie
+     * @returns the serialized cookies
+     */
+    getSetCookieHeaders() {
+        return Object.values(this._cookie ?? {}).map((c) => cookieSerialize(c.name, c.value, c.options));
+    }
     /**
      * Whether the response has been ended
      * @returns the result
@@ -201,6 +218,25 @@ export class WebContext extends OperationContext {
     getResponseSize() {
         return this._body ? Buffer.byteLength(this._body, "utf8") : undefined;
     }
+    /**
+     * Save the session through the SessionManager, once
+     *
+     * The SessionManager writes the session cookie: call it before the headers are flushed
+     */
+    async saveSession() {
+        if (this._sessionSaved || !this.getExtension("http") || !this.session) {
+            return;
+        }
+        this._sessionSaved = true;
+        try {
+            const sm = useDynamicService("SessionManager");
+            if (sm)
+                await sm.save(this, this.session);
+        }
+        catch {
+            // SessionManager may not be available
+        }
+    }
     /**
      * Flush the request
      *
@@ -214,16 +250,7 @@ export class WebContext extends OperationContext {
             return this._ended;
         }
         this._ended = (async () => {
-            if (this.getExtension("http") && this.session) {
-                try {
-                    const sm = useDynamicService("SessionManager");
-                    if (sm)
-                        await sm.save(this, this.session);
-                }
-                catch {
-                    // SessionManager may not be available
-                }
-            }
+            await this.saveSession();
             await super.end();
             if (this._stream instanceof WritableStreamBuffer && this._stream.size()) {
                 this._body = this._stream.getContents().toString();
@@ -340,7 +367,13 @@ export class WebContext extends OperationContext {
     async flushHeaders() {
         if (this.flushed)
             return;
+        // The SessionManager writes the session cookie: save the session before the headers leave
+        await this.saveSession();
         const headers = this.getResponseHeaders();
+        const setCookies = this.getSetCookieHeaders();
+        if (setCookies.length) {
+            headers["Set-Cookie"] = setCookies;
+        }
         await super.flushHeaders();
         // Write to ServerResponse if the stream supports writeHead (not a WritableStreamBuffer)
         if (this._stream && !(this._stream instanceof WritableStreamBuffer) && typeof this._stream.writeHead === "function") {

package/lib/contexts/webcontext.js.map

@@ -1 +1 @@
-{"version":3,"file":"webcontext.js","sourceRoot":"","sources":["../../src/contexts/webcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,cAAc,MAAM,iBAAiB,CAAC;AAG7C,OAAO,EAAE,QAAQ,EAAY,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM;IACV,IAAI,CAAS;IACb,KAAK,CAAS;IACd,OAAO,CAAM;CACd;AAED;;;;;GAKG;AACH,MAAM,OAAO,UAAsC,SAAQ,gBAAyB;IAClF;;OAEG;IACO,cAAc,CAA2B;IAEnD;;OAEG;IACH,UAAU,CAAS;IACnB;;OAEG;IACH,OAAO,CAAsB;IAC7B;;OAEG;IACH,OAAO,CAAsB;IAC7B,MAAM,CAAM;IAEZ,MAAM,GAAiB,SAAS,CAAC;IAEjC;;OAEG;IACO,cAAc,CAAU;IAE1B,KAAK,CAAgB;IAE7B;;;OAGG;IACI,cAAc,CAAC,WAAwB;QAC5C,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,YAAY,CAAc,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB,CACvB,KAAK,GAAW,IAAI,GAAG,IAAI,GAAG,EAAE,EAChC,OAAO,GAAW,KAAK,EACvB,QAAiB;QAEjB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,gBAA8D;QAC3E,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YACtG,OAAO,gBAAgB,EAAE,YAAY,CAAC;QACxC,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,KAAK,GAAW,IAAI,GAAG,IAAI,GAAG,EAAE,EAAE,OAAO,GAAW,KAAK;QACzE,OAAO,CAAC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,YAAY,EAAE,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,KAAK,CAAC,aAAa,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa;IACN,KAAK,CAAC,MAAS,EAAE,QAAiB,EAAE,EAA2B;QACpE,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACxB,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,YAAY,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC3F,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAkB,EAAE,OAAO,GAA6B,SAAS;QACzE,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACrD,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,GAAW;QAClB,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;IACzC,CAAC;IACD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;QACtC,cAAc;QACd,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;oCAIgC;IAEhC;;;;OAIG;IACI,MAAM,CAAC,IAAY;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,GAAQ;QAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG;QACP,cAAc;QACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACxB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC9C,IAAI,CAAC;oBACH,MAAM,EAAE,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;oBAC/C,IAAI,EAAE;wBAAE,MAAO,EAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;gBACrD,CAAC;gBAAC,MAAM,CAAC;oBACP,sCAAsC;gBACxC,CAAC;YACH,CAAC;YACD,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,OAAO,YAAY,oBAAoB,IAA2B,IAAI,CAAC,OAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;gBAChG,IAAI,CAAC,KAAK,GAA0B,IAAI,CAAC,OAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC3E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;YAClE,CAAC;YACD,qDAAqD;YACrD,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,YAAY,oBAAoB,CAAC,IAAI,CAAE,IAAI,CAAC,OAAe,CAAC,aAAa,EAAE,CAAC;gBAC5G,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACd,IAAI,CAAC,OAAe,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACL,IAAI,CAAC,OAAe,CAAC,GAAG,EAAE,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAClB,gBAAgB,GAAQ;QACtB,WAAW,EAAE,EAAE;QACf,iBAAiB,EAAE,EAAE;KACtB;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,YAAY,oBAAoB,EAAE,CAAC;YAChE,OAA8B,IAAI,CAAC,OAAQ,CAAC,WAAW,EAAE,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,UAAU;QACR,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;QACtE,OAAuC;YACrC,gBAAgB,EAAE,CAAC;YACnB,gBAAgB,EAAE,CAAC;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE;YACzC,UAAU,EAAE,EAAE,EAAE,2CAA2C;YAC3D,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;gBAC7B,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC7B,CAAC;YACD,MAAM,EAAE,SAAS;YACjB,UAAU,EAAE,GAAG;YACf,QAAQ,EAAE,EAAE;YACZ,GAAG,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE;YACnC,UAAU,EAAE,SAAS;YACrB,GAAG,MAAM;SACT,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,MAAM,OAAO,GAAG,OAAO,EAAE,CAAC,UAAU,EAAE,CAAC;QACvC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QACxE,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAAM,GAAY,IAAI;QACtC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH;;;;;;;;OAQG;IACM,kBAAkB;QACzB,OAAO,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,kBAAkB,EAAE,EAAE,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1C,MAAM,KAAK,CAAC,YAAY,EAAE,CAAC;QAC3B,wFAAwF;QACxF,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,YAAY,oBAAoB,CAAC,IAAI,OAAQ,IAAI,CAAC,OAAe,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7H,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,OAAe,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,YACE,WAAwB,EACxB,MAAM,GAAa,SAAS,EAC5B,cAAc,GAA6B,SAAS;QAEpD,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI;YACtC,mEAAmE;YACnE,wDAAwD;YACxD,eAAe,EAAE,SAAS;SAC3B,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,GAAY,KAAK;QAC/B,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YAC3B,uBAAuB;YACvB,uCAAuC;YACvC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5E,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}
+{"version":3,"file":"webcontext.js","sourceRoot":"","sources":["../../src/contexts/webcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,cAAc,MAAM,iBAAiB,CAAC;AAG7C,OAAO,EAAE,QAAQ,EAAY,MAAM,aAAa,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,SAAS,IAAI,eAAe,EAAE,MAAM,QAAQ,CAAC;AACtD,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE1E;;GAEG;AACH,MAAM,MAAM;IACV,IAAI,CAAS;IACb,KAAK,CAAS;IACd,OAAO,CAAM;CACd;AAED;;;;;GAKG;AACH,MAAM,OAAO,UAAsC,SAAQ,gBAAyB;IAClF;;OAEG;IACO,cAAc,CAA2B;IAEnD;;OAEG;IACH,UAAU,CAAS;IACnB;;OAEG;IACH,OAAO,CAAsB;IAC7B;;OAEG;IACH,OAAO,CAAsB;IAC7B,MAAM,CAAM;IAEZ,MAAM,GAAiB,SAAS,CAAC;IACjC;;OAEG;IACO,aAAa,GAAY,KAAK,CAAC;IAEzC;;OAEG;IACO,cAAc,CAAU;IAE1B,KAAK,CAAgB;IAE7B;;;OAGG;IACI,cAAc,CAAC,WAAwB;QAC5C,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,cAAc;QACnB,OAAO,IAAI,CAAC,YAAY,CAAc,MAAM,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,mBAAmB,CACvB,KAAK,GAAW,IAAI,GAAG,IAAI,GAAG,EAAE,EAChC,OAAO,GAAW,KAAK,EACvB,QAAiB;QAEjB,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,kBAAkB,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC5E,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,gBAA8D;QAC3E,IAAI,IAAI,CAAC,cAAc,EAAE,EAAE,eAAe,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;YACtG,OAAO,gBAAgB,EAAE,YAAY,CAAC;QACxC,CAAC;QACD,OAAO,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,KAAK,GAAW,IAAI,GAAG,IAAI,GAAG,EAAE,EAAE,OAAO,GAAW,KAAK;QACzE,OAAO,CAAC,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACrF,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,IAAI,CAAC,cAAc,EAAE,CAAC,YAAY,EAAE,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,aAAa;QAClB,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;QACzB,KAAK,CAAC,aAAa,EAAE,CAAC;IACxB,CAAC;IAED;;;;;;;;OAQG;IACH,aAAa;IACN,KAAK,CAAC,MAAS,EAAE,QAAiB,EAAE,EAA2B;QACpE,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,EAAE,CAAC;YAC5B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACxB,CAAC;QACD,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,YAAY,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,EAAE,CAAC;YAC3F,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,KAAK,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,EAAE,EAAE,CAAC,CAAC;IAC3C,CAAC;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,UAAkB,EAAE,OAAO,GAA6B,SAAS;QACzE,MAAM,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACrD,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,UAAU,IAAI,GAAG,CAAC;IAChC,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,GAAW;QAClB,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC;IACzC,CAAC;IACD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,GAAG,SAAS;QACtC,cAAc;QACd,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,mBAAmB;QACjB,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;IAC3G,CAAC;IAED;;;OAGG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;oCAIgC;IAEhC;;;;OAIG;IACI,MAAM,CAAC,IAAY;QACxB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;QACvB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACI,IAAI,CAAC,GAAQ;QAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACtE,OAAO;QACT,CAAC;QACD,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC1B,IAAI,CAAC;YACH,MAAM,EAAE,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,CAAC;YAC/C,IAAI,EAAE;gBAAE,MAAO,EAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,CAAC;QAAC,MAAM,CAAC;YACP,sCAAsC;QACxC,CAAC;IACH,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,GAAG;QACP,cAAc;QACd,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;YAChB,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,IAAI,EAAE;YACxB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACzB,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,OAAO,YAAY,oBAAoB,IAA2B,IAAI,CAAC,OAAQ,CAAC,IAAI,EAAE,EAAE,CAAC;gBAChG,IAAI,CAAC,KAAK,GAA0B,IAAI,CAAC,OAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC;gBAC3E,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC;YAClE,CAAC;YACD,qDAAqD;YACrD,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,YAAY,oBAAoB,CAAC,IAAI,CAAE,IAAI,CAAC,OAAe,CAAC,aAAa,EAAE,CAAC;gBAC5G,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACd,IAAI,CAAC,OAAe,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACL,IAAI,CAAC,OAAe,CAAC,GAAG,EAAE,CAAC;gBAC9B,CAAC;YACH,CAAC;QACH,CAAC,CAAC,EAAE,CAAC;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,cAAc,CAClB,gBAAgB,GAAQ;QACtB,WAAW,EAAE,EAAE;QACf,iBAAiB,EAAE,EAAE;KACtB;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IACzC,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,IAAI,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,OAAO,YAAY,oBAAoB,EAAE,CAAC;YAChE,OAA8B,IAAI,CAAC,OAAQ,CAAC,WAAW,EAAE,CAAC;QAC5D,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;;OAKG;IACH,UAAU;QACR,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC;QACtE,OAAuC;YACrC,gBAAgB,EAAE,CAAC;YACnB,gBAAgB,EAAE,CAAC;YACnB,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,WAAW,EAAE,KAAK;YAClB,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE;YACzC,UAAU,EAAE,EAAE,EAAE,2CAA2C;YAC3D,WAAW,EAAE,EAAE;YACf,UAAU,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,EAAE;gBAC7B,UAAU,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC7B,CAAC;YACD,MAAM,EAAE,SAAS;YACjB,UAAU,EAAE,GAAG;YACf,QAAQ,EAAE,EAAE;YACZ,GAAG,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,MAAM,EAAE;YACnC,UAAU,EAAE,SAAS;YACrB,GAAG,MAAM;SACT,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,MAAM,OAAO,GAAG,OAAO,EAAE,CAAC,UAAU,EAAE,CAAC;QACvC,cAAc,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC,eAAe,CAAC,iBAAiB,CAAC,CAAC;QACxE,IAAI,MAAM,EAAE,CAAC;YACX,OAAO,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QACpC,CAAC;QACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,iBAAiB;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,MAAM,GAAY,IAAI;QACtC,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC;IAC/B,CAAC;IAED;;;;OAIG;IACH;;;;;;;;OAQG;IACM,kBAAkB;QACzB,OAAO,EAAE,GAAG,IAAI,CAAC,cAAc,EAAE,GAAG,KAAK,CAAC,kBAAkB,EAAE,EAAE,CAAC;IACnE,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,YAAY;QAChB,IAAI,IAAI,CAAC,OAAO;YAAE,OAAO;QACzB,0FAA0F;QAC1F,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC9C,IAAI,UAAU,CAAC,MAAM,EAAE,CAAC;YACtB,OAAO,CAAC,YAAY,CAAC,GAAG,UAAU,CAAC;QACrC,CAAC;QACD,MAAM,KAAK,CAAC,YAAY,EAAE,CAAC;QAC3B,wFAAwF;QACxF,IAAI,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,YAAY,oBAAoB,CAAC,IAAI,OAAQ,IAAI,CAAC,OAAe,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;YAC7H,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;YAC1B,IAAI,CAAC,OAAe,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC;QACnE,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,YACE,WAAwB,EACxB,MAAM,GAAa,SAAS,EAC5B,cAAc,GAA6B,SAAS;QAEpD,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QACjC,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI;YACtC,mEAAmE;YACnE,wDAAwD;YACxD,eAAe,EAAE,SAAS;SAC3B,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,IAAI,CAAC,KAAK,GAAY,KAAK;QAC/B,IAAI,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC,KAAK,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YAC3B,uBAAuB;YACvB,uCAAuC;YACvC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAC7B,CAAC,CAAC,CAAC;QACH,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,UAAU,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC5E,CAAC;QACD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF"}

package/lib/contexts/websocketcontext.d.ts

@@ -0,0 +1,39 @@
+import type { WebSocket } from "ws";
+import { HttpContext } from "./httpcontext.js";
+import { StreamingOperationContext } from "./streamingcontext.js";
+import type { Session } from "../session/session.js";
+/**
+ * The context of a bidirectional operation served over a WebSocket: the upgrade request's headers and session,
+ * each streamed chunk sent as one JSON text message.
+ */
+export declare class WebSocketOperationContext extends StreamingOperationContext {
+    private readonly socket;
+    private lastSend;
+    /**
+     * @param httpContext - the upgrade request
+     * @param socket - the accepted socket
+     * @param session - the session already loaded for the upgrade request, if any
+     */
+    constructor(httpContext: HttpContext, socket: WebSocket, session?: Session);
+    /**
+     * The session of an authorized upgrade is reused, not loaded twice
+     * @override
+     */
+    init(): Promise<this>;
+    /**
+     * The socket is closing or closed
+     * @override
+     */
+    protected get connectionEnded(): boolean;
+    /**
+     * One JSON text message per chunk
+     * @override
+     */
+    protected sendChunk(chunk: any): boolean;
+    /**
+     * Wait for the last message to be flushed, or the socket to close
+     * @override
+     */
+    protected waitForDrain(signal: AbortSignal): Promise<void>;
+}
+//# sourceMappingURL=websocketcontext.d.ts.map

package/lib/contexts/websocketcontext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocketcontext.d.ts","sourceRoot":"","sources":["../../src/contexts/websocketcontext.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AASrD;;;GAGG;AACH,qBAAa,yBAA0B,SAAQ,yBAAyB;IAUpE,OAAO,CAAC,QAAQ,CAAC,MAAM;IATzB,OAAO,CAAC,QAAQ,CAAoC;IAEpD;;;;OAIG;IACH,YACE,WAAW,EAAE,WAAW,EACP,MAAM,EAAE,SAAS,EAClC,OAAO,CAAC,EAAE,OAAO,EAIlB;IAED;;;OAGG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;IAED;;;OAGG;IACH,SAAS,KAAK,eAAe,IAAI,OAAO,CAEvC;IAED;;;OAGG;IACH,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,OAAO,CAQvC;IAED;;;OAGG;IACH,UAAgB,YAAY,CAAC,MAAM,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAO/D;CACF"}

package/lib/contexts/websocketcontext.js

@@ -0,0 +1,67 @@
+import { once } from "node:events";
+import { JSONUtils } from "@webda/utils";
+import { StreamingOperationContext } from "./streamingcontext.js";
+import * as WebdaError from "../errors/errors.js";
+/** Pending output (bytes) above which write() asks the operation to wait. */
+const HIGH_WATER = 1024 * 1024;
+/** WebSocket readyState values after which nothing can be sent (CLOSING, CLOSED) */
+const CLOSING = 2;
+/**
+ * The context of a bidirectional operation served over a WebSocket: the upgrade request's headers and session,
+ * each streamed chunk sent as one JSON text message.
+ */
+export class WebSocketOperationContext extends StreamingOperationContext {
+    socket;
+    lastSend = Promise.resolve();
+    /**
+     * @param httpContext - the upgrade request
+     * @param socket - the accepted socket
+     * @param session - the session already loaded for the upgrade request, if any
+     */
+    constructor(httpContext, socket, session) {
+        super(httpContext);
+        this.socket = socket;
+        if (session)
+            this.session = session;
+    }
+    /**
+     * The session of an authorized upgrade is reused, not loaded twice
+     * @override
+     */
+    async init() {
+        return this.session ? this : super.init();
+    }
+    /**
+     * The socket is closing or closed
+     * @override
+     */
+    get connectionEnded() {
+        return this.socket.readyState >= CLOSING;
+    }
+    /**
+     * One JSON text message per chunk
+     * @override
+     */
+    sendChunk(chunk) {
+        const text = JSONUtils.stringify(chunk, undefined, 0, true);
+        const sent = new Promise((resolve, reject) => this.socket.send(text, err => (err ? reject(err) : resolve())));
+        sent.catch(() => {
+            // reported through drained()
+        });
+        this.lastSend = sent;
+        return this.socket.bufferedAmount < HIGH_WATER;
+    }
+    /**
+     * Wait for the last message to be flushed, or the socket to close
+     * @override
+     */
+    async waitForDrain(signal) {
+        await Promise.race([
+            this.lastSend,
+            once(this.socket, "close", { signal }).then(() => {
+                throw new WebdaError.OperationCancelledError();
+            })
+        ]);
+    }
+}
+//# sourceMappingURL=websocketcontext.js.map

package/lib/contexts/websocketcontext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"websocketcontext.js","sourceRoot":"","sources":["../../src/contexts/websocketcontext.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAC;AAElE,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAElD,6EAA6E;AAC7E,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI,CAAC;AAE/B,oFAAoF;AACpF,MAAM,OAAO,GAAG,CAAC,CAAC;AAElB;;;GAGG;AACH,MAAM,OAAO,yBAA0B,SAAQ,yBAAyB;IAUnD,MAAM;IATjB,QAAQ,GAAkB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEpD;;;;OAIG;IACH,YACE,WAAwB,EACP,MAAiB,EAClC,OAAiB;QAEjB,KAAK,CAAC,WAAW,CAAC,CAAC;sBAHF,MAAM;QAIvB,IAAI,OAAO;YAAE,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IAC5C,CAAC;IAED;;;OAGG;IACH,IAAc,eAAe;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,OAAO,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACO,SAAS,CAAC,KAAU;QAC5B,MAAM,IAAI,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QACpH,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE;YACd,6BAA6B;QAC/B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAC,cAAc,GAAG,UAAU,CAAC;IACjD,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,YAAY,CAAC,MAAmB;QAC9C,MAAM,OAAO,CAAC,IAAI,CAAC;YACjB,IAAI,CAAC,QAAQ;YACb,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBAC/C,MAAM,IAAI,UAAU,CAAC,uBAAuB,EAAE,CAAC;YACjD,CAAC,CAAC;SACH,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/core/asyncqueue.d.ts

@@ -0,0 +1,50 @@
+/**
+ * A push-based async iterable: producers push, one consumer iterates. `end()` (or the consumer leaving the loop)
+ * finishes it; items pushed after the end are dropped.
+ */
+export declare class AsyncQueue<T> implements AsyncIterable<T> {
+    private items;
+    private waiters;
+    private done;
+    private sizes;
+    private bytes;
+    private readonly size?;
+    /**
+     * @param options - optional settings
+     * @param options.size - measures an item in bytes, to track `pendingBytes`
+     */
+    constructor(options?: {
+        size?: (item: T) => number;
+    });
+    /**
+     * @returns whether the queue is finished
+     */
+    get ended(): boolean;
+    /**
+     * @param item - the next item
+     * @param size - its size in bytes (defaults to the size function's result)
+     */
+    push(item: T, size?: number): void;
+    /**
+     * @returns the size of the items pushed and not yet consumed (0 when no size is given)
+     */
+    get pendingBytes(): number;
+    /**
+     * @returns the number of items pushed and not yet consumed
+     */
+    get pending(): number;
+    /**
+     * No more items.
+     * @param discard - also drop the items not consumed yet
+     */
+    end(discard?: boolean): void;
+    /**
+     * @returns the next item, without ending the queue (unlike breaking out of a for await)
+     */
+    next(): Promise<IteratorResult<T>>;
+    /**
+     * @returns the iterator
+     */
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+}
+//# sourceMappingURL=asyncqueue.d.ts.map

package/lib/core/asyncqueue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncqueue.d.ts","sourceRoot":"","sources":["../../src/core/asyncqueue.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,qBAAa,UAAU,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC;IACpD,OAAO,CAAC,KAAK,CAAW;IACxB,OAAO,CAAC,OAAO,CAA+C;IAC9D,OAAO,CAAC,IAAI,CAAS;IACrB,OAAO,CAAC,KAAK,CAAgB;IAC7B,OAAO,CAAC,KAAK,CAAK;IAClB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAsB;IAE5C;;;OAGG;IACH,YAAY,OAAO,GAAE;QAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAA;KAAO,EAEvD;IAED;;OAEG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED;;;OAGG;IACH,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAUjC;IAED;;OAEG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;OAEG;IACH,IAAI,OAAO,IAAI,MAAM,CAEpB;IAED;;;OAGG;IACH,GAAG,CAAC,OAAO,GAAE,OAAe,GAAG,IAAI,CASlC;IAED;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAQjC;IAED;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC,CAQzC;CACF"}

package/lib/core/asyncqueue.js

@@ -0,0 +1,96 @@
+/**
+ * A push-based async iterable: producers push, one consumer iterates. `end()` (or the consumer leaving the loop)
+ * finishes it; items pushed after the end are dropped.
+ */
+export class AsyncQueue {
+    items = [];
+    waiters = [];
+    done = false;
+    sizes = [];
+    bytes = 0;
+    size;
+    /**
+     * @param options - optional settings
+     * @param options.size - measures an item in bytes, to track `pendingBytes`
+     */
+    constructor(options = {}) {
+        this.size = options.size;
+    }
+    /**
+     * @returns whether the queue is finished
+     */
+    get ended() {
+        return this.done;
+    }
+    /**
+     * @param item - the next item
+     * @param size - its size in bytes (defaults to the size function's result)
+     */
+    push(item, size) {
+        if (this.done)
+            return;
+        const waiter = this.waiters.shift();
+        if (waiter)
+            waiter({ value: item, done: false });
+        else {
+            const bytes = size ?? this.size?.(item) ?? 0;
+            this.items.push(item);
+            this.sizes.push(bytes);
+            this.bytes += bytes;
+        }
+    }
+    /**
+     * @returns the size of the items pushed and not yet consumed (0 when no size is given)
+     */
+    get pendingBytes() {
+        return this.bytes;
+    }
+    /**
+     * @returns the number of items pushed and not yet consumed
+     */
+    get pending() {
+        return this.items.length;
+    }
+    /**
+     * No more items.
+     * @param discard - also drop the items not consumed yet
+     */
+    end(discard = false) {
+        if (discard) {
+            this.items.length = 0;
+            this.sizes.length = 0;
+            this.bytes = 0;
+        }
+        if (this.done)
+            return;
+        this.done = true;
+        for (const waiter of this.waiters.splice(0))
+            waiter({ value: undefined, done: true });
+    }
+    /**
+     * @returns the next item, without ending the queue (unlike breaking out of a for await)
+     */
+    next() {
+        if (this.items.length > 0) {
+            const value = this.items.shift();
+            this.bytes -= this.sizes.shift();
+            return Promise.resolve({ value, done: false });
+        }
+        if (this.done)
+            return Promise.resolve({ value: undefined, done: true });
+        return new Promise(resolve => this.waiters.push(resolve));
+    }
+    /**
+     * @returns the iterator
+     */
+    [Symbol.asyncIterator]() {
+        return {
+            next: () => this.next(),
+            return: async () => {
+                this.end();
+                return { value: undefined, done: true };
+            }
+        };
+    }
+}
+//# sourceMappingURL=asyncqueue.js.map

package/lib/core/asyncqueue.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"asyncqueue.js","sourceRoot":"","sources":["../../src/core/asyncqueue.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,UAAU;IACb,KAAK,GAAQ,EAAE,CAAC;IAChB,OAAO,GAA4C,EAAE,CAAC;IACtD,IAAI,GAAG,KAAK,CAAC;IACb,KAAK,GAAa,EAAE,CAAC;IACrB,KAAK,GAAG,CAAC,CAAC;IACD,IAAI,CAAuB;IAE5C;;;OAGG;IACH,YAAY,OAAO,GAAmC,EAAE;QACtD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,IAAO,EAAE,IAAa;QACzB,IAAI,IAAI,CAAC,IAAI;YAAE,OAAO;QACtB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACpC,IAAI,MAAM;YAAE,MAAM,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;aAC5C,CAAC;YACJ,MAAM,KAAK,GAAG,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC7C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACtB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;IAED;;OAEG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAED;;;OAGG;IACH,GAAG,CAAC,OAAO,GAAY,KAAK;QAC1B,IAAI,OAAO,EAAE,CAAC;YACZ,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;YACtB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACjB,CAAC;QACD,IAAI,IAAI,CAAC,IAAI;YAAE,OAAO;QACtB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;YAAE,MAAM,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IACxF,CAAC;IAED;;OAEG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAG,CAAC;YAClC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,EAAG,CAAC;YAClC,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;QACjD,CAAC;QACD,IAAI,IAAI,CAAC,IAAI;YAAE,OAAO,OAAO,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;QACxE,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACH,CAAC,MAAM,CAAC,aAAa,CAAC;QACpB,OAAO;YACL,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE;YACvB,MAAM,EAAE,KAAK,IAAI,EAAE;gBACjB,IAAI,CAAC,GAAG,EAAE,CAAC;gBACX,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;YAC1C,CAAC;SACF,CAAC;IACJ,CAAC;CACF"}