Fix issue where we don’t use short defintions for aliased types.

domoritz · domoritz · commit 3803bd426bd1 · 2017-01-16T15:17:44.000-08:00
diff --git a/test/programs/type-aliases-alias-ref-topref/main.ts b/test/programs/type-aliases-alias-ref-topref/main.ts
@@ -1,7 +1,6 @@
 
 interface MyObject {
-    number: number;
-    string: string;
+    prop: number;
 }
 
-type MyAlias = MyObject;
+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
@@ -4,18 +4,17 @@
         "MyObject": {
             "type": "object",
             "properties": {
-                "number": {
+                "prop": {
                     "type": "number"
-                },
-                "string": {
-                    "type": "string"
                 }
             },
             "required": [
-                "number",
-                "string"
+                "prop"
             ]
+        },
+        "MyAlias": {
+            "$ref": "#/definitions/MyObject"
         }
     },
-    "$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
@@ -1,7 +1,6 @@
 
 interface MyObject {
-    number: number;
-    string: string;
+    prop: number;
 }
 
-type MyAlias = MyObject;
+type MyAlias = MyObject;
diff --git a/test/programs/type-aliases-alias-ref/schema.json b/test/programs/type-aliases-alias-ref/schema.json
@@ -1,16 +1,12 @@
 {
     "$schema": "http://json-schema.org/draft-04/schema#",
     "properties": {
-        "number": {
+        "prop": {
             "type": "number"
-        },
-        "string": {
-            "type": "string"
         }
     },
     "required": [
-        "number",
-        "string"
+        "prop"
     ],
     "type": "object"
 }
diff --git a/test/programs/type-aliases-recursive-alias-topref/main.ts b/test/programs/type-aliases-recursive-alias-topref/main.ts
@@ -4,4 +4,4 @@ interface MyObject {
     self: MyObject;
 }
 
-type MyAlias = 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
@@ -2,19 +2,7 @@
     "$schema": "http://json-schema.org/draft-04/schema#",
     "definitions": {
         "MyAlias": {
-            "properties": {
-                "alias": {
-                    "$ref": "#/definitions/MyAlias"
-                },
-                "self": {
-                    "$ref": "#/definitions/MyObject"
-                }
-            },
-            "required": [
-                "alias",
-                "self"
-            ],
-            "type": "object"
+            "$ref": "#/definitions/MyObject"
         },
         "MyObject": {
             "properties": {
@@ -32,5 +20,5 @@
             "type": "object"
         }
     },
-    "$ref": "#/definitions/MyObject"
-}
+    "$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
@@ -4,4 +4,4 @@ interface MyObject {
     self: MyObject;
 }
 
-type MyAlias = 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
@@ -2,19 +2,7 @@
     "$schema": "http://json-schema.org/draft-04/schema#",
     "definitions": {
         "MyAlias": {
-            "properties": {
-                "alias": {
-                    "$ref": "#/definitions/MyAlias"
-                },
-                "self": {
-                    "$ref": "#/definitions/MyObject"
-                }
-            },
-            "required": [
-                "alias",
-                "self"
-            ],
-            "type": "object"
+            "$ref": "#/definitions/MyObject"
         },
         "MyObject": {
             "properties": {
@@ -33,4 +21,4 @@
         }
     },
     "$ref": "#/definitions/MyObject"
-}
+}
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
@@ -63,8 +63,18 @@ describe("schema", function () {
 
     assertSchema("namespace", "main.ts", "Type");
 
-    assertSchema("type-union", "main.ts", "MyObject");
-    assertSchema("type-intersection", "main.ts", "MyObject");
+    assertSchema("type-anonymous", "main.ts", "MyObject");
+    assertSchema("type-primitives", "main.ts", "MyObject");
+    assertSchema("type-nullable", "main.ts", "MyObject");
+
+    assertSchema("optionals", "main.ts", "MyObject");
+
+    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", {
@@ -92,16 +102,17 @@ describe("schema", function () {
         useTypeAliasRef: true,
         useRootRef: true
     });
+    assertSchema("type-no-aliases-recursive-topref", "main.ts", "MyAlias", {
+        useTypeAliasRef: false,
+        useRootRef: true
+    });
 
-    assertSchema("type-anonymous", "main.ts", "MyObject");
-    assertSchema("type-primitives", "main.ts", "MyObject");
-    assertSchema("type-nullable", "main.ts", "MyObject");
-
-    assertSchema("optionals", "main.ts", "MyObject");
-
-    assertSchema("comments", "main.ts", "MyObject");
-    assertSchema("comments-override", "main.ts", "MyObject");
+    /**
+     *  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
@@ -615,7 +615,9 @@ export class JsonSchemaGenerator {
         // if it will be a $ref and it is not yet created
         if (!asRef || !this.reffedDefinitions[fullTypeName]) {
             if (asRef) { // must be here to prevent recursivity problems
-                this.reffedDefinitions[fullTypeName] = definition;
+                this.reffedDefinitions[fullTypeName] = this.args.useTypeAliasRef && symbol && reffedType && reffedType.getFlags() & ts.TypeFlags.IndexedAccess ? {
+                    "$ref": "#/definitions/" + symbol.getName()
+                } : definition;
                 if (this.args.useTitle && fullTypeName) {
                     definition.title = fullTypeName;
                 }
@@ -659,7 +661,6 @@ export class JsonSchemaGenerator {
             def.definitions = this.reffedDefinitions;
         }
         def["$schema"] = "http://json-schema.org/draft-04/schema#";
-        // console.log(JSON.stringify(def, null, 4) + "\n");
         return def;
     }
 
@@ -709,8 +710,10 @@ export function generateSchema(program: ts.Program, fullTypeName: string, args =
                     || node.kind === ts.SyntaxKind.EnumDeclaration
                     || node.kind === ts.SyntaxKind.TypeAliasDeclaration
                     ) {
+                    const symbol: ts.Symbol = (<any>node).symbol;
+                    let fullName = tc.getFullyQualifiedName(symbol);
+
                     const nodeType = tc.getTypeAtLocation(node);
-                    let fullName = tc.getFullyQualifiedName((<any>node).symbol);
 
                     // remove file name
                     // TODO: we probably don't want this eventually,

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`
`2`	`2`	`interface MyObject {`
`3`		`- number: number;`
`4`		`- string: string;`
	`3`	`+ prop: number;`
`5`	`4`	`}`
`6`	`5`
`7`		`-type MyAlias = MyObject;`
	`6`	`+type MyAlias = MyObject;`
Original file line number	Diff line number	Diff line change
`@@ -1,16 +1,12 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "http://json-schema.org/draft-04/schema#",`
`3`	`3`	`"properties": {`
`4`		`- "number": {`
	`4`	`+ "prop": {`
`5`	`5`	`"type": "number"`
`6`		`- },`
`7`		`- "string": {`
`8`		`- "type": "string"`
`9`	`6`	`}`
`10`	`7`	`},`
`11`	`8`	`"required": [`
`12`		`- "number",`
`13`		`- "string"`
	`9`	`+ "prop"`
`14`	`10`	`],`
`15`	`11`	`"type": "object"`
`16`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,4 +4,4 @@ interface MyObject {`
`4`	`4`	`self: MyObject;`
`5`	`5`	`}`
`6`	`6`
`7`		`-type MyAlias = MyObject;`
	`7`	`+type MyAlias = MyObject;`