@xfe-repo/bff-cache 1.0.0

package/README.md

@@ -0,0 +1,3 @@
+# `@xfe-repo/bff-cache`
+
+bff cache 缓存库

package/dist/cache-router.decorator.d.mts

@@ -0,0 +1,3 @@
+declare function CacheRouter(ttl?: number, cacheWhen?: boolean): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+
+export { CacheRouter };

package/dist/cache-router.decorator.d.ts

@@ -0,0 +1,3 @@
+declare function CacheRouter(ttl?: number, cacheWhen?: boolean): <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;
+
+export { CacheRouter };

package/dist/cache-router.decorator.js

@@ -0,0 +1,45 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+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);
+
+// src/cache-router.decorator.ts
+var cache_router_decorator_exports = {};
+__export(cache_router_decorator_exports, {
+  CacheRouter: () => CacheRouter
+});
+module.exports = __toCommonJS(cache_router_decorator_exports);
+var import_common = require("@nestjs/common");
+
+// src/cache.constants.ts
+var CACHE_WHEN = "CACHE_WHEN";
+var CACHE_TTL = "CACHE_TTL";
+
+// src/cache-router.decorator.ts
+function CacheRouter(ttl = 60 * 1e3, cacheWhen = true) {
+  return (0, import_common.applyDecorators)(
+    // 是否缓存
+    (0, import_common.SetMetadata)(CACHE_WHEN, cacheWhen),
+    (0, import_common.SetMetadata)(CACHE_TTL, ttl)
+  );
+}
+__name(CacheRouter, "CacheRouter");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CacheRouter
+});

package/dist/cache-router.decorator.mjs

@@ -0,0 +1,7 @@
+import {
+  CacheRouter
+} from "./chunk-4UPXDJBM.mjs";
+import "./chunk-FNYHTBRP.mjs";
+export {
+  CacheRouter
+};

package/dist/cache-router.interceptor.d.mts

@@ -0,0 +1,23 @@
+import { NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { CacheManagerService } from './cache.manager.service.mjs';
+import '@nestjs/microservices';
+import 'cacheable';
+import './cache.constants.mjs';
+import './cache.memory.service.mjs';
+import 'keyv';
+
+declare class Response<T> {
+    code: number;
+    data: T;
+}
+declare class CacheRouterInterceptor<T> implements NestInterceptor<T, Response<T>> {
+    private readonly reflector;
+    private cacheManagerService;
+    private readonly logger;
+    constructor(reflector: Reflector, cacheManagerService: CacheManagerService);
+    intercept(context: ExecutionContext, next: CallHandler): Promise<any>;
+    private renderCacheKey;
+}
+
+export { CacheRouterInterceptor, Response };

package/dist/cache-router.interceptor.d.ts

@@ -0,0 +1,23 @@
+import { NestInterceptor, ExecutionContext, CallHandler } from '@nestjs/common';
+import { Reflector } from '@nestjs/core';
+import { CacheManagerService } from './cache.manager.service.js';
+import '@nestjs/microservices';
+import 'cacheable';
+import './cache.constants.js';
+import './cache.memory.service.js';
+import 'keyv';
+
+declare class Response<T> {
+    code: number;
+    data: T;
+}
+declare class CacheRouterInterceptor<T> implements NestInterceptor<T, Response<T>> {
+    private readonly reflector;
+    private cacheManagerService;
+    private readonly logger;
+    constructor(reflector: Reflector, cacheManagerService: CacheManagerService);
+    intercept(context: ExecutionContext, next: CallHandler): Promise<any>;
+    private renderCacheKey;
+}
+
+export { CacheRouterInterceptor, Response };

package/dist/cache-router.interceptor.js

@@ -0,0 +1,372 @@
+"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-router.interceptor.ts
+var cache_router_interceptor_exports = {};
+__export(cache_router_interceptor_exports, {
+  CacheRouterInterceptor: () => CacheRouterInterceptor,
+  Response: () => Response
+});
+module.exports = __toCommonJS(cache_router_interceptor_exports);
+var import_common3 = require("@nestjs/common");
+var import_core = require("@nestjs/core");
+var import_rxjs = require("rxjs");
+var import_operators = require("rxjs/operators");
+
+// src/cache.constants.ts
+var CACHE_MANAGER = "CACHE_MANAGER";
+var MEMORY_CACHE_SERVICE = "MEMORY_CACHE_SERVICE";
+var REDIS_CLIENT_SERVICE = "REDIS_CLIENT_SERVICE";
+var CACHE_WHEN = "CACHE_WHEN";
+var CACHE_TTL = "CACHE_TTL";
+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.manager.service.ts
+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.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);
+
+// src/cache-router.interceptor.ts
+function _ts_decorate3(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_decorate3, "_ts_decorate");
+function _ts_metadata3(k, v) {
+  if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+}
+__name(_ts_metadata3, "_ts_metadata");
+var _Response = class _Response {
+  constructor() {
+    __publicField(this, "code");
+    __publicField(this, "data");
+  }
+};
+__name(_Response, "Response");
+var Response = _Response;
+var _CacheRouterInterceptor = class _CacheRouterInterceptor {
+  constructor(reflector, cacheManagerService) {
+    __publicField(this, "reflector");
+    __publicField(this, "cacheManagerService");
+    __publicField(this, "logger", new import_common3.Logger(_CacheRouterInterceptor.name));
+    this.reflector = reflector;
+    this.cacheManagerService = cacheManagerService;
+  }
+  async intercept(context, next) {
+    const request = context.switchToHttp().getRequest();
+    const whenApiCache = this.reflector.get(CACHE_WHEN, context.getHandler()) || this.reflector.get(CACHE_WHEN, context.getClass());
+    if (whenApiCache) {
+      const ttl = this.reflector.get(CACHE_TTL, context.getHandler()) || this.reflector.get(CACHE_TTL, context.getClass());
+      const apiCacheKey = this.renderCacheKey(request.method, request.url);
+      const cachedItem = await this.cacheManagerService.get(CachePrefix.Router, apiCacheKey);
+      if (cachedItem) {
+        this.logger.log(`RouterCache hit for key: ${apiCacheKey}`);
+        return (0, import_rxjs.of)(cachedItem);
+      }
+      return next.handle().pipe((0, import_operators.map)((data) => {
+        this.cacheManagerService.set(CachePrefix.Router, apiCacheKey, data, ttl);
+        return data;
+      }));
+    }
+    return next.handle();
+  }
+  renderCacheKey(method, url) {
+    if (method !== "GET") {
+      throw new import_common3.BadRequestException(`RouterCache \u4E0D\u652F\u6301 ${method} \u65B9\u6CD5-${url}`);
+    }
+    return `${method}:${url}`;
+  }
+};
+__name(_CacheRouterInterceptor, "CacheRouterInterceptor");
+var CacheRouterInterceptor = _CacheRouterInterceptor;
+CacheRouterInterceptor = _ts_decorate3([
+  (0, import_common3.Injectable)(),
+  _ts_metadata3("design:type", Function),
+  _ts_metadata3("design:paramtypes", [
+    typeof import_core.Reflector === "undefined" ? Object : import_core.Reflector,
+    typeof CacheManagerService === "undefined" ? Object : CacheManagerService
+  ])
+], CacheRouterInterceptor);
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CacheRouterInterceptor,
+  Response
+});

package/dist/cache-router.interceptor.mjs

@@ -0,0 +1,11 @@
+import {
+  CacheRouterInterceptor,
+  Response
+} from "./chunk-P44QFEDZ.mjs";
+import "./chunk-DNWAJ23C.mjs";
+import "./chunk-JZT4EYON.mjs";
+import "./chunk-FNYHTBRP.mjs";
+export {
+  CacheRouterInterceptor,
+  Response
+};

package/dist/cache-service.decorator.d.mts

@@ -0,0 +1,7 @@
+interface CacheServiceOptions {
+    cacheKey?: string;
+    ttl?: number;
+}
+declare function CacheService(options?: CacheServiceOptions): MethodDecorator;
+
+export { CacheService };

package/dist/cache-service.decorator.d.ts

@@ -0,0 +1,7 @@
+interface CacheServiceOptions {
+    cacheKey?: string;
+    ttl?: number;
+}
+declare function CacheService(options?: CacheServiceOptions): MethodDecorator;
+
+export { CacheService };