@bedrockio/model 0.12.2 → 0.12.3

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.12.3
+
+- Support for `include` with top level dynamic references.
+
 ## 0.12.2
 
 - Updated validators for string ranges.

package/README.md

@@ -1050,6 +1050,10 @@ await Product.findById(id).include('shop.user.^name').
 }
 ```
 
+> [!WARNING] Fields that are dynamically referenced using `refPath` are unable
+> to resolve the schemas beforehand (ie. before query execution), therefore they
+> can only be populated at the top level.
+
 #### Excluded Fields
 
 Fields can be excluded rather than included using `-`:

package/dist/cjs/include.js

@@ -325,6 +325,12 @@ function setNodePath(node, options) {
             exclusive
           });
           halt = true;
+        } else if (field.refPath) {
+          // Note that dynamic references with refPath cannot "see"
+          // into a field for which they don't know the type yet (ie.
+          // before the query executes), therefore by definition
+          // dynamic references can only be populated one layer deep.
+          node[key] ||= {};
         } else if ((0, _utils.isSchemaTypedef)(field)) {
           node[key] = LEAF_NODE;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.12.2",
+  "version": "0.12.3",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {

package/src/include.js

@@ -233,6 +233,7 @@ function setNodePath(node, options) {
   }
 
   const schema = mongoose.models[modelName]?.schema;
+
   if (!schema) {
     throw new Error(`Could not derive schema for ${modelName}.`);
   }
@@ -318,6 +319,12 @@ function setNodePath(node, options) {
             exclusive,
           });
           halt = true;
+        } else if (field.refPath) {
+          // Note that dynamic references with refPath cannot "see"
+          // into a field for which they don't know the type yet (ie.
+          // before the query executes), therefore by definition
+          // dynamic references can only be populated one layer deep.
+          node[key] ||= {};
         } else if (isSchemaTypedef(field)) {
           node[key] = LEAF_NODE;
         }