json-2-joi 1.0.0 → 2.0.1

package/CHANGELOG.md

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

package/README.md

@@ -1,10 +1,10 @@
-
+![Test](https://github.com/kenspirit/json-2-joi/workflows/Test/badge.svg) [![npm version](https://badge.fury.io/js/json-2-joi.svg)](https://badge.fury.io/js/json-2-joi)
 
 # json-2-joi
 
 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
@@ -12,21 +12,25 @@ Converts a JSON schema to a Joi schema for object validation.
 - 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
+- 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
     * [baseUri]#/$defs/shared
     * [baseUri]#/$defs/shared/properties/level1
 
-    **subSchemas** will be modified for two reason:
+    **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.  Root schema will be added into it as well (if missing $id field, empty string is used as key).
+    * New key-value pair will be added into it if the schema or any its subschema being parsed has `$id` field.
 
 ## Usage
 
 ### Schema Support
 
-`json2Joi` does not support all of json-schema.
+`json-2-joi` does not support all of json-schema.
 
 Here is a list of some known missing keyword support still being worked on:
 
@@ -36,10 +40,11 @@ Please file issues for other unsupported features.
 
 ### API
 
-- `json2Joi.schema(schema [, options])`
+- `json2Joi.schema(schema [, options, joiInstance])`
     - `schema` - a JSON schema or a string type representation (such as `'integer'`).
     - `options` - an (optional) object of additional options such as `subSchemas` and custom `types`.
-- `json2Joi.resolver(options)` - Creates a schema resolver based on `options`.
+    - `joiInstance` - a (optional) Joi instance to be used.  When passed, it will be used directly.  `extensions` option does not take effect and the Object/Array auto coerce extensions will not be included as well.
+- `json2Joi.resolver(options [, joiInstance])` - Creates a schema resolver based on `options`.  `joiInstance` is same as above.
 
 ### Options
 
@@ -49,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:
 
@@ -79,6 +83,15 @@ const schema = Json2Joi.schema({
 
 const { error, value } = schema.validate({firstName: 'John', lastName: 'Doe', age: 45});
 ```
+schema.additionalProperties !== false
+### joiOptions
+
+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:
+* `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/index.js

@@ -1,11 +1,11 @@
 const SchemaResolver = require('./lib/resolver');
 
-function resolver(options = {}) {
-    return new SchemaResolver(options);
+function resolver(options = {}, joiInstance) {
+    return new SchemaResolver(options, joiInstance);
 }
 
-function schema(schema, options = { }) {
-    const joiResolver = resolver(options);
+function schema(schema, options = { }, joiInstance) {
+    const joiResolver = resolver(options, joiInstance);
     const joiSchema = joiResolver.convert(schema);
     return joiSchema;
 }

package/lib/resolver.js

@@ -20,8 +20,7 @@ const optionsSchema = Joi.object({
     refineSchema: Joi.func().allow(null),
     refineDescription: Joi.func().allow(null),
     allowNull: Joi.boolean().default(false),
-    strictMode: Joi.boolean().default(false),
-    useDefaults: Joi.boolean().default(false)
+    joiOptions: Joi.object().unknown(true).default({})
 });
 
 function isNumber(value) {
@@ -32,10 +31,59 @@ function isObject(value) {
     return value !== null && typeof value === 'object';
 }
 
+function isNotEmptyObject(value) {
+    return isObject(value) && Object.keys(value).length > 0;
+}
+
 function normalizedId(id) {
     return id.replace(/[^a-zA-Z0-9]/g, '_');
 }
 
+function getJoiInstance(joiOptions, extensions, joiInstance) {
+    if (joiInstance) {
+        return joiInstance;
+    }
+    if (isNotEmptyObject(joiOptions)) {
+        joiInstance = Joi.defaults((schema) => schema.options(joiOptions));
+    } else {
+        joiInstance = Joi;
+    }
+
+    return joiInstance.extend(
+        {
+            type: 'object',
+            base: joiInstance.object(),
+            coerce: {
+                from: 'string',
+                method(value) {
+                    if (typeof value !== 'string' || (value[0] !== '{' && !/^\s*\{/.test(value))) {
+                        return;
+                    }
+                    try {
+                        return { value: Bourne.parse(value) };
+                    } catch (ignoreErr) { } // eslint-disable-line no-empty
+                }
+            }
+        },
+        {
+            type: 'array',
+            base: joiInstance.array(),
+            coerce: {
+                from: 'string',
+                method(value) {
+                    if (typeof value !== 'string' || (value[0] !== '[' && !/^\s*\[/.test(value))) {
+                        return;
+                    }
+                    try {
+                        return { value: Bourne.parse(value) };
+                    } catch (ignoreErr) { } // eslint-disable-line no-empty
+                }
+            }
+        },
+        ...extensions
+    );
+}
+
 const mapToObj = m => {
     return Array.from(m).reduce((obj, [key, value]) => {
         obj[key] = Joi.isSchema(value) ? value.describe() : value;
@@ -44,56 +92,22 @@ const mapToObj = m => {
 };
 
 class SchemaResolver {
-    constructor(options) {
+    constructor(options, joiInstance) {
         const validatedResult = optionsSchema.validate(options);
 
         Hoek.assert(!validatedResult.error, validatedResult.error);
 
-        const { subSchemas = {}, refineType, refineSchema, strictMode, useDefaults, extensions = [], allowNull = false, refineDescription } = 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();
 
-        this.joi = Joi.extend(
-            {
-                type: 'object',
-                base: Joi.object(),
-                coerce: {
-                    from: 'string',
-                    method(value) {
-                        if (typeof value !== 'string' || (value[0] !== '{' && !/^\s*\{/.test(value))) {
-                            return;
-                        }
-
-                        try {
-                            return { value: Bourne.parse(value) };
-                        } catch (ignoreErr) { } // eslint-disable-line no-empty
-                    }
-                }
-            },
-            {
-                type: 'array',
-                base: Joi.array(),
-                coerce: {
-                    from: 'string',
-                    method(value) {
-                        if (typeof value !== 'string' || (value[0] !== '[' && !/^\s*\[/.test(value))) {
-                            return;
-                        }
-                        try {
-                            return { value: Bourne.parse(value) };
-                        } catch (ignoreErr) { } // eslint-disable-line no-empty
-                    }
-                }
-            },
-            ...extensions
-        );
+        this.joi = getJoiInstance(joiOptions, extensions, joiInstance);
 
         for (let sharedSchemaId in this.subSchemas) {
             const sharedSchema = this.subSchemas[sharedSchemaId];
@@ -214,7 +228,7 @@ class SchemaResolver {
             resolvedSchema = this.refineSchema(resolvedSchema, schema);
         }
 
-        if (this.useDefaults && schema.default !== undefined) {
+        if (schema.default !== undefined) {
             resolvedSchema = resolvedSchema.default(schema.default)
         }
 
@@ -319,7 +333,7 @@ class SchemaResolver {
 
             Hoek.assert(joischema, 'Could not resolve type: ' + schema.type + '.');
 
-            return joischema.strict(this.strictMode);
+            return joischema;
         }
 
         if (Array.isArray(schema.type)) {
@@ -359,7 +373,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;
@@ -426,7 +440,7 @@ class SchemaResolver {
 
         if (isObject(schema.additionalProperties)) {
             joischema = joischema.pattern(/^/, this.resolve(schema.additionalProperties, baseUri));
-        } else {
+        } else if (typeof this.joiOptions.allowUnknown === 'undefined') {
             joischema = joischema.unknown(schema.additionalProperties !== false);
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-2-joi",
-  "version": "1.0.0",
+  "version": "2.0.1",
   "license": "Apache 2.0",
   "description": "Converts json-schema to Joi schema.",
   "main": "./index.js",