util-helpers 4.21.7 → 4.22.1

package/esm/AsyncMemo.js

@@ -0,0 +1,40 @@
+import { __assign } from 'tslib';
+import { Cache } from 'cache2';
+import { isString, uniqueId } from 'ut2';
+
+var AsyncMemo = (function () {
+    function AsyncMemo(options) {
+        this.promiseCache = {};
+        this.cache = new Cache(uniqueId('uh_async_memo'), options);
+    }
+    AsyncMemo.prototype.run = function (asyncFn, key, options) {
+        var _this = this;
+        if (!isString(key)) {
+            return asyncFn();
+        }
+        var opts = __assign({ persisted: true }, options);
+        if (opts.persisted) {
+            var data = this.cache.get(key);
+            if (data) {
+                return Promise.resolve(data);
+            }
+        }
+        if (!this.promiseCache[key]) {
+            this.promiseCache[key] = asyncFn()
+                .then(function (res) {
+                delete _this.promiseCache[key];
+                _this.cache.set(key, res, opts.ttl);
+                return res;
+            })
+                .catch(function (err) {
+                delete _this.promiseCache[key];
+                return Promise.reject(err);
+            });
+        }
+        return this.promiseCache[key];
+    };
+    return AsyncMemo;
+}());
+var AsyncMemo$1 = AsyncMemo;
+
+export { AsyncMemo$1 as default };

package/esm/VERSION.js

@@ -1,4 +1,4 @@
-var VERSION = "4.21.7";
+var VERSION = "4.22.1";
 var VERSION$1 = VERSION;
 
 export { VERSION$1 as default };

package/esm/index.js

@@ -63,7 +63,8 @@ export { default as findTreeNodes } from './findTreeNodes.js';
 export { default as findTreeSelect } from './findTreeSelect.js';
 export { setDisableWarning } from './utils/config.js';
 export { default as VERSION } from './VERSION.js';
+export { default as AsyncMemo } from './AsyncMemo.js';
 
-var version = "4.21.7";
+var version = "4.22.1";
 
 export { version };

package/esm/utils/Cache.js

@@ -1,5 +1,5 @@
 import { __extends, __assign } from 'tslib';
-import EmitterPro from '../node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js';
+import Emitter from 'emitter-pro';
 import { forEach } from 'ut2';
 
 var Cache = (function (_super) {
@@ -41,7 +41,7 @@ var Cache = (function (_super) {
         }
     };
     return Cache;
-}(EmitterPro));
+}(Emitter));
 var Cache$1 = Cache;
 
 export { Cache$1 as default };

package/lib/AsyncMemo.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var tslib = require('tslib');
+var cache2 = require('cache2');
+var ut2 = require('ut2');
+
+var AsyncMemo = (function () {
+    function AsyncMemo(options) {
+        this.promiseCache = {};
+        this.cache = new cache2.Cache(ut2.uniqueId('uh_async_memo'), options);
+    }
+    AsyncMemo.prototype.run = function (asyncFn, key, options) {
+        var _this = this;
+        if (!ut2.isString(key)) {
+            return asyncFn();
+        }
+        var opts = tslib.__assign({ persisted: true }, options);
+        if (opts.persisted) {
+            var data = this.cache.get(key);
+            if (data) {
+                return Promise.resolve(data);
+            }
+        }
+        if (!this.promiseCache[key]) {
+            this.promiseCache[key] = asyncFn()
+                .then(function (res) {
+                delete _this.promiseCache[key];
+                _this.cache.set(key, res, opts.ttl);
+                return res;
+            })
+                .catch(function (err) {
+                delete _this.promiseCache[key];
+                return Promise.reject(err);
+            });
+        }
+        return this.promiseCache[key];
+    };
+    return AsyncMemo;
+}());
+var AsyncMemo$1 = AsyncMemo;
+
+module.exports = AsyncMemo$1;

package/lib/VERSION.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var VERSION = "4.21.7";
+var VERSION = "4.22.1";
 var VERSION$1 = VERSION;
 
 module.exports = VERSION$1;

package/lib/index.js

@@ -65,8 +65,9 @@ var findTreeNodes = require('./findTreeNodes.js');
 var findTreeSelect = require('./findTreeSelect.js');
 var config = require('./utils/config.js');
 var VERSION = require('./VERSION.js');
+var AsyncMemo = require('./AsyncMemo.js');
 
-exports.version = "4.21.7";
+exports.version = "4.22.1";
 
 exports.isMobile = isMobile;
 exports.isTelephone = isTelephone;
@@ -133,3 +134,4 @@ exports.findTreeNodes = findTreeNodes;
 exports.findTreeSelect = findTreeSelect;
 exports.setDisableWarning = config.setDisableWarning;
 exports.VERSION = VERSION;
+exports.AsyncMemo = AsyncMemo;

package/lib/utils/Cache.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var tslib = require('tslib');
-var emitterPro_esm = require('../node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js');
+var Emitter = require('emitter-pro');
 var ut2 = require('ut2');
 
 var Cache = (function (_super) {
@@ -43,7 +43,7 @@ var Cache = (function (_super) {
         }
     };
     return Cache;
-}(emitterPro_esm));
+}(Emitter));
 var Cache$1 = Cache;
 
 module.exports = Cache$1;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.21.7",
+  "version": "4.22.1",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -16,7 +16,7 @@
     "build:dist": "rm -rf dist && rollup -c rollup.umd.config.mjs",
     "build:types": "rm -rf types && tsc -p tsconfig.build.json -d --outDir types --emitDeclarationOnly",
     "build:doc": "npm run doc",
-    "doc": "rm -rf docs && rm -rf docs-src && tsc -p tsconfig.build.json --outDir docs-src && jsdoc -c conf.json && rm -rf docs-src",
+    "doc": "rm -rf docs && rm -rf docs-src && tsc -p tsconfig.build.json -t esnext --outDir docs-src && jsdoc -c conf.json && rm -rf docs-src",
     "doc:open": "open ./docs/index.html",
     "prettier": "prettier --write 'src/**/*.ts' && prettier --write 'test/**/*.ts'",
     "lint": "eslint src --ext .ts",
@@ -51,8 +51,8 @@
   },
   "homepage": "https://doly-dev.github.io/util-helpers/index.html",
   "devDependencies": {
-    "@babel/core": "^7.24.4",
-    "@babel/preset-env": "^7.24.4",
+    "@babel/core": "^7.24.5",
+    "@babel/preset-env": "^7.24.5",
     "@babel/preset-typescript": "^7.24.1",
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
@@ -63,8 +63,8 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.7.0",
-    "@typescript-eslint/parser": "^7.7.0",
+    "@typescript-eslint/eslint-plugin": "^7.9.0",
+    "@typescript-eslint/parser": "^7.9.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-minify-replace": "^0.5.0",
     "commitizen": "^4.3.0",
@@ -76,10 +76,10 @@
     "jest": "^29.7.0",
     "jest-canvas-mock": "^2.5.2",
     "jest-environment-jsdom": "^29.7.0",
-    "jsdoc": "^4.0.2",
+    "jsdoc": "^4.0.3",
     "lint-staged": "^13.3.0",
     "prettier": "^3.2.5",
-    "rollup": "^4.14.3",
+    "rollup": "^4.17.2",
     "typescript": "^5.4.5"
   },
   "lint-staged": {
@@ -92,9 +92,10 @@
     }
   },
   "dependencies": {
+    "cache2": "^2.0.5",
     "emitter-pro": "^1.2.1",
     "tslib": "^2.6.2",
-    "ut2": "^1.7.1"
+    "ut2": "^1.9.1"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/types/AsyncMemo.d.ts

@@ -0,0 +1,33 @@
+import { Cache, CacheOptions } from 'cache2';
+/**
+ * 异步缓存
+ *
+ * @class
+ * @see {@link https://www.npmjs.com/package/cache2 | cache2}
+ * @param {Object} [options] 缓存配置项，更多配置项可参考 [`cache2`](https://www.npmjs.com/package/cache2)
+ * @param {number} [options.max] 最大缓存数量
+ * @param {'replaced' | 'limited'} [options.maxStrategy] 缓存策略
+ */
+declare class AsyncMemo<DataType = any> {
+    private promiseCache;
+    /**
+     * cache2 实例，用于管理缓存
+     */
+    cache: Cache<DataType>;
+    constructor(options?: Partial<CacheOptions>);
+    /**
+     * 执行异步方法
+     *
+     * @param {Function} asyncFn 异步方法
+     * @param {string} [key] 缓存键，如果没有该值将直接执行异步方法。
+     * @param {Object} [options] 配置项
+     * @param {number} [options.ttl] 数据存活时间
+     * @param {boolean} [options.persisted=true] 数据持久化，如果存在缓存数据，直接返回缓存数据，不再执行异步方法。<br/>即使不开启该配置，不影响在异步执行成功后缓存数据。
+     * @returns {Promise<*>} 异步结果
+     */
+    run(asyncFn: (...args: any[]) => Promise<DataType>, key?: string, options?: {
+        ttl?: number;
+        persisted?: boolean;
+    }): Promise<any>;
+}
+export default AsyncMemo;

package/types/ajax.d.ts

@@ -30,7 +30,7 @@ type AjaxOptions = {
  * @property {number} [timeout] 请求超时的毫秒数
  * @property {boolean} [withCredentials=false] 跨域请求时是否需要使用凭证
  * @property {*} [data=null] 请求体被发送的数据
- * @property {function} [options.onReadyStateChange] 当 readyState 属性发生变化时触发
+ * @property {function} [onReadyStateChange] 当 readyState 属性发生变化时触发
  * @property {function} [onLoadStart] 接收到响应数据时触发
  * @property {function} [onProgress] 请求接收到更多数据时，周期性地触发
  * @property {function} [onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时

package/types/download.d.ts

@@ -22,11 +22,11 @@ type DownloadOptions = {
  */
 /**
  * @typedef {Object} DownloadOptions 下载配置项
- * @property {string} [options.fileName] 文件名称
- * @property {string} [options.type] MIME 类型
- * @property {'url'|'text'} [options.dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
- * @property {TransformRequest} [options.transformRequest] 请求前触发，XHR 对象或配置调整
- * @property {TransformResponse} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
+ * @property {string} [fileName] 文件名称
+ * @property {string} [type] MIME 类型
+ * @property {'url'|'text'} [dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+ * @property {TransformRequest} [transformRequest] 请求前触发，XHR 对象或配置调整
+ * @property {TransformResponse} [transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
  */
 /**
  * 下载

package/types/index.d.ts

@@ -138,3 +138,4 @@ export { VERSION };
  * @deprecated 即将废弃，请使用 `VERSION`
  */
 export declare const version: string;
+export { default as AsyncMemo } from './AsyncMemo';

package/types/numberToChinese.d.ts

@@ -17,6 +17,7 @@ type Options = {
  * @static
  * @alias module:Processor.numberToChinese
  * @since 1.2.0
+ * @see {@link https://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=F5DAC3377DA99C8D78AE66735B6359C7 | 出版物上数字用法}
  * @param {number} num 数字
  * @param {Object} [options] 配置项
  * @param {boolean} [options.big5=false] 繁体

package/esm/node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js

@@ -1,98 +0,0 @@
-var EmitterPro = /** @class */ (function () {
-    function EmitterPro() {
-        this.handlers = {};
-    }
-    EmitterPro.prototype.eventNames = function () {
-        var _a;
-        var symbols = ((_a = Object.getOwnPropertySymbols) === null || _a === void 0 ? void 0 : _a.call(Object, this.handlers)) || [];
-        var keys = Object.keys(this.handlers);
-        return keys.concat(symbols);
-    };
-    EmitterPro.prototype.rawListeners = function (eventName) {
-        var handler = this.handlers[eventName];
-        return handler ? handler.map(function (item) { return item.raw; }) : [];
-    };
-    EmitterPro.prototype.listeners = function (eventName) {
-        var handler = this.handlers[eventName];
-        return handler ? handler.map(function (item) { return item.wrap; }) : [];
-    };
-    EmitterPro.prototype.hasListener = function (eventName, listener) {
-        return this.rawListeners(eventName).some(function (item) { return item === listener; });
-    };
-    EmitterPro.prototype._on = function (eventName, raw, wrap, context, dir) {
-        if (context === void 0) { context = null; }
-        if (dir === void 0) { dir = 1; }
-        var currentListener = { raw: raw, wrap: wrap, context: context };
-        if (!this.handlers[eventName]) {
-            this.handlers[eventName] = [currentListener];
-        }
-        else {
-            var appendMethod = dir === 1 ? 'push' : 'unshift';
-            this.handlers[eventName][appendMethod](currentListener);
-        }
-        return this;
-    };
-    EmitterPro.prototype.prependListener = function (eventName, listener, context) {
-        return this._on(eventName, listener, listener, context, 0);
-    };
-    EmitterPro.prototype.on = function (eventName, listener, context) {
-        return this._on(eventName, listener, listener, context);
-    };
-    EmitterPro.prototype._wrapOnce = function (eventName, listener, context) {
-        var _this = this;
-        if (context === void 0) { context = null; }
-        var wrap = (function () {
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments[_i];
-            }
-            listener.apply(context, args);
-            _this.off(eventName, wrap);
-        });
-        return wrap;
-    };
-    EmitterPro.prototype.once = function (eventName, listener, context) {
-        var wrap = this._wrapOnce(eventName, listener, context);
-        return this._on(eventName, listener, wrap, context);
-    };
-    EmitterPro.prototype.prependOnceListener = function (eventName, listener, context) {
-        var wrap = this._wrapOnce(eventName, listener, context);
-        return this._on(eventName, listener, wrap, context, 0);
-    };
-    EmitterPro.prototype.off = function (eventName, listener) {
-        var handler = this.handlers[eventName];
-        if (handler) {
-            if (listener) {
-                var index = handler.findIndex(function (item) { return item.wrap === listener || item.raw === listener; });
-                if (index !== -1) {
-                    handler.splice(index, 1);
-                }
-            }
-            else {
-                delete this.handlers[eventName];
-            }
-        }
-        return this;
-    };
-    EmitterPro.prototype.offAll = function () {
-        this.handlers = {};
-        return this;
-    };
-    EmitterPro.prototype.emit = function (eventName) {
-        var args = [];
-        for (var _i = 1; _i < arguments.length; _i++) {
-            args[_i - 1] = arguments[_i];
-        }
-        var handler = this.handlers[eventName];
-        if (handler && handler.length > 0) {
-            handler.forEach(function (listener) {
-                listener.wrap.apply(listener.context, args);
-            });
-            return true;
-        }
-        return false;
-    };
-    return EmitterPro;
-}());
-
-export { EmitterPro as default };

package/lib/node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js

@@ -1,100 +0,0 @@
-'use strict';
-
-exports.default = /** @class */ (function () {
-    function EmitterPro() {
-        this.handlers = {};
-    }
-    EmitterPro.prototype.eventNames = function () {
-        var _a;
-        var symbols = ((_a = Object.getOwnPropertySymbols) === null || _a === void 0 ? void 0 : _a.call(Object, this.handlers)) || [];
-        var keys = Object.keys(this.handlers);
-        return keys.concat(symbols);
-    };
-    EmitterPro.prototype.rawListeners = function (eventName) {
-        var handler = this.handlers[eventName];
-        return handler ? handler.map(function (item) { return item.raw; }) : [];
-    };
-    EmitterPro.prototype.listeners = function (eventName) {
-        var handler = this.handlers[eventName];
-        return handler ? handler.map(function (item) { return item.wrap; }) : [];
-    };
-    EmitterPro.prototype.hasListener = function (eventName, listener) {
-        return this.rawListeners(eventName).some(function (item) { return item === listener; });
-    };
-    EmitterPro.prototype._on = function (eventName, raw, wrap, context, dir) {
-        if (context === void 0) { context = null; }
-        if (dir === void 0) { dir = 1; }
-        var currentListener = { raw: raw, wrap: wrap, context: context };
-        if (!this.handlers[eventName]) {
-            this.handlers[eventName] = [currentListener];
-        }
-        else {
-            var appendMethod = dir === 1 ? 'push' : 'unshift';
-            this.handlers[eventName][appendMethod](currentListener);
-        }
-        return this;
-    };
-    EmitterPro.prototype.prependListener = function (eventName, listener, context) {
-        return this._on(eventName, listener, listener, context, 0);
-    };
-    EmitterPro.prototype.on = function (eventName, listener, context) {
-        return this._on(eventName, listener, listener, context);
-    };
-    EmitterPro.prototype._wrapOnce = function (eventName, listener, context) {
-        var _this = this;
-        if (context === void 0) { context = null; }
-        var wrap = (function () {
-            var args = [];
-            for (var _i = 0; _i < arguments.length; _i++) {
-                args[_i] = arguments[_i];
-            }
-            listener.apply(context, args);
-            _this.off(eventName, wrap);
-        });
-        return wrap;
-    };
-    EmitterPro.prototype.once = function (eventName, listener, context) {
-        var wrap = this._wrapOnce(eventName, listener, context);
-        return this._on(eventName, listener, wrap, context);
-    };
-    EmitterPro.prototype.prependOnceListener = function (eventName, listener, context) {
-        var wrap = this._wrapOnce(eventName, listener, context);
-        return this._on(eventName, listener, wrap, context, 0);
-    };
-    EmitterPro.prototype.off = function (eventName, listener) {
-        var handler = this.handlers[eventName];
-        if (handler) {
-            if (listener) {
-                var index = handler.findIndex(function (item) { return item.wrap === listener || item.raw === listener; });
-                if (index !== -1) {
-                    handler.splice(index, 1);
-                }
-            }
-            else {
-                delete this.handlers[eventName];
-            }
-        }
-        return this;
-    };
-    EmitterPro.prototype.offAll = function () {
-        this.handlers = {};
-        return this;
-    };
-    EmitterPro.prototype.emit = function (eventName) {
-        var args = [];
-        for (var _i = 1; _i < arguments.length; _i++) {
-            args[_i - 1] = arguments[_i];
-        }
-        var handler = this.handlers[eventName];
-        if (handler && handler.length > 0) {
-            handler.forEach(function (listener) {
-                listener.wrap.apply(listener.context, args);
-            });
-            return true;
-        }
-        return false;
-    };
-    return EmitterPro;
-}());
-
-module.exports = exports.default;