Merge fix-jsonschema

packages/core/src/class/ProxyMap.ts

@@ -7,6 +7,7 @@ export interface ProxyMapSettings {
 
 /**
  * @private
+ * @deprecated
  */
 export abstract class ProxyMap<T, I> implements Map<T, I> {
   readonly [Symbol.toStringTag]: "Map" = "Map";
@@ -18,6 +19,47 @@ export abstract class ProxyMap<T, I> implements Map<T, I> {
     }
   }
 
+  /**
+   * Return the size of the map.
+   * @returns {number}
+   */
+  get size() {
+    return this.registry.size;
+  }
+
+  /**
+   *
+   * @param value
+   * @param query
+   * @returns {boolean}
+   */
+  private static query(value: any, query: any): boolean {
+    /* istanbul ignore next */
+    if (!query) {
+      return true;
+    }
+
+    if (value === query) {
+      return true;
+    }
+
+    /* istanbul ignore else */
+    if (typeof value === "object") {
+      return !!Object.keys(query).find(key => {
+        /* istanbul ignore else */
+        if (value[key] && query[key]) {
+          return this.query(value[key], query[key]);
+        }
+
+        /* istanbul ignore next */
+        return false;
+      });
+    }
+
+    /* istanbul ignore next */
+    return false;
+  }
+
   /**
    *
    * @returns {IterableIterator<[T , I]>}
@@ -145,45 +187,4 @@ export abstract class ProxyMap<T, I> implements Map<T, I> {
 
     return map;
   }
-
-  /**
-   * Return the size of the map.
-   * @returns {number}
-   */
-  get size() {
-    return this.registry.size;
-  }
-
-  /**
-   *
-   * @param value
-   * @param query
-   * @returns {boolean}
-   */
-  private static query(value: any, query: any): boolean {
-    /* istanbul ignore next */
-    if (!query) {
-      return true;
-    }
-
-    if (value === query) {
-      return true;
-    }
-
-    /* istanbul ignore else */
-    if (typeof value === "object") {
-      return !!Object.keys(query).find(key => {
-        /* istanbul ignore else */
-        if (value[key] && query[key]) {
-          return this.query(value[key], query[key]);
-        }
-
-        /* istanbul ignore next */
-        return false;
-      });
-    }
-
-    /* istanbul ignore next */
-    return false;
-  }
 }

packages/core/src/class/ProxyRegistry.ts

@@ -2,6 +2,7 @@ import {ProxyMap} from "./ProxyMap";
 import {Registry, RegistryKey} from "./Registry";
 /**
  * @private
+ * @deprecated
  */
 export abstract class ProxyRegistry<T, I> extends ProxyMap<RegistryKey, T> {
   constructor(protected registry: Registry<T, I>) {

packages/core/src/class/Storable.ts

@@ -4,6 +4,9 @@ import {Entity} from "./Entity";
 import {Metadata} from "./Metadata";
 import {Store} from "./Store";
 
+/**
+ * @deprecated Will be removed in v6
+ */
 export abstract class Storable extends Entity {
   /**
    * Required entity.

packages/schema/src/decorators/common/example.spec.ts

@@ -13,11 +13,11 @@ describe("@Example", () => {
 
     // THEN
     expect(getJsonSchema(Model)).to.deep.equal({
-      examples: {
-        default: {
+      examples: [
+        {
           id: "id"
         }
-      },
+      ],
       type: "object"
     });
   });
@@ -28,9 +28,7 @@ describe("@Example", () => {
 
     // THEN
     expect(getJsonSchema(Model)).to.deep.equal({
-      examples: {
-        name: "description"
-      },
+      examples: ["description"],
       type: "object"
     });
   });

packages/schema/src/decorators/common/example.ts

@@ -1,4 +1,4 @@
-import {DecoratorParameters, DecoratorTypes, getDecoratorType, UnsupportedDecoratorType} from "@tsed/core";
+import {DecoratorParameters, DecoratorTypes, getDecoratorType, isObject, UnsupportedDecoratorType} from "@tsed/core";
 import {JsonEntityStore} from "../../domain/JsonEntityStore";
 import {JsonEntityFn} from "./jsonEntityFn";
 

packages/schema/src/decorators/operations/returns.spec.ts

@@ -8,7 +8,46 @@ describe("@Returns", () => {
     class Controller {
       @OperationPath("POST", "/")
       @(Returns(200, String).Description("description"))
-      method() {}
+      method() {
+      }
+    }
+
+    // THEN
+    const spec = getSpec(Controller, {spec: SpecTypes.SWAGGER});
+
+    expect(spec).to.deep.equal({
+      definitions: {},
+      tags: [
+        {
+          name: "Controller"
+        }
+      ],
+      paths: {
+        "/": {
+          post: {
+            operationId: "controllerMethod",
+            parameters: [],
+            responses: {
+              "200": {
+                description: "description",
+                schema: {
+                  type: "string"
+                }
+              }
+            },
+            tags: ["Controller"]
+          }
+        }
+      }
+    });
+  });
+  it("should declare a return type (Status().Type())", async () => {
+    // WHEN
+    class Controller {
+      @OperationPath("POST", "/")
+      @Returns().Status(200).Type(String).Description("description")
+      method() {
+      }
     }
 
     // THEN
@@ -54,7 +93,8 @@ describe("@Returns", () => {
         .Schema({
           minLength: 3
         }))
-      method() {}
+      method() {
+      }
     }
 
     // THEN
@@ -106,7 +146,8 @@ describe("@Returns", () => {
         .Description("description")
         .ContentType("text/json")
         .Examples("Examples"))
-      method() {}
+      method() {
+      }
     }
 
     // THEN
@@ -149,10 +190,11 @@ describe("@Returns", () => {
     // WHEN
     class Controller {
       @OperationPath("POST", "/")
-      @(Returns(400).Description("Bad request"))
+      @Returns(400).Description("Bad request")
       @Returns(401)
-      @(Returns(200).Description("Success"))
-      method() {}
+      @Returns(200).Description("Success")
+      method() {
+      }
     }
 
     // THEN
@@ -170,11 +212,14 @@ describe("@Returns", () => {
           post: {
             operationId: "controllerMethod",
             parameters: [],
+            "produces": [
+              "text/json"
+            ],
             responses: {
               "200": {
                 description: "Success",
                 schema: {
-                  type: "string"
+                  type: "object"
                 }
               },
               "401": {
@@ -205,7 +250,8 @@ describe("@Returns", () => {
         @(Returns(200, String)
           .Of(Array)
           .Description("description"))
-        method() {}
+        method() {
+        }
       }
     } catch (er) {
       actualError = er;
@@ -222,7 +268,8 @@ describe("@Returns", () => {
         @(Returns(200, Array)
           .Nested(Set)
           .Description("description"))
-        method() {}
+        method() {
+        }
       }
     } catch (er) {
       actualError = er;
@@ -231,7 +278,8 @@ describe("@Returns", () => {
     actualError.message.should.eq("Returns.Nested cannot be used with the following classes: Map, Set, Array, String, Number, Boolean");
   });
   it("should throw an error when the decorator isn't correctly used", async () => {
-    class Test {}
+    class Test {
+    }
 
     // WHEN
     let actualError: any;
@@ -251,7 +299,8 @@ describe("@Returns", () => {
       @(Returns(200, Array)
         .Of(String)
         .Description("description"))
-      method() {}
+      method() {
+      }
     }
 
     // THEN
@@ -299,7 +348,8 @@ describe("@Returns", () => {
       @(Returns(200, Array)
         .Of(Model)
         .Description("description"))
-      method() {}
+      method() {
+      }
     }
 
     // THEN