@procedures/client 0.7.0 → 0.8.1

package/dist/adapters/http/server/transport.d.ts

@@ -1,65 +1,49 @@
 /**
- * HTTP Server Transport Implementation
+ * The HTTP server transport of Express: a shim over `procedureHandler` (CLI-3).
  *
- * Adapts Express HTTP server to unified RPC format.
- * Converts HTTP requests to ServerRequest and ServerResponse back to HTTP.
+ * The transport mounts the procedure handler of `handler.ts` on an Express app, with the CORS of
+ * the app, and it owns its own `node:http` server unless the caller gives one. The handler does
+ * the work: the request, the body, the metadata, the credentials, the response and the NDJSON
+ * streams. The transport keeps its former error codes (`SERVER_STOPPED` and the codes of the
+ * browser checks), so its behavior stays the same.
  */
 import type { ServerTransport } from "../../../server/types.js";
 import type { RequestHandler } from "../../../server/types.js";
 import type { HttpServerTransportOptions } from "./types.js";
+/**
+ * HTTP server transport adapter for Express.
+ *
+ * Converts HTTP requests to unified RPC format and responses back to HTTP.
+ *
+ * @example
+ * ```typescript
+ * const server = new Server();
+ * const app = express();
+ * app.use(express.json({ strict: false })); // optional: the transport can read the body itself
+ * const httpTransport = new HttpServerTransport(server, {
+ *   app,
+ *   port: 3000,
+ *   // The default URL strategy parses the HTTP client's format: /api/{service}/{operation}
+ * });
+ *
+ * await httpTransport.start();
+ * ```
+ */
 export declare class HttpServerTransport implements ServerTransport {
     readonly name = "http";
     private app;
     private httpServer;
     private options;
-    private server;
-    /** The controllers of the requests in progress: stop() aborts them (deep dive TRN-15) */
-    private openRequests;
+    /** The procedure handler that does the work of each request (CLI-3) */
+    private readonly handler;
+    /** The CORS of the app, or undefined when it is off */
+    private readonly cors;
     private stopped;
-    private readonly bodyLimit;
-    /** The browser checks of each procedure call (see `server/browser-guard.ts`) */
-    private readonly guard;
-    /** The quiet time of an NDJSON stream before a keep-alive line, or false for none */
-    private readonly keepAlive;
-    /** The clock of the keep-alive timers (roadmap R35) */
-    private readonly clock;
     constructor(server: RequestHandler, options?: HttpServerTransportOptions);
     /**
-     * Setup Express routes.
+     * Setup Express routes: the CORS of the app, then the procedure handler under the base path.
      */
     private setupRoutes;
-    /**
-     * Handle HTTP request.
-     * Converts to unified RPC format, processes, and sends response.
-     */
-    private handleHttpRequest;
-    /**
-     * The request body. A body parser of the app (`express.json({ strict: false })`) gives
-     * `req.body`. Without one, the transport reads the JSON body itself: before, every payload
-     * was {} when the app had no parser, and a parser with `strict: true` rejected a number or
-     * a string (deep dive TRN-10).
-     */
-    private readBody;
-    /**
-     * Send a stream response.
-     *
-     * A client that accepts `application/x-ndjson` gets one JSON line for each item
-     * (`{"type":"item","seq":1,"payload":...}`), then `{"type":"done","seq":...}`, or
-     * `{"type":"error","error":...}`. The `seq` of the lines counts from 1, as in the `stream`
-     * frames of WebSocket. A quiet stream gets a keep-alive line, a blank line, after each quiet
-     * time of `keepAlive`. `writeNdjsonStream` writes these lines.
-     * Another client (curl, a browser fetch without the header) gets the last item as plain JSON,
-     * the "sponge" mode, so a streaming procedure does not change its response format.
-     */
-    private streamToHttp;
-    /**
-     * This method converts an HTTP request to a `ServerRequest`.
-     */
-    private httpToServerRequest;
-    /**
-     * Convert ServerResponse to HTTP response.
-     */
-    private serverResponseToHttp;
     start(): Promise<void>;
     /**
      * Stop the transport. The requests in progress are aborted: an open stream ends, and its
@@ -69,5 +53,11 @@ export declare class HttpServerTransport implements ServerTransport {
      */
     stop(): Promise<void>;
     isRunning(): boolean;
+    /**
+     * The port that the server of the transport listens on. With the option `port` 0, the system
+     * gives a free port, and this function returns that port. Before `start()` and after `stop()`,
+     * the function returns undefined.
+     */
+    port(): number | undefined;
 }
 //# sourceMappingURL=transport.d.ts.map

package/dist/adapters/http/server/transport.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../../../src/adapters/http/server/transport.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAiC,MAAM,0BAA0B,CAAC;AAE/F,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAG/D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAyD7D,qBAAa,mBAAoB,YAAW,eAAe;IACzD,QAAQ,CAAC,IAAI,UAAU;IAEvB,OAAO,CAAC,GAAG,CAAU;IACrB,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,OAAO,CAQb;IACF,OAAO,CAAC,MAAM,CAAiB;IAC/B,yFAAyF;IACzF,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,gFAAgF;IAChF,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,qFAAqF;IACrF,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAmB;IAC7C,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;IAE9B,YAAY,MAAM,EAAE,cAAc,EAAE,OAAO,GAAE,0BAA+B,EAqC3E;IAED;;OAEG;IACH,OAAO,CAAC,WAAW;IAgFnB;;;OAGG;YACW,iBAAiB;IAuE/B;;;;;OAKG;YACW,QAAQ;IAoBtB;;;;;;;;;;OAUG;YACW,YAAY;IAwD1B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAoG3B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAyDtB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CA2B3B;IAED;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAqB1B;IAED,SAAS,IAAI,OAAO,CAEnB;CACF"}
+{"version":3,"file":"transport.d.ts","sourceRoot":"","sources":["../../../../src/adapters/http/server/transport.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,YAAY,CAAC;AAK7D;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,mBAAoB,YAAW,eAAe;IACzD,QAAQ,CAAC,IAAI,UAAU;IAEvB,OAAO,CAAC,GAAG,CAAU;IACrB,OAAO,CAAC,UAAU,CAA2B;IAC7C,OAAO,CAAC,OAAO,CAAsG;IACrH,uEAAuE;IACvE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAC/C,uDAAuD;IACvD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAyB;IAC9C,OAAO,CAAC,OAAO,CAAS;IAExB,YAAY,MAAM,EAAE,cAAc,EAAE,OAAO,GAAE,0BAA+B,EAoD3E;IAED;;OAEG;IACH,OAAO,CAAC,WAAW;IAmBb,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CA4B3B;IAED;;;;;OAKG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,CAqB1B;IAED,SAAS,IAAI,OAAO,CAEnB;IAED;;;;OAIG;IACH,IAAI,IAAI,MAAM,GAAG,SAAS,CAGzB;CACF"}