Correct schema for mapped object with other keys (#567)

* allow-extra-props-where-pattern-properties-not-empty * object mapped and other keys * docs * remove unnecessary changes * remove unnecessary changes 2 * remove unnecessary changes 3 * remove unnecessary changes 4 * fix auto test * fix comment * 0.60.0 * Back to 0.59.0 --------- Co-authored-by: netanel-mce <[email protected]>
YousefED · Aug 24, 2023 · f38327e · f38327e
1 parent 3662786
commit f38327e
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 4 deletions.
diff --git a/api.md b/api.md
@@ -1285,6 +1285,17 @@ interface SomeOtherDefinition {
 ```
 
 
+## [numeric-keys-and-others](./test/programs/numeric-keys-and-others)
+
+```ts
+interface NumericKeysAndOthers {
+    [key: number]: number;
+    a: string;
+    b: boolean;
+}
+```
+
+
 ## [object-numeric-index](./test/programs/object-numeric-index)
 
 ```ts

diff --git a/test/programs/numeric-keys-and-others/main.ts b/test/programs/numeric-keys-and-others/main.ts
@@ -0,0 +1,5 @@
+interface NumericKeysAndOthers {
+    [key: number]: number;
+    a: string;
+    b: boolean;
+}
diff --git a/test/programs/numeric-keys-and-others/schema.json b/test/programs/numeric-keys-and-others/schema.json
@@ -0,0 +1,22 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "additionalProperties": false,
+    "patternProperties": {
+        "^[0-9]+$": {
+            "type": "number"
+        }
+    },
+    "properties": {
+        "a": {
+            "type": "string"
+        },
+        "b": {
+            "type": "boolean"
+        }
+    },
+    "required": [
+        "a",
+        "b"
+    ],
+    "type": "object"
+}
diff --git a/test/schema.test.ts b/test/schema.test.ts
@@ -379,6 +379,7 @@ describe("schema", () => {
         assertSchema("array-empty", "MyEmptyArray");
         assertSchema("map-types", "MyObject");
         assertSchema("extra-properties", "MyObject");
+        assertSchema("numeric-keys-and-others", "NumericKeysAndOthers");
     });
 
     describe("string literals", () => {

diff --git a/typescript-json-schema.ts b/typescript-json-schema.ts
@@ -721,6 +721,9 @@ export class JsonSchemaGenerator {
                         definition.patternProperties = {
                             [NUMERIC_INDEX_PATTERN]: this.getTypeDefinition(arrayType),
                         };
+                        if (!!Array.from((<any>propertyType).members)?.find((member: [string]) => member[0] !== "__index")) {
+                            this.getClassDefinition(propertyType, definition);
+                        }
                     } else {
                         definition.type = "array";
                         if (!definition.items) {
@@ -1079,8 +1082,8 @@ export class JsonSchemaGenerator {
                     }
                     const indexSymbol: ts.Symbol = (<any>indexSignature.parameters[0]).symbol;
                     const indexType = this.tc.getTypeOfSymbolAtLocation(indexSymbol, node);
-                    const isStringIndexed = indexType.flags === ts.TypeFlags.String;
-                    if (indexType.flags !== ts.TypeFlags.Number && !isStringIndexed) {
+                    const isIndexedObject = indexType.flags === ts.TypeFlags.String || indexType.flags === ts.TypeFlags.Number;
+                    if (indexType.flags !== ts.TypeFlags.Number && !isIndexedObject) {
                         throw new Error(
                             "Not supported: IndexSignatureDeclaration with index symbol other than a number or a string"
                         );
@@ -1105,9 +1108,11 @@ export class JsonSchemaGenerator {
                     if (!def) {
                         def = this.getTypeDefinition(typ, undefined, "anyOf");
                     }
-                    if (isStringIndexed) {
+                    if (isIndexedObject) {
                         definition.type = "object";
-                        definition.additionalProperties = def;
+                        if (!Object.keys(definition.patternProperties || {}).length) {
+                            definition.additionalProperties = def;
+                        }
                     } else {
                         definition.type = "array";
                         if (!definition.items) {