monastery 1.31.7 → 1.32.0

package/changelog.md

@@ -2,6 +2,14 @@
 
 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.32.0](https://github.com/boycce/monastery/compare/1.31.7...1.32.0) (2022-02-28)
+
+
+### Features
+
+* added getSignedUrl(s) ([3552a4d](https://github.com/boycce/monastery/commit/3552a4d0b21c192a256a590e3ac1cb48b31c6564))
+* added image optiosn filename, and params ([353b2f0](https://github.com/boycce/monastery/commit/353b2f09ed429a5cd8d74a3b2e94493650fb52e4))
+
 ### [1.31.7](https://github.com/boycce/monastery/compare/1.31.6...1.31.7) (2022-02-28)
 
 

package/docs/image-plugin.md

@@ -26,9 +26,12 @@ Then in your model schema, e.g.
 ```js
 let user = db.model('user', { fields: {
   logo:  {
-    type: 'image',
-    formats: ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'], // optional plugin rule
-    fileSize: 1000 * 1000 * 5 // optional plugin rule, size in bytes
+    type: 'image', // required
+    formats: ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'],
+    filename: 'avatar',
+    filesize: 1000 * 1000 * 5, // max size in bytes
+    getSignedUrl: true, // get a s3 signed url by default after `find()`
+    params: {}, // upload params, https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property
   },
   logos: [{
     type: 'image'
@@ -61,4 +64,3 @@ user.update({
 Due to known limitations, we are inaccurately able to validate non-binary file types (e.g. txt, svg) before uploading to S3, and rely on their file processing to remove any malicious files.
 
 ...to be continued
-

package/docs/model/find.md

@@ -15,6 +15,7 @@ Find document(s) in a collection and call related hook: `schema.afterFind`
 - [[`options.populate`](#populate)] *(array)*
 - [`options.sort`] *(string\|array\|object)*: same as the mongodb option, but allows string parsing e.g. 'name', 'name:1'
 - [`options.blacklist`] *(array\|string\|false)*: augment `schema.findBL`. `false` will remove all blacklisting
+- [`options.getSignedUrls`] *(boolean)*: get signed urls for all image objects
 - [`options.project`] *(string\|array\|object)*: return only these fields, ignores blacklisting
 - [[`any mongodb option`](http://mongodb.github.io/node-mongodb-native/3.2/api/Collection.html#find)] *(any)*
 

package/lib/model-crud.js

@@ -238,6 +238,7 @@ module.exports = {
      * @param {object} opts
      *     @param {object} <opts.query> - mongodb query object
      *     @param {boolean} <opts.respond> - automatically call res.json/error (requires opts.req)
+     *     @param {boolean=true} <opts.multi> - set to false to limit the deletion to just one document
      *     @param {any} <opts.any> - any mongodb option
      * @param {function} <cb> - execute cb(err, data) instead of responding
      * @this model
@@ -304,7 +305,7 @@ module.exports = {
       opts.query = util.removeUndefined(opts.query)
 
       // Query options
-      opts.limit = opts.one? 1 : parseInt(opts.limit || (type == 'remove' ? 1 : this.manager.limit || 0))
+      opts.limit = opts.one? 1 : parseInt(opts.limit || this.manager.limit || 0)
       opts.skip = Math.max(0, opts.skip || 0)
       opts.sort = opts.sort || { 'createdAt': -1 }
       if (util.isString(opts.sort)) {

package/lib/model-validate.js

@@ -290,9 +290,9 @@ module.exports = {
   },
 
   _ignoredRules: [ // todo: change name? i.e. 'specialFields'
-    // Need to remove fileSize and formats..
-    'default', 'defaultOverride', 'fileSize', 'formats', 'image', 'index', 'insertOnly', 'model',
-    'nullObject', 'timestampField', 'type', 'virtual'
+    // Need to remove filesize and formats..
+    'default', 'defaultOverride', 'filename', 'filesize', 'formats', 'image', 'index', 'insertOnly',
+    'model', 'nullObject', 'params', 'getSignedUrl', 'timestampField', 'type', 'virtual'
   ]
 
 }

package/lib/model.js

@@ -188,9 +188,12 @@ Model.prototype._setupFields = function(fields) {
 
       // Rule doesn't exist
       util.forEach(field, (rule, ruleName) => {
+        if ((this.rules[ruleName] || rules[ruleName]) && this._ignoredRules.indexOf(ruleName) != -1) {
+          this.error(`The rule name "${ruleName}" for the model "${this.name}" is a reserved keyword, ignoring rule.`)
+        }
         if (!this.rules[ruleName] && !rules[ruleName] && this._ignoredRules.indexOf(ruleName) == -1) {
           // console.log(field)
-          this.error(`No rule "${ruleName}" exists for model "${this.name}". Ignoring rule.`)
+          this.error(`No rule "${ruleName}" exists for model "${this.name}", ignoring rule.`)
           delete field[ruleName]
         }
       }, this)

package/package.json

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

package/plugins/images/index.js

@@ -32,7 +32,9 @@ let plugin = module.exports = {
       return
     }
 
-    // Create s3 service instance
+    // Create s3 'service' instance
+    // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
+    manager.getSignedUrl = this._getSignedUrl
     this.s3 = new S3({
       credentials: {
         accessKeyId: this.awsAccessKeyId,
@@ -71,6 +73,9 @@ let plugin = module.exports = {
       model.afterInsert.push(function(data, n) {
         plugin.addImages(this, data).then(() => n(null, data)).catch(e => n(e))
       })
+      model.afterFind.push(function(data, n) {
+        plugin.getSignedUrls(this, data).then(() => n(null, data)).catch(e => n(e))
+      })
     }
   },
 
@@ -121,14 +126,15 @@ let plugin = module.exports = {
         return Promise.all(filesArr.map(file => {
           return new Promise((resolve, reject) => {
             let uid = nanoid.nanoid()
+            let pathFilename = filesArr.imageField.filename ? '/' + filesArr.imageField.filename : ''
             let image = {
               bucket: this.awsBucket,
               date: this.manager.useMilliseconds? Date.now() : Math.floor(Date.now() / 1000),
               filename: file.name,
               filesize: file.size,
-              path: `${plugin.bucketDir}/${uid}.${file.ext}`,
+              path: `${plugin.bucketDir}/${uid}${pathFilename}.${file.ext}`,
               // sizes: ['large', 'medium', 'small'],
-              uid: uid
+              uid: uid,
             }
             this.manager.info(
               `Uploading '${image.filename}' to '${image.bucket}/${image.path}'`
@@ -141,7 +147,11 @@ let plugin = module.exports = {
                 Bucket: this.awsBucket,
                 Key: image.path,
                 Body: file.data,
-                ACL: 'public-read'
+                // The IAM permission "s3:PutObjectACL" must be included in the appropriate policy
+                ACL: 'public-read',
+                // upload params,https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property
+                ...filesArr.imageField.params,
+
               }, (err, response) => {
                 if (err) return reject(err)
                 plugin._addImageObjectsToData(filesArr.inputPath, data, image)
@@ -161,7 +171,7 @@ let plugin = module.exports = {
       return model._update(
         idquery,
         { '$set': prunedData },
-        { 'multi': options.multi || options.create }
+        { 'multi': options.multi || options.create },
       )
 
     // If errors, remove inserted documents to prevent double ups when the user resaves.
@@ -172,6 +182,23 @@ let plugin = module.exports = {
     })
   },
 
+  getSignedUrls: async function(options, data) {
+    // Not wanting signed urls for this operation?
+    if (util.isDefined(options.getSignedUrls) && !options.getSignedUrls) return
+
+    // Find all image objects in data
+    for (let doc of util.toArray(data)) {
+      for (let imageField of options.model.imageFields) {
+        if (options.getSignedUrls || imageField.getSignedUrl) {
+          let images = plugin._findImagesInData(doc, imageField, 0, '').filter(o => o.image)
+          for (let image of images) {
+            image.image.signedUrl = this._getSignedUrl(image.image.path)
+          }
+        }
+      }
+    }
+  },
+
   keepImagePlacement: async function(options, data) {
     /**
      * Hook before update/remove
@@ -376,7 +403,7 @@ let plugin = module.exports = {
       return Promise.all(filesArr.map((file, i) => {
         return new Promise((resolve, reject) => {
           fileType.fromBuffer(file.data).then(res => {
-            let maxSize = filesArr.imageField.fileSize
+            let maxSize = filesArr.imageField.filesize
             let formats = filesArr.imageField.formats || plugin.formats
             let allowAny = util.inArray(formats, 'any')
             file.format = res? res.ext : ''
@@ -431,7 +458,10 @@ let plugin = module.exports = {
       // Image field. Test for field.image as field.type may be 'any'
       } else if (field.type == 'image' || field.image) {
         let formats = field.formats
-        let fileSize = field.fileSize
+        let filesize = field.filesize || field.fileSize // old <= v1.31.7
+        let filename = field.filename
+        let getSignedUrl = field.getSignedUrl
+        let params = { ...field.params||{} }
         // Convert image field to subdocument
         fields[fieldName] = {
           bucket: { type: 'string' },
@@ -440,13 +470,16 @@ let plugin = module.exports = {
           filesize: { type: 'number' },
           path: { type: 'string' },
           schema: { image: true, nullObject: true, isImageObject: true },
-          uid: { type: 'string' }
+          uid: { type: 'string' },
         }
         list.push({
           fullPath: path2,
           fullPathRegex: new RegExp('^' + path2.replace(/\.[0-9]+/g, '.[0-9]+').replace(/\./g, '\\.') + '$'),
           formats: formats,
-          fileSize: fileSize
+          filesize: filesize,
+          filename: filename,
+          getSignedUrl: getSignedUrl,
+          params: params,
         })
       }
     })
@@ -495,6 +528,16 @@ let plugin = module.exports = {
     }
 
     return list
-  }
+  },
+
+  _getSignedUrl: (path, expires=3600) => {
+    // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#getSignedUrl-property
+    let signedUrl = plugin.s3.getSignedUrl('getObject', {
+      Bucket: plugin.awsBucket,
+      Key: path,
+      Expires: expires
+    })
+    return signedUrl
+  },
 
 }

package/test/crud.js

@@ -415,6 +415,40 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('remove basics', async () => {
+    let db = (await opendb(null)).db
+    let user = db.model('user', {
+      fields: {
+        name: { type: 'string' },
+      },
+    })
+
+    // Insert multiple
+    let inserted2 = await user.insert({ data: [{ name: 'Martin' }, { name: 'Martin' }, { name: 'Martin' }]})
+    expect(inserted2).toEqual([
+      {
+        _id: expect.any(Object),
+        name: 'Martin'
+      }, {
+        _id: expect.any(Object),
+        name: 'Martin'
+      }, {
+        _id: expect.any(Object),
+        name: 'Martin'
+      }
+    ])
+
+    // Remove one
+    await expect(user.remove({ query: { name: 'Martin' }, multi: false }))
+      .resolves.toMatchObject({ deletedCount: 1, result: { n: 1, ok: 1 }})
+
+    // Remove many (default)
+    await expect(user.remove({ query: { name: 'Martin' } }))
+      .resolves.toMatchObject({ deletedCount: 2, result: { n: 2, ok: 1 }})
+
+    db.close()
+  })
+
   test('hooks', async () => {
     let db = (await opendb(null)).db
     let user = db.model('user', {

package/test/model.js

@@ -115,6 +115,29 @@ module.exports = function(monastery, opendb) {
     })
   })
 
+  test('model reserved rules', async () => {
+    // Setup
+    let db = (await opendb(false, {})).db
+    db.error = () => {} // hiding debug error
+    let user = db.model('user', {
+      fields: {
+        name: {
+          type: 'string',
+          params: {}, // reserved keyword (image plugin)
+          paramsUnreserved: {}
+        },
+      },
+      rules: {
+        params: (value) => {
+          return false // shouldn'r run
+        }
+      }
+    })
+    await expect(user.validate({ name: 'Martin' })).resolves.toMatchObject({
+      name: 'Martin',
+    })
+  })
+
   test('model indexes', async () => {
     // Setup: Need to test different types of indexes
     let db = (await opendb(null)).db

package/test/plugin-images.js

@@ -707,4 +707,59 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
+  test('images getSignedUrls', async () => {
+    // latest (2022.02)
+    let db = (await opendb(null, {
+      timestamps: false,
+      serverSelectionTimeoutMS: 2000,
+      imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
+    })).db
+
+    db.model('user', { fields: {
+      photos: [{ type: 'image' }],
+      photos2: [{ type: 'image', getSignedUrl: true }],
+    }})
+
+    let image = {
+      bucket: 'test',
+      date: 1234,
+      filename: 'lion1.png',
+      filesize: 1234,
+      path: 'test/lion1.png',
+      uid: 'lion1'
+    }
+
+    let userInserted = await db.user._insert({
+      photos: [image, image],
+      photos2: [image, image],
+    })
+
+    // Find signed URL
+    await expect(db.user.findOne({ query: userInserted._id, getSignedUrls: true })).resolves.toEqual({
+      _id: expect.any(Object),
+      photos: [
+        { ...image, signedUrl: expect.stringMatching(/^https/) },
+        { ...image, signedUrl: expect.stringMatching(/^https/) },
+      ],
+      photos2: [
+        { ...image, signedUrl: expect.stringMatching(/^https/) },
+        { ...image, signedUrl: expect.stringMatching(/^https/) },
+      ]
+    })
+    // Find signed URL
+    await expect(db.user.findOne({ query: userInserted._id })).resolves.toEqual({
+      _id: expect.any(Object),
+      photos: [
+        { ...image },
+        { ...image },
+      ],
+      photos2: [
+        { ...image, signedUrl: expect.stringMatching(/^https/) },
+        { ...image, signedUrl: expect.stringMatching(/^https/) },
+      ]
+    })
+
+    db.close()
+  })
+
 }