ts-patch-mongoose 2.6.1 → 2.6.3

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

@@ -1,37 +1,10 @@
-/// <reference types="mongoose/types/aggregate" />
-/// <reference types="mongoose/types/callback" />
-/// <reference types="mongoose/types/collection" />
-/// <reference types="mongoose/types/connection" />
-/// <reference types="mongoose/types/cursor" />
-/// <reference types="mongoose/types/document" />
-/// <reference types="mongoose/types/error" />
-/// <reference types="mongoose/types/expressions" />
-/// <reference types="mongoose/types/helpers" />
-/// <reference types="mongoose/types/middlewares" />
-/// <reference types="mongoose/types/indexes" />
-/// <reference types="mongoose/types/models" />
-/// <reference types="mongoose/types/mongooseoptions" />
-/// <reference types="mongoose/types/pipelinestage" />
-/// <reference types="mongoose/types/populate" />
-/// <reference types="mongoose/types/query" />
-/// <reference types="mongoose/types/schemaoptions" />
-/// <reference types="mongoose/types/schematypes" />
-/// <reference types="mongoose/types/session" />
-/// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/utility" />
-/// <reference types="mongoose/types/validation" />
-/// <reference types="mongoose/types/virtuals" />
-/// <reference types="mongoose/types/inferschematype" />
-/// <reference types="mongoose/types/inferrawdoctype" />
 import type { HydratedDocument } from 'mongoose';
 import type IEvent from './interfaces/IEvent';
 import type IContext from './interfaces/IContext';
 import type IPluginOptions from './interfaces/IPluginOptions';
 import type { User, Metadata } from './interfaces/IPluginOptions';
-export declare function getObjects<T>(opts: IPluginOptions<T>, current: HydratedDocument<T>, original: HydratedDocument<T>): {
-    currentObject: Partial<T>;
-    originalObject: Partial<T>;
-};
+export declare function getJsonOmit<T>(opts: IPluginOptions<T>, doc: HydratedDocument<T>): Partial<T>;
+export declare function getObjectOmit<T>(opts: IPluginOptions<T>, doc: HydratedDocument<T>): Partial<T>;
 export declare function getUser<T>(opts: IPluginOptions<T>): Promise<User | undefined>;
 export declare function getReason<T>(opts: IPluginOptions<T>): Promise<string | undefined>;
 export declare function getMetadata<T>(opts: IPluginOptions<T>): Promise<Metadata | undefined>;

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

@@ -1 +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,MAAM,MAAM,qBAAqB,CAAA;AAC7C,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AASjE,wBAAgB,UAAU,CAAC,CAAC,EAAE,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,CAU7K;AAED,wBAAsB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CAKnF;AAED,wBAAsB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAKvF;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAK3F;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,CAExE;AAED,wBAAsB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC,CAU/H;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAInG;AAED,wBAAsB,SAAS,CAAC,CAAC,EAAE,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,CAwClL;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,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,CAkC9J;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG"}
+{"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,MAAM,MAAM,qBAAqB,CAAA;AAC7C,OAAO,KAAK,QAAQ,MAAM,uBAAuB,CAAA;AACjD,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAC7D,OAAO,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AASjE,wBAAgB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAQ5F;AAED,wBAAgB,aAAa,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAO9F;AAED,wBAAsB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,GAAG,SAAS,CAAC,CAKnF;AAED,wBAAsB,SAAS,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAKvF;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,QAAQ,GAAG,SAAS,CAAC,CAK3F;AAED,wBAAgB,QAAQ,CAAC,CAAC,EAAE,IAAI,EAAE,oBAAoB,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,CAExE;AAED,wBAAsB,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,GAAG,SAAS,EAAE,MAAM,GAAG,SAAS,EAAE,QAAQ,GAAG,SAAS,CAAC,CAAC,CAU/H;AAED,wBAAgB,SAAS,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAInG;AAED,wBAAsB,SAAS,CAAC,CAAC,EAAE,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,CAwClL;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,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,CAmC9J;AAED,wBAAsB,WAAW,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjG"}

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

@@ -1,48 +1,22 @@
-/// <reference types="node" />
-/// <reference types="mongoose/types/aggregate" />
-/// <reference types="mongoose/types/callback" />
-/// <reference types="mongoose/types/collection" />
-/// <reference types="mongoose/types/connection" />
-/// <reference types="mongoose/types/cursor" />
-/// <reference types="mongoose/types/document" />
-/// <reference types="mongoose/types/error" />
-/// <reference types="mongoose/types/expressions" />
-/// <reference types="mongoose/types/helpers" />
-/// <reference types="mongoose/types/middlewares" />
-/// <reference types="mongoose/types/indexes" />
-/// <reference types="mongoose/types/models" />
-/// <reference types="mongoose/types/mongooseoptions" />
-/// <reference types="mongoose/types/pipelinestage" />
-/// <reference types="mongoose/types/populate" />
-/// <reference types="mongoose/types/query" />
-/// <reference types="mongoose/types/schemaoptions" />
-/// <reference types="mongoose/types/schematypes" />
-/// <reference types="mongoose/types/session" />
-/// <reference types="mongoose/types/types" />
-/// <reference types="mongoose/types/utility" />
-/// <reference types="mongoose/types/validation" />
-/// <reference types="mongoose/types/virtuals" />
-/// <reference types="mongoose/types/inferschematype" />
-/// <reference types="mongoose/types/inferrawdoctype" />
 import type { Schema } from 'mongoose';
 import type IPluginOptions from './interfaces/IPluginOptions';
 export declare const patchEventEmitter: {
     [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
-    addListener<K_1>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-    on<K_2>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-    once<K_3>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-    removeListener<K_4>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-    off<K_5>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    on<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    once<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    removeListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    off<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
     removeAllListeners(eventName?: string | symbol | undefined): any;
     setMaxListeners(n: number): any;
     getMaxListeners(): number;
-    listeners<K_6>(eventName: string | symbol): Function[];
-    rawListeners<K_7>(eventName: string | symbol): Function[];
-    emit<K_8>(eventName: string | symbol, ...args: any[]): boolean;
-    listenerCount<K_9>(eventName: string | symbol, listener?: Function | undefined): number;
-    prependListener<K_10>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-    prependOnceListener<K_11>(eventName: string | symbol, listener: (...args: any[]) => void): any;
-    eventNames(): (string | symbol)[];
+    listeners<K>(eventName: string | symbol): Array<Function>;
+    rawListeners<K>(eventName: string | symbol): Array<Function>;
+    emit<K>(eventName: string | symbol, ...args: any[]): boolean;
+    listenerCount<K>(eventName: string | symbol, listener?: Function | undefined): number;
+    prependListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    eventNames(): Array<(string | symbol) & (string | symbol)>;
 };
 export declare const patchHistoryPlugin: <T>(schema: Schema<T>, opts: IPluginOptions<T>) => void;
 //# sourceMappingURL=plugin.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAWA,OAAO,KAAK,EAA2B,MAAM,EAAE,MAAM,UAAU,CAAA;AAC/D,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAQ7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAK,CAAA;AAQnC,eAAO,MAAM,kBAAkB,cAA8B,OAAO,CAAC,CAAC,QAAQ,eAAe,CAAC,CAAC,KAAG,IA+CjG,CAAA"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAA2B,MAAM,EAAE,MAAM,UAAU,CAAA;AAC/D,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAQ7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAK,CAAA;AAQnC,eAAO,MAAM,kBAAkB,GAAmB,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,QAAQ,cAAc,CAAC,CAAC,CAAC,KAAG,IA+CjG,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-patch-mongoose",
-  "version": "2.6.1",
+  "version": "2.6.3",
   "description": "Patch history & events for mongoose models",
   "author": "Alex Eagle",
   "license": "MIT",
@@ -85,27 +85,27 @@
   },
   "devDependencies": {
     "@shelf/jest-mongodb": "4.3.2",
-    "@stylistic/eslint-plugin": "2.1.0",
-    "@swc/cli": "0.3.12",
-    "@swc/core": "1.5.7",
+    "@stylistic/eslint-plugin": "2.3.0",
+    "@swc/cli": "0.4.0",
+    "@swc/core": "1.6.7",
     "@swc/helpers": "0.5.11",
     "@swc/jest": "0.2.36",
     "@swc/register": "0.1.10",
     "@types/jest": "29.5.12",
-    "@types/lodash": "4.17.4",
+    "@types/lodash": "4.17.6",
     "@types/node": "20",
     "@types/semver": "7.5.8",
-    "@typescript-eslint/eslint-plugin": "7.9.0",
-    "@typescript-eslint/parser": "7.9.0",
+    "@typescript-eslint/eslint-plugin": "7.15.0",
+    "@typescript-eslint/parser": "7.15.0",
     "eslint": "8.57.0",
-    "eslint-plugin-jest": "28.5.0",
+    "eslint-plugin-jest": "28.6.0",
     "eslint-plugin-jest-formatting": "3.1.0",
     "eslint-plugin-sonarjs": "0.25.1",
     "jest": "29.7.0",
     "merge": "2.1.1",
-    "mongoose": "8.4.0",
+    "mongoose": "8.4.5",
     "open-cli": "8.0.0",
-    "typescript": "5.4.5"
+    "typescript": "5.5.3"
   },
   "peerDependencies": {
     "mongoose": ">=6.6.0 < 9"

package/src/patch.ts

@@ -16,16 +16,23 @@ function isPatchHistoryEnabled<T>(opts: IPluginOptions<T>, context: IContext<T>)
   return !opts.patchHistoryDisabled && !context.ignorePatchHistory
 }
 
-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>
+export function getJsonOmit<T>(opts: IPluginOptions<T>, doc: HydratedDocument<T>): Partial<T> {
+  const object = JSON.parse(JSON.stringify(doc)) as Partial<T>
 
   if (opts.omit) {
-    currentObject = omit(currentObject, opts.omit)
-    originalObject = omit(originalObject, opts.omit)
+    return omit(object, opts.omit)
   }
 
-  return { currentObject, originalObject }
+  return object
+}
+
+export function getObjectOmit<T>(opts: IPluginOptions<T>, doc: HydratedDocument<T>): Partial<T> {
+  if (opts.omit) {
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition, @typescript-eslint/unbound-method
+    return omit(_.isFunction(doc?.toObject) ? doc.toObject() : doc, opts.omit)
+  }
+
+  return doc
 }
 
 export async function getUser<T>(opts: IPluginOptions<T>): Promise<User | undefined> {
@@ -96,7 +103,7 @@ export async function bulkPatch<T>(opts: IPluginOptions<T>, context: IContext<T>
               modelName: context.modelName,
               collectionName: context.collectionName,
               collectionId: doc._id as Types.ObjectId,
-              doc,
+              doc: getObjectOmit(opts, doc),
               user,
               reason,
               metadata,
@@ -120,7 +127,8 @@ export async function createPatch<T>(opts: IPluginOptions<T>, context: IContext<
 export async function updatePatch<T>(opts: IPluginOptions<T>, context: IContext<T>, current: HydratedDocument<T>, original: HydratedDocument<T>): Promise<void> {
   const history = isPatchHistoryEnabled(opts, context)
 
-  const { currentObject, originalObject } = getObjects(opts, current, original)
+  const currentObject = getJsonOmit(opts, current)
+  const originalObject = getJsonOmit(opts, original)
   if (_.isEmpty(originalObject) || _.isEmpty(currentObject)) return
 
   const patch = jsonpatch.compare(originalObject, currentObject, true)

package/tests/patch.test.ts

@@ -1,6 +1,6 @@
 import mongoose, { model } from 'mongoose'
 
-import { getUser, getReason, getMetadata, getData, getValue, getObjects, bulkPatch, updatePatch } from '../src/patch'
+import { getUser, getReason, getMetadata, getData, getValue, getJsonOmit, bulkPatch, updatePatch } from '../src/patch'
 import { patchHistoryPlugin } from '../src/plugin'
 
 import UserSchema from './schemas/UserSchema'
@@ -53,7 +53,8 @@ describe('patch tests', () => {
         omit: ['createdAt'],
       }
 
-      const { currentObject, originalObject } = getObjects(pluginOptions, current, original)
+      const currentObject = getJsonOmit(pluginOptions, current)
+      const originalObject = getJsonOmit(pluginOptions, original)
 
       expect(currentObject.name).toBe('John')
       expect(currentObject.role).toBe('admin')
@@ -68,7 +69,10 @@ describe('patch tests', () => {
       const original = await User.create({ name: 'John', role: 'user' })
       const current = await User.create({ name: 'John', role: 'admin' })
 
-      const { currentObject, originalObject } = getObjects({}, current, original)
+      const pluginOptions = {}
+
+      const currentObject = getJsonOmit(pluginOptions, current)
+      const originalObject = getJsonOmit(pluginOptions, original)
 
       expect(currentObject.name).toBe('John')
       expect(currentObject.role).toBe('admin')

package/tests/plugin-event-deleted.test.ts

@@ -137,7 +137,7 @@ describe('plugin - event delete & patch history disabled', () => {
 
     const [john] = users
 
-    await User.findOneAndDelete({ role: 'user' }).exec()
+    await User.findOneAndDelete({ name: 'John' }).exec()
 
     const history = await History.find({})
     expect(history).toHaveLength(0)

package/tests/plugin-global.test.ts

@@ -64,8 +64,8 @@ describe('plugin - global', () => {
     expect(first.doc).toHaveProperty('_id', product._id)
     expect(first.doc).toHaveProperty('name', 'paper')
     expect(first.doc).toHaveProperty('groups', [])
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(first.patch).toHaveLength(0)
 
@@ -138,8 +138,8 @@ describe('plugin - global', () => {
     expect(first.doc).toHaveProperty('_id', product._id)
     expect(first.doc).toHaveProperty('name', 'paper')
     expect(first.doc).toHaveProperty('groups', [])
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(first.patch).toHaveLength(0)
 
@@ -210,8 +210,8 @@ describe('plugin - global', () => {
     expect(first.doc).toHaveProperty('_id', product._id)
     expect(first.doc).toHaveProperty('name', 'paper')
     expect(first.doc).toHaveProperty('description', { summary: 'test1' })
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(first.patch).toHaveLength(0)
 
@@ -286,8 +286,8 @@ describe('plugin - global', () => {
     expect(first.doc).toHaveProperty('_id', product._id)
     expect(first.doc).toHaveProperty('name', 'paper')
     expect(first.doc).toHaveProperty('description', { summary: 'test1' })
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(first.patch).toHaveLength(0)
 
@@ -361,8 +361,8 @@ describe('plugin - global', () => {
     expect(first.doc).toHaveProperty('_id', john._id)
     expect(first.doc).toHaveProperty('name', 'John')
     expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(first.patch).toHaveLength(0)
 
@@ -377,8 +377,8 @@ describe('plugin - global', () => {
     expect(second.doc).toHaveProperty('_id', alice._id)
     expect(second.doc).toHaveProperty('name', 'Alice')
     expect(second.doc).toHaveProperty('role', 'user')
-    expect(second.doc).toHaveProperty('createdAt')
-    expect(second.doc).toHaveProperty('updatedAt')
+    expect(second.doc).not.toHaveProperty('createdAt')
+    expect(second.doc).not.toHaveProperty('updatedAt')
 
     expect(second.patch).toHaveLength(0)
 
@@ -392,8 +392,8 @@ describe('plugin - global', () => {
     expect(third.doc).toHaveProperty('_id', product._id)
     expect(third.doc).toHaveProperty('name', 'paper')
     expect(third.doc).toHaveProperty('addedBy', john._id)
-    expect(third.doc).toHaveProperty('createdAt')
-    expect(third.doc).toHaveProperty('updatedAt')
+    expect(third.doc).not.toHaveProperty('createdAt')
+    expect(third.doc).not.toHaveProperty('updatedAt')
 
     expect(third.patch).toHaveLength(0)
 
@@ -454,8 +454,8 @@ describe('plugin - global', () => {
     expect(first.doc).toHaveProperty('_id', john._id)
     expect(first.doc).toHaveProperty('name', 'John')
     expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(first.patch).toHaveLength(0)
 
@@ -470,8 +470,8 @@ describe('plugin - global', () => {
     expect(second.doc).toHaveProperty('_id', alice._id)
     expect(second.doc).toHaveProperty('name', 'Alice')
     expect(second.doc).toHaveProperty('role', 'user')
-    expect(second.doc).toHaveProperty('createdAt')
-    expect(second.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(second.patch).toHaveLength(0)
 
@@ -485,8 +485,8 @@ describe('plugin - global', () => {
     expect(third.doc).toHaveProperty('_id', product._id)
     expect(third.doc).toHaveProperty('name', 'paper')
     expect(third.doc).toHaveProperty('addedBy', john._id)
-    expect(third.doc).toHaveProperty('createdAt')
-    expect(third.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
 
     expect(third.patch).toHaveLength(0)
 

package/tests/plugin-omit-all.test.ts

@@ -58,10 +58,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', user._id)
 
     expect(second.op).toBe('deleteMany')
@@ -71,10 +71,10 @@ describe('plugin - omit all', () => {
     expect(second.version).toBe(0)
     expect(second.patch).toHaveLength(0)
 
-    expect(second.doc).toHaveProperty('name', 'Bob')
-    expect(second.doc).toHaveProperty('role', 'user')
-    expect(second.doc).toHaveProperty('createdAt')
-    expect(second.doc).toHaveProperty('updatedAt')
+    expect(second.doc).not.toHaveProperty('name')
+    expect(second.doc).not.toHaveProperty('role')
+    expect(second.doc).not.toHaveProperty('createdAt')
+    expect(second.doc).not.toHaveProperty('updatedAt')
     expect(second.doc).toHaveProperty('_id', user._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -99,10 +99,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', user._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -126,10 +126,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', user._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -153,10 +153,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', user._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -184,10 +184,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', user._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -217,10 +217,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', john._id)
 
     expect(second.op).toBe('create')
@@ -230,10 +230,10 @@ describe('plugin - omit all', () => {
     expect(second.version).toBe(0)
     expect(second.patch).toHaveLength(0)
 
-    expect(second.doc).toHaveProperty('name', 'Alice')
-    expect(second.doc).toHaveProperty('role', 'user')
-    expect(second.doc).toHaveProperty('createdAt')
-    expect(second.doc).toHaveProperty('updatedAt')
+    expect(second.doc).not.toHaveProperty('name')
+    expect(second.doc).not.toHaveProperty('role')
+    expect(second.doc).not.toHaveProperty('createdAt')
+    expect(second.doc).not.toHaveProperty('updatedAt')
     expect(second.doc).toHaveProperty('_id', alice._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -255,10 +255,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id')
 
     expect(second.op).toBe('create')
@@ -268,10 +268,10 @@ describe('plugin - omit all', () => {
     expect(second.version).toBe(0)
     expect(second.patch).toHaveLength(0)
 
-    expect(second.doc).toHaveProperty('name', 'Alice')
-    expect(second.doc).toHaveProperty('role', 'user')
-    expect(second.doc).toHaveProperty('createdAt')
-    expect(second.doc).toHaveProperty('updatedAt')
+    expect(second.doc).not.toHaveProperty('name')
+    expect(second.doc).not.toHaveProperty('role')
+    expect(second.doc).not.toHaveProperty('createdAt')
+    expect(second.doc).not.toHaveProperty('updatedAt')
     expect(second.doc).toHaveProperty('_id')
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -294,8 +294,8 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'Bob')
-    expect(first.doc).toHaveProperty('role', 'user')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
     expect(first.doc).toHaveProperty('_id')
 
     expect(em.emit).toHaveBeenCalledTimes(0)
@@ -321,10 +321,10 @@ describe('plugin - omit all', () => {
     expect(first.version).toBe(0)
     expect(first.patch).toHaveLength(0)
 
-    expect(first.doc).toHaveProperty('name', 'John')
-    expect(first.doc).toHaveProperty('role', 'user')
-    expect(first.doc).toHaveProperty('createdAt')
-    expect(first.doc).toHaveProperty('updatedAt')
+    expect(first.doc).not.toHaveProperty('name')
+    expect(first.doc).not.toHaveProperty('role')
+    expect(first.doc).not.toHaveProperty('createdAt')
+    expect(first.doc).not.toHaveProperty('updatedAt')
     expect(first.doc).toHaveProperty('_id', john._id)
 
     expect(second.op).toBe('create')
@@ -334,10 +334,10 @@ describe('plugin - omit all', () => {
     expect(second.version).toBe(0)
     expect(second.patch).toHaveLength(0)
 
-    expect(second.doc).toHaveProperty('name', 'Alice')
-    expect(second.doc).toHaveProperty('role', 'user')
-    expect(second.doc).toHaveProperty('createdAt')
-    expect(second.doc).toHaveProperty('updatedAt')
+    expect(second.doc).not.toHaveProperty('name')
+    expect(second.doc).not.toHaveProperty('role')
+    expect(second.doc).not.toHaveProperty('createdAt')
+    expect(second.doc).not.toHaveProperty('updatedAt')
     expect(second.doc).toHaveProperty('_id', alice._id)
 
     expect(em.emit).toHaveBeenCalledTimes(0)

package/tests/plugin-pre-save.test.ts

@@ -0,0 +1,53 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import mongoose, { model } from 'mongoose'
+
+import UserSchema from './schemas/UserSchema'
+import { patchHistoryPlugin } from '../src/plugin'
+
+import { USER_CREATED } from './constants/events'
+
+import em from '../src/em'
+
+jest.mock('../src/em', () => {
+  return { emit: jest.fn() }
+})
+
+describe('plugin - preSave test', () => {
+  const uri = `${globalThis.__MONGO_URI__}${globalThis.__MONGO_DB_NAME__}`
+
+  UserSchema.plugin(patchHistoryPlugin, {
+    eventCreated: USER_CREATED,
+    omit: ['__v', 'role'],
+  })
+
+  const User = model('User', UserSchema)
+
+  beforeAll(async () => {
+    await mongoose.connect(uri)
+  })
+
+  afterAll(async () => {
+    await mongoose.connection.close()
+  })
+
+  beforeEach(async () => {
+    await mongoose.connection.collection('users').deleteMany({})
+    await mongoose.connection.collection('history').deleteMany({})
+  })
+
+  it('should create a User and execute save, and omit User role in history', async () => {
+    const john = await User.create({ name: 'John', role: 'user' })
+    const { __v, role, ...doc } = john.toJSON()
+
+    expect(em.emit).toHaveBeenCalledTimes(1)
+    expect(em.emit).toHaveBeenCalledWith(USER_CREATED, { doc })
+
+    expect(john).toMatchObject({ name: 'John', role: 'user' })
+
+    const entry = await mongoose.connection.collection('history').findOne({ collectionId: john._id })
+    expect(entry).not.toBeNull()
+    expect(entry?.doc).toMatchObject({ name: 'John' })
+    expect(entry?.doc.role).toBeUndefined()
+    expect(entry?.patch).toEqual([])
+  })
+})