json-2-joi 2.5.0 → 3.0.0

package/README.md

@@ -90,7 +90,7 @@ 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.

package/lib/resolver.js

@@ -1,4 +1,3 @@
-/* global Map */
 const Joi = require('joi');
 const Hoek = require('@hapi/hoek');
 const Bourne = require('@hapi/bourne');
@@ -124,7 +123,9 @@ function getJoiInstance(joiOptions, extensions, joiInstance) {
                     }
                     try {
                         return { value: Bourne.parse(value) };
-                    } catch (ignoreErr) { } // eslint-disable-line no-empty
+                    } catch (ignoreErr) { /* eslint-disable-line no-unused-vars */
+                        // Purposefully ignoring error
+                    }
                 }
             }
         },
@@ -139,7 +140,9 @@ function getJoiInstance(joiOptions, extensions, joiInstance) {
                     }
                     try {
                         return { value: Bourne.parse(value) };
-                    } catch (ignoreErr) { } // eslint-disable-line no-empty
+                    } catch (ignoreErr) { /* eslint-disable-line no-unused-vars */
+                        // Purposefully ignoring error
+                    }
                 }
             }
         },
@@ -222,7 +225,7 @@ class SchemaResolver {
         return joiSchema;
     }
 
-    resolve(schema, resolveOptions = {}, baseUri = (schema.$id || '')) {
+    resolve(schema, resolveOptions = {}, baseUri = (schema.$id || ''), isPropertyRequired = false) {
         if (this.joi.isSchema(schema)) {
             return schema;
         }
@@ -242,17 +245,17 @@ class SchemaResolver {
 
         if (typeof schema === 'string') {
             // If schema is itself a string, interpret it as a type
-            resolvedSchema = this.resolveType({ type: schema }, resolveOptions, baseUri);
+            resolvedSchema = this.resolveType({ type: schema }, resolveOptions, baseUri, isPropertyRequired);
         } 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), resolveOptions, baseUri);
+            resolvedSchema = this.resolve(this.resolveReference(schema.$ref, baseUri), resolveOptions, baseUri, isPropertyRequired);
         } else {
             const partialSchemas = [];
             if (schema.type) {
-                partialSchemas.push(this.resolveType(schema, resolveOptions, baseUri));
+                partialSchemas.push(this.resolveType(schema, resolveOptions, baseUri, isPropertyRequired));
             } else if (schema.properties) {
                 // if no type is specified, just properties
                 partialSchemas.push(this.object(schema, resolveOptions, baseUri))
@@ -282,7 +285,6 @@ class SchemaResolver {
             }
             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());
@@ -298,7 +300,9 @@ class SchemaResolver {
             resolvedSchema = resolvedSchema.default(schema.default)
         }
 
-        if (schemaId) {
+        resolvedSchema = this.copyMetaAnnotations(schema, resolvedSchema);
+
+        if (schemaId && !(this.joiSharedSchemas.get(schemaId))) {
             resolvedSchema = resolvedSchema.id(normalizedId(schemaId));
             this.joiSharedSchemas.set(schemaId, resolvedSchema);
         }
@@ -307,6 +311,15 @@ class SchemaResolver {
             this.joiSharedSchemas.set(`${baseUri}#${schema.$anchor}`, resolvedSchema);
         }
 
+        if (isPropertyRequired) {
+            resolvedSchema = resolvedSchema.required();
+            if (resolveOptions.strictRequired) {
+                resolvedSchema = resolvedSchema.invalid(null, '');
+            }
+        } else {
+            resolvedSchema = allowNullIfNeeded(resolvedSchema, resolveOptions);
+        }
+
         return resolvedSchema;
     }
 
@@ -358,7 +371,7 @@ class SchemaResolver {
         return refSchema;
     }
 
-    resolveType(schema, resolveOptions, baseUri) {
+    resolveType(schema, resolveOptions, baseUri, isPropertyRequired = false) {
         let joischema;
 
         const joitype = (type, options, format) => {
@@ -370,7 +383,7 @@ class SchemaResolver {
 
             switch (type) {
                 case 'array':
-                    joischema = this.array(schema, options, baseUri);
+                    joischema = this.array(schema, options, baseUri, isPropertyRequired);
                     break;
                 case 'boolean':
                     joischema = this.joi.boolean();
@@ -460,6 +473,22 @@ class SchemaResolver {
         return addEnumRestriction(joischema, schema.enum, resolveOptions);
     }
 
+    copyMetaAnnotations(schema, joischema) {
+        const metaDataNames = ['title', 'deprecated', 'readOnly', 'writeOnly'];
+        const metas = {};
+        for (const metaName of metaDataNames) {
+            if (typeof schema[metaName] !== 'undefined') {
+                metas[metaName] = schema[metaName];
+            }
+        }
+
+        if (Object.keys(metas).length === 0) {
+            return joischema;
+        }
+
+        return joischema.meta(metas);
+    }
+
     resolveOneOf(schema, resolveOptions, baseUri) {
         Hoek.assert(Array.isArray(schema.oneOf), 'Expected oneOf to be an array.');
 
@@ -500,17 +529,9 @@ class SchemaResolver {
 
         Object.keys(jsonSchema.properties).forEach((key) => {
             const property = jsonSchema.properties[key];
+            const isPropertyRequired = Array.isArray(jsonSchema.required) && !!~jsonSchema.required.indexOf(key);
 
-            let joischema = this.resolve(property, resolveOptions, baseUri);
-
-            if (Array.isArray(jsonSchema.required) && !!~jsonSchema.required.indexOf(key)) {
-                joischema = joischema.required();
-                if (resolveOptions.strictRequired) {
-                    joischema = joischema.invalid(null, '');
-                }
-            } else {
-                joischema = allowNullIfNeeded(joischema, resolveOptions);
-            }
+            const joischema = this.resolve(property, resolveOptions, baseUri, isPropertyRequired);
 
             schemas[key] = joischema;
         });
@@ -533,26 +554,26 @@ class SchemaResolver {
         return joischema;
     }
 
-    resolveAsArray(value, resolveOptions, baseUri) {
+    resolveAsArray(value, resolveOptions, baseUri, isPropertyRequired = false) {
         return [].concat(value).map((v) => {
             const vSchema = this.resolve(v, resolveOptions, baseUri);
-            if (resolveOptions.strictArrayRequired) {
+            if (resolveOptions.strictArrayRequired && isPropertyRequired) {
                 return vSchema.invalid(...resolveOptions.customizedNullValues);
             }
             return allowNullIfNeeded(vSchema, resolveOptions)
         });
     }
 
-    array(schema, resolveOptions, baseUri) {
+    array(schema, resolveOptions, baseUri, isPropertyRequired = false) {
         let joischema = this.joi.array();
         let items;
 
         if (schema.items) {
-            items = this.resolveAsArray(schema.items, resolveOptions, baseUri);
+            items = this.resolveAsArray(schema.items, resolveOptions, baseUri, isPropertyRequired);
 
             joischema = joischema.items(...items);
         } else if (schema.ordered) {
-            items = this.resolveAsArray(schema.ordered, resolveOptions, baseUri);
+            items = this.resolveAsArray(schema.ordered, resolveOptions, baseUri, isPropertyRequired);
             joischema = joischema.ordered(...items);
         }
 
@@ -560,7 +581,7 @@ class SchemaResolver {
             joischema = joischema.max(items.length);
         }
 
-        if (resolveOptions.strictArrayRequired && !schema.minItems) {
+        if (isPropertyRequired && resolveOptions.strictArrayRequired && !schema.minItems) {
             schema.minItems = 1;
         }
         isNumber(schema.minItems) && (joischema = joischema.min(schema.minItems));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "json-2-joi",
-  "version": "2.5.0",
+  "version": "3.0.0",
   "license": "Apache 2.0",
   "description": "Converts json-schema to Joi schema. (Enhanced enjoi)",
   "main": "./index.js",
@@ -13,9 +13,6 @@
     "type": "git",
     "url": "git://github.com/kenspirit/json-2-joi.git"
   },
-  "engines": {
-    "node": ">=12"
-  },
   "keywords": [
     "json-to-joi",
     "json-2-joi",
@@ -35,17 +32,19 @@
   "homepage": "https://github.com/kenspirit/json-2-joi",
   "dependencies": {
     "@hapi/bourne": "^3.0.0",
-    "@hapi/hoek": "^9.3.0",
-    "debug": "^4.3.4"
+    "@hapi/hoek": "^11.0.4",
+    "debug": "^4.3.5"
   },
   "peerDependencies": {
-    "joi": "^17.6.0"
+    "joi": "^17.13.3"
   },
   "devDependencies": {
-    "joi": "^17.6.0",
-    "eslint": "^6.8.0",
-    "nyc": "^15.1.0",
-    "tape": "^5.5.3"
+    "@eslint/js": "^9.6.0",
+    "eslint": "^9.6.0",
+    "globals": "^15.7.0",
+    "joi": "^17.13.3",
+    "nyc": "^17.0.0",
+    "tape": "^5.8.1"
   },
   "files": [
     "lib/**/*.js",