@tsed/schema 6.88.0 → 6.91.0

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

@@ -0,0 +1 @@
+{"version":3,"file":"required.js","sourceRoot":"","sources":["../../../../src/decorators/common/required.ts"],"names":[],"mappings":";;;AAAA,mCAA8B;AAC9B,yCAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0CG;AACH,SAAgB,QAAQ,CAAC,WAAoB,IAAI,EAAE,GAAG,qBAA4B;IAChF,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAA,aAAK,EAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC,IAAA,mBAAQ,GAAE,CAAC;AACjE,CAAC;AAFD,4BAEC","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/cjs/decorators/common/requiredGroups.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequiredGroups = void 0;
+const core_1 = require("@tsed/core");
+const matchGroups_1 = require("../../utils/matchGroups");
+const jsonEntityFn_1 = require("./jsonEntityFn");
+/**
+ * Apply groups validation strategy for required property.
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function RequiredGroups(...groups) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        if (entity.decoratorType === core_1.DecoratorTypes.PROP) {
+            entity.parent.schema.$hooks.on("requiredGroups", (required, givenGroups) => {
+                if ((0, matchGroups_1.matchGroups)(groups, givenGroups)) {
+                    return required.filter((key) => key !== entity.propertyKey);
+                }
+                return required;
+            });
+        }
+    });
+}
+exports.RequiredGroups = RequiredGroups;
+//# sourceMappingURL=requiredGroups.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requiredGroups.js","sourceRoot":"","sources":["../../../../src/decorators/common/requiredGroups.ts"],"names":[],"mappings":";;;AAAA,qCAA0C;AAC1C,yDAAoD;AACpD,iDAA4C;AAE5C;;;;;;;;GAQG;AACH,SAAgB,cAAc,CAAC,GAAG,MAAgB;IAChD,OAAO,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,IAAI,MAAM,CAAC,aAAa,KAAK,qBAAc,CAAC,IAAI,EAAE;YAChD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,CAAC,QAAkB,EAAE,WAAqB,EAAE,EAAE;gBAC7F,IAAI,IAAA,yBAAW,EAAC,MAAM,EAAE,WAAW,CAAC,EAAE;oBACpC,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,GAAW,EAAE,EAAE,CAAC,GAAG,KAAK,MAAM,CAAC,WAAW,CAAC,CAAC;iBACrE;gBAED,OAAO,QAAQ,CAAC;YAClB,CAAC,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAZD,wCAYC","sourcesContent":["import {DecoratorTypes} from \"@tsed/core\";\nimport {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[]): Function {\n  return JsonEntityFn((entity) => {\n    if (entity.decoratorType === DecoratorTypes.PROP) {\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}\n"]}

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

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.For = exports.Schema = void 0;
+const jsonEntityFn_1 = require("./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
+ */
+function Schema(partialSchema) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        Object.entries(partialSchema).forEach(([key, value]) => {
+            entity.schema.set(key, value);
+        });
+    });
+}
+exports.Schema = Schema;
+/**
+ * Apply specific schema depending on the spec version
+ * @param specType
+ * @param schema
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @input
+ */
+function For(specType, schema) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        entity.schema.set(specType, schema);
+    });
+}
+exports.For = For;
+//# sourceMappingURL=schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../src/decorators/common/schema.ts"],"names":[],"mappings":";;;AAEA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,MAAM,CAAC,aAAqD;IAC1E,OAAO,IAAA,2BAAY,EAAC,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;AAND,wBAMC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,GAAG,CAAC,QAAmB,EAAE,MAAW;IAClD,OAAO,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,kBAIC","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/cjs/decorators/common/title.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"title.js","sourceRoot":"","sources":["../../../../src/decorators/common/title.ts"],"names":[],"mappings":";;;AAAA,iDAA4C;AAE5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,SAAgB,KAAK,CAAC,KAAa;IACjC,OAAO,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,sBAIC","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/cjs/decorators/common/writeOnly.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"writeOnly.js","sourceRoot":"","sources":["../../../../src/decorators/common/writeOnly.ts"],"names":[],"mappings":";;;AACA,iDAA4C;AAC5C;;;;;;;;;GASG;AACH,SAAgB,SAAS,CAAC,YAAqB,IAAI;IACjD,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAsB,EAAE,EAAE;QAC7C,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC,CAAC,CAAC;AACL,CAAC;AAJD,8BAIC","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/cjs/decorators/config/jsonEntityComponent.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonEntityComponent = void 0;
+const JsonEntityStore_1 = require("../../domain/JsonEntityStore");
+/**
+ * Declare a new JsonEntityStore class for a specific decorator type.
+ *
+ * @ignore
+ * @param type
+ * @decorator
+ */
+function JsonEntityComponent(type) {
+    return (target) => {
+        JsonEntityStore_1.JsonEntitiesContainer.set(type, target);
+    };
+}
+exports.JsonEntityComponent = JsonEntityComponent;
+//# sourceMappingURL=jsonEntityComponent.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"jsonEntityComponent.js","sourceRoot":"","sources":["../../../../src/decorators/config/jsonEntityComponent.ts"],"names":[],"mappings":";;;AACA,kEAAoF;AAEpF;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAAC,IAAoB;IACtD,OAAO,CAAC,MAA6B,EAAE,EAAE;QACvC,uCAAqB,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1C,CAAC,CAAC;AACJ,CAAC;AAJD,kDAIC","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"]}

package/lib/cjs/decorators/generics/genericOf.js

@@ -0,0 +1,99 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GenericOf = void 0;
+const core_1 = require("@tsed/core");
+const JsonEntityStore_1 = require("../../domain/JsonEntityStore");
+const from_1 = require("../../utils/from");
+/**
+ * @ignore
+ */
+function isEnum(type) {
+    return (0, core_1.isObject)(type) && !("toJSON" in type);
+}
+/**
+ * Set the types of a Generic class.
+ *
+ * ## Example
+ *
+ * ```typescript
+ * class Product {
+ *   @Property()
+ *   label: string;
+ * }
+ *
+ * @Generics("T")
+ * class Paginated<T> {
+ *   @CollectionOf("T")
+ *   data: T[];
+ *
+ *   @Property()
+ *   totalCount: number;
+ * }
+ *
+ * class Payload {
+ *    @GenericOf(Product)
+ *    products: Paginated<Product>;
+ * }
+ * ```
+ *
+ * ## Example with nested generics
+ *
+ * ```typescript
+ * class Product {
+ *   @Property()
+ *   label: string;
+ * }
+ *
+ * @Generics("T")
+ * class Paginated<T> {
+ *   @CollectionOf("T")
+ *   data: T[];
+ *
+ *   @Property()
+ *   totalCount: number;
+ * }
+ *
+ * @Generics("D")
+ * class Submission<D> {
+ *   @Property()
+ *   _id: string;
+ *
+ *   @Property("D")
+ *   data: D;
+ * }
+ *
+ * class Payload {
+ *    @GenericOf(Submissions).Nested(Product)
+ *    submissions: Paginated<Submission<Product>>;
+ * }
+ * ```
+ *
+ * @param {Type<any>[]} generics
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @generics
+ */
+function GenericOf(...generics) {
+    const nestedGenerics = [
+        generics.map((type) => {
+            if (isEnum(type)) {
+                return (0, from_1.string)().enum(Object.values(type));
+            }
+            return type;
+        })
+    ];
+    const decorator = (...args) => {
+        const store = JsonEntityStore_1.JsonEntityStore.from(...args);
+        store.nestedGenerics = nestedGenerics;
+    };
+    decorator.Nested = (...generics) => {
+        nestedGenerics.push(generics);
+        return decorator;
+    };
+    return decorator;
+}
+exports.GenericOf = GenericOf;
+//# sourceMappingURL=genericOf.js.map

package/lib/cjs/decorators/generics/genericOf.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"genericOf.js","sourceRoot":"","sources":["../../../../src/decorators/generics/genericOf.ts"],"names":[],"mappings":";;;AAAA,qCAA0C;AAC1C,kEAA6D;AAC7D,2CAAwC;AAGxC;;GAEG;AACH,SAAS,MAAM,CAAC,IAAS;IACvB,OAAO,IAAA,eAAQ,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC;AAC/C,CAAC;AAYD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiEG;AACH,SAAgB,SAAS,CAAC,GAAG,QAAwB;IACnD,MAAM,cAAc,GAAqB;QACvC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;YACpB,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;gBAChB,OAAO,IAAA,aAAM,GAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;aAC3C;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;KACH,CAAC;IAEF,MAAM,SAAS,GAAG,CAAC,GAAG,IAAS,EAAE,EAAE;QACjC,MAAM,KAAK,GAAG,iCAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QAC5C,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;IACxC,CAAC,CAAC;IAEF,SAAS,CAAC,MAAM,GAAG,CAAC,GAAG,QAAa,EAAE,EAAE;QACtC,cAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE9B,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;IAEF,OAAO,SAAS,CAAC;AACnB,CAAC;AAtBD,8BAsBC","sourcesContent":["import {isObject, Type} from \"@tsed/core\";\nimport {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {string} from \"../../utils/from\";\nimport {GenericValue} from \"../../utils/generics\";\n\n/**\n * @ignore\n */\nfunction isEnum(type: any) {\n  return isObject(type) && !(\"toJSON\" in type);\n}\n\nexport interface GenericOfChainedDecorators {\n  (...args: any): any;\n\n  /**\n   * Declare a nested generic models\n   * @param generics\n   */\n  Nested(...generics: GenericValue[]): this;\n}\n\n/**\n * Set the types of a Generic class.\n *\n * ## Example\n *\n * ```typescript\n * class Product {\n *   @Property()\n *   label: string;\n * }\n *\n * @Generics(\"T\")\n * class Paginated<T> {\n *   @CollectionOf(\"T\")\n *   data: T[];\n *\n *   @Property()\n *   totalCount: number;\n * }\n *\n * class Payload {\n *    @GenericOf(Product)\n *    products: Paginated<Product>;\n * }\n * ```\n *\n * ## Example with nested generics\n *\n * ```typescript\n * class Product {\n *   @Property()\n *   label: string;\n * }\n *\n * @Generics(\"T\")\n * class Paginated<T> {\n *   @CollectionOf(\"T\")\n *   data: T[];\n *\n *   @Property()\n *   totalCount: number;\n * }\n *\n * @Generics(\"D\")\n * class Submission<D> {\n *   @Property()\n *   _id: string;\n *\n *   @Property(\"D\")\n *   data: D;\n * }\n *\n * class Payload {\n *    @GenericOf(Submissions).Nested(Product)\n *    submissions: Paginated<Submission<Product>>;\n * }\n * ```\n *\n * @param {Type<any>[]} generics\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @generics\n */\nexport function GenericOf(...generics: GenericValue[]): GenericOfChainedDecorators {\n  const nestedGenerics: GenericValue[][] = [\n    generics.map((type) => {\n      if (isEnum(type)) {\n        return string().enum(Object.values(type));\n      }\n      return type;\n    })\n  ];\n\n  const decorator = (...args: any) => {\n    const store = JsonEntityStore.from(...args);\n    store.nestedGenerics = nestedGenerics;\n  };\n\n  decorator.Nested = (...generics: any) => {\n    nestedGenerics.push(generics);\n\n    return decorator;\n  };\n\n  return decorator;\n}\n"]}

package/lib/cjs/decorators/generics/generics.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Generics = void 0;
+const JsonEntityStore_1 = require("../../domain/JsonEntityStore");
+/**
+ * Define generics list. This list is used by @@GenericOf@@ and the @@getJsonSchema@@ function to build the correct JsonSchema.
+ *
+ * See @@GenericOf@@ decorator for more details.
+ *
+ * @param generics
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ * @generics
+ */
+function Generics(...generics) {
+    return (target) => {
+        const storedSchema = JsonEntityStore_1.JsonEntityStore.from(target);
+        storedSchema.schema.genericLabels = generics;
+    };
+}
+exports.Generics = Generics;
+//# sourceMappingURL=generics.js.map

package/lib/cjs/decorators/generics/generics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generics.js","sourceRoot":"","sources":["../../../../src/decorators/generics/generics.ts"],"names":[],"mappings":";;;AAAA,kEAA6D;AAE7D;;;;;;;;;;;;GAYG;AACH,SAAgB,QAAQ,CAAC,GAAG,QAAkB;IAC5C,OAAO,CAAC,MAAW,EAAE,EAAE;QACrB,MAAM,YAAY,GAAG,iCAAe,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAElD,YAAY,CAAC,MAAM,CAAC,aAAa,GAAG,QAAQ,CAAC;IAC/C,CAAC,CAAC;AACJ,CAAC;AAND,4BAMC","sourcesContent":["import {JsonEntityStore} from \"../../domain/JsonEntityStore\";\n\n/**\n * Define generics list. This list is used by @@GenericOf@@ and the @@getJsonSchema@@ function to build the correct JsonSchema.\n *\n * See @@GenericOf@@ decorator for more details.\n *\n * @param generics\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n * @generics\n */\nexport function Generics(...generics: string[]) {\n  return (target: any) => {\n    const storedSchema = JsonEntityStore.from(target);\n\n    storedSchema.schema.genericLabels = generics;\n  };\n}\n"]}

package/lib/cjs/decorators/index.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// class
+(0, tslib_1.__exportStar)(require("./class/children"), exports);
+// collections
+(0, tslib_1.__exportStar)(require("./collections/collectionContains"), exports);
+(0, tslib_1.__exportStar)(require("./collections/collectionOf"), exports);
+(0, tslib_1.__exportStar)(require("./collections/maxItems"), exports);
+(0, tslib_1.__exportStar)(require("./collections/minItems"), exports);
+(0, tslib_1.__exportStar)(require("./collections/uniqueItems"), exports);
+(0, tslib_1.__exportStar)(require("./collections/maxProperties"), exports);
+(0, tslib_1.__exportStar)(require("./collections/minProperties"), exports);
+// generics
+(0, tslib_1.__exportStar)(require("./generics/generics"), exports);
+(0, tslib_1.__exportStar)(require("./generics/genericOf"), exports);
+// operations
+(0, tslib_1.__exportStar)(require("./operations/deprecated"), exports);
+(0, tslib_1.__exportStar)(require("./operations/consumes"), exports);
+(0, tslib_1.__exportStar)(require("./operations/contentType"), exports);
+(0, tslib_1.__exportStar)(require("./operations/in"), exports);
+(0, tslib_1.__exportStar)(require("./operations/operationId"), exports);
+(0, tslib_1.__exportStar)(require("./operations/operationPath"), exports);
+(0, tslib_1.__exportStar)(require("./operations/path"), exports);
+(0, tslib_1.__exportStar)(require("./operations/produces"), exports);
+(0, tslib_1.__exportStar)(require("./operations/returns"), exports);
+(0, tslib_1.__exportStar)(require("./operations/status"), exports);
+(0, tslib_1.__exportStar)(require("./operations/header"), exports);
+(0, tslib_1.__exportStar)(require("./operations/security"), exports);
+(0, tslib_1.__exportStar)(require("./operations/tags"), exports);
+(0, tslib_1.__exportStar)(require("./operations/summary"), exports);
+(0, tslib_1.__exportStar)(require("./operations/partial"), exports);
+(0, tslib_1.__exportStar)(require("./operations/redirect"), exports);
+(0, tslib_1.__exportStar)(require("./operations/location"), exports);
+(0, tslib_1.__exportStar)(require("./operations/route"), exports);
+// common
+(0, tslib_1.__exportStar)(require("./common/additionalProperties"), exports);
+(0, tslib_1.__exportStar)(require("./common/allow"), exports);
+(0, tslib_1.__exportStar)(require("./common/any"), exports);
+(0, tslib_1.__exportStar)(require("./common/integer"), exports);
+(0, tslib_1.__exportStar)(require("./common/const"), exports);
+(0, tslib_1.__exportStar)(require("./common/default"), exports);
+(0, tslib_1.__exportStar)(require("./common/description"), exports);
+(0, tslib_1.__exportStar)(require("./common/example"), exports);
+(0, tslib_1.__exportStar)(require("./common/examples"), exports);
+(0, tslib_1.__exportStar)(require("./common/enum"), exports);
+(0, tslib_1.__exportStar)(require("./common/exclusiveMaximum"), exports);
+(0, tslib_1.__exportStar)(require("./common/exclusiveMinimum"), exports);
+(0, tslib_1.__exportStar)(require("./common/format"), exports);
+(0, tslib_1.__exportStar)(require("./common/forwardGroups"), exports);
+(0, tslib_1.__exportStar)(require("./common/groups"), exports);
+(0, tslib_1.__exportStar)(require("./common/pattern"), exports);
+(0, tslib_1.__exportStar)(require("./common/ignore"), exports);
+(0, tslib_1.__exportStar)(require("./common/maximum"), exports);
+(0, tslib_1.__exportStar)(require("./common/maxLength"), exports);
+(0, tslib_1.__exportStar)(require("./common/minimum"), exports);
+(0, tslib_1.__exportStar)(require("./common/minLength"), exports);
+(0, tslib_1.__exportStar)(require("./common/multipleOf"), exports);
+(0, tslib_1.__exportStar)(require("./common/name"), exports);
+(0, tslib_1.__exportStar)(require("./common/required"), exports);
+(0, tslib_1.__exportStar)(require("./common/requiredGroups"), exports);
+(0, tslib_1.__exportStar)(require("./common/property"), exports);
+(0, tslib_1.__exportStar)(require("./common/hidden"), exports);
+(0, tslib_1.__exportStar)(require("./common/title"), exports);
+(0, tslib_1.__exportStar)(require("./common/schema"), exports);
+(0, tslib_1.__exportStar)(require("./common/oneOf"), exports);
+(0, tslib_1.__exportStar)(require("./common/allOf"), exports);
+(0, tslib_1.__exportStar)(require("./common/anyOf"), exports);
+(0, tslib_1.__exportStar)(require("./common/jsonEntityFn"), exports);
+(0, tslib_1.__exportStar)(require("./common/optional"), exports);
+(0, tslib_1.__exportStar)(require("./common/writeOnly"), exports);
+(0, tslib_1.__exportStar)(require("./common/readOnly"), exports);
+(0, tslib_1.__exportStar)(require("./common/customKey"), exports);
+(0, tslib_1.__exportStar)(require("./common/nullable"), exports);
+(0, tslib_1.__exportStar)(require("./config/jsonEntityComponent"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/decorators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":";;;AAAA,QAAQ;AACR,gEAAiC;AAEjC,cAAc;AACd,gFAAiD;AACjD,0EAA2C;AAC3C,sEAAuC;AACvC,sEAAuC;AACvC,yEAA0C;AAC1C,2EAA4C;AAC5C,2EAA4C;AAE5C,WAAW;AACX,mEAAoC;AACpC,oEAAqC;AAErC,aAAa;AACb,uEAAwC;AACxC,qEAAsC;AACtC,wEAAyC;AACzC,+DAAgC;AAChC,wEAAyC;AACzC,0EAA2C;AAC3C,iEAAkC;AAClC,qEAAsC;AACtC,oEAAqC;AACrC,mEAAoC;AACpC,mEAAoC;AACpC,qEAAsC;AACtC,iEAAkC;AAClC,oEAAqC;AACrC,oEAAqC;AACrC,qEAAsC;AACtC,qEAAsC;AACtC,kEAAmC;AAEnC,SAAS;AACT,6EAA8C;AAC9C,8DAA+B;AAC/B,4DAA6B;AAC7B,gEAAiC;AACjC,8DAA+B;AAC/B,gEAAiC;AACjC,oEAAqC;AACrC,gEAAiC;AACjC,iEAAkC;AAClC,6DAA8B;AAC9B,yEAA0C;AAC1C,yEAA0C;AAC1C,+DAAgC;AAChC,sEAAuC;AACvC,+DAAgC;AAChC,gEAAiC;AACjC,+DAAgC;AAChC,gEAAiC;AACjC,kEAAmC;AACnC,gEAAiC;AACjC,kEAAmC;AACnC,mEAAoC;AACpC,6DAA8B;AAC9B,iEAAkC;AAClC,uEAAwC;AACxC,iEAAkC;AAClC,+DAAgC;AAChC,8DAA+B;AAC/B,+DAAgC;AAChC,8DAA+B;AAC/B,8DAA+B;AAC/B,8DAA+B;AAC/B,qEAAsC;AACtC,iEAAkC;AAClC,kEAAmC;AACnC,iEAAkC;AAClC,kEAAmC;AACnC,iEAAkC;AAClC,4EAA6C","sourcesContent":["// class\nexport * from \"./class/children\";\n\n// collections\nexport * from \"./collections/collectionContains\";\nexport * from \"./collections/collectionOf\";\nexport * from \"./collections/maxItems\";\nexport * from \"./collections/minItems\";\nexport * from \"./collections/uniqueItems\";\nexport * from \"./collections/maxProperties\";\nexport * from \"./collections/minProperties\";\n\n// generics\nexport * from \"./generics/generics\";\nexport * from \"./generics/genericOf\";\n\n// operations\nexport * from \"./operations/deprecated\";\nexport * from \"./operations/consumes\";\nexport * from \"./operations/contentType\";\nexport * from \"./operations/in\";\nexport * from \"./operations/operationId\";\nexport * from \"./operations/operationPath\";\nexport * from \"./operations/path\";\nexport * from \"./operations/produces\";\nexport * from \"./operations/returns\";\nexport * from \"./operations/status\";\nexport * from \"./operations/header\";\nexport * from \"./operations/security\";\nexport * from \"./operations/tags\";\nexport * from \"./operations/summary\";\nexport * from \"./operations/partial\";\nexport * from \"./operations/redirect\";\nexport * from \"./operations/location\";\nexport * from \"./operations/route\";\n\n// common\nexport * from \"./common/additionalProperties\";\nexport * from \"./common/allow\";\nexport * from \"./common/any\";\nexport * from \"./common/integer\";\nexport * from \"./common/const\";\nexport * from \"./common/default\";\nexport * from \"./common/description\";\nexport * from \"./common/example\";\nexport * from \"./common/examples\";\nexport * from \"./common/enum\";\nexport * from \"./common/exclusiveMaximum\";\nexport * from \"./common/exclusiveMinimum\";\nexport * from \"./common/format\";\nexport * from \"./common/forwardGroups\";\nexport * from \"./common/groups\";\nexport * from \"./common/pattern\";\nexport * from \"./common/ignore\";\nexport * from \"./common/maximum\";\nexport * from \"./common/maxLength\";\nexport * from \"./common/minimum\";\nexport * from \"./common/minLength\";\nexport * from \"./common/multipleOf\";\nexport * from \"./common/name\";\nexport * from \"./common/required\";\nexport * from \"./common/requiredGroups\";\nexport * from \"./common/property\";\nexport * from \"./common/hidden\";\nexport * from \"./common/title\";\nexport * from \"./common/schema\";\nexport * from \"./common/oneOf\";\nexport * from \"./common/allOf\";\nexport * from \"./common/anyOf\";\nexport * from \"./common/jsonEntityFn\";\nexport * from \"./common/optional\";\nexport * from \"./common/writeOnly\";\nexport * from \"./common/readOnly\";\nexport * from \"./common/customKey\";\nexport * from \"./common/nullable\";\nexport * from \"./config/jsonEntityComponent\";\n"]}

package/lib/cjs/decorators/operations/consumes.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Consumes = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Add consumes metadata on the decorated element.
+ *
+ * ## Examples
+ *
+ * ```typescript
+ * class Model {
+ *    @Consumes("application/x-www-form-urlencoded")
+ *    id: string;
+ * }
+ * ```
+ *
+ * @param consumes
+ * @decorator
+ * @swagger
+ * @classDecorator
+ * @operation
+ */
+function Consumes(...consumes) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        switch (store.decoratorType) {
+            case core_1.DecoratorTypes.METHOD:
+                store.operation.consumes(consumes);
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                (0, core_1.decorateMethodsOf)(args[0], Consumes(...consumes));
+                break;
+            default:
+                throw new core_1.UnsupportedDecoratorType(Consumes, args);
+        }
+    });
+}
+exports.Consumes = Consumes;
+//# sourceMappingURL=consumes.js.map

package/lib/cjs/decorators/operations/consumes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consumes.js","sourceRoot":"","sources":["../../../../src/decorators/operations/consumes.ts"],"names":[],"mappings":";;;AAAA,qCAAuF;AACvF,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAgB,QAAQ,CAAC,GAAG,QAAkB;IAC5C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,QAAQ,KAAK,CAAC,aAAa,EAAE;YAC3B,KAAK,qBAAc,CAAC,MAAM;gBACxB,KAAK,CAAC,SAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBACpC,MAAM;YACR,KAAK,qBAAc,CAAC,KAAK;gBACvB,IAAA,wBAAiB,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC;gBAClD,MAAM;YAER;gBACE,MAAM,IAAI,+BAAwB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;SACtD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,4BAcC","sourcesContent":["import {decorateMethodsOf, DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Add consumes metadata on the decorated element.\n *\n * ## Examples\n *\n * ```typescript\n * class Model {\n *    @Consumes(\"application/x-www-form-urlencoded\")\n *    id: string;\n * }\n * ```\n *\n * @param consumes\n * @decorator\n * @swagger\n * @classDecorator\n * @operation\n */\nexport function Consumes(...consumes: string[]) {\n  return JsonEntityFn((store, args) => {\n    switch (store.decoratorType) {\n      case DecoratorTypes.METHOD:\n        store.operation!.consumes(consumes);\n        break;\n      case DecoratorTypes.CLASS:\n        decorateMethodsOf(args[0], Consumes(...consumes));\n        break;\n\n      default:\n        throw new UnsupportedDecoratorType(Consumes, args);\n    }\n  });\n}\n"]}

package/lib/cjs/decorators/operations/contentType.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentType = void 0;
+const returns_1 = require("./returns");
+/**
+ * Sets the Content-Type HTTP header to the MIME type as determined by mime.lookup() for the specified type.
+ * If type contains the “/” character, then it sets the `Content-Type` to type.
+ *
+ * ```typescript
+ *  @ContentType('.html');              // => 'text/html'
+ *  @ContentType('html');               // => 'text/html'
+ *  @ContentType('json');               // => 'application/json'
+ *  @ContentType('application/json');   // => 'application/json'
+ *  @ContentType('png');                // => image/png
+ *  private myMethod() {}
+ * ```
+ *
+ * @param type
+ * @decorator
+ * @operation
+ * @response
+ * @headers
+ */
+function ContentType(type) {
+    return (0, returns_1.Returns)().ContentType(type);
+}
+exports.ContentType = ContentType;
+//# sourceMappingURL=contentType.js.map

package/lib/cjs/decorators/operations/contentType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contentType.js","sourceRoot":"","sources":["../../../../src/decorators/operations/contentType.ts"],"names":[],"mappings":";;;AAAA,uCAAkC;AAElC;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,OAAO,IAAA,iBAAO,GAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;AACrC,CAAC;AAFD,kCAEC","sourcesContent":["import {Returns} from \"./returns\";\n\n/**\n * Sets the Content-Type HTTP header to the MIME type as determined by mime.lookup() for the specified type.\n * If type contains the “/” character, then it sets the `Content-Type` to type.\n *\n * ```typescript\n *  @ContentType('.html');              // => 'text/html'\n *  @ContentType('html');               // => 'text/html'\n *  @ContentType('json');               // => 'application/json'\n *  @ContentType('application/json');   // => 'application/json'\n *  @ContentType('png');                // => image/png\n *  private myMethod() {}\n * ```\n *\n * @param type\n * @decorator\n * @operation\n * @response\n * @headers\n */\nexport function ContentType(type: string) {\n  return Returns().ContentType(type);\n}\n"]}

package/lib/cjs/decorators/operations/deprecated.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Deprecated = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Add deprecated metadata on the decorated element.
+ *
+ * ## Examples
+ *
+ * ```typescript
+ *
+ * @Deprecated()
+ * class MyCtrl {
+ *   @Deprecated()
+ *   @Get("/")
+ *   method(){
+ *   }
+ * }
+ * ```
+ *
+ * @param deprecated
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+function Deprecated(deprecated = true) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        switch (store.decoratorType) {
+            case core_1.DecoratorTypes.METHOD:
+                store.operation.deprecated(deprecated);
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                (0, core_1.decorateMethodsOf)(args[0], Deprecated(deprecated));
+                break;
+            default:
+                throw new core_1.UnsupportedDecoratorType(Deprecated, args);
+        }
+    });
+}
+exports.Deprecated = Deprecated;
+//# sourceMappingURL=deprecated.js.map

package/lib/cjs/decorators/operations/deprecated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.js","sourceRoot":"","sources":["../../../../src/decorators/operations/deprecated.ts"],"names":[],"mappings":";;;AAAA,qCAAuF;AACvF,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,UAAU,CAAC,aAAsB,IAAI;IACnD,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,QAAQ,KAAK,CAAC,aAAa,EAAE;YAC3B,KAAK,qBAAc,CAAC,MAAM;gBACxB,KAAK,CAAC,SAAU,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;gBACxC,MAAM;YACR,KAAK,qBAAc,CAAC,KAAK;gBACvB,IAAA,wBAAiB,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC;gBACnD,MAAM;YAER;gBACE,MAAM,IAAI,+BAAwB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;SACxD;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAdD,gCAcC","sourcesContent":["import {decorateMethodsOf, DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Add deprecated metadata on the decorated element.\n *\n * ## Examples\n *\n * ```typescript\n *\n * @Deprecated()\n * class MyCtrl {\n *   @Deprecated()\n *   @Get(\"/\")\n *   method(){\n *   }\n * }\n * ```\n *\n * @param deprecated\n * @decorator\n * @swagger\n * @schema\n * @operation\n */\nexport function Deprecated(deprecated: boolean = true) {\n  return JsonEntityFn((store, args) => {\n    switch (store.decoratorType) {\n      case DecoratorTypes.METHOD:\n        store.operation!.deprecated(deprecated);\n        break;\n      case DecoratorTypes.CLASS:\n        decorateMethodsOf(args[0], Deprecated(deprecated));\n        break;\n\n      default:\n        throw new UnsupportedDecoratorType(Deprecated, args);\n    }\n  });\n}\n"]}