@forklaunch/core 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/http/middleware/request.middleware.d.ts +14 -0
- package/dist/http/middleware/request.middleware.js +43 -28
- package/dist/http/middleware/request.middleware.js.map +1 -1
- package/dist/http/types/api.types.d.ts +7 -5
- package/dist/http/types/primitive.types.d.ts +3 -3
- package/dist/tests/http.middleware.test.js +9 -9
- package/dist/tests/http.middleware.test.js.map +1 -1
- package/dist/tests/openApiV3Generator.test.js +0 -1
- package/dist/tests/openApiV3Generator.test.js.map +1 -1
- package/package.json +1 -1
|
@@ -81,6 +81,20 @@ export declare function parseRequestHeaders<SV extends AnySchemaValidator, Reque
|
|
|
81
81
|
* @param {NextFunction} [next] - The next middleware function.
|
|
82
82
|
*/
|
|
83
83
|
export declare function parseRequestQuery<SV extends AnySchemaValidator, Request extends ForklaunchRequest<SV>, Response extends ForklaunchResponse, NextFunction extends ForklaunchNextFunction>(req: Request, res: Response, next?: NextFunction): void;
|
|
84
|
+
/**
|
|
85
|
+
* Maps roles from authorization.
|
|
86
|
+
*
|
|
87
|
+
* @param {AuthMethod} [authorizationType] - The method of authorization.
|
|
88
|
+
* @param {string} [authorizationToken] - The authorization token.
|
|
89
|
+
* @returns {string[]} - The mapped roles.
|
|
90
|
+
*/
|
|
91
|
+
/**
|
|
92
|
+
* Maps permissions from authorization.
|
|
93
|
+
*
|
|
94
|
+
* @param {AuthMethod} [authorizationType] - The method of authorization.
|
|
95
|
+
* @param {string} [authorizationToken] - The authorization token.
|
|
96
|
+
* @returns {string[]} - The mapped permissions.
|
|
97
|
+
*/
|
|
84
98
|
/**
|
|
85
99
|
* Middleware to parse request authorization.
|
|
86
100
|
*
|
|
@@ -226,9 +226,12 @@ async function checkAuthorizationToken(authorizationMethod, authorizationString)
|
|
|
226
226
|
* @param {string} [authorizationToken] - The authorization token.
|
|
227
227
|
* @returns {string[]} - The mapped roles.
|
|
228
228
|
*/
|
|
229
|
-
function mapRoles(
|
|
230
|
-
|
|
231
|
-
|
|
229
|
+
// function mapRoles(
|
|
230
|
+
// authorizationType?: AuthMethod,
|
|
231
|
+
// authorizationToken?: string
|
|
232
|
+
// ): string[] {
|
|
233
|
+
// return [];
|
|
234
|
+
// }
|
|
232
235
|
/**
|
|
233
236
|
* Maps permissions from authorization.
|
|
234
237
|
*
|
|
@@ -236,9 +239,12 @@ function mapRoles(authorizationType, authorizationToken) {
|
|
|
236
239
|
* @param {string} [authorizationToken] - The authorization token.
|
|
237
240
|
* @returns {string[]} - The mapped permissions.
|
|
238
241
|
*/
|
|
239
|
-
function mapPermissions(
|
|
240
|
-
|
|
241
|
-
|
|
242
|
+
// function mapPermissions(
|
|
243
|
+
// authorizationType?: AuthMethod,
|
|
244
|
+
// authorizationToken?: string
|
|
245
|
+
// ): string[] {
|
|
246
|
+
// return [];
|
|
247
|
+
// }
|
|
242
248
|
/**
|
|
243
249
|
* Middleware to parse request authorization.
|
|
244
250
|
*
|
|
@@ -261,28 +267,37 @@ async function parseRequestAuth(req, res, next) {
|
|
|
261
267
|
}
|
|
262
268
|
}
|
|
263
269
|
// TODO: Implement role and permission checking
|
|
264
|
-
const permissionSlugs = mapPermissions(
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
270
|
+
// const permissionSlugs = mapPermissions(
|
|
271
|
+
// auth.method,
|
|
272
|
+
// req.headers.authorization
|
|
273
|
+
// );
|
|
274
|
+
// const roles = mapRoles(auth.method, req.headers.authorization);
|
|
275
|
+
// const permissionErrorMessage =
|
|
276
|
+
// 'User does not have sufficient permissions to perform action.';
|
|
277
|
+
// const roleErrorMessage =
|
|
278
|
+
// 'User does not have correct role to perform action.';
|
|
279
|
+
// permissionSlugs.forEach((permissionSlug) => {
|
|
280
|
+
// if (
|
|
281
|
+
// !req.contractDetails.auth?.allowedSlugs?.has(permissionSlug) ||
|
|
282
|
+
// req.contractDetails.auth?.forbiddenSlugs?.has(permissionSlug)
|
|
283
|
+
// ) {
|
|
284
|
+
// res.status(403).send(permissionErrorMessage);
|
|
285
|
+
// if (next) {
|
|
286
|
+
// next(new Error(permissionErrorMessage));
|
|
287
|
+
// }
|
|
288
|
+
// }
|
|
289
|
+
// });
|
|
290
|
+
// roles.forEach((role) => {
|
|
291
|
+
// if (
|
|
292
|
+
// !req.contractDetails.auth?.allowedRoles?.has(role) ||
|
|
293
|
+
// req.contractDetails.auth?.forbiddenRoles?.has(role)
|
|
294
|
+
// ) {
|
|
295
|
+
// res.status(403).send(roleErrorMessage);
|
|
296
|
+
// if (next) {
|
|
297
|
+
// next(new Error(roleErrorMessage));
|
|
298
|
+
// }
|
|
299
|
+
// }
|
|
300
|
+
// });
|
|
286
301
|
}
|
|
287
302
|
// if (next) {
|
|
288
303
|
// next();
|
|
@@ -1 +1 @@
|
|
|
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;IACnB,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAmB,EAAE,EAAE;QAC1D,GAAG,CAAC,eAAe,GAAG,eAAkC,CAAC;QAEzD,IAAI,aAAa,GAAG,IAAA,SAAE,GAAE,CAAC;QAEzB,IAAI,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACpC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAW,CAAC;QAC5D,CAAC;QAED,GAAG,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;QAEjD,GAAG,CAAC,OAAO,GAAG;YACZ,aAAa,EAAE,aAAa;SAC7B,CAAC;QAEF,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAKlC,eAA2E;IAC3E,OAAO,CAAC,GAAY,EAAE,IAAc,EAAE,IAAmB,EAAE,EAAE;QAC3D,GAAG,CAAC,eAAe,GAAG,eAAe,CAAC;QAEtC,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,eAAgC,EAChC,MAAe,EACf,WAAkC;IAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;IACT,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;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAKhC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,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;QACrE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACpD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAK9B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,eAAe;YACjC,GAAG,CAAC,eAA0C,CAAC,CAAC,IAAI,CAAC;QACrD,IACE,eAAe,CACb,GAAG,CAAC,eAAe,EACnB,GAAG,CAAC,IAAI,EACR,IAA4B,CAC7B,KAAK,GAAG,EACT,CAAC;YACD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC9C,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAKjC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,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;QACvE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACjD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAK/B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,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;QACnE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAC/C,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,uBAAuB,CACpC,mBAAgC,EAChC,mBAA4B;IAE5B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,EAAE,kCAAkC,CAAC,CAAC;IACnD,CAAC;IACD,QAAQ,mBAAmB,EAAE,CAAC;QAC5B,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/C,OAAO,CAAC,GAAG,EAAE,qCAAqC,CAAC,CAAC;YACtD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CACrC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EACjC,IAAI,WAAW,EAAE,CAAC,MAAM,CACtB,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,qBAAqB,CAChD,CACF,CAAC;gBACF,OAAO,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC;YAChC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACrB,OAAO,CAAC,GAAG,EAAE,8BAA8B,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD;YACE,OAAO,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,
|
|
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;IACnB,OAAO,CAAC,GAAY,EAAE,GAAa,EAAE,IAAmB,EAAE,EAAE;QAC1D,GAAG,CAAC,eAAe,GAAG,eAAkC,CAAC;QAEzD,IAAI,aAAa,GAAG,IAAA,SAAE,GAAE,CAAC;QAEzB,IAAI,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,EAAE,CAAC;YACpC,aAAa,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAW,CAAC;QAC5D,CAAC;QAED,GAAG,CAAC,SAAS,CAAC,kBAAkB,EAAE,aAAa,CAAC,CAAC;QAEjD,GAAG,CAAC,OAAO,GAAG;YACZ,aAAa,EAAE,aAAa;SAC7B,CAAC;QAEF,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,oBAAoB,CAKlC,eAA2E;IAC3E,OAAO,CAAC,GAAY,EAAE,IAAc,EAAE,IAAmB,EAAE,EAAE;QAC3D,GAAG,CAAC,eAAe,GAAG,eAAe,CAAC;QAEtC,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,EAAE,CAAC;QACT,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,SAAgB,eAAe,CAC7B,eAAgC,EAChC,MAAe,EACf,WAAkC;IAElC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,OAAO;IACT,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;QAC9C,OAAO,GAAG,CAAC;IACb,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,kBAAkB,CAKhC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,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;QACrE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QACpD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC,CAAC;QACjD,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAK9B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,IAAI,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE,CAAC;QACvD,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,eAAe;YACjC,GAAG,CAAC,eAA0C,CAAC,CAAC,IAAI,CAAC;QACrD,IACE,eAAe,CACb,GAAG,CAAC,eAAe,EACnB,GAAG,CAAC,IAAI,EACR,IAA4B,CAC7B,KAAK,GAAG,EACT,CAAC;YACD,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC9C,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,mBAAmB,CAKjC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,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;QACvE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACjD,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAAC;QAC9C,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iBAAiB,CAK/B,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,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;QACnE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;QAC/C,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IACD,IAAI,IAAI,EAAE,CAAC;QACT,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,uBAAuB,CACpC,mBAAgC,EAChC,mBAA4B;IAE5B,IAAI,CAAC,mBAAmB,EAAE,CAAC;QACzB,OAAO,CAAC,GAAG,EAAE,kCAAkC,CAAC,CAAC;IACnD,CAAC;IACD,QAAQ,mBAAmB,EAAE,CAAC;QAC5B,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/C,OAAO,CAAC,GAAG,EAAE,qCAAqC,CAAC,CAAC;YACtD,CAAC;YACD,IAAI,CAAC;gBACH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,SAAS,CACrC,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EACjC,IAAI,WAAW,EAAE,CAAC,MAAM,CACtB,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,qBAAqB,CAChD,CACF,CAAC;gBACF,OAAO,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC;YAChC,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACrB,OAAO,CAAC,GAAG,EAAE,8BAA8B,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD;YACE,OAAO,CAAC,GAAG,EAAE,+BAA+B,CAAC,CAAC;IAClD,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,qBAAqB;AACrB,oCAAoC;AACpC,gCAAgC;AAChC,gBAAgB;AAChB,eAAe;AACf,IAAI;AAEJ;;;;;;GAMG;AACH,2BAA2B;AAC3B,oCAAoC;AACpC,gCAAgC;AAChC,gBAAgB;AAChB,eAAe;AACf,IAAI;AAEJ;;;;;;;;;;GAUG;AACI,KAAK,UAAU,gBAAgB,CAKpC,GAAY,EAAE,GAAa,EAAE,IAAmB;IAChD,MAAM,IAAI,GAAG,GAAG,CAAC,eAAe,CAAC,IAAI,CAAC;IACtC,IAAI,IAAI,EAAE,CAAC;QACT,MAAM,eAAe,GAAG,MAAM,uBAAuB,CACnD,IAAI,CAAC,MAAM,EACX,GAAG,CAAC,OAAO,CAAC,aAAa,CAC1B,CAAC;QACF,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE,CAAC;YACnC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC;YACxD,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACtC,CAAC;QACH,CAAC;QAED,+CAA+C;QACjD,4CAA4C;QAC5C,mBAAmB;QACnB,gCAAgC;QAChC,OAAO;QACP,oEAAoE;QAEpE,mCAAmC;QACnC,sEAAsE;QACtE,6BAA6B;QAC7B,4DAA4D;QAE5D,kDAAkD;QAClD,WAAW;QACX,wEAAwE;QACxE,sEAAsE;QACtE,UAAU;QACV,sDAAsD;QACtD,oBAAoB;QACpB,mDAAmD;QACnD,UAAU;QACV,QAAQ;QACR,QAAQ;QACR,8BAA8B;QAC9B,WAAW;QACX,8DAA8D;QAC9D,4DAA4D;QAC5D,UAAU;QACV,gDAAgD;QAChD,oBAAoB;QACpB,6CAA6C;QAC7C,UAAU;QACV,QAAQ;QACR,QAAQ;IACR,CAAC;IAED,cAAc;IACd,cAAc;IACd,IAAI;AACN,CAAC"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { Prettify } from '@forklaunch/common';
|
|
2
2
|
import { AnySchemaValidator, Schema } from '@forklaunch/validator';
|
|
3
3
|
import { IdiomaticSchema, SchemaValidator } from '@forklaunch/validator/types';
|
|
4
|
-
import { IncomingHttpHeaders
|
|
4
|
+
import { IncomingHttpHeaders } from 'http';
|
|
5
5
|
import { ParsedQs } from 'qs';
|
|
6
6
|
import { HttpContractDetails, ParamsDictionary, PathParamHttpContractDetails } from './primitive.types';
|
|
7
7
|
/**
|
|
@@ -49,7 +49,9 @@ export interface ForklaunchResponse<ResBody = {
|
|
|
49
49
|
401: unknown;
|
|
50
50
|
403: unknown;
|
|
51
51
|
500: unknown;
|
|
52
|
-
}, StatusCode = number
|
|
52
|
+
}, StatusCode = number, Headers = {
|
|
53
|
+
'x-correlation-id': string;
|
|
54
|
+
}> {
|
|
53
55
|
/** Data of the response body */
|
|
54
56
|
bodyData: unknown;
|
|
55
57
|
/** Status code of the response */
|
|
@@ -58,15 +60,15 @@ export interface ForklaunchResponse<ResBody = {
|
|
|
58
60
|
corked: boolean;
|
|
59
61
|
/**
|
|
60
62
|
* Gets the headers of the response.
|
|
61
|
-
* @returns {
|
|
63
|
+
* @returns {Headers} - The headers of the response.
|
|
62
64
|
*/
|
|
63
|
-
getHeaders: () =>
|
|
65
|
+
getHeaders: () => Headers;
|
|
64
66
|
/**
|
|
65
67
|
* Sets a header for the response.
|
|
66
68
|
* @param {string} key - The header key.
|
|
67
69
|
* @param {string} value - The header value.
|
|
68
70
|
*/
|
|
69
|
-
setHeader: (key:
|
|
71
|
+
setHeader: <K extends keyof Headers>(key: K, value: Headers[K]) => void;
|
|
70
72
|
/**
|
|
71
73
|
* Sets the status of the response.
|
|
72
74
|
* @param {U} code - The status code.
|
|
@@ -68,7 +68,7 @@ export type AuthMethod = 'jwt' | 'session';
|
|
|
68
68
|
* @template ResponseSchemas - A type for response schemas, defaulting to ResponsesObject.
|
|
69
69
|
* @template QuerySchemas - A type for query schemas, defaulting to QueryObject.
|
|
70
70
|
*/
|
|
71
|
-
export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, ParamSchemas extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, QuerySchemas extends QueryObject<SV> = QueryObject<SV>> {
|
|
71
|
+
export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, ParamSchemas extends ParamsObject<SV> = ParamsObject<SV>, ResponseSchemas extends ResponsesObject<SV> = ResponsesObject<SV>, QuerySchemas extends QueryObject<SV> = QueryObject<SV>, RequestHeaders extends HeadersObject<SV> = HeadersObject<SV>, ResponseHeaders extends HeadersObject<SV> = HeadersObject<SV>> {
|
|
72
72
|
/** Name of the contract */
|
|
73
73
|
name: string;
|
|
74
74
|
/** Summary of the contract */
|
|
@@ -76,9 +76,9 @@ export interface PathParamHttpContractDetails<SV extends AnySchemaValidator, Par
|
|
|
76
76
|
/** Response schemas for the contract */
|
|
77
77
|
responses: ResponseSchemas;
|
|
78
78
|
/** Optional request headers for the contract */
|
|
79
|
-
requestHeaders?:
|
|
79
|
+
requestHeaders?: RequestHeaders;
|
|
80
80
|
/** Optional response headers for the contract */
|
|
81
|
-
responseHeaders?:
|
|
81
|
+
responseHeaders?: ResponseHeaders;
|
|
82
82
|
/** Optional parameter schemas for the contract */
|
|
83
83
|
params?: ParamSchemas;
|
|
84
84
|
/** Optional query schemas for the contract */
|
|
@@ -5,7 +5,7 @@ const http_1 = require("../http");
|
|
|
5
5
|
describe('Http Middleware Tests', () => {
|
|
6
6
|
let contractDetails;
|
|
7
7
|
let req;
|
|
8
|
-
let
|
|
8
|
+
let res;
|
|
9
9
|
const nextFunction = (err) => {
|
|
10
10
|
expect(err).toBeFalsy();
|
|
11
11
|
};
|
|
@@ -33,7 +33,7 @@ describe('Http Middleware Tests', () => {
|
|
|
33
33
|
body: testSchema,
|
|
34
34
|
query: testSchema
|
|
35
35
|
};
|
|
36
|
-
|
|
36
|
+
res = {
|
|
37
37
|
bodyData: {},
|
|
38
38
|
statusCode: 200,
|
|
39
39
|
corked: false,
|
|
@@ -48,29 +48,29 @@ describe('Http Middleware Tests', () => {
|
|
|
48
48
|
test('Create Request Context', async () => {
|
|
49
49
|
req.context = {};
|
|
50
50
|
req.schemaValidator = {};
|
|
51
|
-
(0, http_1.createRequestContext)(mockSchemaValidator_1.mockSchemaValidator)(req,
|
|
51
|
+
(0, http_1.createRequestContext)(mockSchemaValidator_1.mockSchemaValidator)(req, res, nextFunction);
|
|
52
52
|
expect(req.context.correlationId).not.toBe('123');
|
|
53
53
|
expect(req.schemaValidator).toBe(mockSchemaValidator_1.mockSchemaValidator);
|
|
54
54
|
});
|
|
55
55
|
test('Enrich Request Details', async () => {
|
|
56
56
|
req.contractDetails = {};
|
|
57
|
-
(0, http_1.enrichRequestDetails)(contractDetails)(req,
|
|
57
|
+
(0, http_1.enrichRequestDetails)(contractDetails)(req, res, nextFunction);
|
|
58
58
|
expect(req.contractDetails).toEqual(contractDetails);
|
|
59
59
|
});
|
|
60
60
|
test('Validate Request Params', async () => {
|
|
61
|
-
(0, http_1.parseRequestParams)(req,
|
|
61
|
+
(0, http_1.parseRequestParams)(req, res, nextFunction);
|
|
62
62
|
});
|
|
63
63
|
test('Validate Request Headers', async () => {
|
|
64
|
-
(0, http_1.parseRequestHeaders)(req,
|
|
64
|
+
(0, http_1.parseRequestHeaders)(req, res, nextFunction);
|
|
65
65
|
});
|
|
66
66
|
test('Validate Request Body', async () => {
|
|
67
|
-
(0, http_1.parseRequestBody)(req,
|
|
67
|
+
(0, http_1.parseRequestBody)(req, res, nextFunction);
|
|
68
68
|
});
|
|
69
69
|
test('Validate Request Query Params', async () => {
|
|
70
|
-
(0, http_1.parseRequestQuery)(req,
|
|
70
|
+
(0, http_1.parseRequestQuery)(req, res, nextFunction);
|
|
71
71
|
});
|
|
72
72
|
test('Validate Response', async () => {
|
|
73
|
-
(0, http_1.parseResponse)(req,
|
|
73
|
+
(0, http_1.parseResponse)(req, res, nextFunction);
|
|
74
74
|
});
|
|
75
75
|
// Not supported yet
|
|
76
76
|
// test('Validate Auth', async () => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"http.middleware.test.js","sourceRoot":"","sources":["../../tests/http.middleware.test.ts"],"names":[],"mappings":";;AACA,yFAMyD;AACzD,kCAYiB;AAEjB,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,eAAyD,CAAC;IAC9D,IAAI,GAA2C,CAAC;IAChD,IAAI,
|
|
1
|
+
{"version":3,"file":"http.middleware.test.js","sourceRoot":"","sources":["../../tests/http.middleware.test.ts"],"names":[],"mappings":";;AACA,yFAMyD;AACzD,kCAYiB;AAEjB,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,IAAI,eAAyD,CAAC;IAC9D,IAAI,GAA2C,CAAC;IAChD,IAAI,GAAuB,CAAC;IAE5B,MAAM,YAAY,GAAG,CAAC,GAAa,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC;IAC1B,CAAC,CAAC;IAEF,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,IAAA,2BAAK,EAAC,CAAC,GAAG,EAAE,IAAA,8BAAQ,EAAC,IAAA,6BAAO,EAAC,MAAM,CAAC,CAAC,CAAU,CAAC;KACvD,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,eAAe,GAAG;YAChB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,uBAAuB;YAChC,IAAI,EAAE,UAAU;YAChB,MAAM,EAAE,UAAU;YAClB,cAAc,EAAE,UAAU;YAC1B,KAAK,EAAE,UAAU;YACjB,SAAS,EAAE;gBACT,GAAG,EAAE,UAAU;aAChB;SACF,CAAC;QAEF,GAAG,GAAG;YACJ,OAAO,EAAE,EAAoB;YAC7B,eAAe,EAAE,EAA8C;YAC/D,eAAe,EAAE,EAAqB;YACtC,MAAM,EAAE,UAAU;YAClB,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,UAAU;SAClB,CAAC;QAEF,GAAG,GAAG;YACJ,QAAQ,EAAE,EAAE;YACZ,UAAU,EAAE,GAAG;YACf,MAAM,EAAE,KAAK;YACb,UAAU,EAAE,IAAI,CAAC,EAAE,EAAE;YACrB,SAAS,EAAE,IAAI,CAAC,EAAE,EAAE;YACpB,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE;YACjB,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;YACf,KAAK,EAAE,IAAI,CAAC,EAAE,EAAE;SACjB,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACxC,GAAG,CAAC,OAAO,GAAG,EAAoB,CAAC;QACnC,GAAG,CAAC,eAAe,GAAG,EAAqB,CAAC;QAC5C,IAAA,2BAAoB,EAAC,yCAAmB,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;QAClE,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClD,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,yCAAmB,CAAC,CAAC;IACxD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACxC,GAAG,CAAC,eAAe,GAAG,EAA8C,CAAC;QACrE,IAAA,2BAAoB,EAAC,eAAe,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;QAC9D,MAAM,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IACvD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,yBAAyB,EAAE,KAAK,IAAI,EAAE;QACzC,IAAA,yBAAkB,EAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QAC1C,IAAA,0BAAmB,EAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACvC,IAAA,uBAAgB,EAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,+BAA+B,EAAE,KAAK,IAAI,EAAE;QAC/C,IAAA,wBAAiB,EAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACnC,IAAA,oBAAa,EAAC,GAAG,EAAE,GAAG,EAAE,YAAY,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;IAEH,oBAAoB;IACpB,sCAAsC;IACtC,MAAM;AACR,CAAC,CAAC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"openApiV3Generator.test.js","sourceRoot":"","sources":["../../tests/openApiV3Generator.test.ts"],"names":[],"mappings":";;AAAA,yFAKyD;AACzD,mEAAqE;AAErE,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,IAAA,2BAAK,EAAC,CAAC,GAAG,EAAE,IAAA,8BAAQ,EAAC,IAAA,6BAAO,EAAC,MAAM,CAAC,CAAC,CAAU,CAAC;KACvD,CAAC;IAEF,IAAI,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,oBAAoB,GAAG,IAAA,4CAAuB,EAClD,yCAAmB,EACnB,IAAI,EACJ;YACE;gBACE,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE;oBACN;wBACE,QAAQ,EAAE,OAAO;wBACjB,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,OAAO;wBAChB,MAAM,EAAE,KAAK;wBACb,eAAe,EAAE;4BACf,IAAI,EAAE,eAAe;4BACrB,OAAO,EAAE,uBAAuB;4BAChC,IAAI,EAAE,UAAU;4BAChB,MAAM,EAAE,UAAU;4BAClB,cAAc,EAAE,UAAU;4BAC1B,KAAK,EAAE,UAAU;4BACjB,SAAS,EAAE;gCACT,GAAG,EAAE,UAAU;6BAChB;yBACF;qBACF;iBACF;aACF;SACF,CACF,CAAC;QAEF,
|
|
1
|
+
{"version":3,"file":"openApiV3Generator.test.js","sourceRoot":"","sources":["../../tests/openApiV3Generator.test.ts"],"names":[],"mappings":";;AAAA,yFAKyD;AACzD,mEAAqE;AAErE,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,UAAU,GAAG;QACjB,IAAI,EAAE,IAAA,2BAAK,EAAC,CAAC,GAAG,EAAE,IAAA,8BAAQ,EAAC,IAAA,6BAAO,EAAC,MAAM,CAAC,CAAC,CAAU,CAAC;KACvD,CAAC;IAEF,IAAI,CAAC,oBAAoB,EAAE,KAAK,IAAI,EAAE;QACpC,MAAM,oBAAoB,GAAG,IAAA,4CAAuB,EAClD,yCAAmB,EACnB,IAAI,EACJ;YACE;gBACE,QAAQ,EAAE,MAAM;gBAChB,MAAM,EAAE;oBACN;wBACE,QAAQ,EAAE,OAAO;wBACjB,IAAI,EAAE,GAAG;wBACT,OAAO,EAAE,OAAO;wBAChB,MAAM,EAAE,KAAK;wBACb,eAAe,EAAE;4BACf,IAAI,EAAE,eAAe;4BACrB,OAAO,EAAE,uBAAuB;4BAChC,IAAI,EAAE,UAAU;4BAChB,MAAM,EAAE,UAAU;4BAClB,cAAc,EAAE,UAAU;4BAC1B,KAAK,EAAE,UAAU;4BACjB,SAAS,EAAE;gCACT,GAAG,EAAE,UAAU;6BAChB;yBACF;qBACF;iBACF;aACF;SACF,CACF,CAAC;QAEF,MAAM,CAAC,oBAAoB,CAAC,CAAC,OAAO,CAAC;YACnC,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE;YACrC,UAAU,EAAE;gBACV,eAAe,EAAE;oBACf,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,KAAK,EAAE;iBAChE;aACF;YACD,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC,EAAE,GAAG,EAAE,uBAAuB,EAAE,CAAC;YAC3C,KAAK,EAAE;gBACL,MAAM,EAAE;oBACN,GAAG,EAAE;wBACH,IAAI,EAAE,CAAC,KAAK,CAAC;wBACb,OAAO,EAAE,sCAAsC;wBAC/C,UAAU,EAAE;4BACV,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE;4BAC5B,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,EAAE;4BAC9B,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE;yBAC9B;wBACD,SAAS,EAAE;4BACT,KAAK,EAAE;gCACL,WAAW,EAAE,IAAI;gCACjB,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;6BAChD;yBACF;wBACD,WAAW,EAAE;4BACX,QAAQ,EAAE,IAAI;4BACd,OAAO,EAAE,EAAE,kBAAkB,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;yBAChD;qBACF;iBACF;aACF;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|