monastery 1.38.3 → 1.39.2

package/changelog.md

@@ -2,6 +2,12 @@
 
 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.39.2](https://github.com/boycce/monastery/compare/1.39.1...1.39.2) (2022-09-12)
+
+### [1.39.1](https://github.com/boycce/monastery/compare/1.39.0...1.39.1) (2022-09-12)
+
+## [1.39.0](https://github.com/boycce/monastery/compare/1.38.3...1.39.0) (2022-09-11)
+
 ### [1.38.3](https://github.com/boycce/monastery/compare/1.38.2...1.38.3) (2022-08-17)
 
 ### [1.38.2](https://github.com/boycce/monastery/compare/1.38.1...1.38.2) (2022-07-31)

package/docs/manager/models.md

@@ -13,7 +13,7 @@ Setup model definitions from a folder location
 
 ### Returns
 
-An array of [model](../model) instances, the model instances will also be avaliable at:
+A promise with an array of [model](../model) instances, the model instances will also be avaliable at:
 ```js
 db.{model-name}
 db.model.{model-name}
@@ -35,6 +35,6 @@ export default {
 ```
 
 ```js
-db.models(__dirname + "models")
+await db.models(__dirname + "models")
 db.user.insert()
 ```

package/lib/index.js

@@ -1,9 +1,12 @@
+let fs = require('fs')
 let debug = require('debug')
 let monk = require('monk')
 let util = require('./util')
+let path = require('path')
 
 // Apply monk monkey patches
 monk.manager.prototype.open = require('./monk-monkey-patches').open
+monk.manager.prototype.then = require('./monk-monkey-patches').then
 monk.Collection.prototype.findOneAndUpdate = require('./monk-monkey-patches').findOneAndUpdate
 
 module.exports = function(uri, opts, fn) {
@@ -74,21 +77,23 @@ let arrayWithSchema = function(array, schema) {
   return array
 }
 
-let models = function(path) {
+let models = async function(pathname) {
   /**
    * Setup model definitions from a folder location
    * @param {string} pathname
-   * @return {object} - e.g. { user: , article: , .. }
+   * @return {Promise(object)} - e.g. { user: , article: , .. }
    * @this Manager
    */
-  let models = {}
-  if (!path || typeof path !== 'string') {
+  let out = {}
+  if (!pathname || typeof pathname !== 'string') {
     throw 'The path must be a valid pathname'
   }
-  require('fs').readdirSync(path).forEach(filename => {
-    let definition = require(require('path').join(path, filename)).default
+  let filenames = fs.readdirSync(pathname)
+  for (let filename of filenames) {
+    let filepath = path.join(pathname, filename)
+    let definition = (await import(filepath)).default
     let name = filename.replace('.js', '')
-    models[name] = this.model(name, definition)
-  })
-  return models
+    out[name] = this.model(name, definition)
+  }
+  return out
 }

package/lib/monk-monkey-patches.js

@@ -1,4 +1,9 @@
 let MongoClient = require('mongodb').MongoClient
+let STATE = {
+  CLOSED: 'closed',
+  OPENING: 'opening',
+  OPEN: 'open'
+}
 
 module.exports.open = function(uri, opts, fn) {
   /*
@@ -7,11 +12,6 @@ module.exports.open = function(uri, opts, fn) {
    * @see https://www.mongodb.com/community/forums/t/node-44612-deprecationwarning-listening-to-events-on-
        the-db-class-has-been-deprecated-and-will-be-removed-in-the-next-major-version/15849/4
    */
-  var STATE = {
-    CLOSED: 'closed',
-    OPENING: 'opening',
-    OPEN: 'open'
-  }
   MongoClient.connect(uri, opts, function (err, client) {
     // this = Manager
     if (err) {
@@ -39,6 +39,23 @@ module.exports.open = function(uri, opts, fn) {
   }.bind(this))
 }
 
+module.exports.then = function (fn) {
+  /*
+   * Unfortuantly db.then doesn't run after the promise has been fulfilled, this fixes this issue.
+   * @see https://github.com/Automattic/monk/blob/master/lib/manager.js#L194
+   */
+  return new Promise(function (resolve, reject) {
+    if (this._state == STATE.OPEN) {
+      resolve()
+    } else if (this._state == STATE.CLOSED) {
+      reject()
+    } else {
+      this.once('open', resolve)
+      this.once('error-opening', reject)
+    }
+  }.bind(this)).then(fn.bind(null, this))
+}
+
 module.exports.findOneAndUpdate = function(query, update, opts, fn) {
   /*
    * Monkey patch to use returnDocument

package/package.json

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