json-2-joi 2.3.2 → 2.5.0

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`, `forbidArrayNull`, `strictRequired`, `strictEnum`, `enableEnum` options
+- Provided `refineDescription(schema)`, `allowNull`, `forbidArrayNull`, `strictRequired`, `strictEnum`, `enableEnum`, `customizedNullValues` 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`
@@ -55,7 +55,9 @@ Please file issues for other unsupported features.
 - `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
 - `allowNull` - Default as `false`.  When `true` and the field has no `enum` setting, `null` value will be allowed.
+- `customizedNullValues` - Default as `[null]`.  When provided, the value in the array will be treated valid null value when schema is 'null' type or other allowing null case.
 - `forbidArrayNull` - Default as `true`.  When `false` and `allowNull` is true, `null` value will be allowed for array type field.
+- `strictArrayRequired` - Default as `false`.  When `true`, those `required` array-type fields must has at least 1 item and its item must not be `null` item, or value defined by `customizedNullValues`.
 - `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.
@@ -221,6 +223,7 @@ It's possible to override these options for each conversion:
 * allowNull
 * forbidArrayNull
 * strictRequired
+* strictArrayRequired
 * strictEnum
 * enableEnum
 * noDefaults (Copied from `joiOptions` for the construction time)

package/lib/resolver.js

@@ -21,9 +21,11 @@ const optionsSchema = Joi.object({
     refineDescription: Joi.func().allow(null),
     allowNull: Joi.boolean().default(false),
     forbidArrayNull: Joi.boolean().default(true),
+    strictArrayRequired: Joi.boolean().default(false),
     strictRequired: Joi.boolean().default(false),
     strictEnum: Joi.boolean().default(true),
     enableEnum: Joi.boolean().default(true),
+    customizedNullValues: Joi.array().items(Joi.any()).default([null]).min(1),
     joiOptions: Joi.object().unknown(true).default({})
 });
 
@@ -33,10 +35,12 @@ const overridableOptions = {
     refineDescription: Joi.func().allow(null),
     allowNull: Joi.boolean(),
     forbidArrayNull: Joi.boolean(),
+    strictArrayRequired: Joi.boolean(),
     strictRequired: Joi.boolean(),
     noDefaults: Joi.boolean(),
     strictEnum: Joi.boolean(),
-    enableEnum: Joi.boolean()
+    enableEnum: Joi.boolean(),
+    customizedNullValues: Joi.array().items(Joi.any()).min(1),
 };
 const overridableOptionKeys = Object.keys(overridableOptions);
 const overrideOptionsSchema = Joi.object(overridableOptions);
@@ -64,7 +68,7 @@ function isNotEmptyObject(value) {
     return isObject(value) && Object.keys(value).length > 0;
 }
 
-function allowNullIfNeeded(schema, { allowNull = false, forbidArrayNull = true }) {
+function allowNullIfNeeded(schema, { allowNull = false, forbidArrayNull = true, customizedNullValues = [null] }) {
     if (allowNull) {
         const definition = schema.describe();
         if (definition.flags && definition.flags.only && definition.allow) {
@@ -74,7 +78,7 @@ function allowNullIfNeeded(schema, { allowNull = false, forbidArrayNull = true }
         if (forbidArrayNull && schema.type === 'array') {
             return schema;
         }
-        return schema.allow(null);
+        return schema.allow(...customizedNullValues);
     }
     return schema;
 }
@@ -86,10 +90,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.splice(0, 0, '');
+            valids.push('');
         }
+        valids.push(null);
     }
     return joiSchema.valid(...valids);
 }
@@ -382,7 +386,7 @@ class SchemaResolver {
                     joischema = this.string(schema);
                     break;
                 case 'null':
-                    joischema = this.joi.any().valid(null);
+                    joischema = this.joi.any().valid(...options.customizedNullValues);
                     break;
                 default:
                     joischema = this.joi.types()[type];
@@ -418,7 +422,8 @@ class SchemaResolver {
             joischema = joitype(schema.type, resolveOptions, schema.format);
         }
         if (nullIdx > -1) {
-            joischema = joischema.allow(null);
+            joischema = allowNullIfNeeded(joischema,
+                { allowNull: true, customizedNullValues: resolveOptions.customizedNullValues });
         }
 
         const typeDefinitionMap = {
@@ -529,12 +534,13 @@ 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));
-        }
-        // it's a single entity, so just resolve it normally
-        return [allowNullIfNeeded(this.resolve(value, resolveOptions, baseUri), resolveOptions)];
+        return [].concat(value).map((v) => {
+            const vSchema = this.resolve(v, resolveOptions, baseUri);
+            if (resolveOptions.strictArrayRequired) {
+                return vSchema.invalid(...resolveOptions.customizedNullValues);
+            }
+            return allowNullIfNeeded(vSchema, resolveOptions)
+        });
     }
 
     array(schema, resolveOptions, baseUri) {
@@ -554,6 +560,9 @@ class SchemaResolver {
             joischema = joischema.max(items.length);
         }
 
+        if (resolveOptions.strictArrayRequired && !schema.minItems) {
+            schema.minItems = 1;
+        }
         isNumber(schema.minItems) && (joischema = joischema.min(schema.minItems));
         isNumber(schema.maxItems) && (joischema = joischema.max(schema.maxItems));
 

package/package.json

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

package/CHANGELOG.md

@@ -1,214 +0,0 @@
-### 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.
-
-### 2.1.0
-
-- Fix the issue that `enum` is only applied to `string` type or when missing type info.
-- Add `strictEnum` and `enableEnum` option.
-- Allow override options when calling `convert` api.
-
-### 2.0.2
-
-- Remove `min` setting from JOI schema if `minLength` is not defined in JSON schema.
-- Allow `null` value as Array's item if `allowNull` option is set to true.
-
-### 2.0.1
-
-- Set correct examples data for Array type field.
-
-### 2.0.0
-
-* [BREAKING] Remove `useDefaults` and `strictMode` options
-
-### 1.1.0
-
-- Support providing `joiOptions` for JOI default instance creation.
-- Support directly passing a Joi instance for schema building.
-
-### 1.0.0
-
-- Provided `refineDescription(schema)`, `allowNull` 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`
-- Support `contains` keyword in JSON schema using Joi's `has` method
-- Support `$anchor` keyword in JSON schema
-- Remove `defaults` API.  Please refer to section **Reuse JOI Schema Resolver** for similar usage.
-- **Big Change** on `$ref` and `subSchemas`.  Please refer to [test/test-references.js](test/test-references.js) for detail usage.  Currently, four format of `$ref` are supported:
-    * id
-    * [baseUri]#anchor
-    * [baseUri]#/$defs/shared
-    * [baseUri]#/$defs/shared/properties/level1
-
-    **subSchemas will be modified** for two reason:
-    * If any subSchema does not have `$id` field, it will be added using the corresponding key in `subSchemas` object.
-    * New key-value pair will be added into it if the schema or any its subschema being parsed has `$id` field.
-
-## Before Fork
-
-### 9.0.1
-
-* #112 Use joi.link to only resolve strictly recursive self-references
-
-### 9.0.0
-
-* #100 Allow extension constructors
-* #101 Keep string enum type
-* #104 Allow allOf, anyOf, oneOf to be combined with base schema
-* #107 Cycles in schema refs (fixed #106)
-* #108 Handle `not` properly
-* #109 Defaults options
-
-### 8.0.0
-
-* [BREAKING] Switched from @hapi/joi to joi (#94)
-* Added refineSchema function (#92)
-
-### 7.0.0
-
-* [BREAKING] Updated to Joi@17
-* [BREAKING] Custom types moved to being defined under `extensions`
-* [BREAKING] Extensions definitions to follow Joi@17
-
-### 6.0.2
-
-* Correct usage of joi `validate` function. joiSchema.validate(obj) instead of Joi.validate(obj, joiSchema).
-
-### 6.0.1
-
-* #83 differentiate between undefined and falsy
-* #73 updated fix
-
-### 6.0.0
-
-* Do not set empty string as valid for all string types (#73)
-* Updated joi and hoek to latest, drop Node 6 support (#76)
-
-### v5.0.1
-
-* #69
-
-### v5.0.1
-
-* #66
-
-### v5.0.0
-
-* [BREAKING] Addresses #63 : date format to follow RFC3339 as per JSON-Schema.
-
-### v4.1.1
-
-* Fixes `oneOf` requiring (#61).
-
-### v4.1.0
-
-* Added support for string formats `uuid` (v4) and `guid`.
-
-### v4.0.0
-
-* [BREAKING] export interface changed. Call `Enjoi.schema` instead of `Enjoi`.
-* [BREAKING] `joi` is a peer.
-* Added `extensions` support.
-* `types` can also contain function values to do complex resolving of custom types.
-* Added support for `Enjoi.defaults` which returns a new Enjoi with default options.
-
-### v3.2.5
-
-* Fixed allOf support (#53)
-
-### v3.2.4
-
-* Support for allOf
-* Bug fixes
-
-### v3.2.3
-
-* Security fix to resolve https://nodesecurity.io/advisories/566
-
-### v3.2.2
-
-* Documentation fixes.
-
-### v3.2.1
-
-* Support array:additionalItems false setting.
-
-### v3.2.0
-
-* Added `strictMode` support and resolves #34.
-
-### v3.1.0
-
-* Added a refineType function option.
-
-### v3.0.0
-
-* [BREAKING] supports Joi 13.x (required Node 6+)
-* Fixed additional properties https://github.com/tlivings/enjoi/pull/31
-* Adds support for ordered and items https://github.com/tlivings/enjoi/pull/38
-
-### v2.2.4
-
-* Fixes mutating `options` to add `stripUnknown`.
-
-### v2.2.3
-
-* Fix #25 by supporting array for type (e.g. ['string', 'null']).
-* Additional formats: hostname, uri, ipv4, ipv6.
-
-### v2.2.2
-
-* Added @jsdevel's additionalProperties (#14) fixes (thanks!)
-
-### v2.2.1
-
-* Add default value (#30).
-
-### v2.2.0
-
-* Added support for directly passing a `string` instead of a schema to indicate type.
-
-### v2.1.0
-
-* added support for mapping title (to label in joi).
-* added support for mapping description.
-* fixed engine version.
-
-### v2.0.0
-
-* updated `joi` to ^9.
-* requires node 4 minimum.
-
-### v1.0.4
-
-* when undefined `minLength` should default to 0.
-
-### v1.0.3
-
-* Validate when `additionalProperties` is boolean.
-
-### v1.0.2
-
-* Support for `oneOf`.
-
-### v1.0.1
-
-* Support for `format` in string types.
-
-### v1.0.0
-
-* [BREAKING] `subSchemas` is now passed as a property in `options`.
-* Support for custom types using `options.types`.