@bedrockio/model 0.19.1 → 0.19.3

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.19.3
+
+- Fixed issue with unknown sort fields throwing in aggregations.
+
+## 0.19.2
+
+- Fixed issue with delete hooks in subdocument arrays.
+
 ## 0.19.1
 
 - Fix for deep cache field not saving.

package/dist/cjs/delete-hooks.js

@@ -11,7 +11,8 @@ var _errors = require("./errors");
 var _utils = require("./utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const {
-  ObjectId: SchemaObjectId
+  ObjectId: SchemaObjectId,
+  DocumentArray: SchemaDocumentArray
 } = _mongoose.default.Schema.Types;
 function addDeletedFields(definition) {
   let {
@@ -223,7 +224,7 @@ function assertModelNames(arr = []) {
 function getAllReferences(doc) {
   const targetName = doc.constructor.modelName;
   return Object.values(_mongoose.default.models).map(model => {
-    const paths = getModelReferences(model, targetName);
+    const paths = getModelReferences(model.schema, targetName);
     return {
       model,
       paths
@@ -234,10 +235,13 @@ function getAllReferences(doc) {
     return paths.length > 0;
   });
 }
-function getModelReferences(model, targetName) {
-  const paths = [];
-  model.schema.eachPath((schemaPath, schemaType) => {
-    if (schemaType instanceof SchemaObjectId && schemaPath[0] !== '_') {
+function getModelReferences(schema, targetName, path = []) {
+  let references = [];
+  schema.eachPath((name, schemaType) => {
+    if (name.startsWith('_') || name === 'deletedRefs') {
+      return;
+    }
+    if (schemaType instanceof SchemaObjectId) {
       const {
         ref,
         refPath
@@ -246,16 +250,18 @@ function getModelReferences(model, targetName) {
       if (ref) {
         refs = [ref];
       } else if (refPath) {
-        refs = model.schema.path(refPath).options.enum;
+        refs = schema.path(refPath).options.enum;
       } else {
-        throw new Error(`Cannot derive refs for ${model.modelName}#${schemaPath}.`);
+        throw new Error(`Cannot derive refs for ${targetName}#${name}.`);
       }
       if (refs.includes(targetName)) {
-        paths.push(schemaPath);
+        references.push([...path, name].join('.'));
       }
+    } else if (schemaType instanceof SchemaDocumentArray) {
+      references = [...references, ...getModelReferences(schemaType.schema, targetName, [name])];
     }
   });
-  return paths;
+  return references;
 }
 
 // Delete

package/dist/cjs/search.js

@@ -123,7 +123,9 @@ function searchPipeline(Model, pipeline, options) {
     limit,
     sort
   } = options;
-  sort = resolveSort(sort, schema);
+  sort = resolveSort(sort, schema, {
+    allowUnknown: true
+  });
   if (_env.debug) {
     _logger.default.info(`Search pipeline for ${Model.modelName}:\n`, JSON.stringify(pipeline, null, 2));
   }
@@ -168,7 +170,10 @@ function validateDefinition(definition) {
     throw new Error('Invalid model definition.');
   }
 }
-function resolveSort(sort, schema) {
+function resolveSort(sort, schema, options = {}) {
+  const {
+    allowUnknown = false
+  } = options;
   if (!sort) {
     return {
       _id: 1
@@ -186,8 +191,10 @@ function resolveSort(sort, schema) {
     if (name) {
       throw new Error('Sort property "name" is not allowed. Use "field" instead.');
     }
-    if (!field.startsWith('$') && !schema.path(field)) {
-      throw new Error(`Unknown sort field "${field}".`);
+    if (!schema.path(field)) {
+      if (!allowUnknown && !field.startsWith('$')) {
+        throw new Error(`Unknown sort field "${field}".`);
+      }
     }
     result[field] = order === 'desc' ? -1 : 1;
   }

package/package.json

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

package/src/delete-hooks.js

@@ -4,7 +4,8 @@ import mongoose from 'mongoose';
 import { ReferenceError } from './errors';
 import { getInnerField } from './utils';
 
-const { ObjectId: SchemaObjectId } = mongoose.Schema.Types;
+const { ObjectId: SchemaObjectId, DocumentArray: SchemaDocumentArray } =
+  mongoose.Schema.Types;
 
 export function addDeletedFields(definition) {
   let { onDelete: deleteHooks } = definition;
@@ -215,7 +216,7 @@ function getAllReferences(doc) {
   const targetName = doc.constructor.modelName;
   return Object.values(mongoose.models)
     .map((model) => {
-      const paths = getModelReferences(model, targetName);
+      const paths = getModelReferences(model.schema, targetName);
       return { model, paths };
     })
     .filter(({ paths }) => {
@@ -223,27 +224,34 @@ function getAllReferences(doc) {
     });
 }
 
-function getModelReferences(model, targetName) {
-  const paths = [];
-  model.schema.eachPath((schemaPath, schemaType) => {
-    if (schemaType instanceof SchemaObjectId && schemaPath[0] !== '_') {
+function getModelReferences(schema, targetName, path = []) {
+  let references = [];
+  schema.eachPath((name, schemaType) => {
+    if (name.startsWith('_') || name === 'deletedRefs') {
+      return;
+    }
+
+    if (schemaType instanceof SchemaObjectId) {
       const { ref, refPath } = schemaType.options;
       let refs;
       if (ref) {
         refs = [ref];
       } else if (refPath) {
-        refs = model.schema.path(refPath).options.enum;
+        refs = schema.path(refPath).options.enum;
       } else {
-        throw new Error(
-          `Cannot derive refs for ${model.modelName}#${schemaPath}.`,
-        );
+        throw new Error(`Cannot derive refs for ${targetName}#${name}.`);
       }
       if (refs.includes(targetName)) {
-        paths.push(schemaPath);
+        references.push([...path, name].join('.'));
       }
+    } else if (schemaType instanceof SchemaDocumentArray) {
+      references = [
+        ...references,
+        ...getModelReferences(schemaType.schema, targetName, [name]),
+      ];
     }
   });
-  return paths;
+  return references;
 }
 
 // Delete

package/src/search.js

@@ -129,7 +129,9 @@ function searchPipeline(Model, pipeline, options) {
   options = mergeOptions(SEARCH_DEFAULTS, options);
 
   let { skip, limit, sort } = options;
-  sort = resolveSort(sort, schema);
+  sort = resolveSort(sort, schema, {
+    allowUnknown: true,
+  });
 
   if (debug) {
     logger.info(
@@ -199,7 +201,9 @@ function validateDefinition(definition) {
   }
 }
 
-function resolveSort(sort, schema) {
+function resolveSort(sort, schema, options = {}) {
+  const { allowUnknown = false } = options;
+
   if (!sort) {
     return { _id: 1 };
   }
@@ -216,8 +220,10 @@ function resolveSort(sort, schema) {
         'Sort property "name" is not allowed. Use "field" instead.',
       );
     }
-    if (!field.startsWith('$') && !schema.path(field)) {
-      throw new Error(`Unknown sort field "${field}".`);
+    if (!schema.path(field)) {
+      if (!allowUnknown && !field.startsWith('$')) {
+        throw new Error(`Unknown sort field "${field}".`);
+      }
     }
 
     result[field] = order === 'desc' ? -1 : 1;

package/types/delete-hooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"delete-hooks.d.ts","sourceRoot":"","sources":["../src/delete-hooks.js"],"names":[],"mappings":"AAQA,wDAgBC;AAED,qEAqCC"}
+{"version":3,"file":"delete-hooks.d.ts","sourceRoot":"","sources":["../src/delete-hooks.js"],"names":[],"mappings":"AASA,wDAgBC;AAED,qEAqCC"}

package/types/search.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.js"],"names":[],"mappings":"AAuBA,gEAaC;AAED;;;;;;;;;;;;kBAmHU,CAAC;oBAGD,CAAP;qBACoB,CAAC;sBAGlB,CAAD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA7B6B,CAAC;;;;;;;;;;;;;;EApElC;AAED;;;;;;;;;;;;;;;;mBA1BmD,CAAC;;;;;;;;;;;;qBAuBlD,CAAC;sBAGmB,CAAC;sBACrB,CAAC;wBAA8B,CAAC;wBACrB,CAAC;;;4BAwBc,CAAC;kCAK3B,CAAD;wBACc,CAAC;wBAA+B,CAAC;wCACtB,CAAC;2BAGhB,CAAC;kCAES,CAAC;2BACd,CAAC;qBACL,CAAJ;;;uBAuBgC,CAAC;6BAEjB,CAAC;8BACF,CAAC;6BAGZ,CAAH;0BACgB,CAAC;6BACZ,CAAF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAL8B,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA5FgB,CAAC;;;;;;;;;;;;qBAuBlD,CAAC;sBAGmB,CAAC;sBACrB,CAAC;wBAA8B,CAAC;wBACrB,CAAC;;;4BAwBc,CAAC;kCAK3B,CAAD;wBACc,CAAC;wBAA+B,CAAC;wCACtB,CAAC;2BAGhB,CAAC;kCAES,CAAC;2BACd,CAAC;qBACL,CAAJ;;;uBAuBgC,CAAC;6BAEjB,CAAC;8BACF,CAAC;6BAGZ,CAAH;0BACgB,CAAC;6BACZ,CAAF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAL8B,CAAC;;;;;;;;;;;;;;;;;EArDlC"}
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../src/search.js"],"names":[],"mappings":"AAuBA,gEAaC;AAED;;;;;;;;;;;;kBAoHY,CAAL;oBACI,CAAC;qBAGF,CAAL;sBACqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eA5BQ,CAAA;;;;;;;;;;;;;;EApElC;AAED;;;;;;;;;;;;;;;;mBA1BmD,CAAC;;;;;;;;;;;;qBAuBlD,CAAC;sBAGmB,CAAC;sBACrB,CAAC;wBAA8B,CAAC;wBACrB,CAAC;;;4BAwBc,CAAC;kCAK3B,CAAD;wBACc,CAAC;wBAA+B,CAAC;wCACtB,CAAC;2BAGhB,CAAC;kCAES,CAAC;2BACd,CAAC;qBACL,CAAJ;;;uBAuBgC,CAAC;6BAEjB,CAAC;8BACF,CAAC;6BACD,CAAC;0BAIZ,CAAA;6BACmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBANW,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA5FgB,CAAC;;;;;;;;;;;;qBAuBlD,CAAC;sBAGmB,CAAC;sBACrB,CAAC;wBAA8B,CAAC;wBACrB,CAAC;;;4BAwBc,CAAC;kCAK3B,CAAD;wBACc,CAAC;wBAA+B,CAAC;wCACtB,CAAC;2BAGhB,CAAC;kCAES,CAAC;2BACd,CAAC;qBACL,CAAJ;;;uBAuBgC,CAAC;6BAEjB,CAAC;8BACF,CAAC;6BACD,CAAC;0BAIZ,CAAA;6BACmB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBANW,CAAA;;;;;;;;;;;;;;;;;EArDlC"}