ts-cache-mongoose 0.0.1

package/dist/esm/crypto.js

@@ -0,0 +1,22 @@
+import _ from 'lodash';
+import { createHash } from 'crypto';
+export function sortDeep(data) {
+    if (_.isObjectLike(data) && _.isArray(data)) {
+        return data.map(sortDeep);
+    }
+    if (_.isObjectLike(data) && !_.isArray(data)) {
+        const sortedKeys = _.keys(data).sort((a, b) => a.localeCompare(b));
+        const sortedObj = {};
+        sortedKeys.forEach((key) => {
+            sortedObj[key] = sortDeep(data[key]);
+        });
+        return sortedObj;
+    }
+    return data;
+}
+export function getKey(data) {
+    const sortedObj = sortDeep(data);
+    const sortedStr = JSON.stringify(sortedObj);
+    return createHash('sha256').update(sortedStr).digest('hex');
+}
+//# sourceMappingURL=crypto.js.map

package/dist/esm/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../src/crypto.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAA;AAEnC,MAAM,UAAU,QAAQ,CAAE,IAAyD;IACjF,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC3C,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;KAC1B;IAED,IAAI,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC5C,MAAM,UAAU,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;QAClE,MAAM,SAAS,GAA4B,EAAE,CAAA;QAE7C,UAAU,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACzB,SAAS,CAAC,GAAG,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAwD,CAAC,CAAA;QAC7F,CAAC,CAAC,CAAA;QAEF,OAAO,SAAS,CAAA;KACjB;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,MAAM,UAAU,MAAM,CAAE,IAAyD;IAC/E,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAA;IAChC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAA;IAC3C,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;AAC7D,CAAC"}

package/dist/esm/interfaces/ICacheEngine.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICacheEngine.js.map

package/dist/esm/interfaces/ICacheEngine.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICacheEngine.js","sourceRoot":"","sources":["../../../src/interfaces/ICacheEngine.ts"],"names":[],"mappings":""}

package/dist/esm/interfaces/ICacheMongooseOptions.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ICacheMongooseOptions.js.map

package/dist/esm/interfaces/ICacheMongooseOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICacheMongooseOptions.js","sourceRoot":"","sources":["../../../src/interfaces/ICacheMongooseOptions.ts"],"names":[],"mappings":""}

package/dist/esm/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAA;AACtB,OAAO,EAAE,MAAM,IAAI,CAAA;AACnB,OAAO,KAAK,MAAM,eAAe,CAAA;AAIjC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AAgBjC,MAAM,aAAa;IAKjB;IAEA,CAAC;IAGM,MAAM,CAAC,IAAI,CAAE,QAAkB,EAAE,oBAA2C;QACjF,IAAI,OAAO,QAAQ,CAAC,KAAK,CAAC,OAAO,KAAK,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,8FAA8F,CAAC,CAAA;QACjK,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,IAAI,CAAC,QAAQ,GAAG,IAAI,aAAa,EAAE,CAAA;YACnC,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,oBAAoB,CAAC,MAAM,EAAE,oBAAoB,CAAC,UAAU,GAAG,UAAU,CAAC,CAAA;YAE1G,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAA;YAGjC,MAAM,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAA;YAGlD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG;gBACrC,IAAI,IAAI,CAAC,IAAI;oBAAE,OAAO,IAAI,CAAC,IAAI,CAAA;gBAE/B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;gBAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAA;gBAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAA;gBAEjC,MAAM,IAAI,GAA4B;oBACpC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS;oBAC3B,EAAE,EAAE,IAAI,CAAC,EAAE;oBACX,MAAM;oBACN,MAAM;oBACN,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO,EAAE,IAAI,CAAC,OAAO;oBACrB,KAAK,EAAE,IAAI,CAAC,KAAK;oBACjB,SAAS,EAAE,IAAI,CAAC,SAAS;iBAC1B,CAAA;gBAED,OAAO,MAAM,CAAC,IAAI,CAAC,CAAA;YACrB,CAAC,CAAA;YAGD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG;gBACrC,OAAO,IAAI,CAAC,IAAI,CAAA;YAClB,CAAC,CAAA;YAGD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,GAAG,UAAU,GAAY,EAAE,SAAkB;gBACzE,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC,GAAG,IAAI,UAAU,CAAC,CAAA;gBACjC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAA;gBACrB,OAAO,IAAI,CAAA;YACb,CAAC,CAAA;YAGD,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,GAAG,KAAK;gBACnC,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;oBACxB,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;iBAChC;gBAED,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;gBAC9B,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAA;gBAE9B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAA;gBAElC,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;gBACxC,IAAI,WAAW,EAAE;oBACf,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;oBACzC,IAAI,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE;wBAC1B,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAA4B,CAAC,CAAA;qBACvF;yBAAM;wBACL,OAAO,WAAW,CAAC,OAAO,CAAC,WAAW,CAA4B,CAAA;qBACnE;iBACF;gBAED,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,IAAI,CAAC,IAAI,CAAwD,CAAA;gBACnG,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE;oBACxC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;gBACpB,CAAC,CAAC,CAAA;gBAEF,OAAO,MAAM,CAAA;YACf,CAAC,CAAA;SACF;QAED,OAAO,IAAI,CAAC,QAAQ,CAAA;IACtB,CAAC;IAEM,KAAK,CAAC,UAAU,CAAE,SAAiB;QACxC,IAAI,CAAC,SAAS,EAAE;YACd,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;YACxB,OAAM;SACP;QACD,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACjC,CAAC;CACF;AAED,eAAe,aAAa,CAAA"}

package/dist/esm/plugin.mjs

@@ -0,0 +1,79 @@
+import _ from 'lodash';
+import ms from 'ms';
+import Cache from './cache/Cache';
+import { getKey } from './crypto';
+class CacheMongoose {
+    constructor() {
+    }
+    static init(mongoose, cacheMongooseOptions) {
+        if (typeof mongoose.Model.hydrate !== 'function')
+            throw new Error('Cache is only compatible with versions of mongoose that implement the `model.hydrate` method');
+        if (!this.instance) {
+            this.instance = new CacheMongoose();
+            this.instance.cache = new Cache(cacheMongooseOptions.engine, cacheMongooseOptions.defaultTTL = '1 minute');
+            const cache = this.instance.cache;
+            const mongooseExec = mongoose.Query.prototype.exec;
+            mongoose.Query.prototype.getCacheKey = function () {
+                if (this._key)
+                    return this._key;
+                const filter = this.getFilter();
+                const update = this.getUpdate();
+                const options = this.getOptions();
+                const data = {
+                    model: this.model.modelName,
+                    op: this.op,
+                    filter,
+                    update,
+                    skip: options.skip,
+                    limit: options.limit,
+                    sort: options.sort,
+                    _fields: this._fields,
+                    _path: this._path,
+                    _distinct: this._distinct
+                };
+                return getKey(data);
+            };
+            mongoose.Query.prototype.getCacheTTL = function () {
+                return this._ttl;
+            };
+            mongoose.Query.prototype.cache = function (ttl, customKey) {
+                this._ttl = ms(ttl ?? '1 minute');
+                this._key = customKey;
+                return this;
+            };
+            mongoose.Query.prototype.exec = async function () {
+                if (!_.has(this, '_ttl')) {
+                    return mongooseExec.apply(this);
+                }
+                const key = this.getCacheKey();
+                const ttl = this.getCacheTTL();
+                const model = this.model.modelName;
+                const resultCache = await cache.get(key);
+                if (resultCache) {
+                    const constructor = mongoose.model(model);
+                    if (_.isArray(resultCache)) {
+                        return resultCache.map((item) => constructor.hydrate(item));
+                    }
+                    else {
+                        return constructor.hydrate(resultCache);
+                    }
+                }
+                const result = await mongooseExec.call(this);
+                cache.set(key, result, ttl).catch((err) => {
+                    console.error(err);
+                });
+                return result;
+            };
+        }
+        return this.instance;
+    }
+    async clearCache(customKey) {
+        if (!customKey) {
+            await this.cache.clear();
+            return;
+        }
+        await this.cache.del(customKey);
+    }
+}
+export default CacheMongoose;
+//# sourceMappingURL=plugin.js.map

package/dist/esm/types/cache/Cache.d.ts

@@ -0,0 +1,12 @@
+export declare const engines: readonly ["memory", "redis"];
+declare class Cache {
+    private engine;
+    private defaultTTL;
+    constructor(engineName: 'memory' | 'redis', defaultTTL: string);
+    get(key: string): Promise<Record<string, unknown> | Record<string, unknown>[] | undefined>;
+    set(key: string, value: Record<string, unknown> | Record<string, unknown>[], ttl?: number): Promise<void>;
+    del(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export default Cache;
+//# sourceMappingURL=Cache.d.ts.map

package/dist/esm/types/cache/Cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cache.d.ts","sourceRoot":"","sources":["../../../../src/cache/Cache.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,OAAO,8BAA+B,CAAA;AAEnD,cAAM,KAAK;IACT,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,UAAU,CAAQ;gBAEb,UAAU,EAAE,QAAQ,GAAG,OAAO,EAAE,UAAU,EAAE,MAAM;IAczD,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAI3F,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK1G,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhC,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;CAG9B;AAED,eAAe,KAAK,CAAA"}

package/dist/esm/types/cache/engine/MemoryCacheEngine.d.ts

@@ -0,0 +1,11 @@
+import type ICacheEngine from '../../interfaces/ICacheEngine';
+declare class MemoryCacheEngine implements ICacheEngine {
+    private cache;
+    constructor();
+    get(key: string): Record<string, unknown> | Record<string, unknown>[] | undefined;
+    set(key: string, value: Record<string, unknown> | Record<string, unknown>[], ttl?: number): void;
+    del(key: string): void;
+    clear(): void;
+}
+export default MemoryCacheEngine;
+//# sourceMappingURL=MemoryCacheEngine.d.ts.map

package/dist/esm/types/cache/engine/MemoryCacheEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MemoryCacheEngine.d.ts","sourceRoot":"","sources":["../../../../../src/cache/engine/MemoryCacheEngine.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,+BAA+B,CAAA;AAE7D,cAAM,iBAAkB,YAAW,YAAY;IAC7C,OAAO,CAAC,KAAK,CAA+G;;IAM5H,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,SAAS;IAQlF,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,SAAW,GAAG,IAAI;IAInG,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAKvB,KAAK,IAAK,IAAI;CAGf;AAED,eAAe,iBAAiB,CAAA"}

package/dist/esm/types/cache/engine/RedisCacheEngine.d.ts

@@ -0,0 +1,11 @@
+import type ICacheEngine from '../../interfaces/ICacheEngine';
+declare class RedisCacheEngine implements ICacheEngine {
+    private client;
+    constructor();
+    get(key: string): Promise<Record<string, unknown> | Record<string, unknown>[] | undefined>;
+    set(key: string, value: unknown, ttl?: number): Promise<void>;
+    del(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export default RedisCacheEngine;
+//# sourceMappingURL=RedisCacheEngine.d.ts.map

package/dist/esm/types/cache/engine/RedisCacheEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RedisCacheEngine.d.ts","sourceRoot":"","sources":["../../../../../src/cache/engine/RedisCacheEngine.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,YAAY,MAAM,+BAA+B,CAAA;AAE7D,cAAM,gBAAiB,YAAW,YAAY;IAC5C,OAAO,CAAC,MAAM,CAAO;;IAMf,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC;IAQ3F,GAAG,CAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,SAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhE,GAAG,CAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIhC,KAAK,IAAK,OAAO,CAAC,IAAI,CAAC;CAG9B;AAED,eAAe,gBAAgB,CAAA"}

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

@@ -0,0 +1,3 @@
+export declare function sortDeep(data: Record<string, unknown>[] | Record<string, unknown>): unknown;
+export declare function getKey(data: Record<string, unknown>[] | Record<string, unknown>): string;
+//# sourceMappingURL=crypto.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../../../src/crypto.ts"],"names":[],"mappings":"AAGA,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAiB5F;AAED,wBAAgB,MAAM,CAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAIzF"}

package/dist/esm/types/interfaces/ICacheEngine.d.ts

@@ -0,0 +1,8 @@
+interface ICacheEngine {
+    get: (key: string) => Promise<Record<string, unknown> | Record<string, unknown>[] | undefined> | Record<string, unknown> | Record<string, unknown>[] | undefined;
+    set: (key: string, value: Record<string, unknown> | Record<string, unknown>[], ttl?: number) => Promise<void> | void;
+    del: (key: string) => Promise<void> | void;
+    clear: () => Promise<void> | void;
+}
+export default ICacheEngine;
+//# sourceMappingURL=ICacheEngine.d.ts.map

package/dist/esm/types/interfaces/ICacheEngine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICacheEngine.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/ICacheEngine.ts"],"names":[],"mappings":"AAAA,UAAU,YAAY;IACpB,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,GAAG,SAAS,CAAA;IAChK,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACpH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC1C,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAClC;AAED,eAAe,YAAY,CAAA"}

package/dist/esm/types/interfaces/ICacheMongooseOptions.d.ts

@@ -0,0 +1,10 @@
+interface ICacheMongooseOptions {
+    engine: 'memory' | 'redis';
+    defaultTTL?: string;
+    port?: number;
+    host?: string;
+    password?: string;
+    client?: unknown;
+}
+export default ICacheMongooseOptions;
+//# sourceMappingURL=ICacheMongooseOptions.d.ts.map

package/dist/esm/types/interfaces/ICacheMongooseOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICacheMongooseOptions.d.ts","sourceRoot":"","sources":["../../../../src/interfaces/ICacheMongooseOptions.ts"],"names":[],"mappings":"AAAA,UAAU,qBAAqB;IAC7B,MAAM,EAAE,QAAQ,GAAG,OAAO,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,eAAe,qBAAqB,CAAA"}

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

@@ -0,0 +1,24 @@
+import type { Mongoose } from 'mongoose';
+import type ICacheMongooseOptions from './interfaces/ICacheMongooseOptions';
+declare module 'mongoose' {
+    interface Query<ResultType, DocType, THelpers, RawDocType> {
+        cache: (this: Query<ResultType, DocType, THelpers, RawDocType>, ttl?: string) => this;
+        _key?: string;
+        getCacheKey: (this: Query<ResultType, DocType, THelpers, RawDocType>) => string;
+        _ttl: number;
+        getCacheTTL: (this: Query<ResultType, DocType, THelpers, RawDocType>) => number;
+        op?: string;
+        _fields?: unknown;
+        _path?: unknown;
+        _distinct?: unknown;
+    }
+}
+declare class CacheMongoose {
+    private static instance;
+    private cache;
+    private constructor();
+    static init(mongoose: Mongoose, cacheMongooseOptions: ICacheMongooseOptions): CacheMongoose;
+    clearCache(customKey: string): Promise<void>;
+}
+export default CacheMongoose;
+//# sourceMappingURL=plugin.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/plugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACxC,OAAO,KAAK,qBAAqB,MAAM,oCAAoC,CAAA;AAG3E,OAAO,QAAQ,UAAU,CAAC;IACxB,UAAU,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU;QACvD,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;QACrF,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,MAAM,CAAA;QAC/E,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,EAAE,CAAC,IAAI,EAAE,KAAK,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,CAAC,KAAK,MAAM,CAAA;QAC/E,EAAE,CAAC,EAAE,MAAM,CAAA;QACX,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,KAAK,CAAC,EAAE,OAAO,CAAA;QACf,SAAS,CAAC,EAAE,OAAO,CAAA;KACpB;CACF;AAED,cAAM,aAAa;IAEjB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAA2B;IAClD,OAAO,CAAC,KAAK,CAAQ;IAErB,OAAO;WAKO,IAAI,CAAE,QAAQ,EAAE,QAAQ,EAAE,oBAAoB,EAAE,qBAAqB,GAAG,aAAa;IAgFtF,UAAU,CAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAO3D;AAED,eAAe,aAAa,CAAA"}

package/jest-mongodb-config.ts

@@ -0,0 +1,10 @@
+export default {
+  mongodbMemoryServerOptions: {
+    binary: {
+      skipMD5: true
+    },
+    autoStart: false,
+    instance: {}
+  },
+  useSharedDBForAllJestWorkers: false
+}

package/jest.config.ts

@@ -0,0 +1,33 @@
+// For a detailed explanation regarding each configuration property, visit:
+// https://jestjs.io/docs/en/configuration.html
+import { recursive } from 'merge'
+import mongo from '@shelf/jest-mongodb/jest-preset'
+
+const config = recursive(mongo, {
+  roots: [
+    '<rootDir>/src/',
+    '<rootDir>/tests/'
+  ],
+  clearMocks: true,
+  collectCoverage: true,
+  collectCoverageFrom: [
+    'src/**/*.ts',
+    '!src/**/*.d.ts',
+    '!src/interfaces/**/*.ts'
+  ],
+  coverageDirectory: 'coverage',
+  testMatch: [
+    '<rootDir>/tests/**/*.test.ts'
+  ],
+  transform: {
+    '^.+\\.(t|j)sx?$': '@swc/jest'
+  },
+  testPathIgnorePatterns: [
+    'node_modules'
+  ],
+  watchPathIgnorePatterns: [
+    'globalConfig'
+  ]
+})
+
+export default config

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "ts-cache-mongoose",
+  "version": "0.0.1",
+  "description": "Cache plugin for mongoose",
+  "author": "Alex Eagle",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/ilovepixelart/ts-cache-mongoose.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ilovepixelart/ts-cache-mongoose/issues"
+  },
+  "homepage": "https://github.com/ilovepixelart/ts-cache-mongoose#readme",
+  "directories": {
+    "examples": "examples"
+  },
+  "keywords": [
+    "mongo",
+    "mongodb",
+    "mongoose",
+    "plugin",
+    "schema",
+    "db",
+    "nosql",
+    "ts",
+    "typescript",
+    "swc",
+    "cache",
+    "redis",
+    "store",
+    "memory",
+    "ttl",
+    "query"
+  ],
+  "engines": {
+    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+  },
+  "files": [
+    "dist",
+    "src",
+    "tests",
+    ".swcrc",
+    "tsconfig.json",
+    "jest.config.ts",
+    "jest-mongodb-config.ts",
+    ".eslintrc",
+    ".eslintignore"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/esm/types/plugin.d.ts",
+        "default": "./dist/esm/plugin.mjs"
+      },
+      "require": {
+        "types": "./dist/cjs/types/plugin.d.ts",
+        "default": "./dist/cjs/plugin.js"
+      }
+    }
+  },
+  "main": "dist/cjs/plugin.js",
+  "types": "dist/cjs/types/plugin.d.ts",
+  "scripts": {
+    "lint": "eslint . --ext .js,.ts",
+    "lint:fix": "eslint . --fix --ext .js,.ts",
+    "test": "jest --config jest.config.ts --detectOpenHandles --coverage",
+    "test:open": "npm run test && open-cli coverage/lcov-report/index.html",
+    "clean": "rm -rf ./dist",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm",
+    "build:cjs": "tsc -p config/tsconfig.cjs.json",
+    "build:esm": "tsc -p config/tsconfig.esm.json && mv ./dist/esm/plugin.js ./dist/esm/plugin.mjs",
+    "release": "npm install && npm run lint && npm run build && np"
+  },
+  "dependencies": {
+    "ioredis": "^5.3.2",
+    "lodash": "^4.17.21",
+    "ms": "^2.1.3"
+  },
+  "devDependencies": {
+    "@shelf/jest-mongodb": "4.1.7",
+    "@swc/cli": "0.1.62",
+    "@swc/core": "1.3.53",
+    "@swc/helpers": "0.5.0",
+    "@swc/jest": "0.2.26",
+    "@swc/register": "0.1.10",
+    "@types/jest": "29.5.1",
+    "@types/lodash": "4.14.194",
+    "@types/ms": "^0.7.31",
+    "@types/node": "18.16.0",
+    "@typescript-eslint/eslint-plugin": "5.59.0",
+    "@typescript-eslint/parser": "5.59.0",
+    "eslint": "8.39.0",
+    "eslint-config-standard": "17.0.0",
+    "eslint-plugin-import": "2.27.5",
+    "eslint-plugin-jest": "27.2.1",
+    "eslint-plugin-jest-formatting": "3.1.0",
+    "eslint-plugin-n": "15.7.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-promise": "6.1.1",
+    "eslint-plugin-sonarjs": "0.19.0",
+    "jest": "29.5.0",
+    "merge": "2.1.1",
+    "mongoose": "6.10.5",
+    "open-cli": "7.2.0",
+    "ts-node": "10.9.1",
+    "typescript": "5.0.4"
+  },
+  "peerDependencies": {
+    "mongoose": ">=6.6.0 < 8"
+  }
+}

package/src/cache/Cache.ts

@@ -0,0 +1,46 @@
+import ms from 'ms'
+
+import type ICacheEngine from '../interfaces/ICacheEngine'
+
+import MemoryCacheEngine from './engine/MemoryCacheEngine'
+import RedisCacheEngine from './engine/RedisCacheEngine'
+
+export const engines = ['memory', 'redis'] as const
+
+class Cache {
+  private engine: ICacheEngine
+  private defaultTTL: number
+
+  constructor (engineName: 'memory' | 'redis', defaultTTL: string) {
+    if (!engines.includes(engineName)) {
+      throw new Error(`Invalid engine name: ${engineName}`)
+    }
+
+    this.defaultTTL = ms(defaultTTL)
+
+    if (engineName === 'redis') {
+      this.engine = new RedisCacheEngine()
+    } else {
+      this.engine = new MemoryCacheEngine()
+    }
+  }
+
+  async get (key: string): Promise<Record<string, unknown> | Record<string, unknown>[] | undefined> {
+    return await this.engine.get(key)
+  }
+
+  async set (key: string, value: Record<string, unknown> | Record<string, unknown>[], ttl?: number): Promise<void> {
+    const actualTTL = ttl ?? this.defaultTTL
+    return await this.engine.set(key, value, actualTTL)
+  }
+
+  async del (key: string): Promise<void> {
+    return await this.engine.del(key)
+  }
+
+  async clear (): Promise<void> {
+    return await this.engine.clear()
+  }
+}
+
+export default Cache

package/src/cache/engine/MemoryCacheEngine.ts

@@ -0,0 +1,32 @@
+import type ICacheEngine from '../../interfaces/ICacheEngine'
+
+class MemoryCacheEngine implements ICacheEngine {
+  private cache: Record<string, { value: Record<string, unknown> | Record<string, unknown>[], expiresAt: number } | undefined>
+
+  constructor () {
+    this.cache = {}
+  }
+
+  get (key: string): Record<string, unknown> | Record<string, unknown>[] | undefined {
+    const item = this.cache[key]
+    if (!item || item.expiresAt < Date.now()) {
+      return undefined
+    }
+    return item.value
+  }
+
+  set (key: string, value: Record<string, unknown> | Record<string, unknown>[], ttl = Infinity): void {
+    this.cache[key] = { value, expiresAt: Date.now() + ttl }
+  }
+
+  del (key: string): void {
+    // eslint-disable-next-line @typescript-eslint/no-dynamic-delete
+    delete this.cache[key]
+  }
+
+  clear (): void {
+    this.cache = {}
+  }
+}
+
+export default MemoryCacheEngine

package/src/cache/engine/RedisCacheEngine.ts

@@ -0,0 +1,36 @@
+import IORedis from 'ioredis'
+
+import type { Redis } from 'ioredis'
+
+import type ICacheEngine from '../../interfaces/ICacheEngine'
+
+class RedisCacheEngine implements ICacheEngine {
+  private client: Redis
+
+  constructor () {
+    this.client = new IORedis()
+  }
+
+  async get (key: string): Promise<Record<string, unknown> | Record<string, unknown>[] | undefined> {
+    const value = await this.client.get(key)
+    if (value === null) {
+      return undefined
+    }
+    return JSON.parse(value) as Promise<Record<string, unknown> | Record<string, unknown>[]>
+  }
+
+  async set (key: string, value: unknown, ttl = Infinity): Promise<void> {
+    const serializedValue = JSON.stringify(value)
+    await this.client.setex(key, Math.ceil(ttl / 1000), serializedValue)
+  }
+
+  async del (key: string): Promise<void> {
+    await this.client.del(key)
+  }
+
+  async clear (): Promise<void> {
+    await this.client.flushdb()
+  }
+}
+
+export default RedisCacheEngine

package/src/crypto.ts

@@ -0,0 +1,27 @@
+import _ from 'lodash'
+import { createHash } from 'crypto'
+
+export function sortDeep (data: Record<string, unknown>[] | Record<string, unknown>): unknown {
+  if (_.isObjectLike(data) && _.isArray(data)) {
+    return data.map(sortDeep)
+  }
+
+  if (_.isObjectLike(data) && !_.isArray(data)) {
+    const sortedKeys = _.keys(data).sort((a, b) => a.localeCompare(b))
+    const sortedObj: Record<string, unknown> = {}
+
+    sortedKeys.forEach((key) => {
+      sortedObj[key] = sortDeep(data[key] as Record<string, unknown>[] | Record<string, unknown>)
+    })
+
+    return sortedObj
+  }
+
+  return data
+}
+
+export function getKey (data: Record<string, unknown>[] | Record<string, unknown>): string {
+  const sortedObj = sortDeep(data)
+  const sortedStr = JSON.stringify(sortedObj)
+  return createHash('sha256').update(sortedStr).digest('hex')
+}

package/src/interfaces/ICacheEngine.ts

@@ -0,0 +1,8 @@
+interface ICacheEngine {
+  get: (key: string) => Promise<Record<string, unknown> | Record<string, unknown>[] | undefined> | Record<string, unknown> | Record<string, unknown>[] | undefined
+  set: (key: string, value: Record<string, unknown> | Record<string, unknown>[], ttl?: number) => Promise<void> | void
+  del: (key: string) => Promise<void> | void
+  clear: () => Promise<void> | void
+}
+
+export default ICacheEngine

package/src/interfaces/ICacheMongooseOptions.ts

@@ -0,0 +1,10 @@
+interface ICacheMongooseOptions {
+  engine: 'memory' | 'redis'
+  defaultTTL?: string
+  port?: number
+  host?: string
+  password?: string,
+  client?: unknown,
+}
+
+export default ICacheMongooseOptions