@forklaunch/core 0.2.3 → 0.2.6

package/lib/dist/http/middleware/response.middleware.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Middleware to parse and validate the response according to the provided schema.
+ *
+ * This function validates the response against a schema provided by the request's schema validator.
+ * If the response does not conform to the schema, the behavior is determined by the `responseValidation`
+ * option in `req.contractDetails.options`:
+ * - `'error'` (default): Calls `next` with an error.
+ * - `'warning'`: Logs a warning to the console.
+ * - `'none'`: Silently continues without action.
+ *
+ * @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 {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 {ForklaunchNextFunction} [next] - The next middleware function to be called. If not provided, the function will return after processing.
+ *
+ * @returns {void} This function does not return a value.
+ */
+export function parseResponse<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, next?: any): void;
+//# sourceMappingURL=response.middleware.d.ts.map

package/lib/dist/http/middleware/response.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.middleware.d.ts","sourceRoot":"","sources":["../../../../dist/http/middleware/response.middleware.js"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,8BAfa,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,OAEX,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,OACvD,kBAAkB,CAAC,UAAU,EAAE,oBAAoB,GAAG,UAAU,EAAE,SAAS,CAAC,eAG1E,IAAI,CA4BhB"}

package/lib/dist/http/middleware/response.middleware.js

@@ -0,0 +1,52 @@
+/**
+ * Middleware to parse and validate the response according to the provided schema.
+ *
+ * This function validates the response against a schema provided by the request's schema validator.
+ * If the response does not conform to the schema, the behavior is determined by the `responseValidation`
+ * option in `req.contractDetails.options`:
+ * - `'error'` (default): Calls `next` with an error.
+ * - `'warning'`: Logs a warning to the console.
+ * - `'none'`: Silently continues without action.
+ *
+ * @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 {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 {ForklaunchNextFunction} [next] - The next middleware function to be called. If not provided, the function will return after processing.
+ *
+ * @returns {void} This function does not return a value.
+ */
+export function parseResponse(req, res, next) {
+    console.debug('[MIDDLEWARE] parseResponse started');
+    const { headers, responses } = res.responseSchemas;
+    const parsedResponse = req.schemaValidator.parse(responses?.[res.statusCode], res.bodyData);
+    const parsedHeaders = req.schemaValidator.parse(headers, res.getHeaders());
+    const parseErrors = [];
+    if (!parsedHeaders.ok) {
+        parseErrors.push(`${parsedHeaders.error ? `Header ${parsedHeaders.error}` : ''}`);
+    }
+    if (!parsedResponse.ok) {
+        parseErrors.push(`${parsedResponse.error ? `Response ${parsedResponse.error}` : ''}`);
+    }
+    if (parseErrors.length > 0) {
+        switch (req.contractDetails.options?.responseValidation) {
+            default:
+            case 'error':
+                next?.(new Error(`Invalid response:\n${parseErrors.join('\n\n')}`));
+                break;
+            case 'warning':
+                console.warn(`Invalid response:\n${parseErrors.join('\n\n')}`);
+                break;
+            case 'none':
+                break;
+        }
+    }
+    next?.();
+}

package/lib/dist/http/openApiV3Generator/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./openApiV3Generator";
+//# sourceMappingURL=index.d.ts.map

package/lib/dist/http/openApiV3Generator/index.d.ts.map

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

package/lib/dist/http/openApiV3Generator/index.js

@@ -0,0 +1 @@
+export * from './openApiV3Generator';

package/lib/dist/http/openApiV3Generator/openApiV3Generator.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Generates a Swagger document from given routers.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SV} schemaValidator - The schema validator.
+ * @param {string | number} port - The port on which the server is running.
+ * @param {ForklaunchRouter<SV>[]} routers - The routers to include in the Swagger document.
+ * @returns {OpenAPIObject} - The generated Swagger document.
+ */
+export function generateSwaggerDocument<SV>(schemaValidator: SV, port: string | number, routers: ForklaunchRouter<SV>[]): OpenAPIObject;
+//# sourceMappingURL=openApiV3Generator.d.ts.map

package/lib/dist/http/openApiV3Generator/openApiV3Generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openApiV3Generator.d.ts","sourceRoot":"","sources":["../../../../dist/http/openApiV3Generator/openApiV3Generator.js"],"names":[],"mappings":"AA6EA;;;;;;;;GAQG;AACH,wCANa,EAAE,mBACJ,EAAE,QACF,MAAM,GAAG,MAAM,WACf,gBAAgB,CAAC,EAAE,CAAC,EAAE,GACpB,aAAa,CAkFzB"}

package/{dist/http → lib/dist/http/openApiV3Generator}/openApiV3Generator.js

@@ -1,4 +1,4 @@
-import HTTPStatuses from './httpStatusCodes';
+import HTTPStatuses from '../utils/httpStatusCodes';
 /**
  * Capitalizes the first letter of a string.
  *
@@ -75,28 +75,6 @@ function contentResolver(schemaValidator, body) {
             }
         };
 }
-/**
- * Maps a method to a Swagger method type.
- *
- * @param {string} method - The method to map.
- * @returns {string} - The mapped method.
- */
-function mapMethodType(method) {
-    switch (method) {
-        case 'GET':
-            return 'get';
-        case 'POST':
-            return 'post';
-        case 'PUT':
-            return 'put';
-        case 'DELETE':
-            return 'delete';
-        case 'PATCH':
-            return 'patch';
-        default:
-            return 'get';
-    }
-}
 /**
  * Generates a Swagger document from given routers.
  *
@@ -182,7 +160,7 @@ export function generateSwaggerDocument(schemaValidator, port, routers) {
                     ];
                 }
             }
-            paths[fullPath][mapMethodType(route.method)] = pathItemObject;
+            paths[fullPath][route.method] = pathItemObject;
         });
     });
     return swaggerDocument(port, tags, paths);

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

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

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

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

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

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

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

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

package/lib/dist/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/http/types/index.d.ts.map

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

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

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

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

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

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

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

package/lib/dist/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/http/utils/enrichExpressLikeSend.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrichExpressLikeSend.d.ts","sourceRoot":"","sources":["../../../../dist/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/http/utils/enrichExpressLikeSend.js

@@ -0,0 +1,50 @@
+import { parseResponse } from '../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');
+        }
+        parseResponse(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);
+    }
+}