joi-to-json 4.3.2 → 5.0.0

package/README.md

@@ -10,31 +10,16 @@ That is why I build [joi-route-to-swagger](https://github.com/kenspirit/joi-rout
 
 At the beginning, `joi-route-to-swagger` relies on [joi-to-json-schema](https://github.com/lightsofapollo/joi-to-json-schema/) which utilizes many joi internal api or properties.  Maybe joi did not provide the `describe` api way before, but I always feel uncomfortable of relying on internal api.
 
-The intention of `joi-to-json` is to support converting different version's joi schema to [JSON Schema](https://json-schema.org) using `describe` api.
-
-The implementation of this JOI to JSON conversion tool is simply a pipeline of two components:
-
-1. Convertors
-  - Each JOI version has one convertor implementation.
-  - It converts the `joi.describe()` output to the baseline format (currently the v16 and v17 one)
-
-2. Parsers
+The intention of `joi-to-json` is to support converting different version's joi schema to [JSON Schema](https://json-schema.org) using `describe` api, the baseline format.
   - Each supported output JSON format (e.g. JSON Draft 07, OpenAPI) has one parser implementation.
   - All parsers converts the baseline format into its own format
 
 
 ## Joi Version Support
 
-* @commercial/joi
-  * v12.1.0
 * joi
-  * 13.7.0
-  * 14.3.1
-* @hapi/joi
-  * 15.1.1
-  * 16.1.8
-* joi
-  * 17.9.2
+  * 17.13.3
+  * 18.0.0
 
 Although the versions chosen are the latest one for each major version, It should support other minor versions as well.
 
@@ -300,16 +285,13 @@ parse(joi.string(), 'open-api', {}, { logicalOpParser }); // Partially override
 
 * JOI Standard Representation Conversion
 
-`fixtures-conversion` folder stores each JOI version's supported keyword for different data types.
-In case any data type or keyword is not supported in historical JOI version, we can just create customized file to override the `base` version, such as `v15/link.js`.
-
-Standard converted results are stored in `outputs-conversion` folder.
-
-`test/conversion.spec.js` Test Spec handles all supported JOI versions' conversion verificaiton.
+`fixtures-baseline` folder stores JOI schema definition for different data types.
+`outputs-baseline` folder stores expected output for `describe()` api for schemas in `fixtures-baseline` folder.
+`test/conversion.spec.js` Test Spec verifies expected output for `describe()` api for schemas in `fixtures-baseline` folder.
 
 * JSON output format Conversion
 
-`outputs-parsers` folder stores different output formats base on the JOI Standard Representation in `outputs-conversion` folder.
+`outputs-parsers` folder stores different output formats base on the JOI Standard Representation in `outputs-baseline` folder.
 The Test Spec under `test/parser/` are responsible for these area.
 
 * JSON schema (Draft 07) Validity Unit Test
@@ -321,12 +303,8 @@ For special **Logical Relation Operator** and **Conditional Expression**, some U
 
 When running `conversion.spec.js`, below environment variables can be set:
 
-* `TEST_CONVERTOR`: control which version of joi to test.
-  Example: `TEST_CONVERTOR=v17`
-* `TEST_CASE`: control which test cases to verify.  Name of the test cases is the key of the return object in `fixtures-conversion`.
+* `TEST_CASE`: control which test cases to verify.  Name of the test cases is the key of the return object in `fixtures-baseline`.
   Example: `TEST_CASE=conditional,match_all` verifies the case in `alternatives.js`
-* `TEST_UPDATE_CONVERSION_BASELINE`: control whether writes the baseline file generated from the latest-version convertor (Currently `v17`).
-  It is activated when setting to `true`.
 
 When runninng Test Spec under `test/parser`, below environment variables can be set:
 

package/index.d.ts

@@ -1,4 +1,4 @@
-import Joi from 'joi-17';
+import Joi from 'joi';
 
 /**
  * @type {string}
@@ -20,7 +20,7 @@ export interface LogicalOpParserOpts {
   oxor?: LogicalOpParserFn,
   with?: LogicalOpParserFn,
   without?: LogicalOpParserFn
-};
+}
 
 export type ParserOptions = false | { logicalOpParser?: LogicalOpParserOpts };
 

package/index.js

@@ -1,21 +1,9 @@
-const cmp = require('semver-compare')
-
-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')
-
 const JoiJsonSchemaParser = require('./lib/parsers/json')
 const JoiOpenApiSchemaParser = require('./lib/parsers/open-api')
 const JoiOpenApiThreePointOneSchemaParser = require('./lib/parsers/open-api-3.1')
 const JoiJsonDraftSchemaParser19 = require('./lib/parsers/json-draft-2019-09')
 const JoiJsonDraftSchemaParser = require('./lib/parsers/json-draft-04')
 
-const convertors = [
-  c17, c16, c15, c14, c13, c12
-]
 const parsers = {
   'json-draft-2019-09': JoiJsonDraftSchemaParser19,
   'json-draft-04': JoiJsonDraftSchemaParser,
@@ -29,33 +17,7 @@ function parse(joiObj, type = 'json', definitions = {}, parserOptions = {}) {
     throw new Error('Not an joi object.')
   }
 
-  let convertor
-
-  for (let i = 0; i < convertors.length; i++) {
-    const tmpConvertor = convertors[i]
-    try {
-      let version = tmpConvertor.getVersion(joiObj)
-      let result = cmp(tmpConvertor.getSupportVersion(), version)
-      if (result <= 0) {
-        // The first parser has smaller or equal version
-        convertor = tmpConvertor
-        break
-      }
-    } catch (e) {
-      // Format does not match this parser version.
-      // Skip to check the next one
-      continue
-    }
-  }
-
-  if (!convertor) {
-    console.warn('No matched joi version convertor found, using the latest version')
-    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 joiBaseSpec = joiObj.describe()
   const parser = parsers[type]
   if (!parser) {
     throw new Error(`No parser is registered for ${type}`)

package/lib/parsers/json.js

@@ -89,6 +89,7 @@ class JoiJsonSchemaParser {
     this.ruleArgFieldName = this._getRuleArgFieldName()
     this.enumFieldName = this._getEnumFieldName()
     this.allowUnknownFlagName = this._getAllowUnknownFlagName()
+    this.inheritedPreferences = []
 
     if (opts.logicalOpParser === false) {
       this.logicalOpParser = {}
@@ -100,7 +101,12 @@ class JoiJsonSchemaParser {
   parse(joiSpec, definitions = {}, level = 0) {
     let schema = {}
 
+    const hasPreferences = this._pushInheritiedPreferences(joiSpec)
+
     if (this._getPresence(joiSpec) === 'forbidden') {
+      if (hasPreferences) {
+        this._popInheritiedPreferences()
+      }
       schema.not = {}
       return schema
     }
@@ -143,9 +149,28 @@ class JoiJsonSchemaParser {
       schema.$schema = this.$schema
     }
 
+    if (hasPreferences) {
+      this._popInheritiedPreferences()
+    }
     return schema
   }
 
+  _pushInheritiedPreferences(joiSpec) {
+    if (joiSpec.preferences) {
+      this.inheritedPreferences.push(_.merge({}, this._getInheritedPreferences(), joiSpec.preferences))
+      return true
+    }
+    return false
+  }
+
+  _popInheritiedPreferences() {
+    this.inheritedPreferences.pop()
+  }
+
+  _getInheritedPreferences() {
+    return this.inheritedPreferences[this.inheritedPreferences.length - 1] || {}
+  }
+
   _isIfThenElseSupported() {
     return true
   }
@@ -216,7 +241,8 @@ class JoiJsonSchemaParser {
     if (presence !== undefined) {
       return presence
     }
-    return _.get(fieldDefn, `${this.optionsFieldName}.presence`)
+    const preferences = fieldDefn[this.optionsFieldName] || this._getInheritedPreferences()
+    return _.get(preferences, 'presence')
   }
 
   _isRequired(fieldDefn) {
@@ -237,11 +263,12 @@ class JoiJsonSchemaParser {
   }
 
   _getUnknown(joiSpec) {
-    let allowUnknown = _.get(joiSpec, `${this.optionsFieldName}.allowUnknown`, false)
-    if (joiSpec.flags && typeof joiSpec.flags[this.allowUnknownFlagName] !== 'undefined') {
-      allowUnknown = joiSpec.flags[this.allowUnknownFlagName]
+    const allowUnknown = _.get(joiSpec, `flags.${this.allowUnknownFlagName}`)
+    if (allowUnknown !== undefined) {
+      return allowUnknown
     }
-    return allowUnknown
+    const preferences = joiSpec[this.optionsFieldName] || this._getInheritedPreferences()
+    return _.get(preferences, 'allowUnknown') || false
   }
 
   _setIfNotEmpty(schema, field, value) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joi-to-json",
-  "version": "4.3.2",
+  "version": "5.0.0",
   "description": "joi to JSON / OpenAPI Schema Converter",
   "main": "index.js",
   "repository": {
@@ -24,21 +24,16 @@
   ],
   "dependencies": {
     "combinations": "^1.0.0",
-    "lodash": "^4.17.21",
-    "semver-compare": "^1.0.0"
+    "lodash": "^4.17.21"
   },
   "devDependencies": {
-    "@jest/transform": "^29.7.0",
-    "ajv": "^8.16.0",
+    "@jest/transform": "^30.0.5",
+    "ajv": "^8.17.1",
     "ajv-draft-04": "^1.0.0",
-    "eslint": "^8.57.0",
-    "jest": "^29.7.0",
-    "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.9.2"
+    "eslint": "^9.33.0",
+    "jest": "^30.0.5",
+    "joi": "18.0.0",
+    "typescript": "^5.9.2"
   },
   "types": "index.d.ts",
   "files": [

package/lib/convertors/v12.js

@@ -1,330 +0,0 @@
-const _ = require('lodash')
-
-class JoiSpecConvertor {
-  constructor() {}
-
-  static getVersion(joiObj) {
-    return joiObj._currentJoi.version
-  }
-
-  static getSupportVersion() {
-    return '12'
-  }
-
-  _convertObject(joiObj) {
-    _.each(joiObj.rules, (rule, _idx) => {
-      const name = rule.name
-      if (['min', 'max', 'length'].includes(name)) {
-        rule.args = {
-          limit: rule.arg
-        }
-      }
-      delete rule.arg
-    })
-
-    if (joiObj.children) {
-      joiObj.keys = joiObj.children
-      delete joiObj.children
-    }
-
-    _.each(joiObj.keys, (value, _key) => {
-      this.toBaseSpec(value)
-    })
-
-    _.each(joiObj.patterns, (pattern, _idx) => {
-      this.toBaseSpec(pattern.rule)
-    })
-
-    this._convertDependencies(joiObj)
-  }
-
-  _convertDependencies(joiObj) {
-    _.each(joiObj.dependencies, (dependency) => {
-      if (dependency.key === null) {
-        delete dependency.key
-      }
-      if (dependency.type) {
-        dependency.rel = dependency.type
-        delete dependency.type
-      }
-    })
-  }
-
-  _convertDate(joiObj) {
-    if (joiObj.flags.timestamp) {
-      joiObj.flags.format = joiObj.flags.timestamp
-      delete joiObj.flags.timestamp
-      delete joiObj.flags.multiplier
-    } else if (joiObj.flags.format = {}) {
-      joiObj.flags.format = 'iso'
-    }
-  }
-
-  _convertAlternatives(joiObj) {
-    // backup alternatives setting
-    const alternatives = joiObj.alternatives
-    let fieldName = 'matches'
-
-    if (joiObj.base) {
-      // When case is based on one schema type
-      fieldName = 'whens'
-
-      const baseType = joiObj.base
-      delete joiObj.base
-      delete joiObj.alternatives
-      if (joiObj.flags && joiObj.flags.presence) {
-        delete joiObj.flags.presence
-      }
-
-      this.toBaseSpec(baseType)
-
-      _.merge(joiObj, baseType)
-    }
-
-    // Convert alternatives
-    joiObj[fieldName] = _.map(alternatives, (alternative) => {
-      if (alternative.peek || alternative.ref) {
-        if (alternative.peek) {
-          alternative.is = alternative.peek
-          delete alternative.peek
-        }
-
-        return _.mapValues(alternative, (value, condition) => {
-          switch (condition) {
-            case 'is':
-              this.toBaseSpec(value)
-              if (alternative.ref) {
-                // alternative field reference case
-                value.type = 'any'
-                value.allow.splice(0, 0, { 'override': true })
-              }
-              break
-            case 'otherwise':
-              this.toBaseSpec(value)
-              break
-            case 'then':
-              this.toBaseSpec(value)
-              break
-            case 'ref':
-              if (value.indexOf('ref:') === 0) {
-                value = {
-                  path: value.replace('ref:', '').split('.')
-                }
-              }
-              break
-          }
-          return value
-        })
-      } else {
-        return {
-          schema: this.toBaseSpec(alternative)
-        }
-      }
-    })
-
-    // FIXME: Joi seems merging the `is` to `then` schema
-    _.forEach(joiObj[fieldName], (alternative) => {
-      if (alternative.is && alternative.then) {
-        if (alternative.is.type === 'object') {
-          const isKeys = Object.keys(alternative.is.keys)
-          _.forEach(isKeys, (key) => {
-            delete alternative.then.keys[key]
-          })
-        }
-      }
-    })
-
-    delete joiObj.alternatives
-  }
-
-  _convertBinary(joiObj) {
-    _.each(joiObj.rules, (rule, _idx) => {
-      const name = rule.name
-      if (['min', 'max', 'length'].includes(name)) {
-        rule.args = {
-          limit: rule.arg
-        }
-      }
-      delete rule.arg
-    })
-  }
-
-  _convertString(joiObj) {
-    delete joiObj.options
-
-    _.each(joiObj.rules, (rule, _idx) => {
-      const name = rule.name
-      if (['min', 'max'].includes(name)) {
-        rule.args = {
-          limit: rule.arg
-        }
-      } else if (['lowercase', 'uppercase'].includes(name)) {
-        rule.name = 'case'
-        rule.args = {
-          direction: name.replace('case', '')
-        }
-        delete joiObj.flags.case
-      } else if (rule.arg) {
-        rule.args = {
-          options: rule.arg
-        }
-      }
-      if (name === 'regex') {
-        rule.name = 'pattern'
-        rule.args.regex = rule.arg.pattern.toString()
-        delete rule.args.options.pattern
-      }
-      delete rule.arg
-    })
-  }
-
-  _convertNumber(joiObj) {
-    _.each(joiObj.rules, (rule, _idx) => {
-      const name = rule.name
-      if (['positive', 'negative'].includes(name)) {
-        rule.args = {
-          sign: name
-        }
-        rule.name = 'sign'
-      }
-      if (['greater', 'less', 'min', 'max', 'precision'].includes(name)) {
-        rule.args = {
-          limit: rule.arg
-        }
-      }
-      if (name === 'multiple') {
-        rule.args = {
-          base: rule.arg
-        }
-      }
-      delete rule.arg
-    })
-
-    if (joiObj.flags.precision) {
-      delete joiObj.flags.precision
-    }
-  }
-
-  _convertBoolean(joiObj) {
-    if (_.isArray(joiObj.truthy)) {
-      _.remove(joiObj.truthy, (i) => i === true)
-      if (joiObj.truthy.length === 0) {
-        delete joiObj.truthy
-      }
-    }
-    if (_.isArray(joiObj.falsy)) {
-      _.remove(joiObj.falsy, (i) => i === false)
-      if (joiObj.falsy.length === 0) {
-        delete joiObj.falsy
-      }
-    }
-    if (joiObj.flags.insensitive === false) {
-      joiObj.flags.sensitive = true
-    }
-    delete joiObj.flags.insensitive
-  }
-
-  _convertArray(joiObj) {
-    if (joiObj.flags.sparse === false) {
-      delete joiObj.flags.sparse
-    }
-
-    _.each(joiObj.rules, (rule, _idx) => {
-      const name = rule.name
-      if (['min', 'max', 'length'].includes(name)) {
-        rule.args = {
-          limit: rule.arg
-        }
-      }
-      if (name === 'has') {
-        this.toBaseSpec(rule.arg)
-        rule.args = {
-          schema: rule.arg
-        }
-      }
-      delete rule.arg
-    })
-
-    _.each(joiObj.items, (item, _idx) => {
-      this.toBaseSpec(item)
-    })
-  }
-
-  _convertExamples(_joiObj) {
-  }
-
-  toBaseSpec(joiObj) {
-    joiObj.flags = joiObj.flags || {}
-
-    if (joiObj.flags.allowOnly) {
-      joiObj.flags.only = joiObj.flags.allowOnly
-    }
-    delete joiObj.flags.allowOnly
-    if (joiObj.flags.allowUnknown) {
-      joiObj.flags.unknown = joiObj.flags.allowUnknown
-    }
-    delete joiObj.flags.allowUnknown
-    if (joiObj.description) {
-      joiObj.flags.description = joiObj.description
-      delete joiObj.description
-    }
-    if (joiObj.options) {
-      joiObj.preferences = joiObj.options
-      delete joiObj.options
-    }
-    if (joiObj.valids) {
-      joiObj.allow = joiObj.valids
-      delete joiObj.valids
-    }
-    if (joiObj.meta) {
-      joiObj.metas = joiObj.meta
-      delete joiObj.meta
-    }
-    if (joiObj.invalids) {
-      // FIXME Looks like before v16, joi spec default add [''] for string and [Infinity,-Infinity] for number
-      if (!(joiObj.invalids.length === 1 && joiObj.invalids[0] === '') &&
-        !(joiObj.invalids.length === 2 && joiObj.invalids[0] === Infinity && joiObj.invalids[1] === -Infinity)) {
-        joiObj.invalid = joiObj.invalids
-      }
-    }
-    delete joiObj.invalids
-
-    this._convertExamples(joiObj)
-
-    switch (joiObj.type) {
-      case 'object':
-        this._convertObject(joiObj)
-        break
-      case 'date':
-        this._convertDate(joiObj)
-        break
-      case 'alternatives':
-        this._convertAlternatives(joiObj)
-        break
-      case 'binary':
-        this._convertBinary(joiObj)
-        break
-      case 'string':
-        this._convertString(joiObj)
-        break
-      case 'number':
-        this._convertNumber(joiObj)
-        break
-      case 'boolean':
-        this._convertBoolean(joiObj)
-        break
-      case 'array':
-        this._convertArray(joiObj)
-        break
-      default:
-        break
-    }
-    if (_.isEmpty(joiObj.flags)) {
-      delete joiObj.flags
-    }
-
-    return joiObj
-  }
-}
-
-module.exports = JoiSpecConvertor

package/lib/convertors/v13.js

@@ -1,9 +0,0 @@
-const BaseConverter = require('./v12')
-
-class JoiSpecConvertor extends BaseConverter {
-  static getSupportVersion() {
-    return '13'
-  }
-}
-
-module.exports = JoiSpecConvertor

package/lib/convertors/v14.js

@@ -1,27 +0,0 @@
-const BaseConverter = require('./v13')
-
-class JoiSpecConvertor extends BaseConverter {
-  static getSupportVersion() {
-    return '14'
-  }
-
-  _convertExamples(joiObj) {
-    if (joiObj.examples && joiObj.examples.length === 1) {
-      const example = joiObj.examples[0]
-      joiObj.examples = [example.value]
-    }
-    if (joiObj.examples && joiObj.allow && joiObj.flags && joiObj.flags.only) {
-      joiObj.examples = joiObj.allow
-    }
-  }
-
-  _convertNumber(joiObj) {
-    super._convertNumber(joiObj)
-
-    if (joiObj.flags) {
-      delete joiObj.flags.unsafe
-    }
-  }
-}
-
-module.exports = JoiSpecConvertor

package/lib/convertors/v15.js

@@ -1,9 +0,0 @@
-const BaseConverter = require('./v14')
-
-class JoiSpecConvertor extends BaseConverter {
-  static getSupportVersion() {
-    return '15'
-  }
-}
-
-module.exports = JoiSpecConvertor

package/lib/convertors/v16.js

@@ -1,32 +0,0 @@
-const BaseConverter = require('./v15')
-
-class JoiSpecConvertor extends BaseConverter {
-  static getVersion(joiObj) {
-    return joiObj.$_root.version
-  }
-
-  static getSupportVersion() {
-    return '16'
-  }
-
-  // All methods are overridden because the Joi v16.1.8 spec is closed to the latest version
-  _convertExamples(_joiObj) { }
-
-  _convertObject(_joiObj) { }
-
-  _convertDate(_joiObj) { }
-
-  _convertAlternatives(_joiObj) { }
-
-  _convertBinary(_joiObj) { }
-
-  _convertString(_joiObj) { }
-
-  _convertNumber(_joiObj) { }
-
-  _convertBoolean(_joiObj) { }
-
-  _convertArray(_joiObj) {}
-}
-
-module.exports = JoiSpecConvertor

package/lib/convertors/v17.js

@@ -1,9 +0,0 @@
-const BaseConverter = require('./v16')
-
-class JoiSpecConvertor extends BaseConverter {
-  static getSupportVersion() {
-    return '17'
-  }
-}
-
-module.exports = JoiSpecConvertor