FIX: Issue #511: Does not generate definition for Unions and Intersec…

…tion Types (#512) Co-authored-by: Dominik Moritz <domoritz@gmail.com>
YousefED · Nov 7, 2022 · fa81e79 · fa81e79
1 parent cc5075c
commit fa81e79
Show file tree

Hide file tree

Showing 7 changed files with 95 additions and 50 deletions.
diff --git a/test/programs/default-properties/schema.json b/test/programs/default-properties/schema.json
@@ -1,7 +1,7 @@
 {
  "$schema": "http://json-schema.org/draft-07/schema#",
- "properties": {
- "varBoolean": {
+ "definitions": {
+ "Foo": {
  "anyOf": [
  {
  "enum": [
@@ -15,41 +15,20 @@
  {
  "type": "number"
  }
- ],
+ ]
+ }
+ },
+ "properties": {
+ "varBoolean": {
+ "$ref": "#/definitions/Foo",
  "default": false
  },
  "varInteger": {
- "anyOf": [
- {
- "enum": [
- "a",
- "b",
- "c",
- false,
- true
- ]
- },
- {
- "type": "number"
- }
- ],
+ "$ref": "#/definitions/Foo",
  "default": 123
  },
  "varString": {
- "anyOf": [
- {
- "enum": [
- "a",
- "b",
- "c",
- false,
- true
- ]
- },
- {
- "type": "number"
- }
- ],
+ "$ref": "#/definitions/Foo",
  "default": "123"
  }
  },

diff --git a/test/programs/type-alias-or/main.ts b/test/programs/type-alias-or/main.ts
@@ -0,0 +1,8 @@
+interface A {}
+interface B {}
+
+type C = A | B;
+
+interface MyObject {
+ c: C;
+}
diff --git a/test/programs/type-alias-or/schema.json b/test/programs/type-alias-or/schema.json
@@ -0,0 +1,30 @@
+{
+ "$schema": "http://json-schema.org/draft-07/schema#",
+ "definitions": {
+ "A": {
+ "type": "object"
+ },
+ "B": {
+ "type": "object"
+ },
+ "C": {
+ "anyOf": [
+ {
+ "$ref": "#/definitions/A"
+ },
+ {
+ "$ref": "#/definitions/B"
+ }
+ ]
+ }
+ },
+ "properties": {
+ "c": {
+ "$ref": "#/definitions/C"
+ }
+ },
+ "required": [
+ "c"
+ ],
+ "type": "object"
+}
diff --git a/test/programs/type-nullable/schema.json b/test/programs/type-nullable/schema.json
@@ -1,6 +1,25 @@
 {
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
+ "MyType2": {
+ "type": [
+ "string",
+ "number"
+ ]
+ },
+ "MyType3": {
+ "anyOf": [
+ {
+ "items": {
+ "type": "number"
+ },
+ "type": "array"
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
  "MyType6": {
  "type": "object"
  }
@@ -13,22 +32,19 @@
  ]
  },
  "var2": {
- "type": [
- "string",
- "number",
- "null"
+ "anyOf": [
+ {
+ "$ref": "#/definitions/MyType2"
+ },
+ {
+ "type": "null"
+ }
  ]
  },
  "var3": {
  "anyOf": [
  {
- "items": {
- "type": "number"
- },
- "type": "array"
- },
- {
- "type": "string"
+ "$ref": "#/definitions/MyType3"
  },
  {
  "type": "null"
@@ -91,4 +107,3 @@
  ],
  "type": "object"
 }
-
diff --git a/test/programs/type-union/schema.json b/test/programs/type-union/schema.json
@@ -1,26 +1,34 @@
 {
  "$schema": "http://json-schema.org/draft-07/schema#",
- "properties": {
- "var1": {
+ "definitions": {
+ "MyType1": {
  "type": [
  "string",
  "number"
  ]
  },
- "var2": {
+ "MyType2": {
  "anyOf": [
  {
+ "type": "array",
  "items": {
  "type": "number"
- },
- "type": "array"
+ }
  },
  {
  "type": "string"
  }
  ]
  }
  },
+ "properties": {
+ "var1": {
+ "$ref": "#/definitions/MyType1"
+ },
+ "var2": {
+ "$ref": "#/definitions/MyType2"
+ }
+ },
  "required": [
  "var1",
  "var2"

diff --git a/test/schema.test.ts b/test/schema.test.ts
@@ -215,6 +215,7 @@ describe("schema", () => {
  aliasRef: true,
  topRef: true,
  });
+ assertSchema("type-alias-or", "MyObject");
  // disabled because of #80
  // assertSchema("type-aliases-recursive-alias-topref", "MyAlias", {
  // useTypeAliasRef: true,

diff --git a/typescript-json-schema.ts b/typescript-json-schema.ts
@@ -1220,14 +1220,18 @@ export class JsonSchemaGenerator {
 
  const symbol = typ.getSymbol();
  // FIXME: We can't just compare the name of the symbol - it ignores the namespace
- const isRawType =
-  !symbol ||
+ let isRawType =
+ !symbol ||
  // Window is incorrectly marked as rawType here for some reason
  (this.tc.getFullyQualifiedName(symbol) !== "Window" &&
  (this.tc.getFullyQualifiedName(symbol) === "Date" ||
  symbol.name === "integer" ||
  this.tc.getIndexInfoOfType(typ, ts.IndexKind.Number) !== undefined));
 
+ if (isRawType && reffedType?.escapedName && (typ as any).types) {
+ isRawType = false;
+ }
+
  // special case: an union where all child are string literals -> make an enum instead
  let isStringEnum = false;
  if (typ.flags & ts.TypeFlags.Union) {