json-2-joi 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,153 @@
+### 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`.

package/LICENSE.txt

@@ -0,0 +1,203 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) Trevor Livingston.
+   All rights reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,279 @@
+
+
+# json-2-joi
+
+Converts a JSON schema to a Joi schema for object validation.
+
+## Change based on the forked version (Json2Joi):
+
+- 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
+- **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.  Root schema will be added into it as well (if missing $id field, empty string is used as key).
+
+## Usage
+
+### Schema Support
+
+`json2Joi` does not support all of json-schema.
+
+Here is a list of some known missing keyword support still being worked on:
+
+- `object:patternProperties` - unsupported due to Joi limitations.
+
+Please file issues for other unsupported features.
+
+### API
+
+- `json2Joi.schema(schema [, options])`
+    - `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`.
+
+### Options
+
+- `subSchemas` - an (optional) object with keys representing schema ids, and values representing schemas.
+- `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` - 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:
+
+```javascript
+const Joi = require('joi');
+const Json2Joi = require('json-2-joi');
+
+const schema = Json2Joi.schema({
+    type: 'object',
+    properties: {
+        firstName: {
+            description: 'First name.',
+            type: 'string'
+        },
+        lastName: {
+            description: 'Last name.',
+            type: 'string'
+        },
+        age: {
+            description: 'Age in years',
+            type: 'integer',
+            minimum: 1
+        }
+    },
+    'required': ['firstName', 'lastName']
+});
+
+const { error, value } = schema.validate({firstName: 'John', lastName: 'Doe', age: 45});
+```
+
+### Sub Schemas
+
+Sub-schemas can be provided through the `subSchemas` option for `$ref` values to lookup against.
+
+Example:
+
+```javascript
+const schema = Json2Joi.schema({
+    $id: 'top',
+    type: 'object',
+    properties: {
+        product: {
+            $ref: 'prod'
+        },
+        suggestions: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    product: {
+                        $ref: 'product'
+                    },
+                    weight: {
+                        $ref: 'measurement'
+                    }
+                }
+            }
+        }
+    }
+}, {
+    subSchemas: {
+        measurement: {
+            type: 'object',
+            properties: {
+                quantity: {
+                    $anchor: 'subNumber',
+                    type: 'number'
+                },
+                unit: {
+                    type: 'string'
+                }
+            }
+        },
+        product: {
+            $id: 'prod',
+            type: 'object',
+            properties: {
+                isUsed: {
+                    $anchor: 'subBoolean',
+                    type: 'boolean'
+                },
+                isDangerous: {
+                    $ref: '#subBoolean'
+                },
+                width: {
+                    $ref: 'measurement'
+                },
+                length: {
+                    $ref: '#/properties/width'
+                },
+                price: {
+                    $ref: 'measurement#subNumber'
+                }
+            }
+        }
+    }
+});
+```
+
+### Reuse JOI Schema Resolver
+
+Sometimes, we might have a base set of `subSchemas` which is used for building a large number of JSON schema and so we do not want to parse these common `subSchemas` again and again.  We can first construct a JOI Schema Resolver first and then convert other JSON one by one.
+
+```javascript
+
+const json2Joi = Json2Joi.resolver({
+    subSchemas: {
+        measurement: {
+            type: 'object',
+            properties: {
+                quantity: {
+                    $anchor: 'subNumber',
+                    type: 'number'
+                },
+                unit: {
+                    type: 'string'
+                }
+            }
+        }
+    }
+});
+
+const weightSchema = json2Joi.convert({
+    type: 'object',
+    properties: {
+        weight: {
+            $ref: 'measurement'
+        }
+    }
+});
+
+const lengthSchema = json2Joi.convert({
+    type: 'object',
+    properties: {
+        length: {
+            $ref: 'measurement'
+        }
+    }
+});
+```
+
+### Custom Types
+
+Custom types can be provided through the `extensions` option.
+
+```javascript
+const schema = Json2Joi.schema({
+    type: 'thing'
+}, {
+    extensions: [{
+        type: 'thing',
+        base: Joi.any()
+    }]
+});
+```
+
+Also with functions.
+
+```javascript
+const schema = Json2Joi.schema({
+    type: 'thing'
+}, {
+    extensions: [{
+        type: 'thing',
+        validate(value, helpers) {
+            if (value !== 'foobar') {
+                return { value, errors: helpers.error('thing.foobar') };
+            }
+        },
+        messages: {
+            'thing.foobar': '{#label} must be \'foobar\''
+        }
+    }]
+});
+```
+
+### Refine Type
+
+You can use the refine type function to help refine types based on `type` and `format`. This will allow transforming a type for lookup. 
+
+```javascript
+const schema = Json2Joi.schema({
+    type: 'string',
+    format: 'email'
+}, {
+    extensions: [{
+        type: 'email',
+        base: Joi.string().email()
+    }],
+    refineType(type, format) {
+        if (type === 'string' && format === 'email') {
+            return 'email';
+        }
+    }
+});
+```
+
+This can be used in conjunction with function based `extensions` for additional logic:
+
+```javascript
+const schemaDesc = {
+    type: 'string',
+    format: 'email',
+    'x-test': true
+}
+const schema = Json2Joi.schema(schemaDesc, {
+    extensions: [{
+        type: 'email',
+        validate(value, helpers) {
+            const validator = schemaDesc['x-test'] ? Joi.string().email().equal('test@example.com') : Joi.string().email();
+            const validation = validator.validate(value);
+            if (validation.error) {
+                return { value, errors: validation.error };
+            }
+        }
+    }],
+    refineType(type, format) {
+        if (type === 'string' && format === 'email') {
+            return 'email';
+        }
+    }
+});
+```
+
+### Extensions
+
+Refer to Joi documentation on extensions: https://hapi.dev/module/joi/api/?v=17#extensions

package/index.js

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

package/lib/resolver.js

@@ -0,0 +1,582 @@
+/* global Map */
+const Joi = require('joi');
+const Hoek = require('@hapi/hoek');
+const Bourne = require('@hapi/bourne');
+const debugCreator = require('debug');
+
+const debug = debugCreator('enjoi');
+
+debugCreator.formatters.f = function (f) {
+    return f();
+}
+
+const schemaSchema = Joi.alternatives(Joi.object().unknown(true), Joi.string()).required();
+const extensionSchema = Joi.alternatives().try(Joi.object().unknown(true), Joi.function())
+
+const optionsSchema = Joi.object({
+    subSchemas: Joi.object().unknown(true).default({}),
+    extensions: Joi.array().items(extensionSchema).default([]),
+    refineType: Joi.func().allow(null),
+    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)
+});
+
+function isNumber(value) {
+    return typeof value === 'number';
+}
+
+function isObject(value) {
+    return value !== null && typeof value === 'object';
+}
+
+function normalizedId(id) {
+    return id.replace(/[^a-zA-Z0-9]/g, '_');
+}
+
+const mapToObj = m => {
+    return Array.from(m).reduce((obj, [key, value]) => {
+        obj[key] = Joi.isSchema(value) ? value.describe() : value;
+        return obj;
+    }, {});
+};
+
+class SchemaResolver {
+    constructor(options) {
+        const validatedResult = optionsSchema.validate(options);
+
+        Hoek.assert(!validatedResult.error, validatedResult.error);
+
+        const { subSchemas = {}, refineType, refineSchema, strictMode, useDefaults, extensions = [], allowNull = false, refineDescription } = validatedResult.value;
+
+        this.subSchemas = subSchemas;
+        this.refineType = refineType;
+        this.refineDescription = refineDescription;
+        this.refineSchema = refineSchema;
+        this.strictMode = strictMode;
+        this.useDefaults = useDefaults;
+        this.allowNull = allowNull;
+        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
+        );
+
+        for (let sharedSchemaId in this.subSchemas) {
+            const sharedSchema = this.subSchemas[sharedSchemaId];
+            if (typeof sharedSchema === 'object' && !sharedSchema.$id) {
+                // shorthand schema type does not need to set $id
+                sharedSchema.$id = sharedSchemaId;
+            }
+            this.joiSharedSchemas.set(sharedSchemaId, this.resolve(sharedSchema));
+        }
+
+        const itr = this.joiSharedSchemas.keys();
+        this.initialSharedSchemaIds = [];
+        for (const id of itr) {
+            this.initialSharedSchemaIds.push(id);
+        }
+    }
+
+    resolveShareSchemas(schema, baseUri = '', sharedProperties = '$defs') {
+        const localShared = schema[sharedProperties]
+        if (localShared) {
+            for (let sharedSchemaId in localShared) {
+                this.joiSharedSchemas.set(
+                    `${baseUri}#/${sharedProperties}/${sharedSchemaId}`,
+                    this.resolve(localShared[sharedSchemaId], baseUri)
+                );
+            }
+        }
+    }
+
+    convert(schema) {
+        const validateSchema = schemaSchema.validate(schema);
+
+        Hoek.assert(!validateSchema.error, validateSchema.error);
+
+        const schemaId = schema.$id || '';
+        this.subSchemas[schemaId] = schema;
+        const joiSchema = this.resolve(schema);
+
+        // Cleanup all shared schema registered other than the initial shared ones
+        delete this.subSchemas[schemaId];
+        const itr = this.joiSharedSchemas.keys();
+        for (const id of itr) {
+            if (!this.initialSharedSchemaIds.includes(id)) {
+                delete this.subSchemas[id];
+                this.joiSharedSchemas.delete(id);
+            }
+        }
+        return joiSchema;
+    }
+
+    resolve(schema, baseUri = (schema.$id || '')) {
+        if (this.joi.isSchema(schema)) {
+            return schema;
+        }
+
+        const schemaId = schema.$id;
+        let resolvedSchema;
+
+        if (schemaId) {
+            baseUri = schemaId;
+            if (!this.subSchemas[schemaId]) {
+                this.subSchemas[schemaId] = schema;
+            }
+        }
+
+        this.resolveShareSchemas(schema, baseUri, '$defs');
+        this.resolveShareSchemas(schema, baseUri, 'definitions');
+
+        if (typeof schema === 'string') {
+            // If schema is itself a string, interpret it as a type
+            resolvedSchema = this.resolveType({ type: schema });
+        } else if (schema.$ref) {
+            if (schema.$ref.trim() === '#') {
+                return baseUri ? this.joi.link(`#${normalizedId(baseUri)}`) : this.joi.link('/');
+            }
+
+            resolvedSchema = this.resolve(this.resolveReference(schema.$ref, baseUri), baseUri);
+        } else {
+            const partialSchemas = [];
+            if (schema.type) {
+                partialSchemas.push(this.resolveType(schema, baseUri));
+            } else if (schema.properties) {
+                // if no type is specified, just properties
+                partialSchemas.push(this.object(schema, baseUri))
+            } else if (schema.format) {
+                // if no type is specified, just format
+                partialSchemas.push(this.string(schema))
+            } else if (schema.enum) {
+                // If no type is specified, just enum
+                partialSchemas.push(this.joi.any().valid(...schema.enum).example(schema.enum[0]));
+            } else if (schema.const) {
+                // Constant value
+                partialSchemas.push(this.getValueJoiType(schema.const).valid(schema.const));
+            }
+            if (schema.anyOf) {
+                partialSchemas.push(this.resolveAnyOf(schema, baseUri));
+            }
+            if (schema.allOf) {
+                partialSchemas.push(this.resolveAllOf(schema, baseUri));
+            }
+            if (schema.oneOf) {
+                partialSchemas.push(this.resolveOneOf(schema, baseUri));
+            }
+            if (schema.not) {
+                partialSchemas.push(this.resolveNot(schema, baseUri));
+            }
+            if (partialSchemas.length === 0) {
+                //Fall through to whatever.
+                //eslint-disable-next-line no-console
+                console.warn('WARNING: schema missing a \'type\' or \'$ref\' or \'enum\': \n%s', JSON.stringify(schema, null, 2));
+                //TODO: Handle better
+                partialSchemas.push(this.joi.any());
+            }
+            resolvedSchema = partialSchemas.length === 1 ? partialSchemas[0] : this.joi.alternatives(partialSchemas).match('all');
+        }
+
+        if (this.refineSchema) {
+            resolvedSchema = this.refineSchema(resolvedSchema, schema);
+        }
+
+        if (this.useDefaults && schema.default !== undefined) {
+            resolvedSchema = resolvedSchema.default(schema.default)
+        }
+
+        if (schemaId) {
+            resolvedSchema = resolvedSchema.id(normalizedId(schemaId));
+            this.joiSharedSchemas.set(schemaId, resolvedSchema);
+        }
+
+        if (schema.$anchor) {
+            this.joiSharedSchemas.set(`${baseUri}#${schema.$anchor}`, resolvedSchema);
+        }
+
+        return resolvedSchema;
+    }
+
+    resolveReference(value, baseUri = '') {
+        debug('----- Resolving schema reference: %s with baseUri: %s ----- ', value, baseUri);
+        debug('Registered JOI schema for shared: %f', () => {
+            return JSON.stringify(mapToObj(this.joiSharedSchemas), null, 2);
+        });
+        const hashIdx = value.indexOf('#');
+        let refSchema;
+
+        if (hashIdx === -1) {
+            // Locate through $ref: 'refId'
+            // debug('# Resolving reference through id: %s', value);
+            refSchema = this.joiSharedSchemas.get(value);
+        } else {
+            const id = value.substring(0, hashIdx);
+            const path = value.substring(hashIdx + 1);
+
+            const canonicalURI = id ? value : `${baseUri}${value}`;
+
+            if (canonicalURI.indexOf('/') === -1) {
+                // Locate through $ref: [baseUri]#anchorSchema
+                // debug('# Resolving reference through $anchor: %s', canonicalURI);
+                refSchema = this.joiSharedSchemas.get(canonicalURI);
+            } else if (canonicalURI.indexOf('/properties') === -1) {
+                // Locate through $ref: [baseUri]#/$defs/shared
+                // debug('# Resolving reference through direct canonicalURI: %s', canonicalURI);
+                refSchema = this.joiSharedSchemas.get(canonicalURI);
+            } else {
+                // Locate through $ref: [baseUri]#/$defs/shared/properties/level1 or [baseUri]#/properties/product
+                // Can only get raw schema and build Joi again because it might not completely built yet
+                // debug('# Resolving reference through relative path: baseUri - %s; id - %s; path - %s', baseUri, id, path);
+
+                const paths = path.split('/');
+                refSchema = this.subSchemas[id || baseUri];
+
+                while (paths.length > 0 && refSchema) {
+                    if (paths[0]) {
+                        refSchema = refSchema[paths[0]];
+                    }
+                    paths.splice(0, 1);
+                }
+            }
+        }
+
+        Hoek.assert(refSchema, `Can not find schema reference: ${value} with baseUri: ${baseUri}`);
+
+        return refSchema;
+    }
+
+    resolveType(schema, baseUri) {
+        let joischema;
+
+        const typeDefinitionMap = {
+            title: 'label',
+            default: 'default'
+        };
+
+        const joitype = (type, format) => {
+            let joischema;
+
+            if (this.refineType) {
+                type = this.refineType(type, format);
+            }
+
+            switch (type) {
+                case 'array':
+                    joischema = this.array(schema, baseUri);
+                    break;
+                case 'boolean':
+                    joischema = this.joi.boolean();
+                    break;
+                case 'integer':
+                case 'number':
+                    joischema = this.number(schema);
+                    break;
+                case 'object':
+                    joischema = this.object(schema, baseUri);
+                    break;
+                case 'string':
+                    joischema = this.string(schema);
+                    break;
+                case 'null':
+                    joischema = this.joi.any().valid(null);
+                    break;
+                default:
+                    joischema = this.joi.types()[type];
+            }
+
+            Hoek.assert(joischema, 'Could not resolve type: ' + schema.type + '.');
+
+            return joischema.strict(this.strictMode);
+        }
+
+        if (Array.isArray(schema.type)) {
+            const schemas = [];
+
+            for (let i = 0; i < schema.type.length; i++) {
+                schemas.push(joitype(schema.type[i], schema.format));
+            }
+
+            joischema = this.joi.alternatives(schemas);
+        } else {
+            joischema = joitype(schema.type, schema.format);
+        }
+
+        Object.keys(typeDefinitionMap).forEach(function (key) {
+            if (schema[key] !== undefined) {
+                joischema = joischema[typeDefinitionMap[key]](schema[key]);
+            }
+        });
+
+        let desc = schema.description;
+        if (this.refineDescription) {
+            desc = this.refineDescription(schema);
+        }
+        if (desc) {
+            joischema = joischema.description(desc);
+        }
+
+        let example;
+        if (schema.examples && schema.examples.length > 0) {
+            example = schema.examples[0];
+        }
+        if (!example && typeof schema.default !== 'undefined') {
+            example = schema.default;
+        }
+        if (!example && schema.enum && schema.enum.length > 0) {
+            example = schema.enum[0];
+        }
+        if (example) {
+            joischema = joischema.example(example);
+        }
+
+        return joischema;
+    }
+
+    resolveOneOf(schema, baseUri) {
+        Hoek.assert(Array.isArray(schema.oneOf), 'Expected oneOf to be an array.');
+
+        return this.joi.alternatives(schema.oneOf.map(schema => this.resolve(schema, baseUri))).match('one');
+    }
+
+    resolveAnyOf(schema, baseUri) {
+        Hoek.assert(Array.isArray(schema.anyOf), 'Expected anyOf to be an array.');
+
+        return this.joi.alternatives(schema.anyOf.map(schema => this.resolve(schema, baseUri))).match('any');
+    }
+
+    resolveAllOf(schema, baseUri) {
+        Hoek.assert(Array.isArray(schema.allOf), 'Expected allOf to be an array.');
+
+        return this.joi.alternatives(schema.allOf.map(schema => this.resolve(schema, baseUri))).match('all');
+    }
+
+    resolveNot(schema, baseUri) {
+        Hoek.assert(isObject(schema.not), 'Expected Not to be an object.');
+
+        return this.joi.alternatives().conditional(
+          '.',
+          {
+              not: this.resolve(schema.not, baseUri),
+              then: this.joi.any(),
+              otherwise: this.joi.any().forbidden()
+          }
+        );
+    }
+
+    object(schema, baseUri) {
+
+        const resolveproperties = () => {
+            const schemas = {};
+
+            if (!isObject(schema.properties)) {
+                return;
+            }
+
+            Object.keys(schema.properties).forEach((key) => {
+                const property = schema.properties[key];
+
+                let joischema = this.resolve(property, baseUri);
+
+                if (Array.isArray(schema.required) && !!~schema.required.indexOf(key)) {
+                    joischema = joischema.required();
+                } else if (this.allowNull) {
+                    joischema = joischema.allow(null);
+                }
+
+                schemas[key] = joischema;
+            });
+
+            return schemas;
+        }
+
+        let joischema = this.joi.object(resolveproperties(schema));
+
+        if (isObject(schema.additionalProperties)) {
+            joischema = joischema.pattern(/^/, this.resolve(schema.additionalProperties, baseUri));
+        } else {
+            joischema = joischema.unknown(schema.additionalProperties !== false);
+        }
+
+        isNumber(schema.minProperties) && (joischema = joischema.min(schema.minProperties));
+        isNumber(schema.maxProperties) && (joischema = joischema.max(schema.maxProperties));
+
+        return joischema;
+    }
+
+    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);
+
+            joischema = joischema.items(...items);
+        } else if (schema.ordered) {
+            items = resolveAsArray(schema.ordered);
+            joischema = joischema.ordered(...items);
+        }
+
+        if (items && schema.additionalItems === false) {
+            joischema = joischema.max(items.length);
+        }
+
+        isNumber(schema.minItems) && (joischema = joischema.min(schema.minItems));
+        isNumber(schema.maxItems) && (joischema = joischema.max(schema.maxItems));
+
+        if (schema.uniqueItems) {
+            joischema = joischema.unique();
+        }
+        if (schema.contains) {
+            joischema = joischema.has(this.resolve(schema.contains, baseUri));
+        }
+
+        return joischema;
+    }
+
+    number(schema) {
+        let joischema = this.joi.number();
+
+        if (schema.type === 'integer') {
+            joischema = joischema.integer();
+        }
+
+        isNumber(schema.minimum) && (joischema = joischema.min(schema.minimum));
+        isNumber(schema.maximum) && (joischema = joischema.max(schema.maximum));
+        isNumber(schema.exclusiveMinimum) && (joischema = joischema.greater(schema.exclusiveMinimum));
+        isNumber(schema.exclusiveMaximum) && (joischema = joischema.less(schema.exclusiveMaximum));
+        isNumber(schema.multipleOf) && schema.multipleOf !== 0 && (joischema = joischema.multiple(schema.multipleOf));
+
+        return joischema;
+    }
+
+    string(schema) {
+        let joischema = this.joi.string();
+
+        const dateRegex = '(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])';
+        const timeRegex = '([01][0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9]|60)(.[0-9]+)?(Z|(\\+|-)([01][0-9]|2[0-3]):([0-5][0-9]))';
+        const dateTimeRegex = dateRegex + 'T' + timeRegex;
+
+        if (schema.enum) {
+            return this.joi.string().valid(...schema.enum);
+        }
+
+        switch (schema.format) {
+            case 'date':
+                return joischema.regex(new RegExp('^' + dateRegex + '$', 'i'), 'JsonSchema date format');
+            case 'time':
+                return joischema.regex(new RegExp('^' + timeRegex + '$', 'i'), 'JsonSchema time format');
+            case 'date-time':
+                return joischema.regex(new RegExp('^' + dateTimeRegex + '$', 'i'), 'JsonSchema date-time format');
+            case 'binary':
+                joischema = this.binary(schema);
+                break;
+            case 'email':
+                return joischema.email();
+            case 'hostname':
+                return joischema.hostname();
+            case 'ipv4':
+                return joischema.ip({
+                    version: ['ipv4']
+                });
+            case 'ipv6':
+                return joischema.ip({
+                    version: ['ipv6']
+                });
+            case 'uri':
+                return joischema.uri();
+            case 'byte':
+                joischema = joischema.base64();
+                break;
+            case 'uuid':
+                return joischema.guid({ version: ['uuidv4'] });
+            case 'guid':
+                return joischema.guid();
+        }
+        return this.regularString(schema, joischema);
+    }
+
+    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) {
+            joischema = joischema.allow('');
+        }
+
+        isNumber(schema.minLength) && (joischema = joischema.min(schema.minLength));
+        isNumber(schema.maxLength) && (joischema = joischema.max(schema.maxLength));
+        return joischema;
+    }
+
+    binary(schema) {
+        let joischema = this.joi.binary();
+        isNumber(schema.minLength) && (joischema = joischema.min(schema.minLength));
+        isNumber(schema.maxLength) && (joischema = joischema.max(schema.maxLength));
+        return joischema;
+    }
+
+    getValueJoiType(value) {
+        let joiType;
+        switch (typeof value) {
+            case 'string':
+                joiType = this.joi.string();
+                break;
+            case 'number':
+                joiType = this.joi.number();
+                break;
+            case 'boolean':
+                joiType = this.joi.boolean();
+                break;
+            default:
+                joiType = this.joi.any();
+        }
+        return joiType;
+    }
+}
+
+module.exports = SchemaResolver;

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "json-2-joi",
+  "version": "1.0.0",
+  "license": "Apache 2.0",
+  "description": "Converts json-schema to Joi schema.",
+  "main": "./index.js",
+  "scripts": {
+    "test": "tape test/*.js",
+    "cover": "nyc --reporter=lcov --lines 100 npm test && nyc report",
+    "lint": "eslint index.js lib/resolver.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/kenspirit/json-2-joi.git"
+  },
+  "engines": {
+    "node": ">=12"
+  },
+  "keywords": [
+    "json-to-joi",
+    "json-2-joi",
+    "joi",
+    "json-schema",
+    "json",
+    "schema",
+    "validation",
+    "conversion",
+    "hapi",
+    "enjoi"
+  ],
+  "author": "Ken Chen <chengusky@gmail.com>",
+  "bugs": {
+    "url": "https://github.com/kenspirit/json-2-joi/issues"
+  },
+  "homepage": "https://github.com/kenspirit/json-2-joi",
+  "dependencies": {
+    "@hapi/bourne": "^3.0.0",
+    "@hapi/hoek": "^9.3.0",
+    "debug": "^4.3.4"
+  },
+  "peerDependencies": {
+    "joi": "^17.6.0"
+  },
+  "devDependencies": {
+    "joi": "^17.6.0",
+    "eslint": "^6.8.0",
+    "nyc": "^15.1.0",
+    "tape": "^5.5.3"
+  },
+  "files": [
+    "lib/**/*.js",
+    "index.js"
+  ]
+}