@tsed/schema 6.88.0 → 6.91.0

package/lib/cjs/decorators/common/minimum.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Min = exports.Minimum = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * The value of `minimum` MUST be a number, representing an inclusive upper limit for a numeric instance.
+ *
+ * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to `minimum`.
+ *
+ * ::: warning
+ * This decorator will be removed in v7.
+ * For v6 user, use @@Minimum@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Minimum(10)
+ *    property: number;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "minimum": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Minimum(10)
+ *    @CollectionOf(Number)
+ *    property: number[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "number",
+ *          "minimum": 10
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} minimum The minimum value allowed
+ * @param {boolean} exclusive
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Minimum(minimum, exclusive = false) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        exclusive ? store.itemSchema.exclusiveMinimum(minimum) : store.itemSchema.minimum(minimum);
+    });
+}
+exports.Minimum = Minimum;
+/**
+ * The value of `minimum` MUST be a number, representing an inclusive upper limit for a numeric instance.
+ *
+ * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to `minimum`.
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Min(10)
+ *    property: number;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "minimum": 10
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @Min(10)
+ *    @CollectionOf(Number)
+ *    property: number[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "number",
+ *          "minimum": 10
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @alias Minimum
+ * @param minimum The minimum value allowed
+ * @param exclusive
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Min(minimum, exclusive = false) {
+    return Minimum(minimum, exclusive);
+}
+exports.Min = Min;
+//# sourceMappingURL=minimum.js.map

package/lib/cjs/decorators/common/minimum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"minimum.js","sourceRoot":"","sources":["../../../../src/decorators/common/minimum.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoEG;AACH,SAAgB,OAAO,CAAC,OAAe,EAAE,YAAqB,KAAK;IACjE,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IAC7F,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,0BAIC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgEG;AACH,SAAgB,GAAG,CAAC,OAAe,EAAE,YAAqB,KAAK;IAC7D,OAAO,OAAO,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;AACrC,CAAC;AAFD,kBAEC","sourcesContent":["import {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * The value of `minimum` MUST be a number, representing an inclusive upper limit for a numeric instance.\n *\n * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to `minimum`.\n *\n * ::: warning\n * This decorator will be removed in v7.\n * For v6 user, use @@Minimum@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n * ### With primitive type\n *\n * ```typescript\n * class Model {\n *    @Minimum(10)\n *    property: number;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"number\",\n *       \"minimum\": 10\n *     }\n *   }\n * }\n * ```\n *\n * ### With array type\n *\n * ```typescript\n * class Model {\n *    @Minimum(10)\n *    @CollectionOf(Number)\n *    property: number[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"array\",\n *       \"items\": {\n *          \"type\": \"number\",\n *          \"minimum\": 10\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * @param {number} minimum The minimum value allowed\n * @param {boolean} exclusive\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Minimum(minimum: number, exclusive: boolean = false) {\n  return JsonEntityFn((store) => {\n    exclusive ? store.itemSchema.exclusiveMinimum(minimum) : store.itemSchema.minimum(minimum);\n  });\n}\n\n/**\n * The value of `minimum` MUST be a number, representing an inclusive upper limit for a numeric instance.\n *\n * If the instance is a number, then this keyword validates only if the instance is greater than or exactly equal to `minimum`.\n *\n * ## Example\n * ### With primitive type\n *\n * ```typescript\n * class Model {\n *    @Min(10)\n *    property: number;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"number\",\n *       \"minimum\": 10\n *     }\n *   }\n * }\n * ```\n *\n * ### With array type\n *\n * ```typescript\n * class Model {\n *    @Min(10)\n *    @CollectionOf(Number)\n *    property: number[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"array\",\n *       \"items\": {\n *          \"type\": \"number\",\n *          \"minimum\": 10\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * @alias Minimum\n * @param minimum The minimum value allowed\n * @param exclusive\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Min(minimum: number, exclusive: boolean = false) {\n  return Minimum(minimum, exclusive);\n}\n"]}

package/lib/cjs/decorators/common/multipleOf.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MultipleOf = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * A numeric instance is valid only if division by this keyword's value results in an integer.
+ *
+ * ::: warning
+ * The value of `multipleOf` MUST be a number, strictly greater than 0.
+ * :::
+ *
+ * ::: warning
+ * For v6 user, use @@MultipleOf@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @MultipleOf(2)
+ *    property: Number;
+ * }
+ * ```
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "number",
+ *       "multipleOf": 2
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(number)
+ *    @MultipleOf(2)
+ *    property: number[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *          "type": "number",
+ *          "multipleOf": 2
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {number} multipleOf The multiple value allowed
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function MultipleOf(multipleOf) {
+    if (multipleOf <= 0) {
+        throw new Error("The value of multipleOf MUST be a number, strictly greater than 0.");
+    }
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.multipleOf(multipleOf);
+    });
+}
+exports.MultipleOf = MultipleOf;
+//# sourceMappingURL=multipleOf.js.map

package/lib/cjs/decorators/common/multipleOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multipleOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/multipleOf.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,SAAgB,UAAU,CAAC,UAAkB;IAC3C,IAAI,UAAU,IAAI,CAAC,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;KACvF;IAED,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC;AARD,gCAQC","sourcesContent":["import {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * A numeric instance is valid only if division by this keyword's value results in an integer.\n *\n * ::: warning\n * The value of `multipleOf` MUST be a number, strictly greater than 0.\n * :::\n *\n * ::: warning\n * For v6 user, use @@MultipleOf@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n * ### With primitive type\n *\n * ```typescript\n * class Model {\n *    @MultipleOf(2)\n *    property: Number;\n * }\n * ```\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"number\",\n *       \"multipleOf\": 2\n *     }\n *   }\n * }\n * ```\n *\n * ### With array type\n *\n * ```typescript\n * class Model {\n *    @CollectionOf(number)\n *    @MultipleOf(2)\n *    property: number[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"array\",\n *       \"items\": {\n *          \"type\": \"number\",\n *          \"multipleOf\": 2\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * @param {number} multipleOf The multiple value allowed\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function MultipleOf(multipleOf: number) {\n  if (multipleOf <= 0) {\n    throw new Error(\"The value of multipleOf MUST be a number, strictly greater than 0.\");\n  }\n\n  return JsonEntityFn((store) => {\n    store.itemSchema.multipleOf(multipleOf);\n  });\n}\n"]}

package/lib/cjs/decorators/common/name.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Name = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Add a name metadata on the decorated element.
+ *
+ * ## Examples
+ * ### On parameters
+ *
+ * ```typescript
+ * async myMethod(@Name("nameOf") @PathParams("id") id: string): Promise<Model>  {
+ *
+ * }
+ * ```
+ *
+ * ### On parameters
+ *
+ * ```typescript
+ * @Name("AliasName")
+ * @Controller("/")
+ * class ModelCtrl {
+ *
+ * }
+ * ```
+ *
+ * @param name
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @classDecorator
+ * @operation
+ */
+function Name(name) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        switch ((0, core_1.decoratorTypeOf)(args)) {
+            case core_1.DecoratorTypes.CLASS:
+                store.schema.name(name);
+                break;
+            case core_1.DecoratorTypes.PARAM:
+                store.parameter.name(name);
+                break;
+            default:
+                store.parent.schema.addAlias(args[1], name);
+        }
+    });
+}
+exports.Name = Name;
+//# sourceMappingURL=name.js.map

package/lib/cjs/decorators/common/name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"name.js","sourceRoot":"","sources":["../../../../src/decorators/common/name.ts"],"names":[],"mappings":";;;AAAA,qCAAgF;AAEhF,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,SAAgB,IAAI,CAAC,IAAS;IAC5B,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,IAAyB,EAAE,EAAE;QACxE,QAAQ,IAAA,sBAAe,EAAC,IAAI,CAAC,EAAE;YAC7B,KAAK,qBAAc,CAAC,KAAK;gBACvB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxB,MAAM;YACR,KAAK,qBAAc,CAAC,KAAK;gBACvB,KAAK,CAAC,SAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBAC5B,MAAM;YACR;gBACE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;SAC/C;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAbD,oBAaC","sourcesContent":["import {DecoratorParameters, decoratorTypeOf, DecoratorTypes} from \"@tsed/core\";\nimport {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Add a name metadata on the decorated element.\n *\n * ## Examples\n * ### On parameters\n *\n * ```typescript\n * async myMethod(@Name(\"nameOf\") @PathParams(\"id\") id: string): Promise<Model>  {\n *\n * }\n * ```\n *\n * ### On parameters\n *\n * ```typescript\n * @Name(\"AliasName\")\n * @Controller(\"/\")\n * class ModelCtrl {\n *\n * }\n * ```\n *\n * @param name\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @classDecorator\n * @operation\n */\nexport function Name(name: any) {\n  return JsonEntityFn((store: JsonEntityStore, args: DecoratorParameters) => {\n    switch (decoratorTypeOf(args)) {\n      case DecoratorTypes.CLASS:\n        store.schema.name(name);\n        break;\n      case DecoratorTypes.PARAM:\n        store.parameter!.name(name);\n        break;\n      default:\n        store.parent.schema.addAlias(args[1], name);\n    }\n  });\n}\n"]}

package/lib/{decorators → cjs/decorators}/common/nullable.d.ts

@@ -1,5 +1,5 @@
 import { Type } from "@tsed/core";
-import { JSONSchema6TypeName } from "json-schema";
+import type { JSONSchema6TypeName } from "json-schema";
 /**
  * Set field as nullable.
  *

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Nullable = void 0;
+const core_1 = require("@tsed/core");
+const any_1 = require("./any");
+const property_1 = require("./property");
+/**
+ * Set field as nullable.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Nullable(Date)
+ *    property: Date | null;
+ *
+ *    @Nullable(String, Number, Boolean)
+ *    property: string | number | boolean | null;
+ * }
+ * ```
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Nullable(type, ...types) {
+    types = [type, ...types];
+    return (0, core_1.useDecorators)(types.length === 1 && (0, property_1.Property)(types[0]), (0, any_1.Any)(null, ...types));
+}
+exports.Nullable = Nullable;
+//# sourceMappingURL=nullable.js.map

package/lib/cjs/decorators/common/nullable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nullable.js","sourceRoot":"","sources":["../../../../src/decorators/common/nullable.ts"],"names":[],"mappings":";;;AAAA,qCAA+C;AAE/C,+BAA0B;AAC1B,yCAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,QAAQ,CAAC,IAA2C,EAAE,GAAG,KAAgD;IACvH,KAAK,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC;IACzB,OAAO,IAAA,oBAAa,EAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,IAAA,mBAAQ,EAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,IAAA,SAAG,EAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AACtF,CAAC;AAHD,4BAGC","sourcesContent":["import {Type, useDecorators} from \"@tsed/core\";\nimport type {JSONSchema6TypeName} from \"json-schema\";\nimport {Any} from \"./any\";\nimport {Property} from \"./property\";\n\n/**\n * Set field as nullable.\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @Nullable(Date)\n *    property: Date | null;\n *\n *    @Nullable(String, Number, Boolean)\n *    property: string | number | boolean | null;\n * }\n * ```\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Nullable(type: JSONSchema6TypeName | Type<any> | any, ...types: (JSONSchema6TypeName | Type<any> | any)[]) {\n  types = [type, ...types];\n  return useDecorators(types.length === 1 && Property(types[0]), Any(null, ...types));\n}\n"]}

package/lib/cjs/decorators/common/oneOf.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OneOf = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.28
+ *
+ * ::: warning
+ * OneOf isn't supported by OS2
+ * :::
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param oneOf
+ */
+function OneOf(...oneOf) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        entity.itemSchema.oneOf(oneOf);
+    });
+}
+exports.OneOf = OneOf;
+//# sourceMappingURL=oneOf.js.map

package/lib/cjs/decorators/common/oneOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"oneOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/oneOf.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;;;;;;GAcG;AACH,SAAgB,KAAK,CAAC,GAAG,KAAsB;IAC7C,OAAO,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,sBAIC","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.28\n *\n * ::: warning\n * OneOf isn't supported by OS2\n * :::\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @classDecorator\n * @input\n * @param oneOf\n */\nexport function OneOf(...oneOf: AnyJsonSchema[]) {\n  return JsonEntityFn((entity) => {\n    entity.itemSchema.oneOf(oneOf);\n  });\n}\n"]}

package/lib/cjs/decorators/common/optional.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Optional = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Add optional annotation on Property or Parameter.
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Optional() {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        switch (store.decoratorType) {
+            case core_1.DecoratorTypes.PARAM:
+                store.required = false;
+                break;
+            case core_1.DecoratorTypes.PROP:
+                store.parentSchema.removeRequired(store.propertyName);
+                break;
+        }
+    });
+}
+exports.Optional = Optional;
+//# sourceMappingURL=optional.js.map

package/lib/cjs/decorators/common/optional.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"optional.js","sourceRoot":"","sources":["../../../../src/decorators/common/optional.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,iDAA4C;AAG5C;;;;;;;;GAQG;AACH,SAAgB,QAAQ;IACtB,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,QAAQ,KAAK,CAAC,aAAa,EAAE;YAC3B,KAAK,qBAAc,CAAC,KAAK;gBACtB,KAA4B,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAC/C,MAAM;YACR,KAAK,qBAAc,CAAC,IAAI;gBACtB,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBACtD,MAAM;SACT;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAXD,4BAWC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\nimport type {JsonParameterStore} from \"../../domain/JsonParameterStore\";\n\n/**\n * Add optional annotation on Property or Parameter.\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Optional() {\n  return JsonEntityFn((store) => {\n    switch (store.decoratorType) {\n      case DecoratorTypes.PARAM:\n        (store as JsonParameterStore).required = false;\n        break;\n      case DecoratorTypes.PROP:\n        store.parentSchema.removeRequired(store.propertyName);\n        break;\n    }\n  });\n}\n"]}

package/lib/cjs/decorators/common/pattern.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Pattern = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * The pattern and Pattern Properties keywords use regular expressions to express constraints.
+ * The regular expression syntax used is from JavaScript (ECMA 262, specifically). However, that complete syntax is not widely supported, therefore it is recommended that you stick to the subset of that syntax described below.
+ *
+ * ::: warning
+ * For v6 user, use @@Pattern@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * A single unicode character (other than the special characters below) matches itself.
+ *
+ * * `^`: Matches only at the beginning of the string.
+ * * `$`: Matches only at the end of the string.
+ * * `(...)`: Group a series of regular expressions into a single regular expression.
+ * * `|`: Matches either the regular expression preceding or following the | symbol.
+ * * `[abc]`: Matches any of the characters inside the square brackets.
+ * * `[a-z]`: Matches the range of characters.
+ * * `[^abc]`: Matches any character not listed.
+ * * `[^a-z]`: Matches any character outside of the range.
+ * * `+`: Matches one or more repetitions of the preceding regular expression.
+ * * `*`: Matches zero or more repetitions of the preceding regular expression.
+ * * `?`: Matches zero or one repetitions of the preceding regular expression.
+ * * `+?`, *?`, ??`: The `*`, `+`, and `?` qualifiers are all greedy; they match as much text as possible. Sometimes this behavior isn’t desired and you want to match as few characters as possible.
+ * * `{x}`: Match exactly x occurrences of the preceding regular expression.
+ * * `{x,y}`: Match at least x and at most y occurrences of the preceding regular expression.
+ * * `{x,}`: Match x occurrences or more of the preceding regular expression.
+ * * `{x}?`, {x,y}?, {x,}?`: Lazy versions of the above expressions.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Pattern("^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$")
+ *    @Pattern(/^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$/)
+ *    property: string;
+ * }
+ * ```
+ *
+ * ### With primitive type
+ *
+ * ```typescript
+ * class Model {
+ *    @Pattern(/^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$/)
+ *    property: string;
+ * }
+ * ```
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "pattern": "^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * ### With array type
+ *
+ * ```typescript
+ * class Model {
+ *    @CollectionOf(string)
+ *    @Pattern(/^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$/)
+ *    property: string[];
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "array",
+ *       "items": {
+ *         "type": "string",
+ *         "pattern": "^(\\([0-9]{3}\\))?[0-9]{3}-[0-9]{4}$"
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string} pattern
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Pattern(pattern) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.pattern(pattern);
+    });
+}
+exports.Pattern = Pattern;
+//# sourceMappingURL=pattern.js.map

package/lib/cjs/decorators/common/pattern.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern.js","sourceRoot":"","sources":["../../../../src/decorators/common/pattern.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,SAAgB,OAAO,CAAC,OAAwB;IAC9C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,0BAIC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * The pattern and Pattern Properties keywords use regular expressions to express constraints.\n * The regular expression syntax used is from JavaScript (ECMA 262, specifically). However, that complete syntax is not widely supported, therefore it is recommended that you stick to the subset of that syntax described below.\n *\n * ::: warning\n * For v6 user, use @@Pattern@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * A single unicode character (other than the special characters below) matches itself.\n *\n * * `^`: Matches only at the beginning of the string.\n * * `$`: Matches only at the end of the string.\n * * `(...)`: Group a series of regular expressions into a single regular expression.\n * * `|`: Matches either the regular expression preceding or following the | symbol.\n * * `[abc]`: Matches any of the characters inside the square brackets.\n * * `[a-z]`: Matches the range of characters.\n * * `[^abc]`: Matches any character not listed.\n * * `[^a-z]`: Matches any character outside of the range.\n * * `+`: Matches one or more repetitions of the preceding regular expression.\n * * `*`: Matches zero or more repetitions of the preceding regular expression.\n * * `?`: Matches zero or one repetitions of the preceding regular expression.\n * * `+?`, *?`, ??`: The `*`, `+`, and `?` qualifiers are all greedy; they match as much text as possible. Sometimes this behavior isn’t desired and you want to match as few characters as possible.\n * * `{x}`: Match exactly x occurrences of the preceding regular expression.\n * * `{x,y}`: Match at least x and at most y occurrences of the preceding regular expression.\n * * `{x,}`: Match x occurrences or more of the preceding regular expression.\n * * `{x}?`, {x,y}?, {x,}?`: Lazy versions of the above expressions.\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @Pattern(\"^(\\\\([0-9]{3}\\\\))?[0-9]{3}-[0-9]{4}$\")\n *    @Pattern(/^(\\\\([0-9]{3}\\\\))?[0-9]{3}-[0-9]{4}$/)\n *    property: string;\n * }\n * ```\n *\n * ### With primitive type\n *\n * ```typescript\n * class Model {\n *    @Pattern(/^(\\\\([0-9]{3}\\\\))?[0-9]{3}-[0-9]{4}$/)\n *    property: string;\n * }\n * ```\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"string\",\n *       \"pattern\": \"^(\\\\([0-9]{3}\\\\))?[0-9]{3}-[0-9]{4}$\"\n *     }\n *   }\n * }\n * ```\n *\n * ### With array type\n *\n * ```typescript\n * class Model {\n *    @CollectionOf(string)\n *    @Pattern(/^(\\\\([0-9]{3}\\\\))?[0-9]{3}-[0-9]{4}$/)\n *    property: string[];\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"array\",\n *       \"items\": {\n *         \"type\": \"string\",\n *         \"pattern\": \"^(\\\\([0-9]{3}\\\\))?[0-9]{3}-[0-9]{4}$\"\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * @param {string} pattern\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Pattern(pattern: string | RegExp) {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.itemSchema.pattern(pattern);\n  });\n}\n"]}

package/lib/cjs/decorators/common/property.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Property = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Declare a new property on a model.
+ *
+ * @param type
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Property(type) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        if (type) {
+            if ((0, core_1.isClass)(type)) {
+                store.type = type;
+            }
+            store.itemSchema.type(type);
+        }
+    });
+}
+exports.Property = Property;
+//# sourceMappingURL=property.js.map

package/lib/cjs/decorators/common/property.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"property.js","sourceRoot":"","sources":["../../../../src/decorators/common/property.ts"],"names":[],"mappings":";;;AAAA,qCAAmC;AACnC,iDAA4C;AAE5C;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,IAAU;IACjC,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,IAAI,IAAI,EAAE;YACR,IAAI,IAAA,cAAO,EAAC,IAAI,CAAC,EAAE;gBACjB,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;aACnB;YACD,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SAC7B;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AATD,4BASC","sourcesContent":["import {isClass} from \"@tsed/core\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Declare a new property on a model.\n *\n * @param type\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Property(type?: any) {\n  return JsonEntityFn((store) => {\n    if (type) {\n      if (isClass(type)) {\n        store.type = type;\n      }\n      store.itemSchema.type(type);\n    }\n  });\n}\n"]}

package/lib/cjs/decorators/common/readOnly.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReadOnly = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Set the property as readOnly.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+function ReadOnly(readOnly = true) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.readOnly(readOnly);
+    });
+}
+exports.ReadOnly = ReadOnly;
+//# sourceMappingURL=readOnly.js.map

package/lib/cjs/decorators/common/readOnly.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"readOnly.js","sourceRoot":"","sources":["../../../../src/decorators/common/readOnly.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAC5C;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,WAAoB,IAAI;IAC/C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,4BAIC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n/**\n * Set the property as readOnly.\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @property\n * @parameter\n * @schema\n */\nexport function ReadOnly(readOnly: boolean = true) {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.itemSchema.readOnly(readOnly);\n  });\n}\n"]}

package/lib/cjs/decorators/common/required.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Required = void 0;
+const allow_1 = require("./allow");
+const optional_1 = require("./optional");
+/**
+ * Add required annotation on Property or Parameter.
+ *
+ * The @@Required@@ decorator can be used on two cases.
+ *
+ * To decorate a parameters:
+ *
+ * ```typescript
+ * @Post("/")
+ * async method(@Required() @BodyParams("field") field: string) {}
+ * ```
+ *
+ * To decorate a model:
+ *
+ * ```typescript
+ * class Model {
+ *   @Required()
+ *   field: string;
+ * }
+ * ```
+ *
+ * ::: tip
+ * Required will throw a BadRequest when the given value is `null`, an empty string or `undefined`.
+ * :::
+ *
+ * ### Allow values
+ *
+ * In some case, you didn't want trigger a BadRequest when the value is an empty string for example.
+ * The decorator `@Allow()`, allow you to configure a value list for which there will be no exception.
+ *
+ * ```typescript
+ * class Model {
+ *   @Allow("") // add automatically required flag
+ *   field: string;
+ * }
+ * ```
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Required(required = true, ...allowedRequiredValues) {
+    return required ? (0, allow_1.Allow)(...allowedRequiredValues) : (0, optional_1.Optional)();
+}
+exports.Required = Required;
+//# sourceMappingURL=required.js.map