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

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UniqueItems = void 0;
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * 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
+ */
+function UniqueItems(uniqueItems = true) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.schema.uniqueItems(uniqueItems);
+    });
+}
+exports.UniqueItems = UniqueItems;
+//# sourceMappingURL=uniqueItems.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"uniqueItems.js","sourceRoot":"","sources":["../../../../src/decorators/collections/uniqueItems.ts"],"names":[],"mappings":";;;AACA,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgDG;AACH,SAAgB,WAAW,CAAC,cAAuB,IAAI;IACrD,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,kCAIC","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/cjs/decorators/common/additionalProperties.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdditionalProperties = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Accept unknown properties on the deserialized model.
+ *
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ */
+function AdditionalProperties(schema) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity, parameters) => {
+        entity.itemSchema.additionalProperties(schema);
+    });
+}
+exports.AdditionalProperties = AdditionalProperties;
+//# sourceMappingURL=additionalProperties.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"additionalProperties.js","sourceRoot":"","sources":["../../../../src/decorators/common/additionalProperties.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;GAQG;AACH,SAAgB,oBAAoB,CAAC,MAA+B;IAClE,OAAO,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,UAAU,EAAE,EAAE;QACzC,MAAM,CAAC,UAAU,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,oDAIC","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/cjs/decorators/common/allOf.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AllOf = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.26
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param allOf
+ */
+function AllOf(...allOf) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        entity.itemSchema.allOf(allOf);
+    });
+}
+exports.AllOf = AllOf;
+//# sourceMappingURL=allOf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"allOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/allOf.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;;GAUG;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.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/cjs/decorators/common/allow.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Allow = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("./jsonEntityFn");
+const property_1 = require("./property");
+/**
+ * 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
+ */
+function Allow(...values) {
+    const model = values.find((item) => (0, core_1.isClass)(item));
+    return (0, core_1.useDecorators)(model && (0, property_1.Property)(model), (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        store.schema.allow(...values);
+        if (store.decoratorType === core_1.DecoratorTypes.PARAM) {
+            store.required = true;
+        }
+        if (store.decoratorType === core_1.DecoratorTypes.PROP) {
+            store.parentSchema.addRequired(store.propertyName);
+        }
+    }));
+}
+exports.Allow = Allow;
+//# sourceMappingURL=allow.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"allow.js","sourceRoot":"","sources":["../../../../src/decorators/common/allow.ts"],"names":[],"mappings":";;;AAAA,qCAAkE;AAClE,iDAA4C;AAC5C,yCAAoC;AAGpC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,SAAgB,KAAK,CAAC,GAAG,MAAa;IACpC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,cAAO,EAAC,IAAI,CAAC,CAAC,CAAC;IACnD,OAAO,IAAA,oBAAa,EAClB,KAAK,IAAI,IAAA,mBAAQ,EAAC,KAAK,CAAC,EACxB,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAC3B,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC;QAE9B,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,KAAK,EAAE;YAC/C,KAA4B,CAAC,QAAQ,GAAG,IAAI,CAAC;SAC/C;QAED,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,IAAI,EAAE;YAC/C,KAAK,CAAC,YAAY,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;SACpD;IACH,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAhBD,sBAgBC","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/cjs/decorators/common/any.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Any = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * 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
+ */
+function Any(...types) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.any(...types);
+    });
+}
+exports.Any = Any;
+//# sourceMappingURL=any.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"any.js","sourceRoot":"","sources":["../../../../src/decorators/common/any.ts"],"names":[],"mappings":";;;AAEA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,SAAgB,GAAG,CAAC,GAAG,KAAgD;IACrE,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IACjC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,kBAIC","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/cjs/decorators/common/anyOf.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AnyOf = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * See https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.27
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ * @param anyOf
+ */
+function AnyOf(...anyOf) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        entity.itemSchema.anyOf(anyOf);
+    });
+}
+exports.AnyOf = AnyOf;
+//# sourceMappingURL=anyOf.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"anyOf.js","sourceRoot":"","sources":["../../../../src/decorators/common/anyOf.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;;GAUG;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.27\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/cjs/decorators/common/const.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Const = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * 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
+ */
+function Const(constValue) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.const(constValue);
+    });
+}
+exports.Const = Const;
+//# sourceMappingURL=const.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"const.js","sourceRoot":"","sources":["../../../../src/decorators/common/const.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,SAAgB,KAAK,CAAC,UAAiC;IACrD,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACrC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,sBAIC","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/cjs/decorators/common/customKey.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomKeys = exports.CustomKey = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * 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
+ */
+function CustomKey(key, value) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.customKey(key, value);
+    });
+}
+exports.CustomKey = CustomKey;
+/**
+ * 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
+ */
+function CustomKeys(obj) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        Object.entries(obj).forEach(([key, value]) => {
+            store.itemSchema.customKey(key, value);
+        });
+    });
+}
+exports.CustomKeys = CustomKeys;
+//# sourceMappingURL=customKey.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"customKey.js","sourceRoot":"","sources":["../../../../src/decorators/common/customKey.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;;;GAWG;AACH,SAAgB,SAAS,CAAC,GAAW,EAAE,KAAU;IAC/C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,8BAIC;AACD;;;;;;;;;;;GAWG;AACH,SAAgB,UAAU,CAAC,GAAwB;IACjD,OAAO,IAAA,2BAAY,EAAC,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;AAND,gCAMC","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"]}

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

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Default = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * There are no restrictions placed on the value of this keyword.
+ *
+ * ::: warning
+ * For v6 user, use @@Default@@ from @tsed/schema instead of @tsed/common.
+ * :::
+ *
+ * This keyword can be used to supply a default JSON value associated with a particular schema.
+ * It is RECOMMENDED that a default value be valid against the associated schema.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Model {
+ *    @Default("10")
+ *    property: string = "10";
+ * }
+ * ```
+ *
+ * Will produce:
+ *
+ * ```json
+ * {
+ *   "type": "object",
+ *   "properties": {
+ *     "property": {
+ *       "type": "string",
+ *       "default": "10"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * @param {string | number | boolean | {}} defaultValue
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Default(defaultValue) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.itemSchema.default(defaultValue);
+    });
+}
+exports.Default = Default;
+//# sourceMappingURL=default.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"default.js","sourceRoot":"","sources":["../../../../src/decorators/common/default.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,SAAgB,OAAO,CAAC,YAA4C;IAClE,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,0BAIC","sourcesContent":["import {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * There are no restrictions placed on the value of this keyword.\n *\n * ::: warning\n * For v6 user, use @@Default@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * This keyword can be used to supply a default JSON value associated with a particular schema.\n * It is RECOMMENDED that a default value be valid against the associated schema.\n *\n * ## Example\n *\n * ```typescript\n * class Model {\n *    @Default(\"10\")\n *    property: string = \"10\";\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"string\",\n *       \"default\": \"10\"\n *     }\n *   }\n * }\n * ```\n *\n * @param {string | number | boolean | {}} defaultValue\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Default(defaultValue: string | number | boolean | {}) {\n  return JsonEntityFn((store) => {\n    store.itemSchema.default(defaultValue);\n  });\n}\n"]}

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

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Description = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Add a description to the class, method or property
+ *
+ * ## Examples
+ * ### On class
+ *
+ * ```typescript
+ * @Description("description")
+ * class Model {
+ *
+ * }
+ * ```
+ *
+ * ### On method
+ *
+ * ```typescript
+ * @Controller("/")
+ * class ModelCtrl {
+ *    @Description("description")
+ *    async method() {}
+ * }
+ * ```
+ *
+ * ### On parameter
+ *
+ * ```typescript
+ * @Controller("/")
+ * class ModelCtrl {
+ *    async method(@Description("description") @PathParam("id") id: string) {}
+ * }
+ * ```
+ *
+ * ### On property
+ *
+ * ```typescript
+ * class Model {
+ *    @Description("description")
+ *    id: string;
+ * }
+ * ```
+ *
+ * @param {string} description
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @classDecorator
+ * @methodDecorator
+ * @propertyDecorator
+ * @parameterDecorator
+ */
+function Description(description) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        var _a;
+        switch ((0, core_1.decoratorTypeOf)(args)) {
+            case core_1.DecoratorTypes.PROP:
+            case core_1.DecoratorTypes.CLASS:
+                store.schema.description(description);
+                break;
+            case core_1.DecoratorTypes.PARAM:
+                store.parameter.description(description);
+                break;
+            case core_1.DecoratorTypes.METHOD:
+                (_a = store.operation) === null || _a === void 0 ? void 0 : _a.description(description);
+                break;
+        }
+    });
+}
+exports.Description = Description;
+//# sourceMappingURL=description.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"description.js","sourceRoot":"","sources":["../../../../src/decorators/common/description.ts"],"names":[],"mappings":";;;AAAA,qCAAgF;AAEhF,iDAA4C;AAG5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmDG;AACH,SAAgB,WAAW,CAAC,WAAgB;IAC1C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,IAAyB,EAAE,EAAE;;QACxE,QAAQ,IAAA,sBAAe,EAAC,IAAI,CAAC,EAAE;YAC7B,KAAK,qBAAc,CAAC,IAAI,CAAC;YACzB,KAAK,qBAAc,CAAC,KAAK;gBACvB,KAAK,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;gBACtC,MAAM;YAER,KAAK,qBAAc,CAAC,KAAK;gBACtB,KAA4B,CAAC,SAAS,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;gBACjE,MAAM;YAER,KAAK,qBAAc,CAAC,MAAM;gBACxB,MAAC,KAAyB,CAAC,SAAS,0CAAE,WAAW,CAAC,WAAW,CAAC,CAAC;gBAC/D,MAAM;SACT;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAjBD,kCAiBC","sourcesContent":["import {DecoratorParameters, decoratorTypeOf, DecoratorTypes} from \"@tsed/core\";\nimport {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\nimport type {JsonMethodStore, JsonParameterStore} from \"../../domain\";\n\n/**\n * Add a description to the class, method or property\n *\n * ## Examples\n * ### On class\n *\n * ```typescript\n * @Description(\"description\")\n * class Model {\n *\n * }\n * ```\n *\n * ### On method\n *\n * ```typescript\n * @Controller(\"/\")\n * class ModelCtrl {\n *    @Description(\"description\")\n *    async method() {}\n * }\n * ```\n *\n * ### On parameter\n *\n * ```typescript\n * @Controller(\"/\")\n * class ModelCtrl {\n *    async method(@Description(\"description\") @PathParam(\"id\") id: string) {}\n * }\n * ```\n *\n * ### On property\n *\n * ```typescript\n * class Model {\n *    @Description(\"description\")\n *    id: string;\n * }\n * ```\n *\n * @param {string} description\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @classDecorator\n * @methodDecorator\n * @propertyDecorator\n * @parameterDecorator\n */\nexport function Description(description: any) {\n  return JsonEntityFn((store: JsonEntityStore, args: DecoratorParameters) => {\n    switch (decoratorTypeOf(args)) {\n      case DecoratorTypes.PROP:\n      case DecoratorTypes.CLASS:\n        store.schema.description(description);\n        break;\n\n      case DecoratorTypes.PARAM:\n        (store as JsonParameterStore).parameter.description(description);\n        break;\n\n      case DecoratorTypes.METHOD:\n        (store as JsonMethodStore).operation?.description(description);\n        break;\n    }\n  });\n}\n"]}

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Enum = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("./jsonEntityFn");
+const transformTsEnum = (enumValue) => {
+    return Object.keys(enumValue).reduce((acc, key) => {
+        if (isNaN(+key)) {
+            const value = enumValue[key];
+            return acc.concat(value);
+        }
+        return acc;
+    }, []);
+};
+function Enum(enumValue, ...enumValues) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        const values = [enumValue].concat(enumValues).reduce((acc, value) => {
+            if ((0, core_1.isObject)(value) && value !== null) {
+                value = transformTsEnum(value);
+            }
+            return acc.concat(value);
+        }, []);
+        const types = values.reduce((set, value) => {
+            return set.add(value === null ? "null" : typeof value);
+        }, new Set());
+        store.itemSchema.enum(values).any(...types);
+    });
+}
+exports.Enum = Enum;
+//# sourceMappingURL=enum.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../src/decorators/common/enum.ts"],"names":[],"mappings":";;;AAAA,qCAAoC;AAEpC,iDAA4C;AAE5C,MAAM,eAAe,GAAG,CAAC,SAAc,EAAE,EAAE;IACzC,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,GAAQ,EAAE,EAAE;QAC1D,IAAI,KAAK,CAAC,CAAC,GAAG,CAAC,EAAE;YACf,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC;YAE7B,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;SAC1B;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC,CAAC;AAmGF,SAAgB,IAAI,CAAC,SAAgC,EAAE,GAAG,UAA6B;IACrF,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,EAAE;QAC5B,MAAM,MAAM,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;YAClE,IAAI,IAAA,eAAQ,EAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,EAAE;gBACrC,KAAK,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;aAChC;YAED,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3B,CAAC,EAAE,EAAE,CAAC,CAAC;QAEP,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,GAAa,EAAE,KAAU,EAAE,EAAE;YACxD,OAAO,GAAG,CAAC,GAAG,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,CAAC;QACzD,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;QAEd,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;AACL,CAAC;AAhBD,oBAgBC","sourcesContent":["import {isObject} from \"@tsed/core\";\nimport type {JSONSchema6Type} from \"json-schema\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\nconst transformTsEnum = (enumValue: any) => {\n  return Object.keys(enumValue).reduce((acc: any, key: any) => {\n    if (isNaN(+key)) {\n      const value = enumValue[key];\n\n      return acc.concat(value);\n    }\n\n    return acc;\n  }, []);\n};\n\n/**\n * The enum keyword is used to restrict a value to a fixed set of values.\n * It must be an array with at least one element, where each element is unique.\n *\n * Elements in the array might be of any value, including null.\n *\n * ::: warning\n * For v6 user, use @@Enum@@ from @tsed/schema instead of @tsed/common.\n * :::\n *\n * ## Example\n * ### With primitive type\n *\n * ```typescript\n * class Model {\n *    @Enum(\"value1\", \"value2\")\n *    property: \"value1\" | \"value2\";\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *       \"type\": \"string\",\n *       \"enum\": [\"value1\", \"value2\"]\n *     }\n *   }\n * }\n * ```\n *\n * ### With array type\n *\n * ```typescript\n * class Model {\n *    @Enum(\"value1\", \"value2\")\n *    property: (\"value1\" | \"value2\")[];\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 *          \"enum\": [\"value1\", \"value2\"]\n *       }\n *     }\n *   }\n * }\n * ```\n *\n * ### With Typescript Enum\n *\n * ```typescript\n * enum SomeEnum {\n *    ENUM_1 = \"enum1\",\n *    ENUM_2 = \"enum2\"\n * }\n *\n * class Model {\n *    @Enum(SomeEnum)\n *    property: SomeEnum;\n * }\n * ```\n *\n * Will produce:\n *\n * ```json\n * {\n *   \"type\": \"object\",\n *   \"properties\": {\n *     \"property\": {\n *        \"type\": \"string\",\n *        \"enum\": [\"enum1\", \"enum2\"]\n *     }\n *   }\n * }\n * ```\n *\n * @param {string | number | boolean | {}} enumValue\n * @param enumValues\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Enum(...enumValues: (JSONSchema6Type | any)[]): Function;\nexport function Enum(enumValue: JSONSchema6Type | any, ...enumValues: JSONSchema6Type[]) {\n  return JsonEntityFn((store) => {\n    const values = [enumValue].concat(enumValues).reduce((acc, value) => {\n      if (isObject(value) && value !== null) {\n        value = transformTsEnum(value);\n      }\n\n      return acc.concat(value);\n    }, []);\n\n    const types = values.reduce((set: Set<any>, value: any) => {\n      return set.add(value === null ? \"null\" : typeof value);\n    }, new Set());\n\n    store.itemSchema.enum(values).any(...types);\n  });\n}\n"]}

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Example = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Add a example metadata on the decorated element.
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @methodDecorator
+ * @classDecorator
+ */
+function Example(...examples) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.schema.examples(examples);
+    });
+}
+exports.Example = Example;
+//# sourceMappingURL=example.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../../../../src/decorators/common/example.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAE5C;;;;;;;;;GASG;AACH,SAAgB,OAAO,CAAC,GAAG,QAAe;IACxC,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,0BAIC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Add a example metadata on the decorated element.\n *\n * @decorator\n * @swagger\n * @schema\n * @input\n * @methodDecorator\n * @classDecorator\n */\nexport function Example(...examples: any[]): Function {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.schema.examples(examples);\n  });\n}\n"]}

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Examples = void 0;
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Add a examples metadata on the decorated element.
+ *
+ * @decorator
+ * @swagger
+ * @schema
+ * @input
+ * @methodDecorator
+ * @classDecorator
+ */
+function Examples(examples) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store) => {
+        store.parameter.examples(examples);
+    });
+}
+exports.Examples = Examples;
+//# sourceMappingURL=examples.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"examples.js","sourceRoot":"","sources":["../../../../src/decorators/common/examples.ts"],"names":[],"mappings":";;;AAEA,iDAA4C;AAE5C;;;;;;;;;GASG;AACH,SAAgB,QAAQ,CAAC,QAAgD;IACvE,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,SAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,4BAIC","sourcesContent":["import {OpenSpecHash, OpenSpecRef, OS3Example} from \"@tsed/openspec\";\nimport {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonEntityFn} from \"./jsonEntityFn\";\n\n/**\n * Add a examples metadata on the decorated element.\n *\n * @decorator\n * @swagger\n * @schema\n * @input\n * @methodDecorator\n * @classDecorator\n */\nexport function Examples(examples: OpenSpecHash<OS3Example | OpenSpecRef>): ParameterDecorator {\n  return JsonEntityFn((store: JsonEntityStore) => {\n    store.parameter!.examples(examples);\n  });\n}\n"]}