joi 18.0.2 → 18.1.0

package/lib/types/keys.js

@@ -47,6 +47,70 @@ module.exports = Any.extend({
         return schema.keys(keys);
     },
 
+    jsonSchema(schema, res, mode, options) {
+
+        res.type = 'object';
+
+        // Map Joi keys to JSON Schema 'properties' and 'required'
+
+        if (schema.$_terms.keys) {
+            res.properties = {};
+
+            const required = [];
+
+            for (const child of schema.$_terms.keys) {
+                const jsonSchema = child.schema.$_jsonSchema(mode, options);
+                res.properties[child.key] = jsonSchema;
+                if (child.schema._flags.presence === 'required' ||
+                    (mode === 'output' && child.schema._flags.default !== undefined)) {
+
+                    required.push(child.key);
+                }
+            }
+
+            if (required.length) {
+                res.required = required.sort();
+            }
+        }
+
+        // Map Joi patterns to JSON Schema 'patternProperties' or 'additionalProperties'
+
+        if (schema.$_terms.patterns) {
+            const patternProperties = {};
+
+            for (const pattern of schema.$_terms.patterns) {
+                if (pattern.regex) {
+                    patternProperties[pattern.regex.source] = pattern.rule.$_jsonSchema(mode, options);
+                }
+                else {
+                    const isAny = pattern.schema.type === 'any';
+                    if (isAny) {
+                        res.additionalProperties = pattern.rule.$_jsonSchema(mode, options);
+                    }
+                    else {
+                        // Best effort for schema-based patterns that are not 'any'
+                        patternProperties['.*'] = pattern.rule.$_jsonSchema(mode, options);
+                    }
+                }
+            }
+
+            if (Object.keys(patternProperties).length) {
+                res.patternProperties = patternProperties;
+            }
+        }
+
+        // Handle 'additionalProperties' based on unknown keys flag
+
+        if (res.additionalProperties === undefined) {
+            const additionalProperties = schema._flags.unknown === true || (schema._flags.unknown === undefined && !schema.$_terms.keys && !schema.$_terms.patterns && !schema._flags.only);
+            if (additionalProperties === false) {
+                res.additionalProperties = false;
+            }
+        }
+
+        return res;
+    },
+
     validate(value, { schema, error, state, prefs }) {
 
         if (!value ||
@@ -278,6 +342,12 @@ module.exports = Any.extend({
 
                 return helpers.error('object.' + name, { limit: args.limit, value });
             },
+            jsonSchema(rule, res) {
+
+                res.minProperties = rule.args.limit;
+                res.maxProperties = rule.args.limit;
+                return res;
+            },
             args: [
                 {
                     name: 'limit',
@@ -292,6 +362,11 @@ module.exports = Any.extend({
             method(limit) {
 
                 return this.$_addRule({ name: 'max', method: 'length', args: { limit }, operator: '<=' });
+            },
+            jsonSchema(rule, res) {
+
+                res.maxProperties = rule.args.limit;
+                return res;
             }
         },
 
@@ -299,6 +374,11 @@ module.exports = Any.extend({
             method(limit) {
 
                 return this.$_addRule({ name: 'min', method: 'length', args: { limit }, operator: '>=' });
+            },
+            jsonSchema(rule, res) {
+
+                res.minProperties = rule.args.limit;
+                return res;
             }
         },
 

package/lib/types/link.js

@@ -29,6 +29,29 @@ module.exports = Any.extend({
         return schema.ref(ref);
     },
 
+    jsonSchema(schema, res, mode, options) {
+
+        if (!schema.$_terms.link) {
+            return res;
+        }
+
+        const { ref } = schema.$_terms.link[0];
+
+        if (ref.ancestor === 'root' || ref.ancestor > 0) {
+            res.$ref = `#/${ref.path.map((p) => `properties/${p}`).join('/')}`;
+            return res;
+        }
+
+        if (ref.path.length === 1) {
+            res.$ref = `#/$defs/${ref.path[0]}`;
+        }
+        else {
+            res.$ref = `#/${ref.path.slice(1).map((p) => `properties/${p}`).join('/')}`;
+        }
+
+        return res;
+    },
+
     validate(value, { schema, state, prefs }) {
 
         assert(schema.$_terms.link, 'Uninitialized link schema');

package/lib/types/number.js

@@ -136,6 +136,11 @@ module.exports = Any.extend({
             method(limit) {
 
                 return this.$_addRule({ name: 'greater', method: 'compare', args: { limit }, operator: '>' });
+            },
+            jsonSchema(rule, res) {
+
+                res.exclusiveMinimum = rule.args.limit;
+                return res;
             }
         },
 
@@ -151,6 +156,12 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('number.integer');
+            },
+            jsonSchema(rule, res) {
+
+                res.type = 'integer';
+
+                return res;
             }
         },
 
@@ -158,6 +169,11 @@ module.exports = Any.extend({
             method(limit) {
 
                 return this.$_addRule({ name: 'less', method: 'compare', args: { limit }, operator: '<' });
+            },
+            jsonSchema(rule, res) {
+
+                res.exclusiveMaximum = rule.args.limit;
+                return res;
             }
         },
 
@@ -165,6 +181,11 @@ module.exports = Any.extend({
             method(limit) {
 
                 return this.$_addRule({ name: 'max', method: 'compare', args: { limit }, operator: '<=' });
+            },
+            jsonSchema(rule, res) {
+
+                res.maximum = rule.args.limit;
+                return res;
             }
         },
 
@@ -172,6 +193,11 @@ module.exports = Any.extend({
             method(limit) {
 
                 return this.$_addRule({ name: 'min', method: 'compare', args: { limit }, operator: '>=' });
+            },
+            jsonSchema(rule, res) {
+
+                res.minimum = rule.args.limit;
+                return res;
             }
         },
 
@@ -203,6 +229,11 @@ module.exports = Any.extend({
                     value :
                     helpers.error('number.multiple', { multiple: options.args.base, value });
             },
+            jsonSchema(rule, res) {
+
+                res.multipleOf = rule.args.base;
+                return res;
+            },
             args: [
                 {
                     name: 'base',
@@ -284,6 +315,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error(`number.${sign}`);
+            },
+            jsonSchema(rule, res) {
+
+                res['x-constraint'] = { ...res['x-constraint'], sign: rule.args.sign };
+                return res;
             }
         },
 

package/lib/types/string.js

@@ -144,6 +144,23 @@ module.exports = Any.extend({
         }
     },
 
+    jsonSchema(schema, res, mode, options) {
+
+        const noEmpty = !schema._valids?.has('') && !schema._flags.only;
+        if (noEmpty) {
+            const min = schema.$_getRule('min');
+            const length = schema.$_getRule('length');
+
+            if ((!min || min.args.limit > 0) &&
+                (!length || length.args.limit > 0)) {
+
+                res.minLength = 1;
+            }
+        }
+
+        return res;
+    },
+
     rules: {
 
         alphanum: {
@@ -180,6 +197,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.base64');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'base64';
+                return res;
             }
         },
 
@@ -260,6 +282,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.dataUri');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'data-uri';
+                return res;
             }
         },
 
@@ -309,6 +336,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.email', { value, invalids });
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'email';
+                return res;
             }
         },
 
@@ -398,6 +430,11 @@ module.exports = Any.extend({
                 }
 
                 return value;
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'uuid';
+                return res;
             }
         },
 
@@ -430,6 +467,11 @@ module.exports = Any.extend({
                 }
 
                 return value;
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'hex';
+                return res;
             }
         },
 
@@ -447,6 +489,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.hostname');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'hostname';
+                return res;
             }
         },
 
@@ -477,6 +524,18 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.ip', { value, cidr: options.cidr });
+            },
+            jsonSchema(rule, res) {
+
+                const version = rule.args.options.version;
+                if (version && version.length === 1) {
+                    res.format = version[0];
+                }
+                else {
+                    res.format = 'ip';
+                }
+
+                return res;
             }
         },
 
@@ -492,6 +551,11 @@ module.exports = Any.extend({
                 }
 
                 return error('string.isoDate');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'date-time';
+                return res;
             }
         },
 
@@ -507,6 +571,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.isoDuration');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'duration';
+                return res;
             }
         },
 
@@ -524,6 +593,12 @@ module.exports = Any.extend({
 
                 return helpers.error('string.' + name, { limit: args.limit, value, encoding });
             },
+            jsonSchema(rule, res) {
+
+                res.minLength = rule.args.limit;
+                res.maxLength = rule.args.limit;
+                return res;
+            },
             args: [
                 {
                     name: 'limit',
@@ -547,6 +622,11 @@ module.exports = Any.extend({
 
                 return internals.length(this, 'max', limit, '<=', encoding);
             },
+            jsonSchema(rule, res) {
+
+                res.maxLength = rule.args.limit;
+                return res;
+            },
             args: ['limit', 'encoding']
         },
 
@@ -555,6 +635,15 @@ module.exports = Any.extend({
 
                 return internals.length(this, 'min', limit, '>=', encoding);
             },
+            jsonSchema(rule, res) {
+
+                if (rule.args.limit > 0) {
+
+                    res.minLength = rule.args.limit;
+                }
+
+                return res;
+            },
             args: ['limit', 'encoding']
         },
 
@@ -602,6 +691,11 @@ module.exports = Any.extend({
 
                 return helpers.error(errorCode, { name: options.name, regex, value });
             },
+            jsonSchema(rule, res) {
+
+                res.pattern = rule.args.regex.source;
+                return res;
+            },
             args: ['regex', 'options'],
             multi: true
         },
@@ -639,6 +733,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.token');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'token';
+                return res;
             }
         },
 
@@ -728,6 +827,11 @@ module.exports = Any.extend({
                 }
 
                 return helpers.error('string.uri');
+            },
+            jsonSchema(rule, res) {
+
+                res.format = 'uri';
+                return res;
             }
         }
     },

package/lib/types/symbol.js

@@ -95,6 +95,18 @@ module.exports = Any.extend({
         }
     },
 
+    jsonSchema(schema, json, mode, options) {
+
+        const map = schema.$_terms.map;
+        if (!map.size) {
+            return {};
+        }
+
+        return {
+            anyOf: Array.from(map.keys()).map((key) => ({ const: key }))
+        };
+    },
+
     messages: {
         'symbol.base': '{{#label}} must be a symbol',
         'symbol.map': '{{#label}} must be one of {{#map}}'

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "joi",
     "description": "Object schema validation",
-    "version": "18.0.2",
+    "version": "18.1.0",
     "repository": {
         "url": "git://github.com/hapijs/joi",
         "type": "git"
@@ -27,7 +27,7 @@
         "@hapi/pinpoint": "^2.0.1",
         "@hapi/tlds": "^1.1.1",
         "@hapi/topo": "^6.0.2",
-        "@standard-schema/spec": "^1.0.0"
+        "@standard-schema/spec": "^1.1.0"
     },
     "devDependencies": {
         "@hapi/bourne": "^3.0.0",
@@ -36,6 +36,7 @@
         "@hapi/joi-legacy-test": "npm:@hapi/joi@15.x.x",
         "@hapi/lab": "^26.0.0",
         "@types/node": "^20.17.47",
+        "ajv": "^8.18.0",
         "typescript": "^5.8.3"
     },
     "scripts": {