joi-to-json 2.1.0 → 2.2.1

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

@@ -28,6 +28,7 @@ class JoiJsonSchemaParser {
     this._setAlternativesProperties(schema, joiSpec)
     this._setAnyProperties(schema, joiSpec)
     this._addNullTypeIfNullable(schema, joiSpec)
+    this._setMetaProperties(schema, joiSpec)
 
     return schema
   }
@@ -226,11 +227,6 @@ class JoiJsonSchemaParser {
     if (fieldDefn.flags && fieldDefn.flags.encoding) {
       fieldSchema.contentEncoding = fieldDefn.flags.encoding
     }
-    _.forEach(fieldDefn.meta, (m) => {
-      if (m.contentMediaType) {
-        fieldSchema.contentMediaType = m.contentMediaType
-      }
-    })
 
     const ruleArgFieldName = this.ruleArgFieldName
 
@@ -358,10 +354,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)
@@ -398,6 +401,17 @@ class JoiJsonSchemaParser {
       'null'
     ]
   }
+
+  _setMetaProperties(schema, joiSpec) {
+    _.forEach(joiSpec.metas, (m) => {
+      if (m.contentMediaType) {
+        schema.contentMediaType = m.contentMediaType
+      }
+      if (m.format) {
+        schema.format = m.format
+      }
+    })
+  }
 }
 
 module.exports = JoiJsonSchemaParser

package/lib/parsers/open-api.js

@@ -1,5 +1,5 @@
 const _ = require('lodash')
-const JoiJsonSchemaParser = require('./json')
+const JoiJsonSchemaParser = require('./json-draft-04')
 
 class JoiOpenApiSchemaParser extends JoiJsonSchemaParser {
   parse(joiSpec) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "joi-to-json",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "joi to JSON / OpenAPI Schema Converter",
   "main": "index.js",
   "repository": {
@@ -27,15 +27,19 @@
     "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",
     "joi-15": "npm:@hapi/joi@^15.1.1",
     "joi-16": "npm:@hapi/joi@^16.1.8",
     "joi-17": "npm:joi@^17.4.2"
-  }
+  },
+  "files": [
+    "lib/**/*.js",
+    "index.js"
+  ]
 }

package/.eslintrc

@@ -1,57 +0,0 @@
-{
-  "globals": {},
-  "ignorePatterns": [
-    "test/swagger-ui/",
-    "node_modules/"
-  ],
-  "rules": {
-    "no-restricted-syntax": 0,
-    "guard-for-in": 0,
-    "dot-notation": 0,
-    "camelcase": 0,
-    "no-underscore-dangle": 0,
-    "no-extra-parens": 0,
-    "no-param-reassign": 0,
-    "radix": 0,
-    "class-methods-use-this": 0,
-    "new-cap": 0,
-    "global-require": 0,
-    "comma-dangle": [
-      "error",
-      "never"
-    ],
-    "max-len": 0,
-    "no-new": 0,
-    "no-continue": 0,
-    "no-return-await": 0,
-    "arrow-body-style": 0,
-    "quotes": [
-      2,
-      "single"
-    ],
-    "linebreak-style": [
-      2,
-      "unix"
-    ],
-    "no-unused-vars": [
-      2,
-      {
-        "vars": "all",
-        "args": "after-used",
-        "argsIgnorePattern": "^_",
-        "varsIgnorePattern": "^_"
-      }
-    ],
-    "semi": [
-      "error",
-      "never"
-    ],
-    "no-console": 0
-  },
-  "env": {
-    "es6": true,
-    "node": true,
-    "mocha": true
-  },
-  "plugins": []
-}

package/fixtures/joi-obj-12.js

@@ -1,65 +0,0 @@
-const joi = require('joi-12')
-
-const joiRequired = joi.defaults((schema) => schema.options({
-  presence: 'required'
-}))
-const joiAllowUnknown = joi.defaults((schema) => schema.options({
-  allowUnknown: true
-}))
-
-module.exports = joi.object().keys({
-  guid: joi.string().guid({ version: ['uuidv2', 'uuidv4'] }),
-  uuid: joi.string().uuid({ version: ['uuidv3', 'uuidv5'] }),
-  nickName: joi.string().required().example('鹄思乱想').description('Hero Nickname').min(3).max(20).regex(/^[a-z]+$/, { name: 'alpha', invert: true }),
-  avatar: joi.string().required().uri(),
-  password: joi.forbidden(),
-  email: joi.string().email(),
-  ip: joi.string().ip({ version: ['ipv4', 'ipv6'] }),
-  hostname: joi.string().hostname().insensitive(),
-  gender: joi.string().valid('Male', 'Female', '').default('Male'),
-  genderSpecific: joi.when('gender', {
-    is: 'Female',
-    then: joi.number().required(),
-    otherwise: joi.string()
-  }),
-  height: joi.number().precision(2).positive().greater(0).less(200),
-  isoDateString: joi.string().isoDate(),
-  birthday: joi.date().iso(),
-  birthTime: joi.date().timestamp('unix'),
-  skills: joi.array().items(joi.alternatives().try(
-    joi.string(),
-    joi.object().keys({
-      name: joi.string().example('teleport').alphanum().description('Skill Name').lowercase().required(),
-      level: joi.number().integer().min(10).max(100).default(50).multiple(10).example(10).description('Skill Level')
-    }).unknown(true).meta({ 'x-expandable': true, 'x-lookup': 'name' })
-  ).required()).min(1).max(3).unique().description('Skills').meta({ 'z-ignore': true, 'x-exchangable': false }),
-  tags: joi.array().items(joi.string().required()).length(2),
-  retired: joi.boolean().truthy('yes').falsy('no').insensitive(true),
-  certificate: joi.binary().encoding('base64'),
-  notes: joi.any().meta({ 'x-supported-lang': ['zh-CN', 'en-US'] }),
-  facebookId: joi.string().allow(null),
-  meta: joiRequired.object().keys({
-    hash: joiRequired.string(),
-    optional: joiRequired.string().optional()
-  }),
-  nested: joiAllowUnknown.object().keys({
-    key: joiAllowUnknown.string()
-  }),
-  dynamicKeyHolder: joi
-    .object()
-    .pattern(/s/, joi.object().keys({
-      id: joi
-        .number()
-        .description('Tbe ID for the reference')
-        .example(123)
-        .required(),
-      name: joi
-        .string()
-        .allow('', null)
-        .description('Name of something')
-        .example('Jack')
-        .required()
-    }))
-    .description('Some kind of list')
-    .optional()
-})

package/fixtures/joi-obj-13.js

@@ -1,65 +0,0 @@
-const joi = require('joi-13')
-
-const joiRequired = joi.defaults((schema) => schema.options({
-  presence: 'required'
-}))
-const joiAllowUnknown = joi.defaults((schema) => schema.options({
-  allowUnknown: true
-}))
-
-module.exports = joi.object().keys({
-  guid: joi.string().guid({ version: ['uuidv2', 'uuidv4'] }),
-  uuid: joi.string().uuid({ version: ['uuidv3', 'uuidv5'] }),
-  nickName: joi.string().required().example('鹄思乱想').description('Hero Nickname').min(3).max(20).regex(/^[a-z]+$/, { name: 'alpha', invert: true }),
-  avatar: joi.string().required().uri(),
-  password: joi.forbidden(),
-  email: joi.string().email(),
-  ip: joi.string().ip({ version: ['ipv4', 'ipv6'] }),
-  hostname: joi.string().hostname().insensitive(),
-  gender: joi.string().valid('Male', 'Female', '').default('Male'),
-  genderSpecific: joi.when('gender', {
-    is: 'Female',
-    then: joi.number().required(),
-    otherwise: joi.string()
-  }),
-  height: joi.number().precision(2).positive().greater(0).less(200),
-  isoDateString: joi.string().isoDate(),
-  birthday: joi.date().iso(),
-  birthTime: joi.date().timestamp('unix'),
-  skills: joi.array().items(joi.alternatives().try(
-    joi.string(),
-    joi.object().keys({
-      name: joi.string().example('teleport').alphanum().description('Skill Name').lowercase().required(),
-      level: joi.number().integer().min(10).max(100).default(50).multiple(10).example(10).description('Skill Level')
-    }).unknown(true).meta({ 'x-expandable': true, 'x-lookup': 'name' })
-  ).required()).min(1).max(3).unique().description('Skills').meta({ 'z-ignore': true, 'x-exchangable': false }),
-  tags: joi.array().items(joi.string().required()).length(2),
-  retired: joi.boolean().truthy('yes').falsy('no').insensitive(true),
-  certificate: joi.binary().encoding('base64'),
-  notes: joi.any().meta({ 'x-supported-lang': ['zh-CN', 'en-US'] }),
-  facebookId: joi.string().allow(null),
-  meta: joiRequired.object().keys({
-    hash: joiRequired.string(),
-    optional: joiRequired.string().optional()
-  }),
-  nested: joiAllowUnknown.object().keys({
-    key: joiAllowUnknown.string()
-  }),
-  dynamicKeyHolder: joi
-    .object()
-    .pattern(/s/, joi.object().keys({
-      id: joi
-        .number()
-        .description('Tbe ID for the reference')
-        .example(123)
-        .required(),
-      name: joi
-        .string()
-        .allow('', null)
-        .description('Name of something')
-        .example('Jack')
-        .required()
-    }))
-    .description('Some kind of list')
-    .optional()
-})

package/fixtures/joi-obj-14.js

@@ -1,65 +0,0 @@
-const joi = require('joi-14')
-
-const joiRequired = joi.defaults((schema) => schema.options({
-  presence: 'required'
-}))
-const joiAllowUnknown = joi.defaults((schema) => schema.options({
-  allowUnknown: true
-}))
-
-module.exports = joi.object().keys({
-  guid: joi.string().guid({ version: ['uuidv2', 'uuidv4'] }),
-  uuid: joi.string().uuid({ version: ['uuidv3', 'uuidv5'] }),
-  nickName: joi.string().required().example('鹄思乱想').description('Hero Nickname').min(3).max(20).regex(/^[a-z]+$/, { name: 'alpha', invert: true }),
-  avatar: joi.string().required().uri(),
-  password: joi.forbidden(),
-  email: joi.string().email(),
-  ip: joi.string().ip({ version: ['ipv4', 'ipv6'] }),
-  hostname: joi.string().hostname().insensitive(),
-  gender: joi.string().valid('Male', 'Female', '').default('Male'),
-  genderSpecific: joi.when('gender', {
-    is: 'Female',
-    then: joi.number().required(),
-    otherwise: joi.string()
-  }),
-  height: joi.number().precision(2).positive().greater(0).less(200),
-  isoDateString: joi.string().isoDate(),
-  birthday: joi.date().iso(),
-  birthTime: joi.date().timestamp('unix'),
-  skills: joi.array().items(joi.alternatives().try(
-    joi.string(),
-    joi.object().keys({
-      name: joi.string().example(['teleport', { parent: { sibling: 10 } }]).alphanum().description('Skill Name').lowercase().required(),
-      level: joi.number().integer().min(10).max(100).default(50).multiple(10).example(10).description('Skill Level')
-    }).unknown(true).meta({ 'x-expandable': true, 'x-lookup': 'name' })
-  ).required()).min(1).max(3).unique().description('Skills').meta({ 'z-ignore': true, 'x-exchangable': false }),
-  tags: joi.array().items(joi.string().required()).length(2),
-  retired: joi.boolean().truthy('yes').falsy('no').insensitive(true),
-  certificate: joi.binary().encoding('base64'),
-  notes: joi.any().meta({ 'x-supported-lang': ['zh-CN', 'en-US'] }),
-  facebookId: joi.string().allow(null),
-  meta: joiRequired.object().keys({
-    hash: joiRequired.string(),
-    optional: joiRequired.string().optional()
-  }),
-  nested: joiAllowUnknown.object().keys({
-    key: joiAllowUnknown.string()
-  }),
-  dynamicKeyHolder: joi
-    .object()
-    .pattern(/s/, joi.object().keys({
-      id: joi
-        .number()
-        .description('Tbe ID for the reference')
-        .example(123)
-        .required(),
-      name: joi
-        .string()
-        .allow('', null)
-        .description('Name of something')
-        .example('Jack')
-        .required()
-    }))
-    .description('Some kind of list')
-    .optional()
-})

package/fixtures/joi-obj-15.js

@@ -1,65 +0,0 @@
-const joi = require('joi-15')
-
-const joiRequired = joi.defaults((schema) => schema.options({
-  presence: 'required'
-}))
-const joiAllowUnknown = joi.defaults((schema) => schema.options({
-  allowUnknown: true
-}))
-
-module.exports = joi.object().keys({
-  guid: joi.string().guid({ version: ['uuidv2', 'uuidv4'] }),
-  uuid: joi.string().uuid({ version: ['uuidv3', 'uuidv5'] }),
-  nickName: joi.string().required().example('鹄思乱想').description('Hero Nickname').min(3).max(20).regex(/^[a-z]+$/, { name: 'alpha', invert: true }),
-  avatar: joi.string().required().uri(),
-  password: joi.forbidden(),
-  email: joi.string().email(),
-  ip: joi.string().ip({ version: ['ipv4', 'ipv6'] }),
-  hostname: joi.string().hostname().insensitive(),
-  gender: joi.string().valid('Male', 'Female', '').default('Male'),
-  genderSpecific: joi.when('gender', {
-    is: 'Female',
-    then: joi.number().required(),
-    otherwise: joi.string()
-  }),
-  height: joi.number().precision(2).positive().greater(0).less(200),
-  isoDateString: joi.string().isoDate(),
-  birthday: joi.date().iso(),
-  birthTime: joi.date().timestamp('unix'),
-  skills: joi.array().items(joi.alternatives().try(
-    joi.string(),
-    joi.object().keys({
-      name: joi.string().example(['teleport', { parent: { sibling: 10 } }]).alphanum().description('Skill Name').lowercase().required(),
-      level: joi.number().integer().min(10).max(100).default(50).multiple(10).example(10).description('Skill Level')
-    }).unknown(true).meta({ 'x-expandable': true, 'x-lookup': 'name' })
-  ).required()).min(1).max(3).unique().description('Skills').meta({ 'z-ignore': true, 'x-exchangable': false }),
-  tags: joi.array().items(joi.string().required()).length(2),
-  retired: joi.boolean().truthy('yes').falsy('no').insensitive(true),
-  certificate: joi.binary().encoding('base64'),
-  notes: joi.any().meta({ 'x-supported-lang': ['zh-CN', 'en-US'] }),
-  facebookId: joi.string().allow(null),
-  meta: joiRequired.object().keys({
-    hash: joiRequired.string(),
-    optional: joiRequired.string().optional()
-  }),
-  nested: joiAllowUnknown.object().keys({
-    key: joiAllowUnknown.string()
-  }),
-  dynamicKeyHolder: joi
-    .object()
-    .pattern(/s/, joi.object().keys({
-      id: joi
-        .number()
-        .description('Tbe ID for the reference')
-        .example(123)
-        .required(),
-      name: joi
-        .string()
-        .allow('', null)
-        .description('Name of something')
-        .example('Jack')
-        .required()
-    }))
-    .description('Some kind of list')
-    .optional()
-})

package/fixtures/joi-obj-16.js

@@ -1,73 +0,0 @@
-const joi = require('joi-16')
-
-const joiRequired = joi.defaults((schema) => schema.options({
-  presence: 'required'
-}))
-const joiAllowUnknown = joi.defaults((schema) => schema.options({
-  allowUnknown: true
-}))
-
-module.exports = joi.object().keys({
-  guid: joi.string().guid({ version: ['uuidv2', 'uuidv4'] }),
-  uuid: joi.string().uuid({ version: ['uuidv3', 'uuidv5'] }),
-  nickName: joi.string().required().example('鹄思乱想').description('Hero Nickname').min(3).max(20).pattern(/^[a-z]+$/, { name: 'alpha', invert: true }),
-  avatar: joi.string().required().uri(),
-  password: joi.forbidden(),
-  email: joi.string().email(),
-  ip: joi.string().ip({ version: ['ipv4', 'ipv6'] }),
-  hostname: joi.string().hostname().insensitive(),
-  gender: joi.string().valid('Male', 'Female', '').default('Male'),
-  genderSpecific: joi.when('gender', {
-    is: 'Female',
-    then: joi.number().required(),
-    otherwise: joi.string()
-  }),
-  height: joi.number().precision(2).positive().greater(0).less(200),
-  heightRank: joi.alternatives().conditional('height', {
-    switch: [
-      { is: 0, then: joi.string() },
-      { is: joi.number().greater(160), then: joi.number() },
-      { is: joi.number().greater(300), then: joi.object().keys({ name: joi.string(), level: joi.number() }) }
-    ]
-  }),
-  isoDateString: joi.string().isoDate(),
-  isoDurationString: joi.string().isoDuration(),
-  birthday: joi.date().iso(),
-  birthTime: joi.date().timestamp('unix'),
-  skills: joi.array().items(joi.alternatives().try(
-    joi.string(),
-    joi.object().keys({
-      name: joi.string().example('teleport').alphanum().description('Skill Name').lowercase().required(),
-      level: joi.number().integer().min(10).max(100).default(50).multiple(10).example(10).description('Skill Level')
-    }).unknown(true).meta({ 'x-expandable': true, 'x-lookup': 'name' })
-  ).required()).min(1).max(3).unique().description('Skills').meta({ 'z-ignore': true, 'x-exchangable': false }),
-  tags: joi.array().items(joi.string().required()).length(2),
-  retired: joi.boolean().truthy('yes').falsy('no').sensitive(false),
-  certificate: joi.binary().encoding('base64'),
-  notes: joi.any().meta({ 'x-supported-lang': ['zh-CN', 'en-US'], deprecated: true }),
-  facebookId: joi.string().allow(null),
-  meta: joiRequired.object().keys({
-    hash: joiRequired.string(),
-    optional: joiRequired.string().optional()
-  }),
-  nested: joiAllowUnknown.object().keys({
-    key: joiAllowUnknown.string()
-  }),
-  dynamicKeyHolder: joi
-    .object()
-    .pattern(/s/, joi.object().keys({
-      id: joi
-        .number()
-        .description('Tbe ID for the reference')
-        .example(123)
-        .required(),
-      name: joi
-        .string()
-        .allow('', null)
-        .description('Name of something')
-        .example('Jack')
-        .required()
-    }))
-    .description('Some kind of list')
-    .optional()
-})

package/fixtures/joi-obj-17.js

@@ -1,73 +0,0 @@
-const joi = require('joi-17')
-
-const joiRequired = joi.defaults((schema) => schema.options({
-  presence: 'required'
-}))
-const joiAllowUnknown = joi.defaults((schema) => schema.options({
-  allowUnknown: true
-}))
-
-module.exports = joi.object().keys({
-  guid: joi.string().guid({ version: ['uuidv2', 'uuidv4'] }),
-  uuid: joi.string().uuid({ version: ['uuidv3', 'uuidv5'] }),
-  nickName: joi.string().required().example('鹄思乱想').description('Hero Nickname').min(3).max(20).pattern(/^[a-z]+$/, { name: 'alpha', invert: true }),
-  avatar: joi.string().required().uri(),
-  password: joi.forbidden(),
-  email: joi.string().email(),
-  ip: joi.string().ip({ version: ['ipv4', 'ipv6'] }),
-  hostname: joi.string().hostname().insensitive(),
-  gender: joi.string().valid('Male', 'Female', '').default('Male'),
-  genderSpecific: joi.when('gender', {
-    is: 'Female',
-    then: joi.number().required(),
-    otherwise: joi.string()
-  }),
-  height: joi.number().precision(2).positive().greater(0).less(200),
-  heightRank: joi.alternatives().conditional('height', {
-    switch: [
-      { is: 0, then: joi.string() },
-      { is: joi.number().greater(160), then: joi.number() },
-      { is: joi.number().greater(300), then: joi.object().keys({ name: joi.string(), level: joi.number() }) }
-    ]
-  }),
-  isoDateString: joi.string().isoDate(),
-  isoDurationString: joi.string().isoDuration(),
-  birthday: joi.date().iso(),
-  birthTime: joi.date().timestamp('unix'),
-  skills: joi.array().items(joi.alternatives().try(
-    joi.string(),
-    joi.object().keys({
-      name: joi.string().example('teleport').alphanum().description('Skill Name').lowercase().required(),
-      level: joi.number().integer().min(10).max(100).default(50).multiple(10).example(10).description('Skill Level')
-    }).unknown(true).meta({ 'x-expandable': true, 'x-lookup': 'name' })
-  ).required()).min(1).max(3).unique().description('Skills').meta({ 'z-ignore': true, 'x-exchangable': false }),
-  tags: joi.array().items(joi.string().required()).length(2),
-  retired: joi.boolean().truthy('yes').falsy('no').sensitive(false),
-  certificate: joi.binary().encoding('base64'),
-  notes: joi.any().meta({ 'x-supported-lang': ['zh-CN', 'en-US'], deprecated: true }),
-  facebookId: joi.string().allow(null),
-  meta: joiRequired.object().keys({
-    hash: joiRequired.string(),
-    optional: joiRequired.string().optional()
-  }),
-  nested: joiAllowUnknown.object().keys({
-    key: joiAllowUnknown.string()
-  }),
-  dynamicKeyHolder: joi
-    .object()
-    .pattern(/s/, joi.object().keys({
-      id: joi
-        .number()
-        .description('Tbe ID for the reference')
-        .example(123)
-        .required(),
-      name: joi
-        .string()
-        .allow('', null)
-        .description('Name of something')
-        .example('Jack')
-        .required()
-    }))
-    .description('Some kind of list')
-    .optional()
-})