add functions option to TypeScript types and test case for mongodb-js#112

Author: vkarpov15

index.d.ts

@@ -1,5 +1,12 @@
 import { Schema } from 'mongoose';
 
-declare function mongooseAutoPopulate(schema: Schema): void;
+export type AutopopulatedFunctionNames = 'find' | 'findOne' | 'findOneAndUpdate' | 'findOneAndDelete' | 'findOneAndReplace' | 'save';
 
-export default mongooseAutoPopulate;
+interface AutopopulateOptions {
+  // Only autopopulate on the given functions
+  functions?: AutopopulatedFunctionNames[] | RegExp
+}
+
+declare function mongooseAutoPopulate(schema: Schema, options?: AutopopulateOptions): void;
+
+export default mongooseAutoPopulate;

package.json

@@ -27,11 +27,11 @@
     "acquit-markdown": "0.1.0",
     "eslint": "7.32.0",
     "mocha": "5.1.1",
-    "mongoose": "9.0.0-rc1",
+    "mongoose": "git@github.com:Automattic/mongoose.git#vkarpov15/mongodb-js/mongoose-autopopulate#112",
     "nyc": "11.7.3"
   },
   "peerDependencies": {
-    "mongoose": "6.x || 7.x || 8.x || ^9.0.0-0"
+    "mongoose": "6.x || 7.x || 8.x || 9.x"
   },
   "types": "./index.d.ts",
   "author": "Valeri Karpov <val@karpov.io>",

test/bugs.test.js

@@ -360,4 +360,78 @@ describe('bug fixes', function() {
     section = await Section.findById(section);
     assert.equal(section.subdoc.subSection.name, 'foo');
   });
+
+  it('supports match as a function in virtuals (gh-112)', async function() {
+    const teacherSchema = new Schema({
+      schoolClass: {
+        type: Schema.Types.ObjectId,
+        ref: 'gh112_SchoolClass',
+        autopopulate: { maxDepth: 2 }
+      },
+      schoolSubject: {
+        type: Schema.Types.ObjectId,
+        ref: 'gh112_SchoolSubject',
+        autopopulate: { maxDepth: 2 }
+      }
+    });
+
+    const lectureSchema = new Schema({
+      schoolClass: {
+        type: Schema.Types.ObjectId,
+        ref: 'gh112_SchoolClass',
+        autopopulate: { maxDepth: 2 }
+      },
+      schoolSubject: {
+        type: Schema.Types.ObjectId,
+        ref: 'gh112_SchoolSubject',
+        autopopulate: { maxDepth: 2 }
+      }
+    });
+
+    lectureSchema.virtual('assignedTeacher', {
+      ref: 'gh112_Teacher',
+      localField: 'schoolClass',
+      foreignField: 'schoolClass',
+      autopopulate: { maxDepth: 2 },
+      match: (lecture) => ({
+        schoolSubject: lecture.schoolSubject
+      }),
+      justOne: true
+    });
+
+    teacherSchema.plugin(autopopulate);
+    lectureSchema.plugin(autopopulate);
+
+    const Teacher = db.model('gh112_Teacher', teacherSchema);
+    const Lecture = db.model('gh112_Lecture', lectureSchema);
+    const SchoolClass = db.model('gh112_SchoolClass', new Schema({ name: String }));
+    const SchoolSubject = db.model('gh112_SchoolSubject', new Schema({ name: String }));
+
+    // Clean up any leftover data from previous runs
+    await Teacher.deleteMany({});
+    await Lecture.deleteMany({});
+    await SchoolClass.deleteMany({});
+    await SchoolSubject.deleteMany({});
+
+    const schoolClass = await SchoolClass.create({ name: 'MTH-101' });
+    const schoolSubject = await SchoolSubject.create({ name: 'Math' });
+
+    await Teacher.create({
+      schoolClass: schoolClass._id,
+      schoolSubject: schoolSubject._id
+    });
+
+    await Lecture.create({
+      schoolClass: schoolClass._id,
+      schoolSubject: schoolSubject._id
+    });
+
+    const lecture = await Lecture.findOne();
+    assert.ok(lecture.assignedTeacher);
+    // schoolClass/schoolSubject may be populated documents or ObjectIds depending on Mongoose version
+    const teacherSchoolClassId = lecture.assignedTeacher.schoolClass._id || lecture.assignedTeacher.schoolClass;
+    const teacherSchoolSubjectId = lecture.assignedTeacher.schoolSubject._id || lecture.assignedTeacher.schoolSubject;
+    assert.equal(teacherSchoolClassId.toString(), schoolClass._id.toString());
+    assert.equal(teacherSchoolSubjectId.toString(), schoolSubject._id.toString());
+  });
 });