monastery 3.0.0 → 3.0.1

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.
 
+### [3.0.1](https://github.com/boycce/monastery/compare/3.0.0...3.0.1) (2024-04-28)
+
 ## [3.0.0](https://github.com/boycce/monastery/compare/2.2.2...3.0.0) (2024-04-28)
 
 ### [2.2.2](https://github.com/boycce/monastery/compare/2.2.1...2.2.2) (2024-04-07)

package/docs/model/{...rawMethods.md → rawMethods.md}

@@ -1,13 +1,14 @@
 ---
-title: ...raw methods
+title: ...collection methods
 parent: Model
+nav_order: 9
 ---
 
-# Raw Methods
+# Collection Methods
 
 These MongoDB collection methods are made available if you need to test or run any method without hooks or Monastery argument/return processing.
 
-These methods can be accessed via the `model._*`.
+These methods can be accessed via `model._*`.
 
 ## Returns
 
@@ -15,25 +16,25 @@ All methods return a promise.
 
 ## Methods
 
-  * model.[_aggregate](#model._aggregate)
-  * model.[_bulkWrite](#model._bulkWrite)
-  * model.[_count](#model._count)
-  * model.[_createIndex](#model._createIndex)
-  * model.[_createIndexes](#model._createIndexes)
-  * model.[_distinct](#model._distinct)
-  * model.[_drop](#model._drop)
-  * model.[_dropIndex](#model._dropIndex)
-  * model.[_dropIndexes](#model._dropIndexes)
-  * model.[_find](#model._find)
-  * model.[_findOne](#model._findOne)
-  * model.[_findOneAndDelete](#model._findOneAndDelete)
-  * model.[_findOneAndUpdate](#model._findOneAndUpdate)
-  * model.[_indexes](#model._indexes)
-  * model.[_indexInformation](#model._indexInformation)
-  * model.[_insert](#model._insert)
-  * model.[_remove](#model._remove)
-  * model.[_stats](#model._stats)
-  * model.[_update](#model._update)
+  * model.[_aggregate](#model_aggregate)
+  * model.[_bulkWrite](#model_bulkwrite)
+  * model.[_count](#model_count)
+  * model.[_createIndex](#model_createindex)
+  * model.[_createIndexes](#model_createindexes)
+  * model.[_distinct](#model_distinct)
+  * model.[_drop](#model_drop)
+  * model.[_dropIndex](#model_dropindex)
+  * model.[_dropIndexes](#model_dropindexes)
+  * model.[_find](#model_find)
+  * model.[_findOne](#model_findone)
+  * model.[_findOneAndDelete](#model_findoneanddelete)
+  * model.[_findOneAndUpdate](#model_findoneandupdate)
+  * model.[_indexes](#model_indexes)
+  * model.[_indexInformation](#model_indexinformation)
+  * model.[_insert](#model_insert)
+  * model.[_remove](#model_remove)
+  * model.[_stats](#model_stats)
+  * model.[_update](#model_update)
 
 ### [`model._aggregate`](https://mongodb.github.io/node-mongodb-native/5.9/classes/Collection.html#aggregate)
 
@@ -74,7 +75,7 @@ All methods return a promise.
 
   Returns the count of documents that would match a find() query. The method uses collection.countDocuments() in the mongo driver. Arguments:
 
-  1. `[Filter]` *(string|objectId|object)*
+  1. `[Filter]` *(string\|objectId\|object)*
   2. `[Options]` *(object)*
 
   ```js
@@ -93,7 +94,7 @@ All methods return a promise.
 
   Creates an index on the db and collection collection. Arguments:
 
-  1. `IndexSpec` *(string|array|object)* - The field name or index specification to create an index for
+  1. `IndexSpec` *(string\|array\|object)* - The field name or index specification to create an index for
   2. `[Options]` *(object)*
 
   ```js
@@ -133,7 +134,7 @@ All methods return a promise.
   Returns a list of distinct values for the given key across a collection. Arguments:
 
   1. `Key` *(string)*
-  2. `[Filter]` *(string|objectId|object)*
+  2. `[Filter]` *(string\|objectId\|object)*
   3. `[Options]` *(object)*
 
   ```js
@@ -172,7 +173,7 @@ All methods return a promise.
 
   Finds documents in the collection. Arguments:
 
-  1. `[Filter]` *(string|objectId|object)*
+  1. `[Filter]` *(string\|objectId\|object)*
   2. `[Options]` *(object)*
 
   ```js
@@ -192,7 +193,7 @@ All methods return a promise.
 
   Fetches the first document that matches the filter. Arguments:
 
-  1. `[Filter]` *(string|objectId|object)*
+  1. `[Filter]` *(string\|objectId\|object)*
   2. `[Options]` *(object)*
 
   ```js
@@ -204,7 +205,7 @@ All methods return a promise.
 
   Find a document and delete it in one atomic operation. Requires a write lock for the duration of the operation. Arguments: 
 
-  1. `[Filter]` *(string|objectId|object)*
+  1. `[Filter]` *(string\|objectId\|object)*
   2. `[Options]` *(object)*
 
   ```js
@@ -215,7 +216,7 @@ All methods return a promise.
 
   Find a document and update it in one atomic operation. Requires a write lock for the duration of the operation. Arguments: 
 
-  1. `Filter` *(string|objectId|object)*
+  1. `Filter` *(string\|objectId\|object)*
   2. `Update` *(object)*
   3. `[Options]` *(object)*
 
@@ -247,7 +248,7 @@ All methods return a promise.
 
   Inserts one or more documents into the collection. Arguments:
 
-  1. `Doc` *(object|array)* - one or many documents
+  1. `Doc` *(object\|array)* - one or many documents
   2. `[Options]` *(object)*
 
   ```js
@@ -259,7 +260,7 @@ All methods return a promise.
 
   Removes one or more document(s) from the collection. Arguments:
 
-  1. `Filter` *(string|objectId|object)*
+  1. `Filter` *(string\|objectId\|object)*
   2. `[Options]` *(object)*
 
   ```js
@@ -280,7 +281,7 @@ All methods return a promise.
 
   Updates one or more document(s) from the collection. Arguments:
 
-  1. `Filter` *(string|objectId|object)*
+  1. `Filter` *(string\|objectId\|object)*
   1. `Update` *(object)*
   2. `[Options]` *(object)*
 

package/docs/readme.md

@@ -2,8 +2,7 @@
 
 [![NPM](https://img.shields.io/npm/v/monastery.svg)](https://www.npmjs.com/package/monastery) [![Build Status](https://travis-ci.com/boycce/monastery.svg?branch=master)](https://app.travis-ci.com/github/boycce/monastery)
 
-> [!IMPORTANT]  
-> v3.0 has been released 🎉 refer to [breaking changes](#v3.0BreakingChanges) below when upgrading from v2.x.
+> v3.0 has been released 🎉 refer to [breaking changes](#v3-breaking-changes) below when upgrading from v2.x.
 
 ## Features
 
@@ -13,7 +12,7 @@
 * Normalized error responses objects ready for client consumption
 * Custom error messages can be defined in your model definitions
 * Blacklist sensitive fields once in your model definition, or per operation
-* Model methods can accept bracket (multipart/form-data) and dot notation data formats, you can also mix these together
+* Model methods can accept data in bracket (multipart/form) and dot notation, you can also mix these together
 * Automatic Mongo index creation
 
 #### Why Monastery over Mongoose?
@@ -22,7 +21,7 @@
 * Model schema and configurations are all defined within a single object (model definition)
 * You can blacklist/exclude sensitive model fields in the model definition for each CRUD operation
 * Model population uses a single aggregation call instead of multiple queries for faster responses
-* Errors throw normalized error objects that contain the model and field name, error message etc, handy in the client
+* Errors throw normalized error objects that contain the model, field, error message etc, handy in the client
 
 ## Install
 
@@ -83,16 +82,14 @@ You can view MongoDB's [compatibility table here](https://www.mongodb.com/docs/d
 | `2.x` | [`3.7.x`](https://mongodb.github.io/node-mongodb-native/3.7/api/) | `>=2.6  <=6.x` | `>=4.x  <=14.x` |
 
 
-## v3.0 Breaking Changes
+## v3 Breaking Changes
 
   - Removed callback functions on all model methods, you can use the returned promise instead
-  - `model.update()` now returns the following _update property:
-    - `{ acknowledged: true, matchedCount: 1, modifiedCount: 1, upsertedCount: 0, upsertedId: null }`, instead of
-    - `{ n: 1, nModified: 1, ok: 1 }`
-  - `model.remove()` now returns `{ acknowledged: true, deletedCount: 1 }`, instead of `{ results: { n: 1, ok: 1} }`
-  - Models are now added to `db.models` instead of `db.model`, e.g. `db.models.user`
-  - MongoDB connection can be found here `db.db` changed from `db._db`
-  - `model._indexes()` now returns `collection._indexes()` not `collection._indexInformation()`
+  - model.update() now returns the following _update property: `{ acknowledged: true, matchedCount: 1, modifiedCount: 1, upsertedCount: 0, upsertedId: null }` instead of `{ n: 1, nModified: 1, ok: 1 }`
+  - model.remove() now returns `{ acknowledged: true, deletedCount: 1 }`, instead of `{ results: {n:1, ok:1} }`
+  - Models are now added to db.models instead of db.model, e.g. db.models.user
+  - MongoDB connection can be found here db.db changed from db._db
+  - model._indexes() now returns collection._indexes() not collection._indexInformation()
 
 ## Roadmap
 
@@ -121,9 +118,9 @@ You can view MongoDB's [compatibility table here](https://www.mongodb.com/docs/d
 - timstamps are blacklisted by default (instead of the `timestamps` opt), and can be switched off via blacklisting
 - Allow rules on image types, e.g. `required`
 - Test importing of models
-- Docs: model.methods
+- ~~Docs: model.methods~~
 - ~~Convert hooks to promises~~
-- ~~added `model.count()` ~~
+- ~~added `model.count()`~~
 
 ## Debugging
 
@@ -148,12 +145,3 @@ npm run dev -- -t 'Model indexes'
 ## License
 
 Copyright 2024 Ricky Boyce. Code released under the MIT license.
-
-
-
-
-
-
-///////////////////////////////
-/////3. add 'Collection' to monastery docs sidebar ( also add model.count)
-//// docs sapcing.... +4px

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A simple, straightforward MongoDB ODM",
   "author": "Ricky Boyce",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -33,6 +33,7 @@
   },
   "dependencies": {
     "@aws-sdk/client-s3": "3.549.0",
+    "@aws-sdk/lib-storage": "3.549.0",
     "@aws-sdk/s3-request-presigner": "3.549.0",
     "debug": "4.3.4",
     "file-type": "^16.5.4",

package/plugins/images/index.js

@@ -174,11 +174,22 @@ let plugin = module.exports = {
               plugin._addImageObjectsToData(filesArr.inputPath, data, image)
               resolve(s3Options)
             } else {
-              plugin.getS3Client().upload(s3Options, (err, response) => {
-                if (err) return reject(err)
-                plugin._addImageObjectsToData(filesArr.inputPath, data, image)
-                resolve(s3Options)
+              const { Upload } = require('@aws-sdk/lib-storage')
+              const upload = new Upload({
+                client: plugin.getS3Client(),
+                params: s3Options,
               })
+              // upload.on('httpUploadProgress', (progress) => {
+              //   console.log(progress)
+              // })
+              upload.done()
+                .then((res) => {
+                  plugin._addImageObjectsToData(filesArr.inputPath, data, image)
+                  resolve(s3Options)
+                })
+                .catch((err) => {
+                  reject(err)
+                })
             }
           })
         }))