@bedrockio/model 0.19.2 → 0.19.3

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.19.3
+
+- Fixed issue with unknown sort fields throwing in aggregations.
+
 ## 0.19.2
 
 - Fixed issue with delete hooks in subdocument arrays.

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.2",
+  "version": "0.19.3",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {

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/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"}