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

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,CAAC;AACtB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAErG,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qDAAqD,CAAC;AACpE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,uBAAuB,CAAC;AACtC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,iBAAiB,CAAC;AAChC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mCAAmC,CAAC;AAClD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAC;AACrC,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,UAAU,EAAE,CAAC;AACtB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,iBAAiB,CAAC;AAChC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,sBAAsB,CAAC;AACrC,cAAc,sBAAsB,CAAC;AACrC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAErG,cAAc,mBAAmB,CAAC;AAClC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,0BAA0B,CAAC;AACzC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wBAAwB,CAAC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,qDAAqD,CAAC;AACpE,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,uBAAuB,CAAC;AACtC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,kCAAkC,CAAC;AACjD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qCAAqC,CAAC;AACpD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC;AAChD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2CAA2C,CAAC;AAC1D,cAAc,iBAAiB,CAAC;AAChC,cAAc,2CAA2C,CAAC;AAC1D,cAAc,mCAAmC,CAAC;AAClD,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC"}

package/lib/rest/restoperationstransport.service.d.ts

@@ -1,7 +1,11 @@
 import { TransformCaseType } from "@webda/utils";
 import { OperationsTransport, OperationsTransportParameters } from "../services/operationstransport.js";
 import { OperationDefinition } from "../core/icore.js";
+import { useInstanceStorage } from "../core/instancestorage.js";
 import { WebContext } from "../contexts/webcontext.js";
+import type { IncomingMessage, Server, ServerResponse } from "node:http";
+import type { Duplex } from "node:stream";
+import { type WebSocket } from "ws";
 import type { ModelClass } from "@webda/models";
 import type { ModelAction } from "../models/types.js";
 import type { ModelGraphBehaviorDefinition, ModelMetadata } from "@webda/compiler";
@@ -42,6 +46,31 @@ export declare class RESTOperationsTransportParameters extends OperationsTranspo
      * @default "PUT"
      */
     queryMethod?: "PUT" | "GET";
+    /**
+     * Largest message (bytes) a client may send on a bidirectional WebSocket operation; a bigger one closes the socket
+     *
+     * @default 1048576
+     */
+    webSocketMaxPayload?: number;
+    /**
+     * Most unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413
+     *
+     * @default 1000
+     */
+    webSocketMaxQueuedMessages?: number;
+    /**
+     * Most bytes of unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413
+     *
+     * @default 16777216
+     */
+    webSocketMaxQueuedBytes?: number;
+    /**
+     * Milliseconds between two keep-alive comments on an open `text/event-stream` response of a server-streaming
+     * operation (0 disables them)
+     *
+     * @default 20000
+     */
+    streamKeepAliveInterval?: number;
     /**
      * Load parameters with defaults
      * @param params - the service parameters
@@ -49,6 +78,13 @@ export declare class RESTOperationsTransportParameters extends OperationsTranspo
      */
     load(params?: any): this;
 }
+/**
+ * Truncate a string to a number of UTF-8 bytes without cutting a character (a close reason holds 123 bytes)
+ * @param text - the text
+ * @param max - the maximum byte length
+ * @returns the truncated text
+ */
+export declare function truncateUtf8(text: string, max: number): string;
 /**
  * REST transport that exposes model operations as RESTful HTTP routes.
  *
@@ -63,6 +99,13 @@ export declare class RESTOperationsTransport<T extends RESTOperationsTransportPa
      * OpenAPI cache
      */
     openapiContent: string;
+    /** Bidirectional operations served as WebSocket upgrades: path → operation id */
+    webSocketRoutes: Map<string, string>;
+    /** Shared WebSocket server (noServer: upgrades come from the HttpServer) */
+    private webSocketServer?;
+    /** HTTP servers the upgrade listener is already attached to */
+    private webSocketServers;
+    private webSocketEvents;
     /**
      * Transform name using configured casing
      * @param name - the name to transform
@@ -74,6 +117,45 @@ export declare class RESTOperationsTransport<T extends RESTOperationsTransportPa
      * @returns this for chaining
      */
     resolve(): this;
+    /**
+     * Find the bidirectional operation served on a request URL, the way the router matches HTTP paths: relative to the
+     * HttpContext prefix, without the query string, with or without the global route prefix
+     * @param uri - the request URL
+     * @param prefix - the HttpContext prefix (a gateway stage...)
+     * @returns the operation id, if any
+     */
+    webSocketOperationOf(uri: string, prefix?: string): string | undefined;
+    /**
+     * Serve the bidirectional operations' upgrades on an HTTP server (once per server, only if there are any)
+     * @param server - the server emitted by Webda.Init.Http
+     * @param storage - the instance storage to run requests in
+     */
+    protected attachWebSockets(server: Server, storage: ReturnType<typeof useInstanceStorage>): void;
+    /**
+     * Answer an upgrade with an HTTP error
+     * @param socket - the raw socket
+     * @param status - HTTP status
+     * @param message - reason phrase
+     */
+    private refuseUpgrade;
+    /**
+     * Check the caller like a normal request (Webda.Request, router request filters, permission) and accept the WebSocket
+     * @param opId - the bidirectional operation
+     * @param server - the HTTP server
+     * @param req - the upgrade request
+     * @param socket - the raw socket
+     * @param head - first packet of the upgraded stream
+     * @returns a promise settled once the upgrade is accepted or refused
+     */
+    protected upgradeOperation(opId: string, server: Server, req: IncomingMessage, socket: Duplex, head: Buffer): Promise<void>;
+    /**
+     * Run a bidirectional operation over an accepted WebSocket: messages in, chunks out
+     * @param opId - the operation
+     * @param httpContext - the upgrade request
+     * @param ws - the socket
+     * @param session - the session loaded when the upgrade was authorized
+     */
+    protected runWebSocketOperation(opId: string, httpContext: any, ws: WebSocket, session?: any): Promise<void>;
     /**
      * Override initTransport to walk the model tree instead of flat iteration.
      * For each model, we look up its operations and register REST routes.
@@ -85,6 +167,32 @@ export declare class RESTOperationsTransport<T extends RESTOperationsTransportPa
      * @param operations - the filtered operations map
      */
     protected exposeServiceOperations(operations: Record<string, OperationDefinition>): void;
+    /**
+     * The OpenAPI responses of a server-streaming operation
+     * @returns the 200 response with both stream formats
+     */
+    protected streamedResponses(): Record<string, any>;
+    /**
+     * Run an operation for a route: a server-streaming one is streamed to the client as its generator yields, any other
+     * is called and its result flushed with the response
+     * @param context - the request context
+     * @param operationId - the operation
+     * @returns a promise settled once the operation is done (a stream: once the response is over)
+     */
+    protected runOperation(context: WebContext, operationId: string): Promise<void>;
+    /**
+     * Stream a server-streaming operation: NDJSON, or server-sent events when the client accepts them
+     *
+     * The streaming context is built here, from the request's context, rather than by the HttpServer: only these routes
+     * need it, and permissions, validation and events still go through `callOperation` on the request's input. Until the
+     * first chunk an error is a normal HTTP error (thrown to the HttpServer); after it, the error is the last event or
+     * line of the stream.
+     * @param context - the request context
+     * @param operationId - the operation
+     * @param response - the HTTP response
+     * @returns a promise settled once the response is over
+     */
+    protected streamOperation(context: WebContext, operationId: string, response: ServerResponse): Promise<void>;
     /**
      * Recursively walk a model and its children, registering routes at each level
      * @param model - the model class

package/lib/rest/restoperationstransport.service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"restoperationstransport.service.d.ts","sourceRoot":"","sources":["../../src/rest/restoperationstransport.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACxG,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAQvD,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAGvD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,4BAA4B,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AA6CnF;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,6BAA6B;IAClF;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;OAQG;IACH,cAAc,EAAE,MAAM,CAAY;IAClC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAO;IAClB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAE5B;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAS3B;CACF;AAED;;;;;;;;GAQG;AACH,qBAAa,uBAAuB,CAClC,CAAC,SAAS,iCAAiC,GAAG,iCAAiC,CAC/E,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElC;IAED;;;OAGG;IACH,OAAO,SAON;IAED;;;OAGG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI,CAiC9B;IAED;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,IAAI,CAmCvF;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,CACjB,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,aAAa,EACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAC/C,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,IAAI,CA+CN;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,gBAAgB,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CAqGN;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA2EN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA2CN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CAqEN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CACtB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA2CN;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,GAClC,IAAI,CAyDN;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,SAAS,CAAC,oBAAoB,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,4BAA4B,GACrC,IAAI,CAoEN;IAED;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB,GAAG,IAAI,CAE5E;IAED;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,UAAU,iBAM5B;CACF"}
+{"version":3,"file":"restoperationstransport.service.d.ts","sourceRoot":"","sources":["../../src/rest/restoperationstransport.service.ts"],"names":[],"mappings":"AACA,OAAO,EAAiB,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,6BAA6B,EAAE,MAAM,oCAAoC,CAAC;AACxG,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAUvD,OAAO,EAA0B,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAGxF,OAAO,EAAE,UAAU,EAAE,MAAM,2BAA2B,CAAC;AAGvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,WAAW,CAAC;AACzE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,EAAmB,KAAK,SAAS,EAAE,MAAM,IAAI,CAAC;AAErD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,4BAA4B,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAsDnF;;GAEG;AACH,qBAAa,iCAAkC,SAAQ,6BAA6B;IAClF;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;;;;;;OAQG;IACH,cAAc,EAAE,MAAM,CAAY;IAClC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAO;IAClB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;IACpC;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;IAC5B;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAEjC;;;;OAIG;IACH,IAAI,CAAC,MAAM,GAAE,GAAQ,GAAG,IAAI,CAa3B;CACF;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAM9D;AAED;;;;;;;;GAQG;AACH,qBAAa,uBAAuB,CAClC,CAAC,SAAS,iCAAiC,GAAG,iCAAiC,CAC/E,SAAQ,mBAAmB,CAAC,CAAC,CAAC;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB,iFAAiF;IACjF,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAa;IACjD,4EAA4E;IAC5E,OAAO,CAAC,eAAe,CAAC,CAAkB;IAC1C,+DAA+D;IAC/D,OAAO,CAAC,gBAAgB,CAAkC;IAC1D,OAAO,CAAC,eAAe,CAAS;IAEhC;;;;OAIG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAElC;IAED;;;OAGG;IACH,OAAO,SAaN;IAED;;;;;;OAMG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,GAAE,MAAW,GAAG,MAAM,GAAG,SAAS,CAOzE;IAED;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,GAAG,IAAI,CAc/F;IAED;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IAIrB;;;;;;;;OAQG;IACH,UAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,eAAe,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,IAAI,CAAC,CA6Bf;IAED;;;;;;OAMG;IACH,UAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,GAAG,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CA+CjH;IAED;;;OAGG;IACH,SAAS,CAAC,aAAa,IAAI,IAAI,CAiC9B;IAED;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,IAAI,CAwDvF;IAED;;;OAGG;IACH,SAAS,CAAC,iBAAiB,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAajD;IAED;;;;;;OAMG;IACH,UAAgB,YAAY,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASpF;IAED;;;;;;;;;;;OAWG;IACH,UAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CA8CjH;IAED;;;;;;;OAOG;IACH,SAAS,CAAC,SAAS,CACjB,KAAK,EAAE,UAAU,EACjB,QAAQ,EAAE,aAAa,EACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAC/C,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,GACZ,IAAI,CA+CN;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,gBAAgB,CACxB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CAqGN;IAED;;;;;;;;OAQG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,EACnC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA2EN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA2CN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CAqEN;IAED;;;;;;OAMG;IACH,SAAS,CAAC,cAAc,CACtB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAC9C,IAAI,CA2CN;IAED;;;;;;;;;OASG;IACH,SAAS,CAAC,iBAAiB,CACzB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,WAAW,EACnB,KAAK,EAAE,MAAM,EACb,eAAe,EAAE,MAAM,GAAG,SAAS,GAClC,IAAI,CAmEN;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;OA0BG;IACH,SAAS,CAAC,oBAAoB,CAC5B,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,4BAA4B,GACrC,IAAI,CAsEN;IAED;;;;OAIG;IACH,eAAe,CAAC,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,mBAAmB,GAAG,IAAI,CAE5E;IAED;;;OAGG;IACG,OAAO,CAAC,GAAG,EAAE,UAAU,iBAM5B;CACF"}

package/lib/rest/restoperationstransport.service.js

@@ -3,11 +3,28 @@ import { TransformCase } from "@webda/utils";
 import { OperationsTransport, OperationsTransportParameters } from "../services/operationstransport.js";
 import * as WebdaError from "../errors/errors.js";
 import { useRouter } from "./hooks.js";
-import { useApplication } from "../application/hooks.js";
+import { useLog } from "@webda/workout";
+import { HttpContext } from "../contexts/httpcontext.js";
+import { runWithContext } from "../contexts/execution.js";
+import { emitCoreEvent, useCoreEvents } from "../events/events.js";
+import { useApplication, useParameters } from "../application/hooks.js";
 import { useCore, useModelMetadata } from "../core/hooks.js";
-import { useInstanceStorage } from "../core/instancestorage.js";
-import { callOperation } from "../core/operations.js";
+import { runWithInstanceStorage, useInstanceStorage } from "../core/instancestorage.js";
+import { callOperation, canCallOperation, getOperationStreaming } from "../core/operations.js";
+import { AsyncQueue } from "../core/asyncqueue.js";
+import { WebSocketOperationContext } from "../contexts/websocketcontext.js";
+import { RestStreamingOperationContext } from "../contexts/restcontext.js";
+import { WebSocketServer } from "ws";
 import { hasSchema } from "../schemas/hooks.js";
+/**
+ * @param data - a raw WebSocket message
+ * @returns its length in bytes
+ */
+function rawLength(data) {
+    if (Array.isArray(data))
+        return data.reduce((sum, chunk) => sum + chunk.length, 0);
+    return data instanceof ArrayBuffer ? data.byteLength : data.length;
+}
 /**
  * Swagger static html
  */
@@ -87,6 +104,31 @@ export class RESTOperationsTransportParameters extends OperationsTransportParame
      * @default "PUT"
      */
     queryMethod;
+    /**
+     * Largest message (bytes) a client may send on a bidirectional WebSocket operation; a bigger one closes the socket
+     *
+     * @default 1048576
+     */
+    webSocketMaxPayload;
+    /**
+     * Most unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413
+     *
+     * @default 1000
+     */
+    webSocketMaxQueuedMessages;
+    /**
+     * Most bytes of unconsumed messages a bidirectional operation may have queued; above it the socket closes with 4413
+     *
+     * @default 16777216
+     */
+    webSocketMaxQueuedBytes;
+    /**
+     * Milliseconds between two keep-alive comments on an open `text/event-stream` response of a server-streaming
+     * operation (0 disables them)
+     *
+     * @default 20000
+     */
+    streamKeepAliveInterval;
     /**
      * Load parameters with defaults
      * @param params - the service parameters
@@ -96,6 +138,10 @@ export class RESTOperationsTransportParameters extends OperationsTransportParame
         super.load(params);
         this.nameTransformer ??= "camelCase";
         this.queryMethod ??= "PUT";
+        this.webSocketMaxPayload ??= 1024 * 1024;
+        this.webSocketMaxQueuedMessages ??= 1000;
+        this.webSocketMaxQueuedBytes ??= 16 * 1024 * 1024;
+        this.streamKeepAliveInterval ??= 20000;
         // Ensure url ends with /
         if (this.url && !this.url.endsWith("/")) {
             this.url += "/";
@@ -103,6 +149,21 @@ export class RESTOperationsTransportParameters extends OperationsTransportParame
         return this;
     }
 }
+/**
+ * Truncate a string to a number of UTF-8 bytes without cutting a character (a close reason holds 123 bytes)
+ * @param text - the text
+ * @param max - the maximum byte length
+ * @returns the truncated text
+ */
+export function truncateUtf8(text, max) {
+    const buffer = Buffer.from(text, "utf8");
+    if (buffer.length <= max)
+        return text;
+    let end = max;
+    while (end > 0 && (buffer[end] & 0xc0) === 0x80)
+        end--;
+    return buffer.subarray(0, end).toString("utf8");
+}
 /**
  * REST transport that exposes model operations as RESTful HTTP routes.
  *
@@ -117,6 +178,13 @@ export class RESTOperationsTransport extends OperationsTransport {
      * OpenAPI cache
      */
     openapiContent;
+    /** Bidirectional operations served as WebSocket upgrades: path → operation id */
+    webSocketRoutes = new Map();
+    /** Shared WebSocket server (noServer: upgrades come from the HttpServer) */
+    webSocketServer;
+    /** HTTP servers the upgrade listener is already attached to */
+    webSocketServers = new WeakSet();
+    webSocketEvents = false;
     /**
      * Transform name using configured casing
      * @param name - the name to transform
@@ -135,8 +203,162 @@ export class RESTOperationsTransport extends OperationsTransport {
         if (this.parameters.exposeOpenAPI) {
             this.addRoute(".", ["GET"], this.openapi, { hidden: true });
         }
+        // Bidirectional operations: accept WebSocket upgrades on every HTTP server once it listens
+        if (!this.webSocketEvents) {
+            this.webSocketEvents = true;
+            const storage = useInstanceStorage();
+            useCoreEvents("Webda.Init.Http", (server) => this.attachWebSockets(server, storage));
+        }
         return this;
     }
+    /**
+     * Find the bidirectional operation served on a request URL, the way the router matches HTTP paths: relative to the
+     * HttpContext prefix, without the query string, with or without the global route prefix
+     * @param uri - the request URL
+     * @param prefix - the HttpContext prefix (a gateway stage...)
+     * @returns the operation id, if any
+     */
+    webSocketOperationOf(uri, prefix = "") {
+        const context = new HttpContext("localhost", "GET", uri);
+        if (prefix)
+            context.setPrefix(prefix);
+        let path = context.getRelativeUri().split("?")[0];
+        const routePrefix = useParameters().routePrefix || "";
+        if (routePrefix && path.startsWith(routePrefix))
+            path = path.substring(routePrefix.length) || "/";
+        return this.webSocketRoutes.get(path);
+    }
+    /**
+     * Serve the bidirectional operations' upgrades on an HTTP server (once per server, only if there are any)
+     * @param server - the server emitted by Webda.Init.Http
+     * @param storage - the instance storage to run requests in
+     */
+    attachWebSockets(server, storage) {
+        if (this.webSocketRoutes.size === 0 || this.webSocketServers.has(server))
+            return;
+        this.webSocketServers.add(server);
+        server.on("upgrade", (req, socket, head) => {
+            runWithInstanceStorage(storage, () => {
+                const opId = this.webSocketOperationOf(req.url ?? "/");
+                // Not ours (GraphQL subscriptions...): leave the socket to the other listeners
+                if (!opId)
+                    return;
+                this.upgradeOperation(opId, server, req, socket, head).catch(err => {
+                    useLog("ERROR", "WebSocket upgrade failed", opId, err);
+                    socket.destroy();
+                });
+            });
+        });
+    }
+    /**
+     * Answer an upgrade with an HTTP error
+     * @param socket - the raw socket
+     * @param status - HTTP status
+     * @param message - reason phrase
+     */
+    refuseUpgrade(socket, status, message) {
+        socket.end(`HTTP/1.1 ${status} ${message}\r\nConnection: close\r\nContent-Length: 0\r\n\r\n`);
+    }
+    /**
+     * Check the caller like a normal request (Webda.Request, router request filters, permission) and accept the WebSocket
+     * @param opId - the bidirectional operation
+     * @param server - the HTTP server
+     * @param req - the upgrade request
+     * @param socket - the raw socket
+     * @param head - first packet of the upgraded stream
+     * @returns a promise settled once the upgrade is accepted or refused
+     */
+    async upgradeOperation(opId, server, req, socket, head) {
+        const http = Object.values(useCore().getServices()).find(s => s.server === server && typeof s.getContextFromRequest === "function");
+        const base = http && (await http.getContextFromRequest(req));
+        if (!base)
+            return this.refuseUpgrade(socket, 400, "Bad Request");
+        await base.init();
+        const allowed = await runWithContext(base, async () => {
+            try {
+                emitCoreEvent("Webda.Request", { context: base });
+            }
+            catch {
+                // listener error
+            }
+            return (await useRouter().checkRequest(base)) && canCallOperation(base, opId);
+        });
+        if (!allowed)
+            return this.refuseUpgrade(socket, 403, "Forbidden");
+        const storage = useInstanceStorage();
+        this.webSocketServer ??= new WebSocketServer({
+            noServer: true,
+            maxPayload: this.parameters.webSocketMaxPayload
+        });
+        this.webSocketServer.handleUpgrade(req, socket, head, ws => {
+            runWithInstanceStorage(storage, () => {
+                this.runWebSocketOperation(opId, base.getHttpContext(), ws, base.getSession()).catch(err => {
+                    useLog("ERROR", "WebSocket operation failed", opId, err);
+                    ws.close(1011, "Internal server error");
+                });
+            });
+        });
+    }
+    /**
+     * Run a bidirectional operation over an accepted WebSocket: messages in, chunks out
+     * @param opId - the operation
+     * @param httpContext - the upgrade request
+     * @param ws - the socket
+     * @param session - the session loaded when the upgrade was authorized
+     */
+    async runWebSocketOperation(opId, httpContext, ws, session) {
+        const ctx = new WebSocketOperationContext(httpContext, ws, session);
+        await ctx.init();
+        const input = new AsyncQueue();
+        ctx.setExtension("operationInputStream", input);
+        const maxQueued = this.parameters.webSocketMaxQueuedMessages;
+        const maxQueuedBytes = this.parameters.webSocketMaxQueuedBytes;
+        ws.on("message", data => {
+            let message;
+            try {
+                message = JSON.parse(String(data));
+            }
+            catch {
+                ws.close(4400, "Invalid JSON message");
+                return;
+            }
+            input.push(message, rawLength(data));
+            if (input.pending > maxQueued || input.pendingBytes > maxQueuedBytes) {
+                // The operation does not keep up: stop it rather than buffering without limit
+                const bytes = input.pendingBytes > maxQueuedBytes;
+                ctx.cancel();
+                input.end(true);
+                ws.close(4413, bytes ? "Too many queued bytes" : "Too many queued messages");
+            }
+        });
+        ws.on("error", err => useLog("DEBUG", "WebSocket error", opId, err));
+        // The client is gone: the operation's writes throw and its pending read ends so its finally blocks run
+        ws.on("close", () => {
+            ctx.cancel();
+            input.end();
+        });
+        try {
+            await callOperation(ctx, opId);
+            if (ctx.isCancelled)
+                return;
+            const output = ctx.getExtension("operationStreaming") ? undefined : ctx.getOutput();
+            if (output)
+                ws.send(output);
+            ws.close(1000);
+        }
+        catch (err) {
+            // Only a client that went away is a silent cancel: an operation raising it while connected is an error
+            if (ctx.isCancelled)
+                return;
+            const status = typeof err?.getResponseCode === "function" ? err.getResponseCode() : undefined;
+            if (status >= 400 && status < 500) {
+                ws.close(4000 + status, truncateUtf8(String(err.message ?? "Error"), 123));
+                return;
+            }
+            useLog("ERROR", `[WebSocket ${opId}] operation threw:`, err);
+            ws.close(status ? 4000 + status : 1011, "Internal server error");
+        }
+    }
     /**
      * Override initTransport to walk the model tree instead of flat iteration.
      * For each model, we look up its operations and register REST routes.
@@ -187,6 +409,9 @@ export class RESTOperationsTransport extends OperationsTransport {
         for (const [opId, op] of Object.entries(operations)) {
             if (op.hidden)
                 continue;
+            // A client stream cannot be carried by a plain HTTP request: reachable over gRPC only
+            if (getOperationStreaming(op) === "client")
+                continue;
             // Skip if this operation was already handled by model tree walk
             if (op.context?.model)
                 continue;
@@ -202,18 +427,121 @@ export class RESTOperationsTransport extends OperationsTransport {
                 path = `${this.parameters.url}${opId.toLowerCase().replace(/\./g, "/")}`;
                 methods = ["PUT"];
             }
+            if (getOperationStreaming(op) === "bidi") {
+                // Served as a WebSocket upgrade on this path; a plain request cannot carry a bidirectional stream
+                if (path.includes("{")) {
+                    this.log("WARN", `${opId} is bidirectional but its path ${path} has parameters: not served over WebSocket`);
+                }
+                else {
+                    this.webSocketRoutes.set(path, opId);
+                }
+                this.addRoute(path, [...new Set(["GET", ...methods])], async () => {
+                    throw new WebdaError.HttpError("Upgrade Required: open a WebSocket on this URL", 426);
+                }, { get: { tags: op.tags || [], summary: `${op.summary || opId} (WebSocket)`, operationId: opId } });
+                continue;
+            }
             const openapi = {
                 [methods[0].toLowerCase()]: {
                     tags: op.tags || [],
                     summary: op.summary || opId,
-                    operationId: opId
+                    operationId: opId,
+                    ...(getOperationStreaming(op) === "server" ? { responses: this.streamedResponses() } : {})
                 }
             };
             this.addRoute(path, methods, async (context) => {
-                await callOperation(context, opId);
+                await this.runOperation(context, opId);
             }, openapi);
         }
     }
+    /**
+     * The OpenAPI responses of a server-streaming operation
+     * @returns the 200 response with both stream formats
+     */
+    streamedResponses() {
+        return {
+            "200": {
+                description: "Stream of chunks: one JSON line each (application/x-ndjson), or one `data:` event each when `Accept` is " +
+                    "text/event-stream, ended by an `end` event. An error after the first chunk is a last `error` event or " +
+                    '`{"error": {"message", "code"}}` line.',
+                content: {
+                    "application/x-ndjson": { schema: { type: "string", description: "One JSON value per line" } },
+                    "text/event-stream": { schema: { type: "string", description: "Server-sent events with a JSON `data`" } }
+                }
+            }
+        };
+    }
+    /**
+     * Run an operation for a route: a server-streaming one is streamed to the client as its generator yields, any other
+     * is called and its result flushed with the response
+     * @param context - the request context
+     * @param operationId - the operation
+     * @returns a promise settled once the operation is done (a stream: once the response is over)
+     */
+    async runOperation(context, operationId) {
+        const response = context._stream;
+        if (getOperationStreaming(useInstanceStorage().operations?.[operationId]) !== "server" ||
+            typeof response?.writeHead !== "function") {
+            return callOperation(context, operationId);
+        }
+        return this.streamOperation(context, operationId, response);
+    }
+    /**
+     * Stream a server-streaming operation: NDJSON, or server-sent events when the client accepts them
+     *
+     * The streaming context is built here, from the request's context, rather than by the HttpServer: only these routes
+     * need it, and permissions, validation and events still go through `callOperation` on the request's input. Until the
+     * first chunk an error is a normal HTTP error (thrown to the HttpServer); after it, the error is the last event or
+     * line of the stream.
+     * @param context - the request context
+     * @param operationId - the operation
+     * @param response - the HTTP response
+     * @returns a promise settled once the response is over
+     */
+    async streamOperation(context, operationId, response) {
+        const accept = context.getHttpContext().getUniqueHeader("accept", "") ?? "";
+        const format = accept.includes("text/event-stream") ? "sse" : "ndjson";
+        const stream = new RestStreamingOperationContext(context.getHttpContext(), response, format, context.getSession(), this.parameters.streamKeepAliveInterval, context.getResponseHeaders(), context.getSetCookieHeaders());
+        await stream.init();
+        stream.setParameters(context.getParameters());
+        stream.startKeepAlive();
+        try {
+            await callOperation(stream, operationId);
+        }
+        catch (err) {
+            stream.stopKeepAlive();
+            // The client went away: nothing to tell
+            if (stream.isCancelled || stream.disconnected)
+                return stream.finish();
+            // Nothing sent yet: a normal HTTP error response
+            if (!stream.hasStarted) {
+                stream.abortBeforeStart();
+                throw err;
+            }
+            const status = typeof err?.getResponseCode === "function" ? err.getResponseCode() : undefined;
+            const clientError = status >= 400 && status < 500;
+            if (!clientError)
+                useLog("ERROR", `[REST ${operationId}] streamed operation threw:`, err);
+            await stream.writeError(clientError ? String(err.message ?? "Error") : "Internal server error", status || 500);
+            return stream.finish();
+        }
+        stream.stopKeepAlive();
+        if (stream.isCancelled)
+            return stream.finish();
+        if (!stream.getExtension("operationStreaming")) {
+            // Not a generator after all: a normal response, with the status and headers the operation set
+            if (stream.statusCode && stream.statusCode !== 204)
+                context.statusCode = stream.statusCode;
+            for (const [name, value] of Object.entries(stream.getResponseHeaders()))
+                context.setHeader(name, value);
+            const output = stream.getOutput();
+            if (output !== undefined) {
+                context.setHeader("Content-type", "application/json");
+                context.write(output);
+            }
+            return;
+        }
+        return stream.finish(true);
+    }
     /**
      * Recursively walk a model and its children, registering routes at each level
      * @param model - the model class
@@ -637,6 +965,13 @@ export class RESTOperationsTransport extends OperationsTransport {
                 ...(action.openapi?.[method.toLowerCase()] ?? {})
             };
         });
+        if (getOperationStreaming(useInstanceStorage().operations?.[operationId]) === "server") {
+            Object.keys(openapi)
+                .filter(k => ["get", "post", "put", "patch", "delete"].includes(k))
+                .forEach(k => {
+                openapi[k].responses = { ...this.streamedResponses(), ...openapi[k].responses };
+            });
+        }
         if (hasSchema(`${identifier}.${actionName}.input`)) {
             Object.keys(openapi)
                 .filter(k => ["get", "post", "put", "patch", "delete"].includes(k))
@@ -652,7 +987,8 @@ export class RESTOperationsTransport extends OperationsTransport {
                 };
             });
         }
-        if (hasSchema(`${identifier}.${actionName}.output`)) {
+        if (hasSchema(`${identifier}.${actionName}.output`) &&
+            getOperationStreaming(useInstanceStorage().operations?.[operationId]) !== "server") {
             Object.keys(openapi)
                 .filter(k => ["get", "post", "put", "patch", "delete"].includes(k))
                 .forEach(k => {
@@ -672,7 +1008,7 @@ export class RESTOperationsTransport extends OperationsTransport {
                 context.getParameters()[injectAttribute] = context.parameter(`pid.${depth - 1}`);
                 context.getParameters()[`pid.${depth - 1}`] = undefined;
             }
-            await callOperation(context, operationId);
+            await this.runOperation(context, operationId);
         }, openapi);
     }
     /**
@@ -745,7 +1081,10 @@ export class RESTOperationsTransport extends OperationsTransport {
                     }
                 };
             }
-            if (hasSchema(outputSchema)) {
+            if (getOperationStreaming(op) === "server") {
+                openapi[methodKey].responses = this.streamedResponses();
+            }
+            else if (hasSchema(outputSchema)) {
                 openapi[methodKey].responses = {
                     "200": {
                         description: "Operation success",
@@ -759,7 +1098,7 @@ export class RESTOperationsTransport extends OperationsTransport {
                     }
                 };
             }
-            this.addRoute(fullPath, [httpMethod], async (context) => callOperation(context, operationId), openapi);
+            this.addRoute(fullPath, [httpMethod], async (context) => this.runOperation(context, operationId), openapi);
         });
     }
     /**