Merge branch 'main' into 20-real-client-ip-based-on-header-trusted-proxies

Author: zefir-git

package-lock.json

@@ -14,19 +14,19 @@ class ServerErrorRegistry<A> {
     public constructor() {
         this.responses = {
             [ServerErrorRegistry.ErrorCodes.BAD_URL]:
-                new TextResponse("Bad request URL.", 400),
+                new TextResponse("Invalid request URL.", 400),
 
             [ServerErrorRegistry.ErrorCodes.NO_ROUTE]:
-                new TextResponse("No route in this registry matches the request.", 404),
+                new TextResponse("No route matched the request.", 404),
 
             [ServerErrorRegistry.ErrorCodes.INTERNAL]:
-                new TextResponse("An internal error occurred.", 500),
+                new TextResponse("An unexpected internal server error occurred.", 500),
 
             [ServerErrorRegistry.ErrorCodes.PRECONDITION_FAILED]:
-                new TextResponse("Precondition failed.", 412),
+                new TextResponse("One or more preconditions were not met.", 412),
 
             [ServerErrorRegistry.ErrorCodes.NO_PERMISSION]:
-                new TextResponse("You do not have permission to perform this action.", 403),
+                new TextResponse("You do not have the necessary permissions to perform this action.", 403),
 
             [ServerErrorRegistry.ErrorCodes.UNAUTHORISED]:
                 new TextResponse("Authentication information was either absent or invalid.", 401),

src/ServerErrorRegistry.ts

@@ -16,8 +16,8 @@ export class EmptyResponse<A> extends Response<A> {
     }
 
     protected override async send(res: http.ServerResponse, req?: Request<A>): Promise<void> {
-        if (req !== undefined)
-            req._responseHeaders.set("content-length", "0");
+        if (!this.headers.has("content-length"))
+            this.headers.set("content-length", "0");
         this.writeHead(res, req);
         res.end();
     }

src/response/EmptyResponse.ts

@@ -0,0 +1,29 @@
+import http from "node:http";
+import stream from "node:stream/promises";
+import {Request} from "../Request.js";
+import {Response} from "./Response.js";
+
+/**
+ * A response that streams data from a readable stream.
+ */
+export class StreamedResponse<A> extends Response<A> {
+    private readonly stream: NodeJS.ReadableStream;
+
+    /**
+     * Construct a StreamedResponse.
+     * @param stream The readable stream to send in the response body.
+     * @param [statusCode=200] The HTTP response status code to send.
+     * @param [headers] The HTTP response headers to send.
+     */
+    public constructor(stream: NodeJS.ReadableStream, statusCode = 200, headers?: HeadersInit) {
+        super(statusCode, headers);
+        this.stream = stream;
+        if (!this.headers.has("transfer-encoding"))
+            this.headers.set("transfer-encoding", "chunked");
+    }
+
+    protected override async send(res: http.ServerResponse, req?: Request<A>): Promise<void> {
+        this.writeHead(res, req);
+        await stream.pipeline(this.stream, res);
+    }
+}

src/response/StreamedResponse.ts

@@ -19,6 +19,8 @@ export class TextResponse<A> extends BufferResponse<A> {
     public constructor(text: string, statusCode = 200, headers?: HeadersInit) {
         super(statusCode, headers);
         this.text = text;
+        if (!this.headers.has("content-type"))
+            this.headers.set("content-type", "text/plain");
     }
 
     public override readBuffer() {

src/response/TextResponse.ts

@@ -3,5 +3,6 @@ export * from "./BufferResponse.js";
 export * from "./EmptyResponse.js";
 export * from "./JsonResponse.js";
 export * from "./Response.js";
+export * from "./StreamedResponse.js";
 export * from "./TextResponse.js";
 export * from "./ThrowableResponse.js";