@forklaunch/core 0.2.3 → 0.2.6

package/lib/src/http/middleware/request/auth.middleware.js

@@ -0,0 +1,107 @@
+import * as jose from 'jose';
+/**
+ * Checks the authorization token for validity.
+ *
+ * @param {AuthMethod} [authorizationMethod] - The method of authorization.
+ * @param {string} [authorizationString] - The authorization string.
+ * @returns {Promise<[401 | 403, string] | string | undefined>} - The result of the authorization check.
+ */
+async function checkAuthorizationToken(authorizationMethod, authorizationString) {
+    if (!authorizationString) {
+        return [401, 'No Authorization token provided.'];
+    }
+    switch (authorizationMethod) {
+        case 'jwt': {
+            if (!authorizationString.startsWith('Bearer ')) {
+                return [401, 'Invalid Authorization token format.'];
+            }
+            try {
+                const decodedJwt = await jose.jwtVerify(authorizationString.split(' ')[1], new TextEncoder().encode(process.env.JWT_SECRET || 'your-256-bit-secret'));
+                return decodedJwt.payload.iss;
+            }
+            catch (error) {
+                console.error(error);
+                return [403, 'Invalid Authorization token.'];
+            }
+        }
+        default:
+            return [401, 'Invalid Authorization method.'];
+    }
+}
+/**
+ * Maps roles from authorization.
+ *
+ * @param {AuthMethod} [authorizationType] - The method of authorization.
+ * @param {string} [authorizationToken] - The authorization token.
+ * @returns {string[]} - The mapped roles.
+ */
+// function mapRoles(
+//   authorizationType?: AuthMethod,
+//   authorizationToken?: string
+// ): string[] {
+//   return [];
+// }
+/**
+ * Maps permissions from authorization.
+ *
+ * @param {AuthMethod} [authorizationType] - The method of authorization.
+ * @param {string} [authorizationToken] - The authorization token.
+ * @returns {string[]} - The mapped permissions.
+ */
+// function mapPermissions(
+//   authorizationType?: AuthMethod,
+//   authorizationToken?: string
+// ): string[] {
+//   return [];
+// }
+/**
+ * Middleware to parse request authorization.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export async function parseRequestAuth(req, res, next) {
+    const auth = req.contractDetails.auth;
+    if (auth) {
+        const errorAndMessage = await checkAuthorizationToken(auth.method, req.headers.authorization);
+        if (Array.isArray(errorAndMessage)) {
+            res.status(errorAndMessage[0]).send(errorAndMessage[1]);
+            next?.(new Error(errorAndMessage[1]));
+        }
+        // TODO: Implement role and permission checking
+        //   const permissionSlugs = mapPermissions(
+        //     auth.method,
+        //     req.headers.authorization
+        //   );
+        //   const roles = mapRoles(auth.method, req.headers.authorization);
+        //   const permissionErrorMessage =
+        //     'User does not have sufficient permissions to perform action.';
+        //   const roleErrorMessage =
+        //     'User does not have correct role to perform action.';
+        //   permissionSlugs.forEach((permissionSlug) => {
+        //     if (
+        //       !req.contractDetails.auth?.allowedSlugs?.has(permissionSlug) ||
+        //       req.contractDetails.auth?.forbiddenSlugs?.has(permissionSlug)
+        //     ) {
+        //       res.status(403).send(permissionErrorMessage);
+        //       next?.(new Error(permissionErrorMessage));
+        //       }
+        //     }
+        //   });
+        //   roles.forEach((role) => {
+        //     if (
+        //       !req.contractDetails.auth?.allowedRoles?.has(role) ||
+        //       req.contractDetails.auth?.forbiddenRoles?.has(role)
+        //     ) {
+        //       res.status(403).send(roleErrorMessage);
+        //       next?.(new Error(roleErrorMessage));
+        //     }
+        //   });
+    }
+    // next?.();
+}

package/lib/src/http/middleware/request/cors.middleware.d.ts

@@ -0,0 +1,13 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ParsedQs } from 'qs';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResHeaders, ForklaunchResponse } from '../../types/apiDefinition.types';
+import { ParamsDictionary } from '../../types/contractDetails.types';
+/**
+ * Cors middleware handler
+ *
+ * @param req - Express-like request object
+ * @param res - Express-like response object
+ * @param next - Express-like next function
+ */
+export declare function cors<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): void;
+//# sourceMappingURL=cors.middleware.d.ts.map

package/lib/src/http/middleware/request/cors.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cors.middleware.d.ts","sourceRoot":"","sources":["../../../../../src/http/middleware/request/cors.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC9B,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE;;;;;;GAMG;AACH,wBAAgB,IAAI,CAClB,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,GAAG,EAAE,kBAAkB,CACrB,UAAU,EACV,oBAAoB,GAAG,UAAU,EACjC,SAAS,CACV,EACD,IAAI,CAAC,EAAE,sBAAsB,QAO9B"}

package/lib/src/http/middleware/request/cors.middleware.js

@@ -0,0 +1,15 @@
+import corsMiddleware from 'cors';
+/**
+ * Cors middleware handler
+ *
+ * @param req - Express-like request object
+ * @param res - Express-like response object
+ * @param next - Express-like next function
+ */
+export function cors(req, res, next) {
+    console.debug('[MIDDLEWARE] cors started');
+    if (req.method === 'OPTIONS') {
+        res.cors = true;
+    }
+    corsMiddleware()(req, res, next ?? (() => { }));
+}

package/lib/src/http/middleware/request/createContext.middleware.d.ts

@@ -0,0 +1,15 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ExpressLikeSchemaHandler } from '../../types/apiDefinition.types';
+import { Body, HeadersObject, ParamsObject, QueryObject, ResponsesObject } from '../../types/contractDetails.types';
+/**
+ * Middleware to create and add a request context.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {SV} schemaValidator - The schema validator.
+ * @returns {Function} - Middleware function to create request context.
+ */
+export declare function createContext<SV extends AnySchemaValidator, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV): ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>;
+//# sourceMappingURL=createContext.middleware.d.ts.map

package/lib/src/http/middleware/request/createContext.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createContext.middleware.d.ts","sourceRoot":"","sources":["../../../../../src/http/middleware/request/createContext.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAmB,MAAM,uBAAuB,CAAC;AAE5E,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EACL,IAAI,EACJ,aAAa,EACb,YAAY,EACZ,WAAW,EACX,eAAe,EAChB,MAAM,mCAAmC,CAAC;AAE3C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,YAAY,CAAC,EAAE,CAAC,EAC1B,UAAU,SAAS,eAAe,CAAC,EAAE,CAAC,EACtC,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC,EACxB,QAAQ,SAAS,WAAW,CAAC,EAAE,CAAC,EAChC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,eAAe,EAAE,EAAE,GAClB,wBAAwB,CACzB,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,CAmBA"}

package/lib/src/http/middleware/request/createContext.middleware.js

@@ -0,0 +1,26 @@
+import { v4 } from 'uuid';
+/**
+ * Middleware to create and add a request context.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {SV} schemaValidator - The schema validator.
+ * @returns {Function} - Middleware function to create request context.
+ */
+export function createContext(schemaValidator) {
+    return (req, res, next) => {
+        console.debug('[MIDDLEWARE] createRequestContext started');
+        req.schemaValidator = schemaValidator;
+        let correlationId = v4();
+        if (req.headers['x-correlation-id']) {
+            correlationId = req.headers['x-correlation-id'];
+        }
+        res.setHeader('x-correlation-id', correlationId);
+        req.context = {
+            correlationId: correlationId
+        };
+        next?.();
+    };
+}

package/lib/src/http/middleware/request/enrichDetails.middleware.d.ts

@@ -0,0 +1,15 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ExpressLikeSchemaHandler } from '../../types/apiDefinition.types';
+import { Body, HeadersObject, HttpContractDetails, ParamsObject, PathParamHttpContractDetails, QueryObject, ResponseCompiledSchema, ResponsesObject } from '../../types/contractDetails.types';
+/**
+ * Middleware to enrich the request details with contract details.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {PathParamHttpContractDetails<SV> | HttpContractDetails<SV>} contractDetails - The contract details.
+ * @returns {Function} - Middleware function to enrich request details.
+ */
+export declare function enrichDetails<SV extends AnySchemaValidator, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(contractDetails: HttpContractDetails<SV> | PathParamHttpContractDetails<SV>, requestSchema: unknown, responseSchemas: ResponseCompiledSchema): ExpressLikeSchemaHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>;
+//# sourceMappingURL=enrichDetails.middleware.d.ts.map

package/lib/src/http/middleware/request/enrichDetails.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"enrichDetails.middleware.d.ts","sourceRoot":"","sources":["../../../../../src/http/middleware/request/enrichDetails.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,wBAAwB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,OAAO,EACL,IAAI,EACJ,aAAa,EACb,mBAAmB,EACnB,YAAY,EACZ,4BAA4B,EAC5B,WAAW,EACX,sBAAsB,EACtB,eAAe,EAChB,MAAM,mCAAmC,CAAC;AAE3C;;;;;;;;;GASG;AACH,wBAAgB,aAAa,CAC3B,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,YAAY,CAAC,EAAE,CAAC,EAC1B,UAAU,SAAS,eAAe,CAAC,EAAE,CAAC,EACtC,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC,EACxB,QAAQ,SAAS,WAAW,CAAC,EAAE,CAAC,EAChC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,eAAe,EAAE,mBAAmB,CAAC,EAAE,CAAC,GAAG,4BAA4B,CAAC,EAAE,CAAC,EAC3E,aAAa,EAAE,OAAO,EACtB,eAAe,EAAE,sBAAsB,GACtC,wBAAwB,CACzB,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,CAQA"}

package/lib/src/http/middleware/request/enrichDetails.middleware.js

@@ -0,0 +1,19 @@
+/**
+ * Middleware to enrich the request details with contract details.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {PathParamHttpContractDetails<SV> | HttpContractDetails<SV>} contractDetails - The contract details.
+ * @returns {Function} - Middleware function to enrich request details.
+ */
+export function enrichDetails(contractDetails, requestSchema, responseSchemas) {
+    return (req, res, next) => {
+        console.debug('[MIDDLEWARE] enrichRequestDetails started');
+        req.contractDetails = contractDetails;
+        req.requestSchema = requestSchema;
+        res.responseSchemas = responseSchemas;
+        next?.();
+    };
+}

package/lib/src/http/middleware/request/parse.middleware.d.ts

@@ -0,0 +1,17 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ParsedQs } from 'qs';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResponse } from '../../types/apiDefinition.types';
+import { ParamsDictionary } from '../../types/contractDetails.types';
+/**
+ * Pre-handler function to parse and validate input.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export declare function parse<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, _res: ForklaunchResponse<ResBodyMap, ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): void;
+//# sourceMappingURL=parse.middleware.d.ts.map

package/lib/src/http/middleware/request/parse.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.middleware.d.ts","sourceRoot":"","sources":["../../../../../src/http/middleware/request/parse.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAE9B,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE;;;;;;;;;;GAUG;AACH,wBAAgB,KAAK,CACnB,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,IAAI,EAAE,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,EAC3D,IAAI,CAAC,EAAE,sBAAsB,QAoC9B"}

package/lib/src/http/middleware/request/parse.middleware.js

@@ -0,0 +1,43 @@
+import { isResponseShape } from '../../guards/isResponseShape';
+/**
+ * Pre-handler function to parse and validate input.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export function parse(req, _res, next) {
+    console.debug('[MIDDLEWARE] parseRequest started');
+    const request = {
+        params: req.params,
+        query: req.query,
+        headers: req.headers,
+        body: req.body
+    };
+    const parsedRequest = req.schemaValidator.parse(req.requestSchema, request);
+    if (parsedRequest.ok &&
+        isResponseShape(parsedRequest.value)) {
+        req.body = parsedRequest.value.body;
+        req.params = parsedRequest.value.params;
+        req.query = parsedRequest.value.query;
+        req.headers = parsedRequest.value.headers;
+    }
+    if (!parsedRequest.ok) {
+        switch (req.contractDetails.options?.requestValidation) {
+            default:
+            case 'error':
+                next?.(new Error(`Invalid request: ${parsedRequest.error}`));
+                break;
+            case 'warning':
+                console.warn(`Invalid request: ${parsedRequest.error}`);
+                break;
+            case 'none':
+                break;
+        }
+    }
+    next?.();
+}

package/lib/src/http/middleware/request.middleware.d.ts

@@ -0,0 +1,73 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ParsedQs } from 'qs';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResHeaders, ForklaunchResponse, ForklaunchSchemaMiddlewareHandler } from '../types/apiDefinition.types';
+import { Body, ContractDetails, HeadersObject, Method, ParamsDictionary, ParamsObject, QueryObject, ResponseCompiledSchema, ResponsesObject } from '../types/contractDetails.types';
+/**
+ * Cors middleware handler
+ *
+ * @param req - Express-like request object
+ * @param res - Express-like response object
+ * @param next - Express-like next function
+ */
+export declare function corsMiddleware<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): void;
+/**
+ * Middleware to create and add a request context.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {SV} schemaValidator - The schema validator.
+ * @returns {Function} - Middleware function to create request context.
+ */
+export declare function createRequestContext<SV extends AnySchemaValidator, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(schemaValidator: SV): ForklaunchSchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>;
+/**
+ * Middleware to enrich the request details with contract details.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {PathParamHttpContractDetails<SV> | HttpContractDetails<SV>} contractDetails - The contract details.
+ * @returns {Function} - Middleware function to enrich request details.
+ */
+export declare function enrichRequestDetails<SV extends AnySchemaValidator, ContractMethod extends Method, Path extends `/${string}`, P extends ParamsObject<SV>, ResBodyMap extends ResponsesObject<SV>, ReqBody extends Body<SV>, ReqQuery extends QueryObject<SV>, ReqHeaders extends HeadersObject<SV>, ResHeaders extends HeadersObject<SV>, LocalsObj extends Record<string, unknown>>(contractDetails: ContractDetails<SV, ContractMethod, Path, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders>, requestSchema: unknown, responseSchemas: ResponseCompiledSchema): ForklaunchSchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, ReqHeaders, ResHeaders, LocalsObj>;
+/**
+ * Pre-handler function to parse and validate input.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export declare function parseRequest<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, _res: ForklaunchResponse<ResBodyMap, ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): void;
+/**
+ * Maps roles from authorization.
+ *
+ * @param {AuthMethod} [authorizationType] - The method of authorization.
+ * @param {string} [authorizationToken] - The authorization token.
+ * @returns {string[]} - The mapped roles.
+ */
+/**
+ * Maps permissions from authorization.
+ *
+ * @param {AuthMethod} [authorizationType] - The method of authorization.
+ * @param {string} [authorizationToken] - The authorization token.
+ * @returns {string[]} - The mapped permissions.
+ */
+/**
+ * Middleware to parse request authorization.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export declare function parseRequestAuth<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): Promise<void>;
+//# sourceMappingURL=request.middleware.d.ts.map

package/lib/src/http/middleware/request.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.middleware.d.ts","sourceRoot":"","sources":["../../../../src/http/middleware/request.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAmB,MAAM,uBAAuB,CAAC;AAG5E,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAG9B,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,iCAAiC,EAClC,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,IAAI,EACJ,eAAe,EACf,aAAa,EACb,MAAM,EACN,gBAAgB,EAChB,YAAY,EACZ,WAAW,EACX,sBAAsB,EACtB,eAAe,EAChB,MAAM,gCAAgC,CAAC;AAExC;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC5B,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,GAAG,EAAE,kBAAkB,CACrB,UAAU,EACV,oBAAoB,GAAG,UAAU,EACjC,SAAS,CACV,EACD,IAAI,CAAC,EAAE,sBAAsB,QAO9B;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,YAAY,CAAC,EAAE,CAAC,EAC1B,UAAU,SAAS,eAAe,CAAC,EAAE,CAAC,EACtC,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC,EACxB,QAAQ,SAAS,WAAW,CAAC,EAAE,CAAC,EAChC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,eAAe,EAAE,EAAE,GAClB,iCAAiC,CAClC,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,CAmBA;AAED;;;;;;;;;GASG;AACH,wBAAgB,oBAAoB,CAClC,EAAE,SAAS,kBAAkB,EAC7B,cAAc,SAAS,MAAM,EAC7B,IAAI,SAAS,IAAI,MAAM,EAAE,EACzB,CAAC,SAAS,YAAY,CAAC,EAAE,CAAC,EAC1B,UAAU,SAAS,eAAe,CAAC,EAAE,CAAC,EACtC,OAAO,SAAS,IAAI,CAAC,EAAE,CAAC,EACxB,QAAQ,SAAS,WAAW,CAAC,EAAE,CAAC,EAChC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,UAAU,SAAS,aAAa,CAAC,EAAE,CAAC,EACpC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,eAAe,EAAE,eAAe,CAC9B,EAAE,EACF,cAAc,EACd,IAAI,EACJ,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,CACX,EACD,aAAa,EAAE,OAAO,EACtB,eAAe,EAAE,sBAAsB,GACtC,iCAAiC,CAClC,EAAE,EACF,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,UAAU,EACV,UAAU,EACV,SAAS,CACV,CAQA;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,YAAY,CAC1B,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,IAAI,EAAE,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,EAC3D,IAAI,CAAC,EAAE,sBAAsB,QAoC9B;AAuCD;;;;;;GAMG;AAQH;;;;;;GAMG;AAQH;;;;;;;;;;GAUG;AACH,wBAAsB,gBAAgB,CACpC,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,GAAG,EAAE,kBAAkB,CAAC,UAAU,EAAE,UAAU,EAAE,SAAS,CAAC,EAC1D,IAAI,CAAC,EAAE,sBAAsB,iBA+C9B"}

package/lib/src/http/middleware/request.middleware.js

@@ -0,0 +1,210 @@
+import cors from 'cors';
+import * as jose from 'jose';
+import { v4 } from 'uuid';
+import { isResponseShape } from '../guards/isResponseShape';
+/**
+ * Cors middleware handler
+ *
+ * @param req - Express-like request object
+ * @param res - Express-like response object
+ * @param next - Express-like next function
+ */
+export function corsMiddleware(req, res, next) {
+    console.debug('[MIDDLEWARE] cors started');
+    if (req.method === 'OPTIONS') {
+        res.cors = true;
+    }
+    cors()(req, res, next ?? (() => { }));
+}
+/**
+ * Middleware to create and add a request context.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {SV} schemaValidator - The schema validator.
+ * @returns {Function} - Middleware function to create request context.
+ */
+export function createRequestContext(schemaValidator) {
+    return (req, res, next) => {
+        console.debug('[MIDDLEWARE] createRequestContext started');
+        req.schemaValidator = schemaValidator;
+        let correlationId = v4();
+        if (req.headers['x-correlation-id']) {
+            correlationId = req.headers['x-correlation-id'];
+        }
+        res.setHeader('x-correlation-id', correlationId);
+        req.context = {
+            correlationId: correlationId
+        };
+        next?.();
+    };
+}
+/**
+ * Middleware to enrich the request details with contract details.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {PathParamHttpContractDetails<SV> | HttpContractDetails<SV>} contractDetails - The contract details.
+ * @returns {Function} - Middleware function to enrich request details.
+ */
+export function enrichRequestDetails(contractDetails, requestSchema, responseSchemas) {
+    return (req, res, next) => {
+        console.debug('[MIDDLEWARE] enrichRequestDetails started');
+        req.contractDetails = contractDetails;
+        req.requestSchema = requestSchema;
+        res.responseSchemas = responseSchemas;
+        next?.();
+    };
+}
+/**
+ * Pre-handler function to parse and validate input.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export function parseRequest(req, _res, next) {
+    console.debug('[MIDDLEWARE] parseRequest started');
+    const request = {
+        params: req.params,
+        query: req.query,
+        headers: req.headers,
+        body: req.body
+    };
+    const parsedRequest = req.schemaValidator.parse(req.requestSchema, request);
+    if (parsedRequest.ok &&
+        isResponseShape(parsedRequest.value)) {
+        req.body = parsedRequest.value.body;
+        req.params = parsedRequest.value.params;
+        req.query = parsedRequest.value.query;
+        req.headers = parsedRequest.value.headers;
+    }
+    if (!parsedRequest.ok) {
+        switch (req.contractDetails.options?.requestValidation) {
+            default:
+            case 'error':
+                next?.(new Error(`Invalid request: ${parsedRequest.error}`));
+                break;
+            case 'warning':
+                console.warn(`Invalid request: ${parsedRequest.error}`);
+                break;
+            case 'none':
+                break;
+        }
+    }
+    next?.();
+}
+/**
+ * Checks the authorization token for validity.
+ *
+ * @param {AuthMethod} [authorizationMethod] - The method of authorization.
+ * @param {string} [authorizationString] - The authorization string.
+ * @returns {Promise<[401 | 403, string] | string | undefined>} - The result of the authorization check.
+ */
+async function checkAuthorizationToken(authorizationMethod, authorizationString) {
+    if (!authorizationString) {
+        return [401, 'No Authorization token provided.'];
+    }
+    switch (authorizationMethod) {
+        case 'jwt': {
+            if (!authorizationString.startsWith('Bearer ')) {
+                return [401, 'Invalid Authorization token format.'];
+            }
+            try {
+                const decodedJwt = await jose.jwtVerify(authorizationString.split(' ')[1], new TextEncoder().encode(process.env.JWT_SECRET || 'your-256-bit-secret'));
+                return decodedJwt.payload.iss;
+            }
+            catch (error) {
+                console.error(error);
+                return [403, 'Invalid Authorization token.'];
+            }
+        }
+        default:
+            return [401, 'Invalid Authorization method.'];
+    }
+}
+/**
+ * Maps roles from authorization.
+ *
+ * @param {AuthMethod} [authorizationType] - The method of authorization.
+ * @param {string} [authorizationToken] - The authorization token.
+ * @returns {string[]} - The mapped roles.
+ */
+// function mapRoles(
+//   authorizationType?: AuthMethod,
+//   authorizationToken?: string
+// ): string[] {
+//   return [];
+// }
+/**
+ * Maps permissions from authorization.
+ *
+ * @param {AuthMethod} [authorizationType] - The method of authorization.
+ * @param {string} [authorizationToken] - The authorization token.
+ * @returns {string[]} - The mapped permissions.
+ */
+// function mapPermissions(
+//   authorizationType?: AuthMethod,
+//   authorizationToken?: string
+// ): string[] {
+//   return [];
+// }
+/**
+ * Middleware to parse request authorization.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template Request - A type that extends ForklaunchRequest.
+ * @template Response - A type that extends ForklaunchResponse.
+ * @template NextFunction - A type that extends ForklaunchNextFunction.
+ * @param {Request} req - The request object.
+ * @param {Response} res - The response object.
+ * @param {NextFunction} [next] - The next middleware function.
+ */
+export async function parseRequestAuth(req, res, next) {
+    const auth = req.contractDetails.auth;
+    if (auth) {
+        const errorAndMessage = await checkAuthorizationToken(auth.method, req.headers.authorization);
+        if (Array.isArray(errorAndMessage)) {
+            res.status(errorAndMessage[0]).send(errorAndMessage[1]);
+            next?.(new Error(errorAndMessage[1]));
+        }
+        // TODO: Implement role and permission checking
+        //   const permissionSlugs = mapPermissions(
+        //     auth.method,
+        //     req.headers.authorization
+        //   );
+        //   const roles = mapRoles(auth.method, req.headers.authorization);
+        //   const permissionErrorMessage =
+        //     'User does not have sufficient permissions to perform action.';
+        //   const roleErrorMessage =
+        //     'User does not have correct role to perform action.';
+        //   permissionSlugs.forEach((permissionSlug) => {
+        //     if (
+        //       !req.contractDetails.auth?.allowedSlugs?.has(permissionSlug) ||
+        //       req.contractDetails.auth?.forbiddenSlugs?.has(permissionSlug)
+        //     ) {
+        //       res.status(403).send(permissionErrorMessage);
+        //       next?.(new Error(permissionErrorMessage));
+        //       }
+        //     }
+        //   });
+        //   roles.forEach((role) => {
+        //     if (
+        //       !req.contractDetails.auth?.allowedRoles?.has(role) ||
+        //       req.contractDetails.auth?.forbiddenRoles?.has(role)
+        //     ) {
+        //       res.status(403).send(roleErrorMessage);
+        //       next?.(new Error(roleErrorMessage));
+        //     }
+        //   });
+    }
+    // next?.();
+}

package/lib/src/http/middleware/response/parse.middleware.d.ts

@@ -0,0 +1,31 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ParsedQs } from 'qs';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResHeaders, ForklaunchResponse } from '../../types/apiDefinition.types';
+import { ParamsDictionary } from '../../types/contractDetails.types';
+/**
+ * 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 declare function parse<SV extends AnySchemaValidator, P extends ParamsDictionary, ResBodyMap extends Record<number, unknown>, ReqBody extends Record<string, unknown>, ReqQuery extends ParsedQs, ReqHeaders extends Record<string, string>, ResHeaders extends Record<string, string>, LocalsObj extends Record<string, unknown>>(req: ForklaunchRequest<SV, P, ReqBody, ReqQuery, ReqHeaders>, res: ForklaunchResponse<ResBodyMap, ForklaunchResHeaders & ResHeaders, LocalsObj>, next?: ForklaunchNextFunction): void;
+//# sourceMappingURL=parse.middleware.d.ts.map

package/lib/src/http/middleware/response/parse.middleware.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse.middleware.d.ts","sourceRoot":"","sources":["../../../../../src/http/middleware/response/parse.middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,CAAC;AAC9B,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EACnB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,KAAK,CACnB,EAAE,SAAS,kBAAkB,EAC7B,CAAC,SAAS,gBAAgB,EAC1B,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC1C,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACvC,QAAQ,SAAS,QAAQ,EACzB,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EACzC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAEzC,GAAG,EAAE,iBAAiB,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAC5D,GAAG,EAAE,kBAAkB,CACrB,UAAU,EACV,oBAAoB,GAAG,UAAU,EACjC,SAAS,CACV,EACD,IAAI,CAAC,EAAE,sBAAsB,QAyC9B"}