Merge pull request YousefED#78 from YousefED/dom/fix-77

domoritz · web-flow · commit 093b8f6f8628 · 2017-01-16T15:29:14.000-08:00
Fixes for aliased types
diff --git a/test/programs/interface-recursion/schema.json b/test/programs/interface-recursion/schema.json
@@ -7,7 +7,11 @@
             "properties":{
                 "propA":{"type":"number"},
                 "propB":{"$ref": "#/definitions/MyObject"}
-            }
+            },
+            "required": [
+                "propA",
+                "propB"
+            ]
         }
     }
 }
diff --git a/test/programs/type-alias-single/main.ts b/test/programs/type-alias-single/main.ts
@@ -0,0 +1 @@
+type MyString = string;
diff --git a/test/programs/type-alias-single/schema.json b/test/programs/type-alias-single/schema.json
@@ -0,0 +1,4 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "string"
+}
diff --git a/test/programs/type-aliases-alias-ref-topref/main.ts b/test/programs/type-aliases-alias-ref-topref/main.ts
@@ -0,0 +1,6 @@
+
+interface MyObject {
+    prop: number;
+}
+
+type MyAlias = MyObject;
diff --git a/test/programs/type-aliases-alias-ref-topref/schema.json b/test/programs/type-aliases-alias-ref-topref/schema.json
@@ -0,0 +1,20 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "MyObject": {
+            "type": "object",
+            "properties": {
+                "prop": {
+                    "type": "number"
+                }
+            },
+            "required": [
+                "prop"
+            ]
+        },
+        "MyAlias": {
+            "$ref": "#/definitions/MyObject"
+        }
+    },
+    "$ref": "#/definitions/MyAlias"
+}
diff --git a/test/programs/type-aliases-alias-ref/main.ts b/test/programs/type-aliases-alias-ref/main.ts
@@ -0,0 +1,6 @@
+
+interface MyObject {
+    prop: number;
+}
+
+type MyAlias = MyObject;
diff --git a/test/programs/type-aliases-alias-ref/schema.json b/test/programs/type-aliases-alias-ref/schema.json
@@ -0,0 +1,12 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "properties": {
+        "prop": {
+            "type": "number"
+        }
+    },
+    "required": [
+        "prop"
+    ],
+    "type": "object"
+}
diff --git a/test/programs/type-aliases-local-namsepace/main.ts b/test/programs/type-aliases-local-namsepace/main.ts
@@ -0,0 +1,16 @@
+namespace A {
+    export interface A {a: any;}
+}
+namespace B {
+    export interface B {b: any;}
+}
+namespace C {
+    import A = B.B;
+    export interface C {c: A;}
+}
+namespace D {
+    import A = C.C;
+    export interface D {d: A;}
+}
+
+interface MyObject extends D.D {}
diff --git a/test/programs/type-aliases-local-namsepace/schema.json b/test/programs/type-aliases-local-namsepace/schema.json
@@ -0,0 +1,35 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "B.B": {
+            "properties": {
+                "b": {
+                }
+            },
+            "required": [
+                "b"
+            ],
+            "type": "object"
+        },
+        "C.C": {
+            "properties": {
+                "c": {
+                    "$ref": "#/definitions/B.B"
+                }
+            },
+            "required": [
+                "c"
+            ],
+            "type": "object"
+        }
+    },
+    "properties": {
+        "d": {
+            "$ref": "#/definitions/C.C"
+        }   
+    },
+    "required": [
+        "d"
+    ],
+    "type": "object"
+}
diff --git a/test/programs/type-aliases-recursive-alias-topref/main.ts b/test/programs/type-aliases-recursive-alias-topref/main.ts
@@ -0,0 +1,7 @@
+
+interface MyObject {
+    alias: MyAlias;
+    self: MyObject;
+}
+
+type MyAlias = MyObject;
diff --git a/test/programs/type-aliases-recursive-alias-topref/schema.json b/test/programs/type-aliases-recursive-alias-topref/schema.json
@@ -0,0 +1,24 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "MyAlias": {
+            "$ref": "#/definitions/MyObject"
+        },
+        "MyObject": {
+            "properties": {
+                "alias": {
+                    "$ref": "#/definitions/MyAlias"
+                },
+                "self": {
+                    "$ref": "#/definitions/MyObject"
+                }
+            },
+            "required": [
+                "alias",
+                "self"
+            ],
+            "type": "object"
+        }
+    },
+    "$ref": "#/definitions/MyAlias"
+}
diff --git a/test/programs/type-aliases-recursive-object-topref/main.ts b/test/programs/type-aliases-recursive-object-topref/main.ts
@@ -0,0 +1,7 @@
+
+interface MyObject {
+    alias: MyAlias;
+    self: MyObject;
+}
+
+type MyAlias = MyObject;
diff --git a/test/programs/type-aliases-recursive-object-topref/schema.json b/test/programs/type-aliases-recursive-object-topref/schema.json
@@ -0,0 +1,24 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "MyAlias": {
+            "$ref": "#/definitions/MyObject"
+        },
+        "MyObject": {
+            "properties": {
+                "alias": {
+                    "$ref": "#/definitions/MyAlias"
+                },
+                "self": {
+                    "$ref": "#/definitions/MyObject"
+                }
+            },
+            "required": [
+                "alias",
+                "self"
+            ],
+            "type": "object"
+        }
+    },
+    "$ref": "#/definitions/MyObject"
+}
diff --git a/test/programs/type-aliases/main.ts b/test/programs/type-aliases/main.ts
@@ -1 +1,11 @@
 type MyString = string;
+
+interface MySubObject {
+    propA: number;
+    propB: number;
+}
+
+interface MyObject {
+    primitive: MyString;
+    object: MySubObject;
+}
diff --git a/test/programs/type-aliases/schema.json b/test/programs/type-aliases/schema.json
@@ -1,4 +1,36 @@
 {
     "$schema": "http://json-schema.org/draft-04/schema#",
-    "type": "string"
+    "definitions": {
+        "MyString": {
+            "type": "string"
+        },
+        "MySubObject": {
+            "properties": {
+                "propA": {
+                    "type": "number"
+                },
+                "propB": {
+                    "type": "number"
+                }
+            },
+            "type": "object",
+            "required": [
+                "propA",
+                "propB"
+            ]
+        }
+    },
+    "properties": {
+        "object": {
+            "$ref": "#/definitions/MySubObject"
+        },
+        "primitive": {
+            "$ref": "#/definitions/MyString"
+        }
+    },
+    "required": [
+        "primitive",
+        "object"
+    ],
+    "type": "object"
 }
diff --git a/test/programs/type-no-aliases-recursive-topref/main.ts b/test/programs/type-no-aliases-recursive-topref/main.ts
@@ -0,0 +1,7 @@
+
+interface MyObject {
+    alias: MyAlias;
+    self: MyObject;
+}
+
+type MyAlias = MyObject;
diff --git a/test/programs/type-no-aliases-recursive-topref/schema.json b/test/programs/type-no-aliases-recursive-topref/schema.json
@@ -0,0 +1,21 @@
+{
+    "$ref": "#/definitions/MyObject",
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "definitions": {
+        "MyObject": {
+            "properties": {
+                "alias": {
+                    "$ref": "#/definitions/MyObject"
+                },
+                "self": {
+                    "$ref": "#/definitions/MyObject"
+                }
+            },
+            "required": [
+                "alias",
+                "self"
+            ],
+            "type": "object"
+        }
+    }
+}
diff --git a/test/schema.test.ts b/test/schema.test.ts
@@ -9,11 +9,15 @@ const ajv = new Ajv();
 
 const base = "test/programs/";
 
-export function assertSchema(group: string, name: string, type: string, settings?: any, compilerOptions?: CompilerOptions) {
+export function assertSchema(group: string, name: string, type: string, settings: any = {}, compilerOptions?: CompilerOptions) {
     it(group + " should create correct schema", function() {
-        if (!settings) {
-            settings = TJS.getDefaultArgs();
-            settings.generateRequired = true;
+        const defaults = TJS.getDefaultArgs();
+        defaults.generateRequired = true;
+
+        for (let pref in defaults) {
+            if (!(pref in settings)) {
+                settings[pref] = defaults[pref];
+            }
         }
 
         const actual = TJS.generateSchema(TJS.getProgramFromFiles([resolve(base + group + "/" + name)], compilerOptions), type, settings);
@@ -37,9 +41,9 @@ describe("schema", function () {
     assertSchema("interface-single", "main.ts", "MyObject");
     assertSchema("interface-multi", "main.ts", "MyObject");
 
-    let settings = TJS.getDefaultArgs();
-    settings.useRootRef = true;
-    assertSchema("interface-recursion", "main.ts", "MyObject", settings); // this sample needs rootRef
+    assertSchema("interface-recursion", "main.ts", "MyObject", {
+        useRootRef: true
+    });
 
     assertSchema("module-interface-single", "main.ts", "MyObject");
 
@@ -59,12 +63,6 @@ describe("schema", function () {
 
     assertSchema("namespace", "main.ts", "Type");
 
-    assertSchema("type-union", "main.ts", "MyObject");
-    assertSchema("type-intersection", "main.ts", "MyObject");
-
-    assertSchema("type-aliases", "main.ts", "MyString");
-    assertSchema("type-aliases-fixed-size-array", "main.ts", "MyFixedSizeArray");
-    assertSchema("type-aliases-multitype-array", "main.ts", "MyArray");
     assertSchema("type-anonymous", "main.ts", "MyObject");
     assertSchema("type-primitives", "main.ts", "MyObject");
     assertSchema("type-nullable", "main.ts", "MyObject");
@@ -74,6 +72,49 @@ describe("schema", function () {
     assertSchema("comments", "main.ts", "MyObject");
     assertSchema("comments-override", "main.ts", "MyObject");
 
+    /**
+     * Type aliases
+     */
+
+    assertSchema("type-alias-single", "main.ts", "MyString");
+    assertSchema("type-aliases", "main.ts", "MyObject", {
+        useTypeAliasRef: true
+    });
+    assertSchema("type-aliases-fixed-size-array", "main.ts", "MyFixedSizeArray");
+    assertSchema("type-aliases-multitype-array", "main.ts", "MyArray");
+    assertSchema("type-aliases-local-namsepace", "main.ts", "MyObject", {
+        useTypeAliasRef: true
+    });
+
+    assertSchema("type-aliases-alias-ref", "main.ts", "MyAlias", {
+        useTypeAliasRef: true,
+        useRootRef: false
+    });
+    // disabled beacuse of #80
+    // assertSchema("type-aliases-alias-ref-topref", "main.ts", "MyAlias", {
+    //     useTypeAliasRef: true,
+    //     useRootRef: true
+    // });
+    assertSchema("type-aliases-recursive-object-topref", "main.ts", "MyObject", {
+        useTypeAliasRef: true,
+        useRootRef: true
+    });
+    // disabled beacuse of #80
+    // assertSchema("type-aliases-recursive-alias-topref", "main.ts", "MyAlias", {
+    //     useTypeAliasRef: true,
+    //     useRootRef: true
+    // });
+    assertSchema("type-no-aliases-recursive-topref", "main.ts", "MyAlias", {
+        useTypeAliasRef: false,
+        useRootRef: true
+    });
+
+    /**
+     *  unions and intersections
+     */
+
+    assertSchema("type-union", "main.ts", "MyObject");
+    assertSchema("type-intersection", "main.ts", "MyObject");
     assertSchema("type-union-tagged", "main.ts", "Shape");
     assertSchema("type-aliases-union-namespace", "main.ts", "MyModel");
 
diff --git a/typescript-json-schema.ts b/typescript-json-schema.ts

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,11 @@`
`7`	`7`	`"properties":{`
`8`	`8`	`"propA":{"type":"number"},`
`9`	`9`	`"propB":{"$ref": "#/definitions/MyObject"}`
`10`		`- }`
	`10`	`+ },`
	`11`	`+ "required": [`
	`12`	`+ "propA",`
	`13`	`+ "propB"`
	`14`	`+ ]`
`11`	`15`	`}`
`12`	`16`	`}`
`13`	`17`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +    "$schema": "http://json-schema.org/draft-04/schema#",
 +    "type": "string"
 +}