monastery 1.38.1 → 1.38.2

package/changelog.md

@@ -2,6 +2,13 @@
 
 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.38.2](https://github.com/boycce/monastery/compare/1.38.1...1.38.2) (2022-07-31)
+
+
+### Bug Fixes
+
+* init load time ([2273f11](https://github.com/boycce/monastery/commit/2273f11a654a9cfe05ee15ed682203a8752237d6))
+
 ### [1.38.1](https://github.com/boycce/monastery/compare/1.38.0...1.38.1) (2022-06-20)
 
 

package/docs/definition/index.md

@@ -212,7 +212,10 @@ Since unique indexes by default don't allow multiple documents with `null`, you
 
 ### Custom field rules
 
-You are able to define custom field rules to use. (`this` will refer to the data object passed in)
+You are able to define custom field rules to use. 
+
+- `this` will refer to the data object passed in
+- by default, custom rules will ignore `undefined` values
 
 ```js
 {
@@ -223,6 +226,9 @@ You are able to define custom field rules to use. (`this` will refer to the data
     },
     // Full definition
     isGrandMaster: {
+      validateUndefined: false,   // default
+      validateNull: true,         // default
+      validateEmptyString: true,  // default
       message: function(value, ruleArgument, path, model) {
         return 'Only grand masters are permitted'
       },

package/docs/image-plugin.md

@@ -68,3 +68,21 @@ user.update({
 Due to known limitations, we are not able to verify the contents of non-binary files, only the filename extension (e.g. .txt, .svg) before uploading to S3
 
 ...to be continued
+
+### Image sizes
+
+I've put together a AWS Lambda function which you can use to generate small/medium/large image sizes automatically for any new files uploaded to your bucket.
+[https://github.com/boycce/s3-lambda-thumbnail-generator](https://github.com/boycce/s3-lambda-thumbnail-generator#install-bucket)
+
+You can override the function's default image sizes via the `metadata` option globally in the manager options, or per file:
+```js
+// Per file
+let user = db.model('user', {
+  fields: {
+    logo:  {
+      type: 'image',
+      metadata: { small: '*x300', medium: '*x800', large: '*x1200' },
+    },
+  }
+}
+```

package/docs/model/find.md

@@ -74,7 +74,7 @@ user.find({ query: {...}, populate: ['myBook'] })
 ```
 
 You can also populate within embedded document fields. Although at this time arrays are not supported,
-you would need to use the [example below](#more-control).
+you would need to use the [example below](#populate-multiple-documents-into-virtual-fields).
 ```js
 user.find({ query: {...}, populate: ['myBooks.book'] })
 ```

package/docs/model/insert.md

@@ -14,7 +14,7 @@ Validate and insert document(s) in a collection and calls model hooks: `beforeIn
 - `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)
+- [`skipValidation`] (string\|array\|boolean): skip validation for these field name(s), or `true` for all fields
 - [`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)*
 

package/docs/model/update.md

@@ -15,7 +15,7 @@ Update document(s) in a collection and calls model hooks: `beforeUpdate`,  `afte
 - [`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)
+- [`skipValidation`] (string\|array\|boolean): skip validation for these field name(s), or `true` for all fields
 - [`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)*

package/docs/model/validate.md

@@ -14,7 +14,7 @@ Validate a model and calls the model hook: `beforeValidate`
 
 [`options`] *(object)*
 
-- [`skipValidation`] (string\|array): skip validation for this field name(s)
+- [`skipValidation`] (string\|array\/boolean): skip validation for thse field name(s), or `true` for all fields
 - [[`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

package/docs/readme.md

@@ -96,9 +96,16 @@ Coming soon...
 - ~~Ability to change ACL default on the manager~~
 - ~~Public db.arrayWithSchema method~~
 - Global after/before hooks
+- before hooks can receive a data array, remove this
 - docs: Make the implicit ID query conversion more apparent
 - Split away from Monk (unless updated)
 
+## Versions
+
+- Monk: `v7.3.4`
+- MongoDB NodeJS driver: `v3.2.3` ([compatibility](https://www.mongodb.com/docs/drivers/node/current/compatibility/#compatibility))
+- MongoDB: [`v4.0.0`](https://www.mongodb.com/docs/v4.2/reference/)
+
 ## Special Thanks
 
 [Jerome Gravel-Niquet](https://github.com/jeromegn)

package/lib/rules.js

@@ -1,7 +1,6 @@
 // Todo: remove stringnums in date/number/integer rules
 let ObjectId = require('mongodb').ObjectId
 let util = require('./util')
-let validator = require('validator')
 
 module.exports = {
 
@@ -175,31 +174,31 @@ module.exports = {
   },
   isAfter: {
     message: (x, arg) => 'Value was before the configured time (' + arg + ')',
-    fn: function(x, arg) { return validator.isAfter(x, arg) }
+    fn: function(x, arg) { return require('validator').isAfter(x, arg) }
   },
   isBefore: {
     message: (x, arg) => 'Value was after the configured time (' + arg + ')',
-    fn: function(x, arg) { return validator.isBefore(x, arg) }
+    fn: function(x, arg) { return require('validator').isBefore(x, arg) }
   },
   isCreditCard: {
     message: 'Value was not a valid credit card.',
-    fn: function(x, arg) { return validator.isCreditCard(x, arg) }
+    fn: function(x, arg) { return require('validator').isCreditCard(x, arg) }
   },
   isEmail: {
     message: 'Please enter a valid email address.',
-    fn: function(x, arg) { return validator.isEmail(x, arg) }
+    fn: function(x, arg) { return require('validator').isEmail(x, arg) }
   },
   isHexColor: {
     message: 'Value was not a valid hex color.',
-    fn: function(x, arg) { return validator.isHexColor(x, arg) }
+    fn: function(x, arg) { return require('validator').isHexColor(x, arg) }
   },
   isIn: {
     message: (x, arg) => 'Value was not in the configured whitelist (' + arg.join(', ') + ')',
-    fn: function(x, arg) { return validator.isIn(x, arg) }
+    fn: function(x, arg) { return require('validator').isIn(x, arg) }
   },
   isIP: {
     message: 'Value was not a valid IP address.',
-    fn: function(x, arg) { return validator.isIP(x, arg) }
+    fn: function(x, arg) { return require('validator').isIP(x, arg) }
   },
   isNotEmptyString: {
     validateEmptyString: true,
@@ -210,15 +209,15 @@ module.exports = {
   },
   isNotIn: {
     message: (x, arg) => 'Value was in the configured blacklist (' + arg.join(', ') + ')',
-    fn: function(x, arg) { return !validator.isIn(x, arg) }
+    fn: function(x, arg) { return !require('validator').isIn(x, arg) }
   },
   isURL: {
     message: 'Value was not a valid URL.',
-    fn: function(x, arg) { return validator.isURL(x, arg === true? undefined : arg) }
+    fn: function(x, arg) { return require('validator').isURL(x, arg === true? undefined : arg) }
   },
   isUUID: {
     message: 'Value was not a valid UUID.',
-    fn: function(x, arg) { return validator.isUUID(x) }
+    fn: function(x, arg) { return require('validator').isUUID(x) }
   },
   minLength: {
     message: function(x, arg) {
@@ -227,7 +226,7 @@ module.exports = {
     },
     fn: function(x, arg) {
       if (typeof x !== 'string' && !util.isArray(x)) throw new Error ('Value was not a string or an array.')
-      else if (typeof x === 'string') return validator.isLength(x, arg)
+      else if (typeof x === 'string') return require('validator').isLength(x, arg)
       else return x.length >= arg
     }
   },
@@ -238,14 +237,14 @@ module.exports = {
     },
     fn: function(x, arg) {
       if (typeof x !== 'string' && !util.isArray(x)) throw new Error ('Value was not a string or an array.')
-      else if (typeof x === 'string') return validator.isLength(x, 0, arg)
+      else if (typeof x === 'string') return require('validator').isLength(x, 0, arg)
       else return x.length <= arg
     }
   },
   regex: {
     message: (x, arg) => 'Value did not match the configured regular expression (' + arg + ')',
     fn: function(x, arg) {
-      if (util.isRegex(arg)) return validator.matches(x, arg)
+      if (util.isRegex(arg)) return require('validator').matches(x, arg)
       throw new Error('This rule expects a regular expression to be configured, but instead got the '
         + typeof arg + ' `' + arg + '`.')
     }

package/package.json

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

package/plugins/images/index.js

@@ -1,6 +1,4 @@
-let fileType = require('file-type')
-let nanoid = require('nanoid')
-let S3 = require('aws-sdk/clients/s3')
+// requiring: nanoid, file-type, aws-sdk/clients/s3
 let util = require('../../lib/util')
 
 let plugin = module.exports = {
@@ -9,7 +7,6 @@ let plugin = module.exports = {
     /**
      * Monastery plugin that allows models to automatically process and store uploaded images
      * e.g. fields.avatar: { image: true }
-     * e.g. fields.photos: [{ image: true, //sizes: { large: [800,  600], .. } (not implemented) }]
      *
      * Note we cannot accurately test for non binary file-types, e.g. 'txt', 'csv'
      *
@@ -44,15 +41,17 @@ let plugin = module.exports = {
       return
     }
 
-    // Create s3 'service' instance
+    // Create s3 'service' instance (defer require since it takes 120ms to load)
     // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
     manager._getSignedUrl = this._getSignedUrl
-    this.s3 = new S3({
-      credentials: {
-        accessKeyId: this.awsAccessKeyId,
-        secretAccessKey: this.awsSecretAccessKey
-      }
-    })
+    this.s3 = () => {
+      return this._s3 || (this._s3 = new (require('aws-sdk/clients/s3'))({
+        credentials: {
+          accessKeyId: this.awsAccessKeyId,
+          secretAccessKey: this.awsSecretAccessKey
+        }
+      }))
+    }
 
     // Add before model hook
     manager.beforeModel.push(this.setupModel.bind(this))
@@ -141,7 +140,7 @@ let plugin = module.exports = {
       return Promise.all(files.map(filesArr => {
         return Promise.all(filesArr.map(file => {
           return new Promise((resolve, reject) => {
-            let uid = nanoid.nanoid()
+            let uid = require('nanoid').nanoid()
             let path = filesArr.imageField.path || plugin.path
             let image = {
               bucket: filesArr.imageField.awsBucket || plugin.awsBucket,
@@ -169,7 +168,7 @@ let plugin = module.exports = {
               plugin._addImageObjectsToData(filesArr.inputPath, data, image)
               resolve(s3Options)
             } else {
-              plugin.s3.upload(s3Options, (err, response) => {
+              plugin.s3().upload(s3Options, (err, response) => {
                 if (err) return reject(err)
                 plugin._addImageObjectsToData(filesArr.inputPath, data, image)
                 resolve(s3Options)
@@ -365,7 +364,7 @@ let plugin = module.exports = {
     // the file doesnt get deleted, we only delete from plugin.awsBucket.
     if (!unused.length) return
     await new Promise((resolve, reject) => {
-      plugin.s3.deleteObjects({
+      plugin.s3().deleteObjects({
         Bucket: plugin.awsBucket,
         Delete: { Objects: unused }
       }, (err, data) => {
@@ -431,7 +430,7 @@ let plugin = module.exports = {
     return Promise.all(validFiles.map(filesArr => {
       return Promise.all(filesArr.map((file, i) => {
         return new Promise((resolve, reject) => {
-          fileType.fromBuffer(file.data).then(res => {
+          require('file-type').fromBuffer(file.data).then(res => {
             let filesize = filesArr.imageField.filesize || plugin.filesize
             let formats = filesArr.imageField.formats || plugin.formats
             let allowAny = util.inArray(formats, 'any')
@@ -578,7 +577,7 @@ let plugin = module.exports = {
      * @param {number} <bucket>
      * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#getSignedUrl-property
      */
-    let signedUrl = plugin.s3.getSignedUrl('getObject', {
+    let signedUrl = plugin.s3().getSignedUrl('getObject', {
       Bucket: bucket || plugin.awsBucket,
       Expires: expires,
       Key: path,

package/test/crud.js

@@ -213,6 +213,45 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('update general max', async () => {
+    let db = (await opendb(null)).db
+    let user = db.model('user', {
+      fields: {
+        name: { type: 'string' },
+        active: { type: 'boolean' },
+      },
+    })
+
+    // Insert
+    let inserted = await user.insert({ data: { name: 'Martin Luther' }})
+
+    expect(inserted).toEqual({
+      _id: expect.any(Object),
+      name: 'Martin Luther',
+    })
+
+    let updatedUser1 = await user.update({
+      query: { _id: inserted._id },
+      data: { name: 'Martin' },
+      blacklist: ['active'],
+    })
+
+    expect(updatedUser1).toEqual({ name: 'Martin' })
+
+    let updatedUser2 = await user._update(
+      { _id: db.id(inserted._id) },
+      { $set: { name: 'Martin2' }},
+    )
+
+
+    expect(updatedUser2).toEqual({ n: 1, nModified: 1, ok: 1 })
+
+    // Mongo connected?
+    // Try native updates
+
+    db.close()
+  })
+
   test('update defaults', async () => {
     let db = (await opendb(null, { useMilliseconds: true, serverSelectionTimeoutMS: 2000 })).db
     let user = db.model('user', {

package/test/plugin-images.js

@@ -864,7 +864,7 @@ module.exports = function(monastery, opendb) {
         awsBucket: 'fake',
         awsAccessKeyId: 'fake',
         awsSecretAccessKey: 'fake',
-        metadata: { small: '*x200' , medium: '*x800', large: '*x1600' },
+        metadata: { small: '*x300' , medium: '*x800', large: '*x1200' },
         params: { ContentLanguage: 'DE'},
         path: (uid, basename, ext, file) => `images/${basename}`,
       }
@@ -908,7 +908,7 @@ module.exports = function(monastery, opendb) {
             date: expect.any(Number),
             filename: 'logo.png',
             filesize: expect.any(Number),
-            metadata: { small: '*x200' , medium: '*x800', large: '*x1600' },
+            metadata: { small: '*x300' , medium: '*x800', large: '*x1200' },
             path: 'images/logo.png',
             uid: expect.any(String),
           },
@@ -930,7 +930,7 @@ module.exports = function(monastery, opendb) {
             Bucket: 'fake',
             ContentLanguage: 'DE',
             Key: 'images/logo.png',
-            Metadata:  { small: '*x200' , medium: '*x800', large: '*x1600' },
+            Metadata:  { small: '*x300' , medium: '*x800', large: '*x1200' },
           }],
           [{
             ACL: 'public-read-write',

package/test/validate.js

@@ -816,12 +816,14 @@ module.exports = function(monastery, opendb) {
     let user = db.model('user', { fields: {
       name: { type: 'string', minLength: 7 },
       email: { type: 'string', isEmail: true },
-      names: { type: 'string', enum: ['Martin', 'Luther'] },
       amount: { type: 'number' },
     }})
     let user2 = db.model('user', { fields: {
       amount: { type: 'number', required: true },
     }})
+    let user3 = db.model('user', { fields: {
+      names: { type: 'string', enum: ['Martin', 'Luther'], default: 'Martin' },
+    }})
 
     // MinLength
     await expect(user.validate({ name: 'Martin Luther' })).resolves.toEqual({name: 'Martin Luther'})
@@ -850,8 +852,9 @@ module.exports = function(monastery, opendb) {
     })
 
     // Enum
-    await expect(user.validate({ names: 'Martin' })).resolves.toEqual({ names: 'Martin' })
-    await expect(user.validate({ names: 'bad name' })).rejects.toContainEqual({
+    await expect(user3.validate({})).resolves.toEqual({ names: 'Martin' })
+    await expect(user3.validate({ names: 'Luther' })).resolves.toEqual({ names: 'Luther' })
+    await expect(user3.validate({ names: 'bad name' })).rejects.toContainEqual({
       detail: 'Invalid enum value',
       status: '400',
       title: 'names',