json-2-joi 1.1.0 → 2.0.2

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+### 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.

package/README.md

@@ -4,7 +4,7 @@
 
 Converts a JSON schema to a Joi schema for object validation.
 
-## Change based on the forked version (Json2Joi):
+## Change based on the forked version (enjoi):
 
 - Provided `refineDescription(schema)`, `allowNull` options
 - Change cycle reference resovling without self-generating id and rely on $id if defined in JSON schema
@@ -15,6 +15,7 @@ Converts a JSON schema to a Joi schema for object validation.
 - Support providing `joiOptions` for JOI default instance creation.
 - Support directly passing a Joi instance for schema building.
 - Remove `defaults` API.  Please refer to section **Reuse JOI Schema Resolver** for similar usage.
+- Remove `strictMode` and `useDefaults` option.
 - **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
@@ -53,7 +54,6 @@ Please file issues for other unsupported features.
 - `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` - Allows null value when the field is NOT required with a default value of `false`.
-- `strictMode` - make schemas `strict(value)` with a default value of `false`.
 
 Example:
 
@@ -89,9 +89,9 @@ schema.additionalProperties !== false
 When this option is provided, a Joi instance will be created as `joiInstance = Joi.defaults((schema) => schema.options(joiOptions));` for building Joi Schema.
 
 As a result:
-* `useDefaults` will take effect only if `noDefaults` is NOT true in `joiOptions`.
 * `unknown` setting (originally set by schema.additionalProperties !== false) of the schema will take effect only if `allowUnknown` is NOT provided in `joiOptions`.
-
+* Original `useDefaults` option will be replaced by `noDefaults` in `joiOptions`.
+* Original `strictMode` option will be replaced by `convert` in `joiOptions`.
 
 ### Sub Schemas
 

package/lib/resolver.js

@@ -20,9 +20,7 @@ const optionsSchema = Joi.object({
     refineSchema: Joi.func().allow(null),
     refineDescription: Joi.func().allow(null),
     allowNull: Joi.boolean().default(false),
-    joiOptions: Joi.object().unknown(true).default({}),
-    strictMode: Joi.boolean().default(false),
-    useDefaults: Joi.boolean().default(false)
+    joiOptions: Joi.object().unknown(true).default({})
 });
 
 function isNumber(value) {
@@ -37,6 +35,13 @@ function isNotEmptyObject(value) {
     return isObject(value) && Object.keys(value).length > 0;
 }
 
+function allowNullIfNeeded(schema, allowNull = false) {
+    if (allowNull) {
+        return schema.allow(null);
+    }
+    return schema;
+}
+
 function normalizedId(id) {
     return id.replace(/[^a-zA-Z0-9]/g, '_');
 }
@@ -99,14 +104,12 @@ class SchemaResolver {
 
         Hoek.assert(!validatedResult.error, validatedResult.error);
 
-        const { subSchemas = {}, refineType, refineSchema, strictMode, useDefaults, extensions = [], allowNull = false, refineDescription, joiOptions } = validatedResult.value;
+        const { subSchemas = {}, refineType, refineSchema, extensions = [], allowNull = false, refineDescription, joiOptions } = validatedResult.value;
 
         this.subSchemas = subSchemas;
         this.refineType = refineType;
         this.refineDescription = refineDescription;
         this.refineSchema = refineSchema;
-        this.strictMode = strictMode;
-        this.useDefaults = useDefaults;
         this.allowNull = allowNull;
         this.joiOptions = joiOptions;
         this.joiSharedSchemas = new Map();
@@ -232,7 +235,7 @@ class SchemaResolver {
             resolvedSchema = this.refineSchema(resolvedSchema, schema);
         }
 
-        if (this.joiOptions.noDefaults !== true && this.useDefaults && schema.default !== undefined) {
+        if (schema.default !== undefined) {
             resolvedSchema = resolvedSchema.default(schema.default)
         }
 
@@ -337,7 +340,7 @@ class SchemaResolver {
 
             Hoek.assert(joischema, 'Could not resolve type: ' + schema.type + '.');
 
-            return joischema.strict(this.strictMode);
+            return joischema;
         }
 
         if (Array.isArray(schema.type)) {
@@ -377,7 +380,7 @@ class SchemaResolver {
             example = schema.enum[0];
         }
         if (example) {
-            joischema = joischema.example(example);
+            joischema = joischema.type === 'array' && !Array.isArray(example) ? joischema.example([example]) : joischema.example(example);
         }
 
         return joischema;
@@ -430,8 +433,8 @@ class SchemaResolver {
 
                 if (Array.isArray(schema.required) && !!~schema.required.indexOf(key)) {
                     joischema = joischema.required();
-                } else if (this.allowNull) {
-                    joischema = joischema.allow(null);
+                } else {
+                    joischema = allowNullIfNeeded(joischema, this.allowNull);
                 }
 
                 schemas[key] = joischema;
@@ -454,25 +457,25 @@ class SchemaResolver {
         return joischema;
     }
 
+    resolveAsArray(value, baseUri) {
+        if (Array.isArray(value)) {
+            // found an array, thus its _per type_
+            return value.map((v) => allowNullIfNeeded(this.resolve(v, baseUri), this.allowNull));
+        }
+        // it's a single entity, so just resolve it normally
+        return [allowNullIfNeeded(this.resolve(value, baseUri), this.allowNull)];
+    }
+
     array(schema, baseUri) {
         let joischema = this.joi.array();
         let items;
 
-        const resolveAsArray = (value) => {
-            if (Array.isArray(value)) {
-                // found an array, thus its _per type_
-                return value.map((v) => this.resolve(v, baseUri));
-            }
-            // it's a single entity, so just resolve it normally
-            return [this.resolve(value, baseUri)];
-        }
-
         if (schema.items) {
-            items = resolveAsArray(schema.items);
+            items = this.resolveAsArray(schema.items, baseUri);
 
             joischema = joischema.items(...items);
         } else if (schema.ordered) {
-            items = resolveAsArray(schema.ordered);
+            items = this.resolveAsArray(schema.ordered, baseUri);
             joischema = joischema.ordered(...items);
         }
 
@@ -558,11 +561,7 @@ class SchemaResolver {
     regularString(schema, joischema) {
         schema.pattern && (joischema = joischema.regex(new RegExp(schema.pattern)));
 
-        if (typeof schema.minLength === 'undefined') {
-            schema.minLength = 0;
-        }
-
-        if (schema.minLength === 0 && !schema.pattern && !schema.format) {
+        if ((typeof schema.minLength === 'undefined' || schema.minLength === 0) && !schema.pattern && !schema.format) {
             joischema = joischema.allow('');
         }
 

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "json-2-joi",
-  "version": "1.1.0",
+  "version": "2.0.2",
   "license": "Apache 2.0",
-  "description": "Converts json-schema to Joi schema.",
+  "description": "Converts json-schema to Joi schema. (Enhanced enjoi)",
   "main": "./index.js",
   "scripts": {
     "test": "tape test/*.js",