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

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

@@ -0,0 +1 @@
+{"version":3,"file":"location.js","sourceRoot":"","sources":["../../../../src/decorators/operations/location.ts"],"names":[],"mappings":";;;AACA,uCAAkC;AAElC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAgB,QAAQ,CAAC,QAAgB,EAAE,IAAiB;IAC1D,OAAO,IAAA,iBAAO,GAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;AAC5C,CAAC;AAFD,4BAEC","sourcesContent":["import {JsonHeader} from \"../../interfaces/JsonOpenSpec\";\nimport {Returns} from \"./returns\";\n\n/**\n * Sets the response Location HTTP header to the specified path parameter.\n *\n * ```typescript\n *  @Location('/foo/bar', {description: 'Location to the next step'})\n *  @Location('http://example.com')\n *  @Location('back')\n *  private myMethod() {\n *\n *  }\n * ```\n *\n * A path value of “back” has a special meaning, it refers to the URL specified in the `Referer` header of the request. If the `Referer` header was not specified, it refers to “/”.\n *\n * @param location\n * @param meta\n * @returns {Function}\n * @decorator\n * @operation\n */\nexport function Location(location: string, meta?: JsonHeader) {\n  return Returns().Location(location, meta);\n}\n"]}

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

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationId = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Set a swagger operationId explicitly.
+ *
+ * @param operationId
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+function OperationId(operationId) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        if (store.decoratorType !== core_1.DecoratorTypes.METHOD) {
+            throw new core_1.UnsupportedDecoratorType(OperationId, args);
+        }
+        store.operation.operationId(operationId);
+    });
+}
+exports.OperationId = OperationId;
+//# sourceMappingURL=operationId.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operationId.js","sourceRoot":"","sources":["../../../../src/decorators/operations/operationId.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,yDAAoD;AAEpD;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,WAAmB;IAC7C,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,MAAM,EAAE;YACjD,MAAM,IAAI,+BAAwB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;SACvD;QAED,KAAK,CAAC,SAAU,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;AACL,CAAC;AARD,kCAQC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Set a swagger operationId explicitly.\n *\n * @param operationId\n * @decorator\n * @swagger\n * @schema\n * @operation\n */\nexport function OperationId(operationId: string) {\n  return JsonEntityFn((store, args) => {\n    if (store.decoratorType !== DecoratorTypes.METHOD) {\n      throw new UnsupportedDecoratorType(OperationId, args);\n    }\n\n    store.operation!.operationId(operationId);\n  });\n}\n"]}

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

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationPath = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Declare new Operation with his path and http method.
+ *
+ * ::: warning
+ * Don't use decorator with Ts.ED application.
+ *
+ * Use theses decorators instead:
+ *
+ * <ApiList query="status.includes('decorator') && status.includes('httpMethod')" />
+ *
+ * :::
+ *
+ * @param method
+ * @param path
+ * @decorator
+ * @swagger
+ * @schema
+ * @operation
+ */
+function OperationPath(method, path = "/") {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        if (store.decoratorType !== core_1.DecoratorTypes.METHOD) {
+            throw new core_1.UnsupportedDecoratorType(OperationPath, args);
+        }
+        store.operation.addOperationPath(method.toUpperCase(), path);
+    });
+}
+exports.OperationPath = OperationPath;
+//# sourceMappingURL=operationPath.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"operationPath.js","sourceRoot":"","sources":["../../../../src/decorators/operations/operationPath.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,yDAAoD;AAGpD;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,aAAa,CAAC,MAAiC,EAAE,OAAwB,GAAG;IAC1F,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,MAAM,EAAE;YACjD,MAAM,IAAI,+BAAwB,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;SACzD;QAED,KAAK,CAAC,SAAU,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,EAAE,IAAI,CAAC,CAAC;IAChE,CAAC,CAAC,CAAC;AACL,CAAC;AARD,sCAQC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\nimport {OperationMethods} from \"../../constants/httpMethods\";\n\n/**\n * Declare new Operation with his path and http method.\n *\n * ::: warning\n * Don't use decorator with Ts.ED application.\n *\n * Use theses decorators instead:\n *\n * <ApiList query=\"status.includes('decorator') && status.includes('httpMethod')\" />\n *\n * :::\n *\n * @param method\n * @param path\n * @decorator\n * @swagger\n * @schema\n * @operation\n */\nexport function OperationPath(method: OperationMethods | string, path: string | RegExp = \"/\") {\n  return JsonEntityFn((store, args) => {\n    if (store.decoratorType !== DecoratorTypes.METHOD) {\n      throw new UnsupportedDecoratorType(OperationPath, args);\n    }\n\n    store.operation!.addOperationPath(method.toUpperCase(), path);\n  });\n}\n"]}

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Partial = void 0;
+const groups_1 = require("../common/groups");
+/**
+ * Apply Partial group strategy on the input model
+ *
+ * @decorator
+ * @validation
+ * @swagger
+ * @schema
+ * @input
+ */
+function Partial() {
+    return (0, groups_1.Groups)("partial");
+}
+exports.Partial = Partial;
+//# sourceMappingURL=partial.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"partial.js","sourceRoot":"","sources":["../../../../src/decorators/operations/partial.ts"],"names":[],"mappings":";;;AAAA,6CAAwC;AAExC;;;;;;;;GAQG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAA,eAAM,EAAC,SAAS,CAAQ,CAAC;AAClC,CAAC;AAFD,0BAEC","sourcesContent":["import {Groups} from \"../common/groups\";\n\n/**\n * Apply Partial group strategy on the input model\n *\n * @decorator\n * @validation\n * @swagger\n * @schema\n * @input\n */\nexport function Partial(): ParameterDecorator {\n  return Groups(\"partial\") as any;\n}\n"]}

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Path = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Set class path to expose all endpoints
+ *
+ * ::: warning
+ * Don't use this decorator to change the path if you develop your application with Ts.ED.
+ * :::
+ *
+ * @param path
+ * @decorator
+ * @swagger
+ * @schema
+ * @classDecorator
+ * @operation
+ */
+function Path(path) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        if (store.decoratorType !== core_1.DecoratorTypes.CLASS) {
+            throw new core_1.UnsupportedDecoratorType(Path, args);
+        }
+        store.path = path;
+    });
+}
+exports.Path = Path;
+//# sourceMappingURL=path.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"path.js","sourceRoot":"","sources":["../../../../src/decorators/operations/path.ts"],"names":[],"mappings":";;;AAAA,qCAAoE;AACpE,yDAAoD;AAEpD;;;;;;;;;;;;;GAaG;AACH,SAAgB,IAAI,CAAC,IAAY;IAC/B,OAAO,IAAA,2BAAY,EAAC,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;QAClC,IAAI,KAAK,CAAC,aAAa,KAAK,qBAAc,CAAC,KAAK,EAAE;YAChD,MAAM,IAAI,+BAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SAChD;QAED,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC;IACpB,CAAC,CAAC,CAAC;AACL,CAAC;AARD,oBAQC","sourcesContent":["import {DecoratorTypes, UnsupportedDecoratorType} from \"@tsed/core\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\n\n/**\n * Set class path to expose all endpoints\n *\n * ::: warning\n * Don't use this decorator to change the path if you develop your application with Ts.ED.\n * :::\n *\n * @param path\n * @decorator\n * @swagger\n * @schema\n * @classDecorator\n * @operation\n */\nexport function Path(path: string) {\n  return JsonEntityFn((store, args) => {\n    if (store.decoratorType !== DecoratorTypes.CLASS) {\n      throw new UnsupportedDecoratorType(Path, args);\n    }\n\n    store.path = path;\n  });\n}\n"]}

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

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Produces = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+/**
+ * Add produces metadata on the decorated element.
+ *
+ * ## Examples
+ * ### On method
+ *
+ * ```typescript
+ * class Model {
+ *    @Produces("text/html")
+ *    id: string;
+ * }
+ * ```
+ *
+ * ::: warning
+ * For openspec v3 prefer `@Returns().ContentType()` usage (see @@Returns@@).
+ * :::
+ *
+ * @param produces
+ * @decorator
+ * @swagger
+ * @methodDecorator
+ * @classDecorator
+ * @operation
+ * @response
+ */
+function Produces(...produces) {
+    return (0, jsonEntityFn_1.JsonEntityFn)((store, args) => {
+        switch (store.decoratorType) {
+            case core_1.DecoratorTypes.METHOD:
+                store.operation.produces(produces);
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                (0, core_1.decorateMethodsOf)(args[0], Produces(...produces));
+                break;
+            default:
+                throw new core_1.UnsupportedDecoratorType(Produces, args);
+        }
+    });
+}
+exports.Produces = Produces;
+//# sourceMappingURL=produces.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"produces.js","sourceRoot":"","sources":["../../../../src/decorators/operations/produces.ts"],"names":[],"mappings":";;;AAAA,qCAAuF;AACvF,yDAAoD;AAEpD;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;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 produces metadata on the decorated element.\n *\n * ## Examples\n * ### On method\n *\n * ```typescript\n * class Model {\n *    @Produces(\"text/html\")\n *    id: string;\n * }\n * ```\n *\n * ::: warning\n * For openspec v3 prefer `@Returns().ContentType()` usage (see @@Returns@@).\n * :::\n *\n * @param produces\n * @decorator\n * @swagger\n * @methodDecorator\n * @classDecorator\n * @operation\n * @response\n */\nexport function Produces(...produces: string[]) {\n  return JsonEntityFn((store, args) => {\n    switch (store.decoratorType) {\n      case DecoratorTypes.METHOD:\n        store.operation!.produces(produces);\n        break;\n      case DecoratorTypes.CLASS:\n        decorateMethodsOf(args[0], Produces(...produces));\n        break;\n\n      default:\n        throw new UnsupportedDecoratorType(Produces, args);\n    }\n  });\n}\n"]}

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

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Redirect = void 0;
+const core_1 = require("@tsed/core");
+const jsonEntityFn_1 = require("../common/jsonEntityFn");
+const returns_1 = require("./returns");
+function Redirect(...args) {
+    const { status, url, meta } = args.reduce((options, value) => {
+        if ((0, core_1.isNumber)(value)) {
+            options.status = value;
+            return options;
+        }
+        if ((0, core_1.isString)(value)) {
+            options.url = value;
+            return options;
+        }
+        options.meta = value;
+        return options;
+    }, { status: 302, url: "", meta: {} });
+    return (0, core_1.useDecorators)((0, returns_1.Returns)(status).Location(url, meta), (0, jsonEntityFn_1.JsonEntityFn)((entity) => {
+        var _a;
+        (_a = entity.operation) === null || _a === void 0 ? void 0 : _a.setRedirection(status);
+    }));
+}
+exports.Redirect = Redirect;
+//# sourceMappingURL=redirect.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"redirect.js","sourceRoot":"","sources":["../../../../src/decorators/operations/redirect.ts"],"names":[],"mappings":";;;AAAA,qCAA6D;AAE7D,yDAAoD;AACpD,uCAAkC;AAqDlC,SAAgB,QAAQ,CAAC,GAAG,IAAW;IACrC,MAAM,EAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAC,GAAG,IAAI,CAAC,MAAM,CACrC,CAAC,OAAY,EAAE,KAAU,EAAE,EAAE;QAC3B,IAAI,IAAA,eAAQ,EAAC,KAAK,CAAC,EAAE;YACnB,OAAO,CAAC,MAAM,GAAG,KAAK,CAAC;YACvB,OAAO,OAAO,CAAC;SAChB;QAED,IAAI,IAAA,eAAQ,EAAC,KAAK,CAAC,EAAE;YACnB,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC;YACpB,OAAO,OAAO,CAAC;SAChB;QAED,OAAO,CAAC,IAAI,GAAG,KAAK,CAAC;QACrB,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,EAAC,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAC,CACjC,CAAC;IACF,OAAO,IAAA,oBAAa,EAClB,IAAA,iBAAO,EAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,EACnC,IAAA,2BAAY,EAAC,CAAC,MAAM,EAAE,EAAE;;QACtB,MAAA,MAAM,CAAC,SAAS,0CAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC,CAAC,CACH,CAAC;AACJ,CAAC;AAxBD,4BAwBC","sourcesContent":["import {isNumber, isString, useDecorators} from \"@tsed/core\";\nimport {JsonHeader} from \"../../interfaces/JsonOpenSpec\";\nimport {JsonEntityFn} from \"../common/jsonEntityFn\";\nimport {Returns} from \"./returns\";\n\n/**\n * Redirects to the URL derived from the specified path, with specified status, a positive integer that corresponds to an HTTP status code . If not specified, status defaults to “302 “Found”.\n *\n * ```typescript\n *  @Redirect('/foo/bar')\n *  @Redirect(301, 'http://example.com').Type(Model)\n *  private myMethod() {}\n * ```\n * Redirects can be a fully-qualified URL for redirecting to a different site:\n *\n * ```typescript\n *  @Redirect('http://google.com');\n *  private myMethod() {}\n * ```\n *\n * Redirects can be relative to the root of the host name. For example, if the application is on http://example.com/admin/post/new, the following would redirect to the URL http://example.com/admin:\n *\n * ```typescript\n *  @Redirect('/admin');\n * ```\n * Redirects can be relative to the current URL. For example, from http://example.com/blog/admin/ (notice the trailing slash), the following would redirect to the URL http://example.com/blog/admin/post/new.\n *\n * ```typescript\n *  @Redirect('post/new');\n * ```\n *\n * Redirecting to post/new from http://example.com/blog/admin (no trailing slash), will redirect to http://example.com/blog/post/new.\n *\n * If you found the above behavior confusing, think of path segments as directories (with trailing slashes) and files, it will start to make sense.\n *\n * Path-relative redirects are also possible. If you were on http://example.com/admin/post/new, the following would redirect to http//example.com/admin/post:\n *\n * ```typescript\n *  @Redirect('..');\n * ``\n *\n * A back redirection redirects the request back to the referer, defaulting to / when the referer is missing.\n *\n * ```typescript\n *  @Redirect('back');\n * ```\n *\n * @param url\n * @param meta\n * @decorator\n * @operation\n * @response\n * @headers\n */\nexport function Redirect(url: string, meta?: JsonHeader): Function;\nexport function Redirect(status: number, url: string, meta?: JsonHeader): Function;\nexport function Redirect(...args: any[]): Function {\n  const {status, url, meta} = args.reduce(\n    (options: any, value: any) => {\n      if (isNumber(value)) {\n        options.status = value;\n        return options;\n      }\n\n      if (isString(value)) {\n        options.url = value;\n        return options;\n      }\n\n      options.meta = value;\n      return options;\n    },\n    {status: 302, url: \"\", meta: {}}\n  );\n  return useDecorators(\n    Returns(status).Location(url, meta),\n    JsonEntityFn((entity) => {\n      entity.operation?.setRedirection(status);\n    })\n  );\n}\n"]}

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

@@ -0,0 +1,252 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Returns = void 0;
+const core_1 = require("@tsed/core");
+const httpStatusMessages_1 = require("../../constants/httpStatusMessages");
+const DecoratorContext_1 = require("../../domain/DecoratorContext");
+const JsonEntityStore_1 = require("../../domain/JsonEntityStore");
+const JsonSchema_1 = require("../../domain/JsonSchema");
+const defineStatusModel_1 = require("../../utils/defineStatusModel");
+const from_1 = require("../../utils/from");
+const isSuccessStatus_1 = require("../../utils/isSuccessStatus");
+const mapHeaders_1 = require("../../utils/mapHeaders");
+/**
+ * @ignore
+ */
+function isEnum(type) {
+    return (0, core_1.isObject)(type) && !("toJSON" in type);
+}
+function mapGenerics(types) {
+    return types.map((type) => {
+        if (isEnum(type)) {
+            return (0, from_1.string)().enum(Object.values(type));
+        }
+        return type;
+    });
+}
+/**
+ * @ignore
+ */
+class ReturnDecoratorContext extends DecoratorContext_1.DecoratorContext {
+    constructor({ status, model }) {
+        super();
+        this.methods = [
+            "contentType",
+            "description",
+            "examples",
+            "type",
+            "status",
+            "of",
+            "oneOf",
+            "allOf",
+            "anyOf",
+            "nested",
+            "header",
+            "headers",
+            "schema",
+            "title",
+            "groups",
+            "location"
+        ];
+        this.model(model);
+        this.status(status);
+    }
+    type(model) {
+        return this.model(model);
+    }
+    model(model) {
+        model && this.set("model", model);
+        return this;
+    }
+    status(status) {
+        this.set("status", status);
+        if (status && (0, httpStatusMessages_1.getStatusMessage)(status) && !this.get("description")) {
+            this.set("description", (0, httpStatusMessages_1.getStatusMessage)(status));
+            if (!this.get("model")) {
+                this.model((0, defineStatusModel_1.getStatusModel)(+status));
+            }
+        }
+        return this;
+    }
+    headers(headers) {
+        this.set("headers", {
+            ...(this.get("headers") || {}),
+            ...(0, mapHeaders_1.mapHeaders)(headers)
+        });
+        return this;
+    }
+    header(key, value) {
+        return this.headers({ [key]: value });
+    }
+    location(path, meta = {}) {
+        this.headers({
+            Location: {
+                ...meta,
+                value: path
+            }
+        });
+        return this;
+    }
+    groups(...groups) {
+        this.set("groups", groups);
+        return this;
+    }
+    nested(...generics) {
+        const model = this.get("model");
+        this.checkPrimitive(model);
+        this.checkCollection(model);
+        this.addAction((ctx) => {
+            this.get("schema").nestedGenerics.push(mapGenerics(generics));
+        });
+        return this;
+    }
+    of(...types) {
+        const model = this.get("model");
+        this.checkPrimitive(model);
+        this.addAction(() => {
+            const schema = this.get("schema");
+            if ((0, core_1.isCollection)(model)) {
+                schema === null || schema === void 0 ? void 0 : schema.itemSchema({ type: types[0] });
+            }
+            else {
+                schema === null || schema === void 0 ? void 0 : schema.nestedGenerics.push(mapGenerics(types));
+            }
+        });
+        return this;
+    }
+    oneOf(...types) {
+        const model = this.get("model");
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.type(model);
+            schema.itemSchema({ oneOf: types.map((type) => ({ type })) });
+        });
+        return this;
+    }
+    allOf(...types) {
+        const model = this.get("model");
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.type(model);
+            schema.itemSchema({ allOf: types.map((type) => ({ type })) });
+        });
+        return this;
+    }
+    anyOf(...types) {
+        const model = this.get("model");
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.type(model);
+            schema.itemSchema({ anyOf: types.map((type) => ({ type })) });
+        });
+        return this;
+    }
+    schema(partial) {
+        this.addAction(() => {
+            const schema = this.get("schema");
+            schema.assign(partial);
+        });
+        return this;
+    }
+    examples(examples) {
+        this.set("examples", (0, core_1.isString)(examples) ? [examples] : examples);
+        return this;
+    }
+    title(title) {
+        return this.schema({ title });
+    }
+    checkPrimitive(model) {
+        if ((0, core_1.isPrimitiveOrPrimitiveClass)(model)) {
+            throw new Error("Returns.Of cannot be used with the following primitive classes: String, Number, Boolean");
+        }
+    }
+    checkCollection(model) {
+        if ((0, core_1.isCollection)(model)) {
+            throw new Error("Returns.Nested cannot be used with the following classes: Map, Set, Array, String, Number, Boolean");
+        }
+    }
+    getContentType() {
+        const model = this.get("model");
+        let contentType = this.get("contentType");
+        if (model && !(0, core_1.isPlainObject)(model) && !(0, core_1.isPrimitiveOrPrimitiveClass)(model)) {
+            contentType = contentType || "application/json";
+        }
+        return contentType;
+    }
+    getStatus() {
+        return this.get("status") || "default";
+    }
+    onInit(args, decorator) {
+        const type = (0, core_1.decoratorTypeOf)(args);
+        switch (type) {
+            case core_1.DecoratorTypes.METHOD:
+                this.entity = JsonEntityStore_1.JsonEntityStore.from(...args);
+                if (this.entity.operation) {
+                    this.map();
+                }
+                break;
+            case core_1.DecoratorTypes.CLASS:
+                this.decoratorType = core_1.DecoratorTypes.CLASS;
+                (0, core_1.decorateMethodsOf)(args[0], decorator);
+                break;
+        }
+    }
+    map() {
+        const model = this.get("model");
+        const { entity, decoratorType } = this;
+        const operation = this.entity.operation;
+        const currentStatus = this.getStatus();
+        const response = operation.ensureResponseOf(currentStatus);
+        const contentType = this.getContentType();
+        let { description = response.get("description") } = this.toObject();
+        if (description) {
+            description = decoratorType === core_1.DecoratorTypes.CLASS ? response.get("description") || description : description;
+            response.description(description);
+        }
+        const headers = this.getMergedKey("headers", response.get("headers"));
+        if (headers) {
+            response.headers(headers);
+        }
+        this.mapMedia(response);
+        if ((0, isSuccessStatus_1.isSuccessStatus)(this.get("status")) || currentStatus === "default") {
+            if (model) {
+                entity.type = model;
+            }
+        }
+        // additional info for OS2
+        contentType && operation.addProduce(contentType);
+        // run additional actions
+        return this.runActions();
+    }
+    mapMedia(response) {
+        const contentType = this.getContentType();
+        const model = this.get("model");
+        const media = response.getMedia(contentType || "*/*");
+        const schema = media.get("schema") || new JsonSchema_1.JsonSchema({ type: model });
+        if (model) {
+            if ((0, core_1.isArray)(model)) {
+                schema.oneOf(model.map((type) => ({ type })));
+            }
+            else {
+                schema.type(model);
+            }
+        }
+        this.set("schema", schema);
+        media.schema(schema);
+        media.groups = this.get("groups");
+        const examples = this.get("examples");
+        if (examples) {
+            media.examples(examples);
+        }
+        return media;
+    }
+}
+function Returns(status, model) {
+    const context = new ReturnDecoratorContext({
+        status,
+        model
+    });
+    return context.build();
+}
+exports.Returns = Returns;
+//# sourceMappingURL=returns.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"returns.js","sourceRoot":"","sources":["../../../../src/decorators/operations/returns.ts"],"names":[],"mappings":";;;AAAA,qCAWoB;AAEpB,2EAA0F;AAC1F,oEAA+D;AAC/D,kEAA6D;AAE7D,wDAAqE;AAErE,qEAA6D;AAC7D,2CAAwC;AAExC,iEAA4D;AAC5D,uDAAkD;AAgHlD;;GAEG;AACH,SAAS,MAAM,CAAC,IAAS;IACvB,OAAO,IAAA,eAAQ,EAAC,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC;AAC/C,CAAC;AAED,SAAS,WAAW,CAAC,KAAqB;IACxC,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACxB,IAAI,MAAM,CAAC,IAAI,CAAC,EAAE;YAChB,OAAO,IAAA,aAAM,GAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;SAC3C;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,MAAM,sBAAuB,SAAQ,mCAA0C;IAoB7E,YAAY,EAAC,MAAM,EAAE,KAAK,EAAM;QAC9B,KAAK,EAAE,CAAC;QApBD,YAAO,GAAa;YAC3B,aAAa;YACb,aAAa;YACb,UAAU;YACV,MAAM;YACN,QAAQ;YACR,IAAI;YACJ,OAAO;YACP,OAAO;YACP,OAAO;YACP,QAAQ;YACR,QAAQ;YACR,SAAS;YACT,QAAQ;YACR,OAAO;YACP,QAAQ;YACR,UAAU;SACX,CAAC;QAKA,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAClB,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;IACtB,CAAC;IAED,IAAI,CAAC,KAAU;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,KAAU;QACd,KAAK,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,MAAuB;QAC5B,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE3B,IAAI,MAAM,IAAI,IAAA,qCAAgB,EAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YAClE,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,IAAA,qCAAgB,EAAC,MAAM,CAAC,CAAC,CAAC;YAElD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,IAAA,kCAAc,EAAC,CAAC,MAAM,CAAC,CAAC,CAAC;aACrC;SACF;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED,OAAO,CAAC,OAAoB;QAC1B,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE;YAClB,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC;YAC9B,GAAG,IAAA,uBAAU,EAAC,OAAO,CAAC;SACvB,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,GAAW,EAAE,KAA0B;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,EAAC,CAAC,GAAG,CAAC,EAAE,KAAK,EAAC,CAAC,CAAC;IACtC,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,OAAoB,EAAE;QAC3C,IAAI,CAAC,OAAO,CAAC;YACX,QAAQ,EAAE;gBACR,GAAG,IAAI;gBACP,KAAK,EAAE,IAAI;aACZ;SACF,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,GAAG,MAAgB;QACxB,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,GAAG,QAAwB;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAC3B,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAE5B,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,EAAE,EAAE;YACpB,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAgB,CAAC,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,EAAE,CAAC,GAAG,KAA0B;QAC9B,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;QAE3B,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAe,CAAC;YAEhD,IAAI,IAAA,mBAAY,EAAC,KAAK,CAAC,EAAE;gBACvB,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,UAAU,CAAC,EAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,EAAC,CAAC,CAAC;aACtC;iBAAM;gBACL,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC;aACjD;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAAG,KAA0B;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAe,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,MAAM,CAAC,UAAU,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,EAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAAG,KAA0B;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAe,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,MAAM,CAAC,UAAU,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,EAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,GAAG,KAA0B;QACjC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEhC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAe,CAAC;YAChD,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,MAAM,CAAC,UAAU,CAAC,EAAC,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,EAAC,CAAC,CAAC;QAC5D,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,OAAkC;QACvC,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE;YAClB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAe,CAAC;YAEhD,MAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;QAEH,OAAO,IAAI,CAAC;IACd,CAAC;IAED,QAAQ,CAAC,QAAa;QACpB,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,IAAA,eAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;QACjE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,KAAK,CAAC,KAAa;QACjB,OAAO,IAAI,CAAC,MAAM,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC;IAC9B,CAAC;IAES,cAAc,CAAC,KAAU;QACjC,IAAI,IAAA,kCAA2B,EAAC,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAC;SAC5G;IACH,CAAC;IAES,eAAe,CAAC,KAAU;QAClC,IAAI,IAAA,mBAAY,EAAC,KAAK,CAAC,EAAE;YACvB,MAAM,IAAI,KAAK,CAAC,oGAAoG,CAAC,CAAC;SACvH;IACH,CAAC;IAES,cAAc;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;QAE1C,IAAI,KAAK,IAAI,CAAC,IAAA,oBAAa,EAAC,KAAK,CAAC,IAAI,CAAC,IAAA,kCAA2B,EAAC,KAAK,CAAC,EAAE;YACzE,WAAW,GAAG,WAAW,IAAI,kBAAkB,CAAC;SACjD;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAES,SAAS;QACjB,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,SAAS,CAAC;IACzC,CAAC;IAES,MAAM,CAAC,IAAW,EAAE,SAAc;QAC1C,MAAM,IAAI,GAAG,IAAA,sBAAe,EAAC,IAAI,CAAC,CAAC;QACnC,QAAQ,IAAI,EAAE;YACZ,KAAK,qBAAc,CAAC,MAAM;gBACxB,IAAI,CAAC,MAAM,GAAG,iCAAe,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;gBAC5C,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE;oBACzB,IAAI,CAAC,GAAG,EAAE,CAAC;iBACZ;gBACD,MAAM;YACR,KAAK,qBAAc,CAAC,KAAK;gBACvB,IAAI,CAAC,aAAa,GAAG,qBAAc,CAAC,KAAK,CAAC;gBAC1C,IAAA,wBAAiB,EAAC,IAAI,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC;gBACtC,MAAM;SACT;IACH,CAAC;IAES,GAAG;QACX,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,MAAM,EAAC,MAAM,EAAE,aAAa,EAAC,GAAG,IAAI,CAAC;QACrC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,SAAU,CAAC;QACzC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC;QACvC,MAAM,QAAQ,GAAG,SAAS,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC3D,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAE1C,IAAI,EAAC,WAAW,GAAG,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,EAAC,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;QAElE,IAAI,WAAW,EAAE;YACf,WAAW,GAAG,aAAa,KAAK,qBAAc,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,aAAa,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;YAChH,QAAQ,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;SACnC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;QAEtE,IAAI,OAAO,EAAE;YACX,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SAC3B;QAED,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QAExB,IAAI,IAAA,iCAAe,EAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,aAAa,KAAK,SAAS,EAAE;YACtE,IAAI,KAAK,EAAE;gBACT,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC;aACrB;SACF;QAED,0BAA0B;QAC1B,WAAW,IAAI,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAEjD,yBAAyB;QACzB,OAAO,IAAI,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAES,QAAQ,CAAC,QAAsB;QACvC,MAAM,WAAW,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;QAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,WAAW,IAAI,KAAK,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,uBAAU,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;QAEpE,IAAI,KAAK,EAAE;YACT,IAAI,IAAA,cAAO,EAAC,KAAK,CAAC,EAAE;gBAClB,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,EAAC,IAAI,EAAC,CAAC,CAAC,CAAC,CAAC;aAC7C;iBAAM;gBACL,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACpB;SACF;QAED,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAE3B,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAErB,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAElC,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAEtC,IAAI,QAAQ,EAAE;YACZ,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC1B;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AA+JD,SAAgB,OAAO,CAAC,MAAwB,EAAE,KAAqC;IACrF,MAAM,OAAO,GAAG,IAAI,sBAAsB,CAAC;QACzC,MAAM;QACN,KAAK;KACN,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;AACzB,CAAC;AAPD,0BAOC","sourcesContent":["import {\n  decorateMethodsOf,\n  decoratorTypeOf,\n  DecoratorTypes,\n  isArray,\n  isCollection,\n  isObject,\n  isPlainObject,\n  isPrimitiveOrPrimitiveClass,\n  isString,\n  Type\n} from \"@tsed/core\";\nimport {OS3Example} from \"@tsed/openspec\";\nimport {getStatusMessage, HTTP_STATUS_MESSAGES} from \"../../constants/httpStatusMessages\";\nimport {DecoratorContext} from \"../../domain/DecoratorContext\";\nimport {JsonEntityStore} from \"../../domain/JsonEntityStore\";\nimport {JsonResponse} from \"../../domain/JsonResponse\";\nimport {JsonSchema, JsonSchemaObject} from \"../../domain/JsonSchema\";\nimport {JsonHeader, JsonHeaders} from \"../../interfaces/JsonOpenSpec\";\nimport {getStatusModel} from \"../../utils/defineStatusModel\";\nimport {string} from \"../../utils/from\";\nimport {GenericValue} from \"../../utils/generics\";\nimport {isSuccessStatus} from \"../../utils/isSuccessStatus\";\nimport {mapHeaders} from \"../../utils/mapHeaders\";\n\nexport interface ReturnsChainedDecorators {\n  <T>(target: Object, propertyKey: string | symbol, descriptor: TypedPropertyDescriptor<T>): TypedPropertyDescriptor<T> | void;\n\n  (target: Function): void;\n\n  /**\n   * Set a Content-Type for the current response\n   * @param value\n   * @constructor\n   */\n  ContentType(value: string): this;\n\n  /**\n   * Add a description\n   * @param description\n   */\n  Description(description: string): this;\n\n  /**\n   * Add examples\n   * @param examples\n   */\n  Examples(examples: Record<string, OS3Example>): this;\n\n  Examples(examples: Record<string, any>): this;\n\n  Examples(examples: any): this;\n\n  /**\n   * Change the model type\n   * @param type\n   */\n  Type(type: Type<any> | any): this;\n\n  /**\n   * Change the status\n   * @param status\n   * @constructor\n   */\n  Status(status: string | number): this;\n\n  /**\n   * Add the nested types\n   * @param types\n   */\n  Of(...types: GenericValue[]): this;\n\n  /**\n   * Add the nested types\n   * @param types\n   */\n  OneOf(...types: GenericValue[]): this;\n\n  /**\n   * Add the nested types\n   * @param types\n   */\n  AllOf(...types: GenericValue[]): this;\n\n  /**\n   * Add the nested types\n   * @param types\n   */\n  AnyOf(...types: GenericValue[]): this;\n\n  /**\n   * Declare a nested generic models\n   * @param generics\n   */\n  Nested(...generics: GenericValue[]): this;\n\n  /**\n   * Add header.\n   * @param key\n   * @param value\n   */\n  Header(key: string, value: number | string | (JsonHeader & {value?: string | number | boolean})): this;\n\n  /**\n   * Add headers\n   */\n  Headers(headers: JsonHeaders): this;\n\n  /**\n   * Add location hea\n   */\n  Location(location: string, meta?: JsonHeader): this;\n\n  /**\n   * Assign partial schema\n   * @param schema\n   */\n  Schema(schema: Partial<JsonSchemaObject> | JsonSchema): this;\n\n  /**\n   * Add an inline title for the return model.\n   * @param title\n   */\n  Title(title: string): this;\n\n  /**\n   *\n   * @param groups\n   * @constructor\n   */\n  Groups(...groups: string[]): this;\n\n  [key: string]: any;\n}\n\n/**\n * @ignore\n */\nfunction isEnum(type: any) {\n  return isObject(type) && !(\"toJSON\" in type);\n}\n\nfunction mapGenerics(types: GenericValue[]) {\n  return types.map((type) => {\n    if (isEnum(type)) {\n      return string().enum(Object.values(type));\n    }\n    return type;\n  });\n}\n\n/**\n * @ignore\n */\nclass ReturnDecoratorContext extends DecoratorContext<ReturnsChainedDecorators> {\n  readonly methods: string[] = [\n    \"contentType\",\n    \"description\",\n    \"examples\",\n    \"type\",\n    \"status\",\n    \"of\",\n    \"oneOf\",\n    \"allOf\",\n    \"anyOf\",\n    \"nested\",\n    \"header\",\n    \"headers\",\n    \"schema\",\n    \"title\",\n    \"groups\",\n    \"location\"\n  ];\n\n  constructor({status, model}: any) {\n    super();\n\n    this.model(model);\n    this.status(status);\n  }\n\n  type(model: any) {\n    return this.model(model);\n  }\n\n  model(model: any) {\n    model && this.set(\"model\", model);\n    return this;\n  }\n\n  status(status: number | string) {\n    this.set(\"status\", status);\n\n    if (status && getStatusMessage(status) && !this.get(\"description\")) {\n      this.set(\"description\", getStatusMessage(status));\n\n      if (!this.get(\"model\")) {\n        this.model(getStatusModel(+status));\n      }\n    }\n\n    return this;\n  }\n\n  headers(headers: JsonHeaders) {\n    this.set(\"headers\", {\n      ...(this.get(\"headers\") || {}),\n      ...mapHeaders(headers)\n    });\n\n    return this;\n  }\n\n  header(key: string, value: string | JsonHeader) {\n    return this.headers({[key]: value});\n  }\n\n  location(path: string, meta: JsonHeaders = {}) {\n    this.headers({\n      Location: {\n        ...meta,\n        value: path\n      }\n    });\n\n    return this;\n  }\n\n  groups(...groups: string[]) {\n    this.set(\"groups\", groups);\n    return this;\n  }\n\n  nested(...generics: GenericValue[]) {\n    const model = this.get(\"model\");\n    this.checkPrimitive(model);\n    this.checkCollection(model);\n\n    this.addAction((ctx) => {\n      (this.get(\"schema\") as JsonSchema).nestedGenerics.push(mapGenerics(generics));\n    });\n\n    return this;\n  }\n\n  of(...types: (Type<any> | any)[]) {\n    const model = this.get(\"model\");\n    this.checkPrimitive(model);\n\n    this.addAction(() => {\n      const schema = this.get(\"schema\") as JsonSchema;\n\n      if (isCollection(model)) {\n        schema?.itemSchema({type: types[0]});\n      } else {\n        schema?.nestedGenerics.push(mapGenerics(types));\n      }\n    });\n\n    return this;\n  }\n\n  oneOf(...types: (Type<any> | any)[]) {\n    const model = this.get(\"model\");\n\n    this.addAction(() => {\n      const schema = this.get(\"schema\") as JsonSchema;\n      schema.type(model);\n      schema.itemSchema({oneOf: types.map((type) => ({type}))});\n    });\n\n    return this;\n  }\n\n  allOf(...types: (Type<any> | any)[]) {\n    const model = this.get(\"model\");\n\n    this.addAction(() => {\n      const schema = this.get(\"schema\") as JsonSchema;\n      schema.type(model);\n      schema.itemSchema({allOf: types.map((type) => ({type}))});\n    });\n\n    return this;\n  }\n\n  anyOf(...types: (Type<any> | any)[]) {\n    const model = this.get(\"model\");\n\n    this.addAction(() => {\n      const schema = this.get(\"schema\") as JsonSchema;\n      schema.type(model);\n      schema.itemSchema({anyOf: types.map((type) => ({type}))});\n    });\n\n    return this;\n  }\n\n  schema(partial: Partial<JsonSchemaObject>) {\n    this.addAction(() => {\n      const schema = this.get(\"schema\") as JsonSchema;\n\n      schema!.assign(partial);\n    });\n\n    return this;\n  }\n\n  examples(examples: any) {\n    this.set(\"examples\", isString(examples) ? [examples] : examples);\n    return this;\n  }\n\n  title(title: string) {\n    return this.schema({title});\n  }\n\n  protected checkPrimitive(model: any) {\n    if (isPrimitiveOrPrimitiveClass(model)) {\n      throw new Error(\"Returns.Of cannot be used with the following primitive classes: String, Number, Boolean\");\n    }\n  }\n\n  protected checkCollection(model: any) {\n    if (isCollection(model)) {\n      throw new Error(\"Returns.Nested cannot be used with the following classes: Map, Set, Array, String, Number, Boolean\");\n    }\n  }\n\n  protected getContentType() {\n    const model = this.get(\"model\");\n    let contentType = this.get(\"contentType\");\n\n    if (model && !isPlainObject(model) && !isPrimitiveOrPrimitiveClass(model)) {\n      contentType = contentType || \"application/json\";\n    }\n\n    return contentType;\n  }\n\n  protected getStatus() {\n    return this.get(\"status\") || \"default\";\n  }\n\n  protected onInit(args: any[], decorator: any) {\n    const type = decoratorTypeOf(args);\n    switch (type) {\n      case DecoratorTypes.METHOD:\n        this.entity = JsonEntityStore.from(...args);\n        if (this.entity.operation) {\n          this.map();\n        }\n        break;\n      case DecoratorTypes.CLASS:\n        this.decoratorType = DecoratorTypes.CLASS;\n        decorateMethodsOf(args[0], decorator);\n        break;\n    }\n  }\n\n  protected map() {\n    const model = this.get(\"model\");\n    const {entity, decoratorType} = this;\n    const operation = this.entity.operation!;\n    const currentStatus = this.getStatus();\n    const response = operation.ensureResponseOf(currentStatus);\n    const contentType = this.getContentType();\n\n    let {description = response.get(\"description\")} = this.toObject();\n\n    if (description) {\n      description = decoratorType === DecoratorTypes.CLASS ? response.get(\"description\") || description : description;\n      response.description(description);\n    }\n\n    const headers = this.getMergedKey(\"headers\", response.get(\"headers\"));\n\n    if (headers) {\n      response.headers(headers);\n    }\n\n    this.mapMedia(response);\n\n    if (isSuccessStatus(this.get(\"status\")) || currentStatus === \"default\") {\n      if (model) {\n        entity.type = model;\n      }\n    }\n\n    // additional info for OS2\n    contentType && operation.addProduce(contentType);\n\n    // run additional actions\n    return this.runActions();\n  }\n\n  protected mapMedia(response: JsonResponse) {\n    const contentType = this.getContentType();\n    const model = this.get(\"model\");\n    const media = response.getMedia(contentType || \"*/*\");\n    const schema = media.get(\"schema\") || new JsonSchema({type: model});\n\n    if (model) {\n      if (isArray(model)) {\n        schema.oneOf(model.map((type) => ({type})));\n      } else {\n        schema.type(model);\n      }\n    }\n\n    this.set(\"schema\", schema);\n\n    media.schema(schema);\n\n    media.groups = this.get(\"groups\");\n\n    const examples = this.get(\"examples\");\n\n    if (examples) {\n      media.examples(examples);\n    }\n\n    return media;\n  }\n}\n\n/**\n * Add responses documentation for a specific status code.\n *\n * ## Usage\n *\n * Ts.ED v5/v6 API introducing the chaining decorator concept. Now a decorator like Returns can be used with another decorators like Description.\n *\n * ::: warning\n * v5 has a basic support of the chaining decorator to facilitate the migration to v6!\n * :::\n *\n * ```typescript\n * import {Returns} from \"@tsed/schema\";\n *\n * @Controller(\"/\")\n * class MyController {\n *   @Returns(404, String).Description(\"Not Found\")\n *   @Returns(200, Model).Description(\"Success\")\n *   async myMethod(): Promise<Model> {}\n * }\n * ```\n *\n * ::: tip\n * TypeScript and your IDE will discover automatically the chained decorators. But for more details you can look on @@ReturnsChainedDecorators@@ interface, to know\n * what chained decorators are available under Returns decorator.\n * :::\n *\n * This example will produce this documentation in swagger:\n *\n * ```json\n * {\n *   \"responses\": {\n *     \"404\": {\n *       \"description\": \"Description\",\n *       \"schema\": {\"type\": \"string\"}\n *     },\n *     \"2OO\": {\n *       \"description\": \"Description\",\n *       \"schema\": {\"$ref\": \"...\"}\n *     }\n *   }\n * }\n * ```\n *\n * ## Declaring an Array\n *\n * Use chained decorators to declare an array with model as following:\n *\n * ```typescript\n * import {Returns} from \"@tsed/schema\";\n *\n * @Controller(\"/models\")\n * class ModelCtrl {\n *   @Get(\"/\")\n *   @Returns(200, Array).Of(Model).Description(\"Success\")\n *   async myMethod(): Promise<Model>  {\n *   }\n * }\n * ```\n *\n * Deprecated version:\n *\n * ```typescript\n * import {ReturnsArray} from \"@tsed/common\";\n * import {Returns} from \"@tsed/schema\";\n *\n * @Controller(\"/\")\n * class MyController {\n *   @ReturnsArray(200, Model) // deprecated\n *   async myMethod(): Promise<Model> {}\n * }\n * ```\n *\n * ### Declaring a generic model <Badge text=\"6+\"/>\n *\n * Sometime, it might be useful to use generic models. TypeScript doesn't store the generic type in the metadata. This is why we need to\n * declare explicitly the generic models with the decorators.\n *\n * One of the generic's usage, can be a paginated list. With Returns decorator it's now possible to declare generic type and generate the appropriate OpenSpec documentation.\n *\n * Starting with the pagination model, by using @@Generics@@ and @@CollectionOf@@:\n *\n * ```typescript\n * @Generics(\"T\")\n * class Pagination<T> {\n *  @CollectionOf(\"T\")\n *  data: T[];\n *\n *  @Property()\n *  totalCount: number;\n * }\n * ```\n *\n * Now, we need a model to be used with the generic Pagination model:\n *\n * ```typescript\n * class Product {\n *  @Property()\n *  id: string;\n *\n *  @Property()\n *  title: string;\n * }\n * ```\n *\n * Finally, we can use our models on a method as following:\n *\n * ```typescript\n * class Controller {\n *   @OperationPath(\"POST\", \"/\")\n *   @Returns(200, Pagination).Of(Product).Description(\"description\")\n *   async method(): Promise<Pagination<Product> | null> {\n *     return null;\n *   }\n * }\n * ```\n *\n * ### Declaring a nested generics models <Badge text=\"6+\"/>\n *\n * It's also possible to declare a nested generics models in order to have this type `Pagination<Submission<Product>>`:\n *\n * ```typescript\n * import {Generics, Property, Returns} from \"@tsed/schema\";\n * import {Post} from \"@tsed/common\";\n *\n * class Controller {\n *   @Post(\"/\")\n *   @Returns(200, Pagination).Of(Submission).Nested(Product).Description(\"description\")\n *   async method(): Promise<Pagination<Submission<Product>> | null> {\n *     return null;\n *   }\n * }\n * ```\n *\n * And here is the Submission model:\n *\n * ```typescript\n * import {Generics, Property} from \"@tsed/schema\";\n *\n * @Generics(\"T\")\n * class Submission<T> {\n *   @Property()\n *   _id: string;\n *   @Property(\"T\")\n *   data: T;\n * }\n * ```\n *\n * @param status\n * @param model\n * @decorator\n * @swagger\n * @schema\n * @response\n * @operation\n */\nexport function Returns(status?: string | number, model?: Type<any> | Type<any>[]): ReturnsChainedDecorators;\nexport function Returns(status?: string | number, model?: Type<any> | Type<any>[] | any): ReturnsChainedDecorators {\n  const context = new ReturnDecoratorContext({\n    status,\n    model\n  });\n\n  return context.build();\n}\n"]}