@bedrockio/model 0.2.4 → 0.2.6

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/errors.js

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

package/dist/cjs/soft-delete.js

@@ -55,7 +55,10 @@ function applyQueries(schema) {
 
   schema.static('deleteOne', function deleteOne(filter, ...rest) {
     const update = getDelete();
-    const query = this.updateOne(filter, update, ...omitCallback(rest));
+    const query = this.updateOne({
+      ...filter,
+      deleted: false
+    }, update, ...omitCallback(rest));
     return (0, _query.wrapQuery)(query, async promise => {
       const res = await promise;
       return {
@@ -66,7 +69,10 @@ function applyQueries(schema) {
   });
   schema.static('deleteMany', function deleteMany(filter, ...rest) {
     const update = getDelete();
-    const query = this.updateMany(filter, update, ...omitCallback(rest));
+    const query = this.updateMany({
+      ...filter,
+      deleted: false
+    }, update, ...omitCallback(rest));
     return (0, _query.wrapQuery)(query, async promise => {
       const res = await promise;
       return {
@@ -76,10 +82,16 @@ function applyQueries(schema) {
     });
   });
   schema.static('findOneAndDelete', function findOneAndDelete(filter, ...rest) {
-    return this.findOneAndUpdate(filter, getDelete(), ...omitCallback(rest));
+    return this.findOneAndUpdate({
+      ...filter,
+      deleted: false
+    }, getDelete(), ...omitCallback(rest));
   });
   schema.static('restoreOne', function restoreOne(filter, ...rest) {
-    const query = this.updateOne(filter, getRestore(), ...omitCallback(rest));
+    const query = this.updateOne({
+      ...filter,
+      deleted: true
+    }, getRestore(), ...omitCallback(rest));
     return (0, _query.wrapQuery)(query, async promise => {
       const res = await promise;
       return {
@@ -89,7 +101,10 @@ function applyQueries(schema) {
     });
   });
   schema.static('restoreMany', function restoreMany(filter, ...rest) {
-    const query = this.updateMany(filter, getRestore(), ...omitCallback(rest));
+    const query = this.updateMany({
+      ...filter,
+      deleted: true
+    }, getRestore(), ...omitCallback(rest));
     return (0, _query.wrapQuery)(query, async promise => {
       const res = await promise;
       return {

package/package.json

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

package/src/errors.js

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

package/src/soft-delete.js

@@ -48,7 +48,14 @@ function applyQueries(schema) {
 
   schema.static('deleteOne', function deleteOne(filter, ...rest) {
     const update = getDelete();
-    const query = this.updateOne(filter, update, ...omitCallback(rest));
+    const query = this.updateOne(
+      {
+        ...filter,
+        deleted: false,
+      },
+      update,
+      ...omitCallback(rest)
+    );
     return wrapQuery(query, async (promise) => {
       const res = await promise;
       return {
@@ -60,7 +67,14 @@ function applyQueries(schema) {
 
   schema.static('deleteMany', function deleteMany(filter, ...rest) {
     const update = getDelete();
-    const query = this.updateMany(filter, update, ...omitCallback(rest));
+    const query = this.updateMany(
+      {
+        ...filter,
+        deleted: false,
+      },
+      update,
+      ...omitCallback(rest)
+    );
     return wrapQuery(query, async (promise) => {
       const res = await promise;
       return {
@@ -71,11 +85,25 @@ function applyQueries(schema) {
   });
 
   schema.static('findOneAndDelete', function findOneAndDelete(filter, ...rest) {
-    return this.findOneAndUpdate(filter, getDelete(), ...omitCallback(rest));
+    return this.findOneAndUpdate(
+      {
+        ...filter,
+        deleted: false,
+      },
+      getDelete(),
+      ...omitCallback(rest)
+    );
   });
 
   schema.static('restoreOne', function restoreOne(filter, ...rest) {
-    const query = this.updateOne(filter, getRestore(), ...omitCallback(rest));
+    const query = this.updateOne(
+      {
+        ...filter,
+        deleted: true,
+      },
+      getRestore(),
+      ...omitCallback(rest)
+    );
     return wrapQuery(query, async (promise) => {
       const res = await promise;
       return {
@@ -86,7 +114,14 @@ function applyQueries(schema) {
   });
 
   schema.static('restoreMany', function restoreMany(filter, ...rest) {
-    const query = this.updateMany(filter, getRestore(), ...omitCallback(rest));
+    const query = this.updateMany(
+      {
+        ...filter,
+        deleted: true,
+      },
+      getRestore(),
+      ...omitCallback(rest)
+    );
     return wrapQuery(query, async (promise) => {
       const res = await promise;
       return {

package/types/errors.d.ts

@@ -6,6 +6,8 @@ export class ImplementationError extends Error {
 }
 export class ReferenceError extends Error {
     constructor(message: any, references: any);
-    references: any;
+    details: {
+        references: 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,2CAKC;IAHC;;MAEC;CAEJ"}

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

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