@tsed/schema 8.0.0 → 8.0.2

package/src/decorators/common/__snapshots__/groups.spec.ts.snap

@@ -0,0 +1,321 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`@Groups > OpenSpec > should display fields when a group match with (array & groups - OS3) 1`] = `
+{
+  "components": {
+    "schemas": {
+      "ChildModel": {
+        "properties": {
+          "id": {
+            "type": "string",
+          },
+          "prop1": {
+            "minLength": 1,
+            "type": "string",
+          },
+        },
+        "required": [
+          "prop1",
+        ],
+        "type": "object",
+      },
+      "MyModelCreate": {
+        "properties": {
+          "prop3": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop4": {
+            "items": {
+              "$ref": "#/components/schemas/ChildModel",
+            },
+            "type": "array",
+          },
+        },
+        "required": [
+          "prop3",
+        ],
+        "type": "object",
+      },
+      "MyModelDetails": {
+        "properties": {
+          "id": {
+            "type": "string",
+          },
+          "prop1": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop2": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop3": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop4": {
+            "items": {
+              "$ref": "#/components/schemas/ChildModel",
+            },
+            "type": "array",
+          },
+        },
+        "required": [
+          "prop1",
+          "prop2",
+          "prop3",
+        ],
+        "type": "object",
+      },
+    },
+  },
+  "paths": {
+    "/": {
+      "post": {
+        "operationId": "myControllerCreateWithArray",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "items": {
+                  "$ref": "#/components/schemas/MyModelCreate",
+                },
+                "type": "array",
+              },
+            },
+          },
+          "required": false,
+        },
+        "responses": {
+          "201": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "items": {
+                    "$ref": "#/components/schemas/MyModelDetails",
+                  },
+                  "type": "array",
+                },
+              },
+            },
+            "description": "Created",
+          },
+        },
+        "tags": [
+          "MyController",
+        ],
+      },
+    },
+  },
+  "tags": [
+    {
+      "name": "MyController",
+    },
+  ],
+}
+`;
+
+exports[`@Groups > OpenSpec > should display fields when a group match with - body and a group name (OS3) 1`] = `
+{
+  "components": {
+    "schemas": {
+      "ChildModel": {
+        "properties": {
+          "id": {
+            "type": "string",
+          },
+          "prop1": {
+            "minLength": 1,
+            "type": "string",
+          },
+        },
+        "required": [
+          "prop1",
+        ],
+        "type": "object",
+      },
+      "MyModel": {
+        "properties": {
+          "id": {
+            "type": "string",
+          },
+          "prop3": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop4": {
+            "items": {
+              "$ref": "#/components/schemas/ChildModel",
+            },
+            "type": "array",
+          },
+        },
+        "required": [
+          "prop3",
+        ],
+        "type": "object",
+      },
+      "MyModelCompleteGroup": {
+        "properties": {
+          "id": {
+            "type": "string",
+          },
+          "prop1": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop2": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop3": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop4": {
+            "items": {
+              "$ref": "#/components/schemas/ChildModel",
+            },
+            "type": "array",
+          },
+        },
+        "required": [
+          "prop1",
+          "prop2",
+          "prop3",
+        ],
+        "type": "object",
+      },
+      "MyModelCreatePayload": {
+        "properties": {
+          "prop3": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop4": {
+            "items": {
+              "$ref": "#/components/schemas/ChildModel",
+            },
+            "type": "array",
+          },
+        },
+        "required": [
+          "prop3",
+        ],
+        "type": "object",
+      },
+      "MyModelGroup": {
+        "properties": {
+          "id": {
+            "type": "string",
+          },
+          "prop1": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop2": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop3": {
+            "minLength": 1,
+            "type": "string",
+          },
+          "prop4": {
+            "items": {
+              "$ref": "#/components/schemas/ChildModel",
+            },
+            "type": "array",
+          },
+        },
+        "required": [
+          "prop1",
+          "prop2",
+          "prop3",
+        ],
+        "type": "object",
+      },
+    },
+  },
+  "paths": {
+    "/": {
+      "post": {
+        "operationId": "myControllerCreate",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/MyModelCreatePayload",
+              },
+            },
+          },
+          "required": false,
+        },
+        "responses": {
+          "201": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MyModelGroup",
+                },
+              },
+            },
+            "description": "Created",
+          },
+        },
+        "tags": [
+          "MyController",
+        ],
+      },
+    },
+    "/{id}": {
+      "put": {
+        "operationId": "myControllerUpdate",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "id",
+            "required": true,
+            "schema": {
+              "type": "string",
+            },
+          },
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/MyModelCompleteGroup",
+              },
+            },
+          },
+          "required": false,
+        },
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/MyModel",
+                },
+              },
+            },
+            "description": "Success",
+          },
+        },
+        "tags": [
+          "MyController",
+        ],
+      },
+    },
+  },
+  "tags": [
+    {
+      "name": "MyController",
+    },
+  ],
+}
+`;

package/src/decorators/common/additionalProperties.spec.ts

@@ -0,0 +1,133 @@
+import {AdditionalProperties, CollectionOf, getJsonSchema, Property, string} from "../../index.js";
+
+describe("AdditionalProperties", () => {
+  it("should declare additional properties", () => {
+    @AdditionalProperties(true)
+    class Model {
+      @Property()
+      id: string;
+
+      [key: string]: any;
+    }
+
+    expect(getJsonSchema(Model)).toEqual({
+      additionalProperties: true,
+      properties: {
+        id: {
+          type: "string"
+        }
+      },
+      type: "object"
+    });
+  });
+
+  it("should declare additional properties with String Model", () => {
+    @AdditionalProperties(string())
+    class Model {
+      @Property()
+      id: string;
+
+      [key: string]: any;
+    }
+
+    expect(getJsonSchema(Model)).toEqual({
+      additionalProperties: {
+        type: "string"
+      },
+      properties: {
+        id: {
+          type: "string"
+        }
+      },
+      type: "object"
+    });
+  });
+
+  it("should declare additional properties with String Type", () => {
+    @AdditionalProperties(String)
+    class Model {
+      @Property()
+      id: string;
+
+      [key: string]: any;
+    }
+
+    expect(getJsonSchema(Model)).toEqual({
+      additionalProperties: {
+        type: "string"
+      },
+      properties: {
+        id: {
+          type: "string"
+        }
+      },
+      type: "object"
+    });
+  });
+
+  it("should declare additional properties with Number Type", () => {
+    @AdditionalProperties(Number)
+    class Model {
+      @Property()
+      id: string;
+
+      [key: string]: any;
+    }
+
+    expect(getJsonSchema(Model)).toEqual({
+      additionalProperties: {
+        type: "number"
+      },
+      properties: {
+        id: {
+          type: "string"
+        }
+      },
+      type: "object"
+    });
+  });
+
+  it("should declare additional properties with model", () => {
+    class SubModel {
+      @Property()
+      id: string;
+    }
+    @AdditionalProperties(SubModel)
+    class Model {
+      [key: string]: SubModel;
+    }
+
+    class Container {
+      @CollectionOf(Model)
+      list: Model[];
+    }
+
+    expect(getJsonSchema(Container)).toEqual({
+      definitions: {
+        Model: {
+          additionalProperties: {
+            $ref: "#/definitions/SubModel"
+          },
+          type: "object"
+        },
+        SubModel: {
+          properties: {
+            id: {
+              type: "string"
+            }
+          },
+          type: "object"
+        }
+      },
+      properties: {
+        list: {
+          items: {
+            $ref: "#/definitions/Model"
+          },
+          type: "array"
+        }
+      },
+      type: "object"
+    });
+  });
+});

package/src/decorators/common/additionalProperties.ts

@@ -0,0 +1,17 @@
+import {AnyJsonSchema} from "../../domain/JsonSchema.js";
+import {JsonEntityFn} from "./jsonEntityFn.js";
+
+/**
+ * Accept unknown properties on the deserialized model.
+ *
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+export function AdditionalProperties(schema: boolean | AnyJsonSchema) {
+  return JsonEntityFn((entity, parameters) => {
+    entity.itemSchema.additionalProperties(schema);
+  });
+}