@bedrockio/model 0.21.1 → 0.21.3

package/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 0.21.3
+
+- Fixed issue with middleware hook patch.
+- Output model name in UniqueConstraintError.
+
+## 0.21.2
+
+- Export `loadDefinition` and readme updates.
+
 ## 0.21.1
 
 - Fixed issues with schema loading.

package/README.md

@@ -6,6 +6,7 @@ Bedrock utilities for model creation.
 - [Dependencies](#dependencies)
 - [Usage](#usage)
 - [Schemas](#schemas)
+  - [Schema Comments](#schema-comments)
 - [Schema Extensions](#schema-extensions)
   - [Attributes](#attributes)
   - [Scopes](#scopes)
@@ -58,14 +59,13 @@ const { loadModelDir } = require('@bedrockio/model');
 model.exports = loadModelDir('path/to/definitions/');
 ```
 
-Models that need to be extended can use the `createSchema` method with the
-definition and add to the schema as needed:
+Models that need to be extended can use the `loadSchema` method.
 
 ```js
 const mongoose = require('mongoose');
-const definition = require('./definitions/user.json');
+const { loadSchema } = require('@bedrockio/model')
 
-const schema = createSchema(definition);
+const schema = loadSchema('user');
 
 schema.virtual('name').get(function () {
   return [this.firstName, this.lastName].join(' ');
@@ -89,7 +89,7 @@ model.exports = {
 The `attributes` field of model definitions can be considered equivalent to
 Mongoose, but defined in JSON with extended features:
 
-```js
+```jsonc
 {
   "attributes": {
     // Shortcut for the syntax below.
@@ -129,6 +129,21 @@ Links:
 - [Validation](#validation)
 - [Access Control](#access-control)
 
+
+#### Schema Comments
+
+Schemas may be `.jsonc` which will allow comments in definitions:
+
+```jsonc
+// user.jsonc
+{
+  "attributes": {
+    // User name
+    "name": "String",
+  }
+}
+```
+
 ### Schema Extensions
 
 This module provides a number of extensions to assist schema creation outside
@@ -1168,6 +1183,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
@@ -1190,6 +1216,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

@@ -3,6 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
+exports.loadDefinition = loadDefinition;
 exports.loadModel = loadModel;
 exports.loadModelDir = loadModelDir;
 exports.loadSchema = loadSchema;
@@ -35,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/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.1",
+  "version": "0.21.3",
   "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);
@@ -64,7 +65,7 @@ export function loadSchema(name, dir) {
 const DEFINITION_DIR = 'src/models/definitions';
 const SCHEMA_EXTENSIONS = ['.json', '.jsonc'];
 
-function loadDefinition(name, dir) {
+export function loadDefinition(name, dir) {
   const { filepath, ext } = resolvePath(name, dir);
   const content = fs.readFileSync(filepath, 'utf-8');
   return ext === '.jsonc' ? parseWithComments(content) : JSON.parse(content);

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.
@@ -33,5 +36,6 @@ export function loadSchema(name: string, dir?: string): mongoose.Schema<any, mon
 }> & {
     __v: number;
 }>;
+export function loadDefinition(name: any, dir: any): any;
 import mongoose from 'mongoose';
 //# sourceMappingURL=load.d.ts.map

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;qBAvDoB,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"}