joi-to-json 4.3.0 → 4.3.2

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

@@ -1,31 +1,31 @@
-const _ = require('lodash')
-const JoiJsonSchemaParser = require('./json-draft-2019-09')
-
-class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
-  constructor(opts = {}) {
-    super(opts)
-
-    this.$schema = undefined
-  }
-
-  parse(joiSpec, definitions = {}, level = 0) {
-    const schema = super.parse(joiSpec, definitions, level)
-
-    if (level === 0 && !_.isEmpty(definitions)) {
-      schema.schemas = definitions
-    }
-    delete schema.components
-
-    return schema
-  }
-
-  _getLocalSchemaBasePath() {
-    return '#/components/schemas'
-  }
-
-  _isKnownMetaKey(key) {
-    return key.startsWith('x-') || key === 'deprecated' || key === 'readOnly' || key === 'writeOnly'
-  }
-}
-
-module.exports = JoiOpenApiSchemaParser
+const _ = require('lodash')
+const JoiJsonSchemaParser = require('./json-draft-2019-09')
+
+class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
+  constructor(opts = {}) {
+    super(opts)
+
+    this.$schema = undefined
+  }
+
+  parse(joiSpec, definitions = {}, level = 0) {
+    const schema = super.parse(joiSpec, definitions, level)
+
+    if (level === 0 && !_.isEmpty(definitions)) {
+      schema.schemas = definitions
+    }
+    delete schema.components
+
+    return schema
+  }
+
+  _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

@@ -1,134 +1,134 @@
-const _ = require('lodash')
-const JoiJsonSchemaParser = require('./json-draft-04')
-
-class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
-  constructor(opts = {}) {
-    super(_.merge({
-      logicalOpParser: {
-        xor: null,
-        with: null,
-        without: null
-      }
-    }, opts))
-
-    this.$schema = undefined
-  }
-
-  parse(joiSpec, definitions = {}, level = 0) {
-    const fullSchema = super.parse(joiSpec, definitions, level)
-    const schema = _.pickBy(fullSchema, (value, key) => isKnownKey(key))
-
-    if (level === 0 && !_.isEmpty(definitions)) {
-      schema.schemas = definitions
-    }
-
-    if (fullSchema.const) {
-      schema.enum = [fullSchema.const]
-    }
-
-    return schema
-  }
-
-  _isIfThenElseSupported() {
-    return false
-  }
-
-  _getLocalSchemaBasePath() {
-    return '#/components/schemas'
-  }
-
-  _setBasicProperties(fieldSchema, fieldDefn) {
-    super._setBasicProperties(fieldSchema, fieldDefn)
-
-    if (!_.isEmpty(fieldSchema.examples)) {
-      fieldSchema.example = fieldSchema.examples[0]
-    }
-  }
-
-  _addNullTypeIfNullable(fieldSchema, fieldDefn) {
-    super._addNullTypeIfNullable(fieldSchema, fieldDefn)
-
-    if (fieldSchema.type === 'null') {
-      delete fieldSchema.type
-      fieldSchema.nullable = true
-    } else if (_.isArray(fieldSchema.type) && fieldSchema.type.includes('null')) {
-      _.remove(fieldSchema.type, (i) => {
-        return i === 'null'
-      })
-      fieldSchema.nullable = true
-
-      if (fieldSchema.type.length === 1) {
-        fieldSchema.type = fieldSchema.type[0]
-      }
-    }
-
-    if (_.isArray(fieldSchema.type)) {
-      // anyOf might exist for When / Alternative case
-      fieldSchema.anyOf = fieldSchema.anyOf || []
-
-      _.forEach(fieldSchema.type, (t) => {
-        const typeExisted = _.some(fieldSchema.anyOf, (condition) => {
-          return condition.type === t
-        })
-
-        if (!typeExisted) {
-          const def = { type: t }
-          if (t === 'array') {
-            def.items = {}
-          }
-          fieldSchema.anyOf.push(def)
-        }
-      })
-
-      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)
-}
-
+const _ = require('lodash')
+const JoiJsonSchemaParser = require('./json-draft-04')
+
+class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
+  constructor(opts = {}) {
+    super(_.merge({
+      logicalOpParser: {
+        xor: null,
+        with: null,
+        without: null
+      }
+    }, opts))
+
+    this.$schema = undefined
+  }
+
+  parse(joiSpec, definitions = {}, level = 0) {
+    const fullSchema = super.parse(joiSpec, definitions, level)
+    const schema = _.pickBy(fullSchema, (value, key) => isKnownKey(key))
+
+    if (level === 0 && !_.isEmpty(definitions)) {
+      schema.schemas = definitions
+    }
+
+    if (fullSchema.const) {
+      schema.enum = [fullSchema.const]
+    }
+
+    return schema
+  }
+
+  _isIfThenElseSupported() {
+    return false
+  }
+
+  _getLocalSchemaBasePath() {
+    return '#/components/schemas'
+  }
+
+  _setBasicProperties(fieldSchema, fieldDefn) {
+    super._setBasicProperties(fieldSchema, fieldDefn)
+
+    if (!_.isEmpty(fieldSchema.examples)) {
+      fieldSchema.example = fieldSchema.examples[0]
+    }
+  }
+
+  _addNullTypeIfNullable(fieldSchema, fieldDefn) {
+    super._addNullTypeIfNullable(fieldSchema, fieldDefn)
+
+    if (fieldSchema.type === 'null') {
+      delete fieldSchema.type
+      fieldSchema.nullable = true
+    } else if (_.isArray(fieldSchema.type) && fieldSchema.type.includes('null')) {
+      _.remove(fieldSchema.type, (i) => {
+        return i === 'null'
+      })
+      fieldSchema.nullable = true
+
+      if (fieldSchema.type.length === 1) {
+        fieldSchema.type = fieldSchema.type[0]
+      }
+    }
+
+    if (_.isArray(fieldSchema.type)) {
+      // anyOf might exist for When / Alternative case
+      fieldSchema.anyOf = fieldSchema.anyOf || []
+
+      _.forEach(fieldSchema.type, (t) => {
+        const typeExisted = _.some(fieldSchema.anyOf, (condition) => {
+          return condition.type === t
+        })
+
+        if (!typeExisted) {
+          const def = { type: t }
+          if (t === 'array') {
+            def.items = {}
+          }
+          fieldSchema.anyOf.push(def)
+        }
+      })
+
+      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

package/package.json

@@ -1,50 +1,50 @@
-{
-  "name": "joi-to-json",
-  "version": "4.3.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": {
-    "combinations": "^1.0.0",
-    "lodash": "^4.17.21",
-    "semver-compare": "^1.0.0"
-  },
-  "devDependencies": {
-    "@jest/transform": "^29.7.0",
-    "ajv": "^8.16.0",
-    "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"
-  },
-  "types": "index.d.ts",
-  "files": [
-    "docs/**/*",
-    "lib/**/*.js",
-    "index.js",
-    "index.d.ts"
-  ]
-}
+{
+  "name": "joi-to-json",
+  "version": "4.3.2",
+  "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": {
+    "combinations": "^1.0.0",
+    "lodash": "^4.17.21",
+    "semver-compare": "^1.0.0"
+  },
+  "devDependencies": {
+    "@jest/transform": "^29.7.0",
+    "ajv": "^8.16.0",
+    "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"
+  },
+  "types": "index.d.ts",
+  "files": [
+    "docs/**/*",
+    "lib/**/*.js",
+    "index.js",
+    "index.d.ts"
+  ]
+}