Merge pull request #9764 from Automattic/gh9545

feat (document): Exposed $getAllSubdocs()
Automattic · Jan 5, 2021 · d9763fc · d9763fc
2 parents fce72fe + a31efa1
commit d9763fc
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -375,6 +375,9 @@ declare module 'mongoose' {
     /** This documents __v. */
     __v?: number;
 
+    /* Get all subdocs (by bfs) */
+    $getAllSubdocs(): Document[];
+
     /** Don't run validation on this path or persist changes to this path. */
     $ignore(path: string): void;
 
@@ -2349,9 +2352,6 @@ declare module 'mongoose' {
 
     /** Appends new custom $unwind operator(s) to this aggregate pipeline. */
     unwind(...args: any[]): this;
-
-    /** Appends new custom $project operator to this aggregate pipeline. */
-    project(arg: any): this
   }
 
   class AggregationCursor extends stream.Readable {

diff --git a/lib/document.js b/lib/document.js
@@ -843,7 +843,7 @@ Document.prototype.$session = function $session(session) {
   this.$__.session = session;
 
   if (!this.ownerDocument) {
-    const subdocs = this.$__getAllSubdocs();
+    const subdocs = this.$getAllSubdocs();
     for (const child of subdocs) {
       child.$session(session);
     }
@@ -2271,7 +2271,7 @@ function _getPathsToValidate(doc) {
   Object.keys(doc.$__.activePaths.states.default).forEach(addToPaths);
   function addToPaths(p) { paths.add(p); }
 
-  const subdocs = doc.$__getAllSubdocs();
+  const subdocs = doc.$getAllSubdocs();
   const modifiedPaths = doc.modifiedPaths();
   for (const subdoc of subdocs) {
     if (subdoc.$basePath) {
@@ -2942,7 +2942,7 @@ Document.prototype.$__undoReset = function $__undoReset() {
     }
   }
 
-  for (const subdoc of this.$__getAllSubdocs()) {
+  for (const subdoc of this.$getAllSubdocs()) {
     subdoc.$__undoReset();
   }
 };
@@ -3070,13 +3070,13 @@ Document.prototype.$__getArrayPathsToValidate = function() {
 /**
  * Get all subdocs (by bfs)
  *
- * @api private
- * @method $__getAllSubdocs
+ * @api public
+ * @method $getAllSubdocs
  * @memberOf Document
  * @instance
  */
 
-Document.prototype.$__getAllSubdocs = function() {
+Document.prototype.$getAllSubdocs = function $getAllSubdocs() {
   DocumentArray || (DocumentArray = require('./types/documentarray'));
   Embedded = Embedded || require('./types/embedded');
 

diff --git a/lib/model.js b/lib/model.js
@@ -3386,7 +3386,7 @@ function _setIsNew(doc, val) {
   doc.emit('isNew', val);
   doc.constructor.emit('isNew', val);
 
-  const subdocs = doc.$__getAllSubdocs();
+  const subdocs = doc.$getAllSubdocs();
   for (const subdoc of subdocs) {
     subdoc.isNew = val;
   }

diff --git a/lib/plugins/removeSubdocs.js b/lib/plugins/removeSubdocs.js
@@ -15,7 +15,7 @@ module.exports = function(schema) {
     }
 
     const _this = this;
-    const subdocs = this.$__getAllSubdocs();
+    const subdocs = this.$getAllSubdocs();
 
     each(subdocs, function(subdoc, cb) {
       subdoc.$__remove(cb);

diff --git a/lib/plugins/saveSubdocs.js b/lib/plugins/saveSubdocs.js
@@ -15,7 +15,7 @@ module.exports = function(schema) {
     }
 
     const _this = this;
-    const subdocs = this.$__getAllSubdocs();
+    const subdocs = this.$getAllSubdocs();
 
     if (!subdocs.length) {
       next();
@@ -43,7 +43,7 @@ module.exports = function(schema) {
     }
 
     const _this = this;
-    const subdocs = this.$__getAllSubdocs();
+    const subdocs = this.$getAllSubdocs();
 
     if (!subdocs.length) {
       next();