@forklaunch/core 0.1.3 → 0.1.6

package/dist/http/httpStatusCodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"httpStatusCodes.js","sourceRoot":"","sources":["../../http/httpStatusCodes.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACU,QAAA,YAAY,GAAwC;IAC/D;;;;;;;;;;;;;OAaG;IACH,GAAG,EAAE,UAAU;IAEf;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,qBAAqB;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,YAAY;IAEjB;;;;;;;;;;;OAWG;IACH,GAAG,EAAE,IAAI;IAET;;;;;;;;;;;;OAYG;IACH,GAAG,EAAE,SAAS;IAEd;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,UAAU;IAEf;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,+BAA+B;IAEpC;;;;;;;;;;;;OAYG;IACH,GAAG,EAAE,YAAY;IAEjB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,EAAE,eAAe;IAEpB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAoEG;IACH,GAAG,EAAE,iBAAiB;IAEtB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,GAAG,EAAE,cAAc;IAEnB;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,GAAG,EAAE,kBAAkB;IAEvB;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACH,GAAG,EAAE,SAAS;IAEd;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAqCG;IACH,GAAG,EAAE,kBAAkB;IAEvB;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,GAAG,EAAE,mBAAmB;IAExB;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,OAAO;IAEZ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,GAAG,EAAE,WAAW;IAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,GAAG,EAAE,cAAc;IAEnB;;;OAGG;IACH,GAAG,EAAE,WAAW;IAEhB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,EAAE,oBAAoB;IAEzB;;;;;;;;;;;;;;;;;;;OAmBG;IACH,GAAG,EAAE,oBAAoB;IAEzB;;;;;OAKG;IACH,GAAG,EAAE,aAAa;IAElB;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,cAAc;IAEnB;;OAEG;IACH,GAAG,EAAE,kBAAkB;IAEvB;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,WAAW;IAEhB;;;;;;;;;;;;OAYG;IACH,GAAG,EAAE,WAAW;IAEhB;;;;;;;;;;OAUG;IACH,GAAG,EAAE,oBAAoB;IAEzB;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,gBAAgB;IAErB;;;;;;;OAOG;IACH,GAAG,EAAE,+BAA+B;IAEpC;;;;;;;;OAQG;IACH,GAAG,EAAE,iBAAiB;IAEtB;;;;;;;;;;;;;;;OAeG;IACH,GAAG,EAAE,UAAU;IAEf;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,GAAG,EAAE,MAAM;IAEX;;;;;;OAMG;IACH,GAAG,EAAE,iBAAiB;IAEtB;;;;;;;;OAQG;IACH,GAAG,EAAE,qBAAqB;IAE1B;;;;;;;;;OASG;IACH,GAAG,EAAE,mBAAmB;IAExB;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,sBAAsB;IAE3B;;;;;;;OAOG;IACH,GAAG,EAAE,wBAAwB;IAE7B;;;;;;;;;;;;OAYG;IACH,GAAG,EAAE,iCAAiC;IAEtC;;;;;OAKG;IACH,GAAG,EAAE,oBAAoB;IAEzB;;;OAGG;IACH,GAAG,EAAE,cAAc;IAEnB;;;;;;;;;;;;;;;OAeG;IACH,GAAG,EAAE,qBAAqB;IAE1B;;;;;;;;;OASG;IACH,GAAG,EAAE,sBAAsB;IAE3B;;;;;OAKG;IACH,GAAG,EAAE,QAAQ;IAEb;;;;;;OAMG;IACH,GAAG,EAAE,mBAAmB;IAExB;;;;;;;OAOG;IACH,GAAG,EAAE,kBAAkB;IAEvB;;;;;;;;;;;;;OAaG;IACH,GAAG,EAAE,uBAAuB;IAE5B;;;;;;;;;OASG;IACH,GAAG,EAAE,mBAAmB;IAExB;;;;;;;;OAQG;IACH,GAAG,EAAE,iCAAiC;IAEtC;;;;;;;OAOG;IACH,GAAG,EAAE,oCAAoC;IAEzC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,GAAG,EAAE,+BAA+B;IAEpC;;;OAGG;IACH,GAAG,EAAE,uBAAuB;IAE5B;;;;OAIG;IACH,GAAG,EAAE,uBAAuB;IAE5B;;;;;;;;;OASG;IACH,GAAG,EAAE,iBAAiB;IAEtB;;;;OAIG;IACH,GAAG,EAAE,aAAa;IAElB;;;;;;;OAOG;IACH,GAAG,EAAE,qBAAqB;IAE1B;;;;;OAKG;IACH,GAAG,EAAE,iBAAiB;IAEtB;;;;;;;;;;OAUG;IACH,GAAG,EAAE,4BAA4B;IAEjC;;;;;OAKG;IACH,GAAG,EAAE,yBAAyB;IAE9B;;;;;;;;OAQG;IACH,GAAG,EAAE,sBAAsB;IAE3B;;;;OAIG;IACH,GAAG,EAAE,eAAe;IAEpB;;;;;;;;;;;;;;OAcG;IACH,GAAG,EAAE,cAAc;IAEnB;;;;;;;;;;;;;;;OAeG;IACH,GAAG,EAAE,iCAAiC;IAEtC;;;;OAIG;IACH,GAAG,EAAE,+BAA+B;CAC5B,CAAC;AAOX;;;;;;GAMG;AACI,MAAM,iBAAiB,GAAG,CAAC,IAAY,EAAW,EAAE,CACzD,CAAC,CAAC,oBAAY,CAAC,IAAI,CAAC,CAAC;AADV,QAAA,iBAAiB,qBACP;AAEvB;;;;;GAKG;AACI,MAAM,eAAe,GAAG,CAAC,IAAgB,EAAW,EAAE,CAC3D,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG,GAAG,CAAC;AADf,QAAA,eAAe,mBACA;AAE5B;;;;;GAKG;AACI,MAAM,YAAY,GAAG,CAAC,IAAgB,EAAW,EAAE,CACxD,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG,GAAG,CAAC;AADf,QAAA,YAAY,gBACG;AAE5B;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,IAAgB,EAAW,EAAE,CACzD,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG,GAAG,CAAC;AADf,QAAA,aAAa,iBACE;AAE5B;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,IAAgB,EAAW,EAAE,CACzD,IAAI,IAAI,GAAG,IAAI,IAAI,GAAG,GAAG,CAAC;AADf,QAAA,aAAa,iBACE;AAE5B;;;;;GAKG;AACI,MAAM,aAAa,GAAG,CAAC,IAAgB,EAAW,EAAE,CAAC,IAAI,IAAI,GAAG,CAAC;AAA3D,QAAA,aAAa,iBAA8C;AAExE;;;;;;;;;;GAUG;AACI,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAqB,EAAE;IACpE,MAAM,MAAM,GAAG,MAAM,CAAC,iBAAiB,EAAE,CAAC,IAAI,EAAE,CAAC;IACjD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,oBAAY,CAAC,CAAC,IAAI,CAC7C,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,MAAM,CACzC,CAAC;IACF,IAAI,KAAK;QAAE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAe,CAAC;IACnD,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B;AAEF,kBAAe,oBAAY,CAAC"}

package/dist/http/index.d.ts

@@ -1,2 +1,5 @@
-export * from './middlewares';
+export * from './httpStatusCodes';
+export * from './middleware';
+export * from './openApiV3Generator';
+export * from './regex';
 export * from './types';

package/dist/http/index.js

@@ -14,6 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./middlewares"), exports);
+__exportStar(require("./httpStatusCodes"), exports);
+__exportStar(require("./middleware"), exports);
+__exportStar(require("./openApiV3Generator"), exports);
+__exportStar(require("./regex"), exports);
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/http/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../http/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA8B;AAC9B,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../http/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,+CAA6B;AAC7B,uDAAqC;AACrC,0CAAwB;AACxB,0CAAwB"}

package/dist/http/middleware/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../http/middleware/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,uDAAqC;AACrC,wDAAsC"}

package/dist/http/middleware/request.middleware.d.ts

@@ -0,0 +1,95 @@
+import { AnySchemaValidator, SchemaValidator } from '@forklaunch/validator';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResponse } from '../types/api.types';
+import { HttpContractDetails, PathParamHttpContractDetails, StringOnlyObject } from '../types/primitive.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 createRequestContext<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(schemaValidator: SV): (req: Request, res: Response, next?: NextFunction) => void;
+/**
+ * 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, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(contractDetails: PathParamHttpContractDetails<SV> | HttpContractDetails<SV>): (req: Request, _res: Response, next?: NextFunction) => void;
+/**
+ * Pre-handler function to parse and validate input.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SchemaValidator} schemaValidator - The schema validator.
+ * @param {unknown} object - The object to validate.
+ * @param {StringOnlyObject<SV>} [schemaInput] - The schema input.
+ * @returns {number | void} - Returns 400 if validation fails.
+ */
+export declare function preHandlerParse<SV extends AnySchemaValidator>(schemaValidator: SchemaValidator, object: unknown, schemaInput?: StringOnlyObject<SV>): 400 | undefined;
+/**
+ * Middleware to parse request parameters.
+ *
+ * @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 parseRequestParams<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): void;
+/**
+ * Middleware to parse request body.
+ *
+ * @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 parseRequestBody<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): void;
+/**
+ * Middleware to parse request headers.
+ *
+ * @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 parseRequestHeaders<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): void;
+/**
+ * Middleware to parse request query.
+ *
+ * @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 parseRequestQuery<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): void;
+/**
+ * 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, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): Promise<void>;

package/dist/http/{middlewares → middleware}/request.middleware.js

@@ -33,6 +33,16 @@ exports.parseRequestQuery = parseRequestQuery;
 exports.parseRequestAuth = parseRequestAuth;
 const jose = __importStar(require("jose"));
 const uuid_1 = require("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.
+ */
 function createRequestContext(schemaValidator) {
     return (req, res, next) => {
         req.schemaValidator = schemaValidator;
@@ -49,6 +59,16 @@ function createRequestContext(schemaValidator) {
         }
     };
 }
+/**
+ * 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.
+ */
 function enrichRequestDetails(contractDetails) {
     return (req, _res, next) => {
         req.contractDetails = contractDetails;
@@ -57,6 +77,15 @@ function enrichRequestDetails(contractDetails) {
         }
     };
 }
+/**
+ * Pre-handler function to parse and validate input.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SchemaValidator} schemaValidator - The schema validator.
+ * @param {unknown} object - The object to validate.
+ * @param {StringOnlyObject<SV>} [schemaInput] - The schema input.
+ * @returns {number | void} - Returns 400 if validation fails.
+ */
 function preHandlerParse(schemaValidator, object, schemaInput) {
     if (!schemaInput) {
         return;
@@ -66,6 +95,17 @@ function preHandlerParse(schemaValidator, object, schemaInput) {
         return 400;
     }
 }
+/**
+ * Middleware to parse request parameters.
+ *
+ * @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.
+ */
 function parseRequestParams(req, res, next) {
     const params = req.contractDetails.params;
     if (preHandlerParse(req.schemaValidator, req.params, params) === 400) {
@@ -78,6 +118,17 @@ function parseRequestParams(req, res, next) {
         next();
     }
 }
+/**
+ * Middleware to parse request body.
+ *
+ * @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.
+ */
 function parseRequestBody(req, res, next) {
     if (req.headers['content-type'] === 'application/json') {
         const body = (req.schemaValidator,
@@ -93,6 +144,17 @@ function parseRequestBody(req, res, next) {
         next();
     }
 }
+/**
+ * Middleware to parse request headers.
+ *
+ * @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.
+ */
 function parseRequestHeaders(req, res, next) {
     const headers = req.contractDetails.requestHeaders;
     if (preHandlerParse(req.schemaValidator, req.headers, headers) === 400) {
@@ -105,6 +167,17 @@ function parseRequestHeaders(req, res, next) {
         next();
     }
 }
+/**
+ * Middleware to parse request query.
+ *
+ * @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.
+ */
 function parseRequestQuery(req, res, next) {
     const query = req.contractDetails.query;
     if (preHandlerParse(req.schemaValidator, req.query, query) === 400) {
@@ -117,6 +190,13 @@ function parseRequestQuery(req, res, next) {
         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.'];
@@ -139,12 +219,37 @@ async function checkAuthorizationToken(authorizationMethod, authorizationString)
             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, authorizationToken) {
     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, authorizationToken) {
     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.
+ */
 async function parseRequestAuth(req, res, next) {
     const auth = req.contractDetails.auth;
     if (auth) {
@@ -160,8 +265,6 @@ async function parseRequestAuth(req, res, next) {
         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.';
-        // this is wrong, we need to check if any of the user's permissions are in the allowed permissions, while checking that any of the permissions is not in the forbidden slugs
-        // currently this is checking if any of the user's permissions are NOT in the allowed permissions
         permissionSlugs.forEach((permissionSlug) => {
             if (!req.contractDetails.auth?.allowedSlugs?.has(permissionSlug) ||
                 req.contractDetails.auth?.forbiddenSlugs?.has(permissionSlug)) {

package/dist/http/middleware/request.middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.middleware.js","sourceRoot":"","sources":["../../../http/middleware/request.middleware.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAyBA,oDAyBC;AAYD,oDAaC;AAWD,0CAaC;AAaD,gDAgBC;AAaD,4CAyBC;AAaD,kDAgBC;AAaD,8CAgBC;AA8ED,4CA0DC;AAvWD,2CAA6B;AAC7B,+BAA0B;AAa1B;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAKlC,eAAmB;IACjB,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAmB,EAAE,EAAE;QACxD,GAAG,CAAC,eAAe,GAAG,eAAkC,CAAC;QAEzD,IAAI,aAAa,GAAG,IAAA,SAAE,GAAE,CAAC;QAEzB,IAAI,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;YAClC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAW,CAAC;QAC9D,CAAC;QAED,GAAG,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;QAEjD,GAAG,CAAC,OAAO,GAAG;YACV,aAAa,EAAE,aAAa;SAC/B,CAAC;QAEF,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,CAAC;QACX,CAAC;IACL,CAAC,CAAC;AACN,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAKlC,eAA2E;IACzE,OAAO,CAAC,GAAY,EAAE,IAAc,EAAE,IAAmB,EAAE,EAAE;QACzD,GAAG,CAAC,eAAe,GAAG,eAAe,CAAC;QAEtC,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,EAAE,CAAC;QACX,CAAC;IACL,CAAC,CAAC;AACN,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC3B,eAAgC,EAChC,MAAe,EACf,WAAkC;IAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACf,OAAO;IACX,CAAC;IAED,MAAM,MAAM,GAAG,eAAe,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACrD,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5C,OAAO,GAAG,CAAC;IACf,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAKhC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAC9C,MAAM,MAAM,GAAG,GAAG,CAAC,eAAe,CAAC,MAAM,CAAC;IAC1C,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,GAAG,EAAE,CAAC;QACnE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACpD,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;QACnD,CAAC;IACL,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACP,IAAI,EAAE,CAAC;IACX,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAK9B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAC9C,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE,CAAC;QACrD,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,eAAe;YAC7B,GAAG,CAAC,eAA0C,CAAC,CAAC,IAAI,CAAC;QACzD,IACI,eAAe,CACX,GAAG,CAAC,eAAe,EACnB,GAAG,CAAC,IAAI,EACR,IAA4B,CAC/B,KAAK,GAAG,EACX,CAAC;YACC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC9C,IAAI,IAAI,EAAE,CAAC;gBACP,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;YAC7C,CAAC;QACL,CAAC;IACL,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACP,IAAI,EAAE,CAAC;IACX,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAKjC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAC9C,MAAM,OAAO,GAAG,GAAG,CAAC,eAAe,CAAC,cAAc,CAAC;IACnD,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,GAAG,EAAE,CAAC;QACrE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACjD,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC;QAChD,CAAC;IACL,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACP,IAAI,EAAE,CAAC;IACX,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAK/B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAC9C,MAAM,KAAK,GAAG,GAAG,CAAC,eAAe,CAAC,KAAK,CAAC;IACxC,IAAI,eAAe,CAAC,GAAG,CAAC,eAAe,EAAE,GAAG,CAAC,KAAK,EAAE,KAAK,CAAC,KAAK,GAAG,EAAE,CAAC;QACjE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAC/C,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAC9C,CAAC;IACL,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACP,IAAI,EAAE,CAAC;IACX,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,uBAAuB,CAClC,mBAAgC,EAChC,mBAA4B;IAE5B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACvB,OAAO,CAAC,GAAG,EAAE,kCAAkC,CAAC,CAAC;IACrD,CAAC;IACD,QAAQ,mBAAmB,EAAE,CAAC;QAC1B,KAAK,KAAK,CAAC,CAAC,CAAC;YACT,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC7C,OAAO,CAAC,GAAG,EAAE,qCAAqC,CAAC,CAAC;YACxD,CAAC;YACD,IAAI,CAAC;gBACD,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CACnC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EACjC,IAAI,WAAW,EAAE,CAAC,MAAM,CACpB,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,qBAAqB,CAClD,CACJ,CAAC;gBACF,OAAO,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC;YAClC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACrB,OAAO,CAAC,GAAG,EAAE,8BAA8B,CAAC,CAAC;YACjD,CAAC;QACL,CAAC;QACD;YACI,OAAO,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC;IACtD,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,SAAS,QAAQ,CACb,iBAA8B,EAC9B,kBAA2B;IAE3B,OAAO,EAAE,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CACnB,iBAA8B,EAC9B,kBAA2B;IAE3B,OAAO,EAAE,CAAC;AACd,CAAC;AAED;;;;;;;;;;GAUG;AACI,KAAK,UAAU,gBAAgB,CAKpC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAC9C,MAAM,IAAI,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC;IACtC,IAAI,IAAI,EAAE,CAAC;QACP,MAAM,eAAe,GAAG,MAAM,uBAAuB,CACjD,IAAI,CAAC,MAAM,EACX,GAAG,CAAC,OAAO,CAAC,aAAa,CAC5B,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;YACjC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,IAAI,IAAI,EAAE,CAAC;gBACP,IAAI,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACxC,CAAC;QACL,CAAC;QAED,+CAA+C;QAC/C,MAAM,eAAe,GAAG,cAAc,CAClC,IAAI,CAAC,MAAM,EACX,GAAG,CAAC,OAAO,CAAC,aAAa,CAC5B,CAAC;QACF,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAE/D,MAAM,sBAAsB,GACxB,8DAA8D,CAAC;QACnE,MAAM,gBAAgB,GAClB,oDAAoD,CAAC;QAEzD,eAAe,CAAC,OAAO,CAAC,CAAC,cAAc,EAAE,EAAE;YACvC,IACI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,CAAC,cAAc,CAAC;gBAC5D,GAAG,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,CAAC,cAAc,CAAC,EAC/D,CAAC;gBACC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;gBAC7C,IAAI,IAAI,EAAE,CAAC;oBACP,IAAI,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;gBAC5C,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QACH,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACnB,IACI,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,GAAG,CAAC,IAAI,CAAC;gBAClD,GAAG,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,EAAE,GAAG,CAAC,IAAI,CAAC,EACrD,CAAC;gBACC,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBACvC,IAAI,IAAI,EAAE,CAAC;oBACP,IAAI,CAAC,IAAI,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;gBACtC,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAED,cAAc;IACd,cAAc;IACd,IAAI;AACR,CAAC"}

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

@@ -0,0 +1,14 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { ForklaunchNextFunction, ForklaunchRequest, ForklaunchResponse } from '../types/api.types';
+/**
+ * Middleware to parse and validate the response.
+ *
+ * @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 parseResponse<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): void;

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

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseResponse = parseResponse;
+/**
+ * Checks if any validation is required for the given contract details.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {HttpContractDetails<SV>} contractDetails - The contract details.
+ * @returns {boolean} - True if any validation is required, otherwise false.
+ */
+function checkAnyValidation(contractDetails) {
+    return (contractDetails.body ||
+        contractDetails.params ||
+        contractDetails.requestHeaders ||
+        contractDetails.query);
+}
+/**
+ * Middleware to parse and validate the response.
+ *
+ * @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.
+ */
+function parseResponse(req, res, next) {
+    if (req.contractDetails.responseHeaders) {
+        const schema = req.schemaValidator.schemify(req.contractDetails.responseHeaders);
+        req.schemaValidator.validate(schema, res.getHeaders());
+    }
+    if (res.statusCode === 500 ||
+        (checkAnyValidation(req.contractDetails) && res.statusCode === 400) ||
+        (req.contractDetails.auth &&
+            (res.statusCode === 401 || res.statusCode === 403))) {
+        req.schemaValidator.validate(req.schemaValidator.string, res.bodyData);
+        return;
+    }
+    if (Object.prototype.hasOwnProperty.call(req.contractDetails.responses, res.statusCode)) {
+        const schema = req.schemaValidator.schemify(req.contractDetails.responses[res.statusCode]);
+        req.schemaValidator.validate(schema, res.bodyData);
+    }
+    else {
+        if (next) {
+            next(new Error(`Response code ${res.statusCode} not defined in contract.`));
+        }
+    }
+    if (next) {
+        next();
+    }
+}
+//# sourceMappingURL=response.middleware.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"response.middleware.js","sourceRoot":"","sources":["../../../http/middleware/response.middleware.ts"],"names":[],"mappings":";;AAqCA,sCA4CC;AAzED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,eAAwC;IAExC,OAAO,CACL,eAAe,CAAC,IAAI;QACpB,eAAe,CAAC,MAAM;QACtB,eAAe,CAAC,cAAc;QAC9B,eAAe,CAAC,KAAK,CACtB,CAAC;AACJ,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,aAAa,CAK3B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,IAAI,GAAG,CAAC,eAAe,CAAC,eAAe,EAAE,CAAC;QACxC,MAAM,MAAM,GAAG,GAAG,CAAC,eAAe,CAAC,QAAQ,CACzC,GAAG,CAAC,eAAe,CAAC,eAAe,CACpC,CAAC;QACF,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;IACzD,CAAC;IAED,IACE,GAAG,CAAC,UAAU,KAAK,GAAG;QACtB,CAAC,kBAAkB,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC;QACnE,CAAC,GAAG,CAAC,eAAe,CAAC,IAAI;YACvB,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,EACrD,CAAC;QACD,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,GAAG,CAAC,eAAe,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;QACvE,OAAO;IACT,CAAC;IAED,IACE,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAClC,GAAG,CAAC,eAAe,CAAC,SAAS,EAC7B,GAAG,CAAC,UAAU,CACf,EACD,CAAC;QACD,MAAM,MAAM,GAAG,GAAG,CAAC,eAAe,CAAC,QAAQ,CACzC,GAAG,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,CAC9C,CAAC;QACF,GAAG,CAAC,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAC,QAAQ,CAAC,CAAC;IACrD,CAAC;SAAM,CAAC;QACN,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CACF,IAAI,KAAK,CAAC,iBAAiB,GAAG,CAAC,UAAU,2BAA2B,CAAC,CACtE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC"}

package/dist/http/openApiV3Generator.d.ts

@@ -0,0 +1,13 @@
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { OpenAPIObject } from 'openapi3-ts/oas31';
+import { ForklaunchRouter } from './types/forklaunch.types';
+/**
+ * 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 declare function generateSwaggerDocument<SV extends AnySchemaValidator>(schemaValidator: SV, port: string | number, routers: ForklaunchRouter<SV>[]): OpenAPIObject;

package/dist/http/openApiV3Generator.js

@@ -0,0 +1,177 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateSwaggerDocument = generateSwaggerDocument;
+const httpStatusCodes_1 = __importDefault(require("./httpStatusCodes"));
+/**
+ * Capitalizes the first letter of a string.
+ *
+ * @param {string} str - The string to transform.
+ * @returns {string} - The transformed string with the first letter capitalized.
+ */
+function toUpperCase(str) {
+    return str.charAt(0).toUpperCase() + str.slice(1);
+}
+;
+/**
+ * Transforms a base path by ensuring it starts with a slash and capitalizing the first letter.
+ *
+ * @param {string} basePath - The base path to transform.
+ * @returns {string} - The transformed base path.
+ */
+function transformBasePath(basePath) {
+    if (basePath.startsWith('/')) {
+        return toUpperCase(basePath.slice(1));
+    }
+    return `/${basePath}`;
+}
+;
+/**
+ * Creates a Swagger document.
+ *
+ * @param {string | number} port - The port on which the server is running.
+ * @param {TagObject[]} tags - The tags for the Swagger document.
+ * @param {PathObject} paths - The paths for the Swagger document.
+ * @returns {OpenAPIObject} - The Swagger document.
+ */
+function swaggerDocument(port, tags, paths) {
+    return {
+        openapi: '3.1.0',
+        info: {
+            title: process.env.API_TITLE || '',
+            version: process.env.VERSION || '1.0.0'
+        },
+        components: {
+            securitySchemes: {
+                bearer: {
+                    type: 'http',
+                    scheme: 'bearer',
+                    bearerFormat: 'JWT'
+                }
+            }
+        },
+        tags,
+        servers: [
+            {
+                url: `http://localhost:${port}`
+            }
+        ],
+        paths
+    };
+}
+;
+/**
+ * Resolves the content object for a given schema.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {SV} schemaValidator - The schema validator.
+ * @param {IdiomaticSchema<SV>} body - The schema body.
+ * @returns {ContentObject} - The resolved content object.
+ */
+function contentResolver(schemaValidator, body) {
+    const bodySpec = schemaValidator.openapi(body);
+    return body === schemaValidator.string
+        ? {
+            'plain/text': {
+                schema: bodySpec
+            }
+        }
+        : {
+            'application/json': {
+                schema: bodySpec
+            }
+        };
+}
+/**
+ * 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.
+ */
+function generateSwaggerDocument(schemaValidator, port, routers) {
+    const tags = [];
+    const paths = {};
+    routers.forEach((router) => {
+        const controllerName = transformBasePath(router.basePath);
+        tags.push({
+            name: controllerName,
+            description: `${controllerName} Operations`
+        });
+        router.routes.forEach((route) => {
+            const fullPath = `${router.basePath}${route.path === '/' ? '' : route.path}`.replace(/:(\w+)/g, '{$1}');
+            if (!paths[fullPath]) {
+                paths[fullPath] = {};
+            }
+            const { name, summary, query, requestHeaders } = route.contractDetails;
+            const responses = {};
+            for (const key in route.contractDetails.responses) {
+                responses[key] = {
+                    description: httpStatusCodes_1.default[key],
+                    content: contentResolver(schemaValidator, route.contractDetails.responses[key])
+                };
+            }
+            const pathItemObject = {
+                tags: [controllerName],
+                summary: `${name}: ${summary}`,
+                parameters: [],
+                responses
+            };
+            if (route.contractDetails.params) {
+                for (const key in route.contractDetails.params) {
+                    pathItemObject.parameters?.push({
+                        name: key,
+                        in: 'path'
+                    });
+                }
+            }
+            const body = route.contractDetails.body;
+            if (body) {
+                pathItemObject.requestBody = {
+                    required: true,
+                    content: contentResolver(schemaValidator, body)
+                };
+            }
+            if (requestHeaders) {
+                for (const key in requestHeaders) {
+                    pathItemObject.parameters?.push({
+                        name: key,
+                        in: 'header'
+                    });
+                }
+            }
+            if (query) {
+                for (const key in query) {
+                    pathItemObject.parameters?.push({
+                        name: key,
+                        in: 'query'
+                    });
+                }
+            }
+            if (route.contractDetails.auth) {
+                responses[401] = {
+                    description: httpStatusCodes_1.default[401],
+                    content: contentResolver(schemaValidator, schemaValidator.string)
+                };
+                responses[403] = {
+                    description: httpStatusCodes_1.default[403],
+                    content: contentResolver(schemaValidator, schemaValidator.string)
+                };
+                if (route.contractDetails.auth.method === 'jwt') {
+                    pathItemObject.security = [
+                        {
+                            bearer: Array.from(route.contractDetails.auth.allowedSlugs?.values() || [])
+                        }
+                    ];
+                }
+            }
+            paths[fullPath][route.method] = pathItemObject;
+        });
+    });
+    return swaggerDocument(port, tags, paths);
+}
+//# sourceMappingURL=openApiV3Generator.js.map

package/dist/http/openApiV3Generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openApiV3Generator.js","sourceRoot":"","sources":["../../http/openApiV3Generator.ts"],"names":[],"mappings":";;;;;AAiHA,0DAyGC;AA7MD,wEAA6C;AAI7C;;;;;GAKG;AACH,SAAS,WAAW,CAAC,GAAW;IAC9B,OAAO,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACpD,CAAC;AAAA,CAAC;AAEF;;;;;GAKG;AACH,SAAS,iBAAiB,CAAC,QAAgB;IACzC,IAAI,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC7B,OAAO,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,IAAI,QAAQ,EAAE,CAAC;AACxB,CAAC;AAAA,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,eAAe,CACtB,IAAqB,EACrB,IAAiB,EACjB,KAAiB;IAEjB,OAAO;QACL,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,SAAS,IAAI,EAAE;YAClC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,OAAO,IAAI,OAAO;SACxC;QACD,UAAU,EAAE;YACV,eAAe,EAAE;gBACf,MAAM,EAAE;oBACN,IAAI,EAAE,MAAM;oBACZ,MAAM,EAAE,QAAQ;oBAChB,YAAY,EAAE,KAAK;iBACpB;aACF;SACF;QACD,IAAI;QACJ,OAAO,EAAE;YACP;gBACE,GAAG,EAAE,oBAAoB,IAAI,EAAE;aAChC;SACF;QACD,KAAK;KACN,CAAC;AACJ,CAAC;AAAA,CAAC;AAEF;;;;;;;GAOG;AACH,SAAS,eAAe,CACtB,eAAmB,EACnB,IAAyB;IAEzB,MAAM,QAAQ,GAAI,eAAmC,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACpE,OAAO,IAAI,KAAK,eAAe,CAAC,MAAM;QACpC,CAAC,CAAC;YACA,YAAY,EAAE;gBACZ,MAAM,EAAE,QAAQ;aACjB;SACF;QACD,CAAC,CAAC;YACA,kBAAkB,EAAE;gBAClB,MAAM,EAAE,QAAQ;aACjB;SACF,CAAC;AACN,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,uBAAuB,CACrC,eAAmB,EACnB,IAAqB,EACrB,OAA+B;IAE/B,MAAM,IAAI,GAAgB,EAAE,CAAC;IAC7B,MAAM,KAAK,GAAe,EAAE,CAAC;IAE7B,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QACzB,MAAM,cAAc,GAAG,iBAAiB,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC1D,IAAI,CAAC,IAAI,CAAC;YACR,IAAI,EAAE,cAAc;YACpB,WAAW,EAAE,GAAG,cAAc,aAAa;SAC5C,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC9B,MAAM,QAAQ,GACZ,GAAG,MAAM,CAAC,QAAQ,GAAG,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,OAAO,CACjE,SAAS,EACT,MAAM,CACP,CAAC;YACJ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;gBACrB,KAAK,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACvB,CAAC;YACD,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,GAAG,KAAK,CAAC,eAAe,CAAC;YAEvE,MAAM,SAAS,GAAoB,EAAE,CAAC;YAEtC,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,SAAS,EAAE,CAAC;gBAClD,SAAS,CAAC,GAAG,CAAC,GAAG;oBACf,WAAW,EAAE,yBAAY,CAAC,GAAG,CAAC;oBAC9B,OAAO,EAAE,eAAe,CACtB,eAAe,EACf,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,GAAG,CAAC,CACrC;iBACF,CAAC;YACJ,CAAC;YAED,MAAM,cAAc,GAAoB;gBACtC,IAAI,EAAE,CAAC,cAAc,CAAC;gBACtB,OAAO,EAAE,GAAG,IAAI,KAAK,OAAO,EAAE;gBAC9B,UAAU,EAAE,EAAE;gBACd,SAAS;aACV,CAAC;YACF,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;gBACjC,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;oBAC/C,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC;wBAC9B,IAAI,EAAE,GAAG;wBACT,EAAE,EAAE,MAAM;qBACX,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,MAAM,IAAI,GACR,KAAK,CAAC,eACP,CAAC,IAAI,CAAC;YACP,IAAI,IAAI,EAAE,CAAC;gBACT,cAAc,CAAC,WAAW,GAAG;oBAC3B,QAAQ,EAAE,IAAI;oBACd,OAAO,EAAE,eAAe,CAAC,eAAe,EAAE,IAAI,CAAC;iBAChD,CAAC;YACJ,CAAC;YAED,IAAI,cAAc,EAAE,CAAC;gBACnB,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;oBACjC,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC;wBAC9B,IAAI,EAAE,GAAG;wBACT,EAAE,EAAE,QAAQ;qBACb,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,IAAI,KAAK,EAAE,CAAC;gBACV,KAAK,MAAM,GAAG,IAAI,KAAK,EAAE,CAAC;oBACxB,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC;wBAC9B,IAAI,EAAE,GAAG;wBACT,EAAE,EAAE,OAAO;qBACZ,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;YAED,IAAI,KAAK,CAAC,eAAe,CAAC,IAAI,EAAE,CAAC;gBAC/B,SAAS,CAAC,GAAG,CAAC,GAAG;oBACf,WAAW,EAAE,yBAAY,CAAC,GAAG,CAAC;oBAC9B,OAAO,EAAE,eAAe,CAAC,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;iBAClE,CAAC;gBACF,SAAS,CAAC,GAAG,CAAC,GAAG;oBACf,WAAW,EAAE,yBAAY,CAAC,GAAG,CAAC;oBAC9B,OAAO,EAAE,eAAe,CAAC,eAAe,EAAE,eAAe,CAAC,MAAM,CAAC;iBAClE,CAAC;gBACF,IAAI,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;oBAChD,cAAc,CAAC,QAAQ,GAAG;wBACxB;4BACE,MAAM,EAAE,KAAK,CAAC,IAAI,CAChB,KAAK,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,EAAE,CACxD;yBACF;qBACF,CAAC;gBACJ,CAAC;YACH,CAAC;YAED,KAAK,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,cAAc,CAAC;QACjD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,eAAe,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;AAC5C,CAAC"}

package/dist/http/regex.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates a string from a given regular expression or string representation of a regex.
+ *
+ * @param {RegExp | string} regex - The regular expression or string representation of a regex.
+ * @returns {string} - The generated string based on the regex pattern.
+ * @throws {Error} - Throws an error if there are unmatched brackets or groups.
+ */
+export declare function generateStringFromRegex(regex: RegExp | string): string;