monastery 1.28.5 → 1.30.2

package/docs/readme.md

@@ -1,6 +1,6 @@
 ![](./assets/imgs/monastery.jpg)
 
-[![NPM](https://img.shields.io/npm/v/monastery.svg)](https://www.npmjs.com/package/monastery) [![Build Status](https://travis-ci.com/boycce/monastery.svg?branch=master)](https://travis-ci.com/boycce/monastery)
+[![NPM](https://img.shields.io/npm/v/monastery.svg)](https://www.npmjs.com/package/monastery) [![Build Status](https://travis-ci.com/boycce/monastery.svg?branch=master)](https://app.travis-ci.com/github/boycce/monastery)
 
 ## Features
 

package/lib/model-crud.js

@@ -9,7 +9,7 @@ module.exports = {
      *     @param {object|array} <opts.data> - documents to insert
      *     @param {array|string|false} <opts.blacklist> - augment schema.insertBL, `false` will remove all blacklisting
      *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
-     *     @param {array|string|true} ignoreUndefined - ignore all required fields during insert, or
+     *     @param {array|string|false} validateUndefined - ignore all required fields during insert, or
      *         undefined subdocument required fields that have a defined parent/grandparent during update
      *     @param {array|string|true} <opts.skipValidation> - skip validation for this field name(s)
      *     @param {boolean} <opts.timestamps> - whether `createdAt` and `updatedAt` are automatically inserted
@@ -23,7 +23,7 @@ module.exports = {
     opts.model = this
     let data = opts.data = opts.data || (opts.req? opts.req.body : {})
     let options = util.omit(opts, [
-      'data', 'insert', 'model', 'respond', 'ignoreUndefined', 'skipValidation', 'blacklist'
+      'data', 'insert', 'model', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'
     ])
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.insert() is not a function`)
@@ -194,7 +194,7 @@ module.exports = {
      *     @param {object} <opts.query> - mongodb query object
      *     @param {object|array} <opts.data> - mongodb document update object(s)
      *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
-     *     @param {array|string|true} ignoreUndefined - ignore all required fields during insert, or
+     *     @param {array|string|false} validateUndefined - ignore all required fields during insert, or
      *         undefined subdocument required fields that have a defined parent/grandparent during update
      *     @param {array|string|true} <opts.skipValidation> - skip validation for this field name(s)
      *     @param {boolean} <opts.timestamps> - whether `updatedAt` is automatically updated
@@ -215,7 +215,7 @@ module.exports = {
       data = opts.data = opts.data || (opts.req? opts.req.body : null)
       operators = util.pluck(opts, [/^\$/])
       // Operation options
-      options = util.omit(opts, ['data', 'query', 'respond', 'ignoreUndefined', 'skipValidation', 'blacklist'])
+      options = util.omit(opts, ['data', 'query', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'])
       options.sort = options.sort || { 'createdAt': -1 }
       options.limit = parseInt(options.limit || 0)
       // Sort string passed

package/lib/model-validate.js

@@ -12,7 +12,7 @@ module.exports = {
      *     @param {boolean(false)} update - are we validating for insert or update?
      *     @param {array|string|false} blacklist - augment schema blacklist, `false` will remove all blacklisting
      *     @param {array|string} projection - only return these fields, ignores blacklist
-     *     @param {array|string|true} ignoreUndefined - ignore all required fields during insert, or undefined
+     *     @param {array|string|false} validateUndefined - ignore all required fields during insert, or undefined
      *         subdocument required fields that have a defined parent/grandparent during update
      *     @param {array|string|true} skipValidation - skip validation on these fields
      *     @param {boolean} timestamps - whether `createdAt` and `updatedAt` are inserted, or `updatedAt` is
@@ -177,7 +177,11 @@ module.exports = {
           // Object schema errors
           errors.push(...(verrors = this._validateRules(dataRoot, schema, value, opts, path2)))
           // Recurse if data value is a subdocument, or when inserting, or when updating deep properties (non-root)
-          if (util.isObject(value) || opts.insert || ((path2||'').match(/\./) && !opts.ignoreUndefined)) {
+          if (
+            util.isObject(value) ||
+            opts.insert ||
+            ((path2||'').match(/\./) && (util.isDefined(opts.validateUndefined) ? opts.validateUndefined : true))
+          ) {
             var res = this._validateFields(dataRoot, field, value, opts, path2)
             errors.push(...res[0])
           }
@@ -213,6 +217,7 @@ module.exports = {
      * @param {object} dataRoot - data
      * @param {object} field - field schema
      * @param {string} path - full field path
+     * @param {object} opts - original validate() options
      * @this model
      * @return {array} errors
      */
@@ -242,38 +247,32 @@ module.exports = {
 
     for (let ruleName in field) {
       if (this._ignoredRules.indexOf(ruleName) > -1) continue
-      // ignore undefined updated root properties, or
-      if (util.isUndefined(value) && ((opts.update && !path.match(/\./)) || opts.ignoreUndefined)) continue
-      let error = this._validateRule(dataRoot, ruleName, field, field[ruleName], value, path)
+      let error = this._validateRule(dataRoot, ruleName, field, field[ruleName], value, opts, path)
       if (error && ruleName == 'required') return [error] // only show the required error
       if (error) errors.push(error)
     }
     return errors
   },
 
-  _validateRule: function(dataRoot, ruleName, field, ruleArg, value, path) {
-    //this.debug(path, field, ruleName, ruleArg, value)
+  _validateRule: function(dataRoot, ruleName, field, ruleArg, value, opts, path) {
+    // this.debug(path, field, ruleName, ruleArg, value)
     // Remove [] from the message path, and simply ignore non-numeric children to test for all array items
     ruleArg = ruleArg === true? undefined : ruleArg
     let rule = this.rules[ruleName] || rules[ruleName]
     let fieldName = path.match(/[^.]+$/)[0]
     let ruleMessageKey = this._getMostSpecificKeyMatchingPath(this.messages, path)
     let ruleMessage = ruleMessageKey && this.messages[ruleMessageKey][ruleName]
+    let validateUndefined = util.isDefined(opts.validateUndefined) ? opts.validateUndefined : rule.validateUndefined
     if (!ruleMessage) ruleMessage = rule.message
 
-    if (ruleName !== 'required') {
-      // Ignore undefined when not testing 'required'
-      if (typeof value === 'undefined') return
+    // Ignore undefined (if updated root property, or ignoring)
+    if ((!validateUndefined || (opts.update && !path.match(/\./))) && typeof value === 'undefined') return
 
-      // Ignore null if not testing required
-      if (value === null && !field.isObject && !field.isArray) return
-
-      // Ignore null if nullObject is set on objects or arrays
-      if (value === null && field.nullObject) return
-    }
+    // Ignore null (if nullObject is set on objects or arrays) (todo: change to ignoreNull)
+    if (field.nullObject && (field.isObject || field.isArray) && value === null) return
 
     // Ignore empty strings
-    if (value === '' && rule.ignoreEmptyString) return
+    if (!rule.validateEmptyString && value === '') return
 
     // Rule failed
     if (!rule.fn.call(dataRoot, value, ruleArg, path, this)) return {

package/lib/model.js

@@ -61,6 +61,7 @@ let Model = module.exports = function(name, opts, manager) {
       // Update with formatted rule
       let formattedRule = util.isObject(rule)? rule : { fn: rule }
       if (!formattedRule.message) formattedRule.message = `Invalid data property for rule "${ruleName}".`
+      if (typeof formattedRule.validateEmptyString == 'undefined') formattedRule.validateEmptyString = true
       this.rules[ruleName] = formattedRule
     }
   }, this)
@@ -241,11 +242,10 @@ Model.prototype._setupFieldsAndWhitelists = function(fields, path) {
   this.findBLProject = this.findBL.reduce((o, v) => { (o[v] = 0); return o }, {})
 },
 
-Model.prototype._setupIndexes = function(fields) {
+Model.prototype._setupIndexes = function(fields, opts={}) {
   /**
-   * Creates indexes for the model
+   * Creates indexes for the model (multikey, and sub-document supported)
    * Note: only one text index per model(collection) is allowed due to mongodb limitations
-   * Note: we and currently don't support indexes on sub-collections, but sub-documents yes!
    * @link https://docs.mongodb.com/manual/reference/command/createIndexes/
    * @link https://mongodb.github.io/node-mongodb-native/2.1/api/Collection.html#createIndexes
    * @param {object} <fields>
@@ -278,6 +278,7 @@ Model.prototype._setupIndexes = function(fields) {
   recurseFields(fields || model.fields, '')
   // console.log(2, indexes, fields)
   if (hasTextIndex) indexes.push(textIndex)
+  if (opts.dryRun) return Promise.resolve(indexes || [])
   if (!indexes.length) return Promise.resolve([]) // No indexes defined
 
   // Create indexes
@@ -330,22 +331,24 @@ Model.prototype._setupIndexes = function(fields) {
     util.forEach(fields, (field, name) => {
       let index = field.index
       if (index) {
-        let path = name == 'schema'? parentPath.slice(0, -1) : parentPath + name
         let options = util.isObject(index)? util.omit(index, ['type']) : {}
         let type = util.isObject(index)? index.type : index
+        let path = name == 'schema'? parentPath.slice(0, -1) : parentPath + name
+        let path2 = path.replace(/(^|\.)[0-9]+(\.|$)/g, '$2') // no numirical keys, e.g. pets.1.name
         if (type === true) type = 1
-
         if (type == 'text') {
-          hasTextIndex = textIndex.key[path] = 'text'
+          hasTextIndex = textIndex.key[path2] = 'text'
           Object.assign(textIndex, options)
         } else if (type == '1' || type == '-1' || type == '2dsphere') {
-          indexes.push({ name: `${path}_${type}`, key: { [path]: type }, ...options })
+          indexes.push({ name: `${path2}_${type}`, key: { [path2]: type }, ...options })
         } else if (type == 'unique') {
-          indexes.push({ name: `${path}_1`, key: { [path]: 1 }, unique: true, ...options  })
+          indexes.push({ name: `${path2}_1`, key: { [path2]: 1 }, unique: true, ...options  })
         }
       }
       if (util.isSubdocument(field)) {
         recurseFields(field, parentPath + name + '.')
+      } else if (util.isArray(field)) {
+        recurseFields(field, parentPath + name + '.')
       }
     })
   }

package/lib/rules.js

@@ -5,6 +5,8 @@ let validator = require('validator')
 module.exports = {
 
   required: {
+    validateUndefined: true,
+    validateEmptyString: true,
     message: 'This field is required.',
     fn: function(x) {
       if (util.isArray(x) && !x.length) return false
@@ -12,9 +14,10 @@ module.exports = {
     }
   },
 
-  // Rules below ignore null
+  // Type rules below ignore undefined (default for custom model rules)
 
   'isBoolean': {
+    validateEmptyString: true,
     message: 'Value was not a boolean.',
     tryParse: function(x) {
       if (typeof x === 'string' && x === 'true') return true
@@ -25,13 +28,8 @@ module.exports = {
       return typeof x === 'boolean'
     }
   },
-  'isNotEmptyString': {
-    message: 'Value was an empty string.',
-    fn: function(x) {
-      return x !== ''
-    }
-  },
   'isArray': {
+    validateEmptyString: true,
     message: 'Value was not an array.',
     tryParse: function(x) {
       if (x === '') return null
@@ -44,6 +42,7 @@ module.exports = {
     }
   },
   'isDate': {
+    validateEmptyString: true,
     message: 'Value was not a unix timestamp.',
     tryParse: function(x) {
       if (util.isString(x) && x.match(/^[+-]?[0-9]+$/)) return x // keep string nums intact
@@ -55,6 +54,7 @@ module.exports = {
     }
   },
   'isImageObject': {
+    validateEmptyString: true,
     message: 'Invalid image value',
     messageLong: 'Image fields need to either be null, undefined, file, or an object containing the following '
       + 'fields \'{ bucket, date, filename, filesize, path, uid }\'',
@@ -70,6 +70,7 @@ module.exports = {
     }
   },
   'isInteger': {
+    validateEmptyString: true,
     message: 'Value was not an integer.',
     tryParse: function(x) {
       if (util.isString(x) && x.match(/^[+-][0-9]+$/)) return x // keep string nums intact
@@ -81,6 +82,7 @@ module.exports = {
     }
   },
   'isNumber': {
+    validateEmptyString: true,
     message: 'Value was not a number.',
     tryParse: function(x) {
       if (util.isString(x) && x.match(/^[+-][0-9]+$/)) return x // keep string nums intact
@@ -92,6 +94,7 @@ module.exports = {
     }
   },
   'isObject': {
+    validateEmptyString: true,
     message: 'Value was not an object.',
     tryParse: function(x) {
       if (x === '') return null
@@ -104,18 +107,21 @@ module.exports = {
     }
   },
   'isString': {
+    validateEmptyString: true,
     message: 'Value was not a string.',
     fn: function(x) {
       return typeof x === 'string'
     }
   },
   'isAny': {
+    validateEmptyString: true,
     message: '',
     fn: function(x) {
       return true
     }
   },
   'isId': {
+    validateEmptyString: true,
     message: 'Value was not a valid ObjectId.',
     tryParse: function(x) {
       // Try and parse value to a mongodb ObjectId
@@ -130,6 +136,7 @@ module.exports = {
     }
   },
   'max': {
+    validateEmptyString: true,
     message: (x, arg) => 'Value was greater than the configured maximum (' + arg + ')',
     fn: function(x, arg) {
       if (typeof x !== 'number') { throw new Error ('Value was not a number.') }
@@ -137,16 +144,25 @@ module.exports = {
     }
   },
   'min': {
+    validateEmptyString: true,
     message: (x, arg) => 'Value was less than the configured minimum (' + arg + ')',
     fn: function(x, arg) {
       if (typeof x !== 'number') { throw new Error ('Value was not a number.') }
       return x >= arg
     }
   },
+  'isNotEmptyString': {
+    validateEmptyString: true,
+    message: 'Value was an empty string.',
+    fn: function(x) {
+      return x !== ''
+    }
+  },
+
+  // Rules below ignore undefined, & empty strings
+  // (e.g. an empty email field can be saved that isn't required)
 
-  // Rules below ignore null & empty strings
   'enum': {
-    ignoreEmptyString: true,
     message: (x, arg) => 'Invalid enum value',
     fn: function(x, arg) {
       for (let item of arg) {
@@ -154,62 +170,51 @@ module.exports = {
       }
     }
   },
-  'hasAgreed': {
-    message: (x, arg) => 'Please agree to the terms and conditions.',
-    fn: function(x, arg) { return !x }
-  },
+  // 'hasAgreed': {
+  //   message: (x, arg) => 'Please agree to the terms and conditions.',
+  //   fn: function(x, arg) { return !x }
+  // },
   'isAfter': {
-    ignoreEmptyString: true,
     message: (x, arg) => 'Value was before the configured time (' + arg + ')',
     fn: function(x, arg) { return validator.isAfter(x, arg) }
   },
   'isBefore': {
-    ignoreEmptyString: true,
     message: (x, arg) => 'Value was after the configured time (' + arg + ')',
     fn: function(x, arg) { return validator.isBefore(x, arg) }
   },
   'isCreditCard': {
-    ignoreEmptyString: true,
     message: 'Value was not a valid credit card.',
     fn: function(x, arg) { return validator.isCreditCard(x, arg) }
   },
   'isEmail': {
-    ignoreEmptyString: true,
     message: 'Please enter a valid email address.',
     fn: function(x, arg) { return validator.isEmail(x, arg) }
   },
   'isHexColor': {
-    ignoreEmptyString: true,
     message: 'Value was not a valid hex color.',
     fn: function(x, arg) { return validator.isHexColor(x, arg) }
   },
   'isIn': {
-    ignoreEmptyString: true,
     message: (x, arg) => 'Value was not in the configured whitelist (' + arg.join(', ') + ')',
     fn: function(x, arg) { return validator.isIn(x, arg) }
   },
   'isIP': {
-    ignoreEmptyString: true,
     message: 'Value was not a valid IP address.',
     fn: function(x, arg) { return validator.isIP(x, arg) }
   },
   'isNotIn': {
-    ignoreEmptyString: true,
     message: (x, arg) => 'Value was in the configured blacklist (' + arg.join(', ') + ')',
     fn: function(x, arg) { return !validator.isIn(x, arg) }
   },
   'isURL': {
-    ignoreEmptyString: true,
     message: 'Value was not a valid URL.',
     fn: function(x, arg) { return validator.isURL(x, arg === true? undefined : arg) }
   },
   'isUUID': {
-    ignoreEmptyString: true,
     message: 'Value was not a valid UUID.',
     fn: function(x, arg) { return validator.isUUID(x) }
   },
   'minLength': {
-    ignoreEmptyString: true,
     message: function(x, arg) {
       if (typeof x === 'string') return 'Value needs to be at least ' + arg + ' characters long.'
       else return 'Value needs to contain a minimum of ' + arg + ' items.'
@@ -221,7 +226,6 @@ module.exports = {
     }
   },
   'maxLength': {
-    ignoreEmptyString: true,
     message: function(x, arg) {
       if (typeof x === 'string') return 'Value was longer than the configured maximum length (' + arg + ')'
       else return 'Value cannot contain more than ' + arg + ' items.'
@@ -233,7 +237,6 @@ module.exports = {
     }
   },
   'regex': {
-    ignoreEmptyString: true,
     message: (x, arg) => 'Value did not match the configured regular expression (' + arg + ')',
     fn: function(x, arg) {
       if (util.isRegex(arg)) return validator.matches(x, arg)

package/lib/util.js

@@ -300,7 +300,7 @@ module.exports = {
      * @param {boolean} ignoreEmptyArrays -  ignore empty arrays
      * @return obj
      */
-    let chunks = path.split('.') //  ['pets', '$', 'dog']
+    let chunks = path.split('.') //  ['pets', '$|0-9', 'dog']
     let target = obj
     for (let i=0, l=chunks.length; i<l; i++) {
       if (l === i+1) { // Last

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.28.5",
+  "version": "1.30.2",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",