joi-to-json 2.2.1 → 2.2.4

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/lib/parsers/json.js

@@ -96,14 +96,18 @@ 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) {
+    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) {
@@ -139,10 +143,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 +158,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 +171,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 +180,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]
       })
     }
 

package/package.json

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