ts-patch-mongoose 1.1.4 → 1.1.6

package/dist/esm/plugin.mjs

@@ -1,13 +1,15 @@
 import _ from 'lodash';
-import omit from 'omit-deep';
-import jsonpatch from 'fast-json-patch';
 import { assign } from 'power-assign';
+import { createPatch, updatePatch, deletePatch } from './patch';
 import em from './em';
-import History from './models/History';
 const options = {
     document: false,
     query: true
 };
+const toObjectOptions = {
+    depopulate: true,
+    virtuals: false
+};
 const updateMethods = [
     'update',
     'updateOne',
@@ -26,87 +28,10 @@ const deleteMethods = [
     'deleteOne',
     'deleteMany'
 ];
-function getObjects(opts, current, original) {
-    let currentObject = JSON.parse(JSON.stringify(current));
-    let originalObject = JSON.parse(JSON.stringify(original));
-    if (opts.omit) {
-        currentObject = omit(currentObject, opts.omit);
-        originalObject = omit(originalObject, opts.omit);
-    }
-    return { currentObject, originalObject };
-}
-async function updatePatch(opts, context, current, original) {
-    const { currentObject, originalObject } = getObjects(opts, current, original);
-    if (_.isEmpty(originalObject) || _.isEmpty(currentObject))
-        return;
-    const patch = jsonpatch.compare(originalObject, currentObject, true);
-    if (_.isEmpty(patch))
-        return;
-    if (opts.eventUpdated) {
-        em.emit(opts.eventUpdated, { oldDoc: original, doc: current, patch });
-    }
-    if (opts.patchHistoryDisabled)
-        return;
-    let version = 0;
-    const lastHistory = await History.findOne({ collectionId: original._id }).sort('-version').exec();
-    if (lastHistory && lastHistory.version >= 0) {
-        version = lastHistory.version + 1;
-    }
-    await History.create({
-        op: context.op,
-        modelName: context.modelName,
-        collectionName: context.collectionName,
-        collectionId: original._id,
-        patch,
-        version
-    });
-}
-async function bulkPatch(opts, context, eventKey, docsKey) {
-    const event = opts[eventKey];
-    const docs = context[docsKey];
-    const key = eventKey === 'eventCreated' ? 'doc' : 'oldDoc';
-    if (_.isEmpty(docs) || (!event && opts.patchHistoryDisabled))
-        return;
-    const chunks = _.chunk(docs, 1000);
-    for await (const chunk of chunks) {
-        const bulk = [];
-        for (const doc of chunk) {
-            if (event)
-                em.emit(event, { [key]: doc });
-            if (!opts.patchHistoryDisabled) {
-                bulk.push({
-                    insertOne: {
-                        document: {
-                            op: context.op,
-                            modelName: context.modelName,
-                            collectionName: context.collectionName,
-                            collectionId: doc._id,
-                            doc,
-                            version: 0
-                        }
-                    }
-                });
-            }
-        }
-        if (!opts.patchHistoryDisabled) {
-            await History
-                .bulkWrite(bulk, { ordered: false })
-                .catch((err) => {
-                console.error(err);
-            });
-        }
-    }
-}
-async function createPatch(opts, context) {
-    await bulkPatch(opts, context, 'eventCreated', 'createdDocs');
-}
-async function deletePatch(opts, context) {
-    await bulkPatch(opts, context, 'eventDeleted', 'deletedDocs');
-}
 export const patchEventEmitter = em;
 export const patchHistoryPlugin = function plugin(schema, opts) {
     schema.pre('save', async function (next) {
-        const current = this.toObject({ depopulate: true });
+        const current = this.toObject(toObjectOptions);
         const model = this.constructor;
         const context = {
             op: this.isNew ? 'create' : 'update',
@@ -114,21 +39,16 @@ export const patchHistoryPlugin = function plugin(schema, opts) {
             collectionName: opts.collectionName ?? model.collection.collectionName,
             createdDocs: [current]
         };
-        try {
-            if (this.isNew) {
-                await createPatch(opts, context);
-            }
-            else {
-                const original = await model.findById(current._id).exec();
-                if (original) {
-                    await updatePatch(opts, context, current, original);
-                }
-            }
-            next();
+        if (this.isNew) {
+            await createPatch(opts, context);
         }
-        catch (error) {
-            next(error);
+        else {
+            const original = await model.findById(current._id).exec();
+            if (original) {
+                await updatePatch(opts, context, current, original);
+            }
         }
+        next();
     });
     schema.post('insertMany', async function (docs) {
         const context = {
@@ -151,68 +71,52 @@ export const patchHistoryPlugin = function plugin(schema, opts) {
             collectionName: opts.collectionName ?? this.model.collection.collectionName,
             isNew: options.upsert && count === 0
         };
-        try {
-            const keys = _.keys(update).filter((key) => key.startsWith('$'));
-            if (update && !_.isEmpty(keys)) {
-                _.forEach(keys, (key) => {
-                    commands.push({ [key]: update[key] });
-                    delete update[key];
-                });
-            }
-            const cursor = this.model.find(filter).cursor();
-            await cursor.eachAsync(async (doc) => {
-                let current = doc.toObject({ depopulate: true });
-                const original = doc.toObject({ depopulate: true });
-                current = assign(current, update);
-                _.forEach(commands, (command) => {
-                    try {
-                        current = assign(current, command);
-                    }
-                    catch (error) {
-                    }
-                });
-                await updatePatch(opts, this._context, current, original);
+        const keys = _.keys(update).filter((key) => key.startsWith('$'));
+        if (update && !_.isEmpty(keys)) {
+            _.forEach(keys, (key) => {
+                commands.push({ [key]: update[key] });
+                delete update[key];
             });
-            next();
-        }
-        catch (error) {
-            next(error);
         }
-    });
-    schema.post(updateMethods, async function () {
-        const update = this.getUpdate();
-        if (update && this._context.isNew) {
-            const cursor = this.model.findOne(update).cursor();
-            await cursor.eachAsync((doc) => {
-                const current = doc.toObject({ depopulate: true });
-                if (this._context.createdDocs) {
-                    this._context.createdDocs.push(current);
+        const cursor = this.model.find(filter).cursor();
+        await cursor.eachAsync(async (doc) => {
+            let current = doc.toObject(toObjectOptions);
+            const original = doc.toObject(toObjectOptions);
+            current = assign(current, update);
+            _.forEach(commands, (command) => {
+                try {
+                    current = assign(current, command);
                 }
-                else {
-                    this._context.createdDocs = [current];
+                catch (error) {
                 }
             });
+            await updatePatch(opts, this._context, current, original);
+        });
+        next();
+    });
+    schema.post(updateMethods, async function () {
+        const update = this.getUpdate();
+        if (!update || !this._context.isNew)
+            return;
+        const found = await this.model.findOne(update).exec();
+        if (found) {
+            const current = found.toObject(toObjectOptions);
+            this._context.createdDocs = [current];
             await createPatch(opts, this._context);
         }
     });
-    schema.pre('remove', async function (next) {
-        const original = this.toObject({ depopulate: true });
+    schema.post('remove', async function () {
+        const original = this.toObject(toObjectOptions);
         const model = this.constructor;
         const context = {
             op: 'delete',
             modelName: opts.modelName ?? model.modelName,
             collectionName: opts.collectionName ?? model.collection.collectionName
         };
-        try {
-            if (opts.eventDeleted) {
-                em.emit(opts.eventDeleted, { oldDoc: original });
-            }
-            await deletePatch(opts, context);
-            next();
-        }
-        catch (error) {
-            next(error);
+        if (opts.eventDeleted) {
+            em.emit(opts.eventDeleted, { oldDoc: original });
         }
+        await deletePatch(opts, context);
     });
     schema.pre(deleteMethods, options, async function (next) {
         const filter = this.getFilter();
@@ -237,8 +141,8 @@ export const patchHistoryPlugin = function plugin(schema, opts) {
                 this._context.deletedDocs = [doc];
             }
         }
-        if (opts.preDeleteManyCallback && _.isArray(this._context.deletedDocs) && !_.isEmpty(this._context.deletedDocs)) {
-            await opts.preDeleteManyCallback(this._context.deletedDocs);
+        if (opts.preDeleteCallback && _.isArray(this._context.deletedDocs) && !_.isEmpty(this._context.deletedDocs)) {
+            await opts.preDeleteCallback(this._context.deletedDocs);
         }
         next();
     });

package/dist/esm/types/interfaces/IPluginOptions.d.ts

@@ -6,7 +6,7 @@ interface IPluginOptions<T> {
     eventCreated?: string;
     eventDeleted?: string;
     patchHistoryDisabled?: boolean;
-    preDeleteManyCallback?: (docs: HydratedDocument<T>[]) => Promise<void>;
+    preDeleteCallback?: (docs: HydratedDocument<T>[]) => Promise<void>;
     omit?: string[];
 }
 export default IPluginOptions;

package/dist/esm/types/interfaces/IPluginOptions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IPluginOptions.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/IPluginOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,UAAU,cAAc,CAAC,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,qBAAqB,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACtE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,eAAe,cAAc,CAAA"}
+{"version":3,"file":"IPluginOptions.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/IPluginOptions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD,UAAU,cAAc,CAAC,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAClE,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;CAChB;AAED,eAAe,cAAc,CAAA"}

package/dist/esm/types/patch.d.ts

@@ -0,0 +1,12 @@
+import type { HydratedDocument } from 'mongoose';
+import type IPluginOptions from './interfaces/IPluginOptions';
+import type IContext from './interfaces/IContext';
+export declare function getObjects<T>(opts: IPluginOptions<T>, current: HydratedDocument<T>, original: HydratedDocument<T>): {
+    currentObject: Partial<T>;
+    originalObject: Partial<T>;
+};
+export declare function bulkPatch<T>(opts: IPluginOptions<T>, context: IContext<T>, eventKey: 'eventCreated' | 'eventDeleted', docsKey: 'createdDocs' | 'deletedDocs'): Promise<void>;
+export declare function createPatch<T>(opts: IPluginOptions<T>, context: IContext<T>): Promise<void>;
+export declare function updatePatch<T>(opts: IPluginOptions<T>, context: IContext<T>, current: HydratedDocument<T>, original: HydratedDocument<T>): Promise<void>;
+export declare function deletePatch<T>(opts: IPluginOptions<T>, context: IContext<T>): Promise<void>;
+//# sourceMappingURL=patch.d.ts.map

package/dist/esm/types/patch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"patch.d.ts","sourceRoot":"","sources":["../../../src/patch.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,gBAAgB,EAAS,MAAM,UAAU,CAAA;AAEvD,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAC7D,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAA;AAKjD,wBAAgB,UAAU,CAAC,CAAC,EAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG;IAAE,aAAa,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;IAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,CAAA;CAAE,CAU9K;AAED,wBAAsB,SAAS,CAAC,CAAC,EAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,cAAc,GAAG,cAAc,EAAE,OAAO,EAAE,aAAa,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAmCnL;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAElG;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CA+B/J;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAG,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAElG"}

package/dist/esm/types/plugin.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAKA,OAAO,KAAK,EAAmC,KAAK,EAA0C,MAAM,EAAS,MAAM,UAAU,CAAA;AAE7H,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AA+H7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;CAAK,CAAA;AAQnC,eAAO,MAAM,kBAAkB,oOAAoE,IA2JlG,CAAA"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAGA,OAAO,KAAK,EAAoB,KAAK,EAA2B,MAAM,EAAmB,MAAM,UAAU,CAAA;AAEzG,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAwC7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;CAAK,CAAA;AAQnC,eAAO,MAAM,kBAAkB,oOAAoE,IAgJlG,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-patch-mongoose",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Patch history & events for mongoose models",
   "author": "Alex Eagle",
   "license": "MIT",
@@ -83,15 +83,15 @@
   "devDependencies": {
     "@shelf/jest-mongodb": "4.1.7",
     "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.49",
+    "@swc/core": "1.3.51",
     "@swc/helpers": "0.5.0",
-    "@swc/jest": "0.2.24",
+    "@swc/jest": "0.2.26",
     "@swc/register": "0.1.10",
     "@types/jest": "29.5.0",
-    "@types/lodash": "4.14.192",
+    "@types/lodash": "4.14.194",
     "@types/node": "18.15.11",
-    "@typescript-eslint/eslint-plugin": "5.58.0",
-    "@typescript-eslint/parser": "5.58.0",
+    "@typescript-eslint/eslint-plugin": "5.59.0",
+    "@typescript-eslint/parser": "5.59.0",
     "eslint": "8.38.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.27.5",
@@ -100,6 +100,7 @@
     "eslint-plugin-n": "15.7.0",
     "eslint-plugin-node": "11.1.0",
     "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-sonarjs": "0.19.0",
     "jest": "29.5.0",
     "merge": "2.1.1",
     "mongoose": "6.10.5",
@@ -107,6 +108,6 @@
     "typescript": "5.0.4"
   },
   "peerDependencies": {
-    "mongoose": ">=6.10.5"
+    "mongoose": ">=6.6.0 < 7"
   }
 }

package/src/interfaces/IPluginOptions.ts

@@ -7,7 +7,7 @@ interface IPluginOptions<T> {
   eventCreated?: string
   eventDeleted?: string
   patchHistoryDisabled?: boolean
-  preDeleteManyCallback?: (docs: HydratedDocument<T>[]) => Promise<void>
+  preDeleteCallback?: (docs: HydratedDocument<T>[]) => Promise<void>
   omit?: string[]
 }
 

package/src/patch.ts

@@ -0,0 +1,101 @@
+import _ from 'lodash'
+import omit from 'omit-deep'
+import jsonpatch from 'fast-json-patch'
+
+import type { HydratedDocument, Types } from 'mongoose'
+
+import type IPluginOptions from './interfaces/IPluginOptions'
+import type IContext from './interfaces/IContext'
+
+import History from './models/History'
+import em from './em'
+
+export function getObjects<T> (opts: IPluginOptions<T>, current: HydratedDocument<T>, original: HydratedDocument<T>): { currentObject: Partial<T>, originalObject: Partial<T> } {
+  let currentObject = JSON.parse(JSON.stringify(current)) as Partial<T>
+  let originalObject = JSON.parse(JSON.stringify(original)) as Partial<T>
+
+  if (opts.omit) {
+    currentObject = omit(currentObject, opts.omit)
+    originalObject = omit(originalObject, opts.omit)
+  }
+
+  return { currentObject, originalObject }
+}
+
+export async function bulkPatch<T> (opts: IPluginOptions<T>, context: IContext<T>, eventKey: 'eventCreated' | 'eventDeleted', docsKey: 'createdDocs' | 'deletedDocs'): Promise<void> {
+  const event = opts[eventKey]
+  const docs = context[docsKey]
+  const key = eventKey === 'eventCreated' ? 'doc' : 'oldDoc'
+
+  if (_.isEmpty(docs) || (!event && opts.patchHistoryDisabled)) return
+
+  const chunks = _.chunk(docs, 1000)
+
+  for await (const chunk of chunks) {
+    const bulk = []
+
+    for (const doc of chunk) {
+      if (event) em.emit(event, { [key]: doc })
+
+      if (!opts.patchHistoryDisabled) {
+        bulk.push({
+          insertOne: {
+            document: {
+              op: context.op,
+              modelName: context.modelName,
+              collectionName: context.collectionName,
+              collectionId: doc._id as Types.ObjectId,
+              doc,
+              version: 0
+            }
+          }
+        })
+      }
+    }
+
+    if (!opts.patchHistoryDisabled) {
+      await History.bulkWrite(bulk, { ordered: false })
+    }
+  }
+}
+
+export async function createPatch<T> (opts: IPluginOptions<T>, context: IContext<T>): Promise<void> {
+  await bulkPatch(opts, context, 'eventCreated', 'createdDocs')
+}
+
+export async function updatePatch<T> (opts: IPluginOptions<T>, context: IContext<T>, current: HydratedDocument<T>, original: HydratedDocument<T>): Promise<void> {
+  const { currentObject, originalObject } = getObjects(opts, current, original)
+
+  if (_.isEmpty(originalObject) || _.isEmpty(currentObject)) return
+
+  const patch = jsonpatch.compare(originalObject, currentObject, true)
+
+  if (_.isEmpty(patch)) return
+
+  if (opts.eventUpdated) {
+    em.emit(opts.eventUpdated, { oldDoc: original, doc: current, patch })
+  }
+
+  if (opts.patchHistoryDisabled) return
+
+  let version = 0
+
+  const lastHistory = await History.findOne({ collectionId: original._id as Types.ObjectId }).sort('-version').exec()
+
+  if (lastHistory && lastHistory.version >= 0) {
+    version = lastHistory.version + 1
+  }
+
+  await History.create({
+    op: context.op,
+    modelName: context.modelName,
+    collectionName: context.collectionName,
+    collectionId: original._id as Types.ObjectId,
+    patch,
+    version
+  })
+}
+
+export async function deletePatch<T> (opts: IPluginOptions<T>, context: IContext<T>): Promise<void> {
+  await bulkPatch(opts, context, 'eventDeleted', 'deletedDocs')
+}