fix for issue 85 - Generates wrong schema for readonly arrays

Author: Morten Christensen

test/programs/array-readonly/main.ts

@@ -0,0 +1,3 @@
+export interface ArrayThatIsReadonly {
+  test: ReadonlyArray<any>;
+}

test/programs/array-readonly/schema.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "type": "object",
+    "properties": {
+        "test": {
+            "type": "array",
+            "items": {}
+        }
+    },
+    "required": [
+        "test"
+    ]
+}

test/schema.test.ts

@@ -68,6 +68,7 @@ describe("schema", () => {
     assertSchema("string-literals", "main.ts", "MyObject");
     assertSchema("string-literals-inline", "main.ts", "MyObject");
 
+    assertSchema("array-readonly", "main.ts", "ArrayThatIsReadonly");
     assertSchema("array-types", "main.ts", "MyArray");
     assertSchema("map-types", "main.ts", "MyObject");
 

typescript-json-schema.ts

@@ -223,7 +223,7 @@ export class JsonSchemaGenerator {
                     if (value !== undefined) {
                         definition.type = typeof value;
                         definition.enum = [ value ];
-                    } else if (symbol && symbol.getName() === "Array") {
+                    } else if (symbol && (symbol.getName() === "Array" || symbol.getName() === "ReadonlyArray")) {
                         const arrayType = (<ts.TypeReference>propertyType).typeArguments[0];
                         definition.type = "array";
                         definition.items = this.getTypeDefinition(arrayType, tc);
@@ -580,7 +580,7 @@ export class JsonSchemaGenerator {
         let returnedDefinition = definition; // returned definition, may be a $ref
 
         const symbol = typ.getSymbol();
-        const isRawType = (!symbol || symbol.name === "integer" || symbol.name === "Array" || symbol.name === "Date");
+        const isRawType = (!symbol || symbol.name === "integer" || symbol.name === "Array" || symbol.name === "ReadonlyArray" || symbol.name === "Date");
 
         // special case: an union where all child are string literals -> make an enum instead
         let isStringEnum = false;