monastery 1.40.5 → 1.41.0

package/changelog.md

@@ -2,6 +2,8 @@
 
 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.41.0](https://github.com/boycce/monastery/compare/1.40.5...1.41.0) (2023-04-16)
+
 ### [1.40.5](https://github.com/boycce/monastery/compare/1.40.4...1.40.5) (2023-02-22)
 
 ### [1.40.4](https://github.com/boycce/monastery/compare/1.40.3...1.40.4) (2022-12-21)

package/docs/model/remove.md

@@ -13,6 +13,7 @@ Remove document(s) in a collection and calls model hooks: `beforeRemove`,  `afte
 
 - `query` *(object\|id)*: [`MongoDB query document`](https://www.mongodb.com/docs/v4.4/tutorial/query-documents/), or id
 - [`sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
+- [`multi`] *(boolean)*: set to false remove only the first document that match the query criteria
 - [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#remove)] *(any)*
 
 [`callback`] *(function)*: pass instead of return a promise

package/lib/model.js

@@ -131,6 +131,25 @@ Model.prototype._setupFields = function(fields) {
    * @param {object|array} fields - subsdocument or array
    */
   util.forEach(fields, function(field, fieldName) {
+    // Preprocess type objects
+    if (util.isSchema(field) && typeof field.type == 'object') {
+      if (field.schema) {
+        this.error(`Field "${fieldName}.schema" on model "${this.name}" is ignored when using `
+        + 'object types, simply define the schema fields alongside field.type.')
+        delete fields[fieldName]
+        return
+      }
+      if (util.isSchema(field.type)) {
+        this.error(`"${fieldName}.type" on model "${this.name}" is a schema object, it must be either a ` 
+        + 'string, subdocument or array')
+        delete fields[fieldName]
+        return
+      }
+      let fieldCache = field
+      field = fields[fieldName] = field.type
+      field.schema = util.omit(fieldCache, ['type'])
+    }
+    
     // Schema field
     if (util.isSchema(field)) {
       // No image schema pre-processing done yet by a plugin
@@ -195,7 +214,13 @@ Model.prototype._setupFields = function(fields) {
         field.schema.index = index2dsphere
         delete field.index
       }
-      field.schema = { type: 'object', isObject: true, default: objectDefault, nullObject: nullObject, ...field.schema }
+      field.schema = { 
+        type: 'object', 
+        isObject: true, 
+        default: objectDefault, 
+        nullObject: nullObject, 
+        ...field.schema 
+      }
       this._setupFields(field)
     }
   }, this)

package/package.json

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

package/test/model.js

@@ -68,6 +68,58 @@ module.exports = function(monastery, opendb) {
     ))
   })
 
+  test('model setup with type object', async () => {
+    // Setup
+    let db = (await opendb(false)).db
+    let user = db.model('user', { fields: {
+      name: { 
+        type: { cat: { type: 'string' }}, // subdocument
+        minLength: 4,
+      },
+      name2: { 
+        type: [{ type: 'string' }], // array
+        minLength: 4,
+      },
+    }})
+
+    // subdocument object type
+    expect(user.fields.name).toEqual({
+      cat: { isString: true, type: 'string' },
+      schema: { isObject: true, type: 'object', minLength: 4 }
+    })
+    // array object type
+    expect(JSON.stringify(user.fields.name2)).toEqual(JSON.stringify(
+      [{ type: 'string', isString: true }]
+    ))
+    expect(user.fields.name2.schema).toEqual({ 
+      type: 'array', 
+      isArray: true,
+      minLength: 4,
+    })
+  })
+
+  test('model setup with invalid schema type object', async () => {
+    // Setup
+    let db = (await opendb(false, { hideErrors: true })).db // hide debug error
+    let user = db.model('user', { fields: {
+      // valid subdocument
+      name: { 
+        type: { type: 'string' },
+      },
+      // schema with invlaid object type
+      name2: { 
+        type: { type: 'string' },
+        minLength: 10,
+      },
+    }})
+
+    expect(user.fields.name).toEqual({
+      type: { isString: true, type: 'string' },
+      schema: { isObject: true, type: 'object' },
+    })
+    expect(user.fields.name2).toEqual(undefined)
+  })
+
   test('model setup with default fields', async () => {
     // Setup
     let db = (await opendb(false, { defaultObjects: true })).db