@bedrockio/model 0.2.1 → 0.2.3

package/README.md

@@ -436,8 +436,7 @@ validation which will:
 - Append the same validation to `Model.getCreateSchema` and
   `Model.getUpdateSchema` to allow this constraint to trickle down to the API.
 
-> :warning: updateOne and updateMany
->
+> [!WARNING]
 > Note that calling `Model.updateOne` will throw an error when a unique field
 > exists on any document **including the document being updated**. This is an
 > intentional constraint that allows `updateOne` better peformance by not having
@@ -951,7 +950,7 @@ is set after verification:
 A user is allowed to update the name of their own shop and admins can as well.
 However, only admins can set the owner of the shop:
 
-```json
+```jsonc
 // shop.json
 {
   "name": {
@@ -1010,7 +1009,7 @@ check the document is the same as `authUser`.
 Delete hooks are a powerful way to define what actions are taken on document
 deletion. They are defined in the `onDelete` field of the model definition file:
 
-```json
+```jsonc
 // user.json
 {
   "attributes": {
@@ -1026,7 +1025,7 @@ deletion. They are defined in the `onDelete` field of the model definition file:
       "foreign": {
         Shop: "owner"
       },
-    }
+    },
     "errorOnReferenced": {
       "except": ["AuditEntry"]
     }
@@ -1094,7 +1093,7 @@ Models that have delete hooks defined on them will keep a reference of the
 documents that were deleted. Calling `.restore()` on the document will also
 restore these references.
 
-> [!IMPORTANT]  
+> [!WARNING]
 > Delete hooks are **only** run on a single document (`.delete` or `.restore`).
 > They will not be run when using model methods like `deleteOne` or
 > `deleteMany`.

package/dist/cjs/soft-delete.js

@@ -6,8 +6,10 @@ Object.defineProperty(exports, "__esModule", {
 exports.applySoftDelete = applySoftDelete;
 exports.assertUnique = assertUnique;
 exports.hasUniqueConstraints = hasUniqueConstraints;
+var _mongoose = _interopRequireDefault(require("mongoose"));
 var _lodash = require("lodash");
 var _query = require("./query");
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function applySoftDelete(schema) {
   applyQueries(schema);
   applyUniqueConstraints(schema);
@@ -219,7 +221,7 @@ function applyUniqueConstraints(schema) {
     return;
   }
   schema.pre('save', async function () {
-    await assertUnique(this.toObject(), {
+    await assertUnique(this, {
       operation: this.isNew ? 'create' : 'update',
       model: this.constructor,
       schema
@@ -340,6 +342,11 @@ function resolveUnique(schema, obj, map = {}, path = []) {
     for (let el of obj) {
       resolveUnique(schema, el, map, path);
     }
+  } else if (obj instanceof _mongoose.default.Document) {
+    obj.schema.eachPath(key => {
+      const val = obj.get(key);
+      resolveUnique(schema, val, map, [...path, key]);
+    });
   } else if (obj && typeof obj === 'object') {
     for (let [key, val] of Object.entries(obj)) {
       resolveUnique(schema, val, map, [...path, key]);

package/dist/cjs/validation.js

@@ -131,7 +131,7 @@ function applyValidation(schema, definition) {
       allowInclude: true,
       expandDotSyntax: true,
       unwindArrayFields: true,
-      requireReadAccess: true,
+      requireSearchAccess: true,
       stripDeleted: !includeDeleted,
       appendSchema: (0, _search.searchValidation)({
         defaults,
@@ -297,7 +297,7 @@ function getSchemaForTypedef(typedef, options = {}) {
   if (options.allowSearch) {
     schema = getSearchSchema(schema, type);
   }
-  if (typedef.readAccess && options.requireReadAccess) {
+  if (typedef.readAccess && options.requireSearchAccess) {
     schema = validateReadAccess(schema, typedef.readAccess, options);
   }
   if (typedef.writeAccess && options.requireWriteAccess) {
@@ -375,13 +375,13 @@ function isRequired(typedef, options) {
 }
 function isExcludedField(field, options) {
   if ((0, _utils.isSchemaTypedef)(field)) {
-    const {
-      requireWriteAccess
-    } = options;
-    return requireWriteAccess && field.writeAccess === 'none';
-  } else {
-    return false;
+    if (options.requireWriteAccess) {
+      return field.writeAccess === 'none';
+    } else if (options.requireSearchAccess) {
+      return field.readAccess === 'none' || field.readAccess === 'self';
+    }
   }
+  return false;
 }
 function validateReadAccess(schema, allowed, options) {
   return validateAccess('read', schema, allowed, options);

package/jest-mongodb-config.js

@@ -1,7 +1,9 @@
+const { devDependencies } = require('./package.json');
+
 module.exports = {
   mongodbMemoryServerOptions: {
     binary: {
-      version: '6.0.2',
+      version: devDependencies.mongodb,
       skipMD5: true,
     },
     autoStart: false,

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@bedrockio/model",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Bedrock utilities for model creation.",
   "type": "module",
   "scripts": {
     "test": "jest",
+    "types": "tsc",
     "lint": "eslint",
     "build": "scripts/build",
-    "types": "tsc",
+    "eject": "scripts/eject.js",
     "prepublishOnly": "yarn build && yarn types"
   },
   "main": "dist/cjs/index.js",
@@ -39,12 +40,11 @@
     "@bedrockio/prettier-config": "^1.0.2",
     "@bedrockio/yada": "^1.0.34",
     "@shelf/jest-mongodb": "^4.1.7",
-    "babel-plugin-import-replacement": "^1.0.1",
     "eslint": "^8.33.0",
     "eslint-plugin-bedrock": "^1.0.26",
     "jest": "^29.4.1",
     "jest-environment-node": "^29.4.1",
-    "mongodb": "^5.9.1",
+    "mongodb": "^6.2.0",
     "mongoose": "^7.6.4",
     "prettier-eslint": "^15.0.1",
     "typescript": "^4.9.5"

package/src/soft-delete.js

@@ -1,3 +1,4 @@
+import mongoose from 'mongoose';
 import { isEqual } from 'lodash';
 
 import { wrapQuery } from './query';
@@ -251,7 +252,7 @@ function applyUniqueConstraints(schema) {
   }
 
   schema.pre('save', async function () {
-    await assertUnique(this.toObject(), {
+    await assertUnique(this, {
       operation: this.isNew ? 'create' : 'update',
       model: this.constructor,
       schema,
@@ -367,6 +368,11 @@ function resolveUnique(schema, obj, map = {}, path = []) {
     for (let el of obj) {
       resolveUnique(schema, el, map, path);
     }
+  } else if (obj instanceof mongoose.Document) {
+    obj.schema.eachPath((key) => {
+      const val = obj.get(key);
+      resolveUnique(schema, val, map, [...path, key]);
+    });
   } else if (obj && typeof obj === 'object') {
     for (let [key, val] of Object.entries(obj)) {
       resolveUnique(schema, val, map, [...path, key]);

package/src/validation.js

@@ -145,7 +145,7 @@ export function applyValidation(schema, definition) {
         allowInclude: true,
         expandDotSyntax: true,
         unwindArrayFields: true,
-        requireReadAccess: true,
+        requireSearchAccess: true,
         stripDeleted: !includeDeleted,
         appendSchema: searchValidation({
           defaults,
@@ -314,7 +314,7 @@ function getSchemaForTypedef(typedef, options = {}) {
   if (options.allowSearch) {
     schema = getSearchSchema(schema, type);
   }
-  if (typedef.readAccess && options.requireReadAccess) {
+  if (typedef.readAccess && options.requireSearchAccess) {
     schema = validateReadAccess(schema, typedef.readAccess, options);
   }
   if (typedef.writeAccess && options.requireWriteAccess) {
@@ -430,11 +430,13 @@ function isRequired(typedef, options) {
 
 function isExcludedField(field, options) {
   if (isSchemaTypedef(field)) {
-    const { requireWriteAccess } = options;
-    return requireWriteAccess && field.writeAccess === 'none';
-  } else {
-    return false;
+    if (options.requireWriteAccess) {
+      return field.writeAccess === 'none';
+    } else if (options.requireSearchAccess) {
+      return field.readAccess === 'none' || field.readAccess === 'self';
+    }
   }
+  return false;
 }
 
 function validateReadAccess(schema, allowed, options) {

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

@@ -1 +1 @@
-{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../src/soft-delete.js"],"names":[],"mappings":"AAIA,mDAIC;AAiRD,oEAsBC;AAgDD,2DAKC"}
+{"version":3,"file":"soft-delete.d.ts","sourceRoot":"","sources":["../src/soft-delete.js"],"names":[],"mappings":"AAKA,mDAIC;AAiRD,oEAsBC;AAgDD,2DAKC"}

package/types/validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEAkFC;AAsBD,wEAkBC;AAwRD;;;EAEC;AAED;;;EAOC;AAheD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}
+{"version":3,"file":"validation.d.ts","sourceRoot":"","sources":["../src/validation.js"],"names":[],"mappings":"AAiFA,kDAEC;AAED,oEAkFC;AAsBD,wEAkBC;AA0RD;;;EAEC;AAED;;;EAOC;AAleD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQK"}