@tsed/schema 7.0.0-alpha.1 → 7.0.0-beta.10

package/lib/esm/decorators/collections/maxItems.js

@@ -0,0 +1,56 @@
+import { JsonEntityFn } from "../common/jsonEntityFn.js";
+/**
+ * The value `maxItems` 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.
+ *
+ * :: warning
+ * The value `maxItems` MUST be a non-negative integer.
+ * :::
+ *
+ * :: warning
+ * This decorator will be removed in v7.
+ * For v6 user, use @@MaxItems@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(String)
+ *    @MaxItems(10)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "maxItems": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} maxItems
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export function MaxItems(maxItems) {
+    if (maxItems < 0) {
+        throw new Error("The value of maxItems MUST be a non-negative integer.");
+    }
+    return JsonEntityFn((storedJson) => {
+        storedJson.schema.maxItems(maxItems);
+    });
+}
+//# sourceMappingURL=maxItems.js.map

package/lib/esm/decorators/collections/maxItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maxItems.js","sourceRoot":"","sources":["../../../../src/decorators/collections/maxItems.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAU,QAAQ,CAAC,QAAgB;IACvC,IAAI,QAAQ,GAAG,CAAC,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;KAC1E;IAED,OAAO,YAAY,CAAC,CAAC,UAAU,EAAE,EAAE;QACjC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * The value `maxItems` MUST be a non-negative integer.\n *\n * An array instance is valid against `maxItems` if its size is less than, or equal to, the value of this keyword.\n *\n * :: warning\n * The value `maxItems` MUST be a non-negative integer.\n * :::\n *\n * :: warning\n * This decorator will be removed in v7.\n * For v6 user, use @@MaxItems@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @CollectionOf(String)\n *    @MaxItems(10)\n *    property: string[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"number\",\n *       \"maxItems\": 10\n *     }\n *   }\n * }\n * ```\n *\n * @param {number} maxItems\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @collections\n */\nexport function MaxItems(maxItems: number) {\n  if (maxItems < 0) {\n    throw new Error(\"The value of maxItems MUST be a non-negative integer.\");\n  }\n\n  return JsonEntityFn((storedJson) => {\n    storedJson.schema.maxItems(maxItems);\n  });\n}\n"]}

package/lib/esm/decorators/collections/maxProperties.js

@@ -0,0 +1,79 @@
+import { JsonEntityFn } from "../common/jsonEntityFn.js";
+/**
+ * An object instance is valid against `maxProperties` if its number of properties is less than, or equal to, the value of this keyword.
+ *
+ * ::: warning
+ * The value of this keyword MUST be a non-negative integer.
+ * :::
+ *
+ * ::: warning
+ * This decorator will be removed in v7.
+ * For v6 user, use @@MaxProperties@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### On prop
+ * ```typescript
+ * class Model {
+ *    @MaxProperties(10)
+ *    property: any;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "any",
+ *       "maxProperties": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### On class
+ *
+ * ```typescript
+ * @MaxProperties(10)
+ * class Model {
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "maxProperties": 10
+ * }
+ * ```
+ *
+ * ### On Parameter
+ *
+ * ```typescript
+ *
+ * class Model {
+ *   method(@Any() @MaxProperties(10) obj: any){}
+ * }
+ * ```
+ *
+ * @param {number} maxProperties The maximum properties allowed on the given object
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export function MaxProperties(maxProperties) {
+    if (maxProperties < 0) {
+        throw new Error("The value of maxProperties MUST be a non-negative integer.");
+    }
+    return JsonEntityFn((store) => {
+        store.isCollection ? store.schema.maxProperties(maxProperties) : store.itemSchema.maxProperties(maxProperties);
+    });
+}
+//# sourceMappingURL=maxProperties.js.map

package/lib/esm/decorators/collections/maxProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"maxProperties.js","sourceRoot":"","sources":["../../../../src/decorators/collections/maxProperties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,MAAM,UAAU,aAAa,CAAC,aAAqB;IACjD,IAAI,aAAa,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;KAC/E;IAED,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * An object instance is valid against `maxProperties` if its number of properties is less than, or equal to, the value of this keyword.\n *\n * ::: warning\n * The value of this keyword MUST be a non-negative integer.\n * :::\n *\n * ::: warning\n * This decorator will be removed in v7.\n * For v6 user, use @@MaxProperties@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n * ### On prop\n * ```typescript\n * class Model {\n *    @MaxProperties(10)\n *    property: any;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"any\",\n *       \"maxProperties\": 10\n *     }\n *   }\n * }\n * ```\n *\n * ### On class\n *\n * ```typescript\n * @MaxProperties(10)\n * class Model {\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"maxProperties\": 10\n * }\n * ```\n *\n * ### On Parameter\n *\n * ```typescript\n *\n * class Model {\n *   method(@Any() @MaxProperties(10) obj: any){}\n * }\n * ```\n *\n * @param {number} maxProperties The maximum properties allowed on the given object\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @collections\n */\nexport function MaxProperties(maxProperties: number) {\n  if (maxProperties < 0) {\n    throw new Error(\"The value of maxProperties MUST be a non-negative integer.\");\n  }\n\n  return JsonEntityFn((store) => {\n    store.isCollection ? store.schema.maxProperties(maxProperties) : store.itemSchema.maxProperties(maxProperties);\n  });\n}\n"]}

package/lib/esm/decorators/collections/minItems.js

@@ -0,0 +1,60 @@
+import { JsonEntityFn } from "../common/jsonEntityFn.js";
+/**
+ * An array instance is valid against `minItems` if its size is greater than, or equal to, the value of this keyword.
+ *
+ * ::: warning
+ * The value `minItems` MUST be a non-negative integer.
+ * :::
+ *
+ * ::: tip
+ * Omitting this keyword has the same behavior as a value of 0.
+ * :::
+ *
+ * ::: warning
+ * For v6 user, use @@MinItems@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(String)
+ *    @MinItems(10)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "minItems": 10,
+ *       "items": {
+ *         "type": "string"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} minItems
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export function MinItems(minItems) {
+    if (minItems < 0) {
+        throw new Error("The value of minItems MUST be a non-negative integer.");
+    }
+    return JsonEntityFn((storedJson) => {
+        storedJson.schema.minItems(minItems);
+    });
+}
+//# sourceMappingURL=minItems.js.map

package/lib/esm/decorators/collections/minItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minItems.js","sourceRoot":"","sources":["../../../../src/decorators/collections/minItems.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,UAAU,QAAQ,CAAC,QAAgB;IACvC,IAAI,QAAQ,GAAG,CAAC,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;KAC1E;IAED,OAAO,YAAY,CAAC,CAAC,UAAU,EAAE,EAAE;QACjC,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * An array instance is valid against `minItems` if its size is greater than, or equal to, the value of this keyword.\n *\n * ::: warning\n * The value `minItems` MUST be a non-negative integer.\n * :::\n *\n * ::: tip\n * Omitting this keyword has the same behavior as a value of 0.\n * :::\n *\n * ::: warning\n * For v6 user, use @@MinItems@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @CollectionOf(String)\n *    @MinItems(10)\n *    property: string[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"array\",\n *       \"minItems\": 10,\n *       \"items\": {\n *         \"type\": \"string\"\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * @param {number} minItems\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @collections\n */\nexport function MinItems(minItems: number) {\n  if (minItems < 0) {\n    throw new Error(\"The value of minItems MUST be a non-negative integer.\");\n  }\n\n  return JsonEntityFn((storedJson) => {\n    storedJson.schema.minItems(minItems);\n  });\n}\n"]}

package/lib/esm/decorators/collections/minProperties.js

@@ -0,0 +1,78 @@
+import { JsonEntityFn } from "../common/jsonEntityFn.js";
+/**
+ * An object instance is valid against `minProperties` if its number of properties is less than, or equal to, the value of this keyword.
+ *
+ * ::: warning
+ * The value of this keyword MUST be a non-negative integer.
+ * :::
+ *
+ * ::: warning
+ * For v6 user, use @@MinProperties@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### On prop
+ * ```typescript
+ * class Model {
+ *    @MinProperties(10)
+ *    property: any;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "any",
+ *       "minProperties": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### On class
+ *
+ * ```typescript
+ * @MinProperties(10)
+ * class Model {
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "minProperties": 10
+ * }
+ * ```
+ *
+ * ### On Parameter
+ *
+ * ```typescript
+ *
+ * class Model {
+ *   method(@Any() @MinProperties(10) obj: any){}
+ * }
+ * ```
+ *
+ * @param {number} minProperties The minimum properties allowed on the object.
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export function MinProperties(minProperties) {
+    if (minProperties < 0) {
+        throw new Error("The value of minProperties MUST be a non-negative integer.");
+    }
+    return JsonEntityFn((store) => {
+        store.isCollection ? store.schema.minProperties(minProperties) : store.itemSchema.minProperties(minProperties);
+    });
+}
+//# sourceMappingURL=minProperties.js.map

package/lib/esm/decorators/collections/minProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minProperties.js","sourceRoot":"","sources":["../../../../src/decorators/collections/minProperties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmEG;AACH,MAAM,UAAU,aAAa,CAAC,aAAqB;IACjD,IAAI,aAAa,GAAG,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;KAC/E;IAED,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;IACjH,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * An object instance is valid against `minProperties` if its number of properties is less than, or equal to, the value of this keyword.\n *\n * ::: warning\n * The value of this keyword MUST be a non-negative integer.\n * :::\n *\n * ::: warning\n * For v6 user, use @@MinProperties@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n * ### On prop\n * ```typescript\n * class Model {\n *    @MinProperties(10)\n *    property: any;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"any\",\n *       \"minProperties\": 10\n *     }\n *   }\n * }\n * ```\n *\n * ### On class\n *\n * ```typescript\n * @MinProperties(10)\n * class Model {\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"minProperties\": 10\n * }\n * ```\n *\n * ### On Parameter\n *\n * ```typescript\n *\n * class Model {\n *   method(@Any() @MinProperties(10) obj: any){}\n * }\n * ```\n *\n * @param {number} minProperties The minimum properties allowed on the object.\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @collections\n */\nexport function MinProperties(minProperties: number) {\n  if (minProperties < 0) {\n    throw new Error(\"The value of minProperties MUST be a non-negative integer.\");\n  }\n\n  return JsonEntityFn((store) => {\n    store.isCollection ? store.schema.minProperties(minProperties) : store.itemSchema.minProperties(minProperties);\n  });\n}\n"]}

package/lib/esm/decorators/collections/uniqueItems.js

@@ -0,0 +1,56 @@
+import { JsonEntityFn } from "../common/jsonEntityFn.js";
+/**
+ * If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.
+ *
+ * ::: warning
+ * For v6 user, use @@UniqueItems@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @UniqueItems()  // default true
+ *    property: number[];
+ * }
+ * ```
+ *
+ *  * ```typescript
+ * class Model {
+ *    @CollectionOf(String)
+ *    @UniqueItems()
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "uniqueItems": true,
+ *       "items": {
+ *         "type": "string"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {boolean} uniqueItems
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @collections
+ */
+export function UniqueItems(uniqueItems = true) {
+    return JsonEntityFn((store) => {
+        store.schema.uniqueItems(uniqueItems);
+    });
+}
+//# sourceMappingURL=uniqueItems.js.map

package/lib/esm/decorators/collections/uniqueItems.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uniqueItems.js","sourceRoot":"","sources":["../../../../src/decorators/collections/uniqueItems.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,MAAM,UAAU,WAAW,CAAC,cAAuB,IAAI;IACrD,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * If this keyword has boolean value false, the instance validates successfully. If it has boolean value true, the instance validates successfully if all of its elements are unique.\n *\n * ::: warning\n * For v6 user, use @@UniqueItems@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @UniqueItems()  // default true\n *    property: number[];\n * }\n * ```\n *\n *  * ```typescript\n * class Model {\n *    @CollectionOf(String)\n *    @UniqueItems()\n *    property: string[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"array\",\n *       \"uniqueItems\": true,\n *       \"items\": {\n *         \"type\": \"string\"\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * @param {boolean} uniqueItems\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @collections\n */\nexport function UniqueItems(uniqueItems: boolean = true) {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.schema.uniqueItems(uniqueItems);\n  });\n}\n"]}

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

@@ -0,0 +1,16 @@
+import { JsonEntityFn } from "./jsonEntityFn.js";
+/**
+ * Accept unknown properties on the deserialized model.
+ *
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+export function AdditionalProperties(schema) {
+    return JsonEntityFn((entity, parameters) => {
+        entity.itemSchema.additionalProperties(schema);
+    });
+}
+//# sourceMappingURL=additionalProperties.js.map

package/lib/esm/decorators/common/additionalProperties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"additionalProperties.js","sourceRoot":"","sources":["../../../../src/decorators/common/additionalProperties.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;GAQG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAA+B;IAClE,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;QACzC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {AnyJsonSchema} from \"../../domain/JsonSchema\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Accept unknown properties on the deserialized model.\n *\n * @param schema\n * @decorator\n * @validation\n * @swagger\n * @schema\n */\nexport function AdditionalProperties(schema: boolean | AnyJsonSchema) {\n  return JsonEntityFn((entity, parameters) => {\n    entity.itemSchema.additionalProperties(schema);\n  });\n}\n"]}

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

@@ -0,0 +1,18 @@
+import { JsonEntityFn } from "./jsonEntityFn.js";
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param allOf
+ */
+export function AllOf(...allOf) {
+    return JsonEntityFn((entity) => {
+        entity.itemSchema.allOf(allOf);
+    });
+}
+//# sourceMappingURL=allOf.js.map

package/lib/esm/decorators/common/allOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/allOf.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;GAUG;AACH,MAAM,UAAU,KAAK,CAAC,GAAG,KAAsB;IAC7C,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {AnyJsonSchema} from \"../../domain/JsonSchema\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @classDecorator\n * @input\n * @param allOf\n */\nexport function AllOf(...allOf: AnyJsonSchema[]) {\n  return JsonEntityFn((entity) => {\n    entity.itemSchema.allOf(allOf);\n  });\n}\n"]}

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

@@ -0,0 +1,43 @@
+import { DecoratorTypes, isClass, useDecorators } from "@tsed/core";
+import { JsonEntityFn } from "./jsonEntityFn.js";
+import { Property } from "./property.js";
+/**
+ * Add allowed values when the property or parameters is required.
+ *
+ * #### Example on parameter:
+ *
+ * ```typescript
+ * @Post("/")
+ * async method(@Allow("") @BodyParams("field") field: string) {}
+ * ```
+ * > Required will throw a BadRequest when the given value is `null` or `undefined` but not for an empty string.
+ *
+ * #### Example on model:
+ *
+ * ```typescript
+ * class Model {
+ *   @Allow("")
+ *   field: string;
+ * }
+ * ```
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export function Allow(...values) {
+    const model = values.find((item) => isClass(item));
+    return useDecorators(model && Property(model), JsonEntityFn((store, args) => {
+        store.schema.allow(...values);
+        if (store.decoratorType === DecoratorTypes.PARAM) {
+            store.required = true;
+        }
+        if (store.decoratorType === DecoratorTypes.PROP) {
+            store.parentSchema.addRequired(store.propertyName);
+        }
+    }));
+}
+//# sourceMappingURL=allow.js.map

package/lib/esm/decorators/common/allow.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"allow.js","sourceRoot":"","sources":["../../../../src/decorators/common/allow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAAE,OAAO,EAAE,aAAa,EAAC,MAAM,YAAY,CAAC;AAClE,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAGpC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,KAAK,CAAC,GAAG,MAAa;IACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IACnD,OAAO,aAAa,CAClB,KAAK,IAAI,QAAQ,CAAC,KAAK,CAAC,EACxB,YAAY,CAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3B,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC;QAE9B,IAAI,KAAK,CAAC,aAAa,KAAK,cAAc,CAAC,KAAK,EAAE;YAC/C,KAA4B,CAAC,QAAQ,GAAG,IAAI,CAAC;SAC/C;QAED,IAAI,KAAK,CAAC,aAAa,KAAK,cAAc,CAAC,IAAI,EAAE;YAC/C,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;SACpD;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC","sourcesContent":["import {DecoratorTypes, isClass, useDecorators} from \"@tsed/core\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\nimport {Property} from \"./property\";\nimport type {JsonParameterStore} from \"../../domain/JsonParameterStore\";\n\n/**\n * Add allowed values when the property or parameters is required.\n *\n * #### Example on parameter:\n *\n * ```typescript\n * @Post(\"/\")\n * async method(@Allow(\"\") @BodyParams(\"field\") field: string) {}\n * ```\n * > Required will throw a BadRequest when the given value is `null` or `undefined` but not for an empty string.\n *\n * #### Example on model:\n *\n * ```typescript\n * class Model {\n *   @Allow(\"\")\n *   field: string;\n * }\n * ```\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Allow(...values: any[]) {\n  const model = values.find((item) => isClass(item));\n  return useDecorators(\n    model && Property(model),\n    JsonEntityFn((store, args) => {\n      store.schema.allow(...values);\n\n      if (store.decoratorType === DecoratorTypes.PARAM) {\n        (store as JsonParameterStore).required = true;\n      }\n\n      if (store.decoratorType === DecoratorTypes.PROP) {\n        store.parentSchema.addRequired(store.propertyName);\n      }\n    })\n  );\n}\n"]}

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

@@ -0,0 +1,42 @@
+import { JsonEntityFn } from "./jsonEntityFn.js";
+/**
+ * Set the type of the array items.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Any()
+ *    property: any;
+ *
+ *    @Any(String, Number, Boolean)
+ *    property: string | number | boolean;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": ["integer", "number", "string", "boolean", "array", "object", "null"]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export function Any(...types) {
+    return JsonEntityFn((store) => {
+        store.itemSchema.any(...types);
+    });
+}
+//# sourceMappingURL=any.js.map

package/lib/esm/decorators/common/any.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"any.js","sourceRoot":"","sources":["../../../../src/decorators/common/any.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,UAAU,GAAG,CAAC,GAAG,KAAgD;IACrE,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {Type} from \"@tsed/core\";\nimport type {JSONSchema6TypeName} from \"json-schema\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Set the type of the array items.\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @Any()\n *    property: any;\n *\n *    @Any(String, Number, Boolean)\n *    property: string | number | boolean;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": [\"integer\", \"number\", \"string\", \"boolean\", \"array\", \"object\", \"null\"]\n *     }\n *   }\n * }\n * ```\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Any(...types: (JSONSchema6TypeName | Type<any> | any)[]) {\n  return JsonEntityFn((store) => {\n    store.itemSchema.any(...types);\n  });\n}\n"]}

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

@@ -0,0 +1,22 @@
+import { JsonEntityFn } from "./jsonEntityFn.js";
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
+ *
+ * ::: warning
+ * AnyOf isn't supported by OS2
+ * :::
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param anyOf
+ */
+export function AnyOf(...anyOf) {
+    return JsonEntityFn((entity) => {
+        entity.itemSchema.anyOf(anyOf);
+    });
+}
+//# sourceMappingURL=anyOf.js.map

package/lib/esm/decorators/common/anyOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"anyOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/anyOf.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,KAAK,CAAC,GAAG,KAAsB;IAC7C,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {AnyJsonSchema} from \"../../domain/JsonSchema\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27\n *\n * ::: warning\n * AnyOf isn't supported by OS2\n * :::\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @classDecorator\n * @input\n * @param anyOf\n */\nexport function AnyOf(...anyOf: AnyJsonSchema[]) {\n  return JsonEntityFn((entity) => {\n    entity.itemSchema.anyOf(anyOf);\n  });\n}\n"]}

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

@@ -0,0 +1,66 @@
+import { JsonEntityFn } from "./jsonEntityFn.js";
+/**
+ * The const keyword is used to restrict a value to a fixed value.
+ *
+ * ::: warning
+ * For v6 user, use @@Const@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With a string
+ *
+ * ```typescript
+ * class Model {
+ *    @Const("value1")
+ *    property: "value1";
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "const": "value1"
+ *     }
+ *   }
+ * }
+ * ```
+ *  * ### With a boolean
+ *
+ * ```typescript
+ * class Model {
+ *    @Const(true)
+ *    property: boolean;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "boolean",
+ *       "const": true
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string | number | boolean } constValue
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+export function Const(constValue) {
+    return JsonEntityFn((store) => {
+        store.itemSchema.const(constValue);
+    });
+}
+//# sourceMappingURL=const.js.map

package/lib/esm/decorators/common/const.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.js","sourceRoot":"","sources":["../../../../src/decorators/common/const.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,MAAM,UAAU,KAAK,CAAC,UAAiC;IACrD,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import type {JSONSchema6Type} from \"json-schema\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * The const keyword is used to restrict a value to a fixed value.\n *\n * ::: warning\n * For v6 user, use @@Const@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n * ### With a string\n *\n * ```typescript\n * class Model {\n *    @Const(\"value1\")\n *    property: \"value1\";\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"string\",\n *       \"const\": \"value1\"\n *     }\n *   }\n * }\n * ```\n *  * ### With a boolean\n *\n * ```typescript\n * class Model {\n *    @Const(true)\n *    property: boolean;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"boolean\",\n *       \"const\": true\n *     }\n *   }\n * }\n * ```\n *\n * @param {string | number | boolean } constValue\n * @decorator\n * @validation\n * @swagger\n * @schema\n */\nexport function Const(constValue: JSONSchema6Type | any) {\n  return JsonEntityFn((store) => {\n    store.itemSchema.const(constValue);\n  });\n}\n"]}

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

@@ -0,0 +1,38 @@
+import { JsonEntityFn } from "./jsonEntityFn.js";
+/**
+ * Set a custom key on JsonSchema that is not a part of the official spec.
+ *
+ * This custom key can only be displayed if the @@getJsonSchema@@ is called with `{customKeys: true}`.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export function CustomKey(key, value) {
+    return JsonEntityFn((store) => {
+        store.itemSchema.customKey(key, value);
+    });
+}
+/**
+ * Set a group of custom keys on JsonSchema that is not a part of the official spec.
+ *
+ * This custom key can only be displayed if the @@getJsonSchema@@ is called with `{customKeys: true}`.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export function CustomKeys(obj) {
+    return JsonEntityFn((store) => {
+        Object.entries(obj).forEach(([key, value]) => {
+            store.itemSchema.customKey(key, value);
+        });
+    });
+}
+//# sourceMappingURL=customKey.js.map

package/lib/esm/decorators/common/customKey.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customKey.js","sourceRoot":"","sources":["../../../../src/decorators/common/customKey.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,KAAU;IAC/C,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AACD;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,UAAU,CAAC,GAAwB;IACjD,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC3C,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Set a custom key on JsonSchema that is not a part of the official spec.\n *\n * This custom key can only be displayed if the @@getJsonSchema@@ is called with `{customKeys: true}`.\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @property\n * @parameter\n * @schema\n */\nexport function CustomKey(key: string, value: any) {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.itemSchema.customKey(key, value);\n  });\n}\n/**\n * Set a group of custom keys on JsonSchema that is not a part of the official spec.\n *\n * This custom key can only be displayed if the @@getJsonSchema@@ is called with `{customKeys: true}`.\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @property\n * @parameter\n * @schema\n */\nexport function CustomKeys(obj: Record<string, any>) {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    Object.entries(obj).forEach(([key, value]) => {\n      store.itemSchema.customKey(key, value);\n    });\n  });\n}\n"]}