@tc-libs/app-cache 3.5.0 → 3.6.1

package/README.md

@@ -1,11 +1,91 @@
-# 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).
+# @tc-libs/app-cache
+
+Astrazione cache per NestJS basata su `@nestjs/cache-manager`. Supporta due modalita:
+
+- cache in-memory quando `enabled` e `false`
+- cache Redis quando `enabled` e `true`
+
+Il package viene usato soprattutto dai repository Mongo del monorepo per cacheare query e count.
+
+## Registrazione
+
+```ts
+AppCacheModule.register(
+  true,
+  {
+    enabled: true,
+    ttl: 60,
+    server: {
+      host: '127.0.0.1',
+      port: 6379,
+    },
+  },
+  true,
+);
+```
+
+Versione async:
+
+```ts
+AppCacheModule.registerAsync(
+  true,
+  {
+    imports: [ConfigModule],
+    inject: [ConfigService],
+    useFactory: async (config: ConfigService) => ({
+      enabled: true,
+      ttl: 60,
+      server: {
+        host: config.getOrThrow<string>('REDIS_HOST'),
+        port: config.getOrThrow<number>('REDIS_PORT'),
+      },
+    }),
+  },
+  true,
+);
+```
+
+## Servizio esportato
+
+`AppCacheService` espone i metodi usati dal resto del monorepo:
+
+- `getCachedDataByQuery(functionName, find, options)`
+- `getCachedDataByKey(key)`
+- `saveToCache(key, data, options)`
+
+Lato repository il pattern tipico e:
+
+```ts
+const { data, key } = await this.cache.getCachedDataByQuery(
+  'findOne',
+  find,
+  options,
+);
+
+if (data) return data;
+
+this.cache.saveToCache(key, result, options);
+```
+
+## Note operative
+
+- La chiave cache viene derivata da `functionName`, filtro e opzioni tramite hash SHA1 Base64.
+- La cache viene usata solo se il modulo e abilitato e l'operazione passa `options.caching.enabled`.
+- Se vuoi una chiave custom puoi passare `options.caching.key`.
+
+## Export pubblici
+
+```ts
+import {
+  AppCacheModule,
+  AppCacheService,
+  ICachingOptions,
+} from '@tc-libs/app-cache';
+```
+
+## Sviluppo
+
+```bash
+nx build app-cache
+nx test app-cache
+```

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@tc-libs/app-cache",
-  "version": "3.5.0",
+  "version": "3.6.1",
   "dependencies": {
-    "@tc-libs/helper": "3.5.0",
+    "@tc-libs/helper": "3.6.1",
     "@nestjs/common": "^11.0.12",
     "@nestjs/cache-manager": "^3.0.1",
     "cache-manager-redis-store": "^3.0.1",