@forklaunch/core 0.2.3 → 0.2.6

package/{dist/http/interfaces/forklaunchExpress.router.interface.js → lib/dist/lib/src/http/router/expressLikeRouter.js}

@@ -1,11 +1,23 @@
-import { enrichRequestDetails, parseReqHeaders, parseRequestAuth, parseRequestBody, parseRequestParams, parseRequestQuery } from '../middleware';
+import { isHttpContractDetails } from '../guards/isHttpContractDetails';
+import { TypedHandler } from '../handler/typedHandler';
+import { cors } from '../middleware/request/cors.middleware';
+import { createContext } from '../middleware/request/createContext.middleware';
+import { enrichDetails } from '../middleware/request/enrichDetails.middleware';
+import { parse } from '../middleware/request/parse.middleware';
+/**
+ * A class that represents an Express-like router.
+ */
 export class ForklaunchExpressLikeRouter {
+    schemaValidator;
     internal;
     routes = [];
     basePath;
-    constructor(basePath, internal) {
+    constructor(basePath, schemaValidator, internal) {
+        this.schemaValidator = schemaValidator;
         this.internal = internal;
         this.basePath = basePath;
+        this.internal.use(createContext(this.schemaValidator));
+        this.internal.use(cors);
     }
     /**
      * Resolves middlewares based on the contract details.
@@ -13,26 +25,11 @@ export class ForklaunchExpressLikeRouter {
      * @param {PathParamHttpContractDetails<SV> | HttpContractDetails<SV>} contractDetails - The contract details.
      * @returns {MiddlewareHandler<SV>[]} - The resolved middlewares.
      */
-    #resolveMiddlewares(contractDetails) {
-        const middlewares = [
-            enrichRequestDetails(contractDetails)
+    #resolveMiddlewares(contractDetails, requestSchema, responseSchemas) {
+        return [
+            enrichDetails(contractDetails, requestSchema, responseSchemas),
+            parse
         ];
-        if (contractDetails.params) {
-            middlewares.push(parseRequestParams);
-        }
-        if (contractDetails.body) {
-            middlewares.push(parseRequestBody);
-        }
-        if (contractDetails.requestHeaders) {
-            middlewares.push(parseReqHeaders);
-        }
-        if (contractDetails.query) {
-            middlewares.push(parseRequestQuery);
-        }
-        if (contractDetails.auth) {
-            middlewares.push(parseRequestAuth);
-        }
-        return middlewares;
     }
     /**
      * Parses and runs the controller function with error handling.
@@ -47,7 +44,7 @@ export class ForklaunchExpressLikeRouter {
      * @returns {ExpressMiddlewareHandler} - The Express request handler.
      */
     #parseAndRunControllerFunction(requestHandler) {
-        return (async (req, res, next) => {
+        return async (req, res, next) => {
             if (!requestHandler) {
                 throw new Error('Controller function is not defined');
             }
@@ -55,15 +52,13 @@ export class ForklaunchExpressLikeRouter {
                 await requestHandler(req, res, next);
             }
             catch (error) {
-                if (next) {
-                    next(error);
-                }
+                next?.(error);
                 console.error(error);
                 if (!res.headersSent) {
                     res.status(500).send('Internal Server Error');
                 }
             }
-        });
+        };
     }
     /**
      * Extracts the controller function from the provided functions.
@@ -115,6 +110,42 @@ export class ForklaunchExpressLikeRouter {
         this.internal.use(...args);
         return this;
     }
+    #compile(contractDetails) {
+        const schemaValidator = this.schemaValidator;
+        const requestSchema = schemaValidator.compile(schemaValidator.schemify({
+            ...(contractDetails.params ? { params: contractDetails.params } : {}),
+            ...(contractDetails.requestHeaders
+                ? { headers: contractDetails.requestHeaders }
+                : {}),
+            ...(contractDetails.query ? { query: contractDetails.query } : {}),
+            ...(isHttpContractDetails(contractDetails) && contractDetails.body
+                ? { body: contractDetails.body }
+                : {})
+        }));
+        const responseEntries = {
+            400: schemaValidator.string,
+            401: schemaValidator.string,
+            403: schemaValidator.string,
+            404: schemaValidator.string,
+            500: schemaValidator.string,
+            ...contractDetails.responses
+        };
+        const responseSchemas = {
+            responses: {},
+            ...(contractDetails.responseHeaders
+                ? {
+                    headers: schemaValidator.compile(schemaValidator.schemify(contractDetails.responseHeaders))
+                }
+                : {})
+        };
+        Object.entries(responseEntries).forEach(([code, responseShape]) => {
+            responseSchemas.responses[Number(code)] = schemaValidator.compile(schemaValidator.schemify(responseShape));
+        });
+        return {
+            requestSchema,
+            responseSchemas
+        };
+    }
     /**
      * Executes request locally, applying parameters
      *
@@ -123,7 +154,7 @@ export class ForklaunchExpressLikeRouter {
      * @returns
      */
     #localParamRequest(functions, controllerFunction) {
-        return (async (route, request) => {
+        return async (route, request) => {
             let statusCode;
             let responseMessage;
             const responseHeaders = {};
@@ -152,7 +183,6 @@ export class ForklaunchExpressLikeRouter {
                     responseHeaders[key] = value;
                 }
             };
-            // let cursor = functions.shift() as unknown as (req_: typeof req, resp_: typeof res, next: MiddlewareNext) => void;
             let cursor = functions.shift();
             if (cursor) {
                 for (const fn of functions) {
@@ -180,7 +210,24 @@ export class ForklaunchExpressLikeRouter {
                 response: responseMessage,
                 headers: responseHeaders
             };
+        };
+    }
+    #registerRoute(method, path, registrationFunction, contractDetailsOrTypedHandler, ...functions) {
+        if (contractDetailsOrTypedHandler instanceof TypedHandler) {
+            const typedHandler = contractDetailsOrTypedHandler;
+            return this.#registerRoute(method, path, registrationFunction, typedHandler.contractDetails, ...typedHandler.functions.concat(functions));
+        }
+        const contractDetails = contractDetailsOrTypedHandler;
+        this.routes.push({
+            basePath: this.basePath,
+            path,
+            method,
+            contractDetails
         });
+        const { requestSchema, responseSchemas } = this.#compile(contractDetails);
+        const controllerFunction = this.#extractControllerFunction(functions);
+        registrationFunction.bind(this.internal)(path, ...this.#resolveMiddlewares(contractDetails, requestSchema, responseSchemas).concat(functions), this.#parseAndRunControllerFunction(controllerFunction));
+        return this.#localParamRequest(functions, controllerFunction);
     }
     /**
      * Registers a GET route with the specified contract details and handler functions.
@@ -195,17 +242,9 @@ export class ForklaunchExpressLikeRouter {
      * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
      * @returns {ExpressRouter} - The Express router.
      */
-    get(path, contractDetails, ...functions) {
-        const controllerFunction = this.#extractControllerFunction(functions);
-        this.routes.push({
-            basePath: this.basePath,
-            path,
-            method: 'GET',
-            contractDetails
-        });
-        this.internal.get(path, ...this.#resolveMiddlewares(contractDetails).concat(functions), this.#parseAndRunControllerFunction(controllerFunction));
+    get(path, contractDetailsOrTypedHandler, ...functions) {
         return {
-            get: this.#localParamRequest(functions, controllerFunction)
+            get: this.#registerRoute('get', path, this.internal.get, contractDetailsOrTypedHandler, ...functions)
         };
     }
     /**
@@ -221,17 +260,9 @@ export class ForklaunchExpressLikeRouter {
      * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
      * @returns {ExpressRouter} - The Express router.
      */
-    post(path, contractDetails, ...functions) {
-        const controllerFunction = this.#extractControllerFunction(functions);
-        this.routes.push({
-            basePath: this.basePath,
-            path,
-            method: 'POST',
-            contractDetails
-        });
-        this.internal.post(path, ...this.#resolveMiddlewares(contractDetails).concat(functions), this.#parseAndRunControllerFunction(controllerFunction));
+    post(path, contractDetailsOrTypedHandler, ...functions) {
         return {
-            post: this.#localParamRequest(functions, controllerFunction)
+            post: this.#registerRoute('post', path, this.internal.post, contractDetailsOrTypedHandler, ...functions)
         };
     }
     /**
@@ -247,17 +278,9 @@ export class ForklaunchExpressLikeRouter {
      * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
      * @returns {ExpressRouter} - The Express router.
      */
-    put(path, contractDetails, ...functions) {
-        const controllerFunction = this.#extractControllerFunction(functions);
-        this.routes.push({
-            basePath: this.basePath,
-            path,
-            method: 'PUT',
-            contractDetails
-        });
-        this.internal.put(path, ...this.#resolveMiddlewares(contractDetails).concat(functions), this.#parseAndRunControllerFunction(controllerFunction));
+    put(path, contractDetailsOrTypedHandler, ...functions) {
         return {
-            put: this.#localParamRequest(functions, controllerFunction)
+            put: this.#registerRoute('put', path, this.internal.put, contractDetailsOrTypedHandler, ...functions)
         };
     }
     /**
@@ -273,17 +296,9 @@ export class ForklaunchExpressLikeRouter {
      * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
      * @returns {ExpressRouter} - The Express router.
      */
-    patch(path, contractDetails, ...functions) {
-        const controllerFunction = this.#extractControllerFunction(functions);
-        this.routes.push({
-            basePath: this.basePath,
-            path,
-            method: 'PATCH',
-            contractDetails
-        });
-        this.internal.patch(path, ...this.#resolveMiddlewares(contractDetails).concat(functions), this.#parseAndRunControllerFunction(controllerFunction));
+    patch(path, contractDetailsOrTypedHandler, ...functions) {
         return {
-            patch: this.#localParamRequest(functions, controllerFunction)
+            patch: this.#registerRoute('patch', path, this.internal.patch, contractDetailsOrTypedHandler, ...functions)
         };
     }
     /**
@@ -299,30 +314,9 @@ export class ForklaunchExpressLikeRouter {
      * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
      * @returns {ExpressRouter} - The Express router.
      */
-    delete(path, contractDetails, ...functions) {
-        const controllerFunction = this.#extractControllerFunction(functions);
-        this.routes.push({
-            basePath: this.basePath,
-            path,
-            method: 'DELETE',
-            contractDetails
-        });
-        this.internal.delete(path, ...this.#resolveMiddlewares(contractDetails).concat(functions), this.#parseAndRunControllerFunction(controllerFunction));
+    delete(path, contractDetailsOrTypedHandler, ...functions) {
         return {
-            delete: this.#localParamRequest(functions, controllerFunction)
+            delete: this.#registerRoute('delete', path, this.internal.delete, contractDetailsOrTypedHandler, ...functions)
         };
     }
 }
-/**
- * Router class that sets up routes and middleware for an Express router, for use with controller/routes pattern.
- *
- * @template SV - A type that extends AnySchemaValidator.
- * @template contractDetails - The contract details.
- * @template functions - The handler middlware and function.
- */
-export function typedHandler(_schemaValidator, contractDetails, ...functions) {
-    return {
-        contractDetails,
-        functions
-    };
-}

package/lib/dist/lib/src/http/types/apiDefinition.types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=apiDefinition.types.d.ts.map

package/lib/dist/lib/src/http/types/apiDefinition.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiDefinition.types.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/types/apiDefinition.types.js"],"names":[],"mappings":""}

package/lib/dist/lib/src/http/types/apiDefinition.types.js

@@ -0,0 +1 @@
+export {};

package/lib/dist/lib/src/http/types/contractDetails.types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=contractDetails.types.d.ts.map

package/lib/dist/lib/src/http/types/contractDetails.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractDetails.types.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/types/contractDetails.types.js"],"names":[],"mappings":""}

package/lib/dist/lib/src/http/types/contractDetails.types.js

@@ -0,0 +1 @@
+export {};

package/lib/dist/lib/src/http/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./apiDefinition.types";
+export * from "./contractDetails.types";
+export * from "./router.types";
+//# sourceMappingURL=index.d.ts.map

package/lib/dist/lib/src/http/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/types/index.js"],"names":[],"mappings":""}

package/lib/dist/lib/src/http/types/index.js

@@ -0,0 +1,3 @@
+export * from './apiDefinition.types';
+export * from './contractDetails.types';
+export * from './router.types';

package/lib/dist/lib/src/http/types/router.types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=router.types.d.ts.map

package/lib/dist/lib/src/http/types/router.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"router.types.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/types/router.types.js"],"names":[],"mappings":""}

package/lib/dist/lib/src/http/types/router.types.js

@@ -0,0 +1 @@
+export {};

package/lib/dist/lib/src/http/utils/enrichExpressLikeSend.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Enhances the Express-like `send` method with additional logic for response handling and validation.
+ *
+ * This function intercepts the `send` method to provide custom behavior, including response validation
+ * through the `parseResponse` middleware. If the response status is 404, it sends a "Not Found" message.
+ * If the response validation fails, it sends a parsing error message. Otherwise, it calls the original `send`
+ * method with the provided data.
+ *
+ * @template SV - The type of the schema validator used in the request.
+ * @template P - The type of the parameters dictionary used in the request.
+ * @template ResBodyMap - A record type mapping status codes to response body types.
+ * @template ReqBody - The type of the request body.
+ * @template ReqQuery - The type of the parsed query string.
+ * @template ReqHeaders - The type of the request headers.
+ * @template ResHeaders - The type of the response headers, extended from `ForklaunchResHeaders`.
+ * @template LocalsObj - The type of the locals object in the response.
+ *
+ * @param {unknown} instance - The context (typically `this`) in which the original `send` method is called.
+ * @param {ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>} req - The request object, containing the schema validator and other request data.
+ * @param {ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>} res - The response object, including headers and body data.
+ * @param {Function} originalSend - The original `send` method from the response object, to be called after custom logic.
+ * @param {string | ArrayBuffer | ArrayBufferView | NodeJS.ReadableStream | null | undefined} data - The data to be sent as the response body.
+ * @param {boolean} shouldEnrich - A flag indicating whether the response should be sent immediately.
+ *
+ * @returns {unknown} The return value of the original `send` method, typically the response itself.
+ */
+export function enrichExpressLikeSend<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>(instance: unknown, req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, originalSend: Function, data: string | ArrayBuffer | ArrayBufferView | NodeJS.ReadableStream | null | undefined, shouldEnrich: boolean): unknown;
+//# sourceMappingURL=enrichExpressLikeSend.d.ts.map

package/lib/dist/lib/src/http/utils/enrichExpressLikeSend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrichExpressLikeSend.d.ts","sourceRoot":"","sources":["../../../../../../dist/lib/src/http/utils/enrichExpressLikeSend.js"],"names":[],"mappings":"AACA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,sCAlBa,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,YAEX,OAAO,OACP,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,OACvD,kBAAkB,CAAC,UAAU,EAAE,oBAAoB,GAAG,UAAU,EAAE,SAAS,CAAC,gCAE5E,MAAM,GAAG,WAAW,GAAG,eAAe,GAAG,MAAM,CAAC,cAAc,GAAG,IAAI,GAAG,SAAS,gBACjF,OAAO,GAEL,OAAO,CAwBnB"}

package/lib/dist/lib/src/http/utils/enrichExpressLikeSend.js

@@ -0,0 +1,50 @@
+import { parse } from '../middleware/response/parse.middleware';
+/**
+ * Enhances the Express-like `send` method with additional logic for response handling and validation.
+ *
+ * This function intercepts the `send` method to provide custom behavior, including response validation
+ * through the `parseResponse` middleware. If the response status is 404, it sends a "Not Found" message.
+ * If the response validation fails, it sends a parsing error message. Otherwise, it calls the original `send`
+ * method with the provided data.
+ *
+ * @template SV - The type of the schema validator used in the request.
+ * @template P - The type of the parameters dictionary used in the request.
+ * @template ResBodyMap - A record type mapping status codes to response body types.
+ * @template ReqBody - The type of the request body.
+ * @template ReqQuery - The type of the parsed query string.
+ * @template ReqHeaders - The type of the request headers.
+ * @template ResHeaders - The type of the response headers, extended from `ForklaunchResHeaders`.
+ * @template LocalsObj - The type of the locals object in the response.
+ *
+ * @param {unknown} instance - The context (typically `this`) in which the original `send` method is called.
+ * @param {ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>} req - The request object, containing the schema validator and other request data.
+ * @param {ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>} res - The response object, including headers and body data.
+ * @param {Function} originalSend - The original `send` method from the response object, to be called after custom logic.
+ * @param {string | ArrayBuffer | ArrayBufferView | NodeJS.ReadableStream | null | undefined} data - The data to be sent as the response body.
+ * @param {boolean} shouldEnrich - A flag indicating whether the response should be sent immediately.
+ *
+ * @returns {unknown} The return value of the original `send` method, typically the response itself.
+ */
+export function enrichExpressLikeSend(instance, req, res, originalSend, data, shouldEnrich) {
+    let parseErrorSent;
+    if (shouldEnrich) {
+        if (res.statusCode === 404) {
+            res.status(404);
+            originalSend.call(instance, 'Not Found');
+        }
+        parse(req, res, (err) => {
+            if (err) {
+                let errorString = err.message;
+                if (res.locals.errorMessage) {
+                    errorString += `\n------------------\n${res.locals.errorMessage}`;
+                }
+                res.status(500);
+                originalSend.call(instance, errorString);
+                parseErrorSent = true;
+            }
+        });
+    }
+    if (!parseErrorSent) {
+        originalSend.call(instance, data);
+    }
+}