Feat: providing options to Result Handler

src/endpoint.ts

@@ -232,14 +232,15 @@ export class Endpoint<
     request,
     response,
     logger,
+    options,
   }: {
     method: Method | AuxMethod;
     input: Readonly<FlatObject>; // Issue #673: input is immutable, since this.inputSchema is combined with ones of middlewares
     request: Request;
     response: Response;
     logger: AbstractLogger;
+    options: Partial<OPT>;
   }) {
-    const options = {} as OPT;
     for (const def of this.#middlewares) {
       if (method === "options" && def.type === "proprietary") {
         continue;
@@ -271,7 +272,6 @@ export class Endpoint<
         break;
       }
     }
-    return options;
   }
 
   async #parseAndRunHandler({
@@ -308,13 +308,15 @@ export class Endpoint<
     logger,
     input,
     output,
+    options,
   }: {
     error: Error | null;
     request: Request;
     response: Response;
     logger: AbstractLogger;
     input: FlatObject;
     output: FlatObject | null;
+    options: Partial<OPT>;
   }) {
     try {
       await this.#resultHandler.handler({
@@ -324,6 +326,7 @@ export class Endpoint<
         response,
         logger,
         input,
+        options,
       });
     } catch (e) {
       lastResortHandler({
@@ -348,6 +351,7 @@ export class Endpoint<
     siblingMethods?: Method[];
   }) {
     const method = getActualMethod(request);
+    const options: Partial<OPT> = {};
     let output: FlatObject | null = null;
     let error: Error | null = null;
     if (config.cors) {
@@ -366,12 +370,13 @@ export class Endpoint<
     }
     const input = getInput(request, config.inputSources);
     try {
-      const options = await this.#runMiddlewares({
+      await this.#runMiddlewares({
         method,
         input,
         request,
         response,
         logger,
+        options,
       });
       if (response.writableEnded) {
         return;
@@ -381,7 +386,11 @@ export class Endpoint<
         return;
       }
       output = await this.#parseOutput(
-        await this.#parseAndRunHandler({ input, options, logger }),
+        await this.#parseAndRunHandler({
+          input,
+          logger,
+          options: options as OPT, // ensured the complete OPT by writableEnded condition and try-catch
+        }),
       );
     } catch (e) {
       error = makeErrorFromAnything(e);
@@ -393,6 +402,7 @@ export class Endpoint<
       response,
       error,
       logger,
+      options,
     });
   }
 }

src/result-handler.ts

@@ -22,6 +22,8 @@ interface ResultHandlerParams<RES> {
   input: FlatObject | null;
   /** null in case of errors or failures */
   output: FlatObject | null;
+  /** can be empty: check presence of the required property using "in" operator */
+  options: FlatObject;
   error: Error | null;
   request: Request;
   response: Response<RES>;

src/server-helpers.ts

@@ -31,6 +31,7 @@ export const createParserFailureHandler =
       response,
       input: null,
       output: null,
+      options: {},
       logger: getChildLogger
         ? await getChildLogger({ request, parent: rootLogger })
         : rootLogger,
@@ -59,6 +60,7 @@ export const createNotFoundHandler =
         error,
         input: null,
         output: null,
+        options: {},
       });
     } catch (e) {
       lastResortHandler({

tests/unit/result-handler.spec.ts

@@ -9,7 +9,7 @@ import {
   defaultResultHandler,
   withMeta,
 } from "../../src";
-import { ApiResponse } from "../../src/api-response";
+import { ApiResponse } from "../../src";
 import { metaProp } from "../../src/metadata";
 import { describe, expect, test, vi } from "vitest";
 import {
@@ -51,6 +51,7 @@ describe("ResultHandler", () => {
           request: requestMock as unknown as Request,
           response: responseMock as unknown as Response,
           logger: loggerMock,
+          options: {},
         });
         expect(loggerMock.error).toHaveBeenCalledTimes(1);
         expect(loggerMock.error.mock.calls[0][0]).toMatch(
@@ -86,6 +87,7 @@ describe("ResultHandler", () => {
           ),
           input: { something: 453 },
           output: { anything: 118 },
+          options: {},
           request: requestMock as unknown as Request,
           response: responseMock as unknown as Response,
           logger: loggerMock,
@@ -103,6 +105,7 @@ describe("ResultHandler", () => {
           error: createHttpError(404, "Something not found"),
           input: { something: 453 },
           output: { anything: 118 },
+          options: {},
           request: requestMock as unknown as Request,
           response: responseMock as unknown as Response,
           logger: loggerMock,
@@ -120,6 +123,7 @@ describe("ResultHandler", () => {
           error: null,
           input: { something: 453 },
           output: { anything: 118, items: ["One", "Two", "Three"] },
+          options: {},
           request: requestMock as unknown as Request,
           response: responseMock as unknown as Response,
           logger: loggerMock,
@@ -165,6 +169,7 @@ describe("ResultHandler", () => {
       error: null,
       input: { something: 453 },
       output: { anything: 118 },
+      options: {},
       request: requestMock as unknown as Request,
       response: responseMock as unknown as Response,
       logger: loggerMock,