@tsed/platform-test-sdk 7.12.0

package/lib/cjs/tests/testModule.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+const FeatureModule_1 = require("../modules/feature/FeatureModule");
+let TestRootCtrl = class TestRootCtrl {
+    testScenario1() {
+        return "From root";
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Get)("/"),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", []),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestRootCtrl.prototype, "testScenario1", null);
+TestRootCtrl = tslib_1.__decorate([
+    (0, common_1.Controller)("/root")
+], TestRootCtrl);
+function testModule(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        mount: {
+            "/rest": [TestRootCtrl]
+        },
+        imports: [FeatureModule_1.FeatureModule]
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    describe("Scenario1: GET /rest/root", () => {
+        it("should get content from root controller", async () => {
+            const response = await request.get("/rest/root").expect(200);
+            expect(response.text).toEqual("From root");
+        });
+    });
+    describe("Scenario2: GET /rest/features", () => {
+        it("should get content from a module with his controller", async () => {
+            const response = await request.get("/rest/features").expect(200);
+            expect(response.text).toEqual("From feature");
+        });
+    });
+}
+exports.testModule = testModule;
+//# sourceMappingURL=testModule.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"testModule.js","sourceRoot":"","sources":["../../../src/tests/testModule.ts"],"names":[],"mappings":";;;;AAAA,yCAA2D;AAC3D,kEAAkC;AAElC,oEAA+D;AAG/D,IAAM,YAAY,GAAlB,MAAM,YAAY;IAEhB,aAAa;QACX,OAAO,WAAW,CAAC;IACrB,CAAC;CACF,CAAA;AAHC;IADC,IAAA,YAAG,EAAC,GAAG,CAAC;;;;iDAGR;AAJG,YAAY;IADjB,IAAA,mBAAU,EAAC,OAAO,CAAC;GACd,YAAY,CAKjB;AAED,SAAgB,UAAU,CAAC,OAA+B;IACxD,IAAI,OAA4C,CAAC;IAEjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;QACrC,GAAG,OAAO;QACV,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,YAAY,CAAC;SACxB;QACD,OAAO,EAAE,CAAC,6BAAa,CAAC;KACzB,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,2BAA2B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,yCAAyC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAE7D,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;QAC7C,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEjE,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAChD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAhCD,gCAgCC","sourcesContent":["import {Controller, Get, PlatformTest} from \"@tsed/common\";\nimport SuperTest from \"supertest\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\nimport {FeatureModule} from \"../modules/feature/FeatureModule\";\n\n@Controller(\"/root\")\nclass TestRootCtrl {\n  @Get(\"/\")\n  testScenario1() {\n    return \"From root\";\n  }\n}\n\nexport function testModule(options: PlatformTestingSdkOpts) {\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n\n  beforeAll(\n    PlatformTest.bootstrap(options.server, {\n      ...options,\n      mount: {\n        \"/rest\": [TestRootCtrl]\n      },\n      imports: [FeatureModule]\n    })\n  );\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n\n  describe(\"Scenario1: GET /rest/root\", () => {\n    it(\"should get content from root controller\", async () => {\n      const response = await request.get(\"/rest/root\").expect(200);\n\n      expect(response.text).toEqual(\"From root\");\n    });\n  });\n\n  describe(\"Scenario2: GET /rest/features\", () => {\n    it(\"should get content from a module with his controller\", async () => {\n      const response = await request.get(\"/rest/features\").expect(200);\n\n      expect(response.text).toEqual(\"From feature\");\n    });\n  });\n}\n"]}

package/lib/cjs/tests/testMulter.js

@@ -0,0 +1,162 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testMulter = exports.TestMulterController = exports.Event = exports.Task = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@tsed/common");
+const schema_1 = require("@tsed/schema");
+const multer_1 = tslib_1.__importDefault(require("multer"));
+const supertest_1 = tslib_1.__importDefault(require("supertest"));
+class Task {
+    id;
+    title;
+}
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], Task.prototype, "id", void 0);
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    tslib_1.__metadata("design:type", String)
+], Task.prototype, "title", void 0);
+exports.Task = Task;
+class Event {
+    id;
+    tasks;
+}
+tslib_1.__decorate([
+    (0, schema_1.Property)(),
+    (0, schema_1.Required)(),
+    tslib_1.__metadata("design:type", String)
+], Event.prototype, "id", void 0);
+tslib_1.__decorate([
+    (0, schema_1.CollectionOf)(Task),
+    tslib_1.__metadata("design:type", Array)
+], Event.prototype, "tasks", void 0);
+exports.Event = Event;
+const fileFilterStub = jest.fn();
+const fileFilter = (req, file, callback) => {
+    fileFilterStub();
+    callback(null, true);
+};
+function getFileConfig() {
+    return {
+        storage: multer_1.default.diskStorage({
+            destination: (req, _fileItem, cb) => {
+                const path = `${__dirname}/../.tmp`;
+                cb(null, path);
+            }
+        }),
+        fileFilter
+    };
+}
+let TestMulterController = class TestMulterController {
+    uploadWithName(media) {
+        return media.originalname;
+    }
+    uploadWithPayload(media, formId) {
+        return {
+            file: media.originalname,
+            formId
+        };
+    }
+    uploadWithOptions(media) {
+        return {
+            file: media.originalname
+        };
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-1"),
+    (0, schema_1.Status)(201),
+    (0, common_1.MulterOptions)({ dest: `${__dirname}/../.tmp` }),
+    tslib_1.__param(0, (0, schema_1.Required)()),
+    tslib_1.__param(0, (0, common_1.MultipartFile)("media")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestMulterController.prototype, "uploadWithName", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-2"),
+    (0, schema_1.Status)(201),
+    (0, common_1.MulterOptions)({ dest: `${__dirname}/../.tmp` }),
+    tslib_1.__param(0, (0, common_1.MultipartFile)("media")),
+    tslib_1.__param(1, (0, common_1.BodyParams)("form_id")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object, String]),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestMulterController.prototype, "uploadWithPayload", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-3"),
+    (0, schema_1.Status)(201),
+    (0, common_1.MulterOptions)(getFileConfig()),
+    tslib_1.__param(0, (0, common_1.MultipartFile)("media")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", void 0)
+], TestMulterController.prototype, "uploadWithOptions", null);
+TestMulterController = tslib_1.__decorate([
+    (0, common_1.Controller)("/multer")
+], TestMulterController);
+exports.TestMulterController = TestMulterController;
+function testMulter(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        mount: {
+            "/rest": [TestMulterController]
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    beforeAll(() => jest.resetAllMocks());
+    describe("Scenario 1: POST /rest/multer/scenario-1", () => {
+        it("should upload file with multer", async () => {
+            const result = await request.post("/rest/multer/scenario-1").attach("media", `${__dirname}/../data/file.txt`).expect(201);
+            expect(result.text).toEqual("file.txt");
+        });
+        it("should throw an exception when there is no file", async () => {
+            const result = await request.post("/rest/multer/scenario-1").expect(400);
+            expect(result.body).toEqual({
+                name: "REQUIRED_VALIDATION_ERROR",
+                message: "Bad request on parameter \"request.files.media.0\".\nIt should have required parameter 'media.0'",
+                status: 400,
+                errors: [
+                    {
+                        dataPath: "",
+                        keyword: "required",
+                        message: "It should have required parameter 'media.0'",
+                        modelName: "files",
+                        params: { missingProperty: "media.0" },
+                        schemaPath: "#/required"
+                    }
+                ]
+            });
+        });
+    });
+    describe("Scenario 2: POST /rest/multer/scenario-2", () => {
+        it("should upload file with multer", async () => {
+            const result = await request
+                .post("/rest/multer/scenario-2")
+                .attach("media", `${__dirname}/../data/file.txt`)
+                .field({
+                form_id: "form_id"
+            })
+                .expect(201);
+            expect(result.body).toEqual({ file: "file.txt", formId: "form_id" });
+        });
+    });
+    describe("Scenario 3: POST /rest/multer/scenario-3", () => {
+        it("should upload file with multer", async () => {
+            const result = await request.post("/rest/multer/scenario-3").attach("media", `${__dirname}/../data/file.txt`).field({}).expect(201);
+            expect(result.body).toEqual({
+                file: "file.txt"
+            });
+            // filterFilter is called
+            expect(fileFilterStub).toBeCalled();
+        });
+    });
+}
+exports.testMulter = testMulter;
+//# sourceMappingURL=testMulter.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"testMulter.js","sourceRoot":"","sources":["../../../src/tests/testMulter.ts"],"names":[],"mappings":";;;;AAAA,yCAA0H;AAC1H,yCAAsE;AAEtE,4DAAkD;AAClD,kEAAkC;AAGlC,MAAa,IAAI;IAEf,EAAE,CAAS;IAGX,KAAK,CAAS;CACf;AAJC;IADC,IAAA,iBAAQ,GAAE;;gCACA;AAGX;IADC,IAAA,iBAAQ,GAAE;;mCACG;AALhB,oBAMC;AAED,MAAa,KAAK;IAGhB,EAAE,CAAS;IAGX,KAAK,CAAS;CACf;AAJC;IAFC,IAAA,iBAAQ,GAAE;IACV,IAAA,iBAAQ,GAAE;;iCACA;AAGX;IADC,IAAA,qBAAY,EAAC,IAAI,CAAC;;oCACL;AANhB,sBAOC;AAED,MAAM,cAAc,GAAG,IAAI,CAAC,EAAE,EAAE,CAAC;AACjC,MAAM,UAAU,GAAG,CAAC,GAAY,EAAE,IAAwB,EAAE,QAA4B,EAAE,EAAE;IAC1F,cAAc,EAAE,CAAC;IACjB,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AACvB,CAAC,CAAC;AAEF,SAAS,aAAa;IACpB,OAAO;QACL,OAAO,EAAE,gBAAM,CAAC,WAAW,CAAC;YAC1B,WAAW,EAAE,CAAC,GAAoB,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE;gBACnD,MAAM,IAAI,GAAG,GAAG,SAAS,UAAU,CAAC;gBACpC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACjB,CAAC;SACF,CAAC;QACF,UAAU;KACX,CAAC;AACJ,CAAC;AAGD,IAAa,oBAAoB,GAAjC,MAAa,oBAAoB;IAI/B,cAAc,CAAqC,KAAyB;QAC1E,OAAO,KAAK,CAAC,YAAY,CAAC;IAC5B,CAAC;IAKD,iBAAiB,CAAyB,KAAyB,EAAyB,MAAc;QACxG,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,YAAY;YACxB,MAAM;SACP,CAAC;IACJ,CAAC;IAKD,iBAAiB,CAAyB,KAAyB;QACjE,OAAO;YACL,IAAI,EAAE,KAAK,CAAC,YAAY;SACzB,CAAC;IACJ,CAAC;CACF,CAAA;AAtBC;IAHC,IAAA,aAAI,EAAC,aAAa,CAAC;IACnB,IAAA,eAAM,EAAC,GAAG,CAAC;IACX,IAAA,sBAAa,EAAC,EAAC,IAAI,EAAE,GAAG,SAAS,UAAU,EAAC,CAAC;IAC9B,mBAAA,IAAA,iBAAQ,GAAE,CAAA;IAAE,mBAAA,IAAA,sBAAa,EAAC,OAAO,CAAC,CAAA;;;;0DAEjD;AAKD;IAHC,IAAA,aAAI,EAAC,aAAa,CAAC;IACnB,IAAA,eAAM,EAAC,GAAG,CAAC;IACX,IAAA,sBAAa,EAAC,EAAC,IAAI,EAAE,GAAG,SAAS,UAAU,EAAC,CAAC;IAC3B,mBAAA,IAAA,sBAAa,EAAC,OAAO,CAAC,CAAA;IAA6B,mBAAA,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAA;;;;6DAK1F;AAKD;IAHC,IAAA,aAAI,EAAC,aAAa,CAAC;IACnB,IAAA,eAAM,EAAC,GAAG,CAAC;IACX,IAAA,sBAAa,EAAC,aAAa,EAAE,CAAC;IACZ,mBAAA,IAAA,sBAAa,EAAC,OAAO,CAAC,CAAA;;;;6DAIxC;AAzBU,oBAAoB;IADhC,IAAA,mBAAU,EAAC,SAAS,CAAC;GACT,oBAAoB,CA0BhC;AA1BY,oDAAoB;AA4BjC,SAAgB,UAAU,CAAC,OAA+B;IACxD,IAAI,OAA4C,CAAC;IAEjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;QACrC,GAAG,OAAO;QACV,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,oBAAoB,CAAC;SAChC;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,SAAS,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;IACtC,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACxD,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,SAAS,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAE1H,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;YAC/D,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEzE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC1B,IAAI,EAAE,2BAA2B;gBACjC,OAAO,EAAE,kGAAkG;gBAC3G,MAAM,EAAE,GAAG;gBACX,MAAM,EAAE;oBACN;wBACE,QAAQ,EAAE,EAAE;wBACZ,OAAO,EAAE,UAAU;wBACnB,OAAO,EAAE,6CAA6C;wBACtD,SAAS,EAAE,OAAO;wBAClB,MAAM,EAAE,EAAC,eAAe,EAAE,SAAS,EAAC;wBACpC,UAAU,EAAE,YAAY;qBACzB;iBACF;aACF,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACxD,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,MAAM,GAAG,MAAM,OAAO;iBACzB,IAAI,CAAC,yBAAyB,CAAC;iBAC/B,MAAM,CAAC,OAAO,EAAE,GAAG,SAAS,mBAAmB,CAAC;iBAChD,KAAK,CAAC;gBACL,OAAO,EAAE,SAAS;aACnB,CAAC;iBACD,MAAM,CAAC,GAAG,CAAC,CAAC;YAEf,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAC,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAC,CAAC,CAAC;QACrE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC,0CAA0C,EAAE,GAAG,EAAE;QACxD,EAAE,CAAC,gCAAgC,EAAE,KAAK,IAAI,EAAE;YAC9C,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,SAAS,mBAAmB,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;YAEpI,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;gBAC1B,IAAI,EAAE,UAAU;aACjB,CAAC,CAAC;YAEH,yBAAyB;YACzB,MAAM,CAAC,cAAc,CAAC,CAAC,UAAU,EAAE,CAAC;QACtC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AApED,gCAoEC","sourcesContent":["import {BodyParams, Controller, MulterOptions, MultipartFile, PlatformMulterFile, PlatformTest, Post} from \"@tsed/common\";\nimport {CollectionOf, Property, Required, Status} from \"@tsed/schema\";\nimport {Request} from \"express\";\nimport multer, {FileFilterCallback} from \"multer\";\nimport SuperTest from \"supertest\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\n\nexport class Task {\n  @Property()\n  id: string;\n\n  @Property()\n  title: string;\n}\n\nexport class Event {\n  @Property()\n  @Required()\n  id: string;\n\n  @CollectionOf(Task)\n  tasks: Task[];\n}\n\nconst fileFilterStub = jest.fn();\nconst fileFilter = (req: Request, file: PlatformMulterFile, callback: FileFilterCallback) => {\n  fileFilterStub();\n  callback(null, true);\n};\n\nfunction getFileConfig(): any {\n  return {\n    storage: multer.diskStorage({\n      destination: (req: Express.Request, _fileItem, cb) => {\n        const path = `${__dirname}/../.tmp`;\n        cb(null, path);\n      }\n    }),\n    fileFilter\n  };\n}\n\n@Controller(\"/multer\")\nexport class TestMulterController {\n  @Post(\"/scenario-1\")\n  @Status(201)\n  @MulterOptions({dest: `${__dirname}/../.tmp`})\n  uploadWithName(@Required() @MultipartFile(\"media\") media: PlatformMulterFile) {\n    return media.originalname;\n  }\n\n  @Post(\"/scenario-2\")\n  @Status(201)\n  @MulterOptions({dest: `${__dirname}/../.tmp`})\n  uploadWithPayload(@MultipartFile(\"media\") media: PlatformMulterFile, @BodyParams(\"form_id\") formId: string) {\n    return {\n      file: media.originalname,\n      formId\n    };\n  }\n\n  @Post(\"/scenario-3\")\n  @Status(201)\n  @MulterOptions(getFileConfig())\n  uploadWithOptions(@MultipartFile(\"media\") media: PlatformMulterFile) {\n    return {\n      file: media.originalname\n    };\n  }\n}\n\nexport function testMulter(options: PlatformTestingSdkOpts) {\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n\n  beforeAll(\n    PlatformTest.bootstrap(options.server, {\n      ...options,\n      mount: {\n        \"/rest\": [TestMulterController]\n      }\n    })\n  );\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n  beforeAll(() => jest.resetAllMocks());\n  describe(\"Scenario 1: POST /rest/multer/scenario-1\", () => {\n    it(\"should upload file with multer\", async () => {\n      const result = await request.post(\"/rest/multer/scenario-1\").attach(\"media\", `${__dirname}/../data/file.txt`).expect(201);\n\n      expect(result.text).toEqual(\"file.txt\");\n    });\n\n    it(\"should throw an exception when there is no file\", async () => {\n      const result = await request.post(\"/rest/multer/scenario-1\").expect(400);\n\n      expect(result.body).toEqual({\n        name: \"REQUIRED_VALIDATION_ERROR\",\n        message: \"Bad request on parameter \\\"request.files.media.0\\\".\\nIt should have required parameter 'media.0'\",\n        status: 400,\n        errors: [\n          {\n            dataPath: \"\",\n            keyword: \"required\",\n            message: \"It should have required parameter 'media.0'\",\n            modelName: \"files\",\n            params: {missingProperty: \"media.0\"},\n            schemaPath: \"#/required\"\n          }\n        ]\n      });\n    });\n  });\n  describe(\"Scenario 2: POST /rest/multer/scenario-2\", () => {\n    it(\"should upload file with multer\", async () => {\n      const result = await request\n        .post(\"/rest/multer/scenario-2\")\n        .attach(\"media\", `${__dirname}/../data/file.txt`)\n        .field({\n          form_id: \"form_id\"\n        })\n        .expect(201);\n\n      expect(result.body).toEqual({file: \"file.txt\", formId: \"form_id\"});\n    });\n  });\n  describe(\"Scenario 3: POST /rest/multer/scenario-3\", () => {\n    it(\"should upload file with multer\", async () => {\n      const result = await request.post(\"/rest/multer/scenario-3\").attach(\"media\", `${__dirname}/../data/file.txt`).field({}).expect(201);\n\n      expect(result.body).toEqual({\n        file: \"file.txt\"\n      });\n\n      // filterFilter is called\n      expect(fileFilterStub).toBeCalled();\n    });\n  });\n}\n"]}

package/lib/cjs/tests/testPathParams.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testPathParams = 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 TestPathParamsCtrl = class TestPathParamsCtrl {
+    async testScenario1(scope) {
+        // Here scope will be {0: 'a', 1: 'b', 2: 'c'} instead of 'abc' in version 5.47.0
+        expect(scope).toEqual("abc");
+        return scope;
+    }
+    async testScenario2(scope) {
+        // This way it works in version 5.47.0
+        expect(scope).toEqual("abc");
+        return scope;
+    }
+    async testScenario3(scope) {
+        expect(scope).toEqual("abc");
+        // Here the function will return  {0: 'a', 1: 'b', 2: 'c'} instead of ['a','b','c']  in version 5.44.13
+        return ["a", "b", "c"];
+    }
+    async testScenario4(scope, ctx) {
+        expect(scope).toEqual("abc");
+        // This way it works  in version 5.44.13
+        ctx.response.body(["a", "b", "c"]);
+    }
+    async testScenario5(scopeId, ctx) {
+        return "test";
+    }
+    async testScenario6(id) {
+        return { id };
+    }
+};
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-1/:scope/:scopeId"),
+    tslib_1.__param(0, (0, common_1.PathParams)("scope")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestPathParamsCtrl.prototype, "testScenario1", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-2/:scope/:scopeId"),
+    tslib_1.__param(0, (0, common_1.PathParams)("scope")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestPathParamsCtrl.prototype, "testScenario2", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-3/:scope/:scopeId"),
+    tslib_1.__param(0, (0, common_1.PathParams)("scope")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestPathParamsCtrl.prototype, "testScenario3", null);
+tslib_1.__decorate([
+    (0, common_1.Post)("/scenario-4/:scope/:scopeId"),
+    tslib_1.__param(0, (0, common_1.PathParams)("scope")),
+    tslib_1.__param(1, (0, common_1.Context)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestPathParamsCtrl.prototype, "testScenario4", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-5/:scopeId"),
+    tslib_1.__param(0, (0, common_1.PathParams)("scopeId")),
+    tslib_1.__param(0, (0, schema_1.Pattern)(/^[0-9a-fA-F]{24}$/)),
+    tslib_1.__param(1, (0, common_1.Context)()),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [String, Object]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestPathParamsCtrl.prototype, "testScenario5", null);
+tslib_1.__decorate([
+    (0, common_1.Get)("/scenario-6/:id"),
+    tslib_1.__param(0, (0, common_1.PathParams)("id")),
+    tslib_1.__metadata("design:type", Function),
+    tslib_1.__metadata("design:paramtypes", [Number]),
+    tslib_1.__metadata("design:returntype", Promise)
+], TestPathParamsCtrl.prototype, "testScenario6", null);
+TestPathParamsCtrl = tslib_1.__decorate([
+    (0, common_1.Controller)("/path-params")
+], TestPathParamsCtrl);
+function testPathParams(options) {
+    let request;
+    beforeAll(common_1.PlatformTest.bootstrap(options.server, {
+        ...options,
+        mount: {
+            "/rest": [TestPathParamsCtrl]
+        }
+    }));
+    beforeAll(() => {
+        request = (0, supertest_1.default)(common_1.PlatformTest.callback());
+    });
+    afterAll(common_1.PlatformTest.reset);
+    it("Scenario 1: GET /rest/path-params/scenario-1/scope/scopeId", async () => {
+        const response = await request.get("/rest/path-params/scenario-1/abc/1").expect(200);
+        expect(response.text).toEqual("abc");
+    });
+    it("Scenario 2: GET /rest/path-params/scenario-2/scopeId", async () => {
+        const response = await request.get("/rest/path-params/scenario-2/abc/1").expect(200);
+        expect(response.text).toEqual("abc");
+    });
+    it("Scenario 3: POST /rest/path-params/scenario-3/scope/scopeId", async () => {
+        const response = await request.post("/rest/path-params/scenario-3/abc/1").expect(200);
+        expect(response.body).toEqual(["a", "b", "c"]);
+    });
+    it("Scenario 4: POST /rest/path-params/scenario-4/scope/scopeId", async () => {
+        const response = await request.post("/rest/path-params/scenario-4/abc/1").expect(200);
+        expect(response.body).toEqual(["a", "b", "c"]);
+    });
+    it("Scenario 5 a: GET /rest/path-params/scenario-5/scopeId", async () => {
+        const response = await request.get("/rest/path-params/scenario-5/1").expect(400);
+        expect(response.body).toEqual({
+            errors: [
+                {
+                    data: "1",
+                    dataPath: "",
+                    instancePath: "",
+                    keyword: "pattern",
+                    message: 'must match pattern "^[0-9a-fA-F]{24}$"',
+                    params: {
+                        pattern: "^[0-9a-fA-F]{24}$"
+                    },
+                    schemaPath: "#/pattern"
+                }
+            ],
+            message: 'Bad request on parameter "request.path.scopeId".\nValue must match pattern "^[0-9a-fA-F]{24}$". Given value: "1"',
+            name: "AJV_VALIDATION_ERROR",
+            status: 400
+        });
+    });
+    it("Scenario 5b: GET /rest/path-params/scenario-5/scopeId", async () => {
+        await request.get("/rest/path-params/scenario-5/5ce4ee471495836c5e2e4cb0").expect(200);
+    });
+    it("Scenario 6: GET /rest/path-params/scenario-6/id", async () => {
+        const response = await request.get("/rest/path-params/scenario-6/1").expect(200);
+        expect(response.body).toEqual({ id: 1 });
+    });
+}
+exports.testPathParams = testPathParams;
+//# sourceMappingURL=testPathParams.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"testPathParams.js","sourceRoot":"","sources":["../../../src/tests/testPathParams.ts"],"names":[],"mappings":";;;;AAAA,yCAAsF;AACtF,yCAAqC;AACrC,kEAAkC;AAIlC,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAEtB,KAAK,CAAC,aAAa,CAAsB,KAAa;QACpD,iFAAiF;QACjF,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAGD,KAAK,CAAC,aAAa,CAAsB,KAAU;QACjD,sCAAsC;QACtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE7B,OAAO,KAAK,CAAC;IACf,CAAC;IAGD,KAAK,CAAC,aAAa,CAAsB,KAAa;QACpD,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE7B,uGAAuG;QACvG,OAAO,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACzB,CAAC;IAGD,KAAK,CAAC,aAAa,CAAsB,KAAa,EAAa,GAAY;QAC7E,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QAE7B,wCAAwC;QACxC,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACrC,CAAC;IAGD,KAAK,CAAC,aAAa,CAAsD,OAAe,EAAa,GAAY;QAC/G,OAAO,MAAM,CAAC;IAChB,CAAC;IAGD,KAAK,CAAC,aAAa,CAAmB,EAAU;QAC9C,OAAO,EAAC,EAAE,EAAC,CAAC;IACd,CAAC;CACF,CAAA;AAxCC;IADC,IAAA,YAAG,EAAC,6BAA6B,CAAC;IACd,mBAAA,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAA;;;;uDAKvC;AAGD;IADC,IAAA,YAAG,EAAC,6BAA6B,CAAC;IACd,mBAAA,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAA;;;;uDAKvC;AAGD;IADC,IAAA,aAAI,EAAC,6BAA6B,CAAC;IACf,mBAAA,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAA;;;;uDAKvC;AAGD;IADC,IAAA,aAAI,EAAC,6BAA6B,CAAC;IACf,mBAAA,IAAA,mBAAU,EAAC,OAAO,CAAC,CAAA;IAAiB,mBAAA,IAAA,gBAAO,GAAE,CAAA;;;;uDAKjE;AAGD;IADC,IAAA,YAAG,EAAC,sBAAsB,CAAC;IACP,mBAAA,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAA;IAAE,mBAAA,IAAA,gBAAO,EAAC,mBAAmB,CAAC,CAAA;IAAmB,mBAAA,IAAA,gBAAO,GAAE,CAAA;;;;uDAEnG;AAGD;IADC,IAAA,YAAG,EAAC,iBAAiB,CAAC;IACF,mBAAA,IAAA,mBAAU,EAAC,IAAI,CAAC,CAAA;;;;uDAEpC;AAzCG,kBAAkB;IADvB,IAAA,mBAAU,EAAC,cAAc,CAAC;GACrB,kBAAkB,CA0CvB;AAED,SAAgB,cAAc,CAAC,OAA+B;IAC5D,IAAI,OAA4C,CAAC;IAEjD,SAAS,CACP,qBAAY,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,EAAE;QACrC,GAAG,OAAO;QACV,KAAK,EAAE;YACL,OAAO,EAAE,CAAC,kBAAkB,CAAC;SAC9B;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,4DAA4D,EAAE,KAAK,IAAI,EAAE;QAC1E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAErF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sDAAsD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAErF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEtF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6DAA6D,EAAE,KAAK,IAAI,EAAE;QAC3E,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEtF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACtE,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEjF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC;YAC5B,MAAM,EAAE;gBACN;oBACE,IAAI,EAAE,GAAG;oBACT,QAAQ,EAAE,EAAE;oBACZ,YAAY,EAAE,EAAE;oBAChB,OAAO,EAAE,SAAS;oBAClB,OAAO,EAAE,wCAAwC;oBACjD,MAAM,EAAE;wBACN,OAAO,EAAE,mBAAmB;qBAC7B;oBACD,UAAU,EAAE,WAAW;iBACxB;aACF;YACD,OAAO,EAAE,kHAAkH;YAC3H,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,GAAG;SACZ,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,EAAE,CAAC,uDAAuD,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,OAAO,CAAC,GAAG,CAAC,uDAAuD,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEjF,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,EAAC,EAAE,EAAE,CAAC,EAAC,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAvED,wCAuEC","sourcesContent":["import {Context, Controller, Get, PathParams, PlatformTest, Post} from \"@tsed/common\";\nimport {Pattern} from \"@tsed/schema\";\nimport SuperTest from \"supertest\";\nimport {PlatformTestingSdkOpts} from \"../interfaces\";\n\n@Controller(\"/path-params\")\nclass TestPathParamsCtrl {\n  @Get(\"/scenario-1/:scope/:scopeId\")\n  async testScenario1(@PathParams(\"scope\") scope: string) {\n    // Here scope will be {0: 'a', 1: 'b', 2: 'c'} instead of 'abc' in version 5.47.0\n    expect(scope).toEqual(\"abc\");\n\n    return scope;\n  }\n\n  @Get(\"/scenario-2/:scope/:scopeId\")\n  async testScenario2(@PathParams(\"scope\") scope: any) {\n    // This way it works in version 5.47.0\n    expect(scope).toEqual(\"abc\");\n\n    return scope;\n  }\n\n  @Post(\"/scenario-3/:scope/:scopeId\")\n  async testScenario3(@PathParams(\"scope\") scope: string): Promise<any[]> {\n    expect(scope).toEqual(\"abc\");\n\n    // Here the function will return  {0: 'a', 1: 'b', 2: 'c'} instead of ['a','b','c']  in version 5.44.13\n    return [\"a\", \"b\", \"c\"];\n  }\n\n  @Post(\"/scenario-4/:scope/:scopeId\")\n  async testScenario4(@PathParams(\"scope\") scope: string, @Context() ctx: Context) {\n    expect(scope).toEqual(\"abc\");\n\n    // This way it works  in version 5.44.13\n    ctx.response.body([\"a\", \"b\", \"c\"]);\n  }\n\n  @Get(\"/scenario-5/:scopeId\")\n  async testScenario5(@PathParams(\"scopeId\") @Pattern(/^[0-9a-fA-F]{24}$/) scopeId: string, @Context() ctx: Context) {\n    return \"test\";\n  }\n\n  @Get(\"/scenario-6/:id\")\n  async testScenario6(@PathParams(\"id\") id: number) {\n    return {id};\n  }\n}\n\nexport function testPathParams(options: PlatformTestingSdkOpts) {\n  let request: SuperTest.SuperTest<SuperTest.Test>;\n\n  beforeAll(\n    PlatformTest.bootstrap(options.server, {\n      ...options,\n      mount: {\n        \"/rest\": [TestPathParamsCtrl]\n      }\n    })\n  );\n  beforeAll(() => {\n    request = SuperTest(PlatformTest.callback());\n  });\n  afterAll(PlatformTest.reset);\n\n  it(\"Scenario 1: GET /rest/path-params/scenario-1/scope/scopeId\", async () => {\n    const response = await request.get(\"/rest/path-params/scenario-1/abc/1\").expect(200);\n\n    expect(response.text).toEqual(\"abc\");\n  });\n\n  it(\"Scenario 2: GET /rest/path-params/scenario-2/scopeId\", async () => {\n    const response = await request.get(\"/rest/path-params/scenario-2/abc/1\").expect(200);\n\n    expect(response.text).toEqual(\"abc\");\n  });\n\n  it(\"Scenario 3: POST /rest/path-params/scenario-3/scope/scopeId\", async () => {\n    const response = await request.post(\"/rest/path-params/scenario-3/abc/1\").expect(200);\n\n    expect(response.body).toEqual([\"a\", \"b\", \"c\"]);\n  });\n\n  it(\"Scenario 4: POST /rest/path-params/scenario-4/scope/scopeId\", async () => {\n    const response = await request.post(\"/rest/path-params/scenario-4/abc/1\").expect(200);\n\n    expect(response.body).toEqual([\"a\", \"b\", \"c\"]);\n  });\n\n  it(\"Scenario 5 a: GET /rest/path-params/scenario-5/scopeId\", async () => {\n    const response = await request.get(\"/rest/path-params/scenario-5/1\").expect(400);\n\n    expect(response.body).toEqual({\n      errors: [\n        {\n          data: \"1\",\n          dataPath: \"\",\n          instancePath: \"\",\n          keyword: \"pattern\",\n          message: 'must match pattern \"^[0-9a-fA-F]{24}$\"',\n          params: {\n            pattern: \"^[0-9a-fA-F]{24}$\"\n          },\n          schemaPath: \"#/pattern\"\n        }\n      ],\n      message: 'Bad request on parameter \"request.path.scopeId\".\\nValue must match pattern \"^[0-9a-fA-F]{24}$\". Given value: \"1\"',\n      name: \"AJV_VALIDATION_ERROR\",\n      status: 400\n    });\n  });\n  it(\"Scenario 5b: GET /rest/path-params/scenario-5/scopeId\", async () => {\n    await request.get(\"/rest/path-params/scenario-5/5ce4ee471495836c5e2e4cb0\").expect(200);\n  });\n\n  it(\"Scenario 6: GET /rest/path-params/scenario-6/id\", async () => {\n    const response = await request.get(\"/rest/path-params/scenario-6/1\").expect(200);\n\n    expect(response.body).toEqual({id: 1});\n  });\n}\n"]}