monastery 1.41.1 → 1.42.0

package/changelog.md

@@ -2,6 +2,10 @@
 
 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.42.0](https://github.com/boycce/monastery/compare/1.41.2...1.42.0) (2023-10-09)
+
+### [1.41.2](https://github.com/boycce/monastery/compare/1.41.1...1.41.2) (2023-10-04)
+
 ### [1.41.1](https://github.com/boycce/monastery/compare/1.41.0...1.41.1) (2023-04-17)
 
 ## [1.41.0](https://github.com/boycce/monastery/compare/1.40.5...1.41.0) (2023-04-16)

package/docs/manager/index.md

@@ -30,15 +30,18 @@ A monk manager instance with additional Monastery methods, i.e. `model` `models`
 ### Example
 
 ```js
-const db = require('monastery')('localhost/mydb', options)
+import monastery from 'monastery'
+const db = monastery('localhost/mydb', options)
 ```
 
 ```js
-const db = require('monastery')('localhost/mydb,192.168.1.1') // replica set
+import monastery from 'monastery'
+const db = monastery('localhost/mydb,192.168.1.1') // replica set
 ```
 
 ```js
-require('monastery')('localhost/mydb,192.168.1.1').then((db) => {
+import monastery from 'monastery'
+monastery('localhost/mydb,192.168.1.1').then((db) => {
   // db is the connected instance of the Manager
 }).catch((err) => {
   // error connecting to the database

package/docs/manager/models.md

@@ -9,7 +9,7 @@ Setup model definitions from a folder location
 
 ### Arguments
 
-`path` *(string)*: path to model definitions, the filenames are used as the corresponding model name.
+`path` *(string)*: path to model definitions, the filenames are used as the corresponding model name. Make sure the model definition is exported as the default
 
 ### Returns
 
@@ -23,7 +23,7 @@ db.model.{model-name}
 
 ```js
 // ./models/user.js
-export default {
+export default { // Make sure the model definition is exported as the default
   fields: {
     name: { type: 'string', required: true },
     email: { type: 'email', required: true, index: 'unique' }

package/docs/readme.md

@@ -24,9 +24,11 @@ $ npm install --save monastery
 ## Usage
 
 ```javascript
+import monastery from 'monastery'
+
 // Initialise a monastery manager
-const db = require('monastery')('localhost/mydb')
-// const db = require('monastery')('user:pass@localhost:port/mydb')
+const db = monastery('localhost/mydb')
+// const db = monastery('user:pass@localhost:port/mydb')
 
 // Define a model
 db.model('user', {
@@ -101,6 +103,7 @@ Coming soon...
 - Split away from Monk (unless updated)
 - Add a warning if an invalid model is referenced in jthe schema
 - Remove leading forward slashes from custom image paths (AWS adds this as a seperate folder)
+- double check await db.model.remove({ query: idfromparam }) doesnt cause issues for null, undefined or '', but continue to allow {}
 
 ## Versions
 

package/lib/index.js

@@ -93,9 +93,17 @@ let models = async function(pathname, waitForIndexes) {
   }
   let filenames = fs.readdirSync(pathname)
   for (let filename of filenames) {
-    let filepath = path.join(pathname, filename)
-    let definition = (await import(filepath)).default
+    // Ignore folders
+    if (!filename.match(/\.[cm]?js$/)) continue
     let name = filename.replace('.js', '')
+    let filepath = path.join(pathname, filename)
+    // We can't use require() here since we need to be able to import both CJS and ES6 modules
+    let definition = (await import(filepath))?.default
+    // When a commonJS project uses babel (e.g. `nodemon -r @babel/register`, similar to `-r esm`), import() 
+    // will return ES6 model definitions in another nested `default` object
+    if (definition?.default) definition = definition.default
+    if (!definition) throw new Error(`The model definition for '${name}' must export a default object`)
+    // Wait for indexes to be created?
     if (waitForIndexes) out[name] = await this.model(name, { ...definition, waitForIndexes })
     else out[name] = this.model(name, definition)
   }

package/lib/model-crud.js

@@ -25,9 +25,13 @@ module.exports = {
     try {
       opts = await this._queryObject(opts, 'insert')
 
+      // console.log(11, opts.data )
+
       // Validate
       let data = await this.validate(opts.data || {}, opts) // was { ...opts }
 
+      // console.log(22, data)
+
       // Insert
       await util.runSeries(this.beforeInsert.map(f => f.bind(opts, data)))
       let response = await this._insert(data, util.omit(opts, this._queryOptions))

package/lib/model-validate.js

@@ -108,6 +108,8 @@ module.exports = {
     let data2 = util.isArray(fields)? [] : {}
     let timestamps = util.isDefined(opts.timestamps)? opts.timestamps : this.manager.timestamps
 
+    // console.log(8888, fields)
+
     util.forEach(util.forceArray(data), function(data, i) {
       util.forEach(fields, function(field, fieldName) {
         let verrors = []
@@ -131,8 +133,11 @@ module.exports = {
           }
         }
 
+        // console.log(333,path3)
+
         // Ignore blacklisted
         if (this._pathBlacklisted(path3, opts.projectionValidate) && !schema.defaultOverride) return
+        // console.log(444,path3)
         // Ignore insert only
         if (opts.update && schema.insertOnly) return
         // Ignore virtual fields
@@ -141,6 +146,7 @@ module.exports = {
         if (isTypeRule && util.isFunction(isTypeRule.tryParse)) {
           value = isTypeRule.tryParse.call(dataRoot, value, fieldName, this)
         }
+        // console.log(555,path3)
 
         // Schema field (ignore object/array schemas)
         if (util.isSchema(field) && fieldName !== 'schema') {

package/lib/model.js

@@ -14,16 +14,18 @@ let Model = module.exports = function(name, opts, manager) {
    */
   if (!(this instanceof Model)) {
     return new Model(name, opts, this)
-
   } else if (!name) {
     throw 'No model name defined'
-
   } else if (name.match(/^_/)) {
     throw 'Model names cannot start with an underscore'
+  } else if (!opts) {
+    throw `No model definition passed for "${name}"`
+  } else if (!opts.fields) {
+    throw `We couldn't find ${name}.fields in the model definition, the model maybe setup ` 
+      + `or exported incorrectly:\n${JSON.stringify(opts, null, 2)}`
   }
 
   // Add schema options
-  opts = opts || {}
   Object.assign(this, {
     ...(opts.methods || {}),
     afterFind: opts.afterFind || [],
@@ -37,14 +39,14 @@ let Model = module.exports = function(name, opts, manager) {
     error: manager.error,
     info: manager.info,
     warn: manager.warn,
-    insertBL: opts.insertBL || [],
+    insertBL: opts.insertBL || ['_id'],
     fields: { ...(util.deepCopy(opts.fields) || {}) },
     findBL: opts.findBL || ['password'],
     manager: manager,
     messages: opts.messages || {},
     name: name,
     rules: { ...(opts.rules || {}) },
-    updateBL: opts.updateBL || [],
+    updateBL: opts.updateBL || ['_id'],
   })
 
   // Run before model hooks
@@ -69,7 +71,7 @@ let Model = module.exports = function(name, opts, manager) {
   }, this)
 
   // Extend default fields with passed in fields and check for invalid fields
-  this._setupFields(this.fields = Object.assign({}, this._timestampFields, this.fields))
+  this._setupFields(this.fields = Object.assign({}, this._defaultFields, this.fields))
   this.fieldsFlattened = this._getFieldsFlattened(this.fields, '') // test output?
 
   // Extend model with monk collection queries
@@ -319,7 +321,11 @@ Model.prototype._setupIndexes = function(fields, opts={}) {
   }
 }
 
-Model.prototype._timestampFields = {
+Model.prototype._defaultFields = {
+  _id: {
+    insertOnly: true,
+    type: 'id'
+  },
   createdAt: {
     default: function(fieldName, model) {
       return model.manager.useMilliseconds? Date.now() : Math.floor(Date.now() / 1000)

package/package.json

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

package/test/blacklisting.js

@@ -339,7 +339,7 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
-  test('insert update blacklisting (validate)', async () => {
+  test('insert blacklisting (validate)', async () => {
     // Setup
     let db = (await opendb(null)).db
     let user = db.model('user', {
@@ -365,15 +365,21 @@ module.exports = function(monastery, opendb) {
         }
       },
       insertBL: [
+        '_id', // default
         'dog',
         'animals.cat',
         'pets.age',
         'hiddenPets',
         'hiddenList',
         'deep.deep2.deep3'
-      ]
+      ],
+      updateBL: [
+        '_id' // default
+      ],
     })
+    let doc1Id = db.id()
     let doc1 = {
+      _id: doc1Id,
       list: [44, 54],
       dog: 'Bruce',
       pet: 'Freddy',
@@ -409,9 +415,10 @@ module.exports = function(monastery, opendb) {
       }
     })
 
-    // Custom blacklist (remove and add to the current schema blacklist)
+    // Custom insert blacklist (remove and add to the current schema blacklist)
     let user2 = await user.validate(doc1, {
       blacklist: [
+        '-_id',
         '-dog',
         '-animals.dog', // wrong property
         'pets.name',
@@ -421,6 +428,7 @@ module.exports = function(monastery, opendb) {
     })
     let customBlacklist
     expect(user2).toEqual((customBlacklist = {
+      _id: doc1Id,
       list: [44, 54],
       dog: 'Bruce',
       pet: 'Freddy',
@@ -440,7 +448,7 @@ module.exports = function(monastery, opendb) {
 
     // Blacklist string
     let user3 = await user.validate(doc1, {
-      blacklist: '-dog -animals.dog pets.name -hiddenList -deep'
+      blacklist: '-_id -dog -animals.dog pets.name -hiddenList -deep'
     })
     expect(user3).toEqual(customBlacklist)
 
@@ -467,6 +475,14 @@ module.exports = function(monastery, opendb) {
         }
       }
     })
+
+    // double check that _id.insertOnly is working
+    let user6 = await user.validate(doc1, { update: true, blacklist: false })
+    expect(user6).toEqual({
+      ...doc1,
+      _id: undefined,
+    })
+
     db.close()
   })
 

package/test/model.js

@@ -13,7 +13,12 @@ module.exports = function(monastery, opendb) {
     }})
 
     // no fields defined
-    expect(db.model('user2').fields).toEqual({
+    expect(db.model('user2', { fields: {} }).fields).toEqual({
+      _id: {
+         insertOnly: true,
+         isId: true,
+         type: 'id',
+       },
       createdAt: {
          default: expect.any(Function),
          insertOnly: true,
@@ -73,7 +78,12 @@ module.exports = function(monastery, opendb) {
     let db = (await opendb(false, { defaultObjects: true })).db
 
     // Default fields
-    expect(db.model('user2').fields).toEqual({
+    expect(db.model('user2', { fields: {} }).fields).toEqual({
+      _id: {
+        insertOnly: true,
+        isId: true,
+        type: 'id',
+      },
       createdAt: {
         default: expect.any(Function),
         insertOnly: true,
@@ -195,7 +205,7 @@ module.exports = function(monastery, opendb) {
     }
 
     // Unique & text index (after model initialisation, in serial)
-    let userIndexRawModel = db.model('userIndexRaw', {})
+    let userIndexRawModel = db.model('userIndexRaw', {fields: {}})
     await userIndexRawModel._setupIndexes({
       email: { type: 'string', index: 'unique' },
     })

package/test/monk.js

@@ -4,8 +4,8 @@ module.exports = function(monastery, opendb) {
     // Setup
     let db = (await opendb(false)).db
     let monkdb = require('monk')(':badconnection', () => {})
-    db.model('user', {})
-    let modelNamedConnected = db.model('connected', {})
+    db.model('user', { fields: {} })
+    let modelNamedConnected = db.model('connected', { fields: {} })
 
     // Any of our monastery properties already exist on the manager?
     for (let name of ['connected', 'debug', 'log', 'model', 'models']) {

package/test/validate.js

@@ -765,6 +765,11 @@ module.exports = function(monastery, opendb) {
     // Subdocument -> array -> subdocument data (empty)
     await expect(user.validate({ animals: { dogs: [{}] }}))
       .resolves.toEqual({ animals: { dogs: [{}] }})
+
+    // _id is blacklisted by default
+    let id = db.id()
+    await expect(user.validate({ _id: id })).resolves.toEqual({})
+    await expect(user.validate({ _id: id }, { update: true })).resolves.toEqual({})
   })
 
   test('schema options', async () => {