@bedrockio/model 0.1.14 → 0.1.16

package/dist/cjs/include.js

@@ -29,9 +29,8 @@ const INCLUDE_FIELD_SCHEMA = _yada.default.object({
 });
 exports.INCLUDE_FIELD_SCHEMA = INCLUDE_FIELD_SCHEMA;
 function applyInclude(schema) {
-  schema.virtual('include').set(function (include) {
-    this.$locals.include = include;
-  });
+  // Query Includes
+
   schema.pre(/^find/, function (next) {
     const filter = this.getFilter();
     if (filter.include) {
@@ -45,19 +44,37 @@ function applyInclude(schema) {
     }
     return next();
   });
-  schema.pre('save', function () {
+
+  // Static Methods
+
+  // Async method runs the create first then calls into
+  // the instance method to run the populate.
+  schema.static('createWithInclude', async function createWithInclude(attributes) {
     const {
-      include
-    } = this.$locals;
+      include,
+      ...rest
+    } = attributes;
+    const doc = await this.create(rest);
+    if (include) {
+      await doc.include(include);
+    }
+    return doc;
+  });
+
+  // Synchronous method assigns the includes to locals.
+  // Population will be performed on the post save hook below.
+  // Selects will be performed during serialization.
+  schema.method('assignWithInclude', function assignWithInclude(attributes) {
+    const {
+      include,
+      ...rest
+    } = attributes;
+    this.assign(rest);
     if (include) {
-      let {
+      const {
         select,
         populate
       } = getDocumentIncludes(this, include);
-      const modifiedPaths = this.modifiedPaths();
-      populate = populate.filter(p => {
-        return modifiedPaths.includes(p.path);
-      });
       this.$locals.select = select;
       this.$locals.populate = populate;
     }
@@ -71,6 +88,22 @@ function applyInclude(schema) {
       delete this.$locals.populate;
     }
   });
+
+  // Instance Methods
+
+  // Perform population immediately when instance method is called.
+  // Store selects as a local variable which will be checked
+  // during serialization.
+  schema.method('include', async function include(include) {
+    if (include) {
+      const {
+        select,
+        populate
+      } = getDocumentIncludes(this, include);
+      this.$locals.select = select;
+      await this.populate(populate);
+    }
+  });
 }
 
 // "Selected" keys virtually project documents so that

package/dist/cjs/validation.js

@@ -23,16 +23,18 @@ const DATE_TAGS = {
   'x-schema': 'DateTime',
   'x-description': 'A `string` in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.'
 };
-const OBJECT_ID_SCHEMA = _yada.default.string().mongo().tag({
+const OBJECT_ID_SCHEMA = _yada.default.string().mongo().message('Must be an ObjectId.').tag({
   'x-schema': 'ObjectId',
   'x-description': 'A 24 character hexadecimal string representing a Mongo [ObjectId](https://bit.ly/3YPtGlU).'
 });
 exports.OBJECT_ID_SCHEMA = OBJECT_ID_SCHEMA;
 const REFERENCE_SCHEMA = _yada.default.allow(OBJECT_ID_SCHEMA, _yada.default.object({
   id: OBJECT_ID_SCHEMA.required()
+}).options({
+  stripUnknown: true
 }).custom(obj => {
   return obj.id;
-})).tag({
+})).message('Must be an ObjectId or object containing "id" field.').tag({
   'x-schema': 'Reference',
   'x-description': `
 A 24 character hexadecimal string representing a Mongo [ObjectId](https://bit.ly/3YPtGlU).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.1.14",
+  "version": "0.1.16",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {
@@ -25,23 +25,23 @@
     "url": "https://github.com/bedrockio/model"
   },
   "dependencies": {
-    "@bedrockio/logger": "^1.0.5",
+    "@bedrockio/logger": "^1.0.6",
     "lodash": "^4.17.21"
   },
   "peerDependencies": {
-    "@bedrockio/yada": "^1.0.25",
-    "mongoose": "^6.9.0"
+    "@bedrockio/yada": "^1.0.27",
+    "mongoose": ">=6.9.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.20.7",
     "@babel/core": "^7.20.12",
     "@babel/preset-env": "^7.20.2",
     "@bedrockio/prettier-config": "^1.0.2",
-    "@bedrockio/yada": "^1.0.26",
+    "@bedrockio/yada": "^1.0.28",
     "@shelf/jest-mongodb": "^4.1.6",
     "babel-plugin-import-replacement": "^1.0.1",
     "eslint": "^8.33.0",
-    "eslint-plugin-bedrock": "^1.0.24",
+    "eslint-plugin-bedrock": "^1.0.26",
     "jest": "^29.4.1",
     "jest-environment-node": "^29.4.1",
     "mongodb": "4.13.0",

package/src/include.js

@@ -26,9 +26,7 @@ export const INCLUDE_FIELD_SCHEMA = yd.object({
 });
 
 export function applyInclude(schema) {
-  schema.virtual('include').set(function (include) {
-    this.$locals.include = include;
-  });
+  // Query Includes
 
   schema.pre(/^find/, function (next) {
     const filter = this.getFilter();
@@ -41,14 +39,32 @@ export function applyInclude(schema) {
     return next();
   });
 
-  schema.pre('save', function () {
-    const { include } = this.$locals;
+  // Static Methods
+
+  // Async method runs the create first then calls into
+  // the instance method to run the populate.
+  schema.static(
+    'createWithInclude',
+    async function createWithInclude(attributes) {
+      const { include, ...rest } = attributes;
+      const doc = await this.create(rest);
+      if (include) {
+        await doc.include(include);
+      }
+      return doc;
+    }
+  );
+
+  // Synchronous method assigns the includes to locals.
+  // Population will be performed on the post save hook below.
+  // Selects will be performed during serialization.
+  schema.method('assignWithInclude', function assignWithInclude(attributes) {
+    const { include, ...rest } = attributes;
+
+    this.assign(rest);
+
     if (include) {
-      let { select, populate } = getDocumentIncludes(this, include);
-      const modifiedPaths = this.modifiedPaths();
-      populate = populate.filter((p) => {
-        return modifiedPaths.includes(p.path);
-      });
+      const { select, populate } = getDocumentIncludes(this, include);
       this.$locals.select = select;
       this.$locals.populate = populate;
     }
@@ -61,6 +77,19 @@ export function applyInclude(schema) {
       delete this.$locals.populate;
     }
   });
+
+  // Instance Methods
+
+  // Perform population immediately when instance method is called.
+  // Store selects as a local variable which will be checked
+  // during serialization.
+  schema.method('include', async function include(include) {
+    if (include) {
+      const { select, populate } = getDocumentIncludes(this, include);
+      this.$locals.select = select;
+      await this.populate(populate);
+    }
+  });
 }
 
 // "Selected" keys virtually project documents so that

package/src/validation.js

@@ -16,11 +16,15 @@ const DATE_TAGS = {
     'A `string` in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
 };
 
-export const OBJECT_ID_SCHEMA = yd.string().mongo().tag({
-  'x-schema': 'ObjectId',
-  'x-description':
-    'A 24 character hexadecimal string representing a Mongo [ObjectId](https://bit.ly/3YPtGlU).',
-});
+export const OBJECT_ID_SCHEMA = yd
+  .string()
+  .mongo()
+  .message('Must be an ObjectId.')
+  .tag({
+    'x-schema': 'ObjectId',
+    'x-description':
+      'A 24 character hexadecimal string representing a Mongo [ObjectId](https://bit.ly/3YPtGlU).',
+  });
 
 const REFERENCE_SCHEMA = yd
   .allow(
@@ -29,10 +33,14 @@ const REFERENCE_SCHEMA = yd
       .object({
         id: OBJECT_ID_SCHEMA.required(),
       })
+      .options({
+        stripUnknown: true,
+      })
       .custom((obj) => {
         return obj.id;
       })
   )
+  .message('Must be an ObjectId or object containing "id" field.')
   .tag({
     'x-schema': 'Reference',
     'x-description': `

package/types/include.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"include.d.ts","sourceRoot":"","sources":["../src/include.js"],"names":[],"mappings":"AA2BA,gDAoCC;AAMD,uDA4BC;AAGD,2DAIC;AApFD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKG"}
+{"version":3,"file":"include.d.ts","sourceRoot":"","sources":["../src/include.js"],"names":[],"mappings":"AA2BA,gDAiEC;AAMD,uDA4BC;AAGD,2DAIC;AAjHD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAKG"}

package/types/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAyEA,kDAEC;AAED,oEA8EC;AAsBD,wEAkBC;AA6QD;;;EAEC;AAED;;;EAOC;AAzcD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIG"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEA8EC;AAsBD,wEAkBC;AA6QD;;;EAEC;AAED;;;EAOC;AAjdD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}