ts-patch-mongoose 2.6.7 → 2.6.8

package/README.md

@@ -105,9 +105,15 @@ import { Schema, model } from 'mongoose'
 import type { HydratedDocument, Types } from 'mongoose'
 import type IBook from '../interfaces/IBook'
 
-import { patchHistoryPlugin } from 'ts-patch-mongoose'
+import { patchHistoryPlugin, setPatchHistoryTTL } from 'ts-patch-mongoose'
 import { BOOK_CREATED, BOOK_UPDATED, BOOK_DELETED } from '../constants/events'
 
+// You can set patch history TTL in plain english or in milliseconds as you wish.
+// This will determine how long you want to keep patch history.
+// You don't need to use this global config in case you want to keep patch history forever.
+// Execute this method after you connected to you database somewhere in your application.
+setPatchHistoryTTL('1 month')
+
 const BookSchema = new Schema<IBook>({
   name: {
     title: String,

package/dist/cjs/helpers.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toObjectOptions = exports.isHookIgnored = void 0;
+exports.setPatchHistoryTTL = exports.toObjectOptions = exports.isHookIgnored = void 0;
+const tslib_1 = require("tslib");
+const ms_1 = tslib_1.__importDefault(require("ms"));
+const History_1 = tslib_1.__importDefault(require("./models/History"));
 const isHookIgnored = (options) => {
     return options.ignoreHook === true || (options.ignoreEvent === true && options.ignorePatchHistory === true);
 };
@@ -9,4 +12,32 @@ exports.toObjectOptions = {
     depopulate: true,
     virtuals: false,
 };
+const setPatchHistoryTTL = async (ttl) => {
+    const name = 'createdAt_1_TTL';
+    try {
+        const indexes = await History_1.default.collection.indexes();
+        const existingIndex = indexes?.find((index) => index.name === name);
+        if (!ttl && existingIndex) {
+            await History_1.default.collection.dropIndex(name);
+            return;
+        }
+        const milliseconds = (0, ms_1.default)(ttl);
+        if (milliseconds < 1000 && existingIndex) {
+            await History_1.default.collection.dropIndex(name);
+            return;
+        }
+        const expireAfterSeconds = milliseconds / 1000;
+        if (existingIndex && existingIndex.expireAfterSeconds === expireAfterSeconds) {
+            return;
+        }
+        if (existingIndex) {
+            await History_1.default.collection.dropIndex(name);
+        }
+        await History_1.default.collection.createIndex({ createdAt: 1 }, { expireAfterSeconds, name });
+    }
+    catch (err) {
+        console.error("Couldn't create or update index for history collection", err);
+    }
+};
+exports.setPatchHistoryTTL = setPatchHistoryTTL;
 //# sourceMappingURL=helpers.js.map

package/dist/cjs/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":";;;AAEO,MAAM,aAAa,GAAG,CAAI,OAAwB,EAAW,EAAE;IACpE,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,OAAO,CAAC,kBAAkB,KAAK,IAAI,CAAC,CAAA;AAC7G,CAAC,CAAA;AAFY,QAAA,aAAa,iBAEzB;AAEY,QAAA,eAAe,GAAoB;IAC9C,UAAU,EAAE,IAAI;IAChB,QAAQ,EAAE,KAAK;CAChB,CAAA"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":";;;;AAAA,oDAAmB;AAEnB,uEAAsC;AAI/B,MAAM,aAAa,GAAG,CAAI,OAAwB,EAAW,EAAE;IACpE,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,OAAO,CAAC,kBAAkB,KAAK,IAAI,CAAC,CAAA;AAC7G,CAAC,CAAA;AAFY,QAAA,aAAa,iBAEzB;AAEY,QAAA,eAAe,GAAoB;IAC9C,UAAU,EAAE,IAAI;IAChB,QAAQ,EAAE,KAAK;CAChB,CAAA;AAEM,MAAM,kBAAkB,GAAG,KAAK,EAAE,GAAoB,EAAiB,EAAE;IAC9E,MAAM,IAAI,GAAG,iBAAiB,CAAA;IAC9B,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,iBAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAA;QAClD,MAAM,aAAa,GAAG,OAAO,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;QAGnE,IAAI,CAAC,GAAG,IAAI,aAAa,EAAE,CAAC;YAC1B,MAAM,iBAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YACxC,OAAM;QACR,CAAC;QAED,MAAM,YAAY,GAAG,IAAA,YAAE,EAAC,GAAa,CAAC,CAAA;QAGtC,IAAI,YAAY,GAAG,IAAI,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,iBAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YACxC,OAAM;QACR,CAAC;QAED,MAAM,kBAAkB,GAAG,YAAY,GAAG,IAAI,CAAA;QAE9C,IAAI,aAAa,IAAI,aAAa,CAAC,kBAAkB,KAAK,kBAAkB,EAAE,CAAC;YAE7E,OAAM;QACR,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAElB,MAAM,iBAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC1C,CAAC;QAGD,MAAM,iBAAO,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAA;IACtF,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,wDAAwD,EAAE,GAAG,CAAC,CAAA;IAC9E,CAAC;AACH,CAAC,CAAA;AArCY,QAAA,kBAAkB,sBAqC9B"}

package/dist/cjs/plugin.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.patchHistoryPlugin = exports.patchEventEmitter = void 0;
+exports.patchHistoryPlugin = exports.setPatchHistoryTTL = exports.patchEventEmitter = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const em_1 = tslib_1.__importDefault(require("./em"));
@@ -12,6 +12,8 @@ const save_hooks_1 = require("./hooks/save-hooks");
 const update_hooks_1 = require("./hooks/update-hooks");
 const remove = version_1.isMongooseLessThan7 ? 'remove' : 'deleteOne';
 exports.patchEventEmitter = em_1.default;
+var helpers_2 = require("./helpers");
+Object.defineProperty(exports, "setPatchHistoryTTL", { enumerable: true, get: function () { return helpers_2.setPatchHistoryTTL; } });
 const patchHistoryPlugin = function plugin(schema, opts) {
     (0, save_hooks_1.saveHooksInitialize)(schema, opts);
     (0, update_hooks_1.updateHooksInitialize)(schema, opts);

package/dist/cjs/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":";;;;AAAA,4DAAsB;AACtB,sDAAqB;AAErB,uCAA2C;AAC3C,mCAAkD;AAClD,uCAAoE;AAEpE,uDAA4D;AAC5D,mDAAwD;AACxD,uDAA4D;AAM5D,MAAM,MAAM,GAAG,6BAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAA;AAK9C,QAAA,iBAAiB,GAAG,YAAE,CAAA;AAQ5B,MAAM,kBAAkB,GAAG,SAAS,MAAM,CAAI,MAAiB,EAAE,IAAuB;IAE7F,IAAA,gCAAmB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACjC,IAAA,oCAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACnC,IAAA,oCAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAGnC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,WAAW,IAAI;QAC5C,MAAM,OAAO,GAAG;YACd,EAAE,EAAE,QAAQ;YACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YAC3C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc;YACrE,WAAW,EAAE,IAAwC;SACtD,CAAA;QAED,MAAM,IAAA,mBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IAIF,IAAI,6BAAmB,EAAE,CAAC;QAExB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YAExD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAe,CAAwB,CAAA;YAEtE,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAC,CAAA;QAGF,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAe,CAAwB,CAAA;YACtE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAuB,CAAA;YAE1C,MAAM,OAAO,GAAgB;gBAC3B,EAAE,EAAE,QAAQ;gBACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS;gBAC5C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc;gBACtE,WAAW,EAAE,CAAC,QAAQ,CAAC;aACxB,CAAA;YAED,MAAM,IAAA,mBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAA;AA9CY,QAAA,kBAAkB,sBA8C9B"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":";;;;AAAA,4DAAsB;AACtB,sDAAqB;AAErB,uCAA2C;AAC3C,mCAAkD;AAClD,uCAAoE;AAEpE,uDAA4D;AAC5D,mDAAwD;AACxD,uDAA4D;AAM5D,MAAM,MAAM,GAAG,6BAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAA;AAK9C,QAAA,iBAAiB,GAAG,YAAE,CAAA;AAEnC,qCAA8C;AAArC,6GAAA,kBAAkB,OAAA;AAQpB,MAAM,kBAAkB,GAAG,SAAS,MAAM,CAAI,MAAiB,EAAE,IAAuB;IAE7F,IAAA,gCAAmB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACjC,IAAA,oCAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACnC,IAAA,oCAAqB,EAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAGnC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,WAAW,IAAI;QAC5C,MAAM,OAAO,GAAG;YACd,EAAE,EAAE,QAAQ;YACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YAC3C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc;YACrE,WAAW,EAAE,IAAwC;SACtD,CAAA;QAED,MAAM,IAAA,mBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IAIF,IAAI,6BAAmB,EAAE,CAAC;QAExB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YAExD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAe,CAAwB,CAAA;YAEtE,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,gBAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAC,CAAA;QAGF,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,yBAAe,CAAwB,CAAA;YACtE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAuB,CAAA;YAE1C,MAAM,OAAO,GAAgB;gBAC3B,EAAE,EAAE,QAAQ;gBACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS;gBAC5C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc;gBACtE,WAAW,EAAE,CAAC,QAAQ,CAAC;aACxB,CAAA;YAED,MAAM,IAAA,mBAAW,EAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAA;AA9CY,QAAA,kBAAkB,sBA8C9B"}

package/dist/cjs/types/helpers.d.ts

@@ -1,4 +1,5 @@
 import type { QueryOptions, ToObjectOptions } from 'mongoose';
 export declare const isHookIgnored: <T>(options: QueryOptions<T>) => boolean;
 export declare const toObjectOptions: ToObjectOptions;
+export declare const setPatchHistoryTTL: (ttl: number | string) => Promise<void>;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/cjs/types/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE7D,eAAO,MAAM,aAAa,GAAI,CAAC,WAAW,YAAY,CAAC,CAAC,CAAC,KAAG,OAE3D,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,eAG7B,CAAA"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE7D,eAAO,MAAM,aAAa,GAAI,CAAC,WAAW,YAAY,CAAC,CAAC,CAAC,KAAG,OAE3D,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,eAG7B,CAAA;AAED,eAAO,MAAM,kBAAkB,QAAe,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,IAAI,CAqC3E,CAAA"}

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

@@ -18,5 +18,6 @@ export declare const patchEventEmitter: {
     prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
     eventNames(): (string | symbol)[];
 };
+export { setPatchHistoryTTL } from './helpers';
 export declare const patchHistoryPlugin: <T>(schema: Schema<T>, opts: IPluginOptions<T>) => void;
 //# sourceMappingURL=plugin.d.ts.map

package/dist/cjs/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;AAE/D,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAO7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAK,CAAA;AAQnC,eAAO,MAAM,kBAAkB,GAAmB,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,QAAQ,cAAc,CAAC,CAAC,CAAC,KAAG,IA8CjG,CAAA"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAA2B,MAAM,EAAE,MAAM,UAAU,CAAA;AAE/D,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAO7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAK,CAAA;AAEnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAQ9C,eAAO,MAAM,kBAAkB,GAAmB,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,QAAQ,cAAc,CAAC,CAAC,CAAC,KAAG,IA8CjG,CAAA"}

package/dist/esm/helpers.js

@@ -1,3 +1,5 @@
+import ms from 'ms';
+import History from './models/History.js';
 export const isHookIgnored = (options) => {
     return options.ignoreHook === true || (options.ignoreEvent === true && options.ignorePatchHistory === true);
 };
@@ -5,4 +7,31 @@ export const toObjectOptions = {
     depopulate: true,
     virtuals: false,
 };
+export const setPatchHistoryTTL = async (ttl) => {
+    const name = 'createdAt_1_TTL';
+    try {
+        const indexes = await History.collection.indexes();
+        const existingIndex = indexes?.find((index) => index.name === name);
+        if (!ttl && existingIndex) {
+            await History.collection.dropIndex(name);
+            return;
+        }
+        const milliseconds = ms(ttl);
+        if (milliseconds < 1000 && existingIndex) {
+            await History.collection.dropIndex(name);
+            return;
+        }
+        const expireAfterSeconds = milliseconds / 1000;
+        if (existingIndex && existingIndex.expireAfterSeconds === expireAfterSeconds) {
+            return;
+        }
+        if (existingIndex) {
+            await History.collection.dropIndex(name);
+        }
+        await History.collection.createIndex({ createdAt: 1 }, { expireAfterSeconds, name });
+    }
+    catch (err) {
+        console.error("Couldn't create or update index for history collection", err);
+    }
+};
 //# sourceMappingURL=helpers.js.map

package/dist/esm/helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAG,CAAI,OAAwB,EAAW,EAAE;IACpE,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,OAAO,CAAC,kBAAkB,KAAK,IAAI,CAAC,CAAA;AAC7G,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAoB;IAC9C,UAAU,EAAE,IAAI;IAChB,QAAQ,EAAE,KAAK;CAChB,CAAA"}
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,IAAI,CAAA;AAEnB,OAAO,OAAO,MAAM,kBAAkB,CAAA;AAItC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAI,OAAwB,EAAW,EAAE;IACpE,OAAO,OAAO,CAAC,UAAU,KAAK,IAAI,IAAI,CAAC,OAAO,CAAC,WAAW,KAAK,IAAI,IAAI,OAAO,CAAC,kBAAkB,KAAK,IAAI,CAAC,CAAA;AAC7G,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,eAAe,GAAoB;IAC9C,UAAU,EAAE,IAAI;IAChB,QAAQ,EAAE,KAAK;CAChB,CAAA;AAED,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EAAE,GAAoB,EAAiB,EAAE;IAC9E,MAAM,IAAI,GAAG,iBAAiB,CAAA;IAC9B,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,OAAO,EAAE,CAAA;QAClD,MAAM,aAAa,GAAG,OAAO,EAAE,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,CAAA;QAGnE,IAAI,CAAC,GAAG,IAAI,aAAa,EAAE,CAAC;YAC1B,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YACxC,OAAM;QACR,CAAC;QAED,MAAM,YAAY,GAAG,EAAE,CAAC,GAAa,CAAC,CAAA;QAGtC,IAAI,YAAY,GAAG,IAAI,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YACxC,OAAM;QACR,CAAC;QAED,MAAM,kBAAkB,GAAG,YAAY,GAAG,IAAI,CAAA;QAE9C,IAAI,aAAa,IAAI,aAAa,CAAC,kBAAkB,KAAK,kBAAkB,EAAE,CAAC;YAE7E,OAAM;QACR,CAAC;QAED,IAAI,aAAa,EAAE,CAAC;YAElB,MAAM,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QAC1C,CAAC;QAGD,MAAM,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,EAAE,EAAE,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAA;IACtF,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,wDAAwD,EAAE,GAAG,CAAC,CAAA;IAC9E,CAAC;AACH,CAAC,CAAA"}

package/dist/esm/plugin.js

@@ -8,6 +8,7 @@ import { saveHooksInitialize } from './hooks/save-hooks.js';
 import { updateHooksInitialize } from './hooks/update-hooks.js';
 const remove = isMongooseLessThan7 ? 'remove' : 'deleteOne';
 export const patchEventEmitter = em;
+export { setPatchHistoryTTL } from './helpers';
 export const patchHistoryPlugin = function plugin(schema, opts) {
     saveHooksInitialize(schema, opts);
     updateHooksInitialize(schema, opts);

package/dist/esm/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,MAAM,MAAM,CAAA;AAErB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAM5D,MAAM,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAA;AAK3D,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAQnC,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,MAAM,CAAI,MAAiB,EAAE,IAAuB;IAE7F,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACjC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACnC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAGnC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,WAAW,IAAI;QAC5C,MAAM,OAAO,GAAG;YACd,EAAE,EAAE,QAAQ;YACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YAC3C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc;YACrE,WAAW,EAAE,IAAwC;SACtD,CAAA;QAED,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IAIF,IAAI,mBAAmB,EAAE,CAAC;QAExB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YAExD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAwB,CAAA;YAEtE,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAC,CAAA;QAGF,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAwB,CAAA;YACtE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAuB,CAAA;YAE1C,MAAM,OAAO,GAAgB;gBAC3B,EAAE,EAAE,QAAQ;gBACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS;gBAC5C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc;gBACtE,WAAW,EAAE,CAAC,QAAQ,CAAC;aACxB,CAAA;YAED,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAA"}
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,MAAM,MAAM,CAAA;AAErB,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAC3C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AAEpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAA;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAA;AAM5D,MAAM,MAAM,GAAG,mBAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAA;AAK3D,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAA;AAEnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAQ9C,MAAM,CAAC,MAAM,kBAAkB,GAAG,SAAS,MAAM,CAAI,MAAiB,EAAE,IAAuB;IAE7F,mBAAmB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACjC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACnC,qBAAqB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IAGnC,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,KAAK,WAAW,IAAI;QAC5C,MAAM,OAAO,GAAG;YACd,EAAE,EAAE,QAAQ;YACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YAC3C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,UAAU,CAAC,cAAc;YACrE,WAAW,EAAE,IAAwC;SACtD,CAAA;QAED,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;IAClC,CAAC,CAAC,CAAA;IAIF,IAAI,mBAAmB,EAAE,CAAC;QAExB,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YAExD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAwB,CAAA;YAEtE,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3C,MAAM,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAA;YAClC,CAAC;QACH,CAAC,CAAC,CAAA;QAGF,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,KAAK;YACzD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAwB,CAAA;YACtE,MAAM,KAAK,GAAG,IAAI,CAAC,WAAuB,CAAA;YAE1C,MAAM,OAAO,GAAgB;gBAC3B,EAAE,EAAE,QAAQ;gBACZ,SAAS,EAAE,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,SAAS;gBAC5C,cAAc,EAAE,IAAI,CAAC,cAAc,IAAI,KAAK,CAAC,UAAU,CAAC,cAAc;gBACtE,WAAW,EAAE,CAAC,QAAQ,CAAC;aACxB,CAAA;YAED,MAAM,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAClC,CAAC,CAAC,CAAA;IACJ,CAAC;AACH,CAAC,CAAA"}

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

@@ -1,4 +1,5 @@
 import type { QueryOptions, ToObjectOptions } from 'mongoose';
 export declare const isHookIgnored: <T>(options: QueryOptions<T>) => boolean;
 export declare const toObjectOptions: ToObjectOptions;
+export declare const setPatchHistoryTTL: (ttl: number | string) => Promise<void>;
 //# sourceMappingURL=helpers.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE7D,eAAO,MAAM,aAAa,GAAI,CAAC,WAAW,YAAY,CAAC,CAAC,CAAC,KAAG,OAE3D,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,eAG7B,CAAA"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../../../src/helpers.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAE7D,eAAO,MAAM,aAAa,GAAI,CAAC,WAAW,YAAY,CAAC,CAAC,CAAC,KAAG,OAE3D,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,eAG7B,CAAA;AAED,eAAO,MAAM,kBAAkB,QAAe,MAAM,GAAG,MAAM,KAAG,OAAO,CAAC,IAAI,CAqC3E,CAAA"}

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

@@ -18,5 +18,6 @@ export declare const patchEventEmitter: {
     prependOnceListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
     eventNames(): (string | symbol)[];
 };
+export { setPatchHistoryTTL } from './helpers';
 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;AAE/D,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAO7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAK,CAAA;AAQnC,eAAO,MAAM,kBAAkB,GAAmB,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,QAAQ,cAAc,CAAC,CAAC,CAAC,KAAG,IA8CjG,CAAA"}
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":"AAWA,OAAO,KAAK,EAA2B,MAAM,EAAE,MAAM,UAAU,CAAA;AAE/D,OAAO,KAAK,cAAc,MAAM,6BAA6B,CAAA;AAO7D,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;CAAK,CAAA;AAEnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,WAAW,CAAA;AAQ9C,eAAO,MAAM,kBAAkB,GAAmB,CAAC,UAAU,MAAM,CAAC,CAAC,CAAC,QAAQ,cAAc,CAAC,CAAC,CAAC,KAAG,IA8CjG,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-patch-mongoose",
-  "version": "2.6.7",
+  "version": "2.6.8",
   "description": "Patch history & events for mongoose models",
   "author": "Alex Eagle",
   "license": "MIT",
@@ -77,6 +77,7 @@
   "dependencies": {
     "fast-json-patch": "3.1.1",
     "lodash": "4.17.21",
+    "ms": "2.1.3",
     "omit-deep": "0.3.0",
     "power-assign": "0.2.10",
     "semver": "7.6.3"
@@ -84,12 +85,13 @@
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
     "@types/lodash": "4.17.13",
+    "@types/ms": "0.7.34",
     "@types/node": "22.10.1",
     "@types/semver": "7.5.8",
     "@vitest/coverage-v8": "2.1.8",
     "merge": "2.1.1",
     "mongodb-memory-server": "10.1.2",
-    "mongoose": "8.8.3",
+    "mongoose": "8.8.4",
     "open-cli": "8.0.0",
     "typescript": "5.7.2",
     "vitest": "2.1.8"

package/src/helpers.ts

@@ -1,3 +1,7 @@
+import ms from 'ms'
+
+import History from './models/History'
+
 import type { QueryOptions, ToObjectOptions } from 'mongoose'
 
 export const isHookIgnored = <T>(options: QueryOptions<T>): boolean => {
@@ -8,3 +12,42 @@ export const toObjectOptions: ToObjectOptions = {
   depopulate: true,
   virtuals: false,
 }
+
+export const setPatchHistoryTTL = async (ttl: number | string): Promise<void> => {
+  const name = 'createdAt_1_TTL' // To avoid collision with user defined index / manually created index
+  try {
+    const indexes = await History.collection.indexes()
+    const existingIndex = indexes?.find((index) => index.name === name)
+
+    // Drop the index if historyTTL is not set and index exists
+    if (!ttl && existingIndex) {
+      await History.collection.dropIndex(name)
+      return
+    }
+
+    const milliseconds = ms(ttl as string)
+
+    // Drop the index if historyTTL is less than 1 second and index exists
+    if (milliseconds < 1000 && existingIndex) {
+      await History.collection.dropIndex(name)
+      return
+    }
+
+    const expireAfterSeconds = milliseconds / 1000
+
+    if (existingIndex && existingIndex.expireAfterSeconds === expireAfterSeconds) {
+      // Index already exists with the correct TTL, no need to recreate
+      return
+    }
+
+    if (existingIndex) {
+      // Drop the existing index if it exists and TTL is different
+      await History.collection.dropIndex(name)
+    }
+
+    // Create a new index with the correct TTL if it doesn't exist or if the TTL is different
+    await History.collection.createIndex({ createdAt: 1 }, { expireAfterSeconds, name })
+  } catch (err) {
+    console.error("Couldn't create or update index for history collection", err)
+  }
+}

package/src/plugin.ts

@@ -20,6 +20,8 @@ const remove = isMongooseLessThan7 ? 'remove' : 'deleteOne'
  */
 export const patchEventEmitter = em
 
+export { setPatchHistoryTTL } from './helpers'
+
 /**
  * @description Patch history plugin
  * @param {Schema} schema

package/tests/helpers.test.ts

@@ -0,0 +1,86 @@
+import ms from 'ms'
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest'
+
+import History from '../src/models/History'
+
+import { setPatchHistoryTTL } from '../src/helpers'
+
+import type { Mock, MockInstance } from 'vitest'
+
+vi.mock('../src/models/History', () => ({
+  default: {
+    collection: {
+      indexes: vi.fn(),
+      dropIndex: vi.fn(),
+      createIndex: vi.fn(),
+    },
+  },
+}))
+
+const name = 'createdAt_1_TTL'
+
+describe('useTTL', () => {
+  let dropIndexSpy: MockInstance
+  let createIndexSpy: MockInstance
+  const indexes = History.collection.indexes as Mock
+
+  beforeEach(() => {
+    vi.clearAllMocks()
+    dropIndexSpy = vi.spyOn(History.collection, 'dropIndex')
+    createIndexSpy = vi.spyOn(History.collection, 'createIndex')
+  })
+
+  afterEach(() => {
+    vi.restoreAllMocks()
+  })
+
+  it('should drop the index if historyTTL is not set and index exists', async () => {
+    indexes.mockResolvedValue([{ name }])
+
+    // @ts-expect-error ttl can't be undefined in this case but we want to test it
+    await setPatchHistoryTTL(undefined)
+    expect(dropIndexSpy).toHaveBeenCalledWith(name)
+  })
+
+  it('should drop the index if historyTTL is less than 1 second and index exists', async () => {
+    indexes.mockResolvedValue([{ name }])
+
+    await setPatchHistoryTTL('500ms')
+    expect(dropIndexSpy).toHaveBeenCalledWith(name)
+  })
+
+  it('should not recreate the index if it already exists with the correct TTL', async () => {
+    const ttl = '1h'
+    const expireAfterSeconds = ms(ttl) / 1000
+
+    indexes.mockResolvedValue([{ name, expireAfterSeconds }])
+
+    await setPatchHistoryTTL(ttl)
+    expect(dropIndexSpy).not.toHaveBeenCalled()
+    expect(createIndexSpy).not.toHaveBeenCalled()
+  })
+
+  it('should drop and recreate the index if TTL is different', async () => {
+    const ttlBefore = '1h'
+    const ttlAfter = '2h'
+
+    const expireAfterSecondsBefore = ms(ttlBefore) / 1000
+    const expireAfterSecondsAfter = ms(ttlAfter) / 1000
+
+    indexes.mockResolvedValue([{ name, expireAfterSeconds: expireAfterSecondsBefore }])
+
+    await setPatchHistoryTTL(ttlAfter)
+    expect(dropIndexSpy).toHaveBeenCalledWith(name)
+    expect(createIndexSpy).toHaveBeenCalledWith({ createdAt: 1 }, { expireAfterSeconds: expireAfterSecondsAfter, name })
+  })
+
+  it('should create the index if it does not exist', async () => {
+    const ttl = '1h'
+    const expireAfterSeconds = ms(ttl) / 1000
+
+    indexes.mockResolvedValue([])
+
+    await setPatchHistoryTTL(ttl)
+    expect(createIndexSpy).toHaveBeenCalledWith({ createdAt: 1 }, { expireAfterSeconds, name })
+  })
+})