Merge pull request #41 from DesignByOnyx/33-default-lean-options

feat: allow default lean options plugin config

Author: vkarpov15

README.md

@@ -24,3 +24,29 @@ await Model.create({ name: 'Captain Jean-Luc Picard' });
 const doc = await Model.findOne().lean({ getters: true });
 doc.name; // 'Picard'
 ```
+
+You may also set the default lean options to always use getters:
+
+```javascript
+const mongoose = require('mongoose');
+const mongooseLeanGetters = require('mongoose-lean-getters');
+
+const schema = mongoose.Schema({
+  name: {
+    type: String,
+    // Get the last 6 characters of the string
+    get: v => v.slice(-6)
+  }
+});
+// Set the default options for all lean queries
+schema.plugin(mongooseLeanGetters, { defaultLeanOptions: { getters: true }});
+
+await Model.create({ name: 'Captain Jean-Luc Picard' });
+
+const doc = await Model.findOne().lean();
+doc.name; // 'Picard'
+
+// You may also set getters: false at call time
+const doc2 = await Model.findOne().lean({ getters: false });
+doc2.name; // 'Captain Jean-Luc Picard'
+```

index.d.ts

@@ -3,6 +3,7 @@
 
 declare module 'mongoose-lean-getters' {
   import mongoose = require('mongoose');
-  export default function mongooseLeanGetters(schema: mongoose.Schema<any, any, any, any>, opts?: any): void;
-  export function mongooseLeanGetters(schema: mongoose.Schema<any, any, any, any>, opts?: any): void;
-}
+  export type LeanGettersOptions = { defaultLeanOptions?: { getters: boolean } };
+  export default function mongooseLeanGetters(schema: mongoose.Schema<any, any, any, any>, opts?: LeanGettersOptions): void;
+  export function mongooseLeanGetters(schema: mongoose.Schema<any, any, any, any>, opts?: LeanGettersOptions): void;
+}

index.js

@@ -2,8 +2,8 @@
 
 const mpath = require('mpath');
 
-module.exports = function mongooseLeanGetters(schema) {
-  const fn = applyGettersMiddleware(schema);
+module.exports = function mongooseLeanGetters(schema, options) {
+  const fn = applyGettersMiddleware(schema, options);
   // Use `pre('find')` so this also works with `cursor()`
   // and `eachAsync()`, because those do not call `post('find')`
   schema.pre('find', function() {
@@ -31,8 +31,9 @@ module.exports = function mongooseLeanGetters(schema) {
   schema.post('findOneAndReplace', fn);
 };
 
-function applyGettersMiddleware(schema) {
+function applyGettersMiddleware(schema, options) {
   return function(res) {
+    this._mongooseLeanGettersOptions = options || {};
     applyGetters.call(this, schema, res);
   };
 }
@@ -41,7 +42,10 @@ function applyGetters(schema, res, path) {
   if (res == null) {
     return;
   }
-  if (this._mongooseOptions.lean && this._mongooseOptions.lean.getters) {
+  const { defaultLeanOptions } = this._mongooseLeanGettersOptions;
+  const shouldCallGetters = this._mongooseOptions?.lean?.getters ?? defaultLeanOptions?.getters ?? false;
+
+  if (shouldCallGetters) {
     if (Array.isArray(res)) {
       const len = res.length;
       for (let i = 0; i < len; ++i) {

test/index.test.js

@@ -401,6 +401,24 @@ describe('mongoose-lean-getters', function() {
     assert.strictEqual(doc.field, '1337');
   });
 
+  it('allows defaultLeanOptions to be set and overridden at call time (#33)', async() => {
+    const testSchema = new mongoose.Schema({
+      field: {
+        type: String,
+        get(val) { return `${val}-suffix`; },
+      }
+    });
+    testSchema.plugin(mongooseLeanGetters, { defaultLeanOptions: { getters: true } });
+
+    const TestModel = mongoose.model('gh-33', testSchema);
+    const entry = await TestModel.create({ field: 'value' });
+    const doc1 = await TestModel.findById(entry._id).lean();
+    assert.equal(doc1.field, 'value-suffix');
+
+    const doc2 = await TestModel.findById(entry._id).lean({ getters: false });
+    assert.equal(doc2.field, 'value');
+  });
+
   it('should allow non-discriminated documents to be retrieved (#39)', async() => {
     const baseSchema = new mongoose.Schema({ foo: String });
     baseSchema.plugin(mongooseLeanGetters);