@zenweb/cache 4.7.1 → 5.0.0

package/dist/cache.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import { Redis, RedisValue } from 'ioredis';
-import { SetupOption, SetOption, GetOption, LockGetOption, SetResult, LockOption } from './types';
+import { SetupOption, SetOption, GetOption, LockGetOption, SetResult, LockOption } from './types.js';
 /**
  * 缓存结果
  */

package/dist/cache.js

@@ -1,20 +1,19 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cache = exports.CacheResult = void 0;
-const zlib_1 = require("zlib");
-const util_1 = require("util");
-const locker_1 = require("./locker");
-const utils_1 = require("./utils");
-const compress = (0, util_1.promisify)(zlib_1.gzip);
-const decompress = (0, util_1.promisify)(zlib_1.unzip);
+import { gzip, unzip } from 'node:zlib';
+import { promisify } from 'node:util';
+import { Locker } from './locker.js';
+import { debug, sleep } from './utils.js';
+const compress = promisify(gzip);
+const decompress = promisify(unzip);
 const GZ_HEADER = Buffer.from([0x1F, 0x8B, 0x08]);
-const _getDebug = utils_1.debug.extend('get');
-const _setDebug = utils_1.debug.extend('set');
-const _lockDebug = utils_1.debug.extend('lock');
+const _getDebug = debug.extend('get');
+const _setDebug = debug.extend('set');
+const _lockDebug = debug.extend('lock');
 /**
  * 缓存结果
  */
-class CacheResult {
+export class CacheResult {
+    compressed;
+    data;
     /**
      * @param compressed 是否为压缩数据
      * @param data 数据
@@ -24,11 +23,12 @@ class CacheResult {
         this.data = data;
     }
 }
-exports.CacheResult = CacheResult;
 /**
  * 对象缓存系统
  */
-class Cache {
+export class Cache {
+    redis;
+    option;
     constructor(redis, option) {
         this.redis = redis;
         this.option = option;
@@ -123,7 +123,7 @@ class Cache {
      */
     async singleRunner(key, run, _opt) {
         const opt = Object.assign({}, this.option.lockGet, _opt);
-        const locker = new locker_1.Locker(this.redis, key, opt.lockTimeout);
+        const locker = new Locker(this.redis, key, opt.lockTimeout);
         const retryTimeout = typeof opt.retryTimeout === 'number' ? opt.retryTimeout : 0;
         const retryDelay = (opt.retryDelay === undefined || opt.retryDelay < 0) ? 500 : opt.retryDelay;
         let retryTime = 0;
@@ -143,13 +143,17 @@ class Cache {
             }
             else {
                 retryTime += retryDelay;
-                await (0, utils_1.sleep)(retryDelay);
+                await sleep(retryDelay);
             }
         }
     }
 }
-exports.Cache = Cache;
 class LockGet {
+    cache;
+    key;
+    fetch;
+    opt;
+    locker;
     constructor(cache, key, fetch, opt) {
         this.cache = cache;
         this.key = key;
@@ -209,7 +213,7 @@ class LockGet {
         let retryTime = 0;
         while (true) {
             if (!this.locker) {
-                this.locker = new locker_1.Locker(this.cache.redis, `${this.key}.LOCK`, this.opt.lockTimeout);
+                this.locker = new Locker(this.cache.redis, `${this.key}.LOCK`, this.opt.lockTimeout);
             }
             else {
                 // 尝试从 redis 中获取
@@ -240,7 +244,7 @@ class LockGet {
                 }
                 else {
                     retryTime += retryDelay;
-                    await (0, utils_1.sleep)(retryDelay);
+                    await sleep(retryDelay);
                 }
             }
         }

package/dist/global.d.ts

@@ -1,8 +1,8 @@
 /**
  * 取得缓存实例
  */
-export declare function getCache(): import("./cache").Cache;
+export declare function $getCache(): import("./cache.js").Cache;
 /**
  * 快捷方法 - 缓存实例
  */
-export declare const $cache: import("./cache").Cache;
+export declare const $cache: import("./cache.js").Cache;

package/dist/global.js

@@ -1,16 +1,12 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.$cache = exports.getCache = void 0;
-const core_1 = require("@zenweb/core");
+import { callProxy, $getCore } from "@zenweb/core";
 /**
  * 取得缓存实例
  */
-function getCache() {
-    const ins = (0, core_1.getCore)();
+export function $getCache() {
+    const ins = $getCore();
     return ins.cache2;
 }
-exports.getCache = getCache;
 /**
  * 快捷方法 - 缓存实例
  */
-exports.$cache = (0, core_1.callProxy)(getCache);
+export const $cache = callProxy($getCache);

package/dist/index.d.ts

@@ -1,12 +1,12 @@
 import { SetupFunction } from '@zenweb/core';
-import { SetupOption } from './types';
-import { Cache } from './cache';
+import { SetupOption } from './types.js';
+import { Cache } from './cache.js';
 import { Redis } from 'ioredis';
-export { getCache, $cache } from './global';
-export * from './types';
-export * from './utils';
-export { Locker } from './locker';
-export { cached } from './middleware';
+export { $getCache, $cache } from './global.js';
+export * from './types.js';
+export * from './utils.js';
+export { Locker } from './locker.js';
+export { cached } from './middleware.js';
 export { Cache };
 /**
  * 安装模块

package/dist/index.js

@@ -1,50 +1,28 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cache = exports.cached = exports.Locker = exports.$cache = exports.getCache = void 0;
-const cache_1 = require("./cache");
-Object.defineProperty(exports, "Cache", { enumerable: true, get: function () { return cache_1.Cache; } });
-const ioredis_1 = require("ioredis");
-const options_1 = require("./options");
-var global_1 = require("./global");
-Object.defineProperty(exports, "getCache", { enumerable: true, get: function () { return global_1.getCache; } });
-Object.defineProperty(exports, "$cache", { enumerable: true, get: function () { return global_1.$cache; } });
-__exportStar(require("./types"), exports);
-__exportStar(require("./utils"), exports);
-var locker_1 = require("./locker");
-Object.defineProperty(exports, "Locker", { enumerable: true, get: function () { return locker_1.Locker; } });
-var middleware_1 = require("./middleware");
-Object.defineProperty(exports, "cached", { enumerable: true, get: function () { return middleware_1.cached; } });
+import { Cache } from './cache.js';
+import { Redis } from 'ioredis';
+import { defaultSetupOption } from './options.js';
+export { $getCache, $cache } from './global.js';
+export * from './types.js';
+export * from './utils.js';
+export { Locker } from './locker.js';
+export { cached } from './middleware.js';
+export { Cache };
 /**
  * 安装模块
  * @param option 配置
  */
-function setup(option) {
+export default function setup(option) {
     return async function cache(setup) {
         setup.assertModuleExists('result', 'need setup @zenweb/result');
-        const opt = Object.assign({}, options_1.defaultSetupOption, option);
+        const opt = Object.assign({}, defaultSetupOption, option);
         setup.debug('option: %o', opt);
-        const redis = opt.redis instanceof ioredis_1.Redis ? opt.redis : new ioredis_1.Redis(opt.redis);
+        const redis = opt.redis instanceof Redis ? opt.redis : new Redis(opt.redis);
         await redis.ping('check');
         setup.defineCoreProperty('redis2', { value: redis });
-        setup.defineCoreProperty('cache2', { value: new cache_1.Cache(redis, opt) });
+        setup.defineCoreProperty('cache2', { value: new Cache(redis, opt) });
         setup.destroy(async () => {
             setup.debug('quit redis...');
             await redis.quit();
         });
     };
 }
-exports.default = setup;

package/dist/locker.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Locker = void 0;
-const crypto_1 = require("crypto");
-const utils_1 = require("./utils");
+import { randomBytes, createHash } from 'node:crypto';
+import { runRedisScript } from './utils.js';
 const RELEASE_SCRIPT = `
 if redis.call("get", KEYS[1]) == ARGV[1] then
     return redis.call("del", KEYS[1])
@@ -10,11 +7,15 @@ else
     return 0
 end
 `;
-const RELEASE_SCRIPT_HASH = (0, crypto_1.createHash)('sha1').update(RELEASE_SCRIPT).digest('hex');
+const RELEASE_SCRIPT_HASH = createHash('sha1').update(RELEASE_SCRIPT).digest('hex');
 /**
  * 基于 Redis 的分布式锁
  */
-class Locker {
+export class Locker {
+    redis;
+    key;
+    timeout;
+    value = randomBytes(16).toString('hex');
     /**
      * @param redis Redis 实例
      * @param key 锁KEY
@@ -24,7 +25,6 @@ class Locker {
         this.redis = redis;
         this.key = key;
         this.timeout = timeout;
-        this.value = (0, crypto_1.randomBytes)(16).toString('hex');
     }
     /**
      * 取得锁
@@ -40,7 +40,7 @@ class Locker {
      * 释放锁
      */
     async release() {
-        return (await (0, utils_1.runRedisScript)(this.redis, RELEASE_SCRIPT_HASH, RELEASE_SCRIPT, [this.key], [this.value])) === 1;
+        return (await runRedisScript(this.redis, RELEASE_SCRIPT_HASH, RELEASE_SCRIPT, [this.key], [this.value])) === 1;
     }
     /**
      * 使用锁回调
@@ -59,4 +59,3 @@ class Locker {
         callback(false);
     }
 }
-exports.Locker = Locker;

package/dist/middleware.d.ts

@@ -1,5 +1,5 @@
 import { Context, Middleware } from "@zenweb/core";
-import { LockGetOption } from "./types";
+import { LockGetOption } from "./types.js";
 type CachedMiddlewareOption = Omit<LockGetOption, 'parse' | 'decompress'>;
 /**
  * 缓存中间件

package/dist/middleware.js

@@ -1,13 +1,10 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cached = void 0;
 /**
  * 缓存中间件
  * - 缓存 ctx.success() 结果
  * - fail() 时不缓存
  * @param key 不指定 `key` 则默认使用 `ctx.path`，`key: null` 不适用使用缓存
  */
-function cached(key, opt) {
+export function cached(key, opt) {
     return async function cachedMiddleware(ctx, next) {
         const _key = typeof key === 'string' ? key
             : typeof key === 'function' ? await key(ctx)
@@ -23,4 +20,3 @@ function cached(key, opt) {
         ctx.success(result);
     };
 }
-exports.cached = cached;

package/dist/options.d.ts

@@ -1,5 +1,5 @@
 import type { RedisOptions } from "ioredis";
-import type { LockGetOption, ObjectSerializer, SetOption, SetupOption } from "./types";
+import type { LockGetOption, ObjectSerializer, SetOption, SetupOption } from "./types.js";
 export declare const defaultRedisOption: RedisOptions;
 export declare const defaultSetOption: SetOption;
 export declare const defaultLockGetOption: LockGetOption;

package/dist/options.js

@@ -1,26 +1,23 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultSetupOption = exports.defaultSerializer = exports.defaultLockGetOption = exports.defaultSetOption = exports.defaultRedisOption = void 0;
-exports.defaultRedisOption = {
+export const defaultRedisOption = {
     host: process.env.REDIS_HOST || '127.0.0.1',
     port: parseInt(process.env.REDIS_PORT || '') || 6379,
     password: process.env.REDIS_PASSWORD || '',
     db: parseInt(process.env.REDIS_DB || '') || 0,
 };
-exports.defaultSetOption = {
+export const defaultSetOption = {
     ttl: 60,
     compressMinLength: 1024,
     compressStoreRatio: 0.95,
     compressLevel: 1,
 };
-exports.defaultLockGetOption = {
+export const defaultLockGetOption = {
     retryTimeout: 5000,
     retryDelay: 500,
     preRefresh: 0,
     refresh: false,
     localStore: undefined,
 };
-exports.defaultSerializer = {
+export const defaultSerializer = {
     serialize: (data) => {
         return Buffer.from(JSON.stringify(data));
     },
@@ -28,9 +25,9 @@ exports.defaultSerializer = {
         return JSON.parse(data.toString());
     },
 };
-exports.defaultSetupOption = {
-    redis: exports.defaultRedisOption,
-    set: exports.defaultSetOption,
-    lockGet: exports.defaultLockGetOption,
-    serializer: exports.defaultSerializer,
+export const defaultSetupOption = {
+    redis: defaultRedisOption,
+    set: defaultSetOption,
+    lockGet: defaultLockGetOption,
+    serializer: defaultSerializer,
 };

package/dist/types.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Redis, RedisOptions } from "ioredis";
 /**
  * 缓存选项

package/dist/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

package/dist/utils.js

@@ -1,20 +1,16 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cacheKey = exports.runRedisScript = exports.sleep = exports.debug = void 0;
-const core_1 = require("@zenweb/core");
-const crypto = require("crypto");
-exports.debug = (0, core_1.zenwebDebug)('cache');
+import { zenwebDebug } from '@zenweb/core';
+import * as crypto from 'node:crypto';
+export const debug = zenwebDebug('cache');
 /**
  * Promise 等待
  * @param ms 毫秒
  * @returns
  */
-function sleep(ms) {
+export function sleep(ms) {
     return new Promise((resolve) => {
         setTimeout(resolve, ms);
     });
 }
-exports.sleep = sleep;
 /**
  * 执行 Redis Lua 脚本
  * @param redis Redis 实例
@@ -24,14 +20,14 @@ exports.sleep = sleep;
  * @param values 输入值
  * @returns 执行结果
  */
-async function runRedisScript(redis, hash, script, keys, values = []) {
+export async function runRedisScript(redis, hash, script, keys, values = []) {
     try {
         const result = await redis.evalsha(hash, keys.length, ...keys, ...values);
         return result;
     }
     catch (err) {
         if (err instanceof Error && err.message.includes('NOSCRIPT')) {
-            (0, exports.debug)('runRedisScript: NOSCRIPT');
+            debug('runRedisScript: NOSCRIPT');
             // 缺少预设脚本，设置
             const result = await redis.eval(script, keys.length, ...keys, ...values);
             return result;
@@ -39,7 +35,6 @@ async function runRedisScript(redis, hash, script, keys, values = []) {
         throw err;
     }
 }
-exports.runRedisScript = runRedisScript;
 /**
  * 将一个嵌套对象转换为平面字符串结构
  */
@@ -69,7 +64,7 @@ function plainifyOrHash(obj) {
  * 生成一个参数缓存key
  * - 多个元素用 : 连接
  */
-function cacheKey(...key) {
+export function cacheKey(...key) {
     return key.map(i => {
         if (typeof i === 'string')
             return i;
@@ -82,4 +77,3 @@ function cacheKey(...key) {
         return plainifyOrHash(i);
     }).join(':');
 }
-exports.cacheKey = cacheKey;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenweb/cache",
-  "packageManager": "yarn@4.0.2",
-  "version": "4.7.1",
+  "type": "module",
+  "version": "5.0.0",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -9,11 +9,10 @@
     "dist"
   ],
   "scripts": {
-    "vscode": "yarn dlx @yarnpkg/sdks vscode",
     "build": "rimraf dist && tsc",
-    "prepack": "yarn run build",
-    "test": "ts-mocha -p tsconfig.json test/**/*.test.ts",
-    "dev": "cd example && cross-env DEBUG=\\* NODE_ENV=development ts-node app"
+    "prepack": "npm run build",
+    "test": "mocha --loader ts-node/esm -p tsconfig.json test/**/*.test.ts",
+    "dev": "cd example && cross-env DEBUG=\\* NODE_ENV=development node --loader ts-node/esm app.ts"
   },
   "author": {
     "name": "YeFei",
@@ -38,14 +37,13 @@
     "mocha": "^10.2.0",
     "msgpackr": "^1.11.0",
     "rimraf": "^4.3.1",
-    "ts-mocha": "^10.0.0",
     "ts-node": "^10.9.1",
-    "typescript": "^5.3.3",
-    "zenweb": "^4.2.7"
+    "typescript": "^5.6.3",
+    "zenweb": "^5.1.0"
   },
   "dependencies": {
-    "@zenweb/core": "^4.2.3",
-    "@zenweb/result": "^4.1.2",
+    "@zenweb/core": "^5.1.0",
+    "@zenweb/result": "^5.0.0",
     "ioredis": "^5.3.2"
   }
 }