ts-patch-mongoose 3.0.0 → 3.1.0

package/dist/index.mjs

@@ -138,6 +138,12 @@ const cloneImmutable = (value) => {
       cloned.lastIndex = re.lastIndex;
       return cloned;
     }
+    case "[object Error]": {
+      const err = value;
+      const cloned = new err.constructor(err.message);
+      if (err.stack) cloned.stack = err.stack;
+      return cloned;
+    }
     case "[object ArrayBuffer]":
       return cloneArrayBuffer(value);
     case "[object DataView]": {
@@ -186,7 +192,11 @@ const cloneDeep = (value, seen = /* @__PURE__ */ new WeakMap()) => {
   if (seen.has(value)) return seen.get(value);
   const immutable = cloneImmutable(value);
   if (immutable !== void 0) return immutable;
-  if ("toJSON" in value && typeof value.toJSON === "function") {
+  const record = value;
+  if (typeof record._bsontype === "string" && typeof record.toHexString === "function") {
+    return new value.constructor(record.toHexString());
+  }
+  if (typeof record.toJSON === "function") {
     return JSON.parse(JSON.stringify(value));
   }
   return cloneCollection(value, seen);
@@ -205,7 +215,7 @@ const toObjectOptions = {
   depopulate: true,
   virtuals: false
 };
-const setPatchHistoryTTL = async (ttl) => {
+const setPatchHistoryTTL = async (ttl, onError) => {
   const name = "createdAt_1_TTL";
   try {
     const indexes = await HistoryModel.collection.indexes();
@@ -228,7 +238,8 @@ const setPatchHistoryTTL = async (ttl) => {
     }
     await HistoryModel.collection.createIndex({ createdAt: 1 }, { expireAfterSeconds, name });
   } catch (err) {
-    console.error("Couldn't create or update index for history collection", err);
+    const handler = onError ?? console.error;
+    handler(err);
   }
 };
 
@@ -244,113 +255,65 @@ const isPlainObject = (val) => {
 const isUnsafeKey = (key) => {
   return key === "__proto__" || key === "constructor" || key === "prototype";
 };
-const getValue$1 = (obj, path) => {
-  const segs = path.split(".");
-  let current = obj;
-  for (const seg of segs) {
-    if (current == null || typeof current !== "object") return void 0;
-    current = current[seg];
-  }
-  return current;
-};
-const hasValue = (val) => {
-  if (val == null) return false;
-  if (typeof val === "boolean" || typeof val === "number" || typeof val === "function") return true;
-  if (typeof val === "string") return val.length !== 0;
-  if (Array.isArray(val)) return val.length !== 0;
-  if (val instanceof RegExp) return val.source !== "(?:)" && val.source !== "";
-  if (val instanceof Error) return val.message !== "";
-  if (val instanceof Map || val instanceof Set) return val.size !== 0;
-  if (typeof val === "object") {
-    for (const key of Object.keys(val)) {
-      if (hasValue(val[key])) return true;
-    }
-    return false;
-  }
-  return true;
-};
-const has = (obj, path) => {
-  if (obj != null && typeof obj === "object" && typeof path === "string") {
-    return hasValue(getValue$1(obj, path));
-  }
-  return false;
-};
-const unset = (obj, prop) => {
-  if (typeof obj !== "object" || obj === null) return false;
-  if (Object.hasOwn(obj, prop)) {
-    delete obj[prop];
-    return true;
-  }
-  if (has(obj, prop)) {
-    const segs = prop.split(".");
-    let last = segs.pop();
-    while (segs.length && segs.at(-1)?.slice(-1) === "\\") {
-      last = `${segs.pop().slice(0, -1)}.${last}`;
-    }
-    let target = obj;
-    while (segs.length) {
-      const seg = segs.shift();
-      if (isUnsafeKey(seg)) return false;
-      target = target[seg];
+const classifyKeys = (omitKeys) => {
+  const topLevel = /* @__PURE__ */ new Set();
+  const nested = /* @__PURE__ */ new Map();
+  for (const key of omitKeys) {
+    const dotIdx = key.indexOf(".");
+    if (dotIdx === -1) {
+      topLevel.add(key);
+    } else {
+      const head = key.slice(0, dotIdx);
+      const tail = key.slice(dotIdx + 1);
+      if (!isUnsafeKey(head)) {
+        const existing = nested.get(head) ?? [];
+        existing.push(tail);
+        nested.set(head, existing);
+      }
     }
-    return delete target[last ?? ""];
   }
-  return true;
+  return { topLevel, nested };
 };
 const omitDeep = (value, keys) => {
   if (value === void 0) return {};
   if (Array.isArray(value)) {
-    for (let i = 0; i < value.length; i++) {
-      value[i] = omitDeep(value[i], keys);
-    }
-    return value;
+    return value.map((item) => omitDeep(item, keys));
   }
   if (!isPlainObject(value)) return value;
   const omitKeys = typeof keys === "string" ? [keys] : keys;
   if (!Array.isArray(omitKeys)) return value;
-  for (const key of omitKeys) {
-    unset(value, key);
-  }
+  const { topLevel, nested } = classifyKeys(omitKeys);
+  const result = {};
   for (const key of Object.keys(value)) {
-    value[key] = omitDeep(value[key], omitKeys);
+    if (topLevel.has(key)) continue;
+    const nestedKeys = nested.get(key);
+    result[key] = omitDeep(value[key], nestedKeys ?? omitKeys);
   }
-  return value;
+  return result;
 };
 
 const isPatchHistoryEnabled = (opts, context) => {
   return !opts.patchHistoryDisabled && !context.ignorePatchHistory;
 };
+const applyOmit = (object, opts) => {
+  return opts.omit ? omitDeep(object, opts.omit) : object;
+};
+const replacer = (_key, value) => typeof value === "bigint" ? value.toString() : value;
 const getJsonOmit = (opts, doc) => {
-  const object = JSON.parse(JSON.stringify(doc));
-  if (opts.omit) {
-    return omitDeep(object, opts.omit);
-  }
-  return object;
+  return applyOmit(JSON.parse(JSON.stringify(doc, replacer)), opts);
 };
 const getObjectOmit = (opts, doc) => {
-  if (opts.omit) {
-    return omitDeep(isFunction(doc?.toObject) ? doc.toObject() : doc, opts.omit);
-  }
-  return doc;
-};
-const getUser = async (opts, doc) => {
-  if (isFunction(opts.getUser)) {
-    return await opts.getUser(doc);
-  }
-  return void 0;
-};
-const getReason = async (opts, doc) => {
-  if (isFunction(opts.getReason)) {
-    return await opts.getReason(doc);
-  }
-  return void 0;
+  return applyOmit(isFunction(doc?.toObject) ? doc.toObject() : doc, opts);
 };
-const getMetadata = async (opts, doc) => {
-  if (isFunction(opts.getMetadata)) {
-    return await opts.getMetadata(doc);
+const getOptionalField = async (fn, doc) => {
+  if (isFunction(fn)) {
+    return await fn(doc);
   }
   return void 0;
 };
+const getUser = async (opts, doc) => getOptionalField(opts.getUser, doc);
+const getReason = async (opts, doc) => getOptionalField(opts.getReason, doc);
+const getMetadata = async (opts, doc) => getOptionalField(opts.getMetadata, doc);
 const getValue = (item) => {
   return item.status === "fulfilled" ? item.value : void 0;
 };
@@ -361,7 +324,10 @@ const getData = async (opts, doc) => {
 };
 const emitEvent = (context, event, data) => {
   if (event && !context.ignoreEvent) {
-    em.emit(event, data);
+    try {
+      em.emit(event, data);
+    } catch {
+    }
   }
 };
 const bulkPatch = async (opts, context, eventKey, docsKey) => {
@@ -374,7 +340,8 @@ const bulkPatch = async (opts, context, eventKey, docsKey) => {
   for (const batch of chunks) {
     const bulk = [];
     for (const doc of batch) {
-      emitEvent(context, event, { [key]: doc });
+      const omitted = getObjectOmit(opts, doc);
+      emitEvent(context, event, { [key]: omitted });
       if (history) {
         const [user, reason, metadata] = await getData(opts, doc);
         bulk.push({
@@ -384,7 +351,7 @@ const bulkPatch = async (opts, context, eventKey, docsKey) => {
               modelName: context.modelName,
               collectionName: context.collectionName,
               collectionId: doc._id,
-              doc: getObjectOmit(opts, doc),
+              doc: omitted,
               version: 0,
               ...user !== void 0 && { user },
               ...reason !== void 0 && { reason },
@@ -395,8 +362,9 @@ const bulkPatch = async (opts, context, eventKey, docsKey) => {
       }
     }
     if (history && !isEmpty(bulk)) {
+      const onError = opts.onError ?? console.error;
       await HistoryModel.bulkWrite(bulk, { ordered: false }).catch((error) => {
-        console.error(error.message);
+        onError(error);
       });
     }
   }
@@ -419,6 +387,7 @@ const updatePatch = async (opts, context, current, original) => {
       version = lastHistory.version + 1;
     }
     const [user, reason, metadata] = await getData(opts, current);
+    const onError = opts.onError ?? console.error;
     await HistoryModel.create({
       op: context.op,
       modelName: context.modelName,
@@ -429,6 +398,8 @@ const updatePatch = async (opts, context, current, original) => {
       ...user !== void 0 && { user },
       ...reason !== void 0 && { reason },
       ...metadata !== void 0 && { metadata }
+    }).catch((error) => {
+      onError(error);
     });
   }
 };
@@ -445,8 +416,8 @@ const deleteHooksInitialize = (schema, opts) => {
     const filter = this.getFilter();
     this._context = {
       op: this.op,
-      modelName: opts.modelName ?? this.model.modelName,
-      collectionName: opts.collectionName ?? this.model.collection.collectionName,
+      modelName: opts.modelName ?? model.modelName,
+      collectionName: opts.collectionName ?? model.collection.collectionName,
       ignoreEvent: options.ignoreEvent,
       ignorePatchHistory: options.ignorePatchHistory
     };
@@ -462,12 +433,13 @@ const deleteHooksInitialize = (schema, opts) => {
       }
     }
     if (opts.preDelete && isArray(this._context.deletedDocs) && !isEmpty(this._context.deletedDocs)) {
-      await opts.preDelete(this._context.deletedDocs);
+      await opts.preDelete(cloneDeep(this._context.deletedDocs));
     }
   });
   schema.post(deleteMethods, { document: false, query: true }, async function() {
     const options = this.getOptions();
     if (isHookIgnored(options)) return;
+    if (!this._context) return;
     await deletePatch(opts, this._context);
   });
 };
@@ -495,15 +467,42 @@ const saveHooksInitialize = (schema, opts) => {
 };
 
 const updateMethods = ["update", "updateOne", "replaceOne", "updateMany", "findOneAndUpdate", "findOneAndReplace", "findByIdAndUpdate"];
+const trackChangedFields = (fields, updated, changed) => {
+  if (!fields) return;
+  for (const key of Object.keys(fields)) {
+    const root = key.split(".")[0];
+    changed.set(root, updated[root]);
+  }
+};
+const applyPullAll = (updated, fields, changed) => {
+  for (const [field, values] of Object.entries(fields)) {
+    const arr = updated[field];
+    if (Array.isArray(arr)) {
+      const filtered = arr.filter((item) => !values.some((v) => JSON.stringify(v) === JSON.stringify(item)));
+      updated[field] = filtered;
+      changed.set(field, filtered);
+    }
+  }
+};
 const assignUpdate = (document, update, commands) => {
   let updated = assign(document.toObject(toObjectOptions), update);
+  const changedByCommand = /* @__PURE__ */ new Map();
   for (const command of commands) {
+    const op = Object.keys(command)[0];
+    const fields = command[op];
     try {
       updated = assign(updated, command);
+      trackChangedFields(fields, updated, changedByCommand);
     } catch {
+      if (op === "$pullAll" && fields) {
+        applyPullAll(updated, fields, changedByCommand);
+      }
     }
   }
   const doc = document.set(updated).toObject(toObjectOptions);
+  for (const [field, value] of changedByCommand) {
+    doc[field] = value;
+  }
   if (update.createdAt) doc.createdAt = update.createdAt;
   return doc;
 };
@@ -523,17 +522,16 @@ const splitUpdateAndCommands = (updateQuery) => {
   return { update, commands };
 };
 const updateHooksInitialize = (schema, opts) => {
-  schema.pre(updateMethods, async function() {
+  schema.pre(updateMethods, { document: false, query: true }, async function() {
     const options = this.getOptions();
     if (isHookIgnored(options)) return;
     const model = this.model;
     const filter = this.getFilter();
-    const count = await this.model.countDocuments(filter).exec();
     this._context = {
       op: this.op,
-      modelName: opts.modelName ?? this.model.modelName,
-      collectionName: opts.collectionName ?? this.model.collection.collectionName,
-      isNew: Boolean(options.upsert) && count === 0,
+      modelName: opts.modelName ?? model.modelName,
+      collectionName: opts.collectionName ?? model.collection.collectionName,
+      isNew: Boolean(options.upsert) && await model.countDocuments(filter).exec() === 0,
       ignoreEvent: options.ignoreEvent,
       ignorePatchHistory: options.ignorePatchHistory
     };
@@ -545,24 +543,20 @@ const updateHooksInitialize = (schema, opts) => {
       await updatePatch(opts, this._context, assignUpdate(doc, update, commands), origDoc);
     });
   });
-  schema.post(updateMethods, async function() {
+  schema.post(updateMethods, { document: false, query: true }, async function() {
     const options = this.getOptions();
     if (isHookIgnored(options)) return;
+    if (!this._context) return;
     if (!this._context.isNew) return;
     const model = this.model;
     const updateQuery = this.getUpdate();
     const { update, commands } = splitUpdateAndCommands(updateQuery);
-    let current = null;
     const filter = this.getFilter();
-    const combined = assignUpdate(model.hydrate({}), update, commands);
-    if (!isEmpty(update) && !current) {
-      current = await model.findOne(update).sort("desc").lean().exec();
-    }
-    if (!isEmpty(combined) && !current) {
-      current = await model.findOne(combined).sort("desc").lean().exec();
-    }
-    if (!isEmpty(filter) && !current) {
-      current = await model.findOne(filter).sort("desc").lean().exec();
+    const candidates = [update, assignUpdate(model.hydrate({}), update, commands), filter];
+    let current = null;
+    for (const query of candidates) {
+      if (current || isEmpty(query)) continue;
+      current = await model.findOne(query).sort({ _id: -1 }).lean().exec();
     }
     if (current) {
       this._context.createdDocs = [current];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-patch-mongoose",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "Patch history & events for mongoose models",
   "author": "ilovepixelart",
   "license": "MIT",
@@ -75,17 +75,17 @@
     "power-assign": "0.2.10"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.4.7",
+    "@biomejs/biome": "2.4.9",
     "@types/node": "25.5.0",
-    "@vitest/coverage-v8": "4.1.0",
+    "@vitest/coverage-v8": "4.1.2",
     "mongodb-memory-server": "11.0.1",
-    "mongoose": "9.3.0",
+    "mongoose": "9.3.3",
     "np": "11.0.2",
-    "open-cli": "8.0.0",
+    "open-cli": "9.0.0",
     "pkgroll": "2.27.0",
     "simple-git-hooks": "2.13.1",
     "typescript": "5.9.3",
-    "vitest": "4.1.0"
+    "vitest": "4.1.2"
   },
   "peerDependencies": {
     "mongoose": ">=6.6.0 < 10"

package/src/helpers.ts

@@ -44,6 +44,12 @@ const cloneImmutable = <T>(value: T): T | undefined => {
       cloned.lastIndex = re.lastIndex
       return cloned as T
     }
+    case '[object Error]': {
+      const err = value as unknown as Error
+      const cloned = new (err.constructor as ErrorConstructor)(err.message)
+      if (err.stack) cloned.stack = err.stack
+      return cloned as T
+    }
     case '[object ArrayBuffer]':
       return cloneArrayBuffer(value as unknown as ArrayBuffer) as T
     case '[object DataView]': {
@@ -101,7 +107,13 @@ export const cloneDeep = <T>(value: T, seen = new WeakMap<object, unknown>()): T
   const immutable = cloneImmutable(value)
   if (immutable !== undefined) return immutable
 
-  if ('toJSON' in value && typeof (value as Record<string, unknown>).toJSON === 'function') {
+  const record = value as Record<string, unknown>
+
+  if (typeof record._bsontype === 'string' && typeof record.toHexString === 'function') {
+    return new (value.constructor as new (hex: string) => T)((record.toHexString as () => string)())
+  }
+
+  if (typeof record.toJSON === 'function') {
     // NOSONAR — structuredClone cannot handle objects with non-cloneable methods (e.g. mongoose documents)
     return JSON.parse(JSON.stringify(value)) as T
   }
@@ -126,7 +138,7 @@ export const toObjectOptions: ToObjectOptions = {
   virtuals: false,
 }
 
-export const setPatchHistoryTTL = async (ttl: Duration): Promise<void> => {
+export const setPatchHistoryTTL = async (ttl: Duration, onError?: (error: Error) => void): Promise<void> => {
   const name = 'createdAt_1_TTL'
   try {
     const indexes = await HistoryModel.collection.indexes()
@@ -156,6 +168,7 @@ export const setPatchHistoryTTL = async (ttl: Duration): Promise<void> => {
 
     await HistoryModel.collection.createIndex({ createdAt: 1 }, { expireAfterSeconds, name })
   } catch (err) {
-    console.error("Couldn't create or update index for history collection", err)
+    const handler = onError ?? console.error
+    handler(err as Error)
   }
 }

package/src/hooks/delete-hooks.ts

@@ -1,4 +1,4 @@
-import { isArray, isEmpty, isHookIgnored } from '../helpers'
+import { cloneDeep, isArray, isEmpty, isHookIgnored } from '../helpers'
 import { deletePatch } from '../patch'
 
 import type { HydratedDocument, Model, MongooseQueryMiddleware, Schema } from 'mongoose'
@@ -16,8 +16,8 @@ export const deleteHooksInitialize = <T>(schema: Schema<T>, opts: PluginOptions<
 
     this._context = {
       op: this.op,
-      modelName: opts.modelName ?? this.model.modelName,
-      collectionName: opts.collectionName ?? this.model.collection.collectionName,
+      modelName: opts.modelName ?? model.modelName,
+      collectionName: opts.collectionName ?? model.collection.collectionName,
       ignoreEvent: options.ignoreEvent as boolean,
       ignorePatchHistory: options.ignorePatchHistory as boolean,
     }
@@ -35,13 +35,14 @@ export const deleteHooksInitialize = <T>(schema: Schema<T>, opts: PluginOptions<
     }
 
     if (opts.preDelete && isArray(this._context.deletedDocs) && !isEmpty(this._context.deletedDocs)) {
-      await opts.preDelete(this._context.deletedDocs)
+      await opts.preDelete(cloneDeep(this._context.deletedDocs))
     }
   })
 
   schema.post(deleteMethods as MongooseQueryMiddleware[], { document: false, query: true }, async function (this: HookContext<T>) {
     const options = this.getOptions()
     if (isHookIgnored(options)) return
+    if (!this._context) return
 
     await deletePatch(opts, this._context)
   })

package/src/hooks/update-hooks.ts

@@ -7,17 +7,46 @@ import type { HookContext, PluginOptions } from '../types'
 
 const updateMethods = ['update', 'updateOne', 'replaceOne', 'updateMany', 'findOneAndUpdate', 'findOneAndReplace', 'findByIdAndUpdate']
 
+const trackChangedFields = (fields: Record<string, unknown> | undefined, updated: Record<string, unknown>, changed: Map<string, unknown>): void => {
+  if (!fields) return
+  for (const key of Object.keys(fields)) {
+    const root = key.split('.')[0] as string
+    changed.set(root, updated[root])
+  }
+}
+
+const applyPullAll = (updated: Record<string, unknown>, fields: Record<string, unknown[]>, changed: Map<string, unknown>): void => {
+  for (const [field, values] of Object.entries(fields)) {
+    const arr = updated[field]
+    if (Array.isArray(arr)) {
+      const filtered = arr.filter((item: unknown) => !values.some((v) => JSON.stringify(v) === JSON.stringify(item)))
+      updated[field] = filtered
+      changed.set(field, filtered)
+    }
+  }
+}
+
 export const assignUpdate = <T>(document: HydratedDocument<T>, update: UpdateQuery<T>, commands: Record<string, unknown>[]): HydratedDocument<T> => {
-  let updated = assign(document.toObject(toObjectOptions), update)
+  let updated = assign(document.toObject(toObjectOptions), update) as Record<string, unknown>
+  const changedByCommand = new Map<string, unknown>()
+
   for (const command of commands) {
+    const op = Object.keys(command)[0] as string
+    const fields = command[op] as Record<string, unknown> | undefined
     try {
       updated = assign(updated, command)
+      trackChangedFields(fields, updated, changedByCommand)
     } catch {
-      // we catch assign keys that are not implemented
+      if (op === '$pullAll' && fields) {
+        applyPullAll(updated, fields as Record<string, unknown[]>, changedByCommand)
+      }
     }
   }
 
   const doc = document.set(updated).toObject(toObjectOptions) as HydratedDocument<T> & { createdAt?: Date }
+  for (const [field, value] of changedByCommand) {
+    ;(doc as unknown as Record<string, unknown>)[field] = value
+  }
   if (update.createdAt) doc.createdAt = update.createdAt
   return doc
 }
@@ -41,19 +70,18 @@ export const splitUpdateAndCommands = <T>(updateQuery: UpdateWithAggregationPipe
 }
 
 export const updateHooksInitialize = <T>(schema: Schema<T>, opts: PluginOptions<T>): void => {
-  schema.pre(updateMethods as MongooseQueryMiddleware[], async function (this: HookContext<T>) {
+  schema.pre(updateMethods as MongooseQueryMiddleware[], { document: false, query: true }, async function (this: HookContext<T>) {
     const options = this.getOptions()
     if (isHookIgnored(options)) return
 
     const model = this.model as Model<T>
     const filter = this.getFilter()
-    const count = await this.model.countDocuments(filter).exec()
 
     this._context = {
       op: this.op,
-      modelName: opts.modelName ?? this.model.modelName,
-      collectionName: opts.collectionName ?? this.model.collection.collectionName,
-      isNew: Boolean(options.upsert) && count === 0,
+      modelName: opts.modelName ?? model.modelName,
+      collectionName: opts.collectionName ?? model.collection.collectionName,
+      isNew: Boolean(options.upsert) && (await model.countDocuments(filter).exec()) === 0,
       ignoreEvent: options.ignoreEvent as boolean,
       ignorePatchHistory: options.ignorePatchHistory as boolean,
     }
@@ -68,9 +96,10 @@ export const updateHooksInitialize = <T>(schema: Schema<T>, opts: PluginOptions<
     })
   })
 
-  schema.post(updateMethods as MongooseQueryMiddleware[], async function (this: HookContext<T>) {
+  schema.post(updateMethods as MongooseQueryMiddleware[], { document: false, query: true }, async function (this: HookContext<T>) {
     const options = this.getOptions()
     if (isHookIgnored(options)) return
+    if (!this._context) return
 
     if (!this._context.isNew) return
 
@@ -78,19 +107,13 @@ export const updateHooksInitialize = <T>(schema: Schema<T>, opts: PluginOptions<
     const updateQuery = this.getUpdate()
     const { update, commands } = splitUpdateAndCommands(updateQuery)
 
-    let current: HydratedDocument<T> | null = null
     const filter = this.getFilter()
-    const combined = assignUpdate(model.hydrate({}), update, commands)
-    if (!isEmpty(update) && !current) {
-      current = (await model.findOne(update).sort('desc').lean().exec()) as HydratedDocument<T>
-    }
+    const candidates = [update, assignUpdate(model.hydrate({}), update, commands), filter]
 
-    if (!isEmpty(combined) && !current) {
-      current = (await model.findOne(combined).sort('desc').lean().exec()) as HydratedDocument<T>
-    }
-
-    if (!isEmpty(filter) && !current) {
-      current = (await model.findOne(filter).sort('desc').lean().exec()) as HydratedDocument<T>
+    let current: HydratedDocument<T> | null = null
+    for (const query of candidates) {
+      if (current || isEmpty(query)) continue
+      current = (await model.findOne(query).sort({ _id: -1 }).lean().exec()) as HydratedDocument<T>
     }
 
     if (current) {