@tc-libs/app-cache 0.9.0

package/README.md

@@ -0,0 +1,11 @@
+# app-cache
+
+This library was generated with [Nx](https://nx.dev).
+
+## Building
+
+Run `nx build app-cache` to build the library.
+
+## Running unit tests
+
+Run `nx test app-cache` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@tc-libs/app-cache",
+  "version": "0.9.0",
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "type": "commonjs",
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "types": "./src/index.d.ts"
+}

package/src/app-cache.module.d.ts

@@ -0,0 +1,6 @@
+import { DynamicModule } from '@nestjs/common';
+import AppCacheModuleAsyncOptions, { AppCacheModuleOptions } from './app-cache.module.options';
+export declare class AppCacheModule {
+    static register(enabled: boolean, options: AppCacheModuleOptions, isGlobal?: boolean): DynamicModule;
+    static registerAsync(enabled: boolean, options: AppCacheModuleAsyncOptions, isGlobal?: boolean): DynamicModule;
+}

package/src/app-cache.module.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppCacheModule = void 0;
+const tslib_1 = require("tslib");
+const cache_manager_1 = require("@nestjs/cache-manager");
+const cache_manager_redis_store_1 = tslib_1.__importDefault(require("cache-manager-redis-store"));
+const app_cache_service_1 = require("./app-cache.service");
+const app_cache_module_options_1 = require("./app-cache.module.options");
+class AppCacheModule {
+    static register(enabled, options, isGlobal) {
+        const imports = [];
+        if (enabled) {
+            imports.push(cache_manager_1.CacheModule.register({
+                store: cache_manager_redis_store_1.default,
+                host: options.server.host,
+                port: options.server.port,
+                ttl: options.ttl,
+                isGlobal: true,
+            }));
+        }
+        else {
+            imports.push(cache_manager_1.CacheModule.register({
+                isGlobal: true,
+            }));
+        }
+        return {
+            module: AppCacheModule,
+            providers: [
+                { provide: app_cache_module_options_1.APP_CACHE_MODULE_OPTIONS, useValue: options },
+                app_cache_service_1.AppCacheService,
+            ],
+            exports: [app_cache_service_1.AppCacheService],
+            controllers: [],
+            imports,
+            global: isGlobal,
+        };
+    }
+    static registerAsync(enabled, options, isGlobal) {
+        const imports = [];
+        if (enabled) {
+            imports.push(cache_manager_1.CacheModule.registerAsync({
+                imports: options.imports,
+                useFactory: async (...args) => {
+                    const appCacheOptions = await options.useFactory(...args);
+                    return {
+                        store: cache_manager_redis_store_1.default,
+                        host: appCacheOptions.server.host,
+                        port: appCacheOptions.server.port,
+                        ttl: appCacheOptions.ttl,
+                        isGlobal: true,
+                    };
+                },
+            }));
+        }
+        else {
+            imports.push(cache_manager_1.CacheModule.register({
+                isGlobal: true,
+            }));
+        }
+        return {
+            module: AppCacheModule,
+            imports: [...(options.imports || []), ...imports],
+            providers: [
+                {
+                    provide: app_cache_module_options_1.APP_CACHE_MODULE_OPTIONS,
+                    useFactory: options.useFactory,
+                    inject: options.inject,
+                },
+                app_cache_service_1.AppCacheService,
+            ],
+            exports: [app_cache_service_1.AppCacheService],
+            global: isGlobal,
+        };
+    }
+}
+exports.AppCacheModule = AppCacheModule;
+//# sourceMappingURL=app-cache.module.js.map

package/src/app-cache.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-cache.module.js","sourceRoot":"","sources":["../../../../packages/app-cache/src/app-cache.module.ts"],"names":[],"mappings":";;;;AAAA,yDAAoD;AAEpD,kGAAmD;AACnD,2DAAsD;AACtD,yEAGoC;AAEpC,MAAa,cAAc;IACzB,MAAM,CAAC,QAAQ,CACb,OAAgB,EAChB,OAA8B,EAC9B,QAAkB;QAElB,MAAM,OAAO,GAKP,EAAE,CAAC;QAET,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CACV,2BAAW,CAAC,QAAQ,CAAC;gBACnB,KAAK,EAAE,mCAAU;gBACjB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;gBACzB,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI;gBACzB,GAAG,EAAE,OAAO,CAAC,GAAG;gBAChB,QAAQ,EAAE,IAAI;aACf,CAAC,CACH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CACV,2BAAW,CAAC,QAAQ,CAAC;gBACnB,QAAQ,EAAE,IAAI;aACf,CAAC,CACH,CAAC;QACJ,CAAC;QACD,OAAO;YACL,MAAM,EAAE,cAAc;YACtB,SAAS,EAAE;gBACT,EAAE,OAAO,EAAE,mDAAwB,EAAE,QAAQ,EAAE,OAAO,EAAE;gBACxD,mCAAe;aAChB;YACD,OAAO,EAAE,CAAC,mCAAe,CAAC;YAC1B,WAAW,EAAE,EAAE;YACf,OAAO;YACP,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,aAAa,CAClB,OAAgB,EAChB,OAAmC,EACnC,QAAkB;QAElB,MAAM,OAAO,GAKP,EAAE,CAAC;QAET,IAAI,OAAO,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CACV,2BAAW,CAAC,aAAa,CAAC;gBACxB,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,UAAU,EAAE,KAAK,EAAE,GAAG,IAAI,EAAE,EAAE;oBAC5B,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,CAAC;oBAC1D,OAAO;wBACL,KAAK,EAAE,mCAAU;wBACjB,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI;wBACjC,IAAI,EAAE,eAAe,CAAC,MAAM,CAAC,IAAI;wBACjC,GAAG,EAAE,eAAe,CAAC,GAAG;wBACxB,QAAQ,EAAE,IAAI;qBACf,CAAC;gBACJ,CAAC;aACF,CAAC,CACH,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO,CAAC,IAAI,CACV,2BAAW,CAAC,QAAQ,CAAC;gBACnB,QAAQ,EAAE,IAAI;aACf,CAAC,CACH,CAAC;QACJ,CAAC;QAED,OAAO;YACL,MAAM,EAAE,cAAc;YACtB,OAAO,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC;YACjD,SAAS,EAAE;gBACT;oBACE,OAAO,EAAE,mDAAwB;oBACjC,UAAU,EAAE,OAAO,CAAC,UAAU;oBAC9B,MAAM,EAAE,OAAO,CAAC,MAAM;iBACvB;gBACD,mCAAe;aAChB;YACD,OAAO,EAAE,CAAC,mCAAe,CAAC;YAC1B,MAAM,EAAE,QAAQ;SACjB,CAAC;IACJ,CAAC;CACF;AA9FD,wCA8FC"}

package/src/app-cache.module.options.d.ts

@@ -0,0 +1,13 @@
+import { ModuleMetadata } from '@nestjs/common';
+import { FactoryProvider } from '@nestjs/common/interfaces/modules/provider.interface';
+export declare const APP_CACHE_MODULE_OPTIONS = "APP_CACHE_MODULE_OPTIONS";
+export interface AppCacheModuleOptions {
+    ttl: number;
+    server: {
+        host: string;
+        port: number;
+    };
+    enabled: boolean;
+}
+type AppCacheModuleAsyncOptions = Pick<ModuleMetadata, 'imports'> & Pick<FactoryProvider<AppCacheModuleOptions>, 'useFactory' | 'inject'>;
+export default AppCacheModuleAsyncOptions;

package/src/app-cache.module.options.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.APP_CACHE_MODULE_OPTIONS = void 0;
+exports.APP_CACHE_MODULE_OPTIONS = 'APP_CACHE_MODULE_OPTIONS';
+//# sourceMappingURL=app-cache.module.options.js.map

package/src/app-cache.module.options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-cache.module.options.js","sourceRoot":"","sources":["../../../../packages/app-cache/src/app-cache.module.options.ts"],"names":[],"mappings":";;;AAGa,QAAA,wBAAwB,GAAG,0BAA0B,CAAC"}

package/src/app-cache.service.d.ts

@@ -0,0 +1,20 @@
+import { Logger } from '@nestjs/common';
+import { HashService } from '@tc-libs/helper';
+import { Cache } from 'cache-manager';
+import { AppCacheModuleOptions } from './app-cache.module.options';
+import { ICachingOptions } from './interfaces/app-cache.options.interface';
+export declare class AppCacheService {
+    private _options;
+    protected _hash: HashService;
+    protected _cache: Cache;
+    private _cacheTTL;
+    private _cacheEnabled;
+    protected readonly _logger: Logger;
+    constructor(_options: AppCacheModuleOptions, _hash: HashService, _cache: Cache);
+    private _createKeyByQuery;
+    getCachedDataByQuery<T>(functionName: string, find?: any, options?: any): Promise<T | null | undefined>;
+    getCachedDataByKey<T>(key: string): Promise<T | null | undefined>;
+    saveToCache(data: any, options?: {
+        caching?: ICachingOptions;
+    }): void;
+}

package/src/app-cache.service.js

@@ -0,0 +1,69 @@
+"use strict";
+var AppCacheService_1;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppCacheService = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const helper_1 = require("@tc-libs/helper");
+const cache_manager_1 = require("@nestjs/cache-manager");
+const app_cache_module_options_1 = require("./app-cache.module.options");
+let AppCacheService = AppCacheService_1 = class AppCacheService {
+    constructor(_options, _hash, _cache) {
+        this._options = _options;
+        this._hash = _hash;
+        this._cache = _cache;
+        this._logger = new common_1.Logger(AppCacheService_1.name);
+        this._cacheTTL = this._options.ttl;
+        this._cacheEnabled = this._options.enabled;
+    }
+    _createKeyByQuery(functionName, find, options) {
+        if (options.caching.key)
+            return;
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const { caching, returnPlain, session, ...opts } = options;
+        const keyObject = {
+            ...(find || {}),
+            ...opts,
+        };
+        options.caching.key = `${functionName}-${this._hash.sha1Base64(JSON.stringify(keyObject))}`;
+    }
+    async getCachedDataByQuery(functionName, find, options) {
+        if (!(this._cacheEnabled && options?.caching?.enabled))
+            return null;
+        this._createKeyByQuery(functionName, find, options);
+        const x = await this._cache.get(options.caching.key);
+        if (x)
+            this._logger.debug(`[CACHE] key [${options.caching.key}] HIT`);
+        else
+            this._logger.debug(`[CACHE] key [${options.caching.key}] MISS`);
+        return x;
+    }
+    async getCachedDataByKey(key) {
+        if (!this._cacheEnabled)
+            return null;
+        const x = await this._cache.get(key);
+        if (x)
+            this._logger.debug(`[CACHE] key [${key}] HIT`);
+        else
+            this._logger.debug(`[CACHE] key [${key}] MISS`);
+        return x;
+    }
+    saveToCache(data, options) {
+        if (!options)
+            return;
+        const { caching } = options;
+        if (!this._cacheEnabled || !caching?.enabled)
+            return;
+        const ttl = caching.ttl || this._cacheTTL;
+        this._logger.debug(`[CACHE] key [${caching.key}] SET with ttl [${ttl}]`);
+        this._cache.set(caching.key, data, { ttl });
+    }
+};
+exports.AppCacheService = AppCacheService;
+exports.AppCacheService = AppCacheService = AppCacheService_1 = tslib_1.__decorate([
+    (0, common_1.Injectable)(),
+    tslib_1.__param(0, (0, common_1.Inject)(app_cache_module_options_1.APP_CACHE_MODULE_OPTIONS)),
+    tslib_1.__param(2, (0, common_1.Inject)(cache_manager_1.CACHE_MANAGER)),
+    tslib_1.__metadata("design:paramtypes", [Object, helper_1.HashService, Object])
+], AppCacheService);
+//# sourceMappingURL=app-cache.service.js.map

package/src/app-cache.service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-cache.service.js","sourceRoot":"","sources":["../../../../packages/app-cache/src/app-cache.service.ts"],"names":[],"mappings":";;;;;AAAA,2CAA4D;AAC5D,4CAA8C;AAG9C,yDAAsD;AACtD,yEAGoC;AAG7B,IAAM,eAAe,uBAArB,MAAM,eAAe;IAK1B,YAEE,QAAuC,EAC7B,KAAkB,EAE5B,MAAuB;QAHf,aAAQ,GAAR,QAAQ,CAAuB;QAC7B,UAAK,GAAL,KAAK,CAAa;QAElB,WAAM,GAAN,MAAM,CAAO;QAPN,YAAO,GAAW,IAAI,eAAM,CAAC,iBAAe,CAAC,IAAI,CAAC,CAAC;QASpE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC;QACnC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;IAC7C,CAAC;IAEO,iBAAiB,CAAC,YAAoB,EAAE,IAAU,EAAE,OAAa;QACvE,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG;YAAE,OAAO;QAChC,6DAA6D;QAC7D,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;QAC3D,MAAM,SAAS,GAAG;YAChB,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YACf,GAAG,IAAI;SACR,CAAC;QACF,OAAO,CAAC,OAAO,CAAC,GAAG,GAAG,GAAG,YAAY,IAAI,IAAI,CAAC,KAAK,CAAC,UAAU,CAC5D,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAC1B,EAAE,CAAC;IACN,CAAC;IAED,KAAK,CAAC,oBAAoB,CACxB,YAAoB,EACpB,IAAU,EACV,OAAa;QAEb,IAAI,CAAC,CAAC,IAAI,CAAC,aAAa,IAAI,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC;YAAE,OAAO,IAAI,CAAC;QACpE,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QACpD,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAI,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACxD,IAAI,CAAC;YAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;;YACjE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,OAAO,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC,CAAC;QACrE,OAAO,CAAC,CAAC;IACX,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAI,GAAW;QACrC,IAAI,CAAC,IAAI,CAAC,aAAa;YAAE,OAAO,IAAI,CAAC;QACrC,MAAM,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAI,GAAG,CAAC,CAAC;QACxC,IAAI,CAAC;YAAE,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,GAAG,OAAO,CAAC,CAAC;;YACjD,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,GAAG,QAAQ,CAAC,CAAC;QACrD,OAAO,CAAC,CAAC;IACX,CAAC;IAED,WAAW,CAAC,IAAS,EAAE,OAAuC;QAC5D,IAAI,CAAC,OAAO;YAAE,OAAO;QACrB,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAC5B,IAAI,CAAC,IAAI,CAAC,aAAa,IAAI,CAAC,OAAO,EAAE,OAAO;YAAE,OAAO;QACrD,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC;QAC1C,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gBAAgB,OAAO,CAAC,GAAG,mBAAmB,GAAG,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC;IAC9C,CAAC;CACF,CAAA;AA1DY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,mBAAU,GAAE;IAOR,mBAAA,IAAA,eAAM,EAAC,mDAAwB,CAAC,CAAA;IAGhC,mBAAA,IAAA,eAAM,EAAC,6BAAa,CAAC,CAAA;qDADL,oBAAW;GARnB,eAAe,CA0D3B"}

package/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './app-cache.module';
+export * from './app-cache.service';
+export * from './interfaces/app-cache.options.interface';

package/src/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./app-cache.module"), exports);
+tslib_1.__exportStar(require("./app-cache.service"), exports);
+tslib_1.__exportStar(require("./interfaces/app-cache.options.interface"), exports);
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/app-cache/src/index.ts"],"names":[],"mappings":";;;AAAA,6DAAmC;AACnC,8DAAoC;AACpC,mFAAyD"}

package/src/interfaces/app-cache.options.interface.d.ts

@@ -0,0 +1,5 @@
+export interface ICachingOptions {
+    enabled: boolean;
+    key: string;
+    ttl?: number;
+}

package/src/interfaces/app-cache.options.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=app-cache.options.interface.js.map

package/src/interfaces/app-cache.options.interface.js.map

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