fix(schema): fix nullable decorator and mixed type usage

Closes: #2735
tsedio · Jul 10, 2024 · ce892ee · ce892ee
1 parent 528386a
commit ce892ee
Show file tree

Hide file tree

Showing 35 changed files with 1,516 additions and 280 deletions.
diff --git a/....vuepress/public/vite-plugin-ssr-tsed.png → docs/.vuepress/public/vite-tsed.png b/....vuepress/public/vite-plugin-ssr-tsed.png → docs/.vuepress/public/vite-tsed.png
diff --git a/docs/docs/model.md b/docs/docs/model.md
@@ -112,6 +112,131 @@ json type or when you use a mixed TypeScript types.
   </Tab>
 </Tabs>
 
+You can also use @@Any@@ decorator to allow all types:
+
+<Tabs class="-code">
+  <Tab label="Model">
+
+```typescript
+import {Any} from "@tsed/schema";
+
+export class Model {
+  @Any()
+  prop: any;
+}
+```
+
+  </Tab>
+  <Tab label="Json schema">
+
+```json
+{
+  "properties": {
+    "prop": {
+      "anyOf": [
+        {
+          "type": "null"
+        },
+        {
+          "type": "integer",
+          "multipleOf": 1
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "array"
+        },
+        {
+          "type": "object"
+        }
+      ]
+    }
+  },
+  "type": "object"
+}
+```
+
+  </Tab>
+  <Tab label="OS3">
+
+```json
+{
+  "properties": {
+    "prop": {
+      "nullable": true,
+      "anyOf": [
+        {
+          "type": "integer",
+          "multipleOf": 1
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "array"
+        },
+        {
+          "type": "object"
+        }
+      ]
+    }
+  },
+  "type": "object"
+}
+```
+
+  </Tab>
+</Tabs>
+
+Since v7.75.0, when you use @@Any@@ decorator combined with other decorators like @@MinLength@@, @@Minimum@@, etc. metadata will be automatically assigned to the right
+type. For example, if you add a @@Minimum@@ decorator, it will be assigned to the number type.
+
+```ts
+import {Any} from "@tsed/schema";
+
+class Model {
+  @Any(String, Number)
+  @Minimum(0)
+  @MaxLength(100)
+  prop: string | number;
+}
+```
+
+Produce a json-schema as follows:
+
+```json
+{
+  "properties": {
+    "prop": {
+      "allOf": [
+        {
+          "type": "string",
+          "maxLength": 100
+        },
+        {
+          "type": "number",
+          "minimum": 0
+        }
+      ]
+    }
+  },
+  "type": "object"
+}
+```
+
 ## Nullable
 
 The @@Nullable@@ decorator is used allow a null value on a field while preserving the original Typescript type.
@@ -189,62 +314,50 @@ class NullableModel {
 `returnsCoercedValue` will become true by default in the next major version of Ts.ED.
 :::
 
-## Any
-
-The @@Any@@ decorator is used to allow any types:
+## Nullable and mixed types <Badge text="7.75.0+"/>
 
-<Tabs class="-code">
-  <Tab label="Model">
+The @@Nullable@@ decorator can be used with Tuple types:
 
-```typescript
-import {Any} from "@tsed/schema";
+```ts
+import {Nullable} from "@tsed/schema";
 
-export class Model {
-  @Any()
-  prop: any;
+class Model {
+  @Nullable(String, Number)
+  prop: string | number | null;
 }
 ```
 
-  </Tab>
-  <Tab label="Json schema">
+Since v7.75.0, when you use @@Nullable@@ decorator combined with other decorators like @@MinLength@@, @@Minimum@@, etc. metadata will be automatically assigned to the right
+type. For example, if you add a @@Minimum@@ decorator, it will be assigned to the number type.
 
-```json
-{
-  "properties": {
-    "prop": {
-      "type": ["integer", "number", "string", "boolean", "array", "object", "null"]
-    }
-  },
-  "type": "object"
+```ts
+import {Nullable} from "@tsed/schema";
+
+class Model {
+  @Nullable(String, Number)
+  @Minimum(0)
+  @MaxLength(100)
+  prop: string | number | null;
 }
 ```
 
-  </Tab>
-  <Tab label="OS3">
+Produce a json-schema as follows:
 
 ```json
 {
   "properties": {
     "prop": {
-      "nullable": true,
-      "oneOf": [
+      "anyOf": [
         {
-          "type": "integer"
+          "type": "null"
         },
         {
-          "type": "number"
+          "type": "string",
+          "maxLength": 100
         },
         {
-          "type": "string"
-        },
-        {
-          "type": "boolean"
-        },
-        {
-          "type": "array"
-        },
-        {
-          "type": "object"
+          "type": "number",
+          "minimum": 0
         }
       ]
     }
@@ -253,9 +366,6 @@ export class Model {
 }
 ```
 
-  </Tab>
-</Tabs>
-
 ## Regular expressions
 
 The @@Pattern@@ decorator is used to restrict a string to a particular regular expression. The regular expression syntax

diff --git a/docs/docs/snippets/model/any-types.json b/docs/docs/snippets/model/any-types.json
@@ -1,14 +1,53 @@
 {
-  "definitions": {},
   "properties": {
     "prop1": {
-      "type": ["integer", "number", "string", "boolean", "array", "object", "null"]
+      "allOf": [
+        {
+          "type": "integer",
+          "minLength": 1
+        },
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "boolean"
+        },
+        {
+          "type": "array"
+        },
+        {
+          "type": "object"
+        },
+        {
+          "type": "null"
+        }
+      ]
     },
     "prop2": {
-      "type": ["string", "number", "boolean"]
+      "allOf": [
+        {
+          "type": "number"
+        },
+        {
+          "type": "string"
+        },
+        {
+          "type": "boolean"
+        }
+      ]
     },
     "prop3": {
-      "type": ["string", "null"]
+      "allOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ]
     }
   },
   "type": "object"

diff --git a/packages/orm/mongoose/src/decorators/virtualRef.spec.ts b/packages/orm/mongoose/src/decorators/virtualRef.spec.ts
@@ -201,7 +201,7 @@ describe("@VirtualRef()", () => {
                   type: "number"
                 },
                 members: {
-                  oneOf: [
+                  anyOf: [
                     {
                       $ref: "#/components/schemas/TestPerson"
                     }

diff --git a/packages/orm/mongoose/test/enums.integration.spec.ts b/packages/orm/mongoose/test/enums.integration.spec.ts
@@ -47,8 +47,7 @@ describe("Enums integration", () => {
         ResponseTimeThreshold: {
           properties: {
             status: {
-              $ref: "#/definitions/ComponentStatuses",
-              minLength: 1
+              $ref: "#/definitions/ComponentStatuses"
             }
           },
           required: ["status"],

diff --git a/packages/platform/platform-express/test/__snapshots__/array-body.spec.ts.snap b/packages/platform/platform-express/test/__snapshots__/array-body.spec.ts.snap
@@ -29,9 +29,9 @@ Object {
             "application/json": Object {
               "schema": Object {
                 "items": Object {
-                  "nullable": true,
-                  "oneOf": Array [
+                  "anyOf": Array [
                     Object {
+                      "multipleOf": 1,
                       "type": "integer",
                     },
                     Object {
@@ -50,6 +50,7 @@ Object {
                       "type": "object",
                     },
                   ],
+                  "nullable": true,
                 },
                 "type": "array",
               },
@@ -76,9 +77,9 @@ Object {
             "application/json": Object {
               "schema": Object {
                 "items": Object {
-                  "nullable": true,
-                  "oneOf": Array [
+                  "anyOf": Array [
                     Object {
+                      "multipleOf": 1,
                       "type": "integer",
                     },
                     Object {
@@ -97,6 +98,7 @@ Object {
                       "type": "object",
                     },
                   ],
+                  "nullable": true,
                 },
                 "type": "array",
               },
@@ -200,9 +202,9 @@ Object {
           "content": Object {
             "application/json": Object {
               "schema": Object {
-                "nullable": true,
-                "oneOf": Array [
+                "anyOf": Array [
                   Object {
+                    "multipleOf": 1,
                     "type": "integer",
                   },
                   Object {
@@ -221,6 +223,7 @@ Object {
                     "type": "object",
                   },
                 ],
+                "nullable": true,
               },
             },
           },

diff --git a/packages/platform/platform-express/test/__snapshots__/discriminator.spec.ts.snap b/packages/platform/platform-express/test/__snapshots__/discriminator.spec.ts.snap
@@ -30,6 +30,7 @@ Object {
       "ActionPartial": Object {
         "properties": Object {
           "event": Object {
+            "minLength": 1,
             "type": "string",
           },
           "type": Object {
@@ -71,6 +72,7 @@ Object {
       "CustomActionPartial": Object {
         "properties": Object {
           "event": Object {
+            "minLength": 1,
             "type": "string",
           },
           "meta": Object {
@@ -112,6 +114,7 @@ Object {
             "type": "string",
           },
           "url": Object {
+            "minLength": 1,
             "type": "string",
           },
           "value": Object {
@@ -203,7 +206,6 @@ Object {
                   "discriminator": Object {
                     "propertyName": "type",
                   },
-                  "nullable": true,
                   "oneOf": Array [
                     Object {
                       "$ref": "#/components/schemas/PageView",