monastery 1.40.4 → 1.40.5

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.
 
+### [1.40.5](https://github.com/boycce/monastery/compare/1.40.4...1.40.5) (2023-02-22)
+
 ### [1.40.4](https://github.com/boycce/monastery/compare/1.40.3...1.40.4) (2022-12-21)
 
 ### [1.40.3](https://github.com/boycce/monastery/compare/1.40.2...1.40.3) (2022-12-21)

package/docs/image-plugin.md

@@ -43,7 +43,7 @@ let user = db.model('user', {
 })
 ```
 
-Then when inserting or updating a document you need to set `files` to an obkect containing containing your parsed files, [express-fileupload](https://github.com/richardgirges/express-fileupload) works great with an express setup, e.g.
+Then when inserting or updating a document you need to set `options.files` to an object containing your parsed files, [express-fileupload](https://github.com/richardgirges/express-fileupload) works great with an express setup, e.g.
 
 ```js
 user.update({
@@ -53,7 +53,13 @@ user.update({
 })
 ```
 
-When updating, you need to make sure you always pass all of your image objects again back into `data` since any images not found will be removed automatically from your S3 bucket. A nice way to handle image/non-image updates is by appending `?files=true` to your API route calls, e.g.
+### Updating documents
+
+When updating a document with `options.files`, you need to make sure to **always** include previously uploaded file objects in `options.data` otherwise these will be removed automatically from your S3 bucket (via a comparsion check against your previous document). 
+
+You can reuse the image objects (e.g. `{ bucket, data, uid, ... }`) for other file field values on the same document. You can't however copy image objects across documents and collections.
+
+You can skip all file processing by not defining `options.files`. A nice way to sepearte file and non-file updates is by appending ?files=true to your API route calls, e.g.
 
 ```js
 user.update({

package/docs/readme.md

@@ -100,6 +100,7 @@ Coming soon...
 - docs: Make the implicit ID query conversion more apparent
 - Split away from Monk (unless updated)
 - Add a warning if an invalid model is referenced in jthe schema
+- Remove leading forward slashes from custom image paths (AWS adds this as a seperate folder)
 
 ## Versions
 

package/package.json

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

package/plugins/images/index.js

@@ -322,7 +322,8 @@ let plugin = module.exports = {
           // valid image-object?
           if (typeof useCount[image.image.uid] == 'undefined') {
             throw `The passed image object for '${image.dataPath}' does not match any pre-existing
-              images saved on this document.`
+              images saved on this document. Make sure that this image dosen't come from another document or 
+              collection, and is indeed saved on this document.`
           // Different image from prexisting image
           } else if (preExistingImage && preExistingImage.image.uid != image.image.uid) {
             useCount[preExistingImage.image.uid]--