monastery 1.36.1 → 1.36.2

package/docs/model/index.md

@@ -8,9 +8,9 @@ has_children: true
 
 Created via [`manager.model`](../manager/model).
 
-#### Monk collection instance methods
+#### Monk collection instance operators
 
-Additionally models inherit most of the [monk collection](https://automattic.github.io/monk/docs/collection/) instance methods which are available under `model`.
+Additionally models inherit most of the [monk collection](https://automattic.github.io/monk/docs/collection/) instance operators which are available under `model`.
 
   * model.[_aggregate](https://automattic.github.io/monk/docs/collection/aggregate.html)
   * model.[_bulkWrite](https://automattic.github.io/monk/docs/collection/bulkWrite.html)

package/docs/model/insert.md

@@ -5,16 +5,17 @@ parent: Model
 
 # `model.insert`
 
-Validate and insert document(s) in a collection and call related hooks: `schema.beforeInsert`,  `schema.afterInsert`
+Validate and insert document(s) in a collection and calls model hooks: `beforeInsert`,  `afterInsert`
 
 ### Arguments
 
 `options` *(object)*
 
-- `options.data` *(object\|array)* - Data that is validated against the model schema. Key names can be in dot or bracket notation which is handy for HTML FormData.
-- [`options.skipValidation`] (string\|array): skip validation for this field name(s)
-- [`options.timestamps`] *(boolean)*: whether `createdAt` and `updatedAt` are automatically inserted, defaults to `manager.timestamps`
-- [`options.blacklist`] *(array\|string\|false)*: augment `schema.insertBL`. `false` will remove all blacklisting
+- `data` *(object\|array)* - Data that is validated against the model fields. Key names can be in dot or bracket notation which is handy for HTML FormData.
+- [[`blacklist`](#blacklisting)] *(array\|string\|false)*: augment `definition.insertBL`. `false` will remove all blacklisting
+- [`project`] *(string\|array\|object)*: project these fields, ignores blacklisting
+- [`skipValidation`] (string\|array): skip validation for this field name(s)
+- [`timestamps`] *(boolean)*: whether `createdAt` and `updatedAt` are automatically inserted, defaults to `manager.timestamps`
 - [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#insert)] *(any)*
 
 [`callback`] *(function)*: pass instead of return a promise
@@ -32,32 +33,33 @@ user.insert({ data: [{ name: 'Martin Luther' }, { name: 'Bruce Lee' }]})
 
 ### Blacklisting
 
-You can augment the model's `schema.insertBL` blacklist by passing a custom `blacklist`:
+You can augment the model's blacklist (`definition.insertBL`) by passing a custom `blacklist`:
 
 ```js
 // Prevents `name` and `pets.$.name` (array) from being returned.
 user.insert({ data: {}, blacklist: ['name', 'pets.name'] })
-// You can also whitelist any blacklisted fields found in schema.insertBL
+// You can also whitelist any blacklisted fields found in definition.insertBL
 user.insert({ data: {}, blacklist: ['-name', '-pet'] })
 ```
 
 ### Defaults example
 
-When defaultObjects is enabled, undefined subdocuments and arrays will default to `{}` `[]` respectively when inserting. You can enable `defaultObjects` via the [manager options](../manager#arguments).
+When defaultObjects is enabled, undefined embedded documents and arrays will default to `{}` `[]` respectively when inserting. You can enable `defaultObjects` via the [manager options](../manager#arguments).
 
 ```js
-db.model({ fields: {
-  names: [{ type: 'string' }],
-  pets: {
-    name: { type: 'string' },
-    colors: [{ type: 'string' }]
+db.model({
+  fields: {
+    names: [{ type: 'string' }],
+    pets: {
+      name: { type: 'string' },
+      colors: [{ type: 'string' }]
+    }
   }
-}})
-
-user.insert({ data: {} }).then(data => {
-  // data = {
-  //   names: [],
-  //   pets: { colors: [] }
-  // }
 })
+
+await user.insert({ data: {} })
+// data = {
+//   names: [],
+//   pets: { colors: [] }
+// }
 ```

package/docs/model/remove.md

@@ -5,14 +5,14 @@ parent: Model
 
 # `model.remove`
 
-Remove document(s) in a collection and call related hooks: `schema.beforeRemove`,  `schema.afterRemove`
+Remove document(s) in a collection and calls model hooks: `beforeRemove`,  `afterRemove`
 
 ### Arguments
 
 `options` *(object)*
 
-- `options.query` *(object\|id)*
-- [`options.sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
+- `query` *(object\|id)*
+- [`sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
 - [[`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/docs/model/update.md

@@ -5,18 +5,19 @@ parent: Model
 
 # `model.update`
 
-Update document(s) in a collection and call related hooks: `schema.beforeUpdate`,  `schema.afterUpdate`. By default this method method updates a single document. Set the `multi` mongodb option to update all documents that match the query criteria.
+Update document(s) in a collection and calls model hooks: `beforeUpdate`,  `afterUpdate`. By default this method method updates a single document. Set the `multi` mongodb option to update all documents that match the query criteria.
 
 ### Arguments
 
 `options` *(object)*
 
-- `options.query` *(object\|id)*
-- `options.data` *(object)* - data that's validated against the model schema and then wrapped in `{ $set: .. }`, [`more below`](#data)
-- [`options.skipValidation`] (string\|array): skip validation for this field name(s)
-- [`options.sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
-- [`options.timestamps`] *(boolean)*: whether `updatedAt` is automatically updated, defaults to the `manager.timestamps` value
-- [`options.blacklist`] *(array\|string\|false)*: augment `schema.updateBL`. `false` will remove all blacklisting
+- `query` *(object\|id)*
+- [`data`](#data) *(object)* - data that's validated against the model fields (always wrapped in `{ $set: .. }`)
+- [[`blacklist`](#blacklisting)]*(array\|string\|false)*: augment `definition.updateBL`. `false` will remove all blacklisting
+- [`project`] *(string\|array\|object)*: project these fields, ignores blacklisting
+- [`skipValidation`] (string\|array): skip validation for this field name(s)
+- [`sort`] *(string\|object\|array)*: same as the mongodb option, but  allows for string parsing e.g. 'name', 'name:1'
+- [`timestamps`] *(boolean)*: whether `updatedAt` is automatically updated, defaults to the `manager.timestamps` value
 - [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#update)] *(any)*
 
 [`callback`] *(function)*: pass instead of return a promise
@@ -33,7 +34,7 @@ user.update({ query: { name: 'foo' }, data: { name: 'bar' }})
 
 ### Data
 
-Data that is validated against the model schema and then wrapped in `{ $set: .. }`. Key names can be in dot or bracket notation which is handy for HTML FormData.
+Data that's validated against the model fields (always wrapped in `{ $set: .. }`). Key names can be in dot or bracket notation which is handy for HTML FormData.
 
 You can also pass `options.$set` or any other mongodb update operation instead of `options.data`, which bypasses validation, e.g.
 
@@ -48,10 +49,10 @@ user.update({ query: {}, $pull: { name: 'Martin', badField: 1 }})
 
 ### Blacklisting
 
-You can augment the model's `schema.updateBL` blacklist by passing a custom `blacklist`:
+You can augment the model's blacklist (`updateBL`) by passing a custom `blacklist`:
 
 ```js
 // Prevents `name` and `pets.$.name` (array) from being returned.
 user.update({ query: {}, data: {}, blacklist: ['name', 'pets.name'] })
-// You can also whitelist any blacklisted fields found in schema.updateBL
+// You can also whitelist any blacklisted fields found in updateBL
 user.update({ query: {}, data: {}, blacklist: ['-name', '-pet'] })

package/docs/model/validate.md

@@ -5,7 +5,7 @@ parent: Model
 
 # `model.validate`
 
-Validate a model and call related hook: `schema.beforeValidate`
+Validate a model and calls the model hook: `beforeValidate`
 
 
 ### Arguments
@@ -14,10 +14,11 @@ Validate a model and call related hook: `schema.beforeValidate`
 
 [`options`] *(object)*
 
-- [`options.skipValidation`] (string\|array): skip validation for this field name(s)
-- [`options.blacklist`] *(array\|string\|false)*: augment the model's blacklist. `false` will remove all blacklisting
-- [`options.timestamps`] *(boolean)*: whether `createdAt` and `updatedAt` are inserted, or `updatedAt` is updated, depending on the `options.update` value. Defaults to the `manager.timestamps` value
-- [`options.update`] *(boolean)*: If true, required rules will be skipped, defaults to false
+- [`skipValidation`] (string\|array): skip validation for this field name(s)
+- [[`blacklist`](#blacklisting)] *(array\|string\|false)*: augment the model's blacklist. `false` will remove all blacklisting
+- [`project`] *(string\|array\|object)*: project these fields, ignores blacklisting
+- [`timestamps`] *(boolean)*: whether `createdAt` and `updatedAt` are inserted, or `updatedAt` is updated, depending on the `update` value. Defaults to the `manager.timestamps` value
+- [`update`] *(boolean)*: If true, required rules will be skipped, defaults to false
 
 ### Returns
 
@@ -34,39 +35,35 @@ db.model('user', {
   }
 })
 
-db.user.validate({
+await db.user.validate({
   name: 'Martin Luther',
   unknownField: 'Some data'
-
-}).then(data => {
-  // { name: "Martin Luther" }
 })
+// { name: "Martin Luther" }
 
-db.user.validate({
+await db.user.validate({
   name: 'Martin Luther'
   address: { city: 'Eisleben' }
-
-}).catch(errs => {
-  // [{
-  //   detail: "Value needs to be at least 10 characters long.",
-  //   status: "400",
-  //   title: "address.city",
-  //   meta: {
-  //     field: "city",
-  //     model: "user",
-  //     rule: "minLength"
-  //   }
-  // }]
 })
-
+// Error [{
+//   detail: "Value needs to be at least 10 characters long.",
+//   status: "400",
+//   title: "address.city",
+//   meta: {
+//     field: "city",
+//     model: "user",
+//     rule: "minLength"
+//   }
+// }]
 ```
+
 ### Blacklisting
 
-Depending on the `update` option, you can augment the model's `schema.insertBL` or `schema.updateBL` by passing a custom `blacklist`:
+Depending on the `update` option, you can augment the model's `insertBL` or `updateBL` by passing a custom `blacklist`:
 
 ```js
 // Prevents `name` and `pets.$.name` (array) from being returned.
 user.validate({}, { blacklist: ['name', 'pets.name'] })
-// You can also whitelist any blacklisted fields found in schema's blacklist
+// You can also whitelist any blacklisted fields found in insertBL/updateBL
 user.validate({}, { blacklist: ['-name', '-pet'] })
 ```

package/docs/readme.md

@@ -6,8 +6,8 @@
 
 * User friendly API design, built around the awesome [Monk](https://automattic.github.io/monk/)
 * Simple CRUD operations with model population
-* Model validation deriving from your schema
-* Custom error messages can be defined in your schema
+* Model validation deriving from your model definitions
+* Custom error messages can be defined in your model definition
 * Normalised error responses ready for client consumption
 * Automatic mongodb index setup
 
@@ -83,15 +83,16 @@ Coming soon...
 
 ## Roadmap
 
+- Add Aggregate
 - ~~Add FindOneAndUpdate~~
-- Add before/afterInsertUpdate
+- ~~Add beforeInsertUpdate / afterInsertUpdate~~
 - Bug: Setting an object literal on an ID field ('model') saves successfully
 - Population within array items
 - ~~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
+- Automatic embedded document ids/createdAt/updatedAt fields
 - Remove ACL default 'public read'
 - ~~Public db.arrayWithSchema method~~
 - Global after/before hooks

package/lib/model-validate.js

@@ -245,7 +245,7 @@ module.exports = {
     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
+    if (value === null && (field.isObject || field.isArray) && field.nullObject && !rule.validateNull) return
 
     // Ignore null
     if (value === null && !(field.isObject || field.isArray) && !rule.validateNull) return

package/package.json

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

package/test/crud.js

@@ -335,7 +335,7 @@ module.exports = function(monastery, opendb) {
 
   test('find default field population', async () => {
     let db = (await opendb(null)).db
-    let user = db.model('user', {
+    db.model('user', {
       fields: {
         name: { type: 'string', default: 'Martin Luther' },
         addresses: [{ city: { type: 'string' }, country: { type: 'string', default: 'Germany' } }],
@@ -344,7 +344,7 @@ module.exports = function(monastery, opendb) {
         dogs: [{ model: 'dog' }], // virtual association
       }
     })
-    let dog = db.model('dog', {
+    db.model('dog', {
       fields: {
         name: { type: 'string', default: 'Scruff' },
         user: { model: 'user' }
@@ -352,35 +352,35 @@ module.exports = function(monastery, opendb) {
     })
 
     // Default field doesn't override null
-    let nulldoc1 = await dog.insert({ data: { name: null }})
-    let nullfind1 = await dog.findOne({ query: nulldoc1._id })
+    let nulldoc1 = await db.dog.insert({ data: { name: null }})
+    let nullfind1 = await db.dog.findOne({ query: nulldoc1._id })
     expect(nullfind1).toEqual({ _id: nulldoc1._id, name: null })
 
     // Default field doesn't override empty string
-    let nulldoc2 = await dog.insert({ data: { name: '' }})
-    let nullfind2 = await dog.findOne({ query: nulldoc2._id })
+    let nulldoc2 = await db.dog.insert({ data: { name: '' }})
+    let nullfind2 = await db.dog.findOne({ query: nulldoc2._id })
     expect(nullfind2).toEqual({ _id: nulldoc2._id, name: '' })
 
     // Default field overrides undefined
-    let nulldoc3 = await dog.insert({ data: { name: undefined }})
-    let nullfind3 = await dog.findOne({ query: nulldoc3._id })
+    let nulldoc3 = await db.dog.insert({ data: { name: undefined }})
+    let nullfind3 = await db.dog.findOne({ query: nulldoc3._id })
     expect(nullfind3).toEqual({ _id: nullfind3._id, name: 'Scruff' })
 
     // Default field population test
-    // Note that addresses.1.country shouldn't be overriden
+    // Note that addresses.1.country shouldn't be overridden
     // Insert documents (without defaults)
-    let inserted = await dog._insert({})
-    let inserted2 = await user._insert({
+    let dog1 = await db.dog._insert({})
+    let user1 = await db.user._insert({
       addresses: [
         { city: 'Frankfurt' },
         { city: 'Christchurch', country: 'New Zealand' }
       ],
-      pet: { dog: inserted._id }
+      pet: { dog: dog1._id }
     })
-    await dog._update(inserted._id, { $set: { user: inserted2._id }})
+    await db.dog._update(dog1._id, { $set: { user: user1._id }})
 
-    let find1 = await user.findOne({
-      query: inserted2._id,
+    let find1 = await db.user.findOne({
+      query: user1._id,
       populate: ['pet.dog', {
         from: 'dog',
         localField: '_id',
@@ -389,20 +389,20 @@ module.exports = function(monastery, opendb) {
       }]
     })
     expect(find1).toEqual({
-      _id: inserted2._id,
+      _id: user1._id,
       name: 'Martin Luther',
       addresses: [
         { city: 'Frankfurt', country: 'Germany' },
         { city: 'Christchurch', country: 'New Zealand' }
       ],
       address: { country: 'Germany' },
-      pet: { dog: { _id: inserted._id, name: 'Scruff', user: inserted2._id }},
-      dogs: [{ _id: inserted._id, name: 'Scruff', user: inserted2._id }]
+      pet: { dog: { _id: dog1._id, name: 'Scruff', user: user1._id }},
+      dogs: [{ _id: dog1._id, name: 'Scruff', user: user1._id }]
     })
 
     // Blacklisted default field population test
-    let find2 = await user.findOne({
-      query: inserted2._id,
+    let find2 = await db.user.findOne({
+      query: user1._id,
       populate: ['pet.dog', {
         from: 'dog',
         localField: '_id',
@@ -413,11 +413,11 @@ module.exports = function(monastery, opendb) {
       // ^ great test (address should cancel addresses if not stopping at the .)
     })
     expect(find2).toEqual({
-      _id: inserted2._id,
+      _id: user1._id,
       name: 'Martin Luther',
       addresses: [{ city: 'Frankfurt' }, { city: 'Christchurch' }],
-      pet: { dog: { _id: inserted._id, name: 'Scruff', user: inserted2._id }},
-      dogs: [{ _id: inserted._id, user: inserted2._id }]
+      pet: { dog: { _id: dog1._id, name: 'Scruff', user: user1._id }},
+      dogs: [{ _id: dog1._id, user: user1._id }]
     })
 
     db.close()

package/test/test.js

@@ -12,6 +12,8 @@
  *   - expect.objectContaining:
  */
 
+global.oid = require('mongodb').ObjectID
+
 let monastery = require('../lib')
 let opendb = async function(uri, opts) {
   let db = monastery(

package/test/validate.js

@@ -808,8 +808,10 @@ module.exports = function(monastery, opendb) {
     })
   })
 
-  test('schema default rules', async () => {
+  test('schema options default', async () => {
     // Setup
+    // todo: test objects
+    // todo: change test name
     let db = (await opendb(false)).db
     let user = db.model('user', { fields: {
       name: { type: 'string', minLength: 7 },
@@ -889,7 +891,35 @@ module.exports = function(monastery, opendb) {
     await expect(user.validate({ amount: 'bad' })).rejects.toContainEqual(mock2)
   })
 
-  test('schema default objects', async () => {
+  test('schema options objects', async () => {
+    let db = (await opendb(null, {
+      timestamps: false,
+      nullObjects: true,
+      serverSelectionTimeoutMS: 2000
+    })).db
+    let user = db.model('user', {
+      fields: {
+        location: {
+          lat: { type: 'number' },
+          lng: { type: 'number' },
+          schema: { required: true },
+        },
+      },
+    })
+
+    // Subdocument data (null/string)
+    await expect(user.validate({ location: null })).rejects.toEqual([{
+      'detail': 'This field is required.',
+      'meta': {'detailLong': undefined, 'field': 'location', 'model': 'user', 'rule': 'required'},
+      'status': '400',
+      'title': 'location'
+    }])
+    await expect(user.validate({ location: {} })).resolves.toEqual({ location: {} })
+
+    db.close()
+  })
+
+  test('validate defaultObjects', async () => {
     let db = (await opendb(null, {
       timestamps: false,
       defaultObjects: true,
@@ -915,7 +945,7 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
-  test('schema nullObjects', async () => {
+  test('validate nullObjects', async () => {
     let db = (await opendb(null, {
       timestamps: false,
       nullObjects: true,