json-2-joi 2.1.0 → 2.3.1

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 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.
+
 ### 2.1.0
 
 - Fix the issue that `enum` is only applied to `string` type or when missing type info.

package/README.md

@@ -6,7 +6,7 @@ Converts a JSON schema to a Joi schema for object validation.
 
 ## Change based on the forked version (enjoi):
 
-- Provided `refineDescription(schema)`, `allowNull`, `strictEnum`, `enableEnum` options
+- Provided `refineDescription(schema)`, `allowNull`, `forbidArrayNull`, `strictRequired`, `strictEnum`, `enableEnum` options
 - Change cycle reference resovling without self-generating id and rely on $id if defined in JSON schema
 - Support `const` keyword in JSON schema
 - Support `example` setting for Joi based on JSON schema's `examples`, `default` or `enum`
@@ -49,11 +49,14 @@ 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.
 - `strictEnum` - Default as `true`.  When `false`, and `allowNull` is `true`, `null` (and empty string additionally for string type) will be added to `enum` list.
 - `enableEnum` - Default as `true`.  When `false`, `enum` restriction will not be added to Joi Schema.
 
@@ -216,8 +219,11 @@ It's possible to override these options for each conversion:
 * refineSchema
 * refineDescription
 * allowNull
+* forbidArrayNull
+* 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

@@ -20,6 +20,8 @@ const optionsSchema = Joi.object({
     refineSchema: Joi.func().allow(null),
     refineDescription: Joi.func().allow(null),
     allowNull: Joi.boolean().default(false),
+    forbidArrayNull: Joi.boolean().default(true),
+    strictRequired: Joi.boolean().default(false),
     strictEnum: Joi.boolean().default(true),
     enableEnum: Joi.boolean().default(true),
     joiOptions: Joi.object().unknown(true).default({})
@@ -30,6 +32,9 @@ const overridableOptions = {
     refineSchema: Joi.func().allow(null),
     refineDescription: Joi.func().allow(null),
     allowNull: Joi.boolean(),
+    forbidArrayNull: Joi.boolean(),
+    strictRequired: Joi.boolean(),
+    noDefaults: Joi.boolean(),
     strictEnum: Joi.boolean(),
     enableEnum: Joi.boolean()
 };
@@ -59,13 +64,16 @@ function isNotEmptyObject(value) {
     return isObject(value) && Object.keys(value).length > 0;
 }
 
-function allowNullIfNeeded(schema, allowNull = false) {
+function allowNullIfNeeded(schema, { allowNull = false, forbidArrayNull = true }) {
     if (allowNull) {
         const definition = schema.describe();
         if (definition.flags && definition.flags.only && definition.allow) {
             // Already has enum restriction
             return schema;
         }
+        if (forbidArrayNull && schema.type === 'array') {
+            return schema;
+        }
         return schema.allow(null);
     }
     return schema;
@@ -78,9 +86,9 @@ function addEnumRestriction(joiSchema, enumList, { allowNull = false, strictEnum
 
     const valids = [].concat(enumList);
     if (allowNull && !strictEnum) {
-        valids.push(null);
+        valids.splice(0, 0, null);
         if (joiSchema.type === 'string') {
-            valids.push('');
+            valids.splice(0, 0, '');
         }
     }
     return joiSchema.valid(...valids);
@@ -154,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);
 
@@ -281,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)
         }
 
@@ -349,8 +358,7 @@ class SchemaResolver {
         let joischema;
 
         const typeDefinitionMap = {
-            title: 'label',
-            default: 'default'
+            title: 'label'
         };
 
         const joitype = (type, options, format) => {
@@ -477,8 +485,11 @@ class SchemaResolver {
 
             if (Array.isArray(jsonSchema.required) && !!~jsonSchema.required.indexOf(key)) {
                 joischema = joischema.required();
+                if (resolveOptions.strictRequired) {
+                    joischema = joischema.invalid(null, '');
+                }
             } else {
-                joischema = allowNullIfNeeded(joischema, resolveOptions.allowNull);
+                joischema = allowNullIfNeeded(joischema, resolveOptions);
             }
 
             schemas[key] = joischema;
@@ -505,10 +516,10 @@ class SchemaResolver {
     resolveAsArray(value, resolveOptions, baseUri) {
         if (Array.isArray(value)) {
             // found an array, thus its _per type_
-            return value.map((v) => allowNullIfNeeded(this.resolve(v, resolveOptions, baseUri), resolveOptions.allowNull));
+            return value.map((v) => allowNullIfNeeded(this.resolve(v, resolveOptions, baseUri), resolveOptions));
         }
         // it's a single entity, so just resolve it normally
-        return [allowNullIfNeeded(this.resolve(value, resolveOptions, baseUri), resolveOptions.allowNull)];
+        return [allowNullIfNeeded(this.resolve(value, resolveOptions, baseUri), resolveOptions)];
     }
 
     array(schema, resolveOptions, baseUri) {

package/package.json

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