monastery 1.34.0 → 1.36.1

package/.eslintrc.json

@@ -21,7 +21,7 @@
   "plugins": [],
   "rules": {
     "brace-style": ["error", "1tbs", { "allowSingleLine": true }],
-    "max-len": ["error", { "code": 120, "ignorePattern": "^\\s*<(rect|path|line)\\s" }],
+    "max-len": ["error", { "code": 125, "ignorePattern": "^\\s*<(rect|path|line)\\s" }],
     "no-prototype-builtins": "off",
     "no-unused-vars": ["error", { "args": "none" }],
     "object-shorthand": ["error", "consistent"],

package/changelog.md

@@ -2,6 +2,35 @@
 
 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.36.1](https://github.com/boycce/monastery/compare/1.36.0...1.36.1) (2022-04-16)
+
+
+### Bug Fixes
+
+* findOneAndUpdate population, blacklisting, etc ([19c4fc9](https://github.com/boycce/monastery/commit/19c4fc96d8c94d9dd68af2a74af693c8dc7a4c17))
+
+## [1.36.0](https://github.com/boycce/monastery/compare/1.35.0...1.36.0) (2022-04-15)
+
+
+### Features
+
+* added findOneAndUpdate ([60b518a](https://github.com/boycce/monastery/commit/60b518a1d09002a794e72fe3476c39c43c0c3b5e))
+
+
+### Bug Fixes
+
+* removed depreciation warnings ([6db73bb](https://github.com/boycce/monastery/commit/6db73bba7916b4c5c98a24fd03b34c0f776abb5c))
+
+## [1.35.0](https://github.com/boycce/monastery/compare/1.34.0...1.35.0) (2022-04-08)
+
+
+### Features
+
+* Blacklist `false` removes all blacklisting, added tests for blacklisting/project stirng ([5999859](https://github.com/boycce/monastery/commit/599985972cc14b980148db26c03108feabf23756))
+* Add project to insert/update/validate ([1b1eb12](https://github.com/boycce/monastery/commit/1b1eb12bc476ff82445a46489db64b37c13f9513))
+* Whitelisting a parent will remove any previously blacklisted children ([1b1eb12](https://github.com/boycce/monastery/commit/1b1eb12bc476ff82445a46489db64b37c13f9513))
+* Blacklist/project works the same across find/insert/update/validate ([1b1eb12](https://github.com/boycce/monastery/commit/1b1eb12bc476ff82445a46489db64b37c13f9513))
+
 ## [1.34.0](https://github.com/boycce/monastery/compare/1.33.0...1.34.0) (2022-04-05)
 
 

package/docs/readme.md

@@ -83,18 +83,20 @@ Coming soon...
 
 ## Roadmap
 
-- Add FindOneAndUpdate
+- ~~Add FindOneAndUpdate~~
 - Add before/afterInsertUpdate
 - Bug: Setting an object literal on an ID field ('model') saves successfully
 - Population within array items
-- ~~Blackislisitng which aggregates from the order of appearance~~
+- ~~Blacklist false removes all blacklisting~~
+- ~~Add project to insert/update/validate~~
 - ~~Whitelisting a parent will remove any previously blacklisted children~~
+- ~~Blacklist/project works the same across find/insert/update/validate~~
 - Automatic subdocument ids
 - Remove ACL default 'public read'
-- Public db.arrayWithSchema method
+- ~~Public db.arrayWithSchema method~~
 - Global after/before hooks
-- Split away from Monk (unless updated)
 - docs: Make the implicit ID query conversion more apparent
+- Split away from Monk (unless updated)
 
 ## Special Thanks
 

package/docs/schema/index.md

@@ -248,9 +248,9 @@ schema.messages = {
   }
   // You can also target any rules set on the array or sub arrays
   // e.g.
-  // let arrayWithSchema = (array, schema) => { array.schema = schema; return array }
-  // petGroups = arrayWithSchema(
-  //   [arrayWithSchema(
+  // // let arrayWithSchema = (array, schema) => { array.schema = schema; return array }, OR you can use db.arrayWithSchema
+  // petGroups = db.arrayWithSchema(
+  //   [db.arrayWithSchema(
   //     [{ name: { type: 'string' }}],
   //     { minLength: 1 }
   //   )],

package/lib/index.js

@@ -1,6 +1,10 @@
-let util = require('./util')
-let monk = require('monk')
 let debug = require('debug')
+let monk = require('monk')
+let util = require('./util')
+
+// Apply monk monkey patches
+monk.manager.prototype.open = require('./monk-monkey-patches').open
+monk.Collection.prototype.findOneAndUpdate = require('./monk-monkey-patches').findOneAndUpdate
 
 module.exports = function(uri, opts, fn) {
   /**
@@ -12,59 +16,51 @@ module.exports = function(uri, opts, fn) {
    * @param {object} opts
    * @return monk manager
    */
+  let monasteryOpts = [
+    'defaultObjects', 'imagePlugin', 'limit', 'nullObjects', 'timestamps', 'useMilliseconds'
+  ]
+
   if (!opts) opts = {}
   if (util.isDefined(opts.defaultFields)) {
     var depreciationWarningDefaultField = true
     opts.timestamps = opts.defaultFields
+    delete opts.defaultFields
+  }
+  if (!util.isDefined(opts.timestamps)) {
+    opts.timestamps = true
   }
-  let defaultObjects = opts.defaultObjects
-  let imagePlugin = opts.imagePlugin
-  let limit = opts.limit
-  let nullObjects = opts.nullObjects
-  let timestamps = util.isDefined(opts.timestamps)? opts.timestamps : true
-  let useMilliseconds = opts.useMilliseconds
-  delete opts.defaultFields
-  delete opts.defaultObjects
-  delete opts.imagePlugin
-  delete opts.limit
-  delete opts.nullObjects
-  delete opts.timestamps
-  delete opts.useMilliseconds
 
-  // Monk Manager instance or manager mock
+  // Monk manager instance or manager mock
   // Monk manager instances have manager._db defined which is the raw mongodb connection
   if (typeof uri === 'object') var manager = uri
-  else if (uri) manager = monk(uri, { useUnifiedTopology: true, ...opts }, fn)
+  else if (uri) manager = monk(uri, { useUnifiedTopology: true, ...util.omit(opts, monasteryOpts) }, fn)
   else manager = { id: monk.id }
 
   // Add monastery properties
-  manager.error = debug('monastery:error*')
-  manager.warn = debug('monastery:warn')
-  manager.info = debug('monastery:info')
-  manager.model = require('./model')
-  manager.models = models
-  manager.defaultObjects = defaultObjects
-  manager.imagePlugin = imagePlugin
+  manager.arrayWithSchema = arrayWithSchema
+  manager.beforeModel = []
   manager.imagePluginFile = require('../plugins/images')
   manager.isId = util.isId.bind(util)
-  manager.limit = limit
-  manager.nullObjects = nullObjects
+  manager.model = require('./model')
+  manager.models = models
   manager.parseData = util.parseData.bind(util)
-  manager.timestamps = timestamps
-  manager.useMilliseconds = useMilliseconds
-  manager.beforeModel = []
-  manager.arrayWithSchema = manager.arraySchema = (array, schema) => {
-    array.schema = schema; return array
+  manager.warn = debug('monastery:warn')
+  manager.error = debug('monastery:error*')
+  manager.info = debug('monastery:info')
+
+  // Add opts onto manager
+  for (let key of monasteryOpts) {
+    manager[key] = opts[key]
   }
 
   // Depreciation warnings
   if (depreciationWarningDefaultField) {
-    manager.error('manager.defaultFields has been depreciated in favour of manager.timestamps')
+    manager.error('opts.defaultFields has been depreciated in favour of opts.timestamps')
   }
 
   // Initiate any plugins
   if (manager.imagePlugin) {
-    manager.imagePluginFile.setup(manager, util.isObject(imagePlugin)? imagePlugin : {})
+    manager.imagePluginFile.setup(manager, util.isObject(manager.imagePlugin)? manager.imagePlugin : {})
   }
 
   // Catch mongodb connectivity errors
@@ -72,11 +68,17 @@ module.exports = function(uri, opts, fn) {
   return manager
 }
 
-function models(path) {
+let arrayWithSchema = function(array, schema) {
+  array.schema = schema
+  return array
+}
+
+let models = function(path) {
   /**
    * Setup model definitions from a folder location
    * @param {string} pathname
    * @return {object} - e.g. { user: , article: , .. }
+   * @this Manager
    */
   let models = {}
   if (!path || typeof path !== 'string') {