Merge pull request #5 from JaredCE/properly-clean-schema-references

Properly clean schema references

Author: JaredCE

README.md

@@ -81,3 +81,37 @@ const ConvertorFactory = require('index')
 
 const convertedSchema = ConvertorFactory.convert(jsonSchema)
 ```
+
+If you already have a referenced schema named "main", it will append a uuid to "main" like thus:
+
+```
+{
+  schemas: {
+    main: {
+      "type": "string"
+    }
+    "main-547d55a5-87e9-444e-8783-e64f6863d20e": {
+      "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": "object",
+              "properties": {
+                  "message": {
+                      "allOf": [
+                          {
+                              "$ref": "#/components/schemas/main"
+                          }
+                      ]
+                  }
+              }
+          }
+      }
+    }
+  }
+}
+```

package-lock.json

@@ -2,7 +2,12 @@
   "name": "json-schema-for-openapi",
   "version": "0.1.0",
   "description": "Converts a regular JSON Schema to a compatible OpenAPI 3 Schema Object, extracting out $ref schemas to their own schema object",
-  "keywords": ["json", "json-schema", "openAPI", "openAPI-v3"],
+  "keywords": [
+    "json",
+    "json-schema",
+    "openAPI",
+    "openAPI-v3"
+  ],
   "main": "index.js",
   "scripts": {
     "test": "mocha --config './test/.mocharc.js'"
@@ -25,6 +30,7 @@
     "sinon": "^14.0.0"
   },
   "dependencies": {
-    "json-schema-traverse": "^1.0.0"
+    "json-schema-traverse": "^1.0.0",
+    "uuid": "^8.3.2"
   }
 }

package.json

@@ -1,6 +1,7 @@
 'use strict'
 
-const traverse = require('json-schema-traverse');
+const traverse = require('json-schema-traverse')
+const {v4: uuid} = require('uuid')
 
 class Convertor {
     constructor(schema) {
@@ -78,25 +79,36 @@ class Convertor {
 
         traverse(this.schema, traversal)
 
+        for (const [key, value] of Object.entries(this.referencedSchemas)) {
+            const path = value.split('/').slice(1)
+            const pathKey = path.pop()
+            delete path.reduce((previous, current) => previous[current], this.schema)[pathKey]
+        }
+
+        this.removeEmpty(this.schema)
+
         if (Object.keys(this.components).includes('main') === false) {
-            // for (const [key, value] of Object.entries(this.referencedSchemas)) {
-            //     const path = value.split('/')
-            //     path.shift()
-            //     delete this.schema[path]
-            //     // const objPath = path.join('.')
-            //     // const newField = objPath.split('.').reduce((p,c)=>p&&p[c], this.schema)
-            //     // delete this.schema
-            // }
-            // console.log(this.schema)
-
-            delete this.schema.definitions
-            // if (this.schema.$schema) {
-            //     delete this.schema.$schema;
-            // }
             Object.assign(this.components.schemas, {'main': this.schema})
+        } else {
+            Object.assign(this.components.schemas, {[`main-${uuid()}`]: this.schema})
         }
+
         return this.components
     }
+
+    removeEmpty(schema) {
+        Object.keys(schema).forEach(key => {
+            if (schema[key] 
+                && typeof schema[key] === 'object'
+                && this.removeEmpty(schema[key]) === null) {
+                delete schema[key]
+            }
+        })
+
+        if (Object.keys(schema).length === 0) {
+            return null
+        }
+    }
 }
 
 module.exports = Convertor