joi-to-json 4.2.1 → 4.3.1

package/index.d.ts

@@ -3,7 +3,7 @@ import Joi from 'joi-17';
 /**
  * @type {string}
  */
-export type Mode = 'json' | 'open-api' | 'json-draft-2019-09' | 'json-draft-04';
+export type Mode = 'json' | 'open-api' | 'open-api-3.1' | 'json-draft-2019-09' | 'json-draft-04';
 
 /**
  * The parser function modifies the schema in-place.

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

@@ -8,20 +8,8 @@ class JoiJsonDraftSchemaParser extends JoiJsonSchemaParser {
     }, opts))
   }
 
-  parse(joiSpec, definitions = {}, level = 0) {
-    const schema = super.parse(joiSpec, definitions, level)
-
-    if (!_.isEmpty(joiSpec.metas)) {
-      _.each(joiSpec.metas, meta => {
-        _.each(meta, (value, key) => {
-          if (key === 'deprecated' || key === 'readOnly' || key === 'writeOnly') {
-            schema[key] = value
-          }
-        })
-      })
-    }
-
-    return schema
+  _isKnownMetaKey(key) {
+    return key === 'deprecated' || key === 'readOnly' || key === 'writeOnly'
   }
 }
 

package/lib/parsers/json.js

@@ -75,9 +75,9 @@ const LOGICAL_OP_PARSER = {
  */
 function isJoiOverride(e) {
   return typeof e === 'object'
-         && e !== null
-         && Object.keys(e).length === 1
-         && e.override === true
+    && e !== null
+    && Object.keys(e).length === 1
+    && e.override === true
 }
 
 class JoiJsonSchemaParser {
@@ -126,6 +126,8 @@ class JoiJsonSchemaParser {
       })
     }
 
+    this._copyMetasToSchema(joiSpec, schema)
+
     const schemaId = _.get(joiSpec, 'flags.id')
     if (schemaId) {
       definitions[schemaId] = schema
@@ -775,6 +777,25 @@ class JoiJsonSchemaParser {
       delete schema.type
     }
   }
+
+  _copyMetasToSchema(joiSpec, schema) {
+    if (!_.isEmpty(joiSpec.metas)) {
+      _.each(joiSpec.metas, meta => {
+        _.each(meta, (value, key) => {
+          if (this._isKnownMetaKey(key)) {
+            schema[key] = value
+          }
+        })
+      })
+    }
+  }
+
+  // Intended to be overridden by child parsers. By default no meta key will be
+  // is considered "known".
+  // eslint-disable-next-line no-unused-vars
+  _isKnownMetaKey(key) {
+    return false
+  }
 }
 
 module.exports = JoiJsonSchemaParser

package/lib/parsers/open-api-3.1.js

@@ -11,16 +11,6 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
   parse(joiSpec, definitions = {}, level = 0) {
     const schema = super.parse(joiSpec, definitions, level)
 
-    if (!_.isEmpty(joiSpec.metas)) {
-      _.each(joiSpec.metas, meta => {
-        _.each(meta, (value, key) => {
-          if (key.startsWith('x-') || key === 'deprecated' || key === 'readOnly' || key === 'writeOnly') {
-            schema[key] = value
-          }
-        })
-      })
-    }
-
     if (level === 0 && !_.isEmpty(definitions)) {
       schema.schemas = definitions
     }
@@ -32,6 +22,10 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
   _getLocalSchemaBasePath() {
     return '#/components/schemas'
   }
+
+  _isKnownMetaKey(key) {
+    return key.startsWith('x-') || key === 'deprecated' || key === 'readOnly' || key === 'writeOnly'
+  }
 }
 
 module.exports = JoiOpenApiSchemaParser

package/lib/parsers/open-api.js

@@ -16,50 +16,7 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
 
   parse(joiSpec, definitions = {}, level = 0) {
     const fullSchema = super.parse(joiSpec, definitions, level)
-    const schema = _.pick(fullSchema, [
-      '$ref',
-      'title',
-      'multipleOf',
-      'maximum',
-      'exclusiveMaximum',
-      'minimum',
-      'exclusiveMinimum',
-      'maxLength',
-      'minLength',
-      'pattern',
-      'maxItems',
-      'minItems',
-      'uniqueItems',
-      'maxProperties',
-      'minProperties',
-      'required',
-      'enum',
-      'description',
-      'format',
-      'default',
-      'type',
-
-      'allOf',
-      'oneOf',
-      'anyOf',
-      'not',
-      'items',
-      'properties',
-      'additionalProperties',
-
-      'example',
-      'nullable'
-    ])
-
-    if (!_.isEmpty(joiSpec.metas)) {
-      _.each(joiSpec.metas, meta => {
-        _.each(meta, (value, key) => {
-          if (key.startsWith('x-') || key === 'deprecated' || key === 'readOnly' || key === 'writeOnly') {
-            schema[key] = value
-          }
-        })
-      })
-    }
+    const schema = _.pickBy(fullSchema, (value, key) => isKnownKey(key))
 
     if (level === 0 && !_.isEmpty(definitions)) {
       schema.schemas = definitions
@@ -126,6 +83,52 @@ class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
       delete fieldSchema.type
     }
   }
+
+  _isKnownMetaKey(key) {
+    return isKnownMetaKey(key)
+  }
+}
+
+function isKnownMetaKey(key) {
+  return key.startsWith('x-') || key === 'deprecated' || key === 'readOnly' || key === 'writeOnly'
+}
+
+function isKnownKey(key) {
+  const knownKeys = new Set([
+    '$ref',
+    'title',
+    'multipleOf',
+    'maximum',
+    'exclusiveMaximum',
+    'minimum',
+    'exclusiveMinimum',
+    'maxLength',
+    'minLength',
+    'pattern',
+    'maxItems',
+    'minItems',
+    'uniqueItems',
+    'maxProperties',
+    'minProperties',
+    'required',
+    'enum',
+    'description',
+    'format',
+    'default',
+    'type',
+
+    'allOf',
+    'oneOf',
+    'anyOf',
+    'not',
+    'items',
+    'properties',
+    'additionalProperties',
+
+    'example',
+    'nullable'
+  ])
+  return knownKeys.has(key) || isKnownMetaKey(key)
 }
 
-module.exports = JoiOpenApiSchemaParser
+module.exports = JoiOpenApiSchemaParser

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joi-to-json",
-  "version": "4.2.1",
+  "version": "4.3.1",
   "description": "joi to JSON / OpenAPI Schema Converter",
   "main": "index.js",
   "repository": {
@@ -28,11 +28,11 @@
     "semver-compare": "^1.0.0"
   },
   "devDependencies": {
-    "@jest/transform": "^29.6.2",
-    "ajv": "^8.12.0",
+    "@jest/transform": "^29.7.0",
+    "ajv": "^8.16.0",
     "ajv-draft-04": "^1.0.0",
-    "eslint": "^8.47.0",
-    "jest": "^29.6.2",
+    "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",