@tsed/platform-test-sdk 8.0.1 → 8.0.2

package/package.json

@@ -2,13 +2,14 @@
   "name": "@tsed/platform-test-sdk",
   "description": "Package to test platform adapter integration with Ts.ED",
   "type": "module",
-  "version": "8.0.1",
+  "version": "8.0.2",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
   "typings": "./lib/types/index.d.ts",
   "exports": {
     ".": {
+      "@tsed/source": "./src/index.ts",
       "types": "./lib/types/index.d.ts",
       "import": "./lib/esm/index.js",
       "default": "./lib/esm/index.js"
@@ -27,25 +28,25 @@
     "Adapter"
   ],
   "dependencies": {
-    "@tsed/ajv": "8.0.1",
-    "@tsed/core": "8.0.1",
-    "@tsed/di": "8.0.1",
-    "@tsed/json-mapper": "8.0.1",
+    "@tsed/ajv": "8.0.2",
+    "@tsed/core": "8.0.2",
+    "@tsed/di": "8.0.2",
+    "@tsed/json-mapper": "8.0.2",
     "@tsed/logger": "6.7.8",
-    "@tsed/platform-cache": "8.0.1",
-    "@tsed/platform-http": "8.0.1",
-    "@tsed/platform-params": "8.0.1",
-    "@tsed/platform-router": "8.0.1",
-    "@tsed/platform-views": "8.0.1",
-    "@tsed/schema": "8.0.1",
-    "@tsed/swagger": "8.0.1",
+    "@tsed/platform-cache": "8.0.2",
+    "@tsed/platform-http": "8.0.2",
+    "@tsed/platform-params": "8.0.2",
+    "@tsed/platform-router": "8.0.2",
+    "@tsed/platform-views": "8.0.2",
+    "@tsed/schema": "8.0.2",
+    "@tsed/swagger": "8.0.2",
     "ajv": "^8.17.1",
     "axios": "1.7.7",
     "read-pkg-up": "7.0.1"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.0.1",
-    "@tsed/typescript": "8.0.1",
+    "@tsed/barrels": "8.0.2",
+    "@tsed/typescript": "8.0.2",
     "eslint": "9.12.0",
     "typescript": "5.4.5"
   },

package/src/components/PlatformTestSdk.ts

@@ -0,0 +1,30 @@
+import {PlatformTest} from "@tsed/platform-http/testing";
+
+import {PlatformTestingSdkOpts} from "../interfaces/index.js";
+import {specsContainer} from "../tests/exports.js";
+
+export class PlatformTestSdk {
+  protected constructor(private options: PlatformTestingSdkOpts) {}
+
+  static create(options: PlatformTestingSdkOpts) {
+    return new PlatformTestSdk(options);
+  }
+
+  test(name: string, options: any = {}) {
+    specsContainer.get(name)!({
+      ...this.options,
+      ...options
+    });
+  }
+
+  bootstrap(options: any = {}) {
+    return PlatformTest.bootstrap(this.options.server, {
+      ...this.options,
+      ...options
+    });
+  }
+
+  reset() {
+    return PlatformTest.reset();
+  }
+}

package/src/data/file.txt

@@ -0,0 +1 @@
+test content

package/src/data/response.data.json

@@ -0,0 +1,3 @@
+{
+  "id": "1"
+}

package/src/data/swagger.json

@@ -0,0 +1,32 @@
+{
+  "openapi": "3.0.1",
+  "info": {
+    "version": "1.0.0",
+    "description": "Swagger description",
+    "title": "Swagger Title",
+    "termsOfService": "http://swagger.io/terms/",
+    "contact": {
+      "email": "apiteam@swagger.io"
+    },
+    "license": {
+      "name": "Apache 2.0",
+      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
+    }
+  },
+  "components": {
+    "securitySchemes": {
+      "global_auth": {
+        "type": "oauth2",
+        "flows": {
+          "implicit": {
+            "authorizationUrl": "http://petstore.swagger.io/oauth/dialog",
+            "scopes": {
+              "admin": "Admin access"
+            }
+          }
+        }
+      }
+    }
+  },
+  "paths": {}
+}

package/src/errors/CustomBadRequest.ts

@@ -0,0 +1,16 @@
+import {BadRequest} from "@tsed/exceptions";
+import {ResponseErrorObject} from "@tsed/platform-http";
+
+export class CustomBadRequest extends BadRequest implements ResponseErrorObject {
+  name = "CUSTOM_BAD_REQUEST";
+  errors: any[];
+  headers = {};
+
+  constructor(message: string) {
+    super(message);
+    this.errors = ["test"];
+    this.headers = {
+      "X-HEADER-ERROR": "deny"
+    };
+  }
+}

package/src/errors/CustomInternalError.ts

@@ -0,0 +1,16 @@
+import {InternalServerError} from "@tsed/exceptions";
+import {ResponseErrorObject} from "@tsed/platform-http";
+
+export class CustomInternalError extends InternalServerError implements ResponseErrorObject {
+  name = "CUSTOM_INTERNAL_SERVER_ERROR";
+  errors: any[];
+  headers = {};
+
+  constructor(message: string) {
+    super(message);
+    this.errors = ["test"];
+    this.headers = {
+      "X-HEADER-ERROR": "deny"
+    };
+  }
+}

package/src/index.ts

@@ -0,0 +1,40 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./components/PlatformTestSdk.js";
+export * from "./errors/CustomBadRequest.js";
+export * from "./errors/CustomInternalError.js";
+export * from "./interfaces/index.js";
+export * from "./interfaces/PlatformTestingSdkOpts.js";
+export * from "./modules/feature/controllers/FeatureController.js";
+export * from "./modules/feature/FeatureModule.js";
+export * from "./tests/exports.js";
+export * from "./tests/testAcceptMime.js";
+export * from "./tests/testAuth.js";
+export * from "./tests/testBodyParams.js";
+export * from "./tests/testCache.js";
+export * from "./tests/testChildrenControllers.js";
+export * from "./tests/testCookies.js";
+export * from "./tests/testCustom404.js";
+export * from "./tests/testDeepQueryParams.js";
+export * from "./tests/testErrors.js";
+export * from "./tests/testHandlers.js";
+export * from "./tests/testHeaderParams.js";
+export * from "./tests/testHeaders.js";
+export * from "./tests/testInheritanceController.js";
+export * from "./tests/testLocals.js";
+export * from "./tests/testLocation.js";
+export * from "./tests/testMiddlewares.js";
+export * from "./tests/testModule.js";
+export * from "./tests/testMulter.js";
+export * from "./tests/testPathParams.js";
+export * from "./tests/testQueryParams.js";
+export * from "./tests/testRedirect.js";
+export * from "./tests/testResponse.js";
+export * from "./tests/testResponseFilter.js";
+export * from "./tests/testRouting.js";
+export * from "./tests/testScopeRequest.js";
+export * from "./tests/testSession.js";
+export * from "./tests/testStatics.js";
+export * from "./tests/testStream.js";
+export * from "./tests/testView.js";

package/src/interfaces/PlatformTestingSdkOpts.ts

@@ -0,0 +1,10 @@
+import {Type} from "@tsed/core";
+import {PlatformAdapter} from "@tsed/platform-http";
+
+export interface PlatformTestingSdkOpts {
+  rootDir: string;
+  adapter: Type<PlatformAdapter<any>>;
+  server: Type<any>;
+
+  [key: string]: any;
+}

package/src/interfaces/index.ts

@@ -0,0 +1,4 @@
+/**
+ * @file Automatically generated by @tsed/barrels.
+ */
+export * from "./PlatformTestingSdkOpts.js";

package/src/modules/feature/FeatureModule.ts

@@ -0,0 +1,10 @@
+import {Module} from "@tsed/di";
+
+import {FeatureController} from "./controllers/FeatureController.js";
+
+@Module({
+  mount: {
+    "/rest": [FeatureController]
+  }
+})
+export class FeatureModule {}

package/src/modules/feature/controllers/FeatureController.ts

@@ -0,0 +1,11 @@
+import {Controller} from "@tsed/di";
+import {Get, Hidden} from "@tsed/schema";
+
+@Hidden()
+@Controller("/features")
+export class FeatureController {
+  @Get("/")
+  get() {
+    return "From feature";
+  }
+}

package/src/tests/exports.ts

@@ -0,0 +1,71 @@
+import {PlatformTestingSdkOpts} from "../interfaces/index.js";
+import {testAcceptMime} from "./testAcceptMime.js";
+import {testAuth} from "./testAuth.js";
+import {testBodyParams} from "./testBodyParams.js";
+import {testCache} from "./testCache.js";
+import {testChildrenControllers} from "./testChildrenControllers.js";
+import {testCookies} from "./testCookies.js";
+import {testCustom404} from "./testCustom404.js";
+import {testDeepQueryParams} from "./testDeepQueryParams.js";
+import {testErrors} from "./testErrors.js";
+import {testHandlers} from "./testHandlers.js";
+import {testHeaderParams} from "./testHeaderParams.js";
+import {testHeaders} from "./testHeaders.js";
+import {testInheritanceController} from "./testInheritanceController.js";
+import {testLocals} from "./testLocals.js";
+import {testLocation} from "./testLocation.js";
+import {testMiddlewares} from "./testMiddlewares.js";
+import {testModule} from "./testModule.js";
+import {testMulter} from "./testMulter.js";
+import {testPathParams} from "./testPathParams.js";
+import {testQueryParams} from "./testQueryParams.js";
+import {testRedirect} from "./testRedirect.js";
+import {testResponse} from "./testResponse.js";
+import {testResponseFilter} from "./testResponseFilter.js";
+import {testRouting} from "./testRouting.js";
+import {testScopeRequest} from "./testScopeRequest.js";
+import {testSession} from "./testSession.js";
+import {testStatics} from "./testStatics.js";
+import {testStream} from "./testStream.js";
+import {testView} from "./testView.js";
+
+export const specsContainer = new Map<string, (options: PlatformTestingSdkOpts) => void>();
+
+// HANDLERS AND MIDDLEWARES
+specsContainer.set("handlers", testHandlers);
+specsContainer.set("auth", testAuth);
+specsContainer.set("middlewares", testMiddlewares);
+
+// RESPONSES
+specsContainer.set("headers", testHeaders);
+specsContainer.set("acceptMime", testAcceptMime);
+specsContainer.set("location", testLocation);
+specsContainer.set("redirect", testRedirect);
+specsContainer.set("view", testView);
+specsContainer.set("errors", testErrors);
+specsContainer.set("response", testResponse);
+specsContainer.set("stream", testStream);
+specsContainer.set("responseFilter", testResponseFilter);
+specsContainer.set("custom404", testCustom404);
+specsContainer.set("statics", testStatics);
+specsContainer.set("cache", testCache);
+
+// INPUTS
+specsContainer.set("cookies", testCookies);
+specsContainer.set("session", testSession);
+specsContainer.set("headerParams", testHeaderParams);
+specsContainer.set("bodyParams", testBodyParams);
+specsContainer.set("pathParams", testPathParams);
+specsContainer.set("queryParams", testQueryParams);
+specsContainer.set("deepQueryParams", testDeepQueryParams);
+specsContainer.set("locals", testLocals);
+specsContainer.set("multer", testMulter);
+
+// ROUTING
+specsContainer.set("scopeRequest", testScopeRequest);
+specsContainer.set("routing", testRouting);
+
+// CODE ORGANIZATION
+specsContainer.set("childrenControllers", testChildrenControllers);
+specsContainer.set("inheritanceController", testInheritanceController);
+specsContainer.set("module", testModule);

package/src/tests/testAcceptMime.ts

@@ -0,0 +1,99 @@
+import {Controller} from "@tsed/di";
+import {PlatformTest} from "@tsed/platform-http/testing";
+import {HeaderParams} from "@tsed/platform-params";
+import {AcceptMime, ContentType, Get, Post} from "@tsed/schema";
+import SuperTest from "supertest";
+import {afterAll, beforeAll, describe, expect, it} from "vitest";
+
+import {PlatformTestingSdkOpts} from "../interfaces/index.js";
+
+@Controller("/accept-mime")
+class TestAcceptMimeCtrl {
+  @Post("/scenario-1")
+  @AcceptMime("application/json")
+  scenario1(@HeaderParams("Accept") accept: string) {
+    return {
+      accept
+    };
+  }
+
+  @Get("/scenario-2")
+  @ContentType("text")
+  @AcceptMime("text")
+  public ping() {
+    return "pong";
+  }
+}
+
+export function testAcceptMime(options: PlatformTestingSdkOpts) {
+  let request: SuperTest.Agent;
+
+  beforeAll(
+    PlatformTest.bootstrap(options.server, {
+      ...options,
+      mount: {
+        "/rest": [TestAcceptMimeCtrl]
+      }
+    })
+  );
+  beforeAll(() => {
+    request = SuperTest(PlatformTest.callback());
+  });
+  afterAll(PlatformTest.reset);
+  describe("Scenario 1: POST /rest/accept-mime/scenario-1", () => {
+    it('should return a 200 response when Accept header match with @AcceptMime("application/json")', async () => {
+      const response = await request
+        .post("/rest/accept-mime/scenario-1")
+        .set({
+          Accept: "application/json"
+        })
+        .expect(200);
+
+      expect(response.body).toEqual({
+        accept: "application/json"
+      });
+    });
+    it('should return a 406 response when Accept header doesn\'t match with @AcceptMime("application/json")', async () => {
+      const response = await request
+        .post("/rest/accept-mime/scenario-1")
+        .set({
+          Accept: "application/xml"
+        })
+        .expect(406);
+
+      expect(response.body).toEqual({
+        name: "NOT_ACCEPTABLE",
+        message: "You must accept content-type application/json",
+        status: 406,
+        errors: []
+      });
+    });
+  });
+  describe("Scenario 2: GET /rest/accept-mime/scenario-2", () => {
+    it('should return a 200 response when Accept header match with @AcceptMime("text")', async () => {
+      const response = await request
+        .get("/rest/accept-mime/scenario-2")
+        .set({
+          Accept: "text/*, application/json"
+        })
+        .expect(200);
+
+      expect(response.text).toEqual("pong");
+    });
+    it('should return a 406 response when Accept header doesn\'t match with @AcceptMime("text")', async () => {
+      const response = await request
+        .get("/rest/accept-mime/scenario-2")
+        .set({
+          Accept: "application/xml"
+        })
+        .expect(406);
+
+      expect(response.body).toEqual({
+        name: "NOT_ACCEPTABLE",
+        message: "You must accept content-type text",
+        status: 406,
+        errors: []
+      });
+    });
+  });
+}