monastery 2.0.0 → 2.1.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.
 
+## [2.1.0](https://github.com/boycce/monastery/compare/1.42.2...2.1.0) (2024-04-05)
+
 ## [2.0.0](https://github.com/boycce/monastery/compare/1.42.2...2.0.0) (2023-12-06)
 
 ### [1.42.2](https://github.com/boycce/monastery/compare/1.42.1...1.42.2) (2023-10-31)

package/docs/definition/index.md

@@ -283,12 +283,12 @@ You are able to define custom error messages for each field rule.
       }
     },
     // Assign custom error messages for arrays
+    // e.g. pets = [{ name: { type: 'string' }}]
     'pets': {
       minLength: `Please add at least one pet pet group.`
     },
     // You can assign custom error messages for all fields on embedded documents in an array
-    // e.g. pets = [{ name: { type: 'string' }}]
-    'pets.name': {
+    'pets.$.name': {
       required: `Your pet's name needs to be a string.`
     },
     // To target a specific array item

package/docs/image-plugin.md

@@ -12,6 +12,7 @@ To use the default image plugin shipped with monastery, you need to use the opti
     imagePlugin: {
       awsAcl: 'public-read', // default
       awsBucket: 'your-bucket-name',
+      awsRegion: undefined, // required when using getSignedUrl (e.g. 's3-ap-southeast-2')
       awsAccessKeyId: 'your-key-here',
       awsSecretAccessKey: 'your-key-here',
       filesize: undefined, // default (max filesize in bytes)

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A straight forward MongoDB ODM built around Monk",
   "author": "Ricky Boyce",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -26,26 +26,31 @@
     "patch": "standard-version --release-as patch && npm publish",
     "release": "standard-version && npm publish && git push --tags",
     "test": "npm run lint && jest",
-    "test-one-example": "jest -t images"
+    "test-one-example": "jest -t \"images addImages\" --watchAll"
   },
   "dependencies": {
-    "aws-sdk": "2.1062.0",
-    "debug": "4.1.1",
-    "file-type": "15.0.0",
+    "@aws-sdk/client-s3": "^3.549.0",
+    "@aws-sdk/s3-request-presigner": "^3.549.0",
+    "debug": "^4.3.4",
+    "file-type": "^16.5.4",
     "monk": "7.3.4",
     "nanoid": "3.2.0",
     "validator": "13.7.0"
   },
   "devDependencies": {
-    "body-parser": "1.19.0",
+    "body-parser": "^1.20.2",
     "eslint": "8.7.0",
-    "express": "4.17.1",
-    "express-fileupload": "1.2.0",
+    "express": "^4.19.2",
+    "express-fileupload": "^1.5.0",
     "jest": "27.4.7",
-    "nodemon": "2.0.15",
+    "nodemon": "^3.1.0",
     "standard-version": "9.3.2",
     "supertest": "4.0.2"
   },
+  "engines": {
+    "node": ">=14",
+    "npm": ">=6"
+  },
   "standard-version": {
     "infile": "changelog.md",
     "releaseCommitMessageFormat": "{{currentTag}}",

package/plugins/images/index.js

@@ -1,5 +1,6 @@
 // requiring: nanoid, file-type, aws-sdk/clients/s3
-let util = require('../../lib/util')
+const { getSignedUrl } = require('@aws-sdk/s3-request-presigner')
+const util = require('../../lib/util')
 
 let plugin = module.exports = {
 
@@ -26,6 +27,7 @@ let plugin = module.exports = {
     this.awsBucket = options.awsBucket
     this.awsAccessKeyId = options.awsAccessKeyId
     this.awsSecretAccessKey = options.awsSecretAccessKey
+    this.awsRegion = options.awsRegion
     this.bucketDir = options.bucketDir || 'full' // depreciated > 1.36.2
     this.filesize = options.filesize
     this.formats = options.formats || ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff']
@@ -42,10 +44,14 @@ let plugin = module.exports = {
     }
 
     // Create s3 'service' instance (defer require since it takes 120ms to load)
-    // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
+    // v2: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#constructor-property
+    // v3: https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/s3/
+    // v3 examples: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html
     manager._getSignedUrl = this._getSignedUrl
-    this.s3 = () => {
-      return this._s3 || (this._s3 = new (require('aws-sdk/clients/s3'))({
+    this.getS3Client = () => {
+      const { S3 } = require('@aws-sdk/client-s3')
+      return this._s3Client || (this._s3Client = new S3({
+        region: this.awsRegion,
         credentials: {
           accessKeyId: this.awsAccessKeyId,
           secretAccessKey: this.awsSecretAccessKey
@@ -168,7 +174,7 @@ let plugin = module.exports = {
               plugin._addImageObjectsToData(filesArr.inputPath, data, image)
               resolve(s3Options)
             } else {
-              plugin.s3().upload(s3Options, (err, response) => {
+              plugin.getS3Client().upload(s3Options, (err, response) => {
                 if (err) return reject(err)
                 plugin._addImageObjectsToData(filesArr.inputPath, data, image)
                 resolve(s3Options)
@@ -203,7 +209,7 @@ let plugin = module.exports = {
      * Get signed urls for all image objects in data
      * @param {object} options - monastery operation options {model, query, files, ..}
      * @param {object} data
-     * @return promise(data)
+     * @return promise() - mutates data
      * @this model
      */
     // Not wanting signed urls for this operation?
@@ -215,8 +221,9 @@ let plugin = module.exports = {
         if (options.getSignedUrls
             || (util.isDefined(imageField.getSignedUrl) ? imageField.getSignedUrl : plugin.getSignedUrl)) {
           let images = plugin._findImagesInData(doc, imageField, 0, '').filter(o => o.image)
+          // todo: we could do this in parallel
           for (let image of images) {
-            image.image.signedUrl = plugin._getSignedUrl(image.image.path, 3600, imageField.awsBucket)
+            image.image.signedUrl = await plugin._getSignedUrl(image.image.path, 3600, imageField.awsBucket)
           }
         }
       }
@@ -365,7 +372,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.getS3Client().deleteObjects({
         Bucket: plugin.awsBucket,
         Delete: { Objects: unused }
       }, (err, data) => {
@@ -571,18 +578,23 @@ let plugin = module.exports = {
     return list
   },
 
-  _getSignedUrl: (path, expires=3600, bucket) => {
+  _getSignedUrl: async (path, expires=3600, bucket) => {
     /**
      * @param {string} path - aws file path
      * @param {number} <expires> - seconds
      * @param {number} <bucket>
-     * @see https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#getSignedUrl-property
+     * @return {promise} signedUrl
+     * @see v2: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#getSignedUrl-property
+     * @see v3: https://github.com/aws/aws-sdk-js-v3/blob/main/UPGRADING.md#s3-presigned-url
      */
-    let signedUrl = plugin.s3().getSignedUrl('getObject', {
-      Bucket: bucket || plugin.awsBucket,
-      Expires: expires,
-      Key: path,
-    })
+    if (!plugin.awsRegion) {
+      throw 'Monastery requires config.awsRegion to be defined when using getSignedUrl\'s'
+    }
+    const { GetObjectCommand } = require('@aws-sdk/client-s3')
+    const params = { Bucket: bucket || plugin.awsBucket, Key: path }
+    const command = new GetObjectCommand(params)
+    let signedUrl = await getSignedUrl(plugin.getS3Client(), command, { expiresIn: expires })
+    // console.log(signedUrl)
     return signedUrl
   },
 

package/test/plugin-images.js

@@ -803,6 +803,7 @@ module.exports = function(monastery, opendb) {
         awsBucket: 'fake',
         awsAccessKeyId: 'fake',
         awsSecretAccessKey: 'fake',
+        awsRegion: 's3-ap-southeast-2',
         getSignedUrl: true,
       },
     })).db