@tsed/schema 8.17.1 → 8.17.3

package/lib/esm/components/default/nullableMapper.js

@@ -1,48 +1,57 @@
-import { cleanObject } from "@tsed/core";
+import { cleanObject } from "@tsed/core/utils/cleanObject.js";
+import { uniq } from "@tsed/core/utils/uniq.js";
 import { MANY_OF_PROPERTIES } from "../../constants/jsonSchemaProperties.js";
 import { registerJsonSchemaMapper } from "../../registries/JsonSchemaMapperContainer.js";
 export function nullableMapper(obj, schema) {
-    if (!schema?.isNullable) {
+    if (!schema?.isNullable || obj.discriminator) {
         return obj;
     }
-    if (!obj.discriminator) {
-        if (obj.$ref) {
-            obj = cleanObject({
-                ...obj,
-                $ref: undefined,
-                anyOf: [
-                    { type: "null" },
-                    {
-                        $ref: obj.$ref
-                    }
-                ]
-            });
-        }
-        else {
-            MANY_OF_PROPERTIES.some((keyword) => {
-                if (obj[keyword]) {
-                    obj[keyword] = obj[keyword].filter((item) => item.type !== "null");
-                    if (obj[keyword].length === 1) {
-                        const base = obj[keyword];
-                        obj = cleanObject({
-                            ...obj,
-                            ...base[0],
-                            [keyword]: undefined,
-                            type: ["null", Number.isInteger(obj.multipleOf) ? "integer" : base[0].type]
-                        });
-                    }
-                    else {
-                        obj[keyword] = [{ type: "null" }].concat(obj[keyword]).map((item) => {
-                            if (Number.isInteger(item.multipleOf)) {
-                                item.type = "integer";
-                            }
-                            return item;
-                        });
-                        delete obj.type;
-                    }
+    if (obj.$ref) {
+        return cleanObject({
+            ...obj,
+            $ref: undefined,
+            oneOf: [
+                // Note: anyOf work but isn't correct, oneOf can cause issue if the object shape match with 2 or more schema with the lax constraint
+                { type: "null" },
+                {
+                    $ref: obj.$ref
                 }
-            });
-        }
+            ]
+        });
+    }
+    if (obj.type === "array") {
+        return {
+            oneOf: [{ type: "null" }, obj]
+        };
+    }
+    if (obj["oneOf"] || obj["anyOf"] || obj["allOf"]) {
+        MANY_OF_PROPERTIES.some((keyword) => {
+            if (obj[keyword]) {
+                obj[keyword] = obj[keyword].filter((item) => item.type !== "null");
+                if (obj[keyword].length === 1) {
+                    const base = obj[keyword];
+                    obj = cleanObject({
+                        ...obj,
+                        ...base[0],
+                        [keyword]: undefined,
+                        type: ["null", Number.isInteger(obj.multipleOf) ? "integer" : base[0].type]
+                    });
+                }
+                else {
+                    obj[keyword] = [{ type: "null" }].concat(obj[keyword]).map((item) => {
+                        if (Number.isInteger(item.multipleOf)) {
+                            item.type = "integer";
+                        }
+                        return item;
+                    });
+                    delete obj.type;
+                }
+            }
+        });
+        return obj;
+    }
+    if (obj.type) {
+        obj.type = uniq([].concat("null", obj.type));
     }
     return obj;
 }

package/lib/esm/components/open-spec/nullableMapper.js

@@ -12,35 +12,30 @@ export function nullableMapperOpenApi(obj, schema, options) {
     if (obj.$ref) {
         return cleanObject({
             ...obj,
-            ...(obj.$ref && {
-                anyOf: [
-                    {
-                        $ref: obj.$ref
-                    }
-                ],
-                type: undefined
-            }),
-            nullable: true,
-            $ref: undefined
+            nullable: true
         });
     }
-    return cleanObject({
-        ...obj,
-        ...(obj.anyOf?.length === 1
-            ? {
-                ...obj.anyOf[0],
-                anyOf: undefined,
-                type: Number.isInteger(obj.multipleOf) ? "integer" : obj.anyOf[0]?.type
-            }
-            : {
-                type: obj.anyOf?.length > 1 ? undefined : obj.type,
-                anyOf: obj.anyOf?.map((item) => {
+    function map(manyOf) {
+        return obj[manyOf]?.length === 1
+            ? cleanObject({
+                ...obj[manyOf][0],
+                [manyOf]: undefined,
+                type: Number.isInteger(obj.multipleOf) ? "integer" : obj[manyOf][0]?.type
+            })
+            : cleanObject({
+                type: obj[manyOf]?.length > 1 ? undefined : obj.type,
+                [manyOf]: obj[manyOf]?.map((item) => {
                     if (Number.isInteger(item.multipleOf)) {
                         item.type = "integer";
                     }
                     return item;
                 })
-            }),
+            });
+    }
+    return cleanObject({
+        ...obj,
+        ...map("oneOf"),
+        ...map("anyOf"),
         nullable: true
     });
 }

package/lib/esm/decorators/common/nullable.js

@@ -1,5 +1,8 @@
 import { useDecorators } from "@tsed/core";
-import { Any } from "./any.js";
+import { JsonSchema } from "../../domain/JsonSchema.js";
+import { array } from "../../fn/collection.js";
+import { JsonEntityFn } from "./jsonEntityFn.js";
+import { OneOf } from "./oneOf.js";
 import { Property } from "./property.js";
 /**
  * Set field as nullable.
@@ -25,5 +28,13 @@ import { Property } from "./property.js";
  */
 export function Nullable(type, ...types) {
     types = [type, ...types];
-    return useDecorators(types.length === 1 && Property(types[0]), Any(null, ...types));
+    if (type === Array) {
+        return JsonEntityFn((entity) => {
+            entity.schema.assign(array()
+                .items({})
+                .$comment("Warning: you should not use @Nullable(Array), which leads to an incorrect schema. Use @Schema(array().items().nullable()) instead")
+                .nullable(true));
+        });
+    }
+    return useDecorators(types.length === 1 && !(type instanceof JsonSchema) && Property(types[0]), OneOf(null, ...types));
 }

package/lib/esm/domain/JsonSchema.js

@@ -27,16 +27,16 @@ function mapToJsonSchema(item) {
     if (isArray(item)) {
         return item.map(mapToJsonSchema);
     }
-    if (item.isStore || item.$isJsonDocument || item.isLazyRef) {
+    if (item && (item.isStore || item.$isJsonDocument || item.isLazyRef)) {
         return item;
     }
-    if (classOf(item) !== Object && isClass(item)) {
+    if (item && classOf(item) !== Object && isClass(item)) {
         return JsonEntityStore.from(item).schema;
     }
     if (isObject(item)) {
         return JsonSchema.from(item);
     }
-    if (isPrimitiveClass(item)) {
+    if (isPrimitiveClass(item) || item === Date || item === null) {
         return JsonSchema.from({ type: item });
     }
     return item;
@@ -173,7 +173,7 @@ export class JsonSchema extends Map {
         return this.#useRefLabel;
     }
     get isNullable() {
-        return !!this.get("nullable");
+        return !!this.get(VendorKeys.NULLABLE);
     }
     get isReadOnly() {
         return this.get("readOnly");
@@ -188,10 +188,10 @@ export class JsonSchema extends Map {
         if (item instanceof JsonSchema) {
             return item;
         }
-        if (classOf(item) !== Object && isClass(item)) {
+        if (item && classOf(item) !== Object && isClass(item)) {
             return JsonEntityStore.from(item).schema;
         }
-        if (isPrimitiveClass(item)) {
+        if (isPrimitiveClass(item) || item === Date || item === null) {
             return new JsonSchema({ type: item });
         }
         return new JsonSchema(item);
@@ -272,7 +272,9 @@ export class JsonSchema extends Map {
         return this;
     }
     nullable(value) {
-        this.vendorKey(VendorKeys.NULLABLE, value);
+        if (!this.isNullable) {
+            this.vendorKey(VendorKeys.NULLABLE, value);
+        }
         return this;
     }
     itemSchema(obj = {}) {
@@ -445,6 +447,10 @@ export class JsonSchema extends Map {
         super.set("items", (this.#itemSchema = mapToJsonSchema(items)));
         return this;
     }
+    $comment(comment) {
+        super.set("$comment", comment);
+        return this;
+    }
     /**
      * Must be a non-negative integer.
      * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
@@ -504,7 +510,13 @@ export class JsonSchema extends Map {
                     this.set("minLength", undefined);
                     break;
                 case null:
-                    this.any(...["null"].concat(this.getJsonType(), this.$allow.map((v) => typeof v)));
+                    this.nullable(true);
+                    // this.any(
+                    //   ...["null"].concat(
+                    //     this.getJsonType(),
+                    //     this.$allow.map((v) => typeof v)
+                    //   )
+                    // );
                     break;
             }
         });
@@ -830,12 +842,12 @@ export class JsonSchema extends Map {
         return this;
     }
     any(...types) {
-        types = types.length ? types : ["integer", "number", "string", "boolean", "array", "object", "null"];
+        types = types.length ? types : ["integer", "number", "string", "boolean", "array", "object", "null"]; // should be simplified by no type
         types = uniq(types).map((o) => {
             return isClass(o) ? o : { type: getJsonType(o) };
         });
         if (types.length > 1) {
-            this.anyOf(types);
+            this.oneOf(types);
         }
         else {
             this.type(types[0]?.type || types[0]);
@@ -995,7 +1007,7 @@ export class JsonSchema extends Map {
     setManyOf(keyword, value) {
         let resolved = value
             .filter((o) => {
-            if (o && "type" in o && o.type === "null") {
+            if ((o && "type" in o && o.type === "null") || o === null) {
                 this.nullable(true);
                 return false;
             }

package/lib/esm/fn/index.js

@@ -0,0 +1,36 @@
+import { allOf } from "./allOf.js";
+import { anyOf } from "./anyOf.js";
+import { boolean } from "./boolean.js";
+import { array, map, set } from "./collection.js";
+import { date, datetime, time } from "./date.js";
+import { email } from "./email.js";
+import { enums } from "./enums.js";
+import { integer } from "./integer.js";
+import { lazyRef } from "./lazyRef.js";
+import { number } from "./number.js";
+import { object } from "./object.js";
+import { oneOf } from "./oneOf.js";
+import { string } from "./string.js";
+import { uri } from "./uri.js";
+import { url } from "./url.js";
+export const s = {
+    allOf,
+    anyOf,
+    boolean,
+    array,
+    map,
+    set,
+    date,
+    datetime,
+    time,
+    email,
+    enums,
+    integer,
+    number,
+    lazyRef,
+    object,
+    oneOf,
+    string,
+    uri,
+    url
+};

package/lib/esm/hooks/alterOneOf.js

@@ -1,4 +1,6 @@
-import { isBoolean, isNumber, isString } from "@tsed/core";
+import { isBoolean } from "@tsed/core/utils/isBoolean.js";
+import { isNumber } from "@tsed/core/utils/isNumber.js";
+import { isString } from "@tsed/core/utils/isString.js";
 import { ARRAY_PROPERTIES, BOOLEAN_PROPERTIES, COMMON_PROPERTIES, MANY_OF_PROPERTIES, NUMBER_PROPERTIES, OBJECT_PROPERTIES, STRING_PROPERTIES } from "../constants/jsonSchemaProperties.js";
 function findManyOf(obj) {
     return MANY_OF_PROPERTIES.find((keyword) => obj[keyword]);

package/lib/esm/index.js

@@ -143,6 +143,7 @@ export * from "./fn/date.js";
 export * from "./fn/email.js";
 export * from "./fn/enums.js";
 export * from "./fn/from.js";
+export * from "./fn/index.js";
 export * from "./fn/integer.js";
 export * from "./fn/lazyRef.js";
 export * from "./fn/number.js";

package/lib/types/decorators/common/allOf.d.ts

@@ -1,4 +1,4 @@
-import { AnyJsonSchema } from "../../domain/JsonSchema.js";
+import type { JsonSchema } from "../../domain/JsonSchema.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
  *
@@ -10,4 +10,4 @@ import { AnyJsonSchema } from "../../domain/JsonSchema.js";
  * @input
  * @param allOf
  */
-export declare function AllOf(...allOf: AnyJsonSchema[]): (...args: any[]) => any;
+export declare function AllOf(...allOf: Parameters<JsonSchema["allOf"]>[0]): (...args: any[]) => any;

package/lib/types/decorators/common/anyOf.d.ts

@@ -1,4 +1,4 @@
-import { AnyJsonSchema } from "../../domain/JsonSchema.js";
+import type { JsonSchema } from "../../domain/JsonSchema.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
  *
@@ -14,4 +14,4 @@ import { AnyJsonSchema } from "../../domain/JsonSchema.js";
  * @input
  * @param anyOf
  */
-export declare function AnyOf(...anyOf: AnyJsonSchema[]): (...args: any[]) => any;
+export declare function AnyOf(...anyOf: Parameters<JsonSchema["anyOf"]>[0]): (...args: any[]) => any;

package/lib/types/decorators/common/oneOf.d.ts

@@ -1,4 +1,4 @@
-import { AnyJsonSchema } from "../../domain/JsonSchema.js";
+import type { JsonSchema } from "../../domain/JsonSchema.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
  *
@@ -14,4 +14,4 @@ import { AnyJsonSchema } from "../../domain/JsonSchema.js";
  * @input
  * @param oneOf
  */
-export declare function OneOf(...oneOf: AnyJsonSchema[]): (...args: any[]) => any;
+export declare function OneOf(...oneOf: Parameters<JsonSchema["oneOf"]>[0]): (...args: any[]) => any;

package/lib/types/domain/JsonSchema.d.ts

@@ -154,6 +154,7 @@ export declare class JsonSchema extends Map<string, any> {
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.9
      */
     items(items: AnyJsonSchema | AnyJsonSchema[]): this;
+    $comment(comment: string): this;
     /**
      * Must be a non-negative integer.
      * An array instance is valid against "maxItems" if its size is less than, or equal to, the value of this keyword.
@@ -272,12 +273,12 @@ export declare class JsonSchema extends Map<string, any> {
     /**
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
      */
-    allOf(allOf: AnyJsonSchema[]): this;
+    allOf(allOf: (AnyJsonSchema | null)[]): this;
     /**
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
      */
-    anyOf(anyOf: AnyJsonSchema[]): this;
-    oneOf(oneOf: AnyJsonSchema[]): this;
+    anyOf(anyOf: (AnyJsonSchema | null)[]): this;
+    oneOf(oneOf: (AnyJsonSchema | null)[]): this;
     /**
      * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.29
      */
@@ -381,5 +382,5 @@ export declare class JsonSchema extends Map<string, any> {
     getPropertyKey(): string | symbol | undefined;
     target(target: any): void;
     isRequiredValue(property: string, value: any): boolean;
-    protected setManyOf(keyword: "oneOf" | "anyOf" | "allOf", value: AnyJsonSchema[]): this | undefined;
+    protected setManyOf(keyword: "oneOf" | "anyOf" | "allOf", value: (AnyJsonSchema | null)[]): this | undefined;
 }

package/lib/types/fn/allOf.d.ts

@@ -1,4 +1,4 @@
-import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
+import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
  *
@@ -6,4 +6,4 @@ import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
  *
  * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
  */
-export declare function allOf(...allOf: AnyJsonSchema[]): JsonSchema;
+export declare function allOf(...allOf: Parameters<JsonSchema["allOf"]>[0]): JsonSchema;

package/lib/types/fn/any.d.ts

@@ -1,7 +1,7 @@
-import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
+import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * Declare a model with any type (By default: `integer`, `number`, `string`, `boolean`, `array`, `object`, `null`)
  *
  * See @@JsonSchema@@ to discover available methods.
  */
-export declare function any(...types: AnyJsonSchema[]): JsonSchema;
+export declare function any(...types: Parameters<JsonSchema["oneOf"]>[0]): JsonSchema;

package/lib/types/fn/anyOf.d.ts

@@ -1,4 +1,4 @@
-import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
+import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
  *
@@ -6,4 +6,4 @@ import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
  *
  * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
  */
-export declare function anyOf(...anyOf: AnyJsonSchema[]): JsonSchema;
+export declare function anyOf(...anyOf: Parameters<JsonSchema["allOf"]>[0]): JsonSchema;

package/lib/types/fn/index.d.ts

@@ -0,0 +1,36 @@
+import { allOf } from "./allOf.js";
+import { anyOf } from "./anyOf.js";
+import { boolean } from "./boolean.js";
+import { array, map, set } from "./collection.js";
+import { date, datetime, time } from "./date.js";
+import { email } from "./email.js";
+import { enums } from "./enums.js";
+import { integer } from "./integer.js";
+import { lazyRef } from "./lazyRef.js";
+import { number } from "./number.js";
+import { object } from "./object.js";
+import { oneOf } from "./oneOf.js";
+import { string } from "./string.js";
+import { uri } from "./uri.js";
+import { url } from "./url.js";
+export declare const s: {
+    readonly allOf: typeof allOf;
+    readonly anyOf: typeof anyOf;
+    readonly boolean: typeof boolean;
+    readonly array: typeof array;
+    readonly map: typeof map;
+    readonly set: typeof set;
+    readonly date: typeof date;
+    readonly datetime: typeof datetime;
+    readonly time: typeof time;
+    readonly email: typeof email;
+    readonly enums: typeof enums;
+    readonly integer: typeof integer;
+    readonly number: typeof number;
+    readonly lazyRef: typeof lazyRef;
+    readonly object: typeof object;
+    readonly oneOf: typeof oneOf;
+    readonly string: typeof string;
+    readonly uri: typeof uri;
+    readonly url: typeof url;
+};

package/lib/types/fn/oneOf.d.ts

@@ -1,4 +1,4 @@
-import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
+import type { JsonSchema } from "../domain/JsonSchema.js";
 /**
  * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
  *
@@ -7,4 +7,4 @@ import type { AnyJsonSchema, JsonSchema } from "../domain/JsonSchema.js";
  * @schemaFunctional
  * @see https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
  */
-export declare function oneOf(...oneOf: AnyJsonSchema[]): JsonSchema;
+export declare function oneOf(...oneOf: Parameters<JsonSchema["oneOf"]>[0]): JsonSchema;

package/lib/types/index.d.ts

@@ -143,6 +143,7 @@ export * from "./fn/date.js";
 export * from "./fn/email.js";
 export * from "./fn/enums.js";
 export * from "./fn/from.js";
+export * from "./fn/index.js";
 export * from "./fn/integer.js";
 export * from "./fn/lazyRef.js";
 export * from "./fn/number.js";

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tsed/schema",
   "description": "JsonSchema module for Ts.ED Framework",
   "type": "module",
-  "version": "8.17.1",
+  "version": "8.17.3",
   "source": "./src/index.ts",
   "main": "./lib/esm/index.js",
   "module": "./lib/esm/index.js",
@@ -34,7 +34,7 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/openspec": "8.17.1",
+    "@tsed/openspec": "8.17.3",
     "change-case": "^5.4.4",
     "json-schema": "0.4.0",
     "picomatch": "4.0.2",
@@ -43,11 +43,11 @@
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "10.1.0",
-    "@tsed/barrels": "8.17.1",
-    "@tsed/core": "8.17.1",
-    "@tsed/hooks": "8.17.1",
-    "@tsed/openspec": "8.17.1",
-    "@tsed/typescript": "8.17.1",
+    "@tsed/barrels": "8.17.3",
+    "@tsed/core": "8.17.3",
+    "@tsed/hooks": "8.17.3",
+    "@tsed/openspec": "8.17.3",
+    "@tsed/typescript": "8.17.3",
     "@types/fs-extra": "11.0.4",
     "@types/json-schema": "7.0.15",
     "@types/picomatch": "3.0.2",