joi-to-json 2.2.3 → 2.3.1

package/README.md

@@ -101,12 +101,18 @@ const jsonSchema = parse(joiSchema)
 
 You can optionally set below environment variables:
 
-* `CASE_PATTERN=joi-obj-12` to control which version of joi obj to test
+* `CASE_PATTERN=joi-obj-17` to control which version of joi obj to test
 
 ## Known Limitation
 
 * For `object.pattern` usage in Joi, `pattern` parameter can only be a regular expression now as I cannot convert Joi object to regex yet.
 
+## Updates
+
+**Version 2.3.0**
+
+* Supports named link for schema resuse, such as `.link('#person')`.  **For `open-api` conversion**, as the shared schemas are located in `#/components/schemas` which is not self-contained, the conversion result contains an **extra `schemas`** field so that you can extract it when required.
+
 ## License
 
 MIT

package/index.js

@@ -21,7 +21,7 @@ fs.readdirSync(parsersDir).forEach(file => {
   }
 })
 
-function parse(joiObj, type = 'json') {
+function parse(joiObj, type = 'json', definitions = {}) {
   if (typeof joiObj.describe !== 'function') {
     throw new Error('Not an joi object.')
   }
@@ -50,6 +50,7 @@ function parse(joiObj, type = 'json') {
     convertor = convertors[0]
   }
 
+  // fs.writeFileSync('./joi_spec.json', JSON.stringify(joiObj.describe(), null, 2))
   const joiBaseSpec = new convertor().toBaseSpec(joiObj.describe())
   // fs.writeFileSync(`./internal_${convertor.getSupportVersion()}_${type}.json`, JSON.stringify(joiBaseSpec, null, 2))
   const parser = parsers[type]
@@ -57,7 +58,7 @@ function parse(joiObj, type = 'json') {
     throw new Error(`No parser is registered for ${type}`)
   }
 
-  return new parser().parse(joiBaseSpec)
+  return new parser().parse(joiBaseSpec, definitions)
 }
 
 module.exports = parse

package/lib/parsers/json-draft-04.js

@@ -1,7 +1,7 @@
 const _ = require('lodash')
 const JoiJsonSchemaParser = require('./json')
 
-class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
+class JoiJsonDraftSchemaParser extends JoiJsonSchemaParser {
   _setNumberFieldProperties(fieldSchema, fieldDefn) {
     super._setNumberFieldProperties(fieldSchema, fieldDefn)
 
@@ -12,6 +12,10 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
       fieldSchema.exclusiveMaximum = true
     }
   }
+
+  _getLocalSchemaBasePath() {
+    return '#/definitions'
+  }
 }
 
-module.exports = JoiOpenApiSchemaParser
+module.exports = JoiJsonDraftSchemaParser

package/lib/parsers/json-draft-2019-09.js

@@ -1,9 +1,9 @@
 const _ = require('lodash')
 const JoiJsonSchemaParser = require('./json')
 
-class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
-  parse(joiSpec) {
-    const schema = super.parse(joiSpec)
+class JoiJsonDraftSchemaParser extends JoiJsonSchemaParser {
+  parse(joiSpec, definitions = {}, level = 0) {
+    const schema = super.parse(joiSpec, definitions, level)
 
     if (!_.isEmpty(joiSpec.metas)) {
       _.each(joiSpec.metas, meta => {
@@ -19,4 +19,4 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
   }
 }
 
-module.exports = JoiOpenApiSchemaParser
+module.exports = JoiJsonDraftSchemaParser

package/lib/parsers/json.js

@@ -10,8 +10,8 @@ class JoiJsonSchemaParser {
     this.allowUnknownFlagName = this._getAllowUnknownFlagName()
   }
 
-  parse(joiSpec) {
-    const schema = {}
+  parse(joiSpec, definitions = {}, level = 0) {
+    let schema = {}
 
     if (this._getPresence(joiSpec) === 'forbidden') {
       schema.not = {}
@@ -23,12 +23,24 @@ class JoiJsonSchemaParser {
     this._setBinaryFieldProperties(schema, joiSpec)
     this._setStringFieldProperties(schema, joiSpec)
     this._setDateFieldProperties(schema, joiSpec)
-    this._setArrayFieldProperties(schema, joiSpec)
-    this._setObjectProperties(schema, joiSpec)
-    this._setAlternativesProperties(schema, joiSpec)
-    this._setAnyProperties(schema, joiSpec)
+    this._setArrayFieldProperties(schema, joiSpec, definitions, level)
+    this._setObjectProperties(schema, joiSpec, definitions, level)
+    this._setAlternativesProperties(schema, joiSpec, definitions, level)
+    this._setAnyProperties(schema, joiSpec, definitions, level)
     this._addNullTypeIfNullable(schema, joiSpec)
     this._setMetaProperties(schema, joiSpec)
+    this._setLinkFieldProperties(schema, joiSpec)
+
+    const schemaId = _.get(joiSpec, 'flags.id')
+    if (schemaId) {
+      definitions[schemaId] = schema
+      schema = {
+        $ref: `${this._getLocalSchemaBasePath()}/${schemaId}`
+      }
+    }
+    if (level === 0 && !_.isEmpty(definitions)) {
+      _.set(schema, `${this._getLocalSchemaBasePath().replace('#/', '').replace(/\//, '.')}`, definitions)
+    }
 
     return schema
   }
@@ -53,6 +65,10 @@ class JoiJsonSchemaParser {
     return 'unknown'
   }
 
+  _getLocalSchemaBasePath() {
+    return '#/$defs'
+  }
+
   _getFieldDescription(fieldDefn) {
     return _.get(fieldDefn, 'flags.description')
   }
@@ -96,14 +112,10 @@ class JoiJsonSchemaParser {
   }
 
   _getEnum(fieldDefn) {
-    if (_.isEmpty(fieldDefn[this.enumFieldName])) {
-      return undefined
+    const enumList = fieldDefn[this.enumFieldName]
+    if (fieldDefn.flags && fieldDefn.flags.only && !_.isEmpty(enumList)) {
+      return _.uniq(enumList)
     }
-
-    const enumList = _.filter(fieldDefn[this.enumFieldName], (item) => {
-      return !_.isEmpty(item)
-    })
-    return _.isEmpty(enumList) ? undefined : enumList
   }
 
   _getUnknown(joiSpec) {
@@ -139,7 +151,7 @@ class JoiJsonSchemaParser {
     fieldSchema.format = 'binary'
   }
 
-  _setObjectProperties(schema, joiSpec) {
+  _setObjectProperties(schema, joiSpec, definitions, level) {
     if (schema.type !== 'object') {
       return
     }
@@ -150,7 +162,7 @@ class JoiJsonSchemaParser {
     schema.additionalProperties = this._getUnknown(joiSpec)
 
     _.map(joiSpec[this.childrenFieldName], (fieldDefn, key) => {
-      const fieldSchema = this.parse(fieldDefn)
+      const fieldSchema = this.parse(fieldDefn, definitions, level + 1)
       if (this._isRequired(fieldDefn)) {
         schema.required.push(key)
       }
@@ -178,7 +190,7 @@ class JoiJsonSchemaParser {
         schema.properties[patternObj.regex].additionalProperties = this._getUnknown(patternObj.rule)
 
         _.each(childKeys, (ruleObj, key) => {
-          schema.properties[patternObj.regex].properties[key] = this.parse(ruleObj)
+          schema.properties[patternObj.regex].properties[key] = this.parse(ruleObj, definitions, level + 1)
 
           if (this._isRequired(ruleObj)) {
             schema.properties[patternObj.regex].required.push(key)
@@ -305,7 +317,7 @@ class JoiJsonSchemaParser {
     })
   }
 
-  _setArrayFieldProperties(fieldSchema, fieldDefn) {
+  _setArrayFieldProperties(fieldSchema, fieldDefn, definitions, level) {
     if (fieldSchema.type !== 'array') {
       return
     }
@@ -339,10 +351,12 @@ class JoiJsonSchemaParser {
     }
 
     if (fieldDefn.items.length === 1) {
-      fieldSchema.items = this.parse(fieldDefn.items[0])
+      fieldSchema.items = this.parse(fieldDefn.items[0], definitions, level + 1)
     } else {
       fieldSchema.items = {
-        anyOf: _.map(fieldDefn.items, this.parse.bind(this))
+        anyOf: _.map(fieldDefn.items, (itemSchema) => {
+          return this.parse(itemSchema, definitions, level + 1)
+        })
       }
     }
   }
@@ -363,7 +377,7 @@ class JoiJsonSchemaParser {
     }
   }
 
-  _setAlternativesProperties(schema, joiSpec) {
+  _setAlternativesProperties(schema, joiSpec, definitions, level) {
     if (schema.type !== 'alternatives') {
       return
     }
@@ -372,23 +386,23 @@ class JoiJsonSchemaParser {
       const match = joiSpec.matches[0]
       if (match.switch) {
         schema.oneOf = _.map(match.switch, (condition) => {
-          return this.parse(condition.then || condition.otherwise)
+          return this.parse(condition.then || condition.otherwise, definitions, level + 1)
         })
       } else if (match.then || match.otherwise) {
         schema.oneOf = []
-        if (match.then) schema.oneOf.push(this.parse(match.then))
-        if (match.otherwise) schema.oneOf.push(this.parse(match.otherwise))
+        if (match.then) schema.oneOf.push(this.parse(match.then, definitions, level + 1))
+        if (match.otherwise) schema.oneOf.push(this.parse(match.otherwise, definitions, level + 1))
       }
     } else {
       schema.oneOf = _.map(joiSpec.matches, (match) => {
-        return this.parse(match.schema)
+        return this.parse(match.schema, definitions, level + 1)
       })
     }
 
     delete schema.type
   }
 
-  _setAnyProperties(schema, joiSpec) {
+  _setAnyProperties(schema, joiSpec, definitions, level) {
     if (schema.type !== 'any') {
       return
     }
@@ -397,10 +411,10 @@ class JoiJsonSchemaParser {
       const condition = joiSpec.whens[0]
       schema.oneOf = []
       if (condition.then) {
-        schema.oneOf.push(this.parse(condition.then))
+        schema.oneOf.push(this.parse(condition.then, definitions, level + 1))
       }
       if (condition.otherwise) {
-        schema.oneOf.push(this.parse(condition.otherwise))
+        schema.oneOf.push(this.parse(condition.otherwise, definitions, level + 1))
       }
       delete schema.type
       return
@@ -426,6 +440,17 @@ class JoiJsonSchemaParser {
       }
     })
   }
+
+  _setLinkFieldProperties(schema, joiSpec) {
+    if (schema.type !== 'link') {
+      return
+    }
+
+    if (_.get(joiSpec, 'link.ref.type') === 'local') {
+      schema.$ref = `${this._getLocalSchemaBasePath()}/${joiSpec.link.ref.path.join('/')}`
+      delete schema.type
+    }
+  }
 }
 
 module.exports = JoiJsonSchemaParser

package/lib/parsers/open-api.js

@@ -2,8 +2,10 @@ const _ = require('lodash')
 const JoiJsonSchemaParser = require('./json-draft-04')
 
 class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
-  parse(joiSpec) {
-    const schema = _.pick(super.parse(joiSpec), [
+  parse(joiSpec, definitions = {}, level = 0) {
+    const fullSchema = super.parse(joiSpec, definitions, level)
+    const schema = _.pick(fullSchema, [
+      '$ref',
       'title',
       'multipleOf',
       'maximum',
@@ -47,9 +49,17 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
       })
     }
 
+    if (level === 0 && !_.isEmpty(definitions)) {
+      schema.schemas = definitions
+    }
+
     return schema
   }
 
+  _getLocalSchemaBasePath() {
+    return '#/components/schemas'
+  }
+
   _setBasicProperties(fieldSchema, fieldDefn) {
     super._setBasicProperties(fieldSchema, fieldDefn)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joi-to-json",
-  "version": "2.2.3",
+  "version": "2.3.1",
   "description": "joi to JSON / OpenAPI Schema Converter",
   "main": "index.js",
   "repository": {