ph-utils 0.9.10 → 0.9.13

package/README.md

@@ -1,7 +1,7 @@
-## ph-utils
-
-整理了 js 前后端开发(web + nodejs)时常用的一些工具；[详细文档](https://gitee.com/towardly/ph/wikis/Home?sort_id=4035190)
-
-### 包含如下工具文件
-
-`index` 基础工具类、`date` 跟日期相关的工具类、`file` 文件操作相关工具类[**服务端**]、`server` 服务端工具类、`validator` 数据验证、`dom` 浏览器节点操作相关[**前端**]、`web` 一些只适用于前端相关的工具、`color` 颜色相关工具
+## ph-utils
+
+整理了 js 前后端开发(web + nodejs)时常用的一些工具；[详细文档](https://gitee.com/towardly/ph/wikis/Home?sort_id=4035190)
+
+### 包含如下工具文件
+
+`index` 基础工具类、`date` 跟日期相关的工具类、`file` 文件操作相关工具类[**服务端**]、`server` 服务端工具类、`validator` 数据验证、`dom` 浏览器节点操作相关[**前端**]、`web` 一些只适用于前端相关的工具、`color` 颜色相关工具

package/lib/index.d.ts

@@ -126,4 +126,29 @@ export declare function round(num: number, precision?: number, roundType?: 0 | 1
  * 反转字符串
  */
 export declare function reverseStr(str: string): string;
+/** 数据格式化配置 */
+interface FormDataConfig<T> {
+    /** 配置需要转换为数字的字段 */
+    numberFields?: (keyof T)[];
+    /** 配置需要转换为字符串的字段 */
+    stringFields?: (keyof T)[];
+    /** 自定义的格式化 */
+    formatter?: {
+        [K in keyof T]?: "number" | "string" | ((value: any) => number | string);
+    };
+}
+/**
+ * 嵌套的 json 指定 key 数据
+ * @param data JSON格式数据
+ * @param keys 待获取的数据 key, 可以通过 [.] 获取嵌套数据, 例如: a.b.c
+ * @returns
+ */
+export declare function getJSONValue(data: Record<string, any>, keystr: string): Record<string, any> | null;
+/**
+ * 数据格式化主要用于数据类型转换
+ * @param data 待转换数据类型的数据
+ * @param config 转换配置
+ * @returns
+ */
+export declare function formatData<T extends Record<string, any>>(data: T, config?: FormDataConfig<T>): T;
 export {};

package/lib/index.js

@@ -173,3 +173,67 @@ export function round(num, precision = 2, roundType = 0) {
 export function reverseStr(str) {
     return str.split("").reverse().join("");
 }
+function getObjKeyValue(data, key) {
+    if (data == null)
+        return null;
+    return data[key];
+}
+/**
+ * 嵌套的 json 指定 key 数据
+ * @param data JSON格式数据
+ * @param keys 待获取的数据 key, 可以通过 [.] 获取嵌套数据, 例如: a.b.c
+ * @returns
+ */
+export function getJSONValue(data, keystr) {
+    if (data == null)
+        return null;
+    const keys = keystr.split(".");
+    let res = data;
+    for (const key of keys) {
+        res = getObjKeyValue(res, key);
+        if (res == null)
+            break;
+    }
+    return res;
+}
+/**
+ * 数据格式化主要用于数据类型转换
+ * @param data 待转换数据类型的数据
+ * @param config 转换配置
+ * @returns
+ */
+export function formatData(data, config) {
+    const cfg = {
+        numberFields: [],
+        stringFields: [],
+        formatter: {},
+        ...config,
+    };
+    const res = {};
+    for (const key in data) {
+        let value = getJSONValue(data, key);
+        let formater;
+        if (key in cfg.formatter) {
+            formater = cfg.formatter[key];
+        }
+        if (cfg.numberFields.includes(key)) {
+            formater = "number";
+        }
+        if (cfg.stringFields.includes(key)) {
+            formater = "string";
+        }
+        if (formater != null) {
+            if (typeof formater == "function") {
+                value = formater(value);
+            }
+            else if (formater == "number") {
+                value = Number(value);
+            }
+            else if (formater == "string") {
+                value = String(value);
+            }
+        }
+        res[key] = value;
+    }
+    return res;
+}

package/lib/server.js

@@ -1,4 +1,4 @@
-import { spawn } from "node:child_process";
+import { execFile } from "node:child_process";
 import { parseEnv, parseArgs } from "node:util";
 import { readFileSync } from "node:fs";
 /**
@@ -7,47 +7,37 @@ import { readFileSync } from "node:fs";
  * @returns
  */
 export function exec(command, ...params) {
-    return new Promise((resolve, reject) => {
-        let argvs = [];
-        const commandItems = command.split(" ");
-        const cmd = commandItems.shift();
-        if (commandItems.length > 0) {
-            argvs = commandItems;
-        }
-        let opts = undefined;
-        if (params[0] != null) {
-            if (params[0] instanceof Array) {
-                argvs.push(...params[0]);
-                if (params[1] != null) {
-                    opts = params[1];
-                }
-            }
-            else {
-                opts = params[0];
+    let argvs = [];
+    const commandItems = command.split(" ");
+    const cmd = commandItems.shift();
+    if (commandItems.length > 0) {
+        argvs = commandItems;
+    }
+    let opts = { shell: true };
+    if (params[0] != null) {
+        if (params[0] instanceof Array) {
+            argvs.push(...params[0]);
+            if (params[1] != null) {
+                opts = params[1];
             }
         }
-        const prs = spawn(cmd, argvs, opts);
-        let msg = [];
-        let error;
-        prs.stderr.on("data", (chunk) => {
-            msg.push(chunk.toString("utf-8"));
-        });
-        prs.stdout.on("data", (chunk) => {
-            msg.push(chunk.toString("utf-8"));
-        });
-        prs.on("error", (err) => {
-            error = err;
-        });
-        prs.on("close", (code, _signal) => {
-            if (code === 0) {
-                resolve(msg.join("\n"));
+        else {
+            opts = params[0];
+        }
+    }
+    return new Promise((resolve, reject) => {
+        execFile(cmd, argvs, opts, (err, stdout, stderr) => {
+            if (err) {
+                reject(err);
             }
             else {
-                if (error == null) {
-                    error = new Error(msg[msg.length - 1]);
+                let msg = stdout || stderr;
+                if (msg.includes("error") || msg.includes("Error")) {
+                    const error = new Error(msg);
+                    error.type = "StdErr";
+                    reject(error);
                 }
-                error.errno = code;
-                reject(error);
+                resolve(msg);
             }
         });
     });

package/lib/theme.js

@@ -19,10 +19,10 @@ export async function initTheme() {
     if ($themeStyle == null) {
         $themeStyle = document.createElement("style");
         $themeStyle.id = "theme-style";
-        $themeStyle.innerHTML = `
-      :root{color-scheme:light dark;}
-      html.light{color-scheme: light;}
-      html.dark {color-scheme: dark;}
+        $themeStyle.innerHTML = `
+      :root{color-scheme:light dark;}
+      html.light{color-scheme: light;}
+      html.dark {color-scheme: dark;}
     `;
         document.head.appendChild($themeStyle);
     }

package/lib/validator.d.ts

@@ -52,6 +52,7 @@ declare class Validator {
      * 只验证指定 key 的数据格式
      * @param key   指定待验证的 key
      * @param value 待验证的数据
+     * @param data 原始数据，当验证确认密码时需要使用
      */
     validateKey(key: string, value: any, data?: any): Promise<{
         key: string;

package/lib/validator.js

@@ -136,6 +136,7 @@ class Validator {
      * 只验证指定 key 的数据格式
      * @param key   指定待验证的 key
      * @param value 待验证的数据
+     * @param data 原始数据，当验证确认密码时需要使用
      */
     async validateKey(key, value, data) {
         let keyRules = this.rules[key];

package/package.json

@@ -68,7 +68,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.9.10",
+  "version": "0.9.13",
   "type": "module",
   "repository": {
     "type": "git",
@@ -82,8 +82,8 @@
   },
   "homepage": "https://gitee.com/towardly/ph/tree/master/packages/utils",
   "devDependencies": {
-    "@types/node": "^20.12.12",
-    "typescript": "^5.4.5"
+    "@types/node": "^22.7.9",
+    "typescript": "^5.6.3"
   },
   "files": [
     "lib"

package/lib/clipboard.d.ts

@@ -1,11 +0,0 @@
-/**
- * 复制数据, 可以从多种类型的数据
- *    1. 直接复制文本: await copy("待复制的文本")
- *    2. 复制节点上的 data-copy-text:
- *      <button data-copy-text="这是待复制的文本">复制</button>
- *      await copy(e.target) // or await copy("#a") or await copy(document.querySelector('#a'))
- *    3. 直接复制节点本身数据: await copy('#a')
- * @param {string | HTMLElement} source 复制源, 从中解析待复制的数据
- * @returns {Promise<boolean>} 是否复制成功
- */
-export declare function copy(source: string | HTMLElement): Promise<boolean>;

package/lib/clipboard.js

@@ -1,101 +0,0 @@
-/**
- * 创建一个临时节点缓存待复制数据
- * @param {String} value - 待复制文本
- * @return {HTMLElement}
- */
-function createFakeElement(value) {
-    const fakeElement = document.createElement("textarea");
-    fakeElement.style.border = "0";
-    fakeElement.style.padding = "0";
-    fakeElement.style.margin = "0";
-    fakeElement.style.position = "absolute";
-    fakeElement.style.left = "-9999px";
-    fakeElement.style.top = "-9999";
-    fakeElement.setAttribute("readonly", "");
-    fakeElement.value = value;
-    return fakeElement;
-}
-/** 通过执行 execCommand 来执行复制 */
-function copyFromCommand(text) {
-    // 添加节点
-    const fakeEl = createFakeElement(text);
-    document.body.append(fakeEl);
-    fakeEl.focus();
-    fakeEl.select();
-    // 执行复制
-    const res = document.execCommand("copy");
-    fakeEl.remove(); // 删除节点
-    return Promise.resolve(res);
-}
-/** 使用 navigator.clipboard 复制 */
-function copyFromClipboard(text) {
-    const theClipboard = navigator.clipboard;
-    if (theClipboard != null) {
-        return theClipboard
-            .writeText(text)
-            .then(() => {
-            Promise.resolve(true);
-        })
-            .catch(() => Promise.resolve(false));
-    }
-    return Promise.resolve(false);
-}
-/** 解析待复制的文本 */
-function parseCopyText(source) {
-    let copyText = null; // 待复制文本
-    let sourceEl = null;
-    // 获取待复制数据
-    if (typeof source === "string") {
-        // 从节点拿数据
-        if (source.startsWith("#") || source.startsWith(".")) {
-            sourceEl = document.querySelector(source);
-            if (sourceEl == null) {
-                copyText = source;
-            }
-        }
-        else {
-            copyText = source;
-        }
-    }
-    if (source instanceof HTMLElement) {
-        sourceEl = source;
-    }
-    // 从节点获取待复制数据
-    if (sourceEl != null) {
-        if (sourceEl.hasAttribute("data-copy-text")) {
-            copyText = sourceEl.getAttribute("data-copy-text");
-        }
-        else {
-            const tagName = sourceEl.tagName;
-            if (tagName === "INPUT" || tagName === "TEXTAREA") {
-                copyText = sourceEl.value;
-            }
-            else {
-                copyText = sourceEl.textContent;
-            }
-        }
-    }
-    return copyText;
-}
-/**
- * 复制数据, 可以从多种类型的数据
- *    1. 直接复制文本: await copy("待复制的文本")
- *    2. 复制节点上的 data-copy-text:
- *      <button data-copy-text="这是待复制的文本">复制</button>
- *      await copy(e.target) // or await copy("#a") or await copy(document.querySelector('#a'))
- *    3. 直接复制节点本身数据: await copy('#a')
- * @param {string | HTMLElement} source 复制源, 从中解析待复制的数据
- * @returns {Promise<boolean>} 是否复制成功
- */
-export async function copy(source) {
-    // 待复制文本
-    const copyText = parseCopyText(source);
-    if (copyText == null) {
-        return Promise.resolve(false);
-    }
-    const v = await copyFromClipboard(copyText);
-    if (v === false) {
-        return copyFromCommand(copyText);
-    }
-    return Promise.resolve(true);
-}