monastery 1.28.4 → 1.28.5

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/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|true} ignoreUndefined - 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', 'ignoreUndefined', '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|true} ignoreUndefined - 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
@@ -212,7 +216,7 @@ module.exports = {
       operators = util.pluck(opts, [/^\$/])
       // Operation options
       options = util.omit(opts, ['data', 'query', 'respond', 'ignoreUndefined', 'skipValidation', 'blacklist'])
-      options.sort = options.sort || { "createdAt": -1 }
+      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|true} ignoreUndefined - 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
           }
         }
       }
@@ -189,11 +191,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)
@@ -234,7 +236,7 @@ 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 []
       }
     }
 
@@ -254,7 +256,7 @@ module.exports = {
     // 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]
     if (!ruleMessage) ruleMessage = rule.message

package/lib/model.js

@@ -203,7 +203,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)
 
@@ -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)
   }
 
@@ -361,10 +369,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]
 }

package/lib/rules.js

@@ -36,8 +36,7 @@ module.exports = {
     tryParse: function(x) {
       if (x === '') return null
       if (!util.isString(x)) return x
-      try { var parsed = JSON.parse(x) }
-      catch (e) { return x }
+      try { var parsed = JSON.parse(x) } catch (e) { return x }
       return Array.isArray(parsed)? parsed : x
     },
     fn: function(x) {
@@ -47,11 +46,11 @@ module.exports = {
   'isDate': {
     message: 'Value was not a unix timestamp.',
     tryParse: function(x) {
-      if (util.isString(x) && x.match(/^[\+-]?[0-9]+$/)) return x // keep string nums intact
+      if (util.isString(x) && x.match(/^[+-]?[0-9]+$/)) return x // keep string nums intact
       return isNaN(parseInt(x))? x : parseInt(x)
     },
     fn: function(x) {
-      if (util.isString(x) && x.match(/^[\+-]?[0-9]+$/)) return true
+      if (util.isString(x) && x.match(/^[+-]?[0-9]+$/)) return true
       return typeof x === 'number' && (parseInt(x) === x)
     }
   },
@@ -62,8 +61,7 @@ module.exports = {
     tryParse: function(x) {
       if (x === '') return null
       if (!util.isString(x)) return x
-      try { var parsed = JSON.parse(x) }
-      catch (e) { return x }
+      try { var parsed = JSON.parse(x) } catch (e) { return x }
       return parsed !== null && typeof parsed === 'object' && !(parsed instanceof Array)? parsed : x
     },
     fn: function(x) {
@@ -74,22 +72,22 @@ module.exports = {
   'isInteger': {
     message: 'Value was not an integer.',
     tryParse: function(x) {
-      if (util.isString(x) && x.match(/^[\+-][0-9]+$/)) return x // keep string nums intact
+      if (util.isString(x) && x.match(/^[+-][0-9]+$/)) return x // keep string nums intact
       return isNaN(parseInt(x)) || (!x && x!==0) || x===true? x : parseInt(x)
     },
     fn: function(x) {
-      if (util.isString(x) && x.match(/^[\+-]?[0-9]+$/)) return true
+      if (util.isString(x) && x.match(/^[+-]?[0-9]+$/)) return true
       return typeof x === 'number' && (parseInt(x) === x)
     }
   },
   'isNumber': {
     message: 'Value was not a number.',
     tryParse: function(x) {
-      if (util.isString(x) && x.match(/^[\+-][0-9]+$/)) return x // keep string nums intact
+      if (util.isString(x) && x.match(/^[+-][0-9]+$/)) return x // keep string nums intact
       return isNaN(Number(x)) || (!x && x!==0) || x===true? x : Number(x)
     },
     fn: function(x) {
-      if (util.isString(x) && x.match(/^[\+-][0-9]+$/)) return true
+      if (util.isString(x) && x.match(/^[+-][0-9]+$/)) return true
       return typeof x === 'number'
     }
   },
@@ -98,8 +96,7 @@ module.exports = {
     tryParse: function(x) {
       if (x === '') return null
       if (!util.isString(x)) return x
-      try { var parsed = JSON.parse(x) }
-      catch (e) { return x }
+      try { var parsed = JSON.parse(x) } catch (e) { return x }
       return parsed !== null && typeof parsed === 'object' && !(parsed instanceof Array)? parsed : x
     },
     fn: function(x) {

package/lib/util.js

@@ -9,7 +9,7 @@ module.exports = {
     for (let key in obj) {
       let v = obj[key]
       if (this.isId(v)) obj2[key] = v.toString()
-      else obj2[key] = (typeof v === "object")? this.deepCopy(v) : v
+      else obj2[key] = (typeof v === 'object')? this.deepCopy(v) : v
     }
     return obj2
   },
@@ -165,7 +165,7 @@ module.exports = {
      * @param {object}
      */
     for (let key in obj) {
-      if (key.indexOf(".") !== -1) recurse(key, obj[key], obj)
+      if (key.indexOf('.') !== -1) recurse(key, obj[key], obj)
     }
     return obj
     function recurse(str, val, obj) {
@@ -199,8 +199,12 @@ module.exports = {
      */
     return new Promise(res => {
       for (let key in obj) {
-        if (key.match(/\[\]\[/i)) throw `Array items in bracket notation need array indexes "${key}", e.g. users[0][name]`
-        if (key.indexOf("[") !== -1) setup(key)
+        if (key.match(/\[\]\[/i)) {
+          throw `Array items in bracket notation need array indexes "${key}", e.g. users[0][name]`
+        }
+        if (key.indexOf('[') !== -1) {
+          setup(key)
+        }
       }
       res(obj)
     })
@@ -241,7 +245,7 @@ module.exports = {
   removeUndefined: (variable) => {
     // takes an array or object
     if (Array.isArray(variable)) {
-      for (let l=variable.length; i--;) {
+      for (let i=variable.length; i--;) {
         if (variable[i] === undefined) variable.splice(i, 1)
       }
     } else {
@@ -308,7 +312,7 @@ module.exports = {
           target[chunks[i]] = value
         }
       } else {
-        let isArray = chunks[i+1].match(/^[0-9\$]+$/)
+        let isArray = chunks[i+1].match(/^[0-9$]+$/)
         let parentCopy = target[chunks[i]] || (isArray? [] : {})
         if (ignoreEmptyArrays && isArray && !parentCopy.length) break
         target = target[chunks[i]] = parentCopy
@@ -316,7 +320,9 @@ module.exports = {
         if (chunks[i+1] == '$') {
           for (let m=0, n=target.length; m<n; m++) {
             let newPath = chunks.slice(i+2).join('.')
-            if (newPath) this.setDeepValue(target[m], newPath, value, onlyUndefined, onlyUndefinedNull, ignoreEmptyArrays)
+            if (newPath) {
+              this.setDeepValue(target[m], newPath, value, onlyUndefined, onlyUndefinedNull, ignoreEmptyArrays)
+            }
           }
           break
         }

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.28.4",
+  "version": "1.28.5",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -19,27 +19,28 @@
   "scripts": {
     "minor": "standard-version --release-as minor && npm publish",
     "patch": "standard-version && npm publish",
-    "test": "jest",
+    "test": "npm run lint && jest",
     "test-one-example": "jest -t images",
-    "dev": "DEBUG=-monastery:info jest --watchAll --runInBand --verbose=false",
+    "dev": "npm run lint & DEBUG=-monastery:info jest --watchAll --runInBand --verbose=false",
+    "lint": "eslint ./lib ./plugins ./test",
     "docs": "cd docs && bundle exec jekyll serve --livereload --livereload-port 4001"
   },
   "dependencies": {
-    "aws-sdk": "^2.742.0",
+    "aws-sdk": "2.1062.0",
     "debug": "4.1.1",
-    "file-type": "^15.0.0",
-    "monk": "^7.3.0",
-    "nanoid": "^3.1.12",
-    "validator": "^13.0.0"
+    "file-type": "15.0.0",
+    "monk": "7.3.4",
+    "nanoid": "3.2.0",
+    "validator": "13.7.0"
   },
   "devDependencies": {
-    "body-parser": "^1.19.0",
-    "eslint": "^6.8.0",
-    "express": "^4.17.1",
-    "express-fileupload": "^1.2.0",
-    "jest": "^25.3.0",
-    "standard-version": "^7.1.0",
-    "supertest": "^4.0.2"
+    "body-parser": "1.19.0",
+    "eslint": "8.7.0",
+    "express": "4.17.1",
+    "express-fileupload": "1.2.0",
+    "jest": "27.4.7",
+    "standard-version": "9.3.2",
+    "supertest": "4.0.2"
   },
   "standard-version": {
     "releaseCommitMessageFormat": "{{currentTag}}",

package/plugins/images/index.js

@@ -155,8 +155,8 @@ let plugin = module.exports = {
       if (test) return [prunedData]
       return model._update(
         idquery,
-        { "$set": prunedData },
-        { "multi": options.multi || options.create }
+        { '$set': prunedData },
+        { 'multi': options.multi || options.create }
       )
 
     // If errors, remove inserted documents to prevent double ups when the user resaves.
@@ -246,7 +246,7 @@ let plugin = module.exports = {
         // pre-existing image, push to unused
         return plugin._findValidImages(options.files || {}, options.model).then(files => {
           for (let filesArray of files) {
-            if (pre = preExistingImages.find(o => o.dataPath == filesArray.inputPath)) {
+            if ((pre = preExistingImages.find(o => o.dataPath == filesArray.inputPath))) {
               useCount[pre.image.uid]--
             }
           }
@@ -380,7 +380,7 @@ let plugin = module.exports = {
     let list = []
     util.forEach(fields, (field, fieldName) => {
       let path2 = `${path}.${fieldName}`.replace(/^\./, '')
-      let schema = field.schema || {}
+      // let schema = field.schema || {}
 
       // Subdocument field
       if (util.isSubdocument(field)) {//schema.isObject

package/test/blacklisting.js

@@ -1,6 +1,6 @@
 module.exports = function(monastery, opendb) {
 
-  test('Find blacklisting', async (done) => {
+  test('Find blacklisting', async () => {
     // Setup
     let db = (await opendb(null)).db
     let bird = db.model('bird', {
@@ -150,10 +150,9 @@ module.exports = function(monastery, opendb) {
     })
 
     db.close()
-    done()
   })
 
-  test('Find blacklisting (default fields)', async (done) => {
+  test('Find blacklisting (default fields)', async () => {
     // Setup
     let db = (await opendb(null)).db
     let user = db.model('user', {
@@ -222,10 +221,9 @@ module.exports = function(monastery, opendb) {
     })
 
     db.close()
-    done()
   })
 
-  test('Find blacklisting (populate)', async (done) => {
+  test('Find blacklisting (populate)', async () => {
     // Setup
     let db = (await opendb(null)).db
     let bird = db.model('bird', {
@@ -305,10 +303,9 @@ module.exports = function(monastery, opendb) {
     })
 
     db.close()
-    done()
   })
 
-  test('Insert/update blacklisting (validate)', async (done) => {
+  test('Insert/update blacklisting (validate)', async () => {
     // Setup
     let db = (await opendb(null)).db
     let user = db.model('user', {
@@ -406,7 +403,6 @@ module.exports = function(monastery, opendb) {
       }
     })
     db.close()
-    done()
   })
 
 }