monastery 3.0.15 → 3.0.17

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.17](https://github.com/boycce/monastery/compare/3.0.16...3.0.17) (2024-05-02)
+
+### [3.0.16](https://github.com/boycce/monastery/compare/3.0.15...3.0.16) (2024-05-02)
+
 ### [3.0.15](https://github.com/boycce/monastery/compare/3.0.14...3.0.15) (2024-05-01)
 
 ### [3.0.14](https://github.com/boycce/monastery/compare/3.0.13...3.0.14) (2024-05-01)

package/docs/model/find.md

@@ -58,30 +58,27 @@ The value of the model reference should be an ID, e.g. `myBook = id`
 ```js
 {
   fields: {
-    myBook: {
-      model: 'book'
-    }
+    myBook: { model: 'book' },
+    myBooks: [{ model: 'books' }], // you can even populate arrays
   }
 }
 ```
 
-You are then able to easily populate returned results via a find operation.
+You are then able to easily populate the returned results in the find method:
 
 ```js
-user.find({ query: {...}, populate: ['myBook'] })
+user.find({ query: {...}, populate: ['myBook', 'myBooks', ...] })
 ```
 
-You can also populate within embedded document fields. Although at this time arrays are not supported,
-you would need to use the [example below](#populate-multiple-documents-into-virtual-fields).
+You can also populate within embedded document fields.
 ```js
 user.find({ query: {...}, populate: ['myBooks.book'] })
 ```
 
 ### Custom Populate Query
 
-If you would like more control you can either use Mongo's `aggregate` method via [`model._aggregate`](./...rawMethods), or simply pass a MongoDB lookup object to populate. When passing a lookup object, the
-populated field still needs to be defined in `definition.fields` if you want to call any related hooks,
-and prune any blacklisted fields. See the examples below,
+If you would like more control you can either use Mongo's `aggregate` method via [`model._aggregate`](./rawMethods), or simply pass a MongoDB lookup object to `populate`. When passing a lookup object, the
+populated field still needs to be defined in `definition.fields` if you want Monastery to process any related hooks, field blacklisting and default values. See the example belows,
 
 #### Populate a single document
 
@@ -93,37 +90,42 @@ user.find({
   populate: [{
     as: 'myBook',
     from: 'book',
+    foreignField: '_id',
     localField: 'myBook',
-    foreignField: '_id'
   }]
 })
 ```
 
 #### Populate multiple documents into virtual fields
 
-Below populates all books into `user.myBooks` with a `bookOwnerId` equal to the `user._id`. Since `myBooks`
-isn't stored on the user, you will need define it as virtual field
+Below populates all books into `user.myBooks` with a `bookOwnerId` equal to the `user._id`. Since `myBooks` isn't stored on the user, you will need define it as virtual field.
 
 ```js
-{
+db.model('user', {
   fields: {
-    myBooks: [{
-      model: 'book',
-      virtual: true
-    }],
+    name: { type: 'string' },
+    myBooks: [{ model: 'book', virtual: true }],
   },
-}
+})
+db.model('book', {
+  fields: {
+    bookTitle: { type: 'string' },
+    bookOwnerId: { model: 'user' },
+  },
+})
+
+// books and user inserted here...
 
 user.find({
   query: {...},
   populate: [{
     as: 'myBooks',
     from: 'book',
-    let: { id: '$_id' },
+    let: { userId: '$_id' },
     pipeline: [{
       $match: {
         $expr: {
-          $eq: ['$bookOwnerId', '$$id']
+          $eq: ['$bookOwnerId', '$$userId']
         }
       }
     }]

package/lib/model-crud.js

@@ -141,24 +141,40 @@ Model.prototype.find = async function (opts, _one) {
             )
             continue
           }
-          // Convert array into a document for non-array targets
-          if (!arrayTarget) {
+          if (arrayTarget) {
+            // Create lookup
+            lookups.push({ 
+              $lookup: {
+                as: path,
+                from: modelName,
+                let: { arraypath: '$' + path }, // host array path
+                pipeline: [
+                  // Populating an array doesn't return sorted in the original sort order
+                  { $sort: { _id: 1 } },
+                  { $match: { $expr: { $in: ['$_id', '$$arraypath'] } } },
+                ],
+              },
+            })
+          } else {
+            // Convert array into a document for non-array targets
             (opts.addFields = opts.addFields || {})[path] = { '$arrayElemAt': [ '$' + path, 0 ] }
+            // Create basic lookup
+            lookups.push({ 
+              $lookup: {
+                as: path,
+                from: modelName,
+                foreignField: '_id',
+                localField: path,
+              },
+            })
           }
-          // Create lookup
-          lookups.push({ $lookup: {
-            from: modelName,
-            localField: path,
-            foreignField: '_id',
-            as: path,
-          }})
         }
       }
       // console.log(1, opts.projection)
       // console.log(2, lookups)
       let aggregate = [
         { $match: opts.query },
-        ...(util.isDefined(opts.sort) ? [{ $sort: opts.sort }] : []),
+        { $sort: opts.sort },
         ...(util.isDefined(opts.skip) ? [{ $limit: opts.skip }] : []),
         ...(util.isDefined(opts.limit) ? [{ $limit: opts.limit }] : []),
         ...lookups,
@@ -449,6 +465,8 @@ Model.prototype._getProjectionFromProject = function (customProject) {
       o[v.replace(/^-/, '')] = v.match(/^-/)? 0 : 1
       return o
     }, {})
+  } else if (util.isObject(customProject)) {
+    projection = customProject
   }
   return projection
 }

package/lib/util.js

@@ -402,6 +402,10 @@ module.exports = {
     return obj
   },
 
+  setTimeoutPromise: function(ms) {
+    return new Promise(res => setTimeout(res, ms))
+  },
+
   toArray: function(variable) {
     // converts a variable to an array, if not already so
     if (typeof variable === 'undefined') return []

package/package.json

@@ -2,7 +2,7 @@
   "name": "monastery",
   "description": "⛪ A simple, straightforward MongoDB ODM",
   "author": "Ricky Boyce",
-  "version": "3.0.15",
+  "version": "3.0.17",
   "license": "MIT",
   "repository": "github:boycce/monastery",
   "homepage": "https://boycce.github.io/monastery/",
@@ -36,8 +36,8 @@
     "@aws-sdk/lib-storage": "3.549.0",
     "@aws-sdk/s3-request-presigner": "3.549.0",
     "debug": "4.3.4",
-    "file-type": "^16.5.4",
-    "mongodb": "^5.9.2",
+    "file-type": "16.5.4",
+    "mongodb": "5.9.2",
     "nanoid": "3.2.0",
     "validator": "13.7.0"
   },

package/plugins/images/index.js

@@ -50,9 +50,10 @@ let plugin = module.exports = {
     // v3 examples: https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/javascript_s3_code_examples.html
     this.getS3Client = (useRegion) => {
       const { S3 } = require('@aws-sdk/client-s3')
-      const key  = useRegion ? '_s3ClientRegional' : '_s3Client'
+      const key  = '_s3Client'// useRegion ? '_s3ClientRegional' : '_s3Client'
       return this[key] || (this[key] = new S3({
-        region: useRegion ? this.awsRegion : undefined,
+        // ...(region: useRegion ? this.awsRegion : undefined,
+        region: this.awsRegion, // if region is missing it throws an error, but only in production...
         credentials: {
           accessKeyId: this.awsAccessKeyId,
           secretAccessKey: this.awsSecretAccessKey,

package/test/blacklisting.js

@@ -218,18 +218,26 @@ test('find project basic', async () => {
   }})
 
   // pass: test inclusion of projections via native mongodb project option
-  let find1 = await user.findOne({
+  let find11 = await user.findOne({
     query: user1._id,
-    project: ['animal.name', 'animals.name'],
+    project: {'animal.name': 1, 'animals.name': 1},
   })
-  expect(find1).toEqual({
+  const find11Expected = {
     _id: user1._id,
     animal: { name: 'max' },
     animals: [
       { name: 'ponyo' },
       { name: 'freddy' },
     ],
+  }
+  expect(find11).toEqual(find11Expected)
+
+  // pass: test inclusion of projections via native mongodb project option
+  let find1 = await user.findOne({
+    query: user1._id,
+    project: ['animal.name', 'animals.name'],
   })
+  expect(find1).toEqual(find11Expected)
 
   // pass: test exclusion of projections via native mongodb project option
   let find2 = await user.findOne({

package/test/populate.js

@@ -83,14 +83,18 @@ test('model populate', async () => {
 })
 
 test('model populate array', async () => {
-  let bird = db.model('bird', { fields: {
-    name: { type: 'string' },
-  }})
-  let user = db.model('user', { fields: {
-    birds: [{ model: 'bird' }],
-    animal: { birds: [{ model: 'bird' }] },
-    animals: [{ bird: { model: 'bird' }, num: { type: 'number' } }],
-  }})
+  let bird = db.model('bird_pop', { 
+    fields: {
+      name: { type: 'string' },
+    },
+  })
+  let user = db.model('user_pop', { 
+    fields: {
+      birds: [{ model: 'bird_pop' }],
+      animal: { birds: [{ model: 'bird_pop' }] },
+      animals: [{ bird: { model: 'bird_pop' }, num: { type: 'number' } }],
+    },
+  })
   let bird1 = await bird.insert({ data: { name: 'ponyo' }})
   let bird2 = await bird.insert({ data: { name: 'jack' }})
   let bird3 = await bird.insert({ data: { name: 'sophie' }})