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

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

@@ -0,0 +1,77 @@
+import { JsonEntityFn } from "./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
+ */
+export function MultipleOf(multipleOf) {
+    if (multipleOf <= 0) {
+        throw new Error("The value of multipleOf MUST be a number, strictly greater than 0.");
+    }
+    return JsonEntityFn((store) => {
+        store.itemSchema.multipleOf(multipleOf);
+    });
+}
+//# sourceMappingURL=multipleOf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"multipleOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/multipleOf.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkEG;AACH,MAAM,UAAU,UAAU,CAAC,UAAkB;IAC3C,IAAI,UAAU,IAAI,CAAC,EAAE;QACnB,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAC;KACvF;IAED,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;IAC1C,CAAC,CAAC,CAAC;AACL,CAAC","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/esm/decorators/common/name.js

@@ -0,0 +1,48 @@
+import { decoratorTypeOf, DecoratorTypes } from "@tsed/core";
+import { JsonEntityFn } from "../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
+ */
+export function Name(name) {
+    return JsonEntityFn((store, args) => {
+        switch (decoratorTypeOf(args)) {
+            case DecoratorTypes.CLASS:
+                store.schema.name(name);
+                break;
+            case DecoratorTypes.PARAM:
+                store.parameter.name(name);
+                break;
+            default:
+                store.parent.schema.addAlias(args[1], name);
+        }
+    });
+}
+//# sourceMappingURL=name.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"name.js","sourceRoot":"","sources":["../../../../src/decorators/common/name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,eAAe,EAAE,cAAc,EAAC,MAAM,YAAY,CAAC;AAEhF,OAAO,EAAC,YAAY,EAAC,MAAM,wBAAwB,CAAC;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,IAAI,CAAC,IAAS;IAC5B,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,IAAyB,EAAE,EAAE;QACxE,QAAQ,eAAe,CAAC,IAAI,CAAC,EAAE;YAC7B,KAAK,cAAc,CAAC,KAAK;gBACvB,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACxB,MAAM;YACR,KAAK,cAAc,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","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/esm/decorators/common/nullable.js

@@ -0,0 +1,30 @@
+import { useDecorators } from "@tsed/core";
+import { Any } from "./any";
+import { Property } from "./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
+ */
+export function Nullable(type, ...types) {
+    types = [type, ...types];
+    return useDecorators(types.length === 1 && Property(types[0]), Any(null, ...types));
+}
+//# sourceMappingURL=nullable.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"nullable.js","sourceRoot":"","sources":["../../../../src/decorators/common/nullable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAO,aAAa,EAAC,MAAM,YAAY,CAAC;AAE/C,OAAO,EAAC,GAAG,EAAC,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,QAAQ,CAAC,IAA2C,EAAE,GAAG,KAAgD;IACvH,KAAK,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC;IACzB,OAAO,aAAa,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AACtF,CAAC","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/esm/decorators/common/oneOf.js

@@ -0,0 +1,23 @@
+import { JsonEntityFn } from "./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
+ */
+export function OneOf(...oneOf) {
+    return JsonEntityFn((entity) => {
+        entity.itemSchema.oneOf(oneOf);
+        entity.type = Object;
+    });
+}
+//# sourceMappingURL=oneOf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"oneOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/oneOf.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;QAC/B,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;IACvB,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.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    entity.type = Object;\n  });\n}\n"]}

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

@@ -0,0 +1,24 @@
+import { DecoratorTypes } from "@tsed/core";
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Add optional annotation on Property or Parameter.
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export function Optional() {
+    return JsonEntityFn((store) => {
+        switch (store.decoratorType) {
+            case DecoratorTypes.PARAM:
+                store.required = false;
+                break;
+            case DecoratorTypes.PROP:
+                store.parentSchema.removeRequired(store.propertyName);
+                break;
+        }
+    });
+}
+//# sourceMappingURL=optional.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"optional.js","sourceRoot":"","sources":["../../../../src/decorators/common/optional.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,cAAc,EAA2B,MAAM,YAAY,CAAC;AACpE,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAG5C;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,QAAQ,KAAK,CAAC,aAAa,EAAE;YAC3B,KAAK,cAAc,CAAC,KAAK;gBACtB,KAA4B,CAAC,QAAQ,GAAG,KAAK,CAAC;gBAC/C,MAAM;YACR,KAAK,cAAc,CAAC,IAAI;gBACtB,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBACtD,MAAM;SACT;IACH,CAAC,CAAC,CAAC;AACL,CAAC","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/esm/decorators/common/pattern.js

@@ -0,0 +1,99 @@
+import { JsonEntityFn } from "./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
+ */
+export function Pattern(pattern) {
+    return JsonEntityFn((store) => {
+        store.itemSchema.pattern(pattern);
+    });
+}
+//# sourceMappingURL=pattern.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"pattern.js","sourceRoot":"","sources":["../../../../src/decorators/common/pattern.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2FG;AACH,MAAM,UAAU,OAAO,CAAC,OAAwB;IAC9C,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACL,CAAC","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/esm/decorators/common/property.js

@@ -0,0 +1,23 @@
+import { isClass } from "@tsed/core";
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Declare a new property on a model.
+ *
+ * @param type
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export function Property(type) {
+    return JsonEntityFn((store) => {
+        if (type) {
+            if (isClass(type)) {
+                store.type = type;
+            }
+            store.itemSchema.type(type);
+        }
+    });
+}
+//# sourceMappingURL=property.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"property.js","sourceRoot":"","sources":["../../../../src/decorators/common/property.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,OAAO,EAAC,MAAM,YAAY,CAAC;AACnC,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAU;IACjC,OAAO,YAAY,CAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,IAAI,IAAI,EAAE;YACR,IAAI,OAAO,CAAC,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","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/esm/decorators/common/readOnly.js

@@ -0,0 +1,17 @@
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Set the property as readOnly.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export function ReadOnly(readOnly = true) {
+    return JsonEntityFn((store) => {
+        store.itemSchema.readOnly(readOnly);
+    });
+}
+//# sourceMappingURL=readOnly.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"readOnly.js","sourceRoot":"","sources":["../../../../src/decorators/common/readOnly.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CAAC,WAAoB,IAAI;IAC/C,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC","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/esm/decorators/common/required.js

@@ -0,0 +1,49 @@
+import { Allow } from "./allow";
+import { Optional } from "./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
+ */
+export function Required(required = true, ...allowedRequiredValues) {
+    return required ? Allow(...allowedRequiredValues) : Optional();
+}
+//# sourceMappingURL=required.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"required.js","sourceRoot":"","sources":["../../../../src/decorators/common/required.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,MAAM,UAAU,QAAQ,CAAC,WAAoB,IAAI,EAAE,GAAG,qBAA4B;IAChF,OAAO,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;AACjE,CAAC","sourcesContent":["import {Allow} from \"./allow\";\nimport {Optional} from \"./optional\";\n\n/**\n * Add required annotation on Property or Parameter.\n *\n * The @@Required@@ decorator can be used on two cases.\n *\n * To decorate a parameters:\n *\n * ```typescript\n * @Post(\"/\")\n * async method(@Required() @BodyParams(\"field\") field: string) {}\n * ```\n *\n * To decorate a model:\n *\n * ```typescript\n * class Model {\n *   @Required()\n *   field: string;\n * }\n * ```\n *\n * ::: tip\n * Required will throw a BadRequest when the given value is `null`, an empty string or `undefined`.\n * :::\n *\n * ### Allow values\n *\n * In some case, you didn't want trigger a BadRequest when the value is an empty string for example.\n * The decorator `@Allow()`, allow you to configure a value list for which there will be no exception.\n *\n * ```typescript\n * class Model {\n *   @Allow(\"\") // add automatically required flag\n *   field: string;\n * }\n * ```\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Required(required: boolean = true, ...allowedRequiredValues: any[]) {\n  return required ? Allow(...allowedRequiredValues) : Optional();\n}\n"]}

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

@@ -0,0 +1,22 @@
+import { matchGroups } from "../../utils/matchGroups";
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Apply groups validation strategy for required property.
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+export function RequiredGroups(...groups) {
+    return JsonEntityFn((entity) => {
+        entity.parent.schema.$hooks.on("requiredGroups", (required, givenGroups) => {
+            if (matchGroups(groups, givenGroups)) {
+                return required.filter((key) => key !== entity.propertyKey);
+            }
+            return required;
+        });
+    });
+}
+//# sourceMappingURL=requiredGroups.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requiredGroups.js","sourceRoot":"","sources":["../../../../src/decorators/common/requiredGroups.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,WAAW,EAAC,MAAM,yBAAyB,CAAC;AACpD,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,GAAG,MAAgB;IAChD,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,QAAkB,EAAE,WAAqB,EAAE,EAAE;YAC7F,IAAI,WAAW,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE;gBACpC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC,WAAW,CAAC,CAAC;aACrE;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {matchGroups} from \"../../utils/matchGroups\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Apply groups validation strategy for required property.\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function RequiredGroups(...groups: string[]): PropertyDecorator {\n  return JsonEntityFn((entity) => {\n    entity.parent.schema.$hooks.on(\"requiredGroups\", (required: string[], givenGroups: string[]) => {\n      if (matchGroups(groups, givenGroups)) {\n        return required.filter((key: string) => key !== entity.propertyKey);\n      }\n\n      return required;\n    });\n  });\n}\n"]}

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

@@ -0,0 +1,63 @@
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Write data formatted to JsonSchema.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * @Schema({title: "test"})
+ * class Model {
+ *    @Schema({formatMinimum: "1987-10-24"})
+ *    @Format("date")
+ *    birthDate: Date
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "title": "test",
+ *   "properties": {
+ *     "birthdate": {
+ *        "type": "string",
+ *        "format": "date",
+ *        "formatMinimum": "1987-10-24"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param partialSchema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export function Schema(partialSchema) {
+    return JsonEntityFn((entity) => {
+        Object.entries(partialSchema).forEach(([key, value]) => {
+            entity.schema.set(key, value);
+        });
+    });
+}
+/**
+ * Apply specific schema depending on the spec version
+ * @param specType
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export function For(specType, schema) {
+    return JsonEntityFn((entity) => {
+        entity.schema.set(specType, schema);
+    });
+}
+//# sourceMappingURL=schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/decorators/common/schema.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,MAAM,CAAC,aAAqD;IAC1E,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YACrD,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;QAChC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,GAAG,CAAC,QAAmB,EAAE,MAAW;IAClD,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonSchema, JsonSchemaObject} from \"../../domain/JsonSchema\";\nimport {SpecTypes} from \"../../domain/SpecTypes\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Write data formatted to JsonSchema.\n *\n * ## Example\n *\n * ```typescript\n * @Schema({title: \"test\"})\n * class Model {\n *    @Schema({formatMinimum: \"1987-10-24\"})\n *    @Format(\"date\")\n *    birthDate: Date\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"title\": \"test\",\n *   \"properties\": {\n *     \"birthdate\": {\n *        \"type\": \"string\",\n *        \"format\": \"date\",\n *        \"formatMinimum\": \"1987-10-24\"\n *     }\n *   }\n * }\n * ```\n *\n * @param partialSchema\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @classDecorator\n * @input\n */\nexport function Schema(partialSchema: Partial<JsonSchemaObject> | JsonSchema) {\n  return JsonEntityFn((entity) => {\n    Object.entries(partialSchema).forEach(([key, value]) => {\n      entity.schema.set(key, value);\n    });\n  });\n}\n\n/**\n * Apply specific schema depending on the spec version\n * @param specType\n * @param schema\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @classDecorator\n * @input\n */\nexport function For(specType: SpecTypes, schema: any) {\n  return JsonEntityFn((entity) => {\n    entity.schema.set(specType, schema);\n  });\n}\n"]}

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

@@ -0,0 +1,45 @@
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Add title metadata on the decorated element.
+ *
+ * ::: warning
+ * For v6 user, use @@Title@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Title("title")
+ *    id: string;
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "id": {
+ *        "type": "string",
+ *        "title": "title"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string} title
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+export function Title(title) {
+    return JsonEntityFn((entity) => {
+        entity.schema.title(title);
+    });
+}
+//# sourceMappingURL=title.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"title.js","sourceRoot":"","sources":["../../../../src/decorators/common/title.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,MAAM,UAAU,KAAK,CAAC,KAAa;IACjC,OAAO,YAAY,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Add title metadata on the decorated element.\n *\n * ::: warning\n * For v6 user, use @@Title@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @Title(\"title\")\n *    id: string;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"id\": {\n *        \"type\": \"string\",\n *        \"title\": \"title\"\n *     }\n *   }\n * }\n * ```\n *\n * @param {string} title\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @classDecorator\n * @input\n */\nexport function Title(title: string) {\n  return JsonEntityFn((entity) => {\n    entity.schema.title(title);\n  });\n}\n"]}

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

@@ -0,0 +1,17 @@
+import { JsonEntityFn } from "./jsonEntityFn";
+/**
+ * Set the property as WriteOnly.
+ *
+ * @returns {Function}
+ * @decorator
+ * @validation
+ * @property
+ * @parameter
+ * @schema
+ */
+export function WriteOnly(writeOnly = true) {
+    return JsonEntityFn((store) => {
+        store.itemSchema.writeOnly(writeOnly);
+    });
+}
+//# sourceMappingURL=writeOnly.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"writeOnly.js","sourceRoot":"","sources":["../../../../src/decorators/common/writeOnly.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,YAAY,EAAC,MAAM,gBAAgB,CAAC;AAC5C;;;;;;;;;GASG;AACH,MAAM,UAAU,SAAS,CAAC,YAAqB,IAAI;IACjD,OAAO,YAAY,CAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n/**\n * Set the property as WriteOnly.\n *\n * @returns {Function}\n * @decorator\n * @validation\n * @property\n * @parameter\n * @schema\n */\nexport function WriteOnly(writeOnly: boolean = true) {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.itemSchema.writeOnly(writeOnly);\n  });\n}\n"]}

package/lib/esm/decorators/config/jsonEntityComponent.js

@@ -0,0 +1,14 @@
+import { JsonEntitiesContainer } from "../../domain/JsonEntityStore";
+/**
+ * Declare a new JsonEntityStore class for a specific decorator type.
+ *
+ * @ignore
+ * @param type
+ * @decorator
+ */
+export function JsonEntityComponent(type) {
+    return (target) => {
+        JsonEntitiesContainer.set(type, target);
+    };
+}
+//# sourceMappingURL=jsonEntityComponent.js.map

package/lib/esm/decorators/config/jsonEntityComponent.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonEntityComponent.js","sourceRoot":"","sources":["../../../../src/decorators/config/jsonEntityComponent.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,qBAAqB,EAAC,MAAM,8BAA8B,CAAC;AAEpF;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAoB;IACtD,OAAO,CAAC,MAA6B,EAAE,EAAE;QACvC,qBAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC,CAAC;AACJ,CAAC","sourcesContent":["import {DecoratorTypes, Type} from \"@tsed/core\";\nimport {JsonEntityStore, JsonEntitiesContainer} from \"../../domain/JsonEntityStore\";\n\n/**\n * Declare a new JsonEntityStore class for a specific decorator type.\n *\n * @ignore\n * @param type\n * @decorator\n */\nexport function JsonEntityComponent(type: DecoratorTypes) {\n  return (target: Type<JsonEntityStore>) => {\n    JsonEntitiesContainer.set(type, target);\n  };\n}\n"]}