joi-to-json 2.2.0 → 2.2.3

package/README.md

@@ -2,7 +2,7 @@
 
 ## Objective
 
-I have been using [joi](https://hapi.dev/family/joi/) a lot in different Node.js projects which guards the API.
+I have been using [joi](https://joi.dev/) a lot in different Node.js projects to guard the API.
 It's **The most powerful schema description language and data validator for JavaScript.** as it said.
 
 Many times, we need to utilize this schema description to produce other output, such as Swagger OpenAPI doc.
@@ -103,6 +103,10 @@ You can optionally set below environment variables:
 
 * `CASE_PATTERN=joi-obj-12` 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.
+
 ## License
 
 MIT

package/index.js

@@ -51,6 +51,7 @@ function parse(joiObj, type = 'json') {
   }
 
   const joiBaseSpec = new convertor().toBaseSpec(joiObj.describe())
+  // fs.writeFileSync(`./internal_${convertor.getSupportVersion()}_${type}.json`, JSON.stringify(joiBaseSpec, null, 2))
   const parser = parsers[type]
   if (!parser) {
     throw new Error(`No parser is registered for ${type}`)

package/lib/convertors/v12.js

@@ -37,7 +37,13 @@ class JoiSpecConvertor {
   }
 
   _convertAlternatives(joiObj) {
-    if (joiObj.base && joiObj.base.type === 'any') {
+    let isWhenCase = false
+    if (joiObj.alternatives.length === 1) {
+      const condition = joiObj.alternatives[0]
+      isWhenCase = !!condition.then || !!condition.otherwise
+    }
+
+    if (isWhenCase) {
       // when case
       joiObj.type = 'any'
       joiObj.whens = joiObj.alternatives

package/lib/parsers/json.js

@@ -106,6 +106,14 @@ class JoiJsonSchemaParser {
     return _.isEmpty(enumList) ? undefined : 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
@@ -139,10 +147,7 @@ class JoiJsonSchemaParser {
     schema.properties = {}
     schema.required = []
 
-    schema.additionalProperties = _.get(joiSpec, `${this.optionsFieldName}.allowUnknown`, false)
-    if (joiSpec.flags && typeof joiSpec.flags[this.allowUnknownFlagName] !== 'undefined') {
-      schema.additionalProperties = joiSpec.flags[this.allowUnknownFlagName]
-    }
+    schema.additionalProperties = this._getUnknown(joiSpec)
 
     _.map(joiSpec[this.childrenFieldName], (fieldDefn, key) => {
       const fieldSchema = this.parse(fieldDefn)
@@ -157,9 +162,9 @@ class JoiJsonSchemaParser {
      * For dynamic key scenarios to store the pattern as key
      * and have the properties be as with other examples
      */
-     if (joiSpec.patterns) {
+    if (joiSpec.patterns) {
       _.each(joiSpec.patterns, patternObj => {
-        if (typeof patternObj.rule !== 'object') {
+        if (typeof patternObj.rule !== 'object' || typeof patternObj.regex === 'undefined') {
           return
         }
 
@@ -170,6 +175,7 @@ class JoiJsonSchemaParser {
         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)
@@ -178,6 +184,14 @@ class JoiJsonSchemaParser {
             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]
       })
     }
 
@@ -354,10 +368,17 @@ class JoiJsonSchemaParser {
       return
     }
 
-    if (joiSpec.matches.length === 1 && joiSpec.matches[0].switch) {
-      schema.oneOf = _.map(joiSpec.matches[0].switch, (condition) => {
-        return this.parse(condition.then || condition.otherwise)
-      })
+    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)
+        })
+      } 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))
+      }
     } else {
       schema.oneOf = _.map(joiSpec.matches, (match) => {
         return this.parse(match.schema)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joi-to-json",
-  "version": "2.2.0",
+  "version": "2.2.3",
   "description": "joi to JSON / OpenAPI Schema Converter",
   "main": "index.js",
   "repository": {
@@ -27,10 +27,10 @@
     "semver-compare": "^1.0.0"
   },
   "devDependencies": {
-    "ajv": "^8.6.3",
+    "ajv": "^8.11.0",
     "ajv-draft-04": "^1.0.0",
-    "eslint": "^7.32.0",
-    "jest": "^27.2.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",