monastery 3.0.12 → 3.0.14

package/changelog.md

@@ -2,6 +2,10 @@
 
 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.
 
+### [3.0.14](https://github.com/boycce/monastery/compare/3.0.13...3.0.14) (2024-05-01)
+
+### [3.0.13](https://github.com/boycce/monastery/compare/3.0.12...3.0.13) (2024-05-01)
+
 ### [3.0.12](https://github.com/boycce/monastery/compare/3.0.11...3.0.12) (2024-05-01)
 
 ### [3.0.11](https://github.com/boycce/monastery/compare/3.0.10...3.0.11) (2024-04-30)

package/docs/manager/index.md

@@ -60,6 +60,7 @@ db.onError((err) => {
 - `manager.models()`: [see models](./models.html)
 - `manager.onError(Function)`: Catches connection errors
 - `manager.onOpen(Function)`: Triggers on successful connection
+- `manager.getSignedUrl(path, expires, bucket)`: You can sign AWS S3 paths using this image plugin helper
 
 ### Dates
 

package/lib/index.js

@@ -282,7 +282,7 @@ Manager.prototype.parseData = function(obj) {
 }
 
 Manager.prototype.model = Model
-Manager.prototype._getSignedUrl = imagePluginFile._getSignedUrl
+Manager.prototype.getSignedUrl = Manager.prototype._getSignedUrl = imagePluginFile.getSignedUrl
 
 inherits(Manager, EventEmitter)
 module.exports = Manager 

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A simple, straightforward MongoDB ODM",
   "author": "Ricky Boyce",
-  "version": "3.0.12",
+  "version": "3.0.14",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",

package/plugins/images/index.js

@@ -31,7 +31,7 @@ let plugin = module.exports = {
     this.bucketDir = options.bucketDir || 'full' // depreciated > 1.36.2
     this.filesize = options.filesize
     this.formats = options.formats || ['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff']
-    this.getSignedUrl = options.getSignedUrl
+    this.getSignedUrlOption = options.getSignedUrl
     this.manager = manager
     this.metadata = options.metadata ? util.deepCopy(options.metadata) : undefined,
     this.params = options.params ? util.deepCopy(options.params) : {},
@@ -41,17 +41,18 @@ let plugin = module.exports = {
       throw new Error('Monastery imagePlugin: awsRegion, awsBucket, awsAccessKeyId, or awsSecretAccessKey is not defined')
     }
     if (!options.awsRegion) {
-      throw new Error('Monastery imagePlugin: v3 requires awsRegion to be defined for signing urls, e.g. "ap-southeast-2"')
+      throw new Error('Monastery imagePlugin: v3 requires awsRegion to be defined for signing urls, e.g. \'ap-southeast-2\'')
     }
 
     // Create s3 'service' instance (defer require since it takes 120ms to load)
     // 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
-    this.getS3Client = () => {
+    this.getS3Client = (useRegion) => {
       const { S3 } = require('@aws-sdk/client-s3')
-      return this._s3Client || (this._s3Client = new S3({
-        region: this.awsRegion,
+      const key  = useRegion ? '_s3ClientRegional' : '_s3Client'
+      return this[key] || (this[key] = new S3({
+        region: useRegion ? this.awsRegion : undefined,
         credentials: {
           accessKeyId: this.awsAccessKeyId,
           secretAccessKey: this.awsSecretAccessKey,
@@ -230,11 +231,11 @@ let plugin = module.exports = {
     for (let doc of util.toArray(data)) {
       for (let imageField of this.imageFields) {
         if (options.getSignedUrls
-            || (util.isDefined(imageField.getSignedUrl) ? imageField.getSignedUrl : plugin.getSignedUrl)) {
+            || (util.isDefined(imageField.getSignedUrl) ? imageField.getSignedUrl : plugin.getSignedUrlOption)) {
           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 = await plugin._getSignedUrl(image.image.path, 3600, imageField.awsBucket)
+            image.image.signedUrl = await plugin.getSignedUrl(image.image.path, 3600, imageField.awsBucket)
           }
         }
       }
@@ -589,24 +590,24 @@ let plugin = module.exports = {
     return list
   },
 
-  _getSignedUrl: async (path, expires=3600, bucket) => {
+  getSignedUrl: async (path, expires=3600, bucket) => {
     /**
      * @param {string} path - aws file path
      * @param {number} <expires> - seconds
-     * @param {number} <bucket>
+     * @param {string} <bucket>
      * @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
      */
     if (!plugin.getS3Client) {
       throw new Error(
-        'To use db._getSignedUrl(), the imagePlugin manager option must be defined, e.g. `monastery(..., { imagePlugin })`'
+        'To use db.getSignedUrl(), the imagePlugin manager option must be defined, e.g. `monastery(..., { imagePlugin })`'
       )
     }
     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 })
+    let signedUrl = await getSignedUrl(plugin.getS3Client(true), command, { expiresIn: expires })
     // console.log(signedUrl)
     return signedUrl
   },

package/test/plugin-images.js

@@ -2,13 +2,14 @@
 const util = require('../lib/util.js')
 const imagePluginFile = require('../plugins/images/index.js')
 const monastery = require('../lib/index.js')
+const imagePluginFakeOpts = { awsBucket: 'fake', awsRegion: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' }
 
 let db
 afterAll(async () => { db.close() })
 beforeAll(async () => { 
   db = monastery('127.0.0.1/monastery', {
     timestamps: false, 
-    imagePlugin: { awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' },
+    imagePlugin: imagePluginFakeOpts,
   }) 
 })
 
@@ -69,7 +70,7 @@ test('images initialisation', async () => {
   }})
 
   // Initialisation success
-  expect(db.opts.imagePlugin).toEqual({ awsBucket: 'fake', awsAccessKeyId: 'fake', awsSecretAccessKey: 'fake' })
+  expect(db.opts.imagePlugin).toEqual(imagePluginFakeOpts)
 
   let expected = {
     bucket: { type: 'string', isString: true },
@@ -572,7 +573,7 @@ test('images option defaults', async () => {
   expect(imagePluginFile.awsAcl).toEqual('public-read')
   expect(imagePluginFile.filesize).toEqual(undefined)
   expect(imagePluginFile.formats).toEqual(['bmp', 'gif', 'jpg', 'jpeg', 'png', 'tiff'])
-  expect(imagePluginFile.getSignedUrl).toEqual(undefined)
+  expect(imagePluginFile.getSignedUrlOption).toEqual(undefined)
   expect(imagePluginFile.metadata).toEqual(undefined)
   expect(imagePluginFile.path).toEqual(expect.any(Function))
   expect(imagePluginFile.params).toEqual({})
@@ -641,9 +642,7 @@ test('images options formats & filesizes', async () => {
   const db3 = monastery('127.0.0.1/monastery', {
     timestamps: false, 
     imagePlugin: { 
-      awsBucket: 'fake', 
-      awsAccessKeyId: 'fake', 
-      awsSecretAccessKey: 'fake',
+      ...imagePluginFakeOpts,
       formats: ['jpg', 'jpeg', 'png', 'ico'],
       filesize: 1000 * 270, 
     },
@@ -722,10 +721,8 @@ test('images option getSignedUrls', async () => {
   const db3 = monastery('127.0.0.1/monastery', {
     timestamps: false, 
     imagePlugin: { 
-      awsBucket: 'fake', 
-      awsAccessKeyId: 'fake', 
-      awsSecretAccessKey: 'fake',
-      awsRegion: 's3-ap-southeast-2',
+      ...imagePluginFakeOpts,
+      awsRegion: 'ap-southeast-2',
       getSignedUrl: true,
     },
   })
@@ -781,10 +778,8 @@ test('images options awsAcl, awsBucket, metadata, params, path', async () => {
   const db3 = monastery('127.0.0.1/monastery', {
     timestamps: false, 
     imagePlugin: { 
+      ...imagePluginFakeOpts,
       awsAcl: 'private',
-      awsBucket: 'fake',
-      awsAccessKeyId: 'fake',
-      awsSecretAccessKey: 'fake',
       metadata: { small: '*x300' , medium: '*x800', large: '*x1200' },
       params: { ContentLanguage: 'DE'},
       path: (uid, basename, ext, file) => `images/${basename}`,
@@ -884,9 +879,7 @@ test('images option depreciations', async () => {
     logLevel: 1,
     timestamps: false, 
     imagePlugin: { 
-      awsBucket: 'fake',
-      awsAccessKeyId: 'fake',
-      awsSecretAccessKey: 'fake',
+      ...imagePluginFakeOpts,
       bucketDir: 'old',
     },
   })