@tsed/platform-params 8.9.1 → 8.9.2

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/platform-params",
   "description": "Params module for Ts.ED Framework",
   "type": "module",
-  "version": "8.9.1",
+  "version": "8.9.2",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -26,23 +26,23 @@
     "tslib": "2.7.0"
   },
   "devDependencies": {
-    "@tsed/barrels": "8.9.1",
-    "@tsed/core": "8.9.1",
-    "@tsed/di": "8.9.1",
-    "@tsed/exceptions": "8.9.1",
-    "@tsed/json-mapper": "8.9.1",
-    "@tsed/schema": "8.9.1",
-    "@tsed/typescript": "8.9.1",
+    "@tsed/barrels": "8.9.2",
+    "@tsed/core": "8.9.2",
+    "@tsed/di": "8.9.2",
+    "@tsed/exceptions": "8.9.2",
+    "@tsed/json-mapper": "8.9.2",
+    "@tsed/schema": "8.9.2",
+    "@tsed/typescript": "8.9.2",
     "eslint": "9.12.0",
     "typescript": "5.4.5",
     "vitest": "3.1.1"
   },
   "peerDependencies": {
-    "@tsed/core": ">=8.9.1",
-    "@tsed/di": ">=8.9.1",
-    "@tsed/exceptions": ">=8.9.1",
-    "@tsed/json-mapper": ">=8.9.1",
-    "@tsed/schema": ">=8.9.1"
+    "@tsed/core": ">=8.9.2",
+    "@tsed/di": ">=8.9.2",
+    "@tsed/exceptions": ">=8.9.2",
+    "@tsed/json-mapper": ">=8.9.2",
+    "@tsed/schema": ">=8.9.2"
   },
   "peerDependenciesMeta": {
     "@tsed/core": {

package/src/decorators/__snapshots__/bodyParams.spec.ts.snap

@@ -0,0 +1,105 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`@BodyParams > should generate the correct spec for BodyParams from given arg 1`] = `
+{
+  "components": {
+    "schemas": {
+      "TestModel": {
+        "properties": {
+          "name": {
+            "minLength": 1,
+            "type": "string",
+          },
+        },
+        "required": [
+          "name",
+        ],
+        "type": "object",
+      },
+    },
+  },
+  "paths": {
+    "/": {
+      "post": {
+        "operationId": "myCtrlTest",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestModel",
+              },
+            },
+          },
+          "required": false,
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+          },
+        },
+        "tags": [
+          "MyCtrl",
+        ],
+      },
+    },
+  },
+  "tags": [
+    {
+      "name": "MyCtrl",
+    },
+  ],
+}
+`;
+
+exports[`@BodyParams > should generate the correct spec for BodyParams from metadata 1`] = `
+{
+  "components": {
+    "schemas": {
+      "TestModel": {
+        "properties": {
+          "name": {
+            "minLength": 1,
+            "type": "string",
+          },
+        },
+        "required": [
+          "name",
+        ],
+        "type": "object",
+      },
+    },
+  },
+  "paths": {
+    "/": {
+      "post": {
+        "operationId": "myCtrlTest",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/TestModel",
+              },
+            },
+          },
+          "required": false,
+        },
+        "responses": {
+          "200": {
+            "description": "Success",
+          },
+        },
+        "tags": [
+          "MyCtrl",
+        ],
+      },
+    },
+  },
+  "tags": [
+    {
+      "name": "MyCtrl",
+    },
+  ],
+}
+`;

package/src/decorators/bodyParams.spec.ts

@@ -1,5 +1,5 @@
 import {Controller} from "@tsed/di";
-import {getSpec, JsonParameterStore, Post, SpecTypes} from "@tsed/schema";
+import {Description, getJsonSchema, getSpec, JsonParameterStore, MaxLength, MinItems, Post, Required, SpecTypes} from "@tsed/schema";
 
 import {ParamTypes} from "../domain/ParamTypes.js";
 import {BodyParams, RawBodyParams} from "./bodyParams.js";
@@ -58,6 +58,317 @@ describe("@BodyParams", () => {
       ]
     });
   });
+  it("should generate the correct spec for BodyParams from metadata (string)", () => {
+    class TestModel {
+      @Required()
+      name: string;
+    }
+
+    @Controller("/")
+    class MyCtrl {
+      @Post()
+      test(@BodyParams() @Required() @MaxLength(10) @Description("Description") body: string) {}
+    }
+
+    const spec = getSpec(MyCtrl, {specType: SpecTypes.OPENAPI});
+
+    expect(spec).toEqual({
+      paths: {
+        "/": {
+          post: {
+            operationId: "myCtrlTest",
+            parameters: [],
+            requestBody: {
+              description: "Description",
+              content: {
+                "application/json": {
+                  schema: {
+                    minLength: 1,
+                    maxLength: 10,
+                    type: "string"
+                  }
+                }
+              },
+              required: true
+            },
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["MyCtrl"]
+          }
+        }
+      },
+      tags: [
+        {
+          name: "MyCtrl"
+        }
+      ]
+    });
+  });
+  it("should generate the correct spec for BodyParams from metadata (string[])", () => {
+    class TestModel {
+      @Required()
+      name: string;
+    }
+
+    @Controller("/")
+    class MyCtrl {
+      @Post()
+      test(@BodyParams(String) @Required() @MaxLength(10) @MinItems(3) @Description("Description") body: string[]) {}
+    }
+
+    const spec = getSpec(MyCtrl, {specType: SpecTypes.OPENAPI});
+
+    expect(spec).toEqual({
+      paths: {
+        "/": {
+          post: {
+            operationId: "myCtrlTest",
+            parameters: [],
+            requestBody: {
+              description: "Description",
+              content: {
+                "application/json": {
+                  schema: {
+                    items: {
+                      maxLength: 10,
+                      type: "string"
+                    },
+                    minItems: 3,
+                    type: "array"
+                  }
+                }
+              },
+              required: true
+            },
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["MyCtrl"]
+          }
+        }
+      },
+      tags: [
+        {
+          name: "MyCtrl"
+        }
+      ]
+    });
+  });
+  it("should generate the correct spec for BodyParams from metadata (TestModel)", () => {
+    class TestModel {
+      @Required()
+      name: string;
+    }
+
+    @Controller("/")
+    class MyCtrl {
+      @Post()
+      test(@BodyParams() @Required() @Description("Description") body: TestModel) {}
+    }
+
+    const spec = getSpec(MyCtrl, {specType: SpecTypes.OPENAPI});
+
+    expect(spec).toEqual({
+      components: {
+        schemas: {
+          TestModel: {
+            properties: {
+              name: {
+                minLength: 1,
+                type: "string"
+              }
+            },
+            required: ["name"],
+            type: "object"
+          }
+        }
+      },
+      paths: {
+        "/": {
+          post: {
+            operationId: "myCtrlTest",
+            parameters: [],
+            requestBody: {
+              description: "Description",
+              content: {
+                "application/json": {
+                  schema: {$ref: "#/components/schemas/TestModel"}
+                }
+              },
+              required: true
+            },
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["MyCtrl"]
+          }
+        }
+      },
+      tags: [
+        {
+          name: "MyCtrl"
+        }
+      ]
+    });
+    const param = JsonParameterStore.get(MyCtrl, "test", 0);
+    const schema = getJsonSchema(param);
+
+    expect(schema).toEqual({
+      properties: {
+        name: {
+          minLength: 1,
+          type: "string"
+        }
+      },
+      required: ["name"],
+      type: "object"
+    });
+  });
+  it("should generate the correct spec for BodyParams from metadata (TestModel[])", () => {
+    class TestModel {
+      @Required()
+      name: string;
+    }
+
+    @Controller("/")
+    class MyCtrl {
+      @Post()
+      test(@BodyParams(TestModel) @MinItems(2) @Required() @Description("Description") body: TestModel[]) {}
+    }
+
+    const spec = getSpec(MyCtrl, {specType: SpecTypes.OPENAPI});
+
+    expect(spec).toEqual({
+      components: {
+        schemas: {
+          TestModel: {
+            properties: {
+              name: {
+                minLength: 1,
+                type: "string"
+              }
+            },
+            required: ["name"],
+            type: "object"
+          }
+        }
+      },
+      paths: {
+        "/": {
+          post: {
+            operationId: "myCtrlTest",
+            parameters: [],
+            requestBody: {
+              content: {
+                "application/json": {
+                  schema: {
+                    items: {
+                      $ref: "#/components/schemas/TestModel"
+                    },
+                    minItems: 2,
+                    type: "array"
+                  }
+                }
+              },
+              description: "Description",
+              required: true
+            },
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["MyCtrl"]
+          }
+        }
+      },
+      tags: [
+        {
+          name: "MyCtrl"
+        }
+      ]
+    });
+  });
+  it("should generate the correct spec for BodyParams from given type (TestModel)", () => {
+    class TestModel {
+      @Required()
+      name: string;
+    }
+
+    @Controller("/")
+    class MyCtrl {
+      @Post()
+      test(@BodyParams(TestModel) @Required() @Description("Description") body: any) {}
+    }
+
+    const spec = getSpec(MyCtrl, {specType: SpecTypes.OPENAPI});
+
+    expect(spec).toEqual({
+      components: {
+        schemas: {
+          TestModel: {
+            properties: {
+              name: {
+                minLength: 1,
+                type: "string"
+              }
+            },
+            required: ["name"],
+            type: "object"
+          }
+        }
+      },
+      paths: {
+        "/": {
+          post: {
+            operationId: "myCtrlTest",
+            parameters: [],
+            requestBody: {
+              description: "Description",
+              content: {
+                "application/json": {
+                  schema: {$ref: "#/components/schemas/TestModel"}
+                }
+              },
+              required: true
+            },
+            responses: {
+              "200": {
+                description: "Success"
+              }
+            },
+            tags: ["MyCtrl"]
+          }
+        }
+      },
+      tags: [
+        {
+          name: "MyCtrl"
+        }
+      ]
+    });
+
+    const param = JsonParameterStore.get(MyCtrl, "test", 0);
+    const schema = getJsonSchema(param);
+
+    expect(schema).toEqual({
+      properties: {
+        name: {
+          minLength: 1,
+          type: "string"
+        }
+      },
+      required: ["name"],
+      type: "object"
+    });
+  });
 });
 
 describe("RawBodyParams()", () => {