monastery 3.0.11 → 3.0.12

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.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)
 
 ### [3.0.10](https://github.com/boycce/monastery/compare/3.0.8...3.0.10) (2024-04-30)

package/docs/image-plugin.md

@@ -12,7 +12,7 @@ To use the default image plugin shipped with monastery, you need to use the opti
     imagePlugin: {
       awsAcl: 'public-read', // default
       awsBucket: 'your-bucket-name',
-      awsRegion: undefined, // required when using getSignedUrl (e.g. 's3-ap-southeast-2')
+      awsRegion: undefined, // e.g. 'ap-southeast-2'
       awsAccessKeyId: 'your-key-here',
       awsSecretAccessKey: 'your-key-here',
       filesize: undefined, // default (max filesize in bytes)

package/docs/manager/index.md

@@ -13,9 +13,8 @@ Monastery manager constructor.
 `uri` *(string\|array)*: A [mongo connection string URI](https://www.mongodb.com/docs/v5.0/reference/connection-string/). Replica sets can be an array or comma separated.
 
 [`options`] *(object)*:
-  - [`hideWarnings=false`] *(boolean)*: hide monastery warnings
-  - [`hideErrors=false`] *(boolean)*: hide monastery errors
   - [`defaultObjects=false`] *(boolean)*: when [inserting](../model/insert.html#defaults-example), undefined embedded documents and arrays are defined
+  - [`logLevel=2`] *(number)*: 1=errors, 2=warnings, 3=info. You can also use the debug environment variable `DEBUG=monastery:info`
   - [`nullObjects=false`] *(boolean)*: embedded documents and arrays can be set to null or an empty string (which gets converted to null). You can override this per field via `nullObject: true`.
   - [`promise=false`] *(boolean)*: return a promise instead of the manager instance
   - [`timestamps=true`] *(boolean)*: whether to use [`createdAt` and `updatedAt`](../definition), this can be overridden per operation

package/docs/manager/models.md

@@ -11,6 +11,10 @@ Setup model definitions from a folder location
 
 `path` *(string)*: path to model definitions, the filenames are used as the corresponding model name. Make sure the model definition is exported as the default
 
+[`options`] *(object)*:
+  - [`commonJs=false`] *(boolean)*: for old commonjs projects, you will need to set this to `true` which uses `require` instead of `import` (removed in `3.0.0`)
+  - [`waitForIndexes=false`] *(boolean)*: returns a proimse that waits for the Mongo collection indexes to be setup
+
 ### Returns
 
 A promise with an array of [model](../model) instances, the model instances will also be available at:

package/docs/readme.md

@@ -133,10 +133,12 @@ You can view MongoDB's [compatibility table here](https://www.mongodb.com/docs/d
 
 ## Debugging
 
-This package uses [debug](https://github.com/visionmedia/debug) which allows you to set different levels of output via the `DEBUG` environment variable. Due to known limations `monastery:warning` and `monastery:error` are forced on, you can however disable these via [manager settings](./manager).
+This package uses [debug](https://github.com/visionmedia/debug) which allows you to set the level of output via the `DEBUG` environment variable. Using `DEBUG` will override the manager's `logLevel` option, e.g. `monastery('...', { logLevel: 3 })`.
 
 ```bash
-$ DEBUG=monastery:info # shows operation information
+$ DEBUG=monastery:error # level 1, shows errors
+$ DEBUG=monastery:warn  # level 2, shows warnings and depreciation notices
+$ DEBUG=monastery:info  # level 3, shows operation information
 ```
 
 ## Contributing

package/lib/index.js

@@ -31,11 +31,14 @@ function Manager(uri, opts) {
   if (typeof opts.defaultFields != 'undefined') throw Error('opts.defaultFields has been depreciated, use opts.timestamps')
   if (typeof opts.timestamps == 'undefined') opts.timestamps = true
 
+  // opts: logLevel
+  if (typeof opts.logLevel == 'undefined') opts.logLevel = 2
+
   // opts: separate out monastery options
   const mongoOpts = Object.keys(opts||{}).reduce((acc, key) => {
     if (
       ![
-        'databaseName', 'defaultObjects', 'hideWarnings', 'hideErrors', 'imagePlugin', 'limit', 'nullObjects',
+        'databaseName', 'defaultObjects', 'logLevel', 'imagePlugin', 'limit', 'nullObjects',
         'promise', 'timestamps', 'useMilliseconds',
       ].includes(key)) {
         acc[key] = opts[key]
@@ -45,13 +48,20 @@ function Manager(uri, opts) {
 
   // Add properties
   this.uri = uri
-  this.info = debug('monastery:info') // debug doesn't allow debuggers to be enabled by default
-  this.warn = debug('monastery:warn' + (opts.hideWarnings ? '' : '*'))
-  this.error = debug('monastery:error' + (opts.hideErrors ? '' : '*'))
+  this.error = debug('monastery:error' + (opts.logLevel > 0 ? '*' : ''))
+  this.warn = debug('monastery:warn' + (opts.logLevel > 1 ? '*' : ''))
+  this.info = debug('monastery:info' + (opts.logLevel > 2 ? '*' : ''))
   this.opts = opts
   this.beforeModel = []
   this.collections = {}
   this._openQueue = []
+
+  // If there is no DEBUG= environment variable, we will need to force the debugs on (due to bug on debug@4.3.4)
+  if (!debug.namespaces) {
+    if (opts.logLevel > 0) this.error.enabled = true
+    if (opts.logLevel > 1) this.warn.enabled = true
+    if (opts.logLevel > 2) this.info.enabled = true
+  }
   
   // Create a new MongoDB Client
   if (typeof this.uri == 'string' || Array.isArray(this.uri)) {
@@ -272,6 +282,7 @@ Manager.prototype.parseData = function(obj) {
 }
 
 Manager.prototype.model = Model
+Manager.prototype._getSignedUrl = imagePluginFile._getSignedUrl
 
 inherits(Manager, EventEmitter)
 module.exports = Manager 

package/lib/model.js

@@ -263,7 +263,7 @@ Model.prototype._setupIndexes = async function(fields, opts={}) {
   let textIndex = { name: 'text', key: {} }
 
   // No db defined
-  if (!((model.manager||{})._state||{}).match(/^open/)) {
+  if (!((model.manager||{})._state||'').match(/^open/)) {
     throw new Error(`Skipping createIndex on the '${model.name||''}' model, no mongodb connection found.`)
   }
 

package/package.json

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

package/plugins/images/index.js

@@ -38,16 +38,16 @@ let plugin = module.exports = {
     this.path = options.path || function (uid, basename, ext, file) { return `full/${uid}.${ext}` }
 
     if (!options.awsBucket || !options.awsAccessKeyId || !options.awsSecretAccessKey) {
-      manager.error('Monastery imagePlugin: awsBucket, awsAccessKeyId, or awsSecretAccessKey is not defined')
-      delete manager.opts.imagePlugin
-      return
+      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"')
     }
 
     // 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
-    manager._getSignedUrl = this._getSignedUrl
     this.getS3Client = () => {
       const { S3 } = require('@aws-sdk/client-s3')
       return this._s3Client || (this._s3Client = new S3({
@@ -598,8 +598,10 @@ let plugin = module.exports = {
      * @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.awsRegion) {
-      throw 'Monastery requires config.awsRegion to be defined when using getSignedUrl\'s'
+    if (!plugin.getS3Client) {
+      throw new Error(
+        '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 }

package/test/model.js

@@ -7,16 +7,18 @@ beforeAll(async () => { db = monastery('127.0.0.1/monastery') })
 afterAll(async () => { db.close() })
 
 test('model > model on manager', async () => {
-  db.model('user', { fields: {} })
-  let modelNamedConflict = db.model('open', { fields: {} })
+  const db2 = monastery('127.0.0.1', { logLevel: 0 })
+  db2.model('user', { fields: {} })
+  let modelNamedConflict = db2.model('open', { fields: {} })
 
   // Model added to manager[model]
-  expect(db.user).toEqual(expect.any(Object))
-  expect(db.models.user).toEqual(expect.any(Object))
+  expect(db2.user).toEqual(expect.any(Object))
+  expect(db2.models.user).toEqual(expect.any(Object))
 
   // Model with a name conflict is only added to manager.models[name]
-  expect(db.open).toEqual(expect.any(Function))
-  expect(db.models.open).toEqual(modelNamedConflict)
+  expect(db2.open).toEqual(expect.any(Function))
+  expect(db2.models.open).toEqual(modelNamedConflict)
+  db2.close()
 })
 
 test('model setup', async () => {
@@ -313,8 +315,8 @@ test('model setup with messages', async () => {
 
 test('model reserved rules', async () => {
   // Setup
-  // let db = (await opendb(false, { hideErrors: true })).db // hide debug error
-  let user = db.model('user-model', {
+  const db2 = monastery('127.0.0.1/monastery', { logLevel: 0 })
+  let user = db2.model('user-model', {
     fields: {
       name: {
         type: 'string',
@@ -324,7 +326,7 @@ test('model reserved rules', async () => {
     },
     rules: {
       params: (value) => {
-        return false // shouldn'r run
+        return false // shouldn't run
       },
     },
   })
@@ -333,6 +335,7 @@ test('model reserved rules', async () => {
     createdAt: expect.any(Number),
     updatedAt: expect.any(Number),
   })
+  db2.close()
 })
 
 test('model indexes', async () => {

package/test/plugin-images.js

@@ -881,7 +881,7 @@ test('images options awsAcl, awsBucket, metadata, params, path', async () => {
 test('images option depreciations', async () => {
   // testing (filename bucketDir)
   const db3 = monastery('127.0.0.1/monastery', {
-    hideWarnings: true,
+    logLevel: 1,
     timestamps: false, 
     imagePlugin: { 
       awsBucket: 'fake',