monastery 1.37.1 → 1.38.0

package/changelog.md

@@ -2,6 +2,27 @@
 
 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.0](https://github.com/boycce/monastery/compare/1.37.3...1.38.0) (2022-06-17)
+
+
+### Features
+
+* added options.metadata ([cb4ca43](https://github.com/boycce/monastery/commit/cb4ca43a395c1f90a5e37b8cc95472053e2b3b36))
+
+### [1.37.3](https://github.com/boycce/monastery/compare/1.37.2...1.37.3) (2022-06-17)
+
+
+### Bug Fixes
+
+* test ([dad21ad](https://github.com/boycce/monastery/commit/dad21ad9c014a45ccc50a4755daa12941d6b7465))
+
+### [1.37.2](https://github.com/boycce/monastery/compare/1.37.1...1.37.2) (2022-06-13)
+
+
+### Bug Fixes
+
+* changed the default awsAcl from public-read to private ([ba383b5](https://github.com/boycce/monastery/commit/ba383b5f363dafe3b893e08de1a124b7ce96df44))
+
 ### [1.37.1](https://github.com/boycce/monastery/compare/1.37.0...1.37.1) (2022-06-13)
 
 

package/docs/image-plugin.md

@@ -18,7 +18,10 @@ To use the default image plugin shipped with monastery, you need to use the opti
       formats: ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'], // default (use 'any' to allow all extensions)
       getSignedUrl: false, // default (get a S3 signed url after `model.find()`, can be defined per request)
       path: (uid, basename, ext, file) => `/full/${uid}.${ext}`, // default
-      params: {}, // upload params (https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
+      metadata: {},
+      // Any s3 upload param, which takes precedence over the params above
+      // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
+      params: {},
     }
   })
 ```

package/docs/readme.md

@@ -93,7 +93,7 @@ Coming soon...
 - ~~Whitelisting a parent will remove any previously blacklisted children~~
 - ~~Blacklist/project works the same across find/insert/update/validate~~
 - Automatic embedded document ids/createdAt/updatedAt fields
-- Remove ACL default 'public read'
+- ~~Change ACL default 'public read' to 'private'~~
 - ~~Public db.arrayWithSchema method~~
 - Global after/before hooks
 - docs: Make the implicit ID query conversion more apparent

package/package.json

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

package/plugins/images/index.js

@@ -25,7 +25,7 @@ let plugin = module.exports = {
     }
 
     // Settings
-    this.awsAcl = options.awsAcl || 'public-read'
+    this.awsAcl = options.awsAcl || 'private' // default
     this.awsBucket = options.awsBucket
     this.awsAccessKeyId = options.awsAccessKeyId
     this.awsSecretAccessKey = options.awsSecretAccessKey
@@ -34,6 +34,7 @@ let plugin = module.exports = {
     this.formats = options.formats || ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff']
     this.getSignedUrl = options.getSignedUrl
     this.manager = manager
+    this.metadata = options.metadata ? util.deepCopy(options.metadata) : undefined,
     this.params = options.params ? util.deepCopy(options.params) : {},
     this.path = options.path || function (uid, basename, ext, file) { return `full/${uid}.${ext}` }
 
@@ -147,8 +148,8 @@ let plugin = module.exports = {
               date: plugin.manager.useMilliseconds? Date.now() : Math.floor(Date.now() / 1000),
               filename: file.name,
               filesize: file.size,
+              metadata: filesArr.imageField.metadata || plugin.metadata,
               path: path(uid, file.name, file.ext, file),
-              // sizes: ['large', 'medium', 'small'],
               uid: uid,
             }
             let s3Options = {
@@ -158,6 +159,7 @@ let plugin = module.exports = {
               Body: file.data,
               Bucket: image.bucket,
               Key: image.path,
+              Metadata: image.metadata,
               ...(filesArr.imageField.params || plugin.params),
             }
             plugin.manager.info(
@@ -347,11 +349,12 @@ let plugin = module.exports = {
       if (useCount[key] > 0) continue
       let pre = preExistingImages.find(o => o.image.uid == key)
       unused.push(
-        // original key can have a different extension
+        // original key can have a different extension, but always expect generated assets
+        // to be in jpg
         { Key: pre.image.path },
         { Key: `small/${key}.jpg` },
         { Key: `medium/${key}.jpg` },
-        { Key: `large/${key}.jpg` }
+        { Key: `large/${key}.jpg` },
       )
       plugin.manager.info(
         `Removing '${pre.image.filename}' from '${pre.image.bucket}/${pre.image.path}'`
@@ -504,6 +507,7 @@ let plugin = module.exports = {
           fullPath: path2,
           fullPathRegex: new RegExp('^' + path2.replace(/\.[0-9]+/g, '.[0-9]+').replace(/\./g, '\\.') + '$'),
           getSignedUrl: field.getSignedUrl,
+          metadata: field.metadata ? util.deepCopy(field.metadata) : undefined,
           path: field.path,
           params: field.params ? util.deepCopy(field.params) : undefined,
         })
@@ -513,6 +517,7 @@ let plugin = module.exports = {
           date: { type: 'number' },
           filename: { type: 'string' },
           filesize: { type: 'number' },
+          metadata: { type: 'any' },
           path: { type: 'string' },
           schema: { image: true, nullObject: true, isImageObject: true },
           uid: { type: 'string' },

package/test/plugin-images.js

@@ -75,6 +75,7 @@ module.exports = function(monastery, opendb) {
       date: { type: 'number', isNumber: true },
       filename: { type: 'string', isString: true },
       filesize: { type: 'number', isNumber: true },
+      metadata: { type: 'any', isAny: true },
       path: { type: 'string', isString: true },
       schema: {
         type: 'object', isObject: true, image: true, nullObject: true, default: undefined,
@@ -641,10 +642,11 @@ module.exports = function(monastery, opendb) {
     app.use(upload({ limits: { fileSize: 1000 * 480, files: 10 }}))
 
     // Basic tests
-    expect(plugin.awsAcl).toEqual('public-read')
+    expect(plugin.awsAcl).toEqual('private')
     expect(plugin.filesize).toEqual(undefined)
     expect(plugin.formats).toEqual(['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'])
     expect(plugin.getSignedUrl).toEqual(undefined)
+    expect(plugin.metadata).toEqual(undefined)
     expect(plugin.path).toEqual(expect.any(Function))
     expect(plugin.params).toEqual({})
 
@@ -688,7 +690,7 @@ module.exports = function(monastery, opendb) {
         // S3 options
         expect(response[1]).toEqual([
           [{
-            ACL: 'public-read',
+            ACL: 'private',
             Body: expect.any(Object),
             Bucket: 'fake',
             Key: expect.stringMatching(/^full\/.*png$/),
@@ -853,7 +855,7 @@ module.exports = function(monastery, opendb) {
     db.close()
   })
 
-  test('images options awsAcl, awsBucket, params, path', async () => {
+  test('images options awsAcl, awsBucket, metadata, params, path', async () => {
     let db = (await opendb(null, {
       timestamps: false,
       serverSelectionTimeoutMS: 2000,
@@ -862,6 +864,7 @@ module.exports = function(monastery, opendb) {
         awsBucket: 'fake',
         awsAccessKeyId: 'fake',
         awsSecretAccessKey: 'fake',
+        metadata: { small: '*x200' , medium: '*x800', large: '*x1600' },
         params: { ContentLanguage: 'DE'},
         path: (uid, basename, ext, file) => `images/${basename}`,
       }
@@ -874,6 +877,7 @@ module.exports = function(monastery, opendb) {
           type: 'image',
           awsAcl: 'public-read-write',
           awsBucket: 'fake2',
+          metadata: { small: '*x100' , medium: '*x400', large: '*x800' },
           params: { ContentLanguage: 'NZ'},
           path: (uid, basename, ext, file) => `images2/${basename}`,
         },
@@ -904,6 +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' },
             path: 'images/logo.png',
             uid: expect.any(String),
           },
@@ -912,6 +917,7 @@ module.exports = function(monastery, opendb) {
             date: expect.any(Number),
             filename: 'logo2.png',
             filesize: expect.any(Number),
+            metadata: { small: '*x100' , medium: '*x400', large: '*x800' },
             path: 'images2/logo2.png',
             uid: expect.any(String),
           },
@@ -924,6 +930,7 @@ module.exports = function(monastery, opendb) {
             Bucket: 'fake',
             ContentLanguage: 'DE',
             Key: 'images/logo.png',
+            Metadata:  { small: '*x200' , medium: '*x800', large: '*x1600' },
           }],
           [{
             ACL: 'public-read-write',
@@ -931,6 +938,7 @@ module.exports = function(monastery, opendb) {
             Bucket: 'fake2',
             ContentLanguage: 'NZ',
             Key: 'images2/logo2.png',
+            Metadata: { small: '*x100' , medium: '*x400', large: '*x800' },
           }],
         ])
         res.send()