joi 17.4.0 → 17.5.0

package/lib/errors.js

@@ -131,10 +131,19 @@ exports.template = function (value, messages, code, state, prefs) {
     }
 
     if (lang &&
-        messages[lang] &&
-        messages[lang][code] !== undefined) {
+        messages[lang]) {
 
-        return messages[lang][code];
+        if (messages[lang][code] !== undefined) {
+            return messages[lang][code];
+        }
+
+        if (messages[lang]['*'] !== undefined) {
+            return messages[lang]['*'];
+        }
+    }
+
+    if (!messages[code]) {
+        return messages['*'];
     }
 
     return messages[code];

package/lib/index.d.ts

@@ -77,11 +77,18 @@ declare namespace Joi {
             label?: string | false,
 
             /**
-             * the characters used around array avlues. Defaults to `'[]'`
+             * the characters used around array values. Defaults to `'[]'`
              *
              * @default '[]'
              */
             array?: string | false
+
+            /**
+             * the characters used around array string values. Defaults to no wrapping.
+             *
+             * @default false
+             */
+            string?: string | false
         };
     }
 
@@ -250,6 +257,12 @@ declare namespace Joi {
     }
 
     interface EmailOptions {
+        /**
+         * if `true`, domains ending with a `.` character are permitted
+         *
+         * @default false
+         */
+        allowFullyQualified?: boolean;
         /**
          * If `true`, Unicode characters are permitted
          *
@@ -289,6 +302,12 @@ declare namespace Joi {
     }
 
     interface DomainOptions {
+        /**
+         * if `true`, domains ending with a `.` character are permitted
+         *
+         * @default false
+         */
+        allowFullyQualified?: boolean;
         /**
          * If `true`, Unicode characters are permitted
          *
@@ -642,10 +661,14 @@ declare namespace Joi {
 
     type ValidationErrorFunction = (errors: ErrorReport[]) => string | ValidationErrorItem | Error;
 
-    interface ValidationResult {
-        error?: ValidationError;
+    type ValidationResult<TSchema = any> = {
+        error: undefined;
         warning?: ValidationError;
-        value: any;
+        value: TSchema;
+    } | {
+        error: ValidationError;
+        warning?: ValidationError;
+        value: undefined;
     }
 
     interface CreateErrorOptions {
@@ -681,15 +704,44 @@ declare namespace Joi {
 
     type CustomValidator<V = any> = (value: V, helpers: CustomHelpers) => V | ErrorReport;
 
-    type ExternalValidationFunction = (value: any) => any;
+    interface ExternalHelpers {
+        prefs: ValidationOptions;
+    }
+
+    type ExternalValidationFunction<V = any> = (value: V, helpers: ExternalHelpers) => V | undefined;
 
     type SchemaLikeWithoutArray = string | number | boolean | null | Schema | SchemaMap;
     type SchemaLike = SchemaLikeWithoutArray | object;
 
-    type SchemaMap<TSchema = any> = {
+    type NullableType<T> = undefined | null | T
+
+    type ObjectPropertiesSchema<T = any> = 
+        T extends NullableType<string>
+        ? Joi.StringSchema
+        : T extends NullableType<number>
+        ? Joi.NumberSchema
+        : T extends NullableType<bigint>
+        ? Joi.NumberSchema
+        : T extends NullableType<boolean>
+        ? Joi.BooleanSchema
+        : T extends NullableType<Date>
+        ? Joi.DateSchema
+        : T extends NullableType<Array<any>>
+        ? Joi.ArraySchema
+        : T extends NullableType<object>
+        ? ObjectSchema<StrictSchemaMap<T>>
+        : never    
+    
+    type PartialSchemaMap<TSchema = any> = {
         [key in keyof TSchema]?: SchemaLike | SchemaLike[];
+    } 
+
+    type StrictSchemaMap<TSchema = any> =  {
+        [key in keyof TSchema]-?: ObjectPropertiesSchema<TSchema[key]>
     };
 
+    type SchemaMap<TSchema = any, isStrict = false> = isStrict extends true ? StrictSchemaMap<TSchema> : PartialSchemaMap<TSchema>
+
     type Schema<P = any> =
         | AnySchema
         | ArraySchema
@@ -805,7 +857,7 @@ declare namespace Joi {
         $_validate(value: any, state: State, prefs: ValidationOptions): ValidationResult;
     }
 
-    interface AnySchema extends SchemaInternals {
+    interface AnySchema<TSchema = any> extends SchemaInternals {
         /**
          * Flags of current schema.
          */
@@ -1128,7 +1180,7 @@ declare namespace Joi {
         /**
          * Validates a value using the schema and options.
          */
-        validate(value: any, options?: ValidationOptions): ValidationResult;
+        validate(value: any, options?: ValidationOptions): ValidationResult<TSchema>;
 
         /**
          * Validates a value using the schema and options.
@@ -1548,7 +1600,7 @@ declare namespace Joi {
         matches: SchemaLike | Reference;
     }
 
-    interface ObjectSchema<TSchema = any> extends AnySchema {
+    interface ObjectSchema<TSchema = any> extends AnySchema<TSchema> {
         /**
          * Defines an all-or-nothing relationship between keys where if one of the peers is present, all of them are required as well.
          *
@@ -1764,7 +1816,7 @@ declare namespace Joi {
         /**
          * Adds a conditional alternative schema type, either based on another key value, or a schema peeking into the current value.
          */
-        conditional(ref: string | Reference, options: WhenOptions): this;
+        conditional(ref: string | Reference, options: WhenOptions | WhenOptions[]): this;
         conditional(ref: Schema, options: WhenSchemaOptions): this;
 
         /**
@@ -1972,7 +2024,7 @@ declare namespace Joi {
          * Generates a schema object that matches an object data type (as well as JSON strings that have been parsed into objects).
          */
         // tslint:disable-next-line:no-unnecessary-generics
-        object<TSchema = any, T = TSchema>(schema?: SchemaMap<T>): ObjectSchema<TSchema>;
+        object<TSchema = any, isStrict = false, T = TSchema>(schema?: SchemaMap<T, isStrict>): ObjectSchema<TSchema>;
 
         /**
          * Generates a schema object that matches a string data type. Note that empty strings are not allowed by default and must be enabled with allow('').
@@ -2090,7 +2142,7 @@ declare namespace Joi {
         /**
          * Checks whether or not the provided argument is a joi schema.
          */
-        isSchema(schema: any, options?: CompileOptions): boolean;
+        isSchema(schema: any, options?: CompileOptions): schema is AnySchema;
 
         /**
          * A special value used with `any.allow()`, `any.invalid()`, and `any.valid()` as the first value to reset any previously set values.

package/lib/messages.js

@@ -81,7 +81,7 @@ exports.decompile = function (messages) {
         const message = messages[code];
 
         if (code === 'root') {
-            target[code] = message;
+            target.root = message;
             continue;
         }
 
@@ -99,7 +99,7 @@ exports.decompile = function (messages) {
             const localized = message[code];
 
             if (code === 'root') {
-                target[language][code] = localized;
+                target[language].root = localized;
                 continue;
             }
 

package/lib/schemas.js

@@ -34,7 +34,8 @@ exports.preferences = Joi.object({
         stack: Joi.boolean(),
         wrap: {
             label: internals.wrap,
-            array: internals.wrap
+            array: internals.wrap,
+            string: internals.wrap
         }
     },
     externals: Joi.boolean(),

package/lib/template.js

@@ -307,9 +307,10 @@ internals.wrap = function (value, ends) {
 };
 
 
-internals.stringify = function (value, original, state, prefs, local, options) {
+internals.stringify = function (value, original, state, prefs, local, options = {}) {
 
     const type = typeof value;
+    const wrap = prefs && prefs.errors && prefs.errors.wrap || {};
 
     let skipWrap = false;
     if (Ref.isRef(value) &&
@@ -324,7 +325,7 @@ internals.stringify = function (value, original, state, prefs, local, options) {
     }
 
     if (type === 'string') {
-        return value;
+        return internals.wrap(value, options.arrayItems && wrap.string);
     }
 
     if (type === 'number' ||
@@ -355,16 +356,12 @@ internals.stringify = function (value, original, state, prefs, local, options) {
         return value.toString();
     }
 
-    let partial = '';
+    const values = [];
     for (const item of value) {
-        partial = partial + (partial.length ? ', ' : '') + internals.stringify(item, original, state, prefs, local, options);
-    }
-
-    if (skipWrap) {
-        return partial;
+        values.push(internals.stringify(item, original, state, prefs, local, { arrayItems: true, ...options }));
     }
 
-    return internals.wrap(partial, prefs.errors.wrap.array);
+    return internals.wrap(values.join(', '), !skipWrap && wrap.array);
 };
 
 

package/lib/types/alternatives.js

@@ -46,6 +46,7 @@ module.exports = Any.extend({
 
         if (schema._flags.match) {
             const matched = [];
+            const failed = [];
 
             for (let i = 0; i < schema.$_terms.matches.length; ++i) {
                 const item = schema.$_terms.matches[i];
@@ -57,24 +58,45 @@ module.exports = Any.extend({
                     matched.push(result.value);
                 }
                 else {
+                    failed.push(result.errors);
                     localState.restore();
                 }
             }
 
             if (matched.length === 0) {
-                return { errors: error('alternatives.any') };
+                const context = {
+                    details: failed.map((f) => Errors.details(f, { override: false }))
+                };
+
+                return { errors: error('alternatives.any', context) };
             }
 
+            // Match one
+
             if (schema._flags.match === 'one') {
                 return matched.length === 1 ? { value: matched[0] } : { errors: error('alternatives.one') };
             }
 
+            // Match all
+
             if (matched.length !== schema.$_terms.matches.length) {
-                return { errors: error('alternatives.all') };
+                const context = {
+                    details: failed.map((f) => Errors.details(f, { override: false }))
+                };
+
+                return { errors: error('alternatives.all', context) };
             }
 
-            const allobj = schema.$_terms.matches.reduce((acc, v) => acc && v.schema.type === 'object', true);
-            return allobj ? { value: matched.reduce((acc, v) => Merge(acc, v, { mergeArrays: false })) } : { value: matched[matched.length - 1] };
+            const isAnyObj = (alternative) => {
+
+                return alternative.$_terms.matches.some((v) => {
+
+                    return v.schema.type === 'object' ||
+                        (v.schema.type === 'alternatives' && isAnyObj(v.schema));
+                });
+            };
+
+            return isAnyObj(schema) ? { value: matched.reduce((acc, v) => Merge(acc, v, { mergeArrays: false })) } : { value: matched[matched.length - 1] };
         }
 
         // Match any

package/lib/types/array.js

@@ -319,7 +319,7 @@ module.exports = Any.extend({
                         continue;
                     }
 
-                    if (schema.$_terms._inclusions.length &&
+                    if ((schema.$_terms._inclusions.length || schema.$_terms._requireds.length) &&
                         !isValid) {
 
                         if (stripUnknown) {

package/lib/types/number.js

@@ -169,7 +169,7 @@ module.exports = Any.extend({
             },
             validate(value, helpers, { base }, options) {
 
-                if (value % base === 0) {
+                if (value * (1 / base) % 1 === 0) {
                     return value;
                 }
 

package/lib/types/string.js

@@ -28,7 +28,7 @@ const internals = {
     },
     dataUriRegex: /^data:[\w+.-]+\/[\w+.-]+;((charset=[\w-]+|base64),)?(.*)$/,
     hexRegex: /^[a-f0-9]+$/i,
-    ipRegex: Ip.regex().regex,
+    ipRegex: Ip.regex({ cidr: 'forbidden' }).regex,
     isoDurationRegex: /^P(?!$)(\d+Y)?(\d+M)?(\d+W)?(\d+D)?(T(?=\d)(\d+H)?(\d+M)?(\d+S)?)?$/,
 
     guidBrackets: {
@@ -123,13 +123,20 @@ module.exports = Any.extend({
         }
     },
 
-    validate(value, { error }) {
+    validate(value, { schema, error }) {
 
         if (typeof value !== 'string') {
             return { value, errors: error('string.base') };
         }
 
         if (value === '') {
+            const min = schema.$_getRule('min');
+            if (min &&
+                min.args.limit === 0) {
+
+                return;
+            }
+
             return { value, errors: error('string.empty') };
         }
     },
@@ -257,7 +264,7 @@ module.exports = Any.extend({
             method(options) {
 
                 if (options) {
-                    Common.assertOptions(options, ['allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
+                    Common.assertOptions(options, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
                 }
 
                 const address = internals.addressOptions(options);
@@ -276,7 +283,7 @@ module.exports = Any.extend({
         email: {
             method(options = {}) {
 
-                Common.assertOptions(options, ['allowUnicode', 'ignoreLength', 'maxDomainSegments', 'minDomainSegments', 'multiple', 'separator', 'tlds']);
+                Common.assertOptions(options, ['allowFullyQualified', 'allowUnicode', 'ignoreLength', 'maxDomainSegments', 'minDomainSegments', 'multiple', 'separator', 'tlds']);
                 Assert(options.multiple === undefined || typeof options.multiple === 'boolean', 'multiple option must be an boolean');
 
                 const address = internals.addressOptions(options);
@@ -632,7 +639,7 @@ module.exports = Any.extend({
                 Common.assertOptions(options, ['allowRelative', 'allowQuerySquareBrackets', 'domain', 'relativeOnly', 'scheme']);
 
                 if (options.domain) {
-                    Common.assertOptions(options.domain, ['allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
+                    Common.assertOptions(options.domain, ['allowFullyQualified', 'allowUnicode', 'maxDomainSegments', 'minDomainSegments', 'tlds']);
                 }
 
                 const { regex, scheme } = Uri.regex(options);

package/lib/validator.js

@@ -94,7 +94,10 @@ exports.entryAsync = async function (value, schema, prefs) {
                 }
             }
             catch (err) {
-                err.message += ` (${label})`;       // Change message to include path
+                if (settings.errors.label) {
+                    err.message += ` (${label})`;       // Change message to include path
+                }
+
                 throw err;
             }
         }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "joi",
     "description": "Object schema validation",
-    "version": "17.4.0",
+    "version": "17.5.0",
     "repository": "git://github.com/sideway/joi",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -17,7 +17,7 @@
     "dependencies": {
         "@hapi/hoek": "^9.0.0",
         "@hapi/topo": "^5.0.0",
-        "@sideway/address": "^4.1.0",
+        "@sideway/address": "^4.1.3",
         "@sideway/formula": "^3.0.0",
         "@sideway/pinpoint": "^2.0.0"
     },
@@ -26,7 +26,7 @@
         "@hapi/code": "8.x.x",
         "@hapi/joi-legacy-test": "npm:@hapi/joi@15.x.x",
         "@hapi/lab": "24.x.x",
-        "typescript": "4.0.x"
+        "typescript": "4.3.x"
     },
     "scripts": {
         "prepublishOnly": "cd browser && npm install && npm run build",