@bedrockio/model 0.2.5 → 0.2.8

package/README.md

@@ -436,12 +436,11 @@ validation which will:
 - Append the same validation to `Model.getCreateSchema` and
   `Model.getUpdateSchema` to allow this constraint to trickle down to the API.
 
-> [!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
-> to fetch the ids of the documents being updated in order to exclude them. To
-> avoid this call `Document.save` instead.
+> [!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 to fetch the ids of the documents being updated in order to exclude
+> them. To avoid this call `Document.save` instead.
 >
 > Note also that calling `Model.updateMany` with a unique field passed will
 > always throw an error as the result would inherently be non-unique.
@@ -1023,8 +1022,8 @@ deletion. They are defined in the `onDelete` field of the model definition file:
     "clean": {
       "local": "profile",
       "foreign": {
-        Shop: "owner"
-      },
+        "Shop": "owner"
+      }
     },
     "errorOnReferenced": {
       "except": ["AuditEntry"]
@@ -1081,7 +1080,7 @@ user.delete();
 ```
 
 In this case, "referenced by" means any other model that explicitly uses "User"
-as a `ref` for type `ObjectId`. `errorOnReference` may also be simply `true`,
+as a `ref` for type `ObjectId`. `errorOnReferenced` may also be simply `true`,
 which will error on any foreign references of any kind.
 
 `only` may be passed instead of `except`, which will only error when the
@@ -1093,9 +1092,8 @@ 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.
 
-> [!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
+> [!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`.
 
 ### Assign

package/dist/cjs/delete-hooks.js

@@ -121,7 +121,6 @@ function validateError(deleteHooks) {
 async function errorOnForeignReferences(doc, options) {
   const {
     errorHook,
-    cleanForeign,
     references
   } = options;
   if (!errorHook) {
@@ -138,57 +137,54 @@ async function errorOnForeignReferences(doc, options) {
     model,
     paths
   } of references) {
-    if (referenceIsAllowed(errorHook, model)) {
+    if (referenceIsAllowed(model, options)) {
       continue;
     }
-    const $or = paths.filter(path => {
-      if (cleanForeign) {
-        return cleanForeign[model.modelName] !== path;
-      }
-      return true;
-    }).map(path => {
-      return {
+    const {
+      modelName
+    } = model;
+    for (let path of paths) {
+      const docs = await model.find({
         [path]: doc.id
-      };
-    });
-    if (!$or.length) {
-      continue;
-    }
-    const docs = await model.find({
-      $or
-    }, {
-      _id: 1
-    }).lean();
-    if (docs.length > 0) {
-      const ids = docs.map(doc => {
-        return String(doc._id);
-      });
-      results.push({
-        ids,
-        model,
-        count: ids.length
-      });
+      }, {
+        _id: 1
+      }).lean();
+      if (docs.length > 0) {
+        const ids = docs.map(doc => {
+          return String(doc._id);
+        });
+        const strId = ids.join(', ');
+        const message = `Referenced as "${path}" by ${modelName}: ${strId}.`;
+        results.push({
+          ids,
+          path,
+          message,
+          model: modelName
+        });
+      }
     }
   }
   if (results.length) {
     const {
       modelName
     } = doc.constructor;
-    const refNames = results.map(reference => {
-      return reference.model.modelName;
-    });
-    throw new _errors.ReferenceError(`Refusing to delete ${modelName} referenced by ${refNames}.`, results);
+    throw new _errors.ReferenceError(`Refusing to delete ${modelName}.`, results);
   }
 }
-function referenceIsAllowed(errorHook, model) {
+function referenceIsAllowed(model, options) {
+  const {
+    cleanForeign
+  } = options;
   const {
     only,
     except
-  } = errorHook;
+  } = options?.errorHook || {};
   if (only) {
     return !only.includes(model.modelName);
   } else if (except) {
     return except.includes(model.modelName);
+  } else if (cleanForeign) {
+    return model.modelName in cleanForeign;
   } else {
     return false;
   }
@@ -269,6 +265,10 @@ async function deleteForeignReferences(doc, refs) {
       await runDeletes(Model, doc, {
         [arg]: id
       });
+    } else if (Array.isArray(arg)) {
+      await runDeletes(Model, doc, {
+        $or: mapArrayQuery(arg, id)
+      });
     } else {
       const {
         $and,

package/dist/cjs/errors.js

@@ -14,9 +14,9 @@ class ImplementationError extends Error {
 }
 exports.ImplementationError = ImplementationError;
 class ReferenceError extends Error {
-  constructor(message, references) {
+  constructor(message, details) {
     super(message);
-    this.references = references;
+    this.details = details;
   }
 }
 exports.ReferenceError = ReferenceError;

package/package.json

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

package/src/delete-hooks.js

@@ -117,7 +117,7 @@ function validateError(deleteHooks) {
 // Error on references
 
 async function errorOnForeignReferences(doc, options) {
-  const { errorHook, cleanForeign, references } = options;
+  const { errorHook, references } = options;
 
   if (!errorHook) {
     return;
@@ -131,59 +131,53 @@ async function errorOnForeignReferences(doc, options) {
   const results = [];
 
   for (let { model, paths } of references) {
-    if (referenceIsAllowed(errorHook, model)) {
+    if (referenceIsAllowed(model, options)) {
       continue;
     }
 
-    const $or = paths
-      .filter((path) => {
-        if (cleanForeign) {
-          return cleanForeign[model.modelName] !== path;
-        }
-        return true;
-      })
-      .map((path) => {
-        return {
-          [path]: doc.id,
-        };
-      });
-
-    if (!$or.length) {
-      continue;
-    }
-
-    const docs = await model.find({ $or }, { _id: 1 }).lean();
-
-    if (docs.length > 0) {
-      const ids = docs.map((doc) => {
-        return String(doc._id);
-      });
-      results.push({
-        ids,
-        model,
-        count: ids.length,
-      });
+    const { modelName } = model;
+
+    for (let path of paths) {
+      const docs = await model
+        .find(
+          {
+            [path]: doc.id,
+          },
+          { _id: 1 }
+        )
+        .lean();
+
+      if (docs.length > 0) {
+        const ids = docs.map((doc) => {
+          return String(doc._id);
+        });
+        const strId = ids.join(', ');
+        const message = `Referenced as "${path}" by ${modelName}: ${strId}.`;
+        results.push({
+          ids,
+          path,
+          message,
+          model: modelName,
+        });
+      }
     }
   }
 
   if (results.length) {
     const { modelName } = doc.constructor;
-    const refNames = results.map((reference) => {
-      return reference.model.modelName;
-    });
-    throw new ReferenceError(
-      `Refusing to delete ${modelName} referenced by ${refNames}.`,
-      results
-    );
+    throw new ReferenceError(`Refusing to delete ${modelName}.`, results);
   }
 }
 
-function referenceIsAllowed(errorHook, model) {
-  const { only, except } = errorHook;
+function referenceIsAllowed(model, options) {
+  const { cleanForeign } = options;
+  const { only, except } = options?.errorHook || {};
   if (only) {
     return !only.includes(model.modelName);
   } else if (except) {
     return except.includes(model.modelName);
+  } else if (cleanForeign) {
+    return model.modelName in cleanForeign;
   } else {
     return false;
   }
@@ -263,6 +257,10 @@ async function deleteForeignReferences(doc, refs) {
       await runDeletes(Model, doc, {
         [arg]: id,
       });
+    } else if (Array.isArray(arg)) {
+      await runDeletes(Model, doc, {
+        $or: mapArrayQuery(arg, id),
+      });
     } else {
       const { $and, $or } = arg;
       if ($and) {

package/src/errors.js

@@ -8,8 +8,8 @@ export class ImplementationError extends Error {
 }
 
 export class ReferenceError extends Error {
-  constructor(message, references) {
+  constructor(message, details) {
     super(message);
-    this.references = references;
+    this.details = details;
   }
 }

package/types/errors.d.ts

@@ -5,7 +5,7 @@ export class ImplementationError extends Error {
     name: any;
 }
 export class ReferenceError extends Error {
-    constructor(message: any, references: any);
-    references: any;
+    constructor(message: any, details: any);
+    details: any;
 }
 //# sourceMappingURL=errors.d.ts.map

package/types/errors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAAA;CAA8C;AAE9C;IACE,uBAGC;IADC,UAAgB;CAEnB;AAED;IACE,2CAGC;IADC,gBAA4B;CAE/B"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.js"],"names":[],"mappings":"AAAA;CAA8C;AAE9C;IACE,uBAGC;IADC,UAAgB;CAEnB;AAED;IACE,wCAGC;IADC,aAAsB;CAEzB"}