monastery 1.28.4 → 1.30.1

package/.eslintrc.json

@@ -1,12 +1,38 @@
 {
+  "env": {
+    "browser": true,
+    "es2021": true,
+    "node": true
+  },
+  "extends": [
+    "eslint:recommended"
+  ],
+  "globals": {
+    "test": true,
+    "expect": true
+  },
   "parserOptions": {
-    "ecmaVersion": 2018,
-    "sourceType": "module",
     "ecmaFeatures": {
       "jsx": true
-    }
+    },
+    "ecmaVersion": "latest",
+    "sourceType": "module"
   },
+  "plugins": [],
   "rules": {
-    //"quotes": ["error", "double"]
+    "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
+    "max-len": ["error", { "code": 120, "ignorePattern": "^\\s*<(rect|path|line)\\s" }],
+    "no-prototype-builtins": "off",
+    "no-unused-vars": ["error", { "args": "none" }],
+    "object-shorthand": ["error", "consistent"],
+    // "no-restricted-syntax": [
+    //   "error",
+    //   {
+    //     "selector": "ObjectPattern > Property[shorthand=false]",
+    //     "message": "Renaming properties within object deconstructions is not allowed."
+    //   }
+    // ],
+    "quotes": ["error", "single"],
+    "semi": ["error", "never"]
   }
 }

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/index.js

@@ -1,5 +1,4 @@
 let util = require('./util')
-let imagePlugin = require('./util')
 let monk = require('monk')
 let debug = require('debug')
 

package/lib/model-crud.js

@@ -9,7 +9,8 @@ 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 undefined subdocument required fields that have a defined parent/grandparent during update
+     *     @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
      *     @param {any} <opts.any> - any mongodb option
@@ -21,7 +22,9 @@ module.exports = {
     opts.insert = true
     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'])
+    let options = util.omit(opts, [
+      '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`)
     }
@@ -75,7 +78,7 @@ module.exports = {
       opts.one = one || opts.one
       // Operation options
       options = util.omit(opts, ['blacklist', 'one', 'populate', 'project', 'query', 'respond'])
-      options.sort = options.sort || { "createdAt": -1 }
+      options.sort = options.sort || { 'createdAt': -1 }
       options.skip = Math.max(0, options.skip || 0)
       options.limit = opts.one? 1 : parseInt(options.limit || this.manager.limit || 0)
       options.addFields = options.addFields || {}
@@ -99,8 +102,8 @@ module.exports = {
       }
       // Has text search?
       // if (opts.query.$text) {
-      //   options.projection.score = { $meta: "textScore" }
-      //   options.sort = { score: { $meta: "textScore" }}
+      //   options.projection.score = { $meta: 'textScore' }
+      //   options.sort = { score: { $meta: 'textScore' }}
       // }
       // Sort string passed
       if (util.isString(options.sort)) {
@@ -130,7 +133,7 @@ module.exports = {
               continue
             }
             // Populate model (convert array into document & create lookup)
-            options.addFields[path] = { "$arrayElemAt": [ "$" + path, 0 ] }
+            options.addFields[path] = { '$arrayElemAt': [ '$' + path, 0 ] }
             lookups.push({ $lookup: {
               from: modelName,
               localField: path,
@@ -191,7 +194,8 @@ 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 undefined subdocument required fields that have a defined parent/grandparent during update
+     *     @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
      *     @param {array|string|false} <opts.blacklist> - augment schema.updateBL, `false` will remove all blacklisting
@@ -211,8 +215,8 @@ 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.sort = options.sort || { "createdAt": -1 }
+      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
       if (util.isString(options.sort)) {
@@ -283,7 +287,7 @@ module.exports = {
       if (util.isEmpty(opts.query)) throw new Error('Please specify opts.query')
       // Operation options
       options = util.omit(opts, ['query', 'respond'])
-      options.sort = options.sort || { "createdAt": -1 }
+      options.sort = options.sort || { 'createdAt': -1 }
       options.limit = parseInt(options.limit || 1)
       // Sort string passed
       if (util.isString(options.sort)) {
@@ -397,7 +401,7 @@ module.exports = {
     let paths = (populate||[]).map(o => o && o.as? o.as : o)
 
     if (!paths.length) return blacklistProjection
-    this._recurseFields(model.fields, "", function(path, field) {
+    this._recurseFields(model.fields, '', function(path, field) {
       // Remove array indexes from the path e.g. '0.'
       path = path.replace(/(\.[0-9]+)(\.|$)/, '$2')
       if (!field.model || !paths.includes(path)) return
@@ -420,7 +424,8 @@ module.exports = {
     /**
      * Merge blacklist in
      * @param {object} blacklistProjection
-     * @param {array} paths - e.g. ['password', '-email'] - email will be whitelisted / removed from exlcusion projection
+     * @param {array} paths - e.g. ['password', '-email'] - email will be whitelisted / removed from
+     *   exlcusion projection
      * @return {object} exclusion blacklist
      * @this model
      */
@@ -461,7 +466,7 @@ module.exports = {
     let findWL = [ '_id', ...this.findWL ]
     let model = this.manager.model
 
-    this._recurseFields(this.fields, "", function(path, field) {
+    this._recurseFields(this.fields, '', function(path, field) {
       // Remove array indexes from the path e.g. '0.'
       path = path.replace(/(\.[0-9]+)(\.|$)/, '$2')
       //if (field.type == 'any') findWL.push(path) //exclude.push(path)
@@ -529,7 +534,7 @@ module.exports = {
     }
 
     for (let doc of util.toArray(data)) {
-      recurseAndDeleteData(doc, "")
+      recurseAndDeleteData(doc, '')
     }
     return data
   },
@@ -586,7 +591,11 @@ module.exports = {
         if (!data) return
 
         // Valid model object field.
-        if (((util.isArray(field) && field[0].model) || field.model) && data[fieldName] && (util.isObjectAndNotID(data[fieldName]))) {
+        if (
+            ((util.isArray(field) && field[0].model) || field.model) &&
+            data[fieldName] &&
+            util.isObjectAndNotID(data[fieldName])
+          ) {
           // Note that sometimes a single model is passed instead of an array of models via a custom populate $lookup
           out.push({
             dataRef: data[fieldName],
@@ -595,11 +604,18 @@ module.exports = {
           })
 
         // Recurse through fields that are sub-documents
-        } else if (util.isSubdocument(field) && util.isObjectAndNotID(data[fieldName])) {
+        } else if (
+            util.isSubdocument(field) &&
+            util.isObjectAndNotID(data[fieldName])
+          ) {
           out = [...out, ...this._recurseAndFindModels(field, data[fieldName])]
 
         // Array of sub-documents or models
-        } else if ((util.isArray(field) || field.model) && data[fieldName] && util.isObjectAndNotID(data[fieldName][0])) {
+        } else if (
+            (util.isArray(field) || field.model) &&
+            data[fieldName] &&
+            util.isObjectAndNotID(data[fieldName][0])
+          ) {
           // Valid model object found in array
           // Note that sometimes an array of models are passed instead of single object via a custom populate $lookup
           if (field.model || field[0].model) {

package/lib/model-validate.js

@@ -12,9 +12,11 @@ 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 subdocument required fields that have a defined parent/grandparent during update
+     *     @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 updated, depending on the `options.update` value
+     *     @param {boolean} timestamps - whether `createdAt` and `updatedAt` are inserted, or `updatedAt` is
+     *         updated, depending on the `options.update` value
      * @param {function} <cb> - instead of returning a promise
      * @this model
 
@@ -56,7 +58,7 @@ module.exports = {
           else continue
           if (whitelist.includes(split.join())) {
             blacklist.splice(i, 1)
-            break;
+            break
           }
         }
       }
@@ -175,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])
           }
@@ -189,11 +195,11 @@ module.exports = {
           errors.push(...(verrors = this._validateRules(dataRoot, schema, value, opts, path2)))
           // Data value is array too
           if (util.isArray(value)) {
-            var res = this._validateFields(dataRoot, field, value, opts, path2)
-            errors.push(...res[0])
+            var res2 = this._validateFields(dataRoot, field, value, opts, path2)
+            errors.push(...res2[0])
           }
           if (util.isDefined(value) && !verrors.length) {
-            data2[indexOrFieldName] = res? res[1] : value
+            data2[indexOrFieldName] = res2? res2[1] : value
           }
         }
       }, this)
@@ -211,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
      */
@@ -234,44 +241,38 @@ module.exports = {
         for (let i=0, l=skippedFieldChunks.length; i<l; i++) {
           if (skippedFieldChunks[i] == '$') skippedFieldChunks[i] = '[0-9]+'
         }
-        if (path.match(new RegExp('^' + skippedFieldChunks.join('.') + '(\.|$)'))) return []
+        if (path.match(new RegExp('^' + skippedFieldChunks.join('.') + '(.|$)'))) return []
       }
     }
 
     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 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)
@@ -203,7 +204,12 @@ Model.prototype._setupFields = function(fields) {
       let nullObject = this.manager.nullObjects
       let virtual = field.length == 1 && (field[0]||{}).virtual ? true : undefined
       field.schema = {
-        type: 'array', isArray: true, default: arrayDefault, nullObject: nullObject, virtual: virtual, ...(field.schema || {})
+        type: 'array',
+        isArray: true,
+        default: arrayDefault,
+        nullObject: nullObject,
+        virtual: virtual,
+        ...(field.schema || {})
       }
       this._setupFields(field)
 
@@ -236,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>
@@ -262,7 +267,10 @@ Model.prototype._setupIndexes = function(fields) {
 
   // No db defined
   if (!(model.manager._state || '').match(/^open/)) {
-    let error = { type: 'info', detail: `Skipping createIndex on the '${model.name}' model, no mongodb connection found.` }
+    let error = {
+      type: 'info',
+      detail: `Skipping createIndex on the '${model.name}' model, no mongodb connection found.`
+    }
     return Promise.reject(error)
   }
 
@@ -270,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
@@ -322,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 + '.')
       }
     })
   }
@@ -361,10 +372,10 @@ Model.prototype._timestampFields = {
   }
 }
 
-for (var key in crud) {
+for (let key in crud) {
   Model.prototype[key] = crud[key]
 }
 
-for (var key in validate) {
+for (let key in validate) {
   Model.prototype[key] = validate[key]
 }