Merge pull request #300 from ilovepixelart/feature/metadata-update

Update metadata to support batch operations

Author: ilovepixelart

README.md

@@ -81,20 +81,18 @@ export const BOOK_UPDATED = 'book-updated'
 export const BOOK_DELETED = 'book-deleted'
 ```
 
-Create your interface `IBook.ts`
+Create your type `Book` in `types.ts`
 
 ```typescript
 import type { Types } from 'mongoose'
 
-interface IBook {
+export type Book = {
   title: string
   description?: string
   authorId: Types.ObjectId
   createdAt?: Date
   updatedAt?: Date
 }
-
-export default IBook
 ```
 
 Setup your mongoose model `Book.ts`
@@ -103,7 +101,7 @@ Setup your mongoose model `Book.ts`
 import { Schema, model } from 'mongoose'
 
 import type { HydratedDocument, Types } from 'mongoose'
-import type IBook from '../interfaces/IBook'
+import type { Book } from '../types'
 
 import { patchHistoryPlugin, setPatchHistoryTTL } from 'ts-patch-mongoose'
 import { BOOK_CREATED, BOOK_UPDATED, BOOK_DELETED } from '../constants/events'
@@ -114,7 +112,7 @@ import { BOOK_CREATED, BOOK_UPDATED, BOOK_DELETED } from '../constants/events'
 // Execute this method after you connected to you database somewhere in your application.
 setPatchHistoryTTL('1 month')
 
-const BookSchema = new Schema<IBook>({
+const BookSchema = new Schema<Book>({
   name: {
     title: String,
     required: true
@@ -142,21 +140,21 @@ BookSchema.plugin(patchHistoryPlugin, {
 
   // Code bellow is abstract example, you can use any other way to get user, reason, metadata
   // These three properties will be added to patch history document automatically and give you flexibility to track who, why and when made changes to your documents
-  getUser: async () => {
+  getUser: async (doc: HydratedDocument<Book>) => {
     // For example: get user from http context
     // You should return an object, in case you want to save user to patch history
     return httpContext.get('user') as Record<string, unknown>
   },
 
   // Reason of document (create/update/delete) like: 'Excel upload', 'Manual update', 'API call', etc.
-  getReason: async () => {
+  getReason: async (doc: HydratedDocument<Book>) => {
     // For example: get reason from http context, or any other place of your application
     // You shout return a string, in case you want to save reason to patch history
     return httpContext.get('reason') as string
   },
 
   // You can provide any information you want to save in along with patch history
-  getMetadata: async () => {
+  getMetadata: async (doc: HydratedDocument<Book>) => {
     // For example: get metadata from http context, or any other place of your application
     // You should return an object, in case you want to save metadata to patch history
     return httpContext.get('metadata') as Record<string, unknown>

package-lock.json

@@ -83,7 +83,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
-    "@types/node": "22.14.0",
+    "@types/node": "22.14.1",
     "@vitest/coverage-v8": "3.1.1",
     "mongodb-memory-server": "10.1.4",
     "mongoose": "8.13.2",

package.json

@@ -30,23 +30,23 @@ export function getObjectOmit<T>(opts: PluginOptions<T>, doc: HydratedDocument<T
   return doc
 }
 
-export async function getUser<T>(opts: PluginOptions<T>): Promise<User | undefined> {
+export async function getUser<T>(opts: PluginOptions<T>, doc: HydratedDocument<T>): Promise<User | undefined> {
   if (_.isFunction(opts.getUser)) {
-    return await opts.getUser()
+    return await opts.getUser(doc)
   }
   return undefined
 }
 
-export async function getReason<T>(opts: PluginOptions<T>): Promise<string | undefined> {
+export async function getReason<T>(opts: PluginOptions<T>, doc: HydratedDocument<T>): Promise<string | undefined> {
   if (_.isFunction(opts.getReason)) {
-    return await opts.getReason()
+    return await opts.getReason(doc)
   }
   return undefined
 }
 
-export async function getMetadata<T>(opts: PluginOptions<T>): Promise<Metadata | undefined> {
+export async function getMetadata<T>(opts: PluginOptions<T>, doc: HydratedDocument<T>): Promise<Metadata | undefined> {
   if (_.isFunction(opts.getMetadata)) {
-    return await opts.getMetadata()
+    return await opts.getMetadata(doc)
   }
   return undefined
 }
@@ -55,8 +55,8 @@ export function getValue<T>(item: PromiseSettledResult<T>): T | undefined {
   return item.status === 'fulfilled' ? item.value : undefined
 }
 
-export async function getData<T>(opts: PluginOptions<T>): Promise<[User | undefined, string | undefined, Metadata | undefined]> {
-  return Promise.allSettled([getUser(opts), getReason(opts), getMetadata(opts)]).then(([user, reason, metadata]) => {
+export async function getData<T>(opts: PluginOptions<T>, doc: HydratedDocument<T>): Promise<[User | undefined, string | undefined, Metadata | undefined]> {
+  return Promise.allSettled([getUser(opts, doc), getReason(opts, doc), getMetadata(opts, doc)]).then(([user, reason, metadata]) => {
     return [getValue(user), getValue(reason), getValue(metadata)]
   })
 }
@@ -75,8 +75,6 @@ export async function bulkPatch<T>(opts: PluginOptions<T>, context: PatchContext
 
   if (_.isEmpty(docs) || (!event && !history)) return
 
-  const [user, reason, metadata] = await getData(opts)
-
   const chunks = _.chunk(docs, 1000)
   for await (const chunk of chunks) {
     const bulk = []
@@ -85,6 +83,7 @@ export async function bulkPatch<T>(opts: PluginOptions<T>, context: PatchContext
       emitEvent(context, event, { [key]: doc })
 
       if (history) {
+        const [user, reason, metadata] = await getData(opts, doc)
         bulk.push({
           insertOne: {
             document: {
@@ -138,8 +137,7 @@ export async function updatePatch<T>(opts: PluginOptions<T>, context: PatchConte
       version = lastHistory.version + 1
     }
 
-    const [user, reason, metadata] = await getData(opts)
-
+    const [user, reason, metadata] = await getData(opts, current)
     await HistoryModel.create({
       op: context.op,
       modelName: context.modelName,

src/patch.ts

@@ -43,9 +43,9 @@ export interface PluginOptions<T> {
   eventUpdated?: string
   eventCreated?: string
   eventDeleted?: string
-  getUser?: () => Promise<User> | User
-  getReason?: () => Promise<string> | string
-  getMetadata?: () => Promise<Metadata> | Metadata
+  getUser?: (doc: HydratedDocument<T>) => Promise<User> | User
+  getReason?: (doc: HydratedDocument<T>) => Promise<string> | string
+  getMetadata?: (doc: HydratedDocument<T>) => Promise<Metadata> | Metadata
   omit?: string[]
   patchHistoryDisabled?: boolean
   preDelete?: (docs: HydratedDocument<T>[]) => Promise<void>