json-2-joi 2.2.0 → 2.3.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 2.3.2
+
+- Enhance `null` value support when `type` is array and contains `null`.
+
+### 2.3.1
+
+- Fix `noDefaults` options validation issue.
+
+### 2.3.0
+
+- If `noDefaults` is set `true`, `default()` will not be set to Joi schema and allow it overridable.
+
 ### 2.2.0
 
 - Add `forbidArrayNull`, `strictRequired` option.

package/README.md

@@ -49,10 +49,11 @@ Please file issues for other unsupported features.
 ### Options
 
 - `subSchemas` - an (optional) object with keys representing schema ids, and values representing schemas.
+- `extensions` - an array of extensions to pass [joi.extend](https://github.com/hapijs/joi/blob/master/API.md#extendextension).
+- `joiOptions` - Options directly passed to Joi for instance creation.  If the `noDefaults` is set `true`, `default()` will NOT be called and applied to Joi schema.
 - `refineDescription(schema)` - an (optional) function to call to apply to the JSON schema so that it's possible to return customized description.
 - `refineType(type, format)` - an (optional) function to call to apply to type based on the type and format of the JSON schema.
 - `refineSchema(joiSchema, jsonSchema)` - an (optional) function to call to apply to adjust Joi schema base on the original JSON schema. Primary use case is handling `nullable` flag in OpenAPI 3.0
-- `extensions` - an array of extensions to pass [joi.extend](https://github.com/hapijs/joi/blob/master/API.md#extendextension).
 - `allowNull` - Default as `false`.  When `true` and the field has no `enum` setting, `null` value will be allowed.
 - `forbidArrayNull` - Default as `true`.  When `false` and `allowNull` is true, `null` value will be allowed for array type field.
 - `strictRequired` - Default as `false`.  When `true`, `null` (and empty string additionally for string type) will NOT be allowed for those `required` field in object.
@@ -222,6 +223,7 @@ It's possible to override these options for each conversion:
 * strictRequired
 * strictEnum
 * enableEnum
+* noDefaults (Copied from `joiOptions` for the construction time)
 
 However, the overriden options do not have impact on the `subSchemas` as they are preprocessed during Resolver construction.
 

package/lib/resolver.js

@@ -34,6 +34,7 @@ const overridableOptions = {
     allowNull: Joi.boolean(),
     forbidArrayNull: Joi.boolean(),
     strictRequired: Joi.boolean(),
+    noDefaults: Joi.boolean(),
     strictEnum: Joi.boolean(),
     enableEnum: Joi.boolean()
 };
@@ -85,10 +86,10 @@ function addEnumRestriction(joiSchema, enumList, { allowNull = false, strictEnum
 
     const valids = [].concat(enumList);
     if (allowNull && !strictEnum) {
+        valids.splice(0, 0, null);
         if (joiSchema.type === 'string') {
-            valids.push('');
+            valids.splice(0, 0, '');
         }
-        valids.push(null);
     }
     return joiSchema.valid(...valids);
 }
@@ -161,6 +162,7 @@ class SchemaResolver {
         this.subSchemas = subSchemas;
         this.joiOptions = joiOptions;
         this.joiSharedSchemas = new Map();
+        this.resolveOptions.noDefaults = this.joiOptions.noDefaults;
 
         this.joi = getJoiInstance(joiOptions, extensions, joiInstance);
 
@@ -288,7 +290,7 @@ class SchemaResolver {
             resolvedSchema = resolveOptions.refineSchema(resolvedSchema, schema);
         }
 
-        if (schema.default !== undefined) {
+        if (schema.default !== undefined && !resolveOptions.noDefaults) {
             resolvedSchema = resolvedSchema.default(schema.default)
         }
 
@@ -355,11 +357,6 @@ class SchemaResolver {
     resolveType(schema, resolveOptions, baseUri) {
         let joischema;
 
-        const typeDefinitionMap = {
-            title: 'label',
-            default: 'default'
-        };
-
         const joitype = (type, options, format) => {
             let joischema;
 
@@ -396,6 +393,19 @@ class SchemaResolver {
             return joischema;
         }
 
+        let nullIdx;
+        if (Array.isArray(schema.type)) {
+            nullIdx = schema.type.findIndex((type) => type === 'null');
+            if (nullIdx > -1) {
+                schema.type.splice(nullIdx, 1);
+            }
+            if (schema.type.length === 1) {
+                schema.type = schema.type[0];
+            } else if (schema.type.length === 0) {
+                schema.type = 'null';
+            }
+        }
+
         if (Array.isArray(schema.type)) {
             const schemas = [];
 
@@ -407,7 +417,13 @@ class SchemaResolver {
         } else {
             joischema = joitype(schema.type, resolveOptions, schema.format);
         }
+        if (nullIdx > -1) {
+            joischema = joischema.allow(null);
+        }
 
+        const typeDefinitionMap = {
+            title: 'label'
+        };
         Object.keys(typeDefinitionMap).forEach(function (key) {
             if (schema[key] !== undefined) {
                 joischema = joischema[typeDefinitionMap[key]](schema[key]);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-2-joi",
-  "version": "2.2.0",
+  "version": "2.3.2",
   "license": "Apache 2.0",
   "description": "Converts json-schema to Joi schema. (Enhanced enjoi)",
   "main": "./index.js",