sculp-js 1.2.0 → 1.3.0

package/lib/umd/index.js

@@ -1,6 +1,6 @@
 /*!
- * sculp-js v1.1.0
- * (c) 2023-2023 chandq
+ * sculp-js v1.3.0
+ * (c) 2023-2024 chandq
  * Released under the MIT License.
  */
 
@@ -25,6 +25,9 @@
     const isUndefined = (any) => typeof any === 'undefined';
     const isNull = (any) => any === null;
     const isPrimitive = (any) => any === null || typeof any !== 'object';
+    function isNullOrUnDef(val) {
+        return isUndefined(val) || isNull(val);
+    }
     // 复合数据类型判断
     const isObject = (any) => typeIs(any) === 'Object';
     const isArray = (any) => Array.isArray(any);
@@ -1274,6 +1277,109 @@
         });
     }
 
+    const b64 = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+    // eslint-disable-next-line
+    const b64re = /^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/;
+    /**
+     * 字符串编码成Base64 （适用于任何环境，包括小程序）
+     * @param {string} string
+     * @return {string}
+     */
+    function weBtoa(string) {
+        // 同window.btoa: 字符串编码成Base64
+        string = String(string);
+        let bitmap, a, b, c, result = '', i = 0;
+        const rest = string.length % 3;
+        for (; i < string.length;) {
+            if ((a = string.charCodeAt(i++)) > 255 || (b = string.charCodeAt(i++)) > 255 || (c = string.charCodeAt(i++)) > 255)
+                throw new TypeError("Failed to execute 'btoa' on 'Window': The string to be encoded contains characters outside of the Latin1 range.");
+            bitmap = (a << 16) | (b << 8) | c;
+            result +=
+                b64.charAt((bitmap >> 18) & 63) +
+                    b64.charAt((bitmap >> 12) & 63) +
+                    b64.charAt((bitmap >> 6) & 63) +
+                    b64.charAt(bitmap & 63);
+        }
+        return rest ? result.slice(0, rest - 3) + '==='.substring(rest) : result;
+    }
+    /**
+     * Base64解码为原始字符串（适用于任何环境，包括小程序）
+     * @param {string} string
+     * @return {string}
+     */
+    function weAtob(string) {
+        // 同window.atob: Base64解码为原始字符串
+        string = String(string).replace(/[\t\n\f\r ]+/g, '');
+        if (!b64re.test(string))
+            throw new TypeError("Failed to execute 'atob' on 'Window': The string to be decoded is not correctly encoded.");
+        string += '=='.slice(2 - (string.length & 3));
+        let bitmap, result = '', r1, r2, i = 0;
+        for (; i < string.length;) {
+            bitmap =
+                (b64.indexOf(string.charAt(i++)) << 18) |
+                    (b64.indexOf(string.charAt(i++)) << 12) |
+                    ((r1 = b64.indexOf(string.charAt(i++))) << 6) |
+                    (r2 = b64.indexOf(string.charAt(i++)));
+            result +=
+                r1 === 64
+                    ? String.fromCharCode((bitmap >> 16) & 255)
+                    : r2 === 64
+                        ? String.fromCharCode((bitmap >> 16) & 255, (bitmap >> 8) & 255)
+                        : String.fromCharCode((bitmap >> 16) & 255, (bitmap >> 8) & 255, bitmap & 255);
+        }
+        return result;
+    }
+    function b64DecodeUnicode(str) {
+        return decodeURIComponent(exports.weAtob(str).replace(/(.)/g, function (p) {
+            let code = p.charCodeAt(0).toString(16).toUpperCase();
+            if (code.length < 2) {
+                code = '0' + code;
+            }
+            return '%' + code;
+        }));
+    }
+    function base64_url_decode(str) {
+        let output = str.replace(/-/g, '+').replace(/_/g, '/');
+        switch (output.length % 4) {
+            case 0:
+                break;
+            case 2:
+                output += '==';
+                break;
+            case 3:
+                output += '=';
+                break;
+            default:
+                throw new Error('Illegal base64url string!');
+        }
+        try {
+            return b64DecodeUnicode(output);
+        }
+        catch (err) {
+            return exports.weAtob(output);
+        }
+    }
+    function weAppJwtDecode(token, options) {
+        if (typeof token !== 'string') {
+            throw new Error('Invalid token specified');
+        }
+        options = options || {};
+        const pos = options.header === true ? 0 : 1;
+        try {
+            return JSON.parse(base64_url_decode(token.split('.')[pos]));
+        }
+        catch (e) {
+            throw new Error('Invalid token specified: ' + e.message);
+        }
+    }
+
+    /**
+     * 判断是否支持canvas
+     * @returns {boolean}
+     */
+    function supportCanvas() {
+        return !!document.createElement('canvas').getContext;
+    }
     /**
      * 选择本地文件
      * @param {string} accept 上传的文件类型，用于过滤
@@ -1295,6 +1401,119 @@
         };
         return inputObj;
     }
+    /**
+     * Web端：等比例压缩图片批量处理 (size小于200KB，不压缩)
+     * @param {File | FileList} file 文件
+     * @param {ICompressOptions} options
+     * @returns {Promise<object> | undefined}
+     */
+    function compressImg(file, options) {
+        console.assert(file instanceof File || file instanceof FileList, `${file} 必须是File或FileList类型`);
+        console.assert(supportCanvas(), `当前环境不支持 Canvas`);
+        let targetQuality = 0.52;
+        if (file instanceof File) {
+            const sizeKB = +parseInt((file.size / 1024).toFixed(2));
+            if (sizeKB < 1 * 1024) {
+                targetQuality = 0.85;
+            }
+            else if (sizeKB >= 1 * 1024 && sizeKB < 5 * 1024) {
+                targetQuality = 0.62;
+            }
+            else if (sizeKB >= 5 * 1024) {
+                targetQuality = 0.52;
+            }
+        }
+        if (options.quality) {
+            targetQuality = options.quality;
+        }
+        if (file instanceof FileList) {
+            return Promise.all(Array.from(file).map(el => compressImg(el, { mime: options.mime, quality: targetQuality }))); // 如果是 file 数组返回 Promise 数组
+        }
+        else if (file instanceof File) {
+            return new Promise(resolve => {
+                const sizeKB = +parseInt((file.size / 1024).toFixed(2));
+                if (+(file.size / 1024).toFixed(2) < 200) {
+                    resolve({
+                        file: file
+                    });
+                }
+                else {
+                    const reader = new FileReader(); // 创建 FileReader
+                    // @ts-ignore
+                    reader.onload = ({ target: { result: src } }) => {
+                        const image = new Image(); // 创建 img 元素
+                        image.onload = () => {
+                            const canvas = document.createElement('canvas'); // 创建 canvas 元素
+                            const context = canvas.getContext('2d');
+                            let targetWidth = image.width;
+                            let targetHeight = image.height;
+                            const originWidth = image.width;
+                            const originHeight = image.height;
+                            if (1 * 1024 <= sizeKB && sizeKB < 10 * 1024) {
+                                const maxWidth = 1600, maxHeight = 1600;
+                                targetWidth = originWidth;
+                                targetHeight = originHeight;
+                                // 图片尺寸超过的限制
+                                if (originWidth > maxWidth || originHeight > maxHeight) {
+                                    if (originWidth / originHeight > maxWidth / maxHeight) {
+                                        // 更宽，按照宽度限定尺寸
+                                        targetWidth = maxWidth;
+                                        targetHeight = Math.round(maxWidth * (originHeight / originWidth));
+                                    }
+                                    else {
+                                        targetHeight = maxHeight;
+                                        targetWidth = Math.round(maxHeight * (originWidth / originHeight));
+                                    }
+                                }
+                            }
+                            if (10 * 1024 <= sizeKB && sizeKB <= 20 * 1024) {
+                                const maxWidth = 1400, maxHeight = 1400;
+                                targetWidth = originWidth;
+                                targetHeight = originHeight;
+                                // 图片尺寸超过的限制
+                                if (originWidth > maxWidth || originHeight > maxHeight) {
+                                    if (originWidth / originHeight > maxWidth / maxHeight) {
+                                        // 更宽，按照宽度限定尺寸
+                                        targetWidth = maxWidth;
+                                        targetHeight = Math.round(maxWidth * (originHeight / originWidth));
+                                    }
+                                    else {
+                                        targetHeight = maxHeight;
+                                        targetWidth = Math.round(maxHeight * (originWidth / originHeight));
+                                    }
+                                }
+                            }
+                            canvas.width = targetWidth;
+                            canvas.height = targetHeight;
+                            context.clearRect(0, 0, targetWidth, targetHeight);
+                            context.drawImage(image, 0, 0, targetWidth, targetHeight); // 绘制 canvas
+                            const canvasURL = canvas.toDataURL(options.mime, targetQuality);
+                            const buffer = weAtob(canvasURL.split(',')[1]);
+                            let length = buffer.length;
+                            const bufferArray = new Uint8Array(new ArrayBuffer(length));
+                            while (length--) {
+                                bufferArray[length] = buffer.charCodeAt(length);
+                            }
+                            const miniFile = new File([bufferArray], file.name, {
+                                type: options.mime
+                            });
+                            resolve({
+                                file: miniFile,
+                                bufferArray,
+                                origin: file,
+                                beforeSrc: src,
+                                afterSrc: canvasURL,
+                                beforeKB: Number((file.size / 1024).toFixed(2)),
+                                afterKB: Number((miniFile.size / 1024).toFixed(2))
+                            });
+                        };
+                        image.src = src;
+                    };
+                    reader.readAsDataURL(file);
+                }
+            });
+        }
+    }
 
     /*
      * @created: Saturday, 2020-04-18 14:38:23
@@ -1825,7 +2044,7 @@
 
     const defaultFieldOptions = { keyField: 'key', childField: 'children', pidField: 'pid' };
     /**
-     * 自定义深度优先遍历函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+     * 深度优先遍历函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
      * @param {ArrayLike<V>} tree  树形数据
      * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
      * @param {string} children 定制子元素的key
@@ -1880,6 +2099,76 @@
         };
         walk(tree, null);
     }
+    /**
+     * 深度优先遍历的Map函数(支持continue和break操作), 可用于insert tree item 和 remove tree item
+     * @param {ArrayLike<V>} tree  树形数据
+     * @param {Function} iterator  迭代函数, 返回值为true时continue, 返回值为false时break
+     * @param {string} children 定制子元素的key
+     * @param {boolean} isReverse  是否反向遍历
+     * @returns {any[]} 新的一棵树
+     */
+    function forEachMap(tree, iterator, children = 'children', isReverse = false) {
+        let level = 0, isBreak = false;
+        const newTree = [];
+        const walk = (arr, parent, newTree) => {
+            if (isReverse) {
+                for (let i = arr.length - 1; i >= 0; i--) {
+                    if (isBreak) {
+                        break;
+                    }
+                    const re = iterator(arr[i], i, arr, tree, parent, level);
+                    if (re === false) {
+                        isBreak = true;
+                        break;
+                    }
+                    else if (re === true) {
+                        continue;
+                    }
+                    newTree.push(re);
+                    // @ts-ignore
+                    if (arr[i] && Array.isArray(arr[i][children])) {
+                        ++level;
+                        newTree[newTree.length - 1][children] = [];
+                        // @ts-ignore
+                        walk(arr[i][children], arr[i], newTree[newTree.length - 1][children]);
+                    }
+                    else {
+                        // children非有效数组时，移除该属性字段
+                        delete re[children];
+                    }
+                }
+            }
+            else {
+                for (let i = 0; i < arr.length; i++) {
+                    if (isBreak) {
+                        break;
+                    }
+                    const re = iterator(arr[i], i, arr, tree, parent, level);
+                    if (re === false) {
+                        isBreak = true;
+                        break;
+                    }
+                    else if (re === true) {
+                        continue;
+                    }
+                    newTree.push(re);
+                    // @ts-ignore
+                    if (arr[i] && Array.isArray(arr[i][children])) {
+                        ++level;
+                        newTree[newTree.length - 1][children] = [];
+                        // @ts-ignore
+                        walk(arr[i][children], arr[i], newTree[newTree.length - 1][children]);
+                    }
+                    else {
+                        // children非有效数组时，移除该属性字段
+                        delete re[children];
+                    }
+                }
+            }
+        };
+        walk(tree, null, newTree);
+        return newTree;
+    }
     /**
      * 在树中找到 id 为某个值的节点，并返回上游的所有父级节点
      *
@@ -2041,6 +2330,7 @@
     exports.calculateDateTime = calculateDateTime;
     exports.chooseLocalFile = chooseLocalFile;
     exports.cloneDeep = cloneDeep;
+    exports.compressImg = compressImg;
     exports.cookieDel = cookieDel;
     exports.cookieGet = cookieGet;
     exports.cookieSet = cookieSet;
@@ -2054,6 +2344,7 @@
     exports.downloadHref = downloadHref;
     exports.downloadURL = downloadURL;
     exports.forEachDeep = forEachDeep;
+    exports.forEachMap = forEachMap;
     exports.formatDate = formatDate;
     exports.formatNumber = formatNumber;
     exports.formatTree = formatTree;
@@ -2072,6 +2363,7 @@
     exports.isFunction = isFunction;
     exports.isNaN = isNaN;
     exports.isNull = isNull;
+    exports.isNullOrUnDef = isNullOrUnDef;
     exports.isNumber = isNumber;
     exports.isObject = isObject;
     exports.isPlainObject = isPlainObject;
@@ -2113,6 +2405,7 @@
     exports.stringFill = stringFill;
     exports.stringFormat = stringFormat;
     exports.stringKebabCase = stringKebabCase;
+    exports.supportCanvas = supportCanvas;
     exports.throttle = throttle;
     exports.tooltipEvent = tooltipEvent;
     exports.typeIs = typeIs;
@@ -2123,5 +2416,8 @@
     exports.urlSetParams = urlSetParams;
     exports.urlStringify = urlStringify;
     exports.wait = wait;
+    exports.weAppJwtDecode = weAppJwtDecode;
+    exports.weAtob = weAtob;
+    exports.weBtoa = weBtoa;
 
 }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sculp-js",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "packageManager": "npm@8.19.2",
   "description": "js工具库",
   "scripts": {
@@ -37,8 +37,9 @@
     "lib"
   ],
   "keywords": [
-    "typescript",
-    "js-utils"
+    "sculp-js",
+    "js-utils",
+    "typescript"
   ],
   "engines": {
     "node": ">=16"
@@ -71,8 +72,10 @@
     "eslint-config-prettier": "^9.0.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-import-resolver-webpack": "^0.13.7",
+    "eslint-plugin-eslint-plugin": "^5.5.1",
     "eslint-plugin-import": "^2.28.1",
     "eslint-plugin-jest": "^27.4.2",
+    "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-standard": "^5.0.0",
     "husky": "^8.0.3",

package/lib/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.38.3"
-    }
-  ]
-}