monastery 1.31.3 → 1.31.7

package/changelog.md

@@ -0,0 +1,46 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+### [1.31.7](https://github.com/boycce/monastery/compare/1.31.6...1.31.7) (2022-02-28)
+
+
+### Bug Fixes
+
+* refactored crud ops ([e7f3f78](https://github.com/boycce/monastery/commit/e7f3f784e123e4a66586a4d9e733d5cac477b98b))
+
+### [1.31.6](https://github.com/boycce/monastery/compare/1.31.5...1.31.6) (2022-02-25)
+
+
+### Bug Fixes
+
+* added partial unqiue index tests ([ff6f193](https://github.com/boycce/monastery/commit/ff6f1938e333407ee17895873d2b42fa5263d7e3))
+* scripts ([bc32680](https://github.com/boycce/monastery/commit/bc326809098ae24686158a0386fbbd6671d86c98))
+
+### [1.31.5](https://github.com/boycce/monastery/compare/1.31.4...1.31.5) (2022-02-15)
+
+
+### Bug Fixes
+
+* scripts ([417ba13](https://github.com/boycce/monastery/commit/417ba13c1a0862f76fadf97d6d6d063a74e196bd))
+
+### 1.31.4 (2022-02-15)
+
+
+### Bug Fixes
+
+* _callAfterFind bug ([e62472c](https://github.com/boycce/monastery/commit/e62472c191119135839b6d9e42b7f060bc7a508d))
+* .eslintrc.json ([5362585](https://github.com/boycce/monastery/commit/53625857bbf798db97eddad9385799cb1ded97e2))
+* docs ([d8f4e15](https://github.com/boycce/monastery/commit/d8f4e15913f672295cc118fda11ec23a412b4c62))
+* docs ([1a5118e](https://github.com/boycce/monastery/commit/1a5118e4b389b55d30bf987991b59638b11613a9))
+* docs ([564572c](https://github.com/boycce/monastery/commit/564572ce33dfb35fdd131e81d1dcc655f024b26e))
+* docs ([12d37d3](https://github.com/boycce/monastery/commit/12d37d3b2d0b5ec577f9ed4deb9c929c8ea52a36))
+* docs and nav links ([0eabcf0](https://github.com/boycce/monastery/commit/0eabcf0cd9a119a6ab1a07b92634e316995a2a83))
+* model-crud ([d421709](https://github.com/boycce/monastery/commit/d421709a70e6611c78e049e98268153c9bafae6d))
+* normalise afterFind ([0ab7f43](https://github.com/boycce/monastery/commit/0ab7f43f25b599e07d9ae751dc3bac8550e53c24))
+* normalised rule arguments and context ([6ba48da](https://github.com/boycce/monastery/commit/6ba48da3b9c643620cebf5442e60bd0318d6780f))
+* package scripts ([f7935af](https://github.com/boycce/monastery/commit/f7935afb0181ddb3e397bf804b34c841589dfcf0))
+* semver ([6f14909](https://github.com/boycce/monastery/commit/6f14909f4405cf26dc04a8603cc3bac232b96798))
+* standard-version ([4627694](https://github.com/boycce/monastery/commit/46276948f76b22eae946147f488c7e734a88c023))
+* standard-version ([f553b08](https://github.com/boycce/monastery/commit/f553b08445eb7dd2e85f6bb447e2bb0bc38dda34))
+* util bug, updated tests ([bec1887](https://github.com/boycce/monastery/commit/bec1887f56cb8582b606a066c913c191362a61b0))

package/docs/Gemfile

@@ -1,10 +1,4 @@
-# Old
-# source 'https://rubygems.org'
-# gem 'github-pages', group: :jekyll_plugins
-
-# Below pulls the latest remote_theme in development
 source 'https://rubygems.org'
-gem "github-docs", git: "https://github.com/boycce/github-docs"
-group :jekyll_plugins do
-  gem "jekyll-remote-theme", "~> 0.4.2"
-end
+
+# Development (strict gem versions used)
+gem 'github-pages', group: :jekyll_plugins

package/docs/_config.yml

@@ -2,6 +2,7 @@ remote_theme: boycce/github-docs
 title: Monastery
 description: A straight forward MongoDB ODM built upon MonkJS
 github_url: "https://github.com/boycce/monastery"
+port: 4001
 basedir: "docs"
 
 # Aux links for the naviation.

package/docs/{schema.md → schema/index.md}

@@ -1,6 +1,7 @@
 ---
 title: Schema
 nav_order: 4
+has_children: true
 ---
 
 # Schema
@@ -166,6 +167,24 @@ await db.user.insert({
 }
 ```
 
+Since unique indexes by default don't allow mutliple documents with `null`, you use a partial index (less performant), e.g.
+
+```js
+
+schema.fields = {
+index: {
+  name: {
+    type: 'string',
+    index: {
+      type: 'unique',
+      partialFilterExpression: {
+        email: { $type: 'string' }
+      }
+    }
+  }
+}
+```
+
 ### Custom validation rules
 
 You are able to define custom validation rules to use. (`this` will refer to the data object passed in)

package/docs/{rules.md → schema/rules.md}

@@ -1,6 +1,7 @@
 ---
 title: Rules
 nav_order: 5
+parent: Schema
 ---
 
 # Validation Rules

package/lib/model-crud.js

@@ -2,15 +2,15 @@ let util = require('./util')
 
 module.exports = {
 
-  insert: function(opts, cb) {
+  insert: async function(opts, cb) {
     /**
      * Inserts document(s) with monk after validating data & before hooks.
      * @param {object} opts
      *     @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|false} validateUndefined - ignore all required fields during insert, or
-     *         undefined subdocument required fields that have a defined parent/grandparent during update
+     *     @param {array|string|false} validateUndefined - validates all 'required' undefined fields, true by
+     *         default, but false on 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
@@ -18,44 +18,36 @@ module.exports = {
      * @this model
      * @return promise
      */
-    opts = opts || {}
-    opts.insert = true
-    opts.model = this
-    let req = opts.req
-    let data = opts.data = util.isDefined(opts.data)? opts.data : util.isDefined((req||{}).body) ? req.body : {}
-    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`)
     }
-    return util.parseData(data).then(data => {
-      opts.data = data
-      return this.validate(data, { ...opts })
-
-    }).then(data => {
-      return util.runSeries(this.beforeInsert.map(f => f.bind(opts, data))).then(() => data)
-
-    }).then(data => {
-      return this._insert(data, options)
-
-    }).then(data => {
-      return util.runSeries(this.afterInsert.map(f => f.bind(opts, data))).then(() => data)
-
-    // Success/error
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
-
-    }).catch(err => {
+    try {
+      opts = await this._queryObject(opts, 'insert')
+      let options = util.omit(opts, [
+        'data', 'insert', 'model', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'
+      ])
+
+      // Validate
+      opts.data = await this.validate(opts.data||{}, { ...opts })
+
+      // Insert
+      await util.runSeries(this.beforeInsert.map(f => f.bind(opts, opts.data)))
+      let response = await this._insert(opts.data, options)
+      await util.runSeries(this.afterInsert.map(f => f.bind(opts, response)))
+
+      // Success/error
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return Promise.resolve(response)
+
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  find: function(opts, cb, one) {
+  find: async function(opts, cb, one) {
     /**
      * Finds document(s) with monk, also auto populates
      * @param {object} opts
@@ -69,19 +61,15 @@ module.exports = {
      * @this model
      * @return promise
      */
-    let options, lookups = []
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.find() is not a function`)
     }
-    return new Promise((resolve, reject) => {
-      opts = this._queryObject(opts)
-      opts.one = one || opts.one
-      // Operation options
-      options = util.omit(opts, ['blacklist', 'one', 'populate', 'project', 'query', 'respond'])
-      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)
+    try {
+      opts = await this._queryObject(opts, 'find', one)
+      let lookups = []
+      let options = util.omit(opts, ['blacklist', 'one', 'populate', 'project', 'query', 'respond'])
       options.addFields = options.addFields || {}
+
       // Project, or use blacklisting
       if (opts.project) {
         // Can be an inclusion or exclusion projection
@@ -105,14 +93,10 @@ module.exports = {
       //   options.projection.score = { $meta: 'textScore' }
       //   options.sort = { score: { $meta: 'textScore' }}
       // }
-      // Sort string passed
-      if (util.isString(options.sort)) {
-        let name = (options.sort.match(/([a-z0-9-_]+)/) || [])[0]
-        let order = (options.sort.match(/:(-?[0-9])/) || [])[1]
-        options.sort = { [name]: parseInt(order || 1) }
-      }
       // Wanting to populate?
-      if (opts.populate) {
+      if (!opts.populate) {
+        var response = await this[`_find${opts.one? 'One' : ''}`](opts.query, options)
+      } else {
         loop: for (let item of opts.populate) {
           let path = util.isObject(item)? item.as : item
           // Blacklisted?
@@ -148,7 +132,7 @@ module.exports = {
         }
         // console.log(1, options.projection)
         // console.log(2, lookups)
-        let aggreagte = [
+        let aggregate = [
           { $match: opts.query },
           { $sort: options.sort },
           { $skip: options.skip },
@@ -157,49 +141,45 @@ module.exports = {
           ...util.isEmpty(options.addFields)? [] : [{ $addFields: options.addFields }],
           { $project: options.projection }
         ]
-        var operation = this._aggregate.bind(this._collection, aggreagte)
-        this.info('aggregate', JSON.stringify(aggreagte))
-
-      // Normal operation
-      } else {
-        operation = this[opts.one? '_findOne' : '_find'].bind(this._collection, opts.query, options)
+        response = await this._aggregate(aggregate)
+        this.info('aggregate', JSON.stringify(aggregate))
       }
-      operation()
-        .then(data => resolve(data))
-        .catch(err => reject(err))
 
-    }).then(data => {
-      if (opts.one && util.isArray(data)) data = data[0]
+      if (opts.one && util.isArray(response)) response = response[0]
       // (Not using) Project works with lookup.
       // Remove blacklisted properties from joined models, because subpiplines with 'project' are slower
       // if (opts.populate) this._depreciated_removeBlacklisted(data, opts.populate, options.projection)
-      return this._processAfterFind(data, options.projection, opts)
+      response = await this._processAfterFind(response, options.projection, opts)
 
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
+      // Success
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return Promise.resolve(response)
 
-    }).catch(err => {
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  findOne: function(opts, cb) {
+  findOne: async function(opts, cb) {
     return this.find(opts, cb, true)
   },
 
-  update: function(opts, cb) {
+  // findOneAndUpdate: function(opts, cb) {
+  //   return this._findOneAndUpdate(opts, cb)
+  // },
+
+  update: async function(opts, cb) {
     /**
      * Updates document(s) with monk after validating data & before hooks.
      * @param {object} opts
      *     @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|false} validateUndefined - ignore all required fields during insert, or
-     *         undefined subdocument required fields that have a defined parent/grandparent during update
+     *     @param {array|string|false} validateUndefined - validates all 'required' undefined fields, true by
+     *         default, but false on 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
@@ -208,78 +188,51 @@ module.exports = {
      * @this model
      * @return promise(data)
      */
-    let data, options, operators
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.update() is not a function`)
     }
-    return new Promise((resolve, reject) => {
-      opts = this._queryObject(opts)
-      opts.update = true
-      opts.model = this
-      let req = opts.req
-      data = opts.data = util.isDefined(opts.data)? opts.data : util.isDefined((req||{}).body) ? req.body : undefined
-      operators = util.pluck(opts, [/^\$/])
-      // Operation options
-      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)) {
-        let name = (options.sort.match(/([a-z0-9-_]+)/) || [])[0]
-        let order = (options.sort.match(/:(-?[0-9])/) || [])[1]
-        options.sort = { [name]: parseInt(order || 1) }
+    try {
+      opts = await this._queryObject(opts, 'update')
+      let response = null
+      let operators = util.pluck(opts, [/^\$/])
+      let options = util.omit(opts, ['data', 'query', 'respond', 'validateUndefined', 'skipValidation', 'blacklist'])
+
+      // Validate
+      if (util.isDefined(opts.data)) opts.data = await this.validate(opts.data, { ...opts })
+      if (!util.isDefined(opts.data) && util.isEmpty(operators)) {
+        throw new Error(`Please pass an update operator to ${this.name}.update(), e.g. data, $unset, etc`)
       }
-      util.parseData(data).then(d => resolve(d))
-
-    }).then(data => {
-      opts.data = data
-      if (util.isDefined(data)) return this.validate(data, { ...opts })
-      else return Promise.resolve(data)
-
-    }).then(data => {
-      if (util.isDefined(data) && (!data || util.isEmpty(data))) {
+      if (util.isDefined(opts.data) && (!opts.data || util.isEmpty(opts.data))) {
         throw new Error(`No valid data passed to ${this.name}.update({ data: .. })`)
       }
-      if (!util.isDefined(data) && util.isEmpty(operators)) {
-        throw new Error(`Please pass an update operator to ${this.name}.update(), e.g. data, $unset, etc`)
-      }
-      return util.runSeries(this.beforeUpdate.map(f => f.bind(opts, data||{}))).then(() => data)
-
-    }).then(data => {
-      if (data && operators['$set']) {
+      // Hook: beforeUpdate
+      await util.runSeries(this.beforeUpdate.map(f => f.bind(opts, opts.data||{})))
+      if (opts.data && operators['$set']) {
         this.warn(`'$set' fields take precedence over the data fields for \`${this.name}.update()\``)
       }
-      if (data || operators['$set']) {
-        operators['$set'] = {
-          ...data,
-          ...(operators['$set'] || {}),
-        }
+      if (opts.data || operators['$set']) {
+        operators['$set'] = { ...opts.data, ...(operators['$set'] || {}) }
       }
-      return this._update(opts.query, operators, options).then(output => {
-        if (!output.n) return null
-        let response = Object.assign(Object.create({ _output: output }), operators['$set']||{})
-        output = data = null // Cleanup (just incase)
-        return response
-      })
+      // Update
+      let update = await this._update(opts.query, operators, options)
+      if (update.n) response = Object.assign(Object.create({ _output: update }), operators['$set']||{})
 
-    }).then(data => {
-      if (!data) return data
-      return util.runSeries(this.afterUpdate.map(f => f.bind(opts, data))).then(() => data)
+      // Hook: afterUpdate
+      if (update.n) await util.runSeries(this.afterUpdate.map(f => f.bind(opts, response)))
 
-    // Success/error
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
+      // Success
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return response
 
-    }).catch(err => {
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  remove: function(opts, cb) {
+  remove: async function(opts, cb) {
     /**
      * Remove document(s) with monk after before hooks.
      * @param {object} opts
@@ -290,73 +243,84 @@ module.exports = {
      * @this model
      * @return promise
      */
-    let options
     if (cb && !util.isFunction(cb)) {
       throw new Error(`The callback passed to ${this.name}.remove() is not a function`)
     }
-    return new Promise((resolve, reject) => {
-      opts = this._queryObject(opts)
-      opts.remove = true
-      opts.model = this
+    try {
+      opts = await this._queryObject(opts, 'remove')
+      let options = util.omit(opts, ['query', 'respond'])
       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.limit = parseInt(options.limit || 1)
-      // Sort string passed
-      if (util.isString(options.sort)) {
-        let name = (options.sort.match(/([a-z0-9-_]+)/) || [])[0]
-        let order = (options.sort.match(/:(-?[0-9])/) || [])[1]
-        options.sort = { [name]: parseInt(order || 1) }
-      }
-      util.runSeries(this.beforeRemove.map(f => f.bind(opts)))
-        .then(() => resolve())
-        .catch(e => reject(e))
-
-    }).then(() => {
-      return this._remove(opts.query, options)
 
-    }).then(data => {
-      return util.runSeries(this.afterRemove.map(f => f.bind(opts))).then(() => data)
+      // Remove
+      await util.runSeries(this.beforeRemove.map(f => f.bind(opts)))
+      let response = await this._remove(opts.query, options)
+      await util.runSeries(this.afterRemove.map(f => f.bind(response)))
 
-    // Success/error
-    }).then(data => {
-      if (cb) cb(null, data)
-      else if (opts.req && opts.respond) opts.req.res.json(data)
-      else return Promise.resolve(data)
+      // Success
+      if (cb) cb(null, response)
+      else if (opts.req && opts.respond) opts.req.res.json(response)
+      else return Promise.resolve(response)
 
-    }).catch(err => {
+    } catch (err) {
       if (cb) cb(err)
       else if (opts && opts.req && opts.respond) opts.req.res.error(err)
       else throw err
-    })
+    }
   },
 
-  _queryObject: function(opts) {
+  _queryObject: async function(opts, type, one) {
     /**
-     * Extract the query id from opts, opts.query
-     * @param {MongoId|ID string|Query object} opts
-     * @return opts
+     * Normalise options
+     * @param {MongoId|string|object} opts
+     * @param {string} type - operation type
+     * @param {boolean} one - return one document
+     * @this model
+     * @return {Promise} opts
      *
-     * opts == string|MongodID - treated as an id
+     * opts == string|MongodId - treated as an id
      * opts == undefined|null|false - throw error
      * opts.query == string|MongodID - treated as an id
      * opts.query == undefined|null|false - throw error
      */
-    let isIdType = (o) => util.isId(o) || util.isString(o)
-    if (isIdType(opts)) opts = { query: { _id: opts || '' }}
-    if (isIdType((opts||{}).query)) opts.query = { _id: opts.query || '' }
-    if (!util.isObject(opts) || !util.isObject(opts.query)) {
-      throw new Error('Please pass an object or MongoId to options.query')
-    }
-    // For security, if _id is set and undefined, throw an error
-    if (typeof opts.query._id == 'undefined' && opts.query.hasOwnProperty('_id')) {
-      throw new Error('Please pass an object or MongoId to options.query')
+
+    // Query
+    if (type != 'insert') {
+      let isIdType = (o) => util.isId(o) || util.isString(o)
+      if (isIdType(opts)) {
+        opts = { query: { _id: opts || '' }}
+      }
+      if (isIdType((opts||{}).query)) {
+        opts.query = { _id: opts.query || '' }
+      }
+      if (!util.isObject(opts) || !util.isObject(opts.query)) {
+        throw new Error('Please pass an object or MongoId to options.query')
+      }
+      // For security, if _id is set and undefined, throw an error
+      if (typeof opts.query._id == 'undefined' && opts.query.hasOwnProperty('_id')) {
+        throw new Error('Please pass an object or MongoId to options.query')
+      }
+      if (util.isId(opts.query._id)) opts.query._id = this.manager.id(opts.query._id)
+      if (isIdType(opts.query._id) || one) opts.one = true
+      opts.query = util.removeUndefined(opts.query)
+
+      // Query options
+      opts.limit = opts.one? 1 : parseInt(opts.limit || (type == 'remove' ? 1 : this.manager.limit || 0))
+      opts.skip = Math.max(0, opts.skip || 0)
+      opts.sort = opts.sort || { 'createdAt': -1 }
+      if (util.isString(opts.sort)) {
+        let name = (opts.sort.match(/([a-z0-9-_]+)/) || [])[0]
+        let order = (opts.sort.match(/:(-?[0-9])/) || [])[1]
+        opts.sort = { [name]: parseInt(order || 1) }
+      }
     }
-    // Remove undefined query parameters
-    opts.query = util.removeUndefined(opts.query)
-    if (util.isId(opts.query._id)) opts.query._id = this.manager.id(opts.query._id)
-    if (isIdType(opts.query._id)) opts.one = true
+
+    // Data
+    if (!opts) opts = {}
+    if (!util.isDefined(opts.data) && util.isDefined((opts.req||{}).body)) opts.data = opts.req.body
+    if (util.isDefined(opts.data)) opts.data = await util.parseData(opts.data)
+
+    opts[type] = true
+    opts.model = this
     return opts
   },
 

package/lib/model-validate.js

@@ -12,8 +12,8 @@ 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|false} validateUndefined - ignore all required fields during insert, or undefined
-     *         subdocument required fields that have a defined parent/grandparent during update
+     *     @param {array|string|false} validateUndefined - validates all 'required' undefined fields, true by
+     *         default, but false on 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
@@ -176,11 +176,11 @@ module.exports = {
         } else if (util.isSubdocument(field)) {
           // 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)
+          // Recurse if inserting, value is a subdocument, or a deep property (todo: not dot-notation)
           if (
-            util.isObject(value) ||
             opts.insert ||
-            ((path2||'').match(/\./) && (util.isDefined(opts.validateUndefined) ? opts.validateUndefined : true))
+            util.isObject(value) ||
+            (util.isDefined(opts.validateUndefined) ? opts.validateUndefined : (path2||'').match(/\./))
           ) {
             var res = this._validateFields(dataRoot, field, value, opts, path2)
             errors.push(...res[0])
@@ -260,13 +260,14 @@ module.exports = {
     ruleArg = ruleArg === true? undefined : ruleArg
     let rule = this.rules[ruleName] || rules[ruleName]
     let fieldName = path.match(/[^.]+$/)[0]
+    let isDeepProp = path.match(/\./) // todo: not dot-notation
     let ruleMessageKey = this._getMostSpecificKeyMatchingPath(this.messages, path)
     let ruleMessage = ruleMessageKey && this.messages[ruleMessageKey][ruleName]
-    let validateUndefined = util.isDefined(opts.validateUndefined) ? opts.validateUndefined : rule.validateUndefined
+    let validateUndefined = util.isDefined(opts.validateUndefined) ? opts.validateUndefined : opts.insert || isDeepProp
     if (!ruleMessage) ruleMessage = rule.message
 
-    // Ignore undefined (if updated root property, or ignoring)
-    if (typeof value === 'undefined' && (!validateUndefined || (opts.update && !path.match(/\./)))) return
+    // Undefined value
+    if (typeof value === 'undefined' && (!validateUndefined  || !rule.validateUndefined)) return
 
     // Ignore null (if nullObject is set on objects or arrays)
     if (value === null && (field.isObject || field.isArray) && field.nullObject) return

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "1.31.3",
+  "version": "1.31.7",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -23,7 +23,7 @@
     "mong": "nodemon resources/mong.js",
     "minor": "standard-version --release-as minor && npm publish",
     "patch": "standard-version --release-as patch && npm publish",
-    "release": "standard-version && npm publish",
+    "release": "standard-version && npm publish && git push --tags",
     "test": "npm run lint && jest",
     "test-one-example": "jest -t images"
   },
@@ -46,11 +46,13 @@
     "supertest": "4.0.2"
   },
   "standard-version": {
+    "infile": "changelog.md",
     "releaseCommitMessageFormat": "{{currentTag}}",
     "sign": true,
     "skip": {
       "changelog": false,
       "tag": false
-    }
+    },
+    "tag-prefix": ""
   }
 }

package/test/model.js

@@ -189,6 +189,55 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('model unique indexes', async () => {
+    let db = (await opendb(null)).db
+    // Setup: Drop previously tested collections
+    if ((await db._db.listCollections().toArray()).find(o => o.name == 'userUniqueIndex')) {
+      await db._db.collection('userUniqueIndex').drop()
+    }
+
+    // Partial unique indexes (allows mulitple null values)
+    await db.model('userUniqueIndex', {
+      waitForIndexes: true,
+      fields: {
+        email: {
+          type: 'string',
+          index: {
+            type: 'unique',
+            partialFilterExpression: {
+              email: { $type: 'string' }
+            }
+          }
+        },
+      }
+    })
+
+    let indexes2 = await db._db.collection('userUniqueIndex').indexes()
+    expect(indexes2[0]).toMatchObject({ v: 2, key: { _id: 1 }, name: '_id_' })
+    expect(indexes2[1]).toMatchObject({ v: 2, unique: true, key: { email: 1 }, name: 'email_1' })
+
+    await expect(db.userUniqueIndex.insert({ data: { 'email': 'ricky@orchid.co.nz' }})).resolves.toEqual({
+      _id: expect.any(Object),
+      email: 'ricky@orchid.co.nz'
+    })
+
+    await expect(db.userUniqueIndex.insert({ data: { 'email': 'ricky@orchid.co.nz' }})).rejects.toThrow(
+      /E11000 duplicate key error collection: monastery.userUniqueIndex index: email_1 dup key: {/
+    )
+
+    await expect(db.userUniqueIndex.insert({ data: { 'email': null }})).resolves.toEqual({
+      _id: expect.any(Object),
+      email: null
+    })
+
+    await expect(db.userUniqueIndex.insert({ data: { 'email': null }})).resolves.toEqual({
+      _id: expect.any(Object),
+      email: null
+    })
+
+    db.close()
+  })
+
   test('model subdocument indexes', async () => {
     // Setup: Need to test different types of indexes
     let db = (await opendb(null)).db

package/test/validate.js

@@ -26,17 +26,18 @@ module.exports = function(monastery, opendb) {
       meta: { rule: 'required', model: 'user', field: 'name' }
     })
 
-    // Required error (insert, and with ignoreRequired)
-    await expect(user.validate({}, { validateUndefined: false })).resolves.toEqual({})
-    await expect(user.validate({}, { validateUndefined: false, update: true })).resolves.toEqual({})
-
     // No required error (update)
     await expect(user.validate({}, { update: true })).resolves.toEqual({})
 
     // Type error (string)
     await expect(user.validate({ name: 1 })).resolves.toEqual({ name: '1' })
     await expect(user.validate({ name: 1.123 })).resolves.toEqual({ name: '1.123' })
-    await expect(user.validate({ name: undefined }, { validateUndefined: false })).resolves.toEqual({})
+    await expect(user.validate({ name: undefined })).rejects.toContainEqual({
+      status: '400',
+      title: 'name',
+      detail: 'This field is required.',
+      meta: { rule: 'required', model: 'user', field: 'name' }
+    })
     await expect(user.validate({ name: null })).rejects.toContainEqual({
       status: '400',
       title: 'name',
@@ -65,20 +66,19 @@ module.exports = function(monastery, opendb) {
     await expect(usernum.validate({ amount: 0 })).resolves.toEqual({ amount: 0 })
     await expect(usernum.validate({ amount: '0' })).resolves.toEqual({ amount: 0 })
     await expect(usernum2.validate({ amount: '' })).resolves.toEqual({ amount: null })
-    await expect(usernum.validate({ amount: undefined }, { validateUndefined: false })).resolves.toEqual({})
     await expect(usernum.validate({ amount: false })).rejects.toEqual([{
       status: '400',
       title: 'amount',
       detail: 'Value was not a number.',
       meta: { rule: 'isNumber', model: 'usernum', field: 'amount' }
     }])
-    await expect(usernum.validate({ amount: null })).rejects.toEqual([{
+    await expect(usernum.validate({ amount: undefined })).rejects.toEqual([{
       status: '400',
       title: 'amount',
       detail: 'This field is required.',
       meta: { rule: 'required', model: 'usernum', field: 'amount' },
     }])
-    await expect(usernum.validate({ amount: null }, { validateUndefined: false })).rejects.toEqual([{
+    await expect(usernum.validate({ amount: null })).rejects.toEqual([{
       status: '400',
       title: 'amount',
       detail: 'This field is required.',
@@ -309,6 +309,41 @@ module.exports = function(monastery, opendb) {
       .rejects.toContainEqual(error)
   })
 
+  test('validation array schema errors', async () => {
+    // Setup
+    let db = (await opendb(false)).db
+    function arrayWithSchema(array, schema) {
+      array.schema = schema
+      return array
+    }
+    let user = db.model('user', { fields: {
+      animals: arrayWithSchema(
+        [{ type: 'string' }],
+        { required: true, minLength: 2 },
+      )
+    }})
+
+    // MinLength error
+    await expect(user.validate({
+      animals: [],
+    })).rejects.toContainEqual({
+      status: '400',
+      title: 'animals',
+      detail: 'This field is required.',
+      meta: { rule: 'required', model: 'user', field: 'animals' }
+    })
+
+    // MinLength error
+    await expect(user.validate({
+      animals: ['dog'],
+    })).rejects.toContainEqual({
+      status: '400',
+      title: 'animals',
+      detail: 'Value needs to contain a minimum of 2 items.',
+      meta: { rule: 'minLength', model: 'user', field: 'animals' }
+    })
+  })
+
   test('validation getMostSpecificKeyMatchingPath', async () => {
     let fn = validate._getMostSpecificKeyMatchingPath
     let mock = {
@@ -870,7 +905,7 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
-  test('validation options', async () => {
+  test('validation option skipValidation', async () => {
     let db = (await opendb(false)).db
     let user = db.model('user', { fields: {
       name: { type: 'string', required: true }
@@ -955,6 +990,66 @@ module.exports = function(monastery, opendb) {
     })
   })
 
+  test('validation option validateUndefined', async () => {
+    // ValidateUndefined runs required rules on all fields, `true` for insert, `false` for update.
+
+    // Setup
+    let db = (await opendb(false)).db
+    let user = db.model('user', { fields: {
+      date: { type: 'number' },
+      name: { type: 'string', required: true },
+    }})
+    let usernum = db.model('usernum', { fields: {
+      amount: { type: 'number', required: true }
+    }})
+    let userdeep = db.model('userdeep', { fields: {
+      date: { type: 'number' },
+      name: {
+        first: { type: 'string', required: true },
+      },
+      names: [{
+        first: { type: 'string', required: true },
+      }]
+    }})
+    let errorRequired = {
+      status: '400',
+      title: 'name',
+      detail: 'This field is required.',
+      meta: expect.any(Object),
+    }
+
+    // Required error for undefined
+    await expect(user.validate({}))
+      .rejects.toEqual([errorRequired])
+    await expect(user.validate({}, { update: true, validateUndefined: true }))
+      .rejects.toEqual([errorRequired])
+    await expect(userdeep.validate({}))
+      .rejects.toEqual([{ ...errorRequired, title: 'name.first' }])
+    await expect(userdeep.validate({ name: {} }, { update: true }))
+      .rejects.toEqual([{ ...errorRequired, title: 'name.first' }])
+    await expect(userdeep.validate({ names: [{}] }, { update: true }))
+      .rejects.toEqual([{ ...errorRequired, title: 'names.0.first' }])
+
+    // Required error for null
+    await expect(user.validate({ name: null }, { update: true }))
+      .rejects.toEqual([errorRequired])
+    await expect(usernum.validate({ amount: null }, { update: true }))
+      .rejects.toEqual([{ ...errorRequired, title: 'amount' }])
+    await expect(user.validate({ name: null }, { update: true, validateUndefined: true }))
+      .rejects.toEqual([errorRequired])
+
+    // Skip required error
+    await expect(user.validate({ name: undefined }, { validateUndefined: false })).resolves.toEqual({})
+    await expect(user.validate({}, { validateUndefined: false })).resolves.toEqual({})
+    await expect(user.validate({}, { update: true })).resolves.toEqual({})
+    await expect(user.validate({}, { update: true, validateUndefined: false })).resolves.toEqual({})
+    await expect(userdeep.validate({}, { update: true })).resolves.toEqual({})
+    await expect(userdeep.validate({ name: {} }, { update: true, validateUndefined: false }))
+      .resolves.toEqual({ name: {} })
+    await expect(userdeep.validate({ names: [{}] }, { update: true, validateUndefined: false }))
+      .resolves.toEqual({ names: [{}] })
+  })
+
   test('validation hooks', async () => {
     let db = (await opendb(null)).db
     let user = db.model('user', {

package/CHANGELOG.md

@@ -1,23 +0,0 @@
-# Changelog
-
-All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
-
-### 1.31.3 (2022-02-15)
-
-
-### Bug Fixes
-
-* _callAfterFind bug ([e62472c](https://github.com/boycce/monastery/commit/e62472c191119135839b6d9e42b7f060bc7a508d))
-* .eslintrc.json ([5362585](https://github.com/boycce/monastery/commit/53625857bbf798db97eddad9385799cb1ded97e2))
-* docs ([d8f4e15](https://github.com/boycce/monastery/commit/d8f4e15913f672295cc118fda11ec23a412b4c62))
-* docs ([1a5118e](https://github.com/boycce/monastery/commit/1a5118e4b389b55d30bf987991b59638b11613a9))
-* docs ([564572c](https://github.com/boycce/monastery/commit/564572ce33dfb35fdd131e81d1dcc655f024b26e))
-* docs ([12d37d3](https://github.com/boycce/monastery/commit/12d37d3b2d0b5ec577f9ed4deb9c929c8ea52a36))
-* docs and nav links ([0eabcf0](https://github.com/boycce/monastery/commit/0eabcf0cd9a119a6ab1a07b92634e316995a2a83))
-* model-crud ([d421709](https://github.com/boycce/monastery/commit/d421709a70e6611c78e049e98268153c9bafae6d))
-* normalise afterFind ([0ab7f43](https://github.com/boycce/monastery/commit/0ab7f43f25b599e07d9ae751dc3bac8550e53c24))
-* normalised rule arguments and context ([6ba48da](https://github.com/boycce/monastery/commit/6ba48da3b9c643620cebf5442e60bd0318d6780f))
-* package scripts ([f7935af](https://github.com/boycce/monastery/commit/f7935afb0181ddb3e397bf804b34c841589dfcf0))
-* semver ([6f14909](https://github.com/boycce/monastery/commit/6f14909f4405cf26dc04a8603cc3bac232b96798))
-* standard-version ([f553b08](https://github.com/boycce/monastery/commit/f553b08445eb7dd2e85f6bb447e2bb0bc38dda34))
-* util bug, updated tests ([bec1887](https://github.com/boycce/monastery/commit/bec1887f56cb8582b606a066c913c191362a61b0))