@tsed/schema 6.93.0 → 6.94.0

package/lib/cjs/decorators/operations/returns.d.ts

@@ -40,6 +40,21 @@ export interface ReturnsChainedDecorators {
      * @param types
      */
     Of(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    OneOf(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    AllOf(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    AnyOf(...types: GenericValue[]): this;
     /**
      * Declare a nested generic models
      * @param generics
@@ -235,4 +250,4 @@ export interface ReturnsChainedDecorators {
  * @response
  * @operation
  */
-export declare function Returns(status?: string | number, model?: Type<any>): ReturnsChainedDecorators;
+export declare function Returns(status?: string | number, model?: Type<any> | Type<any>[]): ReturnsChainedDecorators;

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

@@ -37,6 +37,9 @@ class ReturnDecoratorContext extends DecoratorContext_1.DecoratorContext {
             "type",
             "status",
             "of",
+            "oneOf",
+            "allOf",
+            "anyOf",
             "nested",
             "header",
             "headers",
@@ -111,6 +114,33 @@ class ReturnDecoratorContext extends DecoratorContext_1.DecoratorContext {
         });
         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");
@@ -193,7 +223,14 @@ class ReturnDecoratorContext extends DecoratorContext_1.DecoratorContext {
         const model = this.get("model");
         const media = response.getMedia(contentType || "*/*");
         const schema = media.get("schema") || new JsonSchema_1.JsonSchema({ type: model });
-        model && schema.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");

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

@@ -1 +1 @@
-{"version":3,"file":"returns.js","sourceRoot":"","sources":["../../../../src/decorators/operations/returns.ts"],"names":[],"mappings":";;;AAAA,qCAUoB;AAEpB,2EAA0F;AAC1F,oEAA+D;AAC/D,kEAA6D;AAE7D,wDAAqE;AAErE,qEAA6D;AAC7D,2CAAwC;AAExC,iEAA4D;AAC5D,uDAAkD;AA8FlD;;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;IAiB7E,YAAY,EAAC,MAAM,EAAE,KAAK,EAAM;QAC9B,KAAK,EAAE,CAAC;QAjBD,YAAO,GAAa;YAC3B,aAAa;YACb,aAAa;YACb,UAAU;YACV,MAAM;YACN,QAAQ;YACR,IAAI;YACJ,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,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,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5B,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,KAAuB;IACvE,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  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   * 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    \"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  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    model && schema.type(model);\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>): ReturnsChainedDecorators;\nexport function Returns(status?: string | number, model?: Type<any> | any): ReturnsChainedDecorators {\n  const context = new ReturnDecoratorContext({\n    status,\n    model\n  });\n\n  return context.build();\n}\n"]}
+{"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"]}

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

@@ -1,4 +1,4 @@
-import { decorateMethodsOf, decoratorTypeOf, DecoratorTypes, isCollection, isObject, isPlainObject, isPrimitiveOrPrimitiveClass, isString } from "@tsed/core";
+import { decorateMethodsOf, decoratorTypeOf, DecoratorTypes, isArray, isCollection, isObject, isPlainObject, isPrimitiveOrPrimitiveClass, isString } from "@tsed/core";
 import { getStatusMessage } from "../../constants/httpStatusMessages";
 import { DecoratorContext } from "../../domain/DecoratorContext";
 import { JsonEntityStore } from "../../domain/JsonEntityStore";
@@ -34,6 +34,9 @@ class ReturnDecoratorContext extends DecoratorContext {
             "type",
             "status",
             "of",
+            "oneOf",
+            "allOf",
+            "anyOf",
             "nested",
             "header",
             "headers",
@@ -108,6 +111,33 @@ class ReturnDecoratorContext extends DecoratorContext {
         });
         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");
@@ -190,7 +220,14 @@ class ReturnDecoratorContext extends DecoratorContext {
         const model = this.get("model");
         const media = response.getMedia(contentType || "*/*");
         const schema = media.get("schema") || new JsonSchema({ type: model });
-        model && schema.type(model);
+        if (model) {
+            if (isArray(model)) {
+                schema.oneOf(model.map((type) => ({ type })));
+            }
+            else {
+                schema.type(model);
+            }
+        }
         this.set("schema", schema);
         media.schema(schema);
         media.groups = this.get("groups");

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

@@ -1 +1 @@
-{"version":3,"file":"returns.js","sourceRoot":"","sources":["../../../../src/decorators/operations/returns.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,YAAY,EACZ,QAAQ,EACR,aAAa,EACb,2BAA2B,EAC3B,QAAQ,EAET,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAC,gBAAgB,EAAuB,MAAM,oCAAoC,CAAC;AAC1F,OAAO,EAAC,gBAAgB,EAAC,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAE7D,OAAO,EAAC,UAAU,EAAmB,MAAM,yBAAyB,CAAC;AAErE,OAAO,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AA8FlD;;GAEG;AACH,SAAS,MAAM,CAAC,IAAS;IACvB,OAAO,QAAQ,CAAC,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,MAAM,EAAE,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,gBAA0C;IAiB7E,YAAY,EAAC,MAAM,EAAE,KAAK,EAAM;QAC9B,KAAK,EAAE,CAAC;QAjBD,YAAO,GAAa;YAC3B,aAAa;YACb,aAAa;YACb,UAAU;YACV,MAAM;YACN,QAAQ;YACR,IAAI;YACJ,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,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YAClE,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAElD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,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,UAAU,CAAC,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,YAAY,CAAC,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,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,QAAQ,CAAC,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,2BAA2B,CAAC,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAC;SAC5G;IACH,CAAC;IAES,eAAe,CAAC,KAAU;QAClC,IAAI,YAAY,CAAC,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,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,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,eAAe,CAAC,IAAI,CAAC,CAAC;QACnC,QAAQ,IAAI,EAAE;YACZ,KAAK,cAAc,CAAC,MAAM;gBACxB,IAAI,CAAC,MAAM,GAAG,eAAe,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,cAAc,CAAC,KAAK;gBACvB,IAAI,CAAC,aAAa,GAAG,cAAc,CAAC,KAAK,CAAC;gBAC1C,iBAAiB,CAAC,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,cAAc,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,eAAe,CAAC,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,UAAU,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;QAEpE,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAE5B,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,MAAM,UAAU,OAAO,CAAC,MAAwB,EAAE,KAAuB;IACvE,MAAM,OAAO,GAAG,IAAI,sBAAsB,CAAC;QACzC,MAAM;QACN,KAAK;KACN,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,KAAK,EAAE,CAAC;AACzB,CAAC","sourcesContent":["import {\n  decorateMethodsOf,\n  decoratorTypeOf,\n  DecoratorTypes,\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   * 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    \"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  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    model && schema.type(model);\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>): ReturnsChainedDecorators;\nexport function Returns(status?: string | number, model?: Type<any> | any): ReturnsChainedDecorators {\n  const context = new ReturnDecoratorContext({\n    status,\n    model\n  });\n\n  return context.build();\n}\n"]}
+{"version":3,"file":"returns.js","sourceRoot":"","sources":["../../../../src/decorators/operations/returns.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,OAAO,EACP,YAAY,EACZ,QAAQ,EACR,aAAa,EACb,2BAA2B,EAC3B,QAAQ,EAET,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAC,gBAAgB,EAAuB,MAAM,oCAAoC,CAAC;AAC1F,OAAO,EAAC,gBAAgB,EAAC,MAAM,+BAA+B,CAAC;AAC/D,OAAO,EAAC,eAAe,EAAC,MAAM,8BAA8B,CAAC;AAE7D,OAAO,EAAC,UAAU,EAAmB,MAAM,yBAAyB,CAAC;AAErE,OAAO,EAAC,cAAc,EAAC,MAAM,+BAA+B,CAAC;AAC7D,OAAO,EAAC,MAAM,EAAC,MAAM,kBAAkB,CAAC;AAExC,OAAO,EAAC,eAAe,EAAC,MAAM,6BAA6B,CAAC;AAC5D,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAgHlD;;GAEG;AACH,SAAS,MAAM,CAAC,IAAS;IACvB,OAAO,QAAQ,CAAC,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,MAAM,EAAE,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,gBAA0C;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,gBAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE;YAClE,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAAC;YAElD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;gBACtB,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,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,UAAU,CAAC,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,YAAY,CAAC,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,QAAQ,CAAC,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,2BAA2B,CAAC,KAAK,CAAC,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yFAAyF,CAAC,CAAC;SAC5G;IACH,CAAC;IAES,eAAe,CAAC,KAAU;QAClC,IAAI,YAAY,CAAC,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,aAAa,CAAC,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,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,eAAe,CAAC,IAAI,CAAC,CAAC;QACnC,QAAQ,IAAI,EAAE;YACZ,KAAK,cAAc,CAAC,MAAM;gBACxB,IAAI,CAAC,MAAM,GAAG,eAAe,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,cAAc,CAAC,KAAK;gBACvB,IAAI,CAAC,aAAa,GAAG,cAAc,CAAC,KAAK,CAAC;gBAC1C,iBAAiB,CAAC,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,cAAc,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,eAAe,CAAC,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,UAAU,CAAC,EAAC,IAAI,EAAE,KAAK,EAAC,CAAC,CAAC;QAEpE,IAAI,KAAK,EAAE;YACT,IAAI,OAAO,CAAC,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,MAAM,UAAU,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","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"]}

package/lib/types/decorators/operations/returns.d.ts

@@ -40,6 +40,21 @@ export interface ReturnsChainedDecorators {
      * @param types
      */
     Of(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    OneOf(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    AllOf(...types: GenericValue[]): this;
+    /**
+     * Add the nested types
+     * @param types
+     */
+    AnyOf(...types: GenericValue[]): this;
     /**
      * Declare a nested generic models
      * @param generics
@@ -235,4 +250,4 @@ export interface ReturnsChainedDecorators {
  * @response
  * @operation
  */
-export declare function Returns(status?: string | number, model?: Type<any>): ReturnsChainedDecorators;
+export declare function Returns(status?: string | number, model?: Type<any> | Type<any>[]): ReturnsChainedDecorators;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tsed/schema",
-  "version": "6.93.0",
+  "version": "6.94.0",
   "description": "JsonSchema module for Ts.ED Framework",
   "private": false,
   "source": "./src/index.ts",
@@ -29,8 +29,8 @@
     "tsed"
   ],
   "dependencies": {
-    "@tsed/core": "6.93.0",
-    "@tsed/openspec": "6.93.0",
+    "@tsed/core": "6.94.0",
+    "@tsed/openspec": "6.94.0",
     "camel-case": "4.1.2",
     "json-schema": "0.4.0",
     "micromatch": "4.0.2",
@@ -45,8 +45,8 @@
     "fs-extra": "9.0.1"
   },
   "peerDependencies": {
-    "@tsed/core": "^6.93.0",
-    "@tsed/openspec": "^6.93.0"
+    "@tsed/core": "^6.94.0",
+    "@tsed/openspec": "^6.94.0"
   },
   "repository": "https://github.com/tsedio/tsed",
   "bugs": {