joi-to-json 2.4.0 → 2.5.0

package/README.md

@@ -95,6 +95,13 @@ const jsonSchema = parse(joiSchema)
 // const openApiSchema = parse(joiSchema, 'open-api')
 ```
 
+## Browser support
+For generating JSON Schema in a browser you should use below import syntax for `joi` library in order to work because the `joi` browser minimized build does not have `describe` api which the `joi-to-json` relies on.
+
+```typescript
+  import Joi from 'joi/lib/index';
+```
+
 ## Test
 
 >npm run test

package/index.d.ts

@@ -1,18 +1,18 @@
-import Joi from 'joi-17';
-
-declare module Joi2Json {
-  /**
-   * @type {string}
-   */
-  export type Mode = 'json' | 'open-api' | 'json-draft-2019-09' | 'json-draft-04';
-
-  /**
-   * @param {string} joi - A Joi schema.
-   * @param {string} [mode='json'] - json / open-api / json-draft-2019-09 / json-draft-04
-   * @param {Record} [sharedSchema={}] - Passed-in object storing shared schemas
-   * @returns {any} Converted JSON schema object.
-   */
-  export function parse(joi: Joi.Schema, mode?: Mode, sharedSchema?: Record<string, any>): any;
-}
-
-export default Joi2Json.parse;
+import Joi from 'joi-17';
+
+declare module Joi2Json {
+  /**
+   * @type {string}
+   */
+  export type Mode = 'json' | 'open-api' | 'json-draft-2019-09' | 'json-draft-04';
+
+  /**
+   * @param {string} joi - A Joi schema.
+   * @param {string} [mode='json'] - json / open-api / json-draft-2019-09 / json-draft-04
+   * @param {Record} [sharedSchema={}] - Passed-in object storing shared schemas
+   * @returns {any} Converted JSON schema object.
+   */
+  export function parse(joi: Joi.Schema, mode?: Mode, sharedSchema?: Record<string, any>): any;
+}
+
+export default Joi2Json.parse;

package/index.js

@@ -1,25 +1,26 @@
 const cmp = require('semver-compare')
-const fs = require('fs')
-const path = require('path')
 
-const convertorsDir = path.resolve(__dirname, './lib/convertors')
-const parsersDir = path.resolve(__dirname, './lib/parsers')
-const convertors = []
-const parsers = {}
+const c17 = require('./lib/convertors/v17')
+const c16 = require('./lib/convertors/v16')
+const c15 = require('./lib/convertors/v15')
+const c14 = require('./lib/convertors/v14')
+const c13 = require('./lib/convertors/v13')
+const c12 = require('./lib/convertors/v12')
 
-fs.readdirSync(convertorsDir).sort().reverse().forEach(file => {
-  if (file.endsWith('.js')) {
-    const convertor = require(`${convertorsDir}/${file}`)
-    convertors.push(convertor)
-  }
-})
+const JoiJsonSchemaParser = require('./lib/parsers/json')
+const JoiOpenApiSchemaParser = require('./lib/parsers/open-api')
+const JoiJsonDraftSchemaParser19 = require('./lib/parsers/json-draft-2019-09')
+const JoiJsonDraftSchemaParser = require('./lib/parsers/json-draft-04')
 
-fs.readdirSync(parsersDir).forEach(file => {
-  if (file.endsWith('.js')) {
-    const parser = require(`${parsersDir}/${file}`)
-    parsers[file.split('.')[0]] = parser
-  }
-})
+const convertors = [
+  c17, c16, c15, c14, c13, c12
+]
+const parsers = {
+  'json-draft-2019-09': JoiJsonDraftSchemaParser19,
+  'json-draft-4': JoiJsonDraftSchemaParser,
+  json: JoiJsonSchemaParser,
+  'open-api': JoiOpenApiSchemaParser
+}
 
 function parse(joiObj, type = 'json', definitions = {}) {
   if (typeof joiObj.describe !== 'function') {

package/lib/parsers/json.js

@@ -1,484 +1,484 @@
-/* eslint no-use-before-define: 'off' */
-const _ = require('lodash')
-
-class JoiJsonSchemaParser {
-  constructor() {
-    this.childrenFieldName = this._getChildrenFieldName()
-    this.optionsFieldName = this._getOptionsFieldName()
-    this.ruleArgFieldName = this._getRuleArgFieldName()
-    this.enumFieldName = this._getEnumFieldName()
-    this.allowUnknownFlagName = this._getAllowUnknownFlagName()
-  }
-
-  parse(joiSpec, definitions = {}, level = 0) {
-    let schema = {}
-
-    if (this._getPresence(joiSpec) === 'forbidden') {
-      schema.not = {}
-      return schema
-    }
-
-    this._setBasicProperties(schema, joiSpec)
-    this._setNumberFieldProperties(schema, joiSpec)
-    this._setBinaryFieldProperties(schema, joiSpec)
-    this._setStringFieldProperties(schema, joiSpec)
-    this._setDateFieldProperties(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)
-
-    if (!_.isEmpty(joiSpec.shared)) {
-      this.parse(joiSpec.shared[0], definitions, level)
-    }
-
-    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
-  }
-
-  _getChildrenFieldName() {
-    return 'keys'
-  }
-
-  _getOptionsFieldName() {
-    return 'preferences'
-  }
-
-  _getRuleArgFieldName() {
-    return 'args'
-  }
-
-  _getEnumFieldName() {
-    return 'allow'
-  }
-
-  _getAllowUnknownFlagName() {
-    return 'unknown'
-  }
-
-  _getLocalSchemaBasePath() {
-    return '#/$defs'
-  }
-
-  _getFieldDescription(fieldDefn) {
-    return _.get(fieldDefn, 'flags.description')
-  }
-
-  _getFieldType(fieldDefn) {
-    let type = fieldDefn.type
-    if (type === 'number' && !_.isEmpty(fieldDefn.rules) &&
-      fieldDefn.rules[0].name === 'integer') {
-      type = 'integer'
-    }
-    return type
-  }
-
-  _addNullTypeIfNullable(fieldSchema, fieldDefn) {
-    // This should always be the last call in parse
-    const enums = _.get(fieldDefn, this.enumFieldName)
-    if (Array.isArray(enums) && enums.includes(null)) {
-      fieldSchema.type = [fieldSchema.type, 'null']
-    }
-  }
-
-  _getFieldExample(fieldDefn) {
-    return _.get(fieldDefn, 'examples')
-  }
-
-  _getPresence(fieldDefn) {
-    const presence = _.get(fieldDefn, 'flags.presence')
-    if (presence !== undefined) {
-      return presence
-    }
-    return _.get(fieldDefn, `${this.optionsFieldName}.presence`)
-  }
-
-  _isRequired(fieldDefn) {
-    const presence = this._getPresence(fieldDefn)
-    return presence === 'required'
-  }
-
-  _getDefaultValue(fieldDefn) {
-    return _.get(fieldDefn, 'flags.default')
-  }
-
-  _getConst(fieldDefn) {
-    const enumList = fieldDefn[this.enumFieldName]
-    if (fieldDefn.flags && fieldDefn.flags.only && _.size(enumList) === 1) {
-      return enumList[0]
-    }
-  }
-
-  _getEnum(fieldDefn) {
-    const enumList = fieldDefn[this.enumFieldName]
-    if (fieldDefn.flags && fieldDefn.flags.only && _.size(enumList) > 1) {
-      return _.uniq(enumList)
-    }
-  }
-
-  _getUnknown(joiSpec) {
-    let allowUnknown = _.get(joiSpec, `${this.optionsFieldName}.allowUnknown`, false)
-    if (joiSpec.flags && typeof joiSpec.flags[this.allowUnknownFlagName] !== 'undefined') {
-      allowUnknown = joiSpec.flags[this.allowUnknownFlagName]
-    }
-    return allowUnknown
-  }
-
-  _setIfNotEmpty(schema, field, value) {
-    if (value !== null && value !== undefined) {
-      schema[field] = value
-    }
-  }
-
-  _setBasicProperties(fieldSchema, fieldDefn) {
-    this._setIfNotEmpty(fieldSchema, 'type', this._getFieldType(fieldDefn))
-    this._setIfNotEmpty(fieldSchema, 'examples', this._getFieldExample(fieldDefn))
-    this._setIfNotEmpty(fieldSchema, 'description', this._getFieldDescription(fieldDefn))
-    this._setIfNotEmpty(fieldSchema, 'default', this._getDefaultValue(fieldDefn))
-    this._setIfNotEmpty(fieldSchema, 'const', this._getConst(fieldDefn))
-    this._setIfNotEmpty(fieldSchema, 'enum', this._getEnum(fieldDefn))
-  }
-
-  _setBinaryFieldProperties(fieldSchema, fieldDefn) {
-    if (fieldSchema.type !== 'binary') {
-      return
-    }
-    fieldSchema.type = 'string'
-    if (fieldDefn.flags && fieldDefn.flags.encoding) {
-      fieldSchema.contentEncoding = fieldDefn.flags.encoding
-    }
-    fieldSchema.format = 'binary'
-  }
-
-  _setObjectProperties(schema, joiSpec, definitions, level) {
-    if (schema.type !== 'object') {
-      return
-    }
-
-    schema.properties = {}
-    schema.required = []
-
-    schema.additionalProperties = this._getUnknown(joiSpec)
-
-    _.map(joiSpec[this.childrenFieldName], (fieldDefn, key) => {
-      const fieldSchema = this.parse(fieldDefn, definitions, level + 1)
-      if (this._isRequired(fieldDefn)) {
-        schema.required.push(key)
-      }
-
-      schema.properties[key] = fieldSchema
-    })
-
-    /**
-     * For dynamic key scenarios to store the pattern as key
-     * and have the properties be as with other examples
-     */
-    if (joiSpec.patterns) {
-      _.each(joiSpec.patterns, patternObj => {
-        if (typeof patternObj.rule !== 'object' || typeof patternObj.regex === 'undefined') {
-          return
-        }
-
-        schema.properties[patternObj.regex] = {
-          type: patternObj.rule.type,
-          properties: {}
-        }
-        schema.properties[patternObj.regex].required = []
-
-        const childKeys = patternObj.rule.keys || patternObj.rule.children
-        schema.properties[patternObj.regex].additionalProperties = this._getUnknown(patternObj.rule)
-
-        _.each(childKeys, (ruleObj, key) => {
-          schema.properties[patternObj.regex].properties[key] = this.parse(ruleObj, definitions, level + 1)
-
-          if (this._isRequired(ruleObj)) {
-            schema.properties[patternObj.regex].required.push(key)
-          }
-        })
-
-        schema.patternProperties = schema.patternProperties || {}
-
-        let regexString = patternObj.regex
-        regexString = regexString.indexOf('/') === 0 ? regexString.substring(1) : regexString
-        regexString = regexString.lastIndexOf('/') > -1 ? regexString.substring(0, regexString.length - 1) : regexString
-
-        schema.patternProperties[regexString] = schema.properties[patternObj.regex]
-      })
-    }
-
-    if (_.isEmpty(schema.required)) {
-      delete schema.required
-    }
-  }
-
-  _setNumberFieldProperties(fieldSchema, fieldDefn) {
-    if (fieldSchema.type !== 'number' && fieldSchema.type !== 'integer') {
-      return
-    }
-
-    const ruleArgFieldName = this.ruleArgFieldName
-
-    _.each(fieldDefn.rules, (rule) => {
-      const value = rule[ruleArgFieldName]
-      switch (rule.name) {
-        case 'max':
-          fieldSchema.maximum = value.limit
-          break
-        case 'min':
-          fieldSchema.minimum = value.limit
-          break
-        case 'greater':
-          fieldSchema.exclusiveMinimum = value.limit
-          fieldSchema.minimum = value.limit
-          break
-        case 'less':
-          fieldSchema.exclusiveMaximum = value.limit
-          fieldSchema.maximum = value.limit
-          break
-        case 'multiple':
-          fieldSchema.multipleOf = value.base
-          break
-        default:
-          break
-      }
-    })
-  }
-
-  _setStringFieldProperties(fieldSchema, fieldDefn) {
-    if (fieldSchema.type !== 'string') {
-      return
-    }
-
-    if (fieldDefn.flags && fieldDefn.flags.encoding) {
-      fieldSchema.contentEncoding = fieldDefn.flags.encoding
-    }
-
-    const ruleArgFieldName = this.ruleArgFieldName
-
-    _.forEach(fieldDefn.rules, (rule) => {
-      switch (rule.name) {
-        case 'min':
-          fieldSchema.minLength = rule[ruleArgFieldName].limit
-          break
-        case 'max':
-          fieldSchema.maxLength = rule[ruleArgFieldName].limit
-          break
-        case 'email':
-          fieldSchema.format = 'email'
-          break
-        case 'hostname':
-          fieldSchema.format = 'hostname'
-          break
-        case 'uri':
-          fieldSchema.format = 'uri'
-          break
-        case 'ip':
-          const versions = rule[ruleArgFieldName].options.version
-          if (!_.isEmpty(versions)) {
-            if (versions.length === 1) {
-              fieldSchema.format = versions[0]
-            } else {
-              fieldSchema.oneOf = _.map(versions, (version) => {
-                return {
-                  format: version
-                }
-              })
-            }
-          } else {
-            fieldSchema.format = 'ipv4'
-          }
-          break
-        case 'pattern':
-          let regex = rule[ruleArgFieldName].regex
-          let idx = regex.indexOf('/')
-          if (idx === 0) {
-            regex = regex.replace('/', '')
-          }
-          idx = regex.lastIndexOf('/') === regex.length - 1
-          if (idx > -1) {
-            regex = regex.replace(/\/$/, '')
-          }
-          fieldSchema.pattern = regex
-          break
-        case 'isoDate':
-          fieldSchema.format = 'date-time'
-          break
-        case 'isoDuration':
-          fieldSchema.format = 'duration'
-          break
-        case 'uuid':
-        case 'guid':
-          fieldSchema.format = 'uuid'
-          break
-        default:
-          break
-      }
-    })
-  }
-
-  _setArrayFieldProperties(fieldSchema, fieldDefn, definitions, level) {
-    if (fieldSchema.type !== 'array') {
-      return
-    }
-
-    const ruleArgFieldName = this.ruleArgFieldName
-
-    _.each(fieldDefn.rules, (rule) => {
-      const value = rule[ruleArgFieldName]
-      switch (rule.name) {
-        case 'max':
-          fieldSchema.maxItems = value.limit
-          break
-        case 'min':
-          fieldSchema.minItems = value.limit
-          break
-        case 'length':
-          fieldSchema.maxItems = value.limit
-          fieldSchema.minItems = value.limit
-          break
-        case 'unique':
-          fieldSchema.uniqueItems = true
-          break
-        default:
-          break
-      }
-    })
-
-    if (!fieldDefn.items) {
-      fieldSchema.items = {}
-      return
-    }
-
-    if (fieldDefn.items.length === 1) {
-      fieldSchema.items = this.parse(fieldDefn.items[0], definitions, level + 1)
-    } else {
-      fieldSchema.items = {
-        anyOf: _.map(fieldDefn.items, (itemSchema) => {
-          return this.parse(itemSchema, definitions, level + 1)
-        })
-      }
-    }
-  }
-
-  _setDateFieldProperties(fieldSchema, fieldDefn) {
-    if (fieldSchema.type !== 'date') {
-      return
-    }
-
-    if (fieldDefn.flags && fieldDefn.flags.format !== 'iso') {
-      fieldSchema.type = 'integer'
-    } else {
-      // https://datatracker.ietf.org/doc/draft-handrews-json-schema-validation
-      // JSON Schema does not have date type, but use string with format.
-      // However, joi definition cannot clearly tells the date/time/date-time format
-      fieldSchema.type = 'string'
-      fieldSchema.format = 'date-time'
-    }
-  }
-
-  _setAlternativesProperties(schema, joiSpec, definitions, level) {
-    if (schema.type !== 'alternatives') {
-      return
-    }
-
-    if (joiSpec.matches.length === 1) {
-      const match = joiSpec.matches[0]
-      if (match.switch) {
-        schema.oneOf = _.map(match.switch, (condition) => {
-          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, 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, definitions, level + 1)
-      })
-    }
-
-    delete schema.type
-  }
-
-  _setAnyProperties(schema, joiSpec, definitions, level) {
-    if (schema.type !== 'any') {
-      return
-    }
-
-    if (joiSpec.whens) {
-      schema.oneOf = []
-
-      const condition = joiSpec.whens[0]
-
-      if (condition.switch) {
-        for (const switchCondition of condition.switch) {
-          if (switchCondition.then) {
-            schema.oneOf.push(this.parse(switchCondition.then, definitions, level + 1))
-          }
-
-          if (switchCondition.otherwise) {
-            schema.oneOf.push(this.parse(switchCondition.otherwise, definitions, level + 1))
-          }
-        }
-      }
-
-      if (condition.then) {
-        schema.oneOf.push(this.parse(condition.then, definitions, level + 1))
-      }
-
-      if (condition.otherwise) {
-        schema.oneOf.push(this.parse(condition.otherwise, definitions, level + 1))
-      }
-
-      delete schema.type
-      return
-    }
-
-    schema.type = [
-      'array',
-      'boolean',
-      'number',
-      'object',
-      'string',
-      'null'
-    ]
-  }
-
-  _setMetaProperties(schema, joiSpec) {
-    _.forEach(joiSpec.metas, (m) => {
-      if (m.contentMediaType) {
-        schema.contentMediaType = m.contentMediaType
-      }
-      if (m.format) {
-        schema.format = m.format
-      }
-    })
-  }
-
-  _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
+/* eslint no-use-before-define: 'off' */
+const _ = require('lodash')
+
+class JoiJsonSchemaParser {
+  constructor() {
+    this.childrenFieldName = this._getChildrenFieldName()
+    this.optionsFieldName = this._getOptionsFieldName()
+    this.ruleArgFieldName = this._getRuleArgFieldName()
+    this.enumFieldName = this._getEnumFieldName()
+    this.allowUnknownFlagName = this._getAllowUnknownFlagName()
+  }
+
+  parse(joiSpec, definitions = {}, level = 0) {
+    let schema = {}
+
+    if (this._getPresence(joiSpec) === 'forbidden') {
+      schema.not = {}
+      return schema
+    }
+
+    this._setBasicProperties(schema, joiSpec)
+    this._setNumberFieldProperties(schema, joiSpec)
+    this._setBinaryFieldProperties(schema, joiSpec)
+    this._setStringFieldProperties(schema, joiSpec)
+    this._setDateFieldProperties(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)
+
+    if (!_.isEmpty(joiSpec.shared)) {
+      this.parse(joiSpec.shared[0], definitions, level)
+    }
+
+    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
+  }
+
+  _getChildrenFieldName() {
+    return 'keys'
+  }
+
+  _getOptionsFieldName() {
+    return 'preferences'
+  }
+
+  _getRuleArgFieldName() {
+    return 'args'
+  }
+
+  _getEnumFieldName() {
+    return 'allow'
+  }
+
+  _getAllowUnknownFlagName() {
+    return 'unknown'
+  }
+
+  _getLocalSchemaBasePath() {
+    return '#/$defs'
+  }
+
+  _getFieldDescription(fieldDefn) {
+    return _.get(fieldDefn, 'flags.description')
+  }
+
+  _getFieldType(fieldDefn) {
+    let type = fieldDefn.type
+    if (type === 'number' && !_.isEmpty(fieldDefn.rules) &&
+      fieldDefn.rules[0].name === 'integer') {
+      type = 'integer'
+    }
+    return type
+  }
+
+  _addNullTypeIfNullable(fieldSchema, fieldDefn) {
+    // This should always be the last call in parse
+    const enums = _.get(fieldDefn, this.enumFieldName)
+    if (Array.isArray(enums) && enums.includes(null)) {
+      fieldSchema.type = [fieldSchema.type, 'null']
+    }
+  }
+
+  _getFieldExample(fieldDefn) {
+    return _.get(fieldDefn, 'examples')
+  }
+
+  _getPresence(fieldDefn) {
+    const presence = _.get(fieldDefn, 'flags.presence')
+    if (presence !== undefined) {
+      return presence
+    }
+    return _.get(fieldDefn, `${this.optionsFieldName}.presence`)
+  }
+
+  _isRequired(fieldDefn) {
+    const presence = this._getPresence(fieldDefn)
+    return presence === 'required'
+  }
+
+  _getDefaultValue(fieldDefn) {
+    return _.get(fieldDefn, 'flags.default')
+  }
+
+  _getConst(fieldDefn) {
+    const enumList = fieldDefn[this.enumFieldName]
+    if (fieldDefn.flags && fieldDefn.flags.only && _.size(enumList) === 1) {
+      return enumList[0]
+    }
+  }
+
+  _getEnum(fieldDefn) {
+    const enumList = fieldDefn[this.enumFieldName]
+    if (fieldDefn.flags && fieldDefn.flags.only && _.size(enumList) > 1) {
+      return _.uniq(enumList)
+    }
+  }
+
+  _getUnknown(joiSpec) {
+    let allowUnknown = _.get(joiSpec, `${this.optionsFieldName}.allowUnknown`, false)
+    if (joiSpec.flags && typeof joiSpec.flags[this.allowUnknownFlagName] !== 'undefined') {
+      allowUnknown = joiSpec.flags[this.allowUnknownFlagName]
+    }
+    return allowUnknown
+  }
+
+  _setIfNotEmpty(schema, field, value) {
+    if (value !== null && value !== undefined) {
+      schema[field] = value
+    }
+  }
+
+  _setBasicProperties(fieldSchema, fieldDefn) {
+    this._setIfNotEmpty(fieldSchema, 'type', this._getFieldType(fieldDefn))
+    this._setIfNotEmpty(fieldSchema, 'examples', this._getFieldExample(fieldDefn))
+    this._setIfNotEmpty(fieldSchema, 'description', this._getFieldDescription(fieldDefn))
+    this._setIfNotEmpty(fieldSchema, 'default', this._getDefaultValue(fieldDefn))
+    this._setIfNotEmpty(fieldSchema, 'const', this._getConst(fieldDefn))
+    this._setIfNotEmpty(fieldSchema, 'enum', this._getEnum(fieldDefn))
+  }
+
+  _setBinaryFieldProperties(fieldSchema, fieldDefn) {
+    if (fieldSchema.type !== 'binary') {
+      return
+    }
+    fieldSchema.type = 'string'
+    if (fieldDefn.flags && fieldDefn.flags.encoding) {
+      fieldSchema.contentEncoding = fieldDefn.flags.encoding
+    }
+    fieldSchema.format = 'binary'
+  }
+
+  _setObjectProperties(schema, joiSpec, definitions, level) {
+    if (schema.type !== 'object') {
+      return
+    }
+
+    schema.properties = {}
+    schema.required = []
+
+    schema.additionalProperties = this._getUnknown(joiSpec)
+
+    _.map(joiSpec[this.childrenFieldName], (fieldDefn, key) => {
+      const fieldSchema = this.parse(fieldDefn, definitions, level + 1)
+      if (this._isRequired(fieldDefn)) {
+        schema.required.push(key)
+      }
+
+      schema.properties[key] = fieldSchema
+    })
+
+    /**
+     * For dynamic key scenarios to store the pattern as key
+     * and have the properties be as with other examples
+     */
+    if (joiSpec.patterns) {
+      _.each(joiSpec.patterns, patternObj => {
+        if (typeof patternObj.rule !== 'object' || typeof patternObj.regex === 'undefined') {
+          return
+        }
+
+        schema.properties[patternObj.regex] = {
+          type: patternObj.rule.type,
+          properties: {}
+        }
+        schema.properties[patternObj.regex].required = []
+
+        const childKeys = patternObj.rule.keys || patternObj.rule.children
+        schema.properties[patternObj.regex].additionalProperties = this._getUnknown(patternObj.rule)
+
+        _.each(childKeys, (ruleObj, key) => {
+          schema.properties[patternObj.regex].properties[key] = this.parse(ruleObj, definitions, level + 1)
+
+          if (this._isRequired(ruleObj)) {
+            schema.properties[patternObj.regex].required.push(key)
+          }
+        })
+
+        schema.patternProperties = schema.patternProperties || {}
+
+        let regexString = patternObj.regex
+        regexString = regexString.indexOf('/') === 0 ? regexString.substring(1) : regexString
+        regexString = regexString.lastIndexOf('/') > -1 ? regexString.substring(0, regexString.length - 1) : regexString
+
+        schema.patternProperties[regexString] = schema.properties[patternObj.regex]
+      })
+    }
+
+    if (_.isEmpty(schema.required)) {
+      delete schema.required
+    }
+  }
+
+  _setNumberFieldProperties(fieldSchema, fieldDefn) {
+    if (fieldSchema.type !== 'number' && fieldSchema.type !== 'integer') {
+      return
+    }
+
+    const ruleArgFieldName = this.ruleArgFieldName
+
+    _.each(fieldDefn.rules, (rule) => {
+      const value = rule[ruleArgFieldName]
+      switch (rule.name) {
+        case 'max':
+          fieldSchema.maximum = value.limit
+          break
+        case 'min':
+          fieldSchema.minimum = value.limit
+          break
+        case 'greater':
+          fieldSchema.exclusiveMinimum = value.limit
+          fieldSchema.minimum = value.limit
+          break
+        case 'less':
+          fieldSchema.exclusiveMaximum = value.limit
+          fieldSchema.maximum = value.limit
+          break
+        case 'multiple':
+          fieldSchema.multipleOf = value.base
+          break
+        default:
+          break
+      }
+    })
+  }
+
+  _setStringFieldProperties(fieldSchema, fieldDefn) {
+    if (fieldSchema.type !== 'string') {
+      return
+    }
+
+    if (fieldDefn.flags && fieldDefn.flags.encoding) {
+      fieldSchema.contentEncoding = fieldDefn.flags.encoding
+    }
+
+    const ruleArgFieldName = this.ruleArgFieldName
+
+    _.forEach(fieldDefn.rules, (rule) => {
+      switch (rule.name) {
+        case 'min':
+          fieldSchema.minLength = rule[ruleArgFieldName].limit
+          break
+        case 'max':
+          fieldSchema.maxLength = rule[ruleArgFieldName].limit
+          break
+        case 'email':
+          fieldSchema.format = 'email'
+          break
+        case 'hostname':
+          fieldSchema.format = 'hostname'
+          break
+        case 'uri':
+          fieldSchema.format = 'uri'
+          break
+        case 'ip':
+          const versions = rule[ruleArgFieldName].options.version
+          if (!_.isEmpty(versions)) {
+            if (versions.length === 1) {
+              fieldSchema.format = versions[0]
+            } else {
+              fieldSchema.oneOf = _.map(versions, (version) => {
+                return {
+                  format: version
+                }
+              })
+            }
+          } else {
+            fieldSchema.format = 'ipv4'
+          }
+          break
+        case 'pattern':
+          let regex = rule[ruleArgFieldName].regex
+          let idx = regex.indexOf('/')
+          if (idx === 0) {
+            regex = regex.replace('/', '')
+          }
+          idx = regex.lastIndexOf('/') === regex.length - 1
+          if (idx > -1) {
+            regex = regex.replace(/\/$/, '')
+          }
+          fieldSchema.pattern = regex
+          break
+        case 'isoDate':
+          fieldSchema.format = 'date-time'
+          break
+        case 'isoDuration':
+          fieldSchema.format = 'duration'
+          break
+        case 'uuid':
+        case 'guid':
+          fieldSchema.format = 'uuid'
+          break
+        default:
+          break
+      }
+    })
+  }
+
+  _setArrayFieldProperties(fieldSchema, fieldDefn, definitions, level) {
+    if (fieldSchema.type !== 'array') {
+      return
+    }
+
+    const ruleArgFieldName = this.ruleArgFieldName
+
+    _.each(fieldDefn.rules, (rule) => {
+      const value = rule[ruleArgFieldName]
+      switch (rule.name) {
+        case 'max':
+          fieldSchema.maxItems = value.limit
+          break
+        case 'min':
+          fieldSchema.minItems = value.limit
+          break
+        case 'length':
+          fieldSchema.maxItems = value.limit
+          fieldSchema.minItems = value.limit
+          break
+        case 'unique':
+          fieldSchema.uniqueItems = true
+          break
+        default:
+          break
+      }
+    })
+
+    if (!fieldDefn.items) {
+      fieldSchema.items = {}
+      return
+    }
+
+    if (fieldDefn.items.length === 1) {
+      fieldSchema.items = this.parse(fieldDefn.items[0], definitions, level + 1)
+    } else {
+      fieldSchema.items = {
+        anyOf: _.map(fieldDefn.items, (itemSchema) => {
+          return this.parse(itemSchema, definitions, level + 1)
+        })
+      }
+    }
+  }
+
+  _setDateFieldProperties(fieldSchema, fieldDefn) {
+    if (fieldSchema.type !== 'date') {
+      return
+    }
+
+    if (fieldDefn.flags && fieldDefn.flags.format !== 'iso') {
+      fieldSchema.type = 'integer'
+    } else {
+      // https://datatracker.ietf.org/doc/draft-handrews-json-schema-validation
+      // JSON Schema does not have date type, but use string with format.
+      // However, joi definition cannot clearly tells the date/time/date-time format
+      fieldSchema.type = 'string'
+      fieldSchema.format = 'date-time'
+    }
+  }
+
+  _setAlternativesProperties(schema, joiSpec, definitions, level) {
+    if (schema.type !== 'alternatives') {
+      return
+    }
+
+    if (joiSpec.matches.length === 1) {
+      const match = joiSpec.matches[0]
+      if (match.switch) {
+        schema.oneOf = _.map(match.switch, (condition) => {
+          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, 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, definitions, level + 1)
+      })
+    }
+
+    delete schema.type
+  }
+
+  _setAnyProperties(schema, joiSpec, definitions, level) {
+    if (schema.type !== 'any') {
+      return
+    }
+
+    if (joiSpec.whens) {
+      schema.oneOf = []
+
+      const condition = joiSpec.whens[0]
+
+      if (condition.switch) {
+        for (const switchCondition of condition.switch) {
+          if (switchCondition.then) {
+            schema.oneOf.push(this.parse(switchCondition.then, definitions, level + 1))
+          }
+
+          if (switchCondition.otherwise) {
+            schema.oneOf.push(this.parse(switchCondition.otherwise, definitions, level + 1))
+          }
+        }
+      }
+
+      if (condition.then) {
+        schema.oneOf.push(this.parse(condition.then, definitions, level + 1))
+      }
+
+      if (condition.otherwise) {
+        schema.oneOf.push(this.parse(condition.otherwise, definitions, level + 1))
+      }
+
+      delete schema.type
+      return
+    }
+
+    schema.type = [
+      'array',
+      'boolean',
+      'number',
+      'object',
+      'string',
+      'null'
+    ]
+  }
+
+  _setMetaProperties(schema, joiSpec) {
+    _.forEach(joiSpec.metas, (m) => {
+      if (m.contentMediaType) {
+        schema.contentMediaType = m.contentMediaType
+      }
+      if (m.format) {
+        schema.format = m.format
+      }
+    })
+  }
+
+  _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/package.json

@@ -1,47 +1,47 @@
-{
-  "name": "joi-to-json",
-  "version": "2.4.0",
-  "description": "joi to JSON / OpenAPI Schema Converter",
-  "main": "index.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/kenspirit/joi-to-json.git"
-  },
-  "scripts": {
-    "lint": "./node_modules/.bin/eslint .",
-    "test": "jest"
-  },
-  "author": "Ken Chen",
-  "license": "MIT",
-  "keywords": [
-    "joi",
-    "json-schema",
-    "json",
-    "schema",
-    "openapi",
-    "swagger",
-    "oas"
-  ],
-  "dependencies": {
-    "lodash": "^4.17.21",
-    "semver-compare": "^1.0.0"
-  },
-  "devDependencies": {
-    "ajv": "^8.11.0",
-    "ajv-draft-04": "^1.0.0",
-    "eslint": "^8.12.0",
-    "jest": "^27.5.1",
-    "joi-12": "npm:@commercial/joi@^12.1.0",
-    "joi-13": "npm:joi@^13.7.0",
-    "joi-14": "npm:joi@^14.3.1",
-    "joi-15": "npm:@hapi/joi@^15.1.1",
-    "joi-16": "npm:@hapi/joi@^16.1.8",
-    "joi-17": "npm:joi@^17.4.2"
-  },
-  "types": "index.d.ts",
-  "files": [
-    "lib/**/*.js",
-    "index.js",
-    "index.d.ts"
-  ]
-}
+{
+  "name": "joi-to-json",
+  "version": "2.5.0",
+  "description": "joi to JSON / OpenAPI Schema Converter",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kenspirit/joi-to-json.git"
+  },
+  "scripts": {
+    "lint": "./node_modules/.bin/eslint .",
+    "test": "jest"
+  },
+  "author": "Ken Chen",
+  "license": "MIT",
+  "keywords": [
+    "joi",
+    "json-schema",
+    "json",
+    "schema",
+    "openapi",
+    "swagger",
+    "oas"
+  ],
+  "dependencies": {
+    "lodash": "^4.17.21",
+    "semver-compare": "^1.0.0"
+  },
+  "devDependencies": {
+    "ajv": "^8.11.0",
+    "ajv-draft-04": "^1.0.0",
+    "eslint": "^8.12.0",
+    "jest": "^27.5.1",
+    "joi-12": "npm:@commercial/joi@^12.1.0",
+    "joi-13": "npm:joi@^13.7.0",
+    "joi-14": "npm:joi@^14.3.1",
+    "joi-15": "npm:@hapi/joi@^15.1.1",
+    "joi-16": "npm:@hapi/joi@^16.1.8",
+    "joi-17": "npm:joi@^17.6.0"
+  },
+  "types": "index.d.ts",
+  "files": [
+    "lib/**/*.js",
+    "index.js",
+    "index.d.ts"
+  ]
+}