ts-patch-mongoose 1.0.4 → 1.0.6

package/README.md

@@ -1,6 +1,6 @@
 # ts-patch-mongoose
 
-Patch history & events for mongoose models
+Patch history & events plugin for mongoose
 
 [![npm](https://img.shields.io/npm/v/ts-patch-mongoose)](https://www.npmjs.com/package/ts-patch-mongoose)
 [![npm](https://img.shields.io/npm/dt/ts-patch-mongoose)](https://www.npmjs.com/package/ts-patch-mongoose)
@@ -17,9 +17,9 @@ Patch history & events for mongoose models
 
 ## Motivation
 
-ts-patch-mongoose is a plugin for mongoose and requires it as peer dependency
+ts-patch-mongoose is a plugin for mongoose
 \
-I needed to track changes in my mongoose models and save them as patch history (audit log) in separate collection. Events will allow me to track changes in my models and react to them in other parts of the application. I also wanted to omit some fields from patch history.
+I need to track changes of mongoose models and save them as patch history (audit log) in separate collection. Changes must also emit events that I can subscribe to and react in other parts of my application. I also want to omit some fields from patch history.
 
 ## Features
 
@@ -42,7 +42,30 @@ yarn add ts-patch-mongoose
 
 ## Example
 
-Setup your mongoose model
+How to use it with express [ts-express-swc](https://github.com/ilovepixelart/ts-express-swc)
+
+Create your event constants `events.ts`
+
+```typescript
+export const USER_CREATED = 'user-created'
+export const USER_UPDATED = 'user-updated'
+export const USER_DELETED = 'user-deleted'
+```
+
+Create your interface `IUser.ts`
+
+```typescript
+interface IUser {
+  name: string
+  role: string
+  createdAt?: Date
+  updatedAt?: Date
+}
+
+export default IUser
+```
+
+Setup your mongoose model `User.ts`
 
 ```typescript
 import { Schema, model } from 'mongoose'
@@ -50,8 +73,7 @@ import { Schema, model } from 'mongoose'
 import type IUser from '../interfaces/IUser'
 
 import { patchHistoryPlugin } from 'ts-patch-mongoose'
-
-import { USER_CREATED_EVENT, USER_DELETED_EVENT, USER_UPDATED_EVENT } from '../constants/events'
+import { USER_CREATED, USER_UPDATED, USER_DELETED } from '../constants/events'
 
 const UserSchema = new Schema<IUser>({
   name: {
@@ -70,9 +92,9 @@ UserSchema.plugin(patchHistoryPlugin, {
   patchHistoryDisabled: true,
 
   // Create event constants provide them to plugin and use them to subscribe to events
-  eventCreated: USER_CREATED_EVENT,
-  eventUpdated: USER_UPDATED_EVENT,
-  eventDeleted: USER_DELETED_EVENT,
+  eventCreated: USER_CREATED,
+  eventUpdated: USER_UPDATED,
+  eventDeleted: USER_DELETED,
   
   // You can omit some properties in case you don't want to save them to patch history
   omit: ['__v', 'createdAt', 'updatedAt']
@@ -89,16 +111,21 @@ You can subscribe to events using patchEventEmitter anywhere in your application
 
 ```typescript
 import { patchEventEmitter } from 'ts-patch-mongoose'
+import { USER_CREATED, USER_UPDATED, USER_DELETED } from '../constants/events'
 
-patchEventEmitter.on(USER_CREATED_EVENT, ({ doc }) => {
+patchEventEmitter.on(USER_CREATED, ({ doc }) => {
   console.log('User created', doc)
 })
 
-patchEventEmitter.on(USER_UPDATED_EVENT, ({ doc, oldDoc, patch }) => {
-  console.log('User updated', doc, patch)
+patchEventEmitter.on(USER_UPDATED, ({ doc, oldDoc, patch }) => {
+  console.log('User updated', doc, oldDoc, patch)
 })
 
-patchEventEmitter.on(USER_DELETED_EVENT, ({ doc }) => {
+patchEventEmitter.on(USER_DELETED, ({ doc }) => {
   console.log('User deleted', doc)
 })
 ```
+
+## Check my other projects
+
+- [ts-migrate-mongoose](https://github.com/ilovepixelart/ts-migrate-mongoose) - Migration framework for mongoose

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-patch-mongoose",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "Patch history & events for mongoose models",
   "author": "Alex Eagle",
   "license": "MIT",
@@ -31,7 +31,9 @@
     "emit",
     "create",
     "update",
-    "delete"
+    "delete",
+    "audit",
+    "log"
   ],
   "engines": {
     "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
@@ -71,7 +73,7 @@
   "devDependencies": {
     "@shelf/jest-mongodb": "4.1.7",
     "@swc/cli": "0.1.62",
-    "@swc/core": "1.3.46",
+    "@swc/core": "1.3.49",
     "@swc/helpers": "0.5.0",
     "@swc/jest": "0.2.24",
     "@swc/register": "0.1.10",