@lark-apaas/cache-service 0.1.1-alpha.0

package/dist/nestjs/index.d.ts

@@ -0,0 +1,56 @@
+import { OnApplicationShutdown, DynamicModule, ModuleMetadata, InjectionToken } from '@nestjs/common';
+import { a as CacheStoreHandle } from '../types-CFj87Od0.js';
+import 'keyv';
+
+/**
+ * 用户传入的运行时配置
+ */
+interface NestjsCacheModuleOptions {
+    /**
+     * Redis 连接串（redis:// 或 rediss://）
+     */
+    connectionString: string;
+    /**
+     * ZTI Token 文件路径。存在则启动 watchFile 热刷新。
+     */
+    connectionTokenFilePath?: string;
+    /**
+     * Socket connect timeout（毫秒）。默认 10_000。
+     */
+    connectTimeoutMs?: number;
+    /**
+     * Socket idle timeout（毫秒）。默认 5_000。
+     */
+    socketTimeoutMs?: number;
+}
+/**
+ * 异步配置选项
+ */
+interface NestjsCacheModuleAsyncOptions {
+    imports?: ModuleMetadata['imports'];
+    useFactory: (...args: unknown[]) => Promise<NestjsCacheModuleOptions> | NestjsCacheModuleOptions;
+    inject?: InjectionToken[];
+}
+declare class NestjsCacheModule implements OnApplicationShutdown {
+    private readonly storeHandle;
+    constructor(storeHandle: CacheStoreHandle);
+    onApplicationShutdown(): Promise<void>;
+    /**
+     * 同步注册
+     */
+    static forRoot(options: NestjsCacheModuleOptions): DynamicModule;
+    /**
+     * 异步注册（从 ConfigService 等异步源读配置）
+     */
+    static forRootAsync(options: NestjsCacheModuleAsyncOptions): DynamicModule;
+}
+
+/**
+ * @lark-apaas/cache-service - NestJS 层 DI tokens
+ */
+declare const NESTJS_CACHE_OPTIONS: unique symbol;
+declare const CACHE_STORE_HANDLE: unique symbol;
+declare const CACHE_OBSERVABLE_ADAPTER: unique symbol;
+declare const CACHE_LOGGER_ADAPTER: unique symbol;
+
+export { CACHE_LOGGER_ADAPTER, CACHE_OBSERVABLE_ADAPTER, CACHE_STORE_HANDLE, NESTJS_CACHE_OPTIONS, NestjsCacheModule, type NestjsCacheModuleAsyncOptions, type NestjsCacheModuleOptions };

package/dist/nestjs/index.js

@@ -0,0 +1,16 @@
+import {
+  CACHE_LOGGER_ADAPTER,
+  CACHE_OBSERVABLE_ADAPTER,
+  CACHE_STORE_HANDLE,
+  NESTJS_CACHE_OPTIONS,
+  NestjsCacheModule
+} from "../chunk-SSW7W3K6.js";
+import "../chunk-BSJRPCEN.js";
+export {
+  CACHE_LOGGER_ADAPTER,
+  CACHE_OBSERVABLE_ADAPTER,
+  CACHE_STORE_HANDLE,
+  NESTJS_CACHE_OPTIONS,
+  NestjsCacheModule
+};
+//# sourceMappingURL=index.js.map

package/dist/nestjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/types-CFj87Od0.d.cts

@@ -0,0 +1,38 @@
+import Keyv from 'keyv';
+
+/**
+ * Cache Store 构造选项
+ */
+interface CacheStoreOptions {
+    connectionString: string;
+    connectionTokenFilePath?: string;
+    connectTimeoutMs?: number;
+    socketTimeoutMs?: number;
+    observable: ObservableAdapter;
+    logger?: LoggerAdapter;
+}
+/**
+ * 框架无关的 Observable 契约
+ * NestJS 层用 @lark-apaas/nestjs-common 的 ObservableService 适配到这里
+ */
+interface ObservableAdapter {
+    log(level: 'debug' | 'info' | 'warn' | 'error', event: string, attrs: Record<string, unknown>): void;
+}
+/**
+ * 框架无关的 Logger 契约
+ */
+interface LoggerAdapter {
+    warn(message: string, attrs?: Record<string, unknown>): void;
+    error(message: string, err?: unknown): void;
+}
+/**
+ * Cache Store 句柄，允许外层控制生命周期
+ */
+interface CacheStoreHandle {
+    keyv: Keyv;
+    dispose(): Promise<void>;
+}
+type CacheTraceEvent = 'cache.read' | 'cache.write' | 'cache.delete' | 'cache.error';
+type CacheReadResult = 'hit' | 'miss';
+
+export type { CacheStoreOptions as C, LoggerAdapter as L, ObservableAdapter as O, CacheStoreHandle as a, CacheReadResult as b, CacheTraceEvent as c };

package/dist/types-CFj87Od0.d.ts

@@ -0,0 +1,38 @@
+import Keyv from 'keyv';
+
+/**
+ * Cache Store 构造选项
+ */
+interface CacheStoreOptions {
+    connectionString: string;
+    connectionTokenFilePath?: string;
+    connectTimeoutMs?: number;
+    socketTimeoutMs?: number;
+    observable: ObservableAdapter;
+    logger?: LoggerAdapter;
+}
+/**
+ * 框架无关的 Observable 契约
+ * NestJS 层用 @lark-apaas/nestjs-common 的 ObservableService 适配到这里
+ */
+interface ObservableAdapter {
+    log(level: 'debug' | 'info' | 'warn' | 'error', event: string, attrs: Record<string, unknown>): void;
+}
+/**
+ * 框架无关的 Logger 契约
+ */
+interface LoggerAdapter {
+    warn(message: string, attrs?: Record<string, unknown>): void;
+    error(message: string, err?: unknown): void;
+}
+/**
+ * Cache Store 句柄，允许外层控制生命周期
+ */
+interface CacheStoreHandle {
+    keyv: Keyv;
+    dispose(): Promise<void>;
+}
+type CacheTraceEvent = 'cache.read' | 'cache.write' | 'cache.delete' | 'cache.error';
+type CacheReadResult = 'hit' | 'miss';
+
+export type { CacheStoreOptions as C, LoggerAdapter as L, ObservableAdapter as O, CacheStoreHandle as a, CacheReadResult as b, CacheTraceEvent as c };

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@lark-apaas/cache-service",
+  "version": "0.1.1-alpha.0",
+  "description": "FullStack cache SDK, NestJS today, Express-ready tomorrow",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "keywords": [
+    "plugin",
+    "nestjs",
+    "server",
+    "cache",
+    "typescript"
+  ],
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs"
+    },
+    "./nestjs": {
+      "import": "./dist/nestjs/index.js",
+      "types": "./dist/nestjs/index.d.ts",
+      "require": "./dist/nestjs/index.cjs"
+    },
+    "./core": {
+      "import": "./dist/core/index.js",
+      "types": "./dist/core/index.d.ts",
+      "require": "./dist/core/index.cjs"
+    }
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist",
+    "lint": "eslint src/**/*.ts",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@keyv/redis": "^5.1.6",
+    "@nestjs/cache-manager": "^3.1.3",
+    "cache-manager": "^6.4.3",
+    "keyv": "^5.6.0",
+    "reflect-metadata": "^0.1.13"
+  },
+  "devDependencies": {
+    "@lark-apaas/nestjs-common": "^0.1.9",
+    "@lark-apaas/nestjs-logger": "workspace:*",
+    "@lark-apaas/nestjs-observable": "^0.0.12",
+    "@nestjs/testing": "^10.0.0",
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.0.0",
+    "@typescript-eslint/parser": "^6.0.0",
+    "eslint": "^8.42.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^3.2.4"
+  },
+  "peerDependencies": {
+    "@lark-apaas/nestjs-common": "^0.1.9",
+    "@lark-apaas/nestjs-logger": "*",
+    "@lark-apaas/nestjs-observable": "^0.0.12",
+    "@nestjs/common": "^10.0.0",
+    "@nestjs/core": "^10.0.0"
+  }
+}