Merge pull request #1 from JaredAAT/deal-with-type-arrays

Deal with type arrays

Author: JaredAAT

src/Convertor.js

@@ -53,16 +53,45 @@ class Convertor {
                 }
             }
 
-            bannedWordsRemoval()
-
             const convertNull = () => {
                 if (schema.type === 'null') {
                     schema.nullable = true
                     delete schema.type
                 }
             }
 
+            const convertTypeArrays = () => {
+                if (Array.isArray(schema.type)) {
+                    const oneOf = []
+                    for (const type of schema.type) {
+                        const obj = {}
+                        if (type === 'null') {
+                            obj.nullable = true
+                        } else {
+                            obj.type = type
+                            for (const property of Object.keys(schema)) {
+                                if (type === 'array' && property === 'items') {
+                                    obj.items = schema[property]
+                                    delete schema.items
+                                }
+
+                                if (type === 'object' && property === 'properties') {
+                                    obj.properties = schema[property]
+                                    delete schema.properties
+                                }
+                            }
+                        }
+
+                        oneOf.push(obj)
+                    }
+                    schema.oneOf = oneOf
+                    delete schema.type
+                }
+            }
+
             convertNull()
+            convertTypeArrays()
+            bannedWordsRemoval()
 
             if (this.specialProperties.indexOf(parentKeyword) !== -1) {
                 if (this.ofProperties.indexOf(parentKeyword) !== -1) {

test/schemas/complex-typeArray.json

@@ -0,0 +1,41 @@
+{
+    "$schema": "http://json-schema.org/draft-04/schema#",
+    "title": "JSON API Schema",
+    "description": "This is a schema for responses in the JSON API format. For more, see http://jsonapi.org",
+    "type": "object",
+    "required": [
+        "errors"
+    ],
+    "properties": {
+        "errors": {
+            "type": ["string", "null"],
+            "description": "this is an errors object",
+            "example": "Error occured here"
+        },
+        "error": {
+            "type": ["object", "null"],
+            "properties": {
+                "errors": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
+        "otherThing": {
+            "type": ["null", "array"],
+            "items": {
+                "type":"string"
+            }
+        },
+        "moreThing": {
+            "type": ["null", "object"],
+            "properties": {
+                "name": {
+                    "type": "string"
+                }
+            }
+        }
+    }
+}

test/src/Convertor.spec.js

@@ -20,6 +20,7 @@ const complexPropertySchema = require('../schemas/complex-property')
 const complexPropertyDefinitionSchema = require('../schemas/complex-propertyDefinition')
 const complexResolvedDefinitionSchema = require('../schemas/complex-resolvedDefinition')
 const complexNullTypeSchema = require('../schemas/complex-null')
+const complexTypeArraySchema = require('../schemas/complex-typeArray')
 
 const simpleOpenAPI = require('../openAPI/simple')
 
@@ -39,6 +40,7 @@ describe('Convertor', () => {
         delete require.cache[require.resolve('../schemas/complex-propertyDefinition')];
         delete require.cache[require.resolve('../schemas/complex-resolvedDefinition')];
         delete require.cache[require.resolve('../schemas/complex-null')];
+        delete require.cache[require.resolve('../schemas/complex-typeArray')];
         convertor = new Convertor(simpleSchema)
     });
 
@@ -393,8 +395,30 @@ describe('Convertor', () => {
         });
     });
 
+    describe('convert a schema with types that are an array', () => {
+        it('should return a schema valid for OpenAPI v3.0.0', async function() {
+            const complexConvertor = new Convertor(complexTypeArraySchema)
+            const components = complexConvertor.convert()
+
+            const cloned = JSON.parse(JSON.stringify(simpleOpenAPI))
+            let valid = await validator.validateInner(cloned, {})
+            expect(valid).to.be.true
+            Object.assign(cloned, {components})
+            expect(cloned).to.have.property('components')
+            expect(cloned.components).to.have.property('schemas')
+            expect(cloned.components.schemas).to.have.property('main')
+            expect(cloned.components.schemas.main).to.not.have.property('definitions')
+            valid = await validator.validateInner(cloned, {})
+                .catch(err => {
+                    console.log(err)
+                })
+            expect(valid).to.be.true
+        });
+    });
+
     describe('use a repo with lots of schemas to find failing ones', () => {
-        it('should convert all schemas successfully', async function() {
+        xit('should convert all schemas successfully', async function() {
+            this.timeout(5000);
             const bannedSchemas = []
 
             const url = `https://api.github.com/repos/SchemaStore/schemastore/contents/src/schemas/json`;