@xfe-repo/bff-cache 1.0.0

package/dist/cache.manager.service.js

@@ -0,0 +1,298 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/cache.manager.service.ts
+var cache_manager_service_exports = {};
+__export(cache_manager_service_exports, {
+  CacheManagerService: () => CacheManagerService
+});
+module.exports = __toCommonJS(cache_manager_service_exports);
+var import_bff_utils = require("@xfe-repo/bff-utils");
+var import_common2 = require("@nestjs/common");
+var import_microservices2 = require("@nestjs/microservices");
+var import_cacheable = require("cacheable");
+
+// src/cache.constants.ts
+var CACHE_MANAGER = "CACHE_MANAGER";
+var MEMORY_CACHE_SERVICE = "MEMORY_CACHE_SERVICE";
+var REDIS_CLIENT_SERVICE = "REDIS_CLIENT_SERVICE";
+var REDIS_PUB = {
+  /** Redis 发布订阅频道 */
+  CHANNEL: "CACHE_CHANNEL",
+  /** Redis 发布订阅事件 */
+  EVENTS: {
+    SET: "SET",
+    MSET: "MSET",
+    DEL: "DEL",
+    MDEL: "MDEL",
+    CLEAR: "CLEAR"
+  }
+};
+var CachePrefix = /* @__PURE__ */ function(CachePrefix2) {
+  CachePrefix2["User"] = "User";
+  CachePrefix2["QRCode"] = "QRCode";
+  CachePrefix2["Router"] = "Router";
+  CachePrefix2["Service"] = "Service";
+  CachePrefix2["UnionQuery"] = "UnionQuery";
+  return CachePrefix2;
+}({});
+
+// src/cache.memory.service.ts
+var import_common = require("@nestjs/common");
+var import_microservices = require("@nestjs/microservices");
+var import_keyv = require("keyv");
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+function _ts_metadata(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata, "_ts_metadata");
+function _ts_param(paramIndex, decorator) {
+  return function(target, key) {
+    decorator(target, key, paramIndex);
+  };
+}
+__name(_ts_param, "_ts_param");
+var _CacheMemoryService = class _CacheMemoryService extends import_keyv.Keyv {
+  constructor(keyvOptions) {
+    super(keyvOptions);
+    __publicField(this, "logger", new import_common.Logger(_CacheMemoryService.name));
+  }
+  setEventPattern(item) {
+    this.logger.log(`EventPattern set: ${item.key}`);
+    this.set(item.key, item.value, item.ttl);
+  }
+  msetEventPattern(list) {
+    this.logger.log(`EventPattern mset: ${list.map((item) => item.key).join(", ")}`);
+    this.setMany(list);
+  }
+  delEventPattern(key) {
+    this.logger.log(`EventPattern del: ${key}`);
+    return this.delete(key);
+  }
+  mdelEventPattern(keys) {
+    this.logger.log(`EventPattern mdel: ${keys.join(", ")}`);
+    return this.deleteMany(keys);
+  }
+  clearEventPattern() {
+    this.logger.log(`EventPattern clear`);
+    return this.clear();
+  }
+};
+__name(_CacheMemoryService, "CacheMemoryService");
+var CacheMemoryService = _CacheMemoryService;
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.SET),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof SetOptions === "undefined" ? Object : SetOptions
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "setEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.MSET),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof MSetOptions === "undefined" ? Object : MSetOptions
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "msetEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.DEL),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    String
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "delEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.MDEL),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    Array
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "mdelEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.CLEAR),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "clearEventPattern", null);
+CacheMemoryService = _ts_decorate([
+  (0, import_common.Injectable)(),
+  (0, import_common.Controller)(),
+  _ts_param(0, (0, import_common.Inject)(MEMORY_CACHE_SERVICE)),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof import_keyv.KeyvOptions === "undefined" ? Object : import_keyv.KeyvOptions
+  ])
+], CacheMemoryService);
+
+// src/cache.manager.service.ts
+function _ts_decorate2(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate2, "_ts_decorate");
+function _ts_metadata2(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata2, "_ts_metadata");
+function _ts_param2(paramIndex, decorator) {
+  return function(target, key) {
+    decorator(target, key, paramIndex);
+  };
+}
+__name(_ts_param2, "_ts_param");
+var _CacheManagerService = class _CacheManagerService {
+  constructor(redisPublisher, cacheRedis, cacheMemory) {
+    __publicField(this, "redisPublisher");
+    __publicField(this, "cacheRedis");
+    __publicField(this, "cacheMemory");
+    this.redisPublisher = redisPublisher;
+    this.cacheRedis = cacheRedis;
+    this.cacheMemory = cacheMemory;
+  }
+  getKey(prefix, key) {
+    return `${prefix}:${key}`;
+  }
+  getMKey(prefix, key) {
+    return key.map((_key) => this.getKey(prefix, _key));
+  }
+  async get(prefix, key) {
+    const keyWithPrefix = this.getKey(prefix, key);
+    const memoryResult = await this.cacheMemory.getRaw(keyWithPrefix);
+    if (memoryResult !== void 0) return memoryResult.value;
+    const redisResult = await this.cacheRedis.getRaw(keyWithPrefix);
+    if (redisResult !== void 0) {
+      this.redisPublisher.emit(REDIS_PUB.EVENTS.SET, {
+        key: this.getKey(prefix, key),
+        value: redisResult.value,
+        ttl: redisResult.expires
+      });
+    }
+    return redisResult?.value;
+  }
+  async mget(prefix, key) {
+    const keyWithPrefix = this.getMKey(prefix, key);
+    const memoryResult = await this.cacheMemory.getManyRaw(keyWithPrefix);
+    if (memoryResult.every((item) => item !== void 0)) {
+      return memoryResult.map((item) => item?.value);
+    }
+    const missingKeys = keyWithPrefix.filter((_, i) => memoryResult[i] === void 0);
+    const redisResult = await this.cacheRedis.getManyRaw(missingKeys);
+    const missingMemoryCaches = [];
+    for (const [i, key2] of keyWithPrefix.entries()) {
+      if (memoryResult[i] === void 0 && redisResult[i] !== void 0) {
+        memoryResult[i] = redisResult[i];
+        missingMemoryCaches.push({
+          key: key2,
+          value: redisResult[i].value,
+          ttl: redisResult[i].expires
+        });
+      }
+    }
+    if (missingMemoryCaches.length > 0) {
+      this.redisPublisher.emit(REDIS_PUB.EVENTS.MSET, missingMemoryCaches);
+    }
+    return memoryResult.map((item) => item?.value);
+  }
+  set(prefix, key, value, ttl) {
+    const keyWithPrefix = this.getKey(prefix, key);
+    this.redisPublisher.emit(REDIS_PUB.EVENTS.SET, {
+      key: keyWithPrefix,
+      value,
+      ttl
+    });
+    return this.cacheRedis.set(keyWithPrefix, value, ttl);
+  }
+  mset(prefix, list, ttl) {
+    const listItems = list.map((item) => ({
+      key: this.getKey(prefix, item.key),
+      value: item.value,
+      ttl
+    }));
+    this.redisPublisher.emit(REDIS_PUB.EVENTS.MSET, listItems);
+    return this.cacheRedis.setMany(listItems);
+  }
+  del(prefix, key) {
+    const keyWithPrefix = this.getKey(prefix, key);
+    this.redisPublisher.emit(REDIS_PUB.EVENTS.DEL, {
+      key: keyWithPrefix
+    });
+    return this.cacheRedis.delete(keyWithPrefix);
+  }
+  mdel(prefix, key) {
+    const keyWithPrefix = this.getMKey(prefix, key);
+    this.redisPublisher.emit(REDIS_PUB.EVENTS.MDEL, {
+      keys: keyWithPrefix
+    });
+    return this.cacheRedis.deleteMany(keyWithPrefix);
+  }
+  clear() {
+    this.redisPublisher.emit(REDIS_PUB.EVENTS.CLEAR, {});
+    return this.cacheRedis.clear();
+  }
+};
+__name(_CacheManagerService, "CacheManagerService");
+var CacheManagerService = _CacheManagerService;
+_ts_decorate2([
+  (0, import_bff_utils.timeIt)(),
+  _ts_metadata2("design:type", Function),
+  _ts_metadata2("design:paramtypes", [
+    typeof CachePrefix === "undefined" ? Object : CachePrefix,
+    String
+  ]),
+  _ts_metadata2("design:returntype", Promise)
+], CacheManagerService.prototype, "get", null);
+_ts_decorate2([
+  (0, import_bff_utils.timeIt)(),
+  _ts_metadata2("design:type", Function),
+  _ts_metadata2("design:paramtypes", [
+    typeof CachePrefix === "undefined" ? Object : CachePrefix,
+    Array
+  ]),
+  _ts_metadata2("design:returntype", Promise)
+], CacheManagerService.prototype, "mget", null);
+CacheManagerService = _ts_decorate2([
+  (0, import_common2.Injectable)(),
+  _ts_param2(0, (0, import_common2.Inject)(REDIS_CLIENT_SERVICE)),
+  _ts_param2(1, (0, import_common2.Inject)(CACHE_MANAGER)),
+  _ts_metadata2("design:type", Function),
+  _ts_metadata2("design:paramtypes", [
+    typeof import_microservices2.ClientProxy === "undefined" ? Object : import_microservices2.ClientProxy,
+    typeof import_cacheable.Cacheable === "undefined" ? Object : import_cacheable.Cacheable,
+    typeof CacheMemoryService === "undefined" ? Object : CacheMemoryService
+  ])
+], CacheManagerService);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CacheManagerService
+});

package/dist/cache.manager.service.mjs

@@ -0,0 +1,8 @@
+import {
+  CacheManagerService
+} from "./chunk-DNWAJ23C.mjs";
+import "./chunk-JZT4EYON.mjs";
+import "./chunk-FNYHTBRP.mjs";
+export {
+  CacheManagerService
+};

package/dist/cache.memory.service.d.mts

@@ -0,0 +1,20 @@
+import { Keyv, KeyvOptions } from 'keyv';
+
+type Milliseconds = number;
+type SetOptions<T> = {
+    key: string;
+    value: T;
+    ttl?: Milliseconds;
+};
+type MSetOptions<T> = SetOptions<T>[];
+declare class CacheMemoryService extends Keyv {
+    private readonly logger;
+    constructor(keyvOptions: KeyvOptions);
+    protected setEventPattern<T>(item: SetOptions<T>): void;
+    protected msetEventPattern<T>(list: MSetOptions<T>): void;
+    protected delEventPattern(key: string): Promise<boolean>;
+    protected mdelEventPattern(keys: string[]): Promise<boolean>;
+    protected clearEventPattern(): Promise<void>;
+}
+
+export { CacheMemoryService, type MSetOptions };

package/dist/cache.memory.service.d.ts

@@ -0,0 +1,20 @@
+import { Keyv, KeyvOptions } from 'keyv';
+
+type Milliseconds = number;
+type SetOptions<T> = {
+    key: string;
+    value: T;
+    ttl?: Milliseconds;
+};
+type MSetOptions<T> = SetOptions<T>[];
+declare class CacheMemoryService extends Keyv {
+    private readonly logger;
+    constructor(keyvOptions: KeyvOptions);
+    protected setEventPattern<T>(item: SetOptions<T>): void;
+    protected msetEventPattern<T>(list: MSetOptions<T>): void;
+    protected delEventPattern(key: string): Promise<boolean>;
+    protected mdelEventPattern(keys: string[]): Promise<boolean>;
+    protected clearEventPattern(): Promise<void>;
+}
+
+export { CacheMemoryService, type MSetOptions };

package/dist/cache.memory.service.js

@@ -0,0 +1,144 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "symbol" ? key + "" : key, value);
+
+// src/cache.memory.service.ts
+var cache_memory_service_exports = {};
+__export(cache_memory_service_exports, {
+  CacheMemoryService: () => CacheMemoryService
+});
+module.exports = __toCommonJS(cache_memory_service_exports);
+var import_common = require("@nestjs/common");
+var import_microservices = require("@nestjs/microservices");
+var import_keyv = require("keyv");
+
+// src/cache.constants.ts
+var MEMORY_CACHE_SERVICE = "MEMORY_CACHE_SERVICE";
+var REDIS_PUB = {
+  /** Redis 发布订阅频道 */
+  CHANNEL: "CACHE_CHANNEL",
+  /** Redis 发布订阅事件 */
+  EVENTS: {
+    SET: "SET",
+    MSET: "MSET",
+    DEL: "DEL",
+    MDEL: "MDEL",
+    CLEAR: "CLEAR"
+  }
+};
+
+// src/cache.memory.service.ts
+function _ts_decorate(decorators, target, key, desc) {
+  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+  if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+  else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+__name(_ts_decorate, "_ts_decorate");
+function _ts_metadata(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata, "_ts_metadata");
+function _ts_param(paramIndex, decorator) {
+  return function(target, key) {
+    decorator(target, key, paramIndex);
+  };
+}
+__name(_ts_param, "_ts_param");
+var _CacheMemoryService = class _CacheMemoryService extends import_keyv.Keyv {
+  constructor(keyvOptions) {
+    super(keyvOptions);
+    __publicField(this, "logger", new import_common.Logger(_CacheMemoryService.name));
+  }
+  setEventPattern(item) {
+    this.logger.log(`EventPattern set: ${item.key}`);
+    this.set(item.key, item.value, item.ttl);
+  }
+  msetEventPattern(list) {
+    this.logger.log(`EventPattern mset: ${list.map((item) => item.key).join(", ")}`);
+    this.setMany(list);
+  }
+  delEventPattern(key) {
+    this.logger.log(`EventPattern del: ${key}`);
+    return this.delete(key);
+  }
+  mdelEventPattern(keys) {
+    this.logger.log(`EventPattern mdel: ${keys.join(", ")}`);
+    return this.deleteMany(keys);
+  }
+  clearEventPattern() {
+    this.logger.log(`EventPattern clear`);
+    return this.clear();
+  }
+};
+__name(_CacheMemoryService, "CacheMemoryService");
+var CacheMemoryService = _CacheMemoryService;
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.SET),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof SetOptions === "undefined" ? Object : SetOptions
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "setEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.MSET),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof MSetOptions === "undefined" ? Object : MSetOptions
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "msetEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.DEL),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    String
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "delEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.MDEL),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    Array
+  ]),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "mdelEventPattern", null);
+_ts_decorate([
+  (0, import_microservices.EventPattern)(REDIS_PUB.EVENTS.CLEAR),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", []),
+  _ts_metadata("design:returntype", void 0)
+], CacheMemoryService.prototype, "clearEventPattern", null);
+CacheMemoryService = _ts_decorate([
+  (0, import_common.Injectable)(),
+  (0, import_common.Controller)(),
+  _ts_param(0, (0, import_common.Inject)(MEMORY_CACHE_SERVICE)),
+  _ts_metadata("design:type", Function),
+  _ts_metadata("design:paramtypes", [
+    typeof import_keyv.KeyvOptions === "undefined" ? Object : import_keyv.KeyvOptions
+  ])
+], CacheMemoryService);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CacheMemoryService
+});

package/dist/cache.memory.service.mjs

@@ -0,0 +1,7 @@
+import {
+  CacheMemoryService
+} from "./chunk-JZT4EYON.mjs";
+import "./chunk-FNYHTBRP.mjs";
+export {
+  CacheMemoryService
+};

package/dist/cache.module.d.mts

@@ -0,0 +1,15 @@
+import { EnvConfigService } from '@xfe-repo/bff-utils';
+import { Type, OnModuleInit, DynamicModule } from '@nestjs/common';
+
+interface CacheModuleOptions {
+    global?: boolean;
+    ttl?: number;
+    RedisEnvConfig: Type<EnvConfigService>;
+}
+declare class CacheModule implements OnModuleInit {
+    static redisEnvConfigFromForRoot: EnvConfigService;
+    static forRoot(options: CacheModuleOptions): DynamicModule;
+    onModuleInit(): Promise<void>;
+}
+
+export { CacheModule, type CacheModuleOptions };

package/dist/cache.module.d.ts

@@ -0,0 +1,15 @@
+import { EnvConfigService } from '@xfe-repo/bff-utils';
+import { Type, OnModuleInit, DynamicModule } from '@nestjs/common';
+
+interface CacheModuleOptions {
+    global?: boolean;
+    ttl?: number;
+    RedisEnvConfig: Type<EnvConfigService>;
+}
+declare class CacheModule implements OnModuleInit {
+    static redisEnvConfigFromForRoot: EnvConfigService;
+    static forRoot(options: CacheModuleOptions): DynamicModule;
+    onModuleInit(): Promise<void>;
+}
+
+export { CacheModule, type CacheModuleOptions };