@tsed/platform-test-sdk 7.12.0

package/lib/cjs/tests/testCustom404.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testCustom404 = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+function testCustom404(options) {
+    class CustomServer extends options.server {
+    }
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(CustomServer, {
+        ...options,
+        mount: {
+            "/rest": []
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    it("Scenario 1: GET /", async () => {
+        const response = await request.get("/").expect(404);
+        expect(response.body).toEqual({
+            name: "NOT_FOUND",
+            message: 'Resource "/" not found',
+            status: 404,
+            errors: []
+        });
+    });
+}
+exports.testCustom404 = testCustom404;
+//# sourceMappingURL=testCustom404.js.map

package/lib/cjs/tests/testCustom404.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testCustom404.js","sourceRoot":"","sources":["../../../src/tests/testCustom404.ts"],"names":[],"mappings":";;;;AAAA,yCAA0C;AAC1C,kEAAkC;AAGlC,SAAgB,aAAa,CAAC,OAA+B;IAC3D,MAAM,YAAa,SAAQ,OAAO,CAAC,MAAM;KAAG;IAE5C,IAAI,OAA4C,CAAC;IACjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,YAAY,EAAE;QACnC,GAAG,OAAO;QACV,KAAK,EAAE;YACL,OAAO,EAAE,EAAE;SACZ;KACF,CAAC,CACH,CAAC;IAEF,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,GAAG,IAAA,mBAAS,EAAC,qBAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,qBAAY,CAAC,KAAK,CAAC,CAAC;IAE7B,EAAE,CAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QACjC,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEzD,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,wBAAwB;YACjC,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,EAAE;SACX,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AA5BD,sCA4BC","sourcesContent":["import {PlatformTest} from \"@tsed/common\";\nimport SuperTest from \"supertest\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\n\nexport function testCustom404(options: PlatformTestingSdkOpts) {\n  class CustomServer extends options.server {}\n\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n  beforeAll(\n    PlatformTest.bootstrap(CustomServer, {\n      ...options,\n      mount: {\n        \"/rest\": []\n      }\n    })\n  );\n\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n\n  it(\"Scenario 1: GET /\", async () => {\n    const response: any = await request.get(\"/\").expect(404);\n\n    expect(response.body).toEqual({\n      name: \"NOT_FOUND\",\n      message: 'Resource \"/\" not found',\n      status: 404,\n      errors: []\n    });\n  });\n}\n"]}

package/lib/cjs/tests/testErrors.js

@@ -0,0 +1,252 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testErrors = exports.ErrorsCtrl = void 0;
+const tslib_1 = require("tslib");
+require("@tsed/ajv");
+const common_1 = require("@tsed/common");
+const core_1 = require("@tsed/core");
+const exceptions_1 = require("@tsed/exceptions");
+const schema_1 = require("@tsed/schema");
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+const CustomBadRequest_1 = require("../errors/CustomBadRequest");
+const CustomInternalError_1 = require("../errors/CustomInternalError");
+class CustomModel {
+    name;
+}
+tslib_1.__decorate([
+    (0, schema_1.Required)(),
+    tslib_1.__metadata("design:type", String)
+], CustomModel.prototype, "name", void 0);
+class CustomPropModel {
+    roleItem;
+}
+tslib_1.__decorate([
+    (0, schema_1.Name)("role_item"),
+    (0, schema_1.Required)(),
+    tslib_1.__metadata("design:type", String)
+], CustomPropModel.prototype, "roleItem", void 0);
+let ErrorMiddleware = class ErrorMiddleware {
+    use(error) {
+        return {
+            message: "no error"
+        };
+    }
+};
+tslib_1.__decorate([
+    tslib_1.__param(0, (0, common_1.Err)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorMiddleware.prototype, "use", null);
+ErrorMiddleware = tslib_1.__decorate([
+    (0, common_1.Middleware)()
+], ErrorMiddleware);
+let FakeMiddleware = class FakeMiddleware {
+    use() {
+        return {
+            message: "should not be called by the platform when endpoint throw an error"
+        };
+    }
+};
+FakeMiddleware = tslib_1.__decorate([
+    (0, common_1.Middleware)()
+], FakeMiddleware);
+let ErrorsCtrl = class ErrorsCtrl {
+    scenario1() {
+        throw new CustomBadRequest_1.CustomBadRequest("Custom Bad Request");
+    }
+    scenario2() {
+        throw new Error("My error");
+    }
+    scenario3() {
+        throw new CustomInternalError_1.CustomInternalError("My custom error");
+    }
+    scenario4(name) {
+        return name;
+    }
+    scenario5(model) {
+        return model;
+    }
+    scenario6(model) {
+        return model;
+    }
+    scenario7() {
+        throw new CustomInternalError_1.CustomInternalError("My custom error");
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-1"),
+    (0, schema_1.Returns)(500, exceptions_1.InternalServerError).Description("Custom Bad Request"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario1", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-2"),
+    (0, schema_1.Returns)(500).Description("Internal Server Error"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario2", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-3"),
+    (0, schema_1.Returns)(400, CustomInternalError_1.CustomInternalError).Description("Bad request"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario3", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-4"),
+    (0, schema_1.Returns)(400),
+    tslib_1.__param(0, (0, schema_1.Required)()),
+    tslib_1.__param(0, (0, common_1.BodyParams)("name")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario4", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-5"),
+    (0, schema_1.Returns)(400, exceptions_1.BadRequest).Description("Bad request"),
+    tslib_1.__param(0, (0, schema_1.Required)()),
+    tslib_1.__param(0, (0, common_1.BodyParams)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [CustomModel]),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario5", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-6"),
+    (0, schema_1.Summary)("Throw a Required prop if prop name is required"),
+    (0, schema_1.Description)(`Return a required error`),
+    (0, schema_1.Returns)(400).Description("Bad request"),
+    tslib_1.__param(0, (0, schema_1.Required)()),
+    tslib_1.__param(0, (0, common_1.BodyParams)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [CustomPropModel]),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario6", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-7"),
+    (0, schema_1.Returns)(400).Description("Bad request"),
+    (0, common_1.UseAfter)(FakeMiddleware),
+    (0, common_1.UseAfter)(ErrorMiddleware),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], ErrorsCtrl.prototype, "scenario7", null);
+ErrorsCtrl = tslib_1.__decorate([
+    (0, common_1.Controller)("/errors")
+], ErrorsCtrl);
+exports.ErrorsCtrl = ErrorsCtrl;
+function testErrors(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        env: core_1.Env.TEST,
+        mount: {
+            "/rest": [ErrorsCtrl]
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    it("Scenario 1: GET /rest/errors/scenario-1", async () => {
+        const response = await request.get("/rest/errors/scenario-1").expect(400);
+        expect(response.headers["x-header-error"]).toEqual("deny");
+        expect(response.body).toEqual({
+            name: "CUSTOM_BAD_REQUEST",
+            message: "Custom Bad Request",
+            status: 400,
+            errors: ["test"]
+        });
+    });
+    it("Scenario 2: GET /rest/errors/scenario-2", async () => {
+        const response = await request.get("/rest/errors/scenario-2").expect(500);
+        expect(response.body).toEqual({
+            errors: [],
+            message: "My error",
+            name: "Error",
+            status: 500
+        });
+    });
+    it("Scenario 3: GET /rest/errors/scenario-3", async () => {
+        const response = await request.get("/rest/errors/scenario-3").expect(500);
+        expect(response.headers["x-header-error"]).toEqual("deny");
+        expect(response.body).toEqual({
+            name: "CUSTOM_INTERNAL_SERVER_ERROR",
+            message: "My custom error",
+            status: 500,
+            errors: ["test"]
+        });
+    });
+    it("Scenario 4: POST /rest/errors/scenario-4", async () => {
+        const response = await request.post("/rest/errors/scenario-4").expect(400);
+        expect(response.body).toEqual({
+            errors: [
+                {
+                    dataPath: "",
+                    keyword: "required",
+                    message: "It should have required parameter 'name'",
+                    modelName: "body",
+                    params: {
+                        missingProperty: "name"
+                    },
+                    schemaPath: "#/required"
+                }
+            ],
+            message: "Bad request on parameter \"request.body.name\".\nIt should have required parameter 'name'",
+            name: "REQUIRED_VALIDATION_ERROR",
+            status: 400
+        });
+    });
+    it("Scenario 5: POST /rest/errors/scenario-5", async () => {
+        const response = await request.post("/rest/errors/scenario-5").expect(400);
+        expect(response.body).toEqual({
+            errors: [
+                {
+                    dataPath: "",
+                    instancePath: "",
+                    keyword: "required",
+                    message: "must have required property 'name'",
+                    modelName: "CustomModel",
+                    params: {
+                        missingProperty: "name"
+                    },
+                    schemaPath: "#/required"
+                }
+            ],
+            message: 'Bad request on parameter "request.body".\nCustomModel must have required property \'name\'. Given value: "undefined"',
+            name: "AJV_VALIDATION_ERROR",
+            status: 400
+        });
+    });
+    it("Scenario 6: POST /rest/errors/scenario-6", async () => {
+        const response = await request.post(`/rest/errors/scenario-6`).send({}).expect(400);
+        expect(response.body).toEqual({
+            errors: [
+                {
+                    dataPath: "",
+                    instancePath: "",
+                    keyword: "required",
+                    message: "must have required property 'role_item'",
+                    modelName: "CustomPropModel",
+                    params: {
+                        missingProperty: "role_item"
+                    },
+                    schemaPath: "#/required"
+                }
+            ],
+            message: 'Bad request on parameter "request.body".\nCustomPropModel must have required property \'role_item\'. Given value: "undefined"',
+            name: "AJV_VALIDATION_ERROR",
+            status: 400
+        });
+    });
+    it("Scenario 7: GET /rest/errors/scenario-7", async () => {
+        const response = await request.get("/rest/errors/scenario-7").expect(200);
+        expect(response.body).toEqual({
+            message: "no error"
+        });
+    });
+}
+exports.testErrors = testErrors;
+//# sourceMappingURL=testErrors.js.map

package/lib/cjs/tests/testErrors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testErrors.js","sourceRoot":"","sources":["../../../src/tests/testErrors.ts"],"names":[],"mappings":";;;;AAAA,qBAAmB;AACnB,yCAAwG;AACxG,qCAA+B;AAC/B,iDAAiE;AACjE,yCAA2E;AAC3E,kEAAkC;AAClC,iEAA4D;AAC5D,uEAAkE;AAGlE,MAAM,WAAW;IACH,IAAI,CAAS;CAC1B;AADa;IAAX,IAAA,iBAAQ,GAAE;;yCAAc;AAG3B,MAAM,eAAe;IAGnB,QAAQ,CAAS;CAClB;AADC;IAFC,IAAA,aAAI,EAAC,WAAW,CAAC;IACjB,IAAA,iBAAQ,GAAE;;iDACM;AAInB,IAAM,eAAe,GAArB,MAAM,eAAe;IACnB,GAAG,CAAQ,KAAU;QACnB,OAAO;YACL,OAAO,EAAE,UAAU;SACpB,CAAC;IACJ,CAAC;CACF,CAAA;AALC;IAAK,mBAAA,IAAA,YAAG,GAAE,CAAA;;;;0CAIT;AALG,eAAe;IADpB,IAAA,mBAAU,GAAE;GACP,eAAe,CAMpB;AAGD,IAAM,cAAc,GAApB,MAAM,cAAc;IAClB,GAAG;QACD,OAAO;YACL,OAAO,EAAE,mEAAmE;SAC7E,CAAC;IACJ,CAAC;CACF,CAAA;AANK,cAAc;IADnB,IAAA,mBAAU,GAAE;GACP,cAAc,CAMnB;AAGD,IAAa,UAAU,GAAvB,MAAa,UAAU;IAGd,SAAS;QACd,MAAM,IAAI,mCAAgB,CAAC,oBAAoB,CAAC,CAAC;IACnD,CAAC;IAIM,SAAS;QACd,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;IAC9B,CAAC;IAIM,SAAS;QACd,MAAM,IAAI,yCAAmB,CAAC,iBAAiB,CAAC,CAAC;IACnD,CAAC;IAIM,SAAS,CAAiC,IAAY;QAC3D,OAAO,IAAI,CAAC;IACd,CAAC;IAIM,SAAS,CAGd,KAAkB;QAElB,OAAO,KAAK,CAAC;IACf,CAAC;IAMM,SAAS,CAGd,KAAsB;QAEtB,OAAO,KAAK,CAAC;IACf,CAAC;IAMM,SAAS;QACd,MAAM,IAAI,yCAAmB,CAAC,iBAAiB,CAAC,CAAC;IACnD,CAAC;CACF,CAAA;AAnDC;IAFC,IAAA,YAAG,EAAC,aAAa,CAAC;IAClB,IAAA,gBAAO,EAAC,GAAG,EAAE,gCAAmB,CAAC,CAAC,WAAW,CAAC,oBAAoB,CAAC;;;;2CAGnE;AAID;IAFC,IAAA,YAAG,EAAC,aAAa,CAAC;IAClB,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC,WAAW,CAAC,uBAAuB,CAAC;;;;2CAGjD;AAID;IAFC,IAAA,YAAG,EAAC,aAAa,CAAC;IAClB,IAAA,gBAAO,EAAC,GAAG,EAAE,yCAAmB,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC;;;;2CAG5D;AAID;IAFC,IAAA,aAAI,EAAC,aAAa,CAAC;IACnB,IAAA,gBAAO,EAAC,GAAG,CAAC;IACK,mBAAA,IAAA,iBAAQ,GAAE,CAAA;IAAE,mBAAA,IAAA,mBAAU,EAAC,MAAM,CAAC,CAAA;;;;2CAE/C;AAID;IAFC,IAAA,aAAI,EAAC,aAAa,CAAC;IACnB,IAAA,gBAAO,EAAC,GAAG,EAAE,uBAAU,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC;IAEjD,mBAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,mBAAA,IAAA,mBAAU,GAAE,CAAA;;6CACN,WAAW;;2CAGnB;AAMD;IAJC,IAAA,aAAI,EAAC,aAAa,CAAC;IACnB,IAAA,gBAAO,EAAC,gDAAgD,CAAC;IACzD,IAAA,oBAAW,EAAC,yBAAyB,CAAC;IACtC,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC;IAErC,mBAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,mBAAA,IAAA,mBAAU,GAAE,CAAA;;6CACN,eAAe;;2CAGvB;AAMD;IAJC,IAAA,YAAG,EAAC,aAAa,CAAC;IAClB,IAAA,gBAAO,EAAC,GAAG,CAAC,CAAC,WAAW,CAAC,aAAa,CAAC;IACvC,IAAA,iBAAQ,EAAC,cAAc,CAAC;IACxB,IAAA,iBAAQ,EAAC,eAAe,CAAC;;;;2CAGzB;AArDU,UAAU;IADtB,IAAA,mBAAU,EAAC,SAAS,CAAC;GACT,UAAU,CAsDtB;AAtDY,gCAAU;AAwDvB,SAAgB,UAAU,CAAC,OAA+B;IACxD,IAAI,OAA4C,CAAC;IACjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;QACrC,GAAG,OAAO;QACV,GAAG,EAAE,UAAG,CAAC,IAAI;QACb,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,UAAU,CAAC;SACtB;KACF,CAAC,CACH,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,GAAG,IAAA,mBAAS,EAAC,qBAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,qBAAY,CAAC,KAAK,CAAC,CAAC;IAE7B,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE/E,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,IAAI,EAAE,oBAAoB;YAC1B,OAAO,EAAE,oBAAoB;YAC7B,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,CAAC,MAAM,CAAC;SACjB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE/E,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE,EAAE;YACV,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,OAAO;YACb,MAAM,EAAE,GAAG;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE/E,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAC3D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,IAAI,EAAE,8BAA8B;YACpC,OAAO,EAAE,iBAAiB;YAC1B,MAAM,EAAE,GAAG;YACX,MAAM,EAAE,CAAC,MAAM,CAAC;SACjB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,EAAE;oBACZ,OAAO,EAAE,UAAU;oBACnB,OAAO,EAAE,0CAA0C;oBACnD,SAAS,EAAE,MAAM;oBACjB,MAAM,EAAE;wBACN,eAAe,EAAE,MAAM;qBACxB;oBACD,UAAU,EAAE,YAAY;iBACzB;aACF;YACD,OAAO,EAAE,2FAA2F;YACpG,IAAI,EAAE,2BAA2B;YACjC,MAAM,EAAE,GAAG;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,EAAE;oBACZ,YAAY,EAAE,EAAE;oBAChB,OAAO,EAAE,UAAU;oBACnB,OAAO,EAAE,oCAAoC;oBAC7C,SAAS,EAAE,aAAa;oBACxB,MAAM,EAAE;wBACN,eAAe,EAAE,MAAM;qBACxB;oBACD,UAAU,EAAE,YAAY;iBACzB;aACF;YACD,OAAO,EAAE,sHAAsH;YAC/H,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,GAAG;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,KAAK,IAAI,EAAE;QACxD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEzF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE;gBACN;oBACE,QAAQ,EAAE,EAAE;oBACZ,YAAY,EAAE,EAAE;oBAChB,OAAO,EAAE,UAAU;oBACnB,OAAO,EAAE,yCAAyC;oBAClD,SAAS,EAAE,iBAAiB;oBAC5B,MAAM,EAAE;wBACN,eAAe,EAAE,WAAW;qBAC7B;oBACD,UAAU,EAAE,YAAY;iBACzB;aACF;YACD,OAAO,EACL,+HAA+H;YACjI,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,GAAG;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;QACvD,MAAM,QAAQ,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAE/E,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,OAAO,EAAE,UAAU;SACpB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AA/HD,gCA+HC","sourcesContent":["import \"@tsed/ajv\";\nimport {BodyParams, Controller, Err, Get, Middleware, PlatformTest, Post, UseAfter} from \"@tsed/common\";\nimport {Env} from \"@tsed/core\";\nimport {BadRequest, InternalServerError} from \"@tsed/exceptions\";\nimport {Description, Name, Required, Returns, Summary} from \"@tsed/schema\";\nimport SuperTest from \"supertest\";\nimport {CustomBadRequest} from \"../errors/CustomBadRequest\";\nimport {CustomInternalError} from \"../errors/CustomInternalError\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\n\nclass CustomModel {\n  @Required() name: string;\n}\n\nclass CustomPropModel {\n  @Name(\"role_item\")\n  @Required()\n  roleItem: string;\n}\n\n@Middleware()\nclass ErrorMiddleware {\n  use(@Err() error: any) {\n    return {\n      message: \"no error\"\n    };\n  }\n}\n\n@Middleware()\nclass FakeMiddleware {\n  use() {\n    return {\n      message: \"should not be called by the platform when endpoint throw an error\"\n    };\n  }\n}\n\n@Controller(\"/errors\")\nexport class ErrorsCtrl {\n  @Get(\"/scenario-1\")\n  @Returns(500, InternalServerError).Description(\"Custom Bad Request\")\n  public scenario1() {\n    throw new CustomBadRequest(\"Custom Bad Request\");\n  }\n\n  @Get(\"/scenario-2\")\n  @Returns(500).Description(\"Internal Server Error\")\n  public scenario2() {\n    throw new Error(\"My error\");\n  }\n\n  @Get(\"/scenario-3\")\n  @Returns(400, CustomInternalError).Description(\"Bad request\")\n  public scenario3() {\n    throw new CustomInternalError(\"My custom error\");\n  }\n\n  @Post(\"/scenario-4\")\n  @Returns(400)\n  public scenario4(@Required() @BodyParams(\"name\") name: string) {\n    return name;\n  }\n\n  @Post(\"/scenario-5\")\n  @Returns(400, BadRequest).Description(\"Bad request\")\n  public scenario5(\n    @Required()\n    @BodyParams()\n    model: CustomModel\n  ) {\n    return model;\n  }\n\n  @Post(\"/scenario-6\")\n  @Summary(\"Throw a Required prop if prop name is required\")\n  @Description(`Return a required error`)\n  @Returns(400).Description(\"Bad request\")\n  public scenario6(\n    @Required()\n    @BodyParams()\n    model: CustomPropModel\n  ) {\n    return model;\n  }\n\n  @Get(\"/scenario-7\")\n  @Returns(400).Description(\"Bad request\")\n  @UseAfter(FakeMiddleware)\n  @UseAfter(ErrorMiddleware)\n  public scenario7() {\n    throw new CustomInternalError(\"My custom error\");\n  }\n}\n\nexport function testErrors(options: PlatformTestingSdkOpts) {\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n  beforeAll(\n    PlatformTest.bootstrap(options.server, {\n      ...options,\n      env: Env.TEST,\n      mount: {\n        \"/rest\": [ErrorsCtrl]\n      }\n    })\n  );\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n\n  it(\"Scenario 1: GET /rest/errors/scenario-1\", async () => {\n    const response: any = await request.get(\"/rest/errors/scenario-1\").expect(400);\n\n    expect(response.headers[\"x-header-error\"]).toEqual(\"deny\");\n    expect(response.body).toEqual({\n      name: \"CUSTOM_BAD_REQUEST\",\n      message: \"Custom Bad Request\",\n      status: 400,\n      errors: [\"test\"]\n    });\n  });\n\n  it(\"Scenario 2: GET /rest/errors/scenario-2\", async () => {\n    const response: any = await request.get(\"/rest/errors/scenario-2\").expect(500);\n\n    expect(response.body).toEqual({\n      errors: [],\n      message: \"My error\",\n      name: \"Error\",\n      status: 500\n    });\n  });\n\n  it(\"Scenario 3: GET /rest/errors/scenario-3\", async () => {\n    const response: any = await request.get(\"/rest/errors/scenario-3\").expect(500);\n\n    expect(response.headers[\"x-header-error\"]).toEqual(\"deny\");\n    expect(response.body).toEqual({\n      name: \"CUSTOM_INTERNAL_SERVER_ERROR\",\n      message: \"My custom error\",\n      status: 500,\n      errors: [\"test\"]\n    });\n  });\n\n  it(\"Scenario 4: POST /rest/errors/scenario-4\", async () => {\n    const response: any = await request.post(\"/rest/errors/scenario-4\").expect(400);\n\n    expect(response.body).toEqual({\n      errors: [\n        {\n          dataPath: \"\",\n          keyword: \"required\",\n          message: \"It should have required parameter 'name'\",\n          modelName: \"body\",\n          params: {\n            missingProperty: \"name\"\n          },\n          schemaPath: \"#/required\"\n        }\n      ],\n      message: \"Bad request on parameter \\\"request.body.name\\\".\\nIt should have required parameter 'name'\",\n      name: \"REQUIRED_VALIDATION_ERROR\",\n      status: 400\n    });\n  });\n\n  it(\"Scenario 5: POST /rest/errors/scenario-5\", async () => {\n    const response: any = await request.post(\"/rest/errors/scenario-5\").expect(400);\n\n    expect(response.body).toEqual({\n      errors: [\n        {\n          dataPath: \"\",\n          instancePath: \"\",\n          keyword: \"required\",\n          message: \"must have required property 'name'\",\n          modelName: \"CustomModel\",\n          params: {\n            missingProperty: \"name\"\n          },\n          schemaPath: \"#/required\"\n        }\n      ],\n      message: 'Bad request on parameter \"request.body\".\\nCustomModel must have required property \\'name\\'. Given value: \"undefined\"',\n      name: \"AJV_VALIDATION_ERROR\",\n      status: 400\n    });\n  });\n\n  it(\"Scenario 6: POST /rest/errors/scenario-6\", async () => {\n    const response: any = await request.post(`/rest/errors/scenario-6`).send({}).expect(400);\n\n    expect(response.body).toEqual({\n      errors: [\n        {\n          dataPath: \"\",\n          instancePath: \"\",\n          keyword: \"required\",\n          message: \"must have required property 'role_item'\",\n          modelName: \"CustomPropModel\",\n          params: {\n            missingProperty: \"role_item\"\n          },\n          schemaPath: \"#/required\"\n        }\n      ],\n      message:\n        'Bad request on parameter \"request.body\".\\nCustomPropModel must have required property \\'role_item\\'. Given value: \"undefined\"',\n      name: \"AJV_VALIDATION_ERROR\",\n      status: 400\n    });\n  });\n\n  it(\"Scenario 7: GET /rest/errors/scenario-7\", async () => {\n    const response: any = await request.get(\"/rest/errors/scenario-7\").expect(200);\n\n    expect(response.body).toEqual({\n      message: \"no error\"\n    });\n  });\n}\n"]}

package/lib/cjs/tests/testHandlers.js

@@ -0,0 +1,110 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testHandlers = exports.HandlersCtrl = exports.MyModel = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const schema_1 = require("@tsed/schema");
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+class MyModel {
+    id;
+    name;
+}
+tslib_1.__decorate([
+    (0, schema_1.Title)("ID"),
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], MyModel.prototype, "id", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    (0, schema_1.Required)(),
+    tslib_1.__metadata("design:type", String)
+], MyModel.prototype, "name", void 0);
+exports.MyModel = MyModel;
+let HandlersCtrl = class HandlersCtrl {
+    scenario1(id) {
+        const model = new MyModel();
+        model.id = id;
+        model.name = "test";
+        return model;
+    }
+    scenario2(ctx, id) {
+        const model = new MyModel();
+        model.id = "1";
+        model.name = "test";
+        try {
+            ctx.response.status(202).body(model);
+        }
+        catch (er) {
+            console.log(er);
+        }
+    }
+    async scenario3(id) {
+        const model = new MyModel();
+        model.id = id;
+        model.name = "test";
+        return model;
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-1/:id") // Express style
+    ,
+    tslib_1.__param(0, (0, common_1.PathParams)("id")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", MyModel)
+], HandlersCtrl.prototype, "scenario1", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-2/:id") // Ts.ED style with response injection
+    ,
+    tslib_1.__param(0, (0, common_1.Context)()),
+    tslib_1.__param(1, (0, common_1.PathParams)("id")),
+    tslib_1.__param(1, (0, schema_1.Required)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, String]),
+    tslib_1.__metadata("design:returntype", void 0)
+], HandlersCtrl.prototype, "scenario2", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-3/:id") // Ts.ED style
+    ,
+    tslib_1.__param(0, (0, common_1.PathParams)("id")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], HandlersCtrl.prototype, "scenario3", null);
+HandlersCtrl = tslib_1.__decorate([
+    (0, common_1.Controller)("/handlers")
+], HandlersCtrl);
+exports.HandlersCtrl = HandlersCtrl;
+function testHandlers(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        logger: {
+            leve: "info"
+        },
+        mount: {
+            "/rest": [HandlersCtrl]
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    it("Scenario 1: GET /rest/handlers/scenario-1/:id", async () => {
+        const { body } = await request.get("/rest/handlers/scenario-1/1").expect(200);
+        expect(body.id).toEqual("1");
+        expect(body.name).toEqual("test");
+    });
+    it("Scenario 2: GET /rest/handlers/scenario-2/:id", async () => {
+        const { body } = await request.get("/rest/handlers/scenario-2/1").expect(202);
+        expect(body.id).toEqual("1");
+        expect(body.name).toEqual("test");
+    });
+    it("Scenario 3: GET /rest/handlers/scenario-3/:id", async () => {
+        const { body } = await request.get("/rest/handlers/scenario-3/1").expect(200);
+        expect(body.id).toEqual("1");
+        expect(body.name).toEqual("test");
+    });
+}
+exports.testHandlers = testHandlers;
+//# sourceMappingURL=testHandlers.js.map

package/lib/cjs/tests/testHandlers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testHandlers.js","sourceRoot":"","sources":["../../../src/tests/testHandlers.ts"],"names":[],"mappings":";;;;AAAA,yCAAgF;AAChF,yCAAuD;AACvD,kEAAkC;AAGlC,MAAa,OAAO;IAGX,EAAE,CAAS;IAIX,IAAI,CAAS;CACrB;AALC;IAFC,IAAA,cAAK,EAAC,IAAI,CAAC;IACX,IAAA,iBAAQ,GAAE;;mCACO;AAIlB;IAFC,IAAA,iBAAQ,GAAE;IACV,IAAA,iBAAQ,GAAE;;qCACS;AAPtB,0BAQC;AAGD,IAAa,YAAY,GAAzB,MAAa,YAAY;IAEhB,SAAS,CAAmB,EAAU;QAC3C,MAAM,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QAC5B,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;QAEpB,OAAO,KAAK,CAAC;IACf,CAAC;IAGM,SAAS,CACH,GAAY,EAGvB,EAAU;QAEV,MAAM,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QAC5B,KAAK,CAAC,EAAE,GAAG,GAAG,CAAC;QACf,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;QAEpB,IAAI;YACF,GAAG,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;SACtC;QAAC,OAAO,EAAE,EAAE;YACX,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;SACjB;IACH,CAAC;IAGM,KAAK,CAAC,SAAS,CAAmB,EAAU;QACjD,MAAM,KAAK,GAAG,IAAI,OAAO,EAAE,CAAC;QAC5B,KAAK,CAAC,EAAE,GAAG,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,GAAG,MAAM,CAAC;QAEpB,OAAO,KAAK,CAAC;IACf,CAAC;CACF,CAAA;AAlCC;IADC,IAAA,YAAG,EAAC,iBAAiB,CAAC,CAAC,gBAAgB;;IACtB,mBAAA,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAA;;;4CAAc,OAAO;6CAMtD;AAGD;IADC,IAAA,YAAG,EAAC,iBAAiB,CAAC,CAAC,sCAAsC;;IAE3D,mBAAA,IAAA,gBAAO,GAAE,CAAA;IACT,mBAAA,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAA;IAChB,mBAAA,IAAA,iBAAQ,GAAE,CAAA;;;;6CAYZ;AAGD;IADC,IAAA,YAAG,EAAC,iBAAiB,CAAC,CAAC,cAAc;;IACd,mBAAA,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAA;;;;6CAMvC;AAnCU,YAAY;IADxB,IAAA,mBAAU,EAAC,WAAW,CAAC;GACX,YAAY,CAoCxB;AApCY,oCAAY;AAsCzB,SAAgB,YAAY,CAAC,OAA+B;IAC1D,IAAI,OAA4C,CAAC;IACjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;QACrC,GAAG,OAAO;QACV,MAAM,EAAE;YACN,IAAI,EAAE,MAAM;SACb;QACD,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,YAAY,CAAC;SACxB;KACF,CAAC,CACH,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,GAAG,IAAA,mBAAS,EAAC,qBAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,qBAAY,CAAC,KAAK,CAAC,CAAC;IAC7B,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,EAAC,IAAI,EAAC,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEjF,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,EAAC,IAAI,EAAC,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEjF,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;QAC7D,MAAM,EAAC,IAAI,EAAC,GAAQ,MAAM,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEjF,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC;AArCD,oCAqCC","sourcesContent":["import {Context, Controller, Get, PathParams, PlatformTest} from \"@tsed/common\";\nimport {Property, Required, Title} from \"@tsed/schema\";\nimport SuperTest from \"supertest\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\n\nexport class MyModel {\n  @Title(\"ID\")\n  @Property()\n  public id: string;\n\n  @Property()\n  @Required()\n  public name: string;\n}\n\n@Controller(\"/handlers\")\nexport class HandlersCtrl {\n  @Get(\"/scenario-1/:id\") // Express style\n  public scenario1(@PathParams(\"id\") id: string): MyModel {\n    const model = new MyModel();\n    model.id = id;\n    model.name = \"test\";\n\n    return model;\n  }\n\n  @Get(\"/scenario-2/:id\") // Ts.ED style with response injection\n  public scenario2(\n    @Context() ctx: Context,\n    @PathParams(\"id\")\n    @Required()\n    id: string\n  ): void {\n    const model = new MyModel();\n    model.id = \"1\";\n    model.name = \"test\";\n\n    try {\n      ctx.response.status(202).body(model);\n    } catch (er) {\n      console.log(er);\n    }\n  }\n\n  @Get(\"/scenario-3/:id\") // Ts.ED style\n  public async scenario3(@PathParams(\"id\") id: string): Promise<any> {\n    const model = new MyModel();\n    model.id = id;\n    model.name = \"test\";\n\n    return model;\n  }\n}\n\nexport function testHandlers(options: PlatformTestingSdkOpts) {\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n  beforeAll(\n    PlatformTest.bootstrap(options.server, {\n      ...options,\n      logger: {\n        leve: \"info\"\n      },\n      mount: {\n        \"/rest\": [HandlersCtrl]\n      }\n    })\n  );\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n  it(\"Scenario 1: GET /rest/handlers/scenario-1/:id\", async () => {\n    const {body}: any = await request.get(\"/rest/handlers/scenario-1/1\").expect(200);\n\n    expect(body.id).toEqual(\"1\");\n    expect(body.name).toEqual(\"test\");\n  });\n\n  it(\"Scenario 2: GET /rest/handlers/scenario-2/:id\", async () => {\n    const {body}: any = await request.get(\"/rest/handlers/scenario-2/1\").expect(202);\n\n    expect(body.id).toEqual(\"1\");\n    expect(body.name).toEqual(\"test\");\n  });\n\n  it(\"Scenario 3: GET /rest/handlers/scenario-3/:id\", async () => {\n    const {body}: any = await request.get(\"/rest/handlers/scenario-3/1\").expect(200);\n\n    expect(body.id).toEqual(\"1\");\n    expect(body.name).toEqual(\"test\");\n  });\n}\n"]}

package/lib/cjs/tests/testHeaderParams.js

@@ -0,0 +1,166 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testHeaderParams = exports.HeaderParamsCtrl = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const schema_1 = require("@tsed/schema");
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+let SetId = class SetId {
+    use(request, locals, $ctx) {
+        request["user"] = 1;
+        locals.id = "local-10909";
+        $ctx.set("uid", "ctx-10909");
+    }
+};
+tslib_1.__decorate([
+    tslib_1.__param(0, (0, common_1.Req)()),
+    tslib_1.__param(1, (0, common_1.Locals)()),
+    tslib_1.__param(2, (0, common_1.Context)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, Object, Object]),
+    tslib_1.__metadata("design:returntype", void 0)
+], SetId.prototype, "use", null);
+SetId = tslib_1.__decorate([
+    (0, common_1.Middleware)()
+], SetId);
+let HeaderParamsCtrl = class HeaderParamsCtrl {
+    /**
+     * Handle request with a raw middleware + handler
+     * Get Authorization from header
+     * @param request
+     * @param auth
+     */
+    scenario1(request, auth) {
+        return {
+            user: request.user,
+            token: auth
+        };
+    }
+    scenario2(contentType) {
+        return { contentType };
+    }
+    testScenario3(token) {
+        return { token };
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-1"),
+    (0, common_1.Use)(SetId),
+    tslib_1.__param(0, (0, common_1.Req)()),
+    tslib_1.__param(1, (0, common_1.HeaderParams)("authorization")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, String]),
+    tslib_1.__metadata("design:returntype", Object)
+], HeaderParamsCtrl.prototype, "scenario1", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-2"),
+    tslib_1.__param(0, (0, common_1.HeaderParams)("Content-type")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", void 0)
+], HeaderParamsCtrl.prototype, "scenario2", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-3"),
+    tslib_1.__param(0, (0, common_1.HeaderParams)({
+        expression: "x-token",
+        useValidation: true
+    })),
+    tslib_1.__param(0, (0, schema_1.Required)()),
+    tslib_1.__param(0, (0, schema_1.Enum)("test", "gcp")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", Object)
+], HeaderParamsCtrl.prototype, "testScenario3", null);
+HeaderParamsCtrl = tslib_1.__decorate([
+    (0, common_1.Controller)("/header-params")
+], HeaderParamsCtrl);
+exports.HeaderParamsCtrl = HeaderParamsCtrl;
+function testHeaderParams(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        mount: {
+            "/rest": [HeaderParamsCtrl]
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    describe("Scenario 1: GET /rest/header-params/scenario-1", () => {
+        it("should return a response with the extracted authorization from the request headers", async () => {
+            const { body } = await request
+                .get("/rest/header-params/scenario-1")
+                .set({
+                Authorization: "tokenauth"
+            })
+                .expect(200);
+            expect(body.user).toEqual(1);
+            expect(body.token).toEqual("tokenauth");
+        });
+    });
+    describe("Scenario 2: POST with contentType", () => {
+        it("should return a response with the extracted contentType from the request headers", async () => {
+            const response = await request
+                .post("/rest/header-params/scenario-2")
+                .set({
+                "Content-Type": "application/json"
+            })
+                .expect(200);
+            expect(response.body).toEqual({
+                contentType: "application/json"
+            });
+        });
+    });
+    describe("Scenario3: GET /rest/headers/scenario-3", () => {
+        it("should accept the header", async () => {
+            const response = await request.get("/rest/header-params/scenario-3").set("x-token", "test").expect(200);
+            expect(response.body).toEqual({
+                token: "test"
+            });
+        });
+        it("should not validate the header", async () => {
+            const response = await request.get("/rest/header-params/scenario-3").expect(400);
+            expect(response.body).toEqual({
+                errors: [
+                    {
+                        dataPath: "",
+                        keyword: "required",
+                        message: "It should have required parameter 'x-token'",
+                        modelName: "header",
+                        params: {
+                            missingProperty: "x-token"
+                        },
+                        schemaPath: "#/required"
+                    }
+                ],
+                message: "Bad request on parameter \"request.header.x-token\".\nIt should have required parameter 'x-token'",
+                name: "REQUIRED_VALIDATION_ERROR",
+                status: 400
+            });
+        });
+        it("should not validate the header - enum", async () => {
+            const response = await request.get("/rest/header-params/scenario-3").set("x-token", "invalid").expect(400);
+            expect(response.body).toEqual({
+                errors: [
+                    {
+                        data: "invalid",
+                        dataPath: "",
+                        instancePath: "",
+                        keyword: "enum",
+                        message: "must be equal to one of the allowed values",
+                        params: {
+                            allowedValues: ["test", "gcp"]
+                        },
+                        schemaPath: "#/enum"
+                    }
+                ],
+                message: 'Bad request on parameter "request.header.x-token".\nValue must be equal to one of the allowed values. Given value: "invalid"',
+                name: "AJV_VALIDATION_ERROR",
+                status: 400
+            });
+        });
+    });
+}
+exports.testHeaderParams = testHeaderParams;
+//# sourceMappingURL=testHeaderParams.js.map

package/lib/cjs/tests/testHeaderParams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"testHeaderParams.js","sourceRoot":"","sources":["../../../src/tests/testHeaderParams.ts"],"names":[],"mappings":";;;;AAAA,yCAAsH;AACtH,yCAA4C;AAC5C,kEAAkC;AAIlC,IAAM,KAAK,GAAX,MAAM,KAAK;IACT,GAAG,CAAQ,OAAY,EAAY,MAAW,EAAa,IAAa;QACtE,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,MAAM,CAAC,EAAE,GAAG,aAAa,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAC/B,CAAC;CACF,CAAA;AALC;IAAK,mBAAA,IAAA,YAAG,GAAE,CAAA;IAAgB,mBAAA,IAAA,eAAM,GAAE,CAAA;IAAe,mBAAA,IAAA,gBAAO,GAAE,CAAA;;;;gCAIzD;AALG,KAAK;IADV,IAAA,mBAAU,GAAE;GACP,KAAK,CAMV;AAGD,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAC3B;;;;;OAKG;IAGI,SAAS,CAAQ,OAAY,EAAiC,IAAY;QAC/E,OAAO;YACL,IAAI,EAAG,OAAe,CAAC,IAAI;YAC3B,KAAK,EAAE,IAAI;SACZ,CAAC;IACJ,CAAC;IAGD,SAAS,CAA+B,WAAmB;QACzD,OAAO,EAAC,WAAW,EAAC,CAAC;IACvB,CAAC;IAGD,aAAa,CAOX,KAAa;QAEb,OAAO,EAAC,KAAK,EAAC,CAAC;IACjB,CAAC;CACF,CAAA;AAxBC;IAFC,IAAA,YAAG,EAAC,aAAa,CAAC;IAClB,IAAA,YAAG,EAAC,KAAK,CAAC;IACO,mBAAA,IAAA,YAAG,GAAE,CAAA;IAAgB,mBAAA,IAAA,qBAAY,EAAC,eAAe,CAAC,CAAA;;;;iDAKnE;AAGD;IADC,IAAA,aAAI,EAAC,aAAa,CAAC;IACT,mBAAA,IAAA,qBAAY,EAAC,cAAc,CAAC,CAAA;;;;iDAEtC;AAGD;IADC,IAAA,YAAG,EAAC,aAAa,CAAC;IAEhB,mBAAA,IAAA,qBAAY,EAAC;QACZ,UAAU,EAAE,SAAS;QACrB,aAAa,EAAE,IAAI;KACpB,CAAC,CAAA;IACD,mBAAA,IAAA,iBAAQ,GAAE,CAAA;IACV,mBAAA,IAAA,aAAI,EAAC,MAAM,EAAE,KAAK,CAAC,CAAA;;;;qDAIrB;AAhCU,gBAAgB;IAD5B,IAAA,mBAAU,EAAC,gBAAgB,CAAC;GAChB,gBAAgB,CAiC5B;AAjCY,4CAAgB;AAmC7B,SAAgB,gBAAgB,CAAC,OAA+B;IAC9D,IAAI,OAA4C,CAAC;IACjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;QACrC,GAAG,OAAO;QACV,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,gBAAgB,CAAC;SAC5B;KACF,CAAC,CACH,CAAC;IACF,SAAS,CAAC,GAAG,EAAE;QACb,OAAO,GAAG,IAAA,mBAAS,EAAC,qBAAY,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,qBAAY,CAAC,KAAK,CAAC,CAAC;IAE7B,QAAQ,CAAC,gDAAgD,EAAE,GAAG,EAAE;QAC9D,EAAE,CAAC,oFAAoF,EAAE,KAAK,IAAI,EAAE;YAClG,MAAM,EAAC,IAAI,EAAC,GAAQ,MAAM,OAAO;iBAC9B,GAAG,CAAC,gCAAgC,CAAC;iBACrC,GAAG,CAAC;gBACH,aAAa,EAAE,WAAW;aAC3B,CAAC;iBACD,MAAM,CAAC,GAAG,CAAC,CAAC;YAEf,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACjD,EAAE,CAAC,kFAAkF,EAAE,KAAK,IAAI,EAAE;YAChG,MAAM,QAAQ,GAAG,MAAM,OAAO;iBAC3B,IAAI,CAAC,gCAAgC,CAAC;iBACtC,GAAG,CAAC;gBACH,cAAc,EAAE,kBAAkB;aACnC,CAAC;iBACD,MAAM,CAAC,GAAG,CAAC,CAAC;YAEf,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC5B,WAAW,EAAE,kBAAkB;aAChC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACvD,EAAE,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;YACxC,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAExG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC5B,KAAK,EAAE,MAAM;aACd,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEjF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC5B,MAAM,EAAE;oBACN;wBACE,QAAQ,EAAE,EAAE;wBACZ,OAAO,EAAE,UAAU;wBACnB,OAAO,EAAE,6CAA6C;wBACtD,SAAS,EAAE,QAAQ;wBACnB,MAAM,EAAE;4BACN,eAAe,EAAE,SAAS;yBAC3B;wBACD,UAAU,EAAE,YAAY;qBACzB;iBACF;gBACD,OAAO,EAAE,mGAAmG;gBAC5G,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACrD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAE3G,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC5B,MAAM,EAAE;oBACN;wBACE,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,EAAE;wBACZ,YAAY,EAAE,EAAE;wBAChB,OAAO,EAAE,MAAM;wBACf,OAAO,EAAE,4CAA4C;wBACrD,MAAM,EAAE;4BACN,aAAa,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;yBAC/B;wBACD,UAAU,EAAE,QAAQ;qBACrB;iBACF;gBACD,OAAO,EACL,8HAA8H;gBAChI,IAAI,EAAE,sBAAsB;gBAC5B,MAAM,EAAE,GAAG;aACZ,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAlGD,4CAkGC","sourcesContent":["import {Context, Controller, Get, HeaderParams, Locals, Middleware, PlatformTest, Post, Req, Use} from \"@tsed/common\";\nimport {Enum, Required} from \"@tsed/schema\";\nimport SuperTest from \"supertest\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\n\n@Middleware()\nclass SetId {\n  use(@Req() request: any, @Locals() locals: any, @Context() $ctx: Context) {\n    request[\"user\"] = 1;\n    locals.id = \"local-10909\";\n    $ctx.set(\"uid\", \"ctx-10909\");\n  }\n}\n\n@Controller(\"/header-params\")\nexport class HeaderParamsCtrl {\n  /**\n   * Handle request with a raw middleware + handler\n   * Get Authorization from header\n   * @param request\n   * @param auth\n   */\n  @Get(\"/scenario-1\")\n  @Use(SetId)\n  public scenario1(@Req() request: Req, @HeaderParams(\"authorization\") auth: string): any {\n    return {\n      user: (request as any).user,\n      token: auth\n    };\n  }\n\n  @Post(\"/scenario-2\")\n  scenario2(@HeaderParams(\"Content-type\") contentType: string) {\n    return {contentType};\n  }\n\n  @Get(\"/scenario-3\")\n  testScenario3(\n    @HeaderParams({\n      expression: \"x-token\",\n      useValidation: true\n    })\n    @Required()\n    @Enum(\"test\", \"gcp\")\n    token: string\n  ): any {\n    return {token};\n  }\n}\n\nexport function testHeaderParams(options: PlatformTestingSdkOpts) {\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n  beforeAll(\n    PlatformTest.bootstrap(options.server, {\n      ...options,\n      mount: {\n        \"/rest\": [HeaderParamsCtrl]\n      }\n    })\n  );\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n\n  describe(\"Scenario 1: GET /rest/header-params/scenario-1\", () => {\n    it(\"should return a response with the extracted authorization from the request headers\", async () => {\n      const {body}: any = await request\n        .get(\"/rest/header-params/scenario-1\")\n        .set({\n          Authorization: \"tokenauth\"\n        })\n        .expect(200);\n\n      expect(body.user).toEqual(1);\n      expect(body.token).toEqual(\"tokenauth\");\n    });\n  });\n\n  describe(\"Scenario 2: POST with contentType\", () => {\n    it(\"should return a response with the extracted contentType from the request headers\", async () => {\n      const response = await request\n        .post(\"/rest/header-params/scenario-2\")\n        .set({\n          \"Content-Type\": \"application/json\"\n        })\n        .expect(200);\n\n      expect(response.body).toEqual({\n        contentType: \"application/json\"\n      });\n    });\n  });\n  describe(\"Scenario3: GET /rest/headers/scenario-3\", () => {\n    it(\"should accept the header\", async () => {\n      const response = await request.get(\"/rest/header-params/scenario-3\").set(\"x-token\", \"test\").expect(200);\n\n      expect(response.body).toEqual({\n        token: \"test\"\n      });\n    });\n\n    it(\"should not validate the header\", async () => {\n      const response = await request.get(\"/rest/header-params/scenario-3\").expect(400);\n\n      expect(response.body).toEqual({\n        errors: [\n          {\n            dataPath: \"\",\n            keyword: \"required\",\n            message: \"It should have required parameter 'x-token'\",\n            modelName: \"header\",\n            params: {\n              missingProperty: \"x-token\"\n            },\n            schemaPath: \"#/required\"\n          }\n        ],\n        message: \"Bad request on parameter \\\"request.header.x-token\\\".\\nIt should have required parameter 'x-token'\",\n        name: \"REQUIRED_VALIDATION_ERROR\",\n        status: 400\n      });\n    });\n\n    it(\"should not validate the header - enum\", async () => {\n      const response = await request.get(\"/rest/header-params/scenario-3\").set(\"x-token\", \"invalid\").expect(400);\n\n      expect(response.body).toEqual({\n        errors: [\n          {\n            data: \"invalid\",\n            dataPath: \"\",\n            instancePath: \"\",\n            keyword: \"enum\",\n            message: \"must be equal to one of the allowed values\",\n            params: {\n              allowedValues: [\"test\", \"gcp\"]\n            },\n            schemaPath: \"#/enum\"\n          }\n        ],\n        message:\n          'Bad request on parameter \"request.header.x-token\".\\nValue must be equal to one of the allowed values. Given value: \"invalid\"',\n        name: \"AJV_VALIDATION_ERROR\",\n        status: 400\n      });\n    });\n  });\n}\n"]}