joi 13.4.0 → 13.6.0

package/README.md

@@ -16,7 +16,7 @@ Imagine you run facebook and you want visitors to sign up on the website with re
 This is joi, joi allows you to create *blueprints* or *schemas* for JavaScript objects (an object that stores information) to ensure *validation* of key information.
 
 # API
-See the detailed [API Reference](https://github.com/hapijs/joi/blob/v13.4.0/API.md).
+See the detailed [API Reference](https://github.com/hapijs/joi/blob/v13.6.0/API.md).
 
 # Example
 
@@ -28,7 +28,7 @@ const schema = Joi.object().keys({
     password: Joi.string().regex(/^[a-zA-Z0-9]{3,30}$/),
     access_token: [Joi.string(), Joi.number()],
     birthyear: Joi.number().integer().min(1900).max(2013),
-    email: Joi.string().email()
+    email: Joi.string().email({ minDomainAtoms: 2 })
 }).with('username', 'birthyear').without('password', 'access_token');
 
 // Return result.
@@ -56,6 +56,7 @@ The above schema defines the following constraints:
     * an integer between 1900 and 2013
 * `email`
     * a valid email address string
+    * must have two domain parts e.g. `example.com`
 
 # Usage
 

package/lib/index.js

@@ -132,7 +132,7 @@ internals.root = function () {
             return any.validate(value, callback);
         }
 
-        const options = count === 2 ? args[1] : {};
+        const options = count === 2 ? args[1] : undefined;
         const schema = root.compile(args[0]);
 
         return schema._validateWithOptions(value, options, callback);

package/lib/language.js

@@ -147,6 +147,7 @@ exports.errors = {
         hex: 'must only contain hexadecimal characters',
         hexAlign: 'hex decoded representation must be byte aligned',
         base64: 'must be a valid base64 string',
+        dataUri: 'must be a valid dataUri string',
         hostname: 'must be a valid hostname',
         normalize: 'must be unicode normalized in the {{form}} form',
         lowercase: 'must only contain lowercase characters',

package/lib/types/alternatives/index.js

@@ -150,7 +150,7 @@ internals.Alternatives = class extends Any {
 
     describe() {
 
-        const description = Any.prototype.describe.call(this);
+        const description = super.describe();
         const alternatives = [];
         for (let i = 0; i < this._inner.matches.length; ++i) {
             const item = this._inner.matches[i];

package/lib/types/array/index.js

@@ -311,7 +311,7 @@ internals.Array = class extends Any {
 
     describe() {
 
-        const description = Any.prototype.describe.call(this);
+        const description = super.describe();
 
         if (this._inner.ordereds.length) {
             description.orderedItems = [];
@@ -477,13 +477,19 @@ internals.Array = class extends Any {
         });
     }
 
-    unique(comparator) {
+    unique(comparator, configs) {
 
         Hoek.assert(comparator === undefined ||
             typeof comparator === 'function' ||
             typeof comparator === 'string', 'comparator must be a function or a string');
 
-        const settings = {};
+        Hoek.assert(configs === undefined ||
+            typeof configs === 'object', 'configs must be an object');
+
+        const settings = {
+            ignoreUndefined: (configs && configs.ignoreUndefined) || false
+        };
+
 
         if (typeof comparator === 'string') {
             settings.path = comparator;
@@ -505,6 +511,7 @@ internals.Array = class extends Any {
             };
 
             const compare = settings.comparator || Hoek.deepEqual;
+            const ignoreUndefined = settings.ignoreUndefined;
 
             for (let i = 0; i < value.length; ++i) {
                 const item = settings.path ? Hoek.reach(value[i], settings.path) : value[i];
@@ -543,7 +550,7 @@ internals.Array = class extends Any {
                         records.set(item, i);
                     }
                     else {
-                        if (records[item] !== undefined) {
+                        if ((!ignoreUndefined || item !== undefined) && records[item] !== undefined) {
                             const localState = {
                                 key: state.key,
                                 path: state.path.concat(i),

package/lib/types/boolean/index.js

@@ -87,7 +87,7 @@ internals.Boolean = class extends Any {
 
     describe() {
 
-        const description = Any.prototype.describe.call(this);
+        const description = super.describe();
         description.truthy = [true].concat(this._inner.truthySet.values());
         description.falsy = [false].concat(this._inner.falsySet.values());
         return description;

package/lib/types/number/index.js

@@ -47,7 +47,7 @@ internals.Number = class extends Any {
             result.value = Math.round(result.value * precision) / precision;
         }
 
-        result.errors = isNumber ? null : this.createError('number.base', null, state, options);
+        result.errors = isNumber ? null : this.createError('number.base', { value }, state, options);
         return result;
     }
 

package/lib/types/object/index.js

@@ -615,7 +615,7 @@ internals.Object = class extends Any {
 
     describe(shallow) {
 
-        const description = Any.prototype.describe.call(this);
+        const description = super.describe();
 
         if (description.rules) {
             for (let i = 0; i < description.rules.length; ++i) {

package/lib/types/string/index.js

@@ -276,11 +276,15 @@ internals.String = class extends Any {
         let customScheme = '';
         let allowRelative = false;
         let relativeOnly = false;
+        let allowQuerySquareBrackets = false;
         let regex = internals.uriRegex;
 
         if (uriOptions) {
             Hoek.assert(typeof uriOptions === 'object', 'options must be an object');
 
+            const unknownOptions = Object.keys(uriOptions).filter((key) => !['scheme', 'allowRelative', 'relativeOnly', 'allowQuerySquareBrackets'].includes(key));
+            Hoek.assert(unknownOptions.length === 0, `options contain unknown keys: ${unknownOptions}`);
+
             if (uriOptions.scheme) {
                 Hoek.assert(uriOptions.scheme instanceof RegExp || typeof uriOptions.scheme === 'string' || Array.isArray(uriOptions.scheme), 'scheme must be a RegExp, String, or Array');
 
@@ -316,10 +320,14 @@ internals.String = class extends Any {
             if (uriOptions.relativeOnly) {
                 relativeOnly = true;
             }
+
+            if (uriOptions.allowQuerySquareBrackets) {
+                allowQuerySquareBrackets = true;
+            }
         }
 
-        if (customScheme || allowRelative || relativeOnly) {
-            regex = Uri.createUriRegex(customScheme, allowRelative, relativeOnly);
+        if (customScheme || allowRelative || relativeOnly || allowQuerySquareBrackets) {
+            regex = Uri.createUriRegex(customScheme, allowRelative, relativeOnly, allowQuerySquareBrackets);
         }
 
         return this._test('uri', uriOptions, function (value, state, options) {
@@ -460,6 +468,41 @@ internals.String = class extends Any {
         });
     }
 
+    dataUri(dataUriOptions = {}) {
+
+        const regex = /^data:[\w\/\+]+;((charset=[\w-]+|base64),)?(.*)$/;
+
+        // Determine if padding is required.
+        const paddingRequired = dataUriOptions.paddingRequired === false ?
+            dataUriOptions.paddingRequired
+            : dataUriOptions.paddingRequired || true;
+
+        const base64regex =  paddingRequired ?
+            /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/
+            : /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}(==)?|[A-Za-z0-9+\/]{3}=?)?$/;
+
+        return this._test('dataUri', regex, function (value, state, options) {
+
+            const matches = value.match(regex);
+
+            if (matches) {
+                if (!matches[2]) {
+                    return value;
+                }
+
+                if (matches[2] !== 'base64') {
+                    return value;
+                }
+
+                if (base64regex.test(matches[3])) {
+                    return value;
+                }
+            }
+
+            return this.createError('string.dataUri', { value }, state, options);
+        });
+    }
+
     hostname() {
 
         const regex = /^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$/;
@@ -529,20 +572,33 @@ internals.String = class extends Any {
         return obj;
     }
 
-    trim() {
+    trim(enabled = true) {
 
-        const obj = this._test('trim', undefined, function (value, state, options) {
+        Hoek.assert(typeof enabled === 'boolean', 'option must be a boolean');
 
-            if (options.convert ||
-                value === value.trim()) {
+        if ((this._flags.trim && enabled) || (!this._flags.trim && !enabled)) {
+            return this;
+        }
 
-                return value;
-            }
+        let obj;
+        if (enabled) {
+            obj = this._test('trim', undefined, function (value, state, options) {
 
-            return this.createError('string.trim', { value }, state, options);
-        });
+                if (options.convert ||
+                    value === value.trim()) {
+
+                    return value;
+                }
+
+                return this.createError('string.trim', { value }, state, options);
+            });
+        }
+        else {
+            obj = this.clone();
+            obj._tests = obj._tests.filter((test) => test.name !== 'trim');
+        }
 
-        obj._flags.trim = true;
+        obj._flags.trim = enabled;
         return obj;
     }
 

package/lib/types/string/rfc3986.js

@@ -78,6 +78,11 @@ internals.generate = function () {
     const pchar = unreserved + pctEncoded + subDelims + ':@';
     const pcharOnly = '[' + pchar + ']';
 
+    /**
+     * squareBrackets example: []
+     */
+    const squareBrackets = '\\[\\]';
+
     /**
      * dec-octet   = DIGIT                 ; 0-9
      *            / %x31-39 DIGIT         ; 10-99
@@ -197,6 +202,11 @@ internals.generate = function () {
      */
     internals.rfc3986.query = '[' + pchar + '\\/\\?]*(?=#|$)'; //Finish matching either at the fragment part or end of the line.
 
+    /**
+     * query = *( pchar / "[" / "]" / "/" / "?" )
+     */
+    internals.rfc3986.queryWithSquareBrackets = '[' + pchar + squareBrackets + '\\/\\?]*(?=#|$)'; //Finish matching either at the fragment part or end of the line.
+
     /**
      * fragment = *( pchar / "/" / "?" )
      */

package/lib/types/string/uri.js

@@ -9,7 +9,7 @@ const RFC3986 = require('./rfc3986');
 
 const internals = {
     Uri: {
-        createUriRegex: function (optionalScheme, allowRelative, relativeOnly) {
+        createUriRegex: function (optionalScheme, allowRelative, relativeOnly, allowQuerySquareBrackets) {
 
             let scheme = RFC3986.scheme;
             let prefix;
@@ -37,7 +37,7 @@ const internals = {
              *
              * relative-ref = relative-part [ "?" query ] [ "#" fragment ]
              */
-            return new RegExp('^' + prefix + '(?:\\?' + RFC3986.query + ')?' + '(?:#' + RFC3986.fragment + ')?$');
+            return new RegExp('^' + prefix + '(?:\\?' + (allowQuerySquareBrackets ? RFC3986.queryWithSquareBrackets : RFC3986.query) + ')?' + '(?:#' + RFC3986.fragment + ')?$');
         }
     }
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "joi",
   "description": "Object schema validation",
-  "version": "13.4.0",
+  "version": "13.6.0",
   "homepage": "https://github.com/hapijs/joi",
   "repository": "git://github.com/hapijs/joi",
   "main": "lib/index.js",