@bedrockio/model 0.21.2 → 0.22.0

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.22.0
+
+- Removed regex parsing in search.
+
+## 0.21.3
+
+- Fixed issue with middleware hook patch.
+- Output model name in UniqueConstraintError.
+
 ## 0.21.2
 
 - Export `loadDefinition` and readme updates.

package/README.md

@@ -603,8 +603,6 @@ Input to `search` will execute the optimal mongo query and supports several
 advanced features:
 
 - Array fields will be executed using `$in`.
-- Javascript regular expressions will map to `$regex` which allows for
-  [more advanced PCRE compatible features](https://docs.mongodb.com/manual/reference/operator/query/regex/#pcre-vs-javascript).
 - Nested objects will be automatically flattened to query subdocuments:
 
 ```
@@ -1183,6 +1181,17 @@ const user = await User.find({
 });
 ```
 
+#### Include with Create
+
+Includes are not allowed in create operations by default. Instead use the `createWithInclude` method:
+
+```js
+const user = await User.createWithInclude({
+  firstName: 'Frank',
+  include: 'profile',
+});
+```
+
 #### Validation with includes
 
 The [validation](#validation) methods additionally allow `include` as a special
@@ -1205,6 +1214,18 @@ The `getSearchValidation` will allow the `include` property to be passed,
 letting the client populate documents as they require. Note that the fields a
 client is able to include is subject to [access control](#access-control).
 
+Additionally the `getIncludeValidation` exports the includes as a standalone schema so that it can be used ad-hoc in routes and [composed with other custom validations](https://github.com/bedrockio/yada#append).
+
+
+|Method|Includes|
+|---|---|
+|getSearchValiation|default|
+|getIncludeValidation|default|
+|getCreateValidation|optional|
+|getUpdateValidation|optional|
+
+
+
 #### Other Differences with Populate
 
 Calling `populate` on a Mongoose document will always load the current data. In

package/dist/cjs/load.js

@@ -36,6 +36,7 @@ function loadModel(definition, name) {
  * Loads all model definitions in the given directory.
  * Returns the full loaded model set.
  * @param {string} dir
+ * @returns {{ [name: string]: mongoose.Model<any> }}
  */
 function loadModelDir(dir) {
   const files = _fs.default.readdirSync(dir);

package/dist/cjs/search.js

@@ -351,8 +351,6 @@ function hasTextIndex(schema) {
 // handling specialed query syntax:
 // ranges:
 //  path: { min: n, max n }
-// regex:
-//  path: "/reg/"
 // array:
 //  path; [1,2,3]
 function normalizeQuery(query, schema, root = {}, rootPath = []) {
@@ -364,8 +362,6 @@ function normalizeQuery(query, schema, root = {}, rootPath = []) {
       }
     } else if (isNestedQuery(key, value)) {
       normalizeQuery(value, (0, _utils.getField)(schema, key), root, path);
-    } else if (isRegexQuery(key, value)) {
-      root[path.join('.')] = parseRegexQuery(value);
     } else if (isArrayQuery(key, value)) {
       root[path.join('.')] = {
         $in: value
@@ -420,23 +416,6 @@ function isInclude(str) {
   return str === 'include';
 }
 
-// Regex queries
-
-const REGEX_QUERY = /^\/(.+)\/(\w*)$/;
-function isRegexQuery(key, value) {
-  return REGEX_QUERY.test(value);
-}
-function parseRegexQuery(str) {
-  // Note that using the $options syntax allows for PCRE features
-  // that aren't supported in Javascript as compared to RegExp(...):
-  // https://docs.mongodb.com/manual/reference/operator/query/regex/#pcre-vs-javascript
-  const [, $regex, $options] = str.match(REGEX_QUERY);
-  return {
-    $regex,
-    $options
-  };
-}
-
 // Search field caching
 
 function validateSearchFields(schema, definition) {

package/dist/cjs/soft-delete.js

@@ -35,8 +35,11 @@ async function assertUnique(options) {
   const exists = await model.exists(query);
   if (exists) {
     const message = getUniqueErrorMessage(field, options);
+    const {
+      modelName
+    } = model;
     throw new _errors.UniqueConstraintError(message, {
-      model,
+      modelName,
       field,
       value
     });
@@ -407,6 +410,12 @@ function applyHookPatch(schema) {
   const schemaPre = schema.pre;
   const schemaPost = schema.post;
   schema.pre = function (name, fn) {
+    // Newer Mongoose versions appear to use internal plugins
+    // that pass objects instead of functions here (not documented)
+    // so abort and pass to internal handler.
+    if (typeof fn !== 'function') {
+      return schemaPre.apply(this, arguments);
+    }
     if (name === 'restore') {
       // Document hooks
       schemaPre.call(this, 'save', getPreDocRestore(fn));

package/package.json

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

package/src/load.js

@@ -30,6 +30,7 @@ export function loadModel(definition, name) {
  * Loads all model definitions in the given directory.
  * Returns the full loaded model set.
  * @param {string} dir
+ * @returns {{ [name: string]: mongoose.Model<any> }}
  */
 export function loadModelDir(dir) {
   const files = fs.readdirSync(dir);

package/src/search.js

@@ -398,8 +398,6 @@ function hasTextIndex(schema) {
 // handling specialed query syntax:
 // ranges:
 //  path: { min: n, max n }
-// regex:
-//  path: "/reg/"
 // array:
 //  path; [1,2,3]
 function normalizeQuery(query, schema, root = {}, rootPath = []) {
@@ -411,8 +409,6 @@ function normalizeQuery(query, schema, root = {}, rootPath = []) {
       }
     } else if (isNestedQuery(key, value)) {
       normalizeQuery(value, getField(schema, key), root, path);
-    } else if (isRegexQuery(key, value)) {
-      root[path.join('.')] = parseRegexQuery(value);
     } else if (isArrayQuery(key, value)) {
       root[path.join('.')] = { $in: value };
     } else if (isEmptyArrayQuery(schema, key, value)) {
@@ -475,25 +471,6 @@ function isInclude(str) {
   return str === 'include';
 }
 
-// Regex queries
-
-const REGEX_QUERY = /^\/(.+)\/(\w*)$/;
-
-function isRegexQuery(key, value) {
-  return REGEX_QUERY.test(value);
-}
-
-function parseRegexQuery(str) {
-  // Note that using the $options syntax allows for PCRE features
-  // that aren't supported in Javascript as compared to RegExp(...):
-  // https://docs.mongodb.com/manual/reference/operator/query/regex/#pcre-vs-javascript
-  const [, $regex, $options] = str.match(REGEX_QUERY);
-  return {
-    $regex,
-    $options,
-  };
-}
-
 // Search field caching
 
 function validateSearchFields(schema, definition) {

package/src/soft-delete.js

@@ -28,8 +28,10 @@ export async function assertUnique(options) {
 
   if (exists) {
     const message = getUniqueErrorMessage(field, options);
+    const { modelName } = model;
+
     throw new UniqueConstraintError(message, {
-      model,
+      modelName,
       field,
       value,
     });
@@ -454,6 +456,13 @@ function applyHookPatch(schema) {
   const schemaPost = schema.post;
 
   schema.pre = function (name, fn) {
+    // Newer Mongoose versions appear to use internal plugins
+    // that pass objects instead of functions here (not documented)
+    // so abort and pass to internal handler.
+    if (typeof fn !== 'function') {
+      return schemaPre.apply(this, arguments);
+    }
+
     if (name === 'restore') {
       // Document hooks
       schemaPre.call(this, 'save', getPreDocRestore(fn));

package/types/generated/load.d.ts

@@ -9,8 +9,11 @@ export function loadModel(definition: object, name: string): any;
  * Loads all model definitions in the given directory.
  * Returns the full loaded model set.
  * @param {string} dir
+ * @returns {{ [name: string]: mongoose.Model<any> }}
  */
-export function loadModelDir(dir: string): mongoose.Models;
+export function loadModelDir(dir: string): {
+    [name: string]: mongoose.Model<any>;
+};
 /**
  * Loads the schema from a .json or .jsonc file.
  * @param {string} name - The model or schema name.

package/types/generated/load.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/load.js"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,sCAJW,MAAM,QACN,MAAM,OAahB;AAED;;;;GAIG;AACH,kCAFW,MAAM,mBAoBhB;AAED;;;;GAIG;AACH,iCAHW,MAAM,QACN,MAAM;;;;;;;;;;;;;;;;GAKhB;AAKD,yDAIC;qBAhEoB,UAAU"}
+{"version":3,"file":"load.d.ts","sourceRoot":"","sources":["../../src/load.js"],"names":[],"mappings":"AAUA;;;;;GAKG;AACH,sCAJW,MAAM,QACN,MAAM,OAahB;AAED;;;;;GAKG;AACH,kCAHW,MAAM,GACJ;IAAE,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;CAAE,CAoBnD;AAED;;;;GAIG;AACH,iCAHW,MAAM,QACN,MAAM;;;;;;;;;;;;;;;;GAKhB;AAKD,yDAIC;qBAjEoB,UAAU"}

package/types/generated/soft-delete.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../../src/soft-delete.js"],"names":[],"mappings":"AAMA,mDAIC;AAED,0DAwBC"}
+{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../../src/soft-delete.js"],"names":[],"mappings":"AAMA,mDAIC;AAED,0DA0BC"}