ph-utils 0.16.2 → 0.16.3

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/array.d.ts

@@ -59,14 +59,14 @@ export declare function symmetricDifference<T>(...arrs: T[][]): T[];
  * @param a2
  * @returns
  */
-export declare function isSubsetOf<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): any;
+export declare function isSubsetOf<T>(a1: T[] | Set<T>, a2: T[] | Set<T>): boolean;
 /**
  * 返回一个布尔值，指示给定集合中的所有元素是否都在此集合中。
  * @param arr1
  * @param arr2
  * @returns
  */
-export declare function isSupersetOf<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): any;
+export declare function isSupersetOf<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): boolean;
 /**
  * 返回一个布尔值，指示此集合是否与给定集合没有公共元素。
  *
@@ -76,4 +76,4 @@ export declare function isSupersetOf<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>):
  * @param arr2
  * @returns
  */
-export declare function isDisjointFrom<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): any;
+export declare function isDisjointFrom<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): boolean;

package/lib/clipboard.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 复制数据, 可以从多种类型的数据
+ *    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

@@ -0,0 +1,101 @@
+/**
+ * 创建一个临时节点缓存待复制数据
+ * @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);
+}

package/lib/crypto.d.ts

@@ -12,7 +12,7 @@ export declare function bufferToHex(bf: ArrayBuffer | Uint8Array, upper?: boolea
  * @param algorithm   hash算法, 支持: SHA-1、SHA-256、SHA-384、SHA-512; 默认为: SHA-256
  * @returns
  */
-export declare function sha(message: string, upper?: boolean, algorithm?: string): Promise<string>;
+export declare function sha(message: string | ArrayBuffer, upper?: boolean, algorithm?: string): Promise<string>;
 /**
  * 哈希算法
  * @param message     待进行 hash 的数据
@@ -20,7 +20,7 @@ export declare function sha(message: string, upper?: boolean, algorithm?: string
  * @param algorithm   hash算法, 支持: SHA-1、SHA-256、SHA-384、SHA-512; 默认为: SHA-256
  * @returns
  */
-export declare function hash(message: string, upper?: boolean, algorithm?: string): Promise<string>;
+export declare function hash(message: string | ArrayBuffer, upper?: boolean, algorithm?: string): Promise<string>;
 type HMACAlgorithm = "SHA-256" | "SHA-512";
 /**
  * 使用 HMAC 算法计算消息的哈希值

package/lib/crypto.js

@@ -59,8 +59,11 @@ function base64ToBuffer(data) {
  * @returns
  */
 export async function sha(message, upper = false, algorithm = "SHA-256") {
-    const msgUint8 = new TextEncoder().encode(message);
-    const hashBuffer = await globalThis.crypto.subtle.digest(algorithm || "SHA-256", msgUint8);
+    let msgBuffer = message;
+    if (typeof message === "string") {
+        msgBuffer = new TextEncoder().encode(message);
+    }
+    const hashBuffer = await globalThis.crypto.subtle.digest(algorithm || "SHA-256", msgBuffer);
     return bufferToHex(hashBuffer, upper);
 }
 /**

package/lib/crypto_node.d.ts

@@ -43,7 +43,7 @@ export declare function aesEncrypt(key: string, input: string, upper?: boolean):
  * @param iv    向量
  * @returns
  */
-export declare function aesDecrypt(input: string, key: string, iv: string): string;
+export declare function aesDecrypt(input: string, key: string | Buffer, iv?: string | Buffer, algorithm?: string): string;
 /**
  * RSA 公钥加密
  * @param input 待加密字符串

package/lib/crypto_node.js

@@ -73,6 +73,16 @@ export function aesEncrypt(key, input, upper = false) {
         iv.toString("hex"),
     ];
 }
+function aesAlgorithm(key) {
+    if (key.startsWith("aes-"))
+        return key;
+    let prefix = "aes-";
+    // 如果 key 不是以数字开头，则加上数字，例如：128，256 等
+    if (!/^\d/.test(key)) {
+        prefix += "256-";
+    }
+    return `${prefix}${key}`;
+}
 /**
  * AES 解密
  * @param input 加密后的数据
@@ -80,8 +90,19 @@ export function aesEncrypt(key, input, upper = false) {
  * @param iv    向量
  * @returns
  */
-export function aesDecrypt(input, key, iv) {
-    const cipher = createDecipheriv("aes-256-cbc", Buffer.from(key, "hex"), Buffer.from(iv, "hex"));
+export function aesDecrypt(input, key, iv, algorithm = "aes-256-cbc") {
+    let ivBuffer = null;
+    if (iv && !Buffer.isBuffer(iv)) {
+        ivBuffer = Buffer.from(iv, "hex");
+    }
+    let keyBuffer;
+    if (Buffer.isBuffer(key)) {
+        keyBuffer = key;
+    }
+    else {
+        keyBuffer = Buffer.from(key, "hex");
+    }
+    const cipher = createDecipheriv(aesAlgorithm(algorithm), keyBuffer, ivBuffer);
     let decryptedData = cipher.update(input, "hex", "utf-8");
     decryptedData += cipher.final("utf-8");
     return decryptedData;

package/lib/dom.d.ts

@@ -75,6 +75,7 @@ export declare function hasClass(elem: HTMLElement, clazz: string): boolean;
  * @param clazz - 要切换的类名。
  */
 export declare function toggleClass(el: HTMLElement, clazz: string): void;
+type EventHandler = EventListenerOrEventListenerObject | ((e: CustomEvent) => void);
 /**
  * 为节点添加事件处理
  * @param {HTMLElement} element   添加事件的节点
@@ -82,7 +83,7 @@ export declare function toggleClass(el: HTMLElement, clazz: string): void;
  * @param {function}    event     事件处理函数
  * @param {boolean}     onceOrConfig  是否是只运行一次的处理函数或者配置，其中 eventFlag 为 string，如果配置该项，则表明为委托事件
  */
-export declare function on(element: HTMLElement | ShadowRoot | Document | HTMLCollection | NodeListOf<HTMLElement> | HTMLElement[], listener: string, fn: EventListener, option?: boolean | (AddEventListenerOptions & {
+export declare function on(element: HTMLElement | ShadowRoot | Document | HTMLCollection | NodeListOf<HTMLElement> | HTMLElement[], listener: string, fn: EventHandler, option?: boolean | (AddEventListenerOptions & {
     eventFlag?: string;
 })): void;
 /**
@@ -91,7 +92,7 @@ export declare function on(element: HTMLElement | ShadowRoot | Document | HTMLCo
  * @param listener - 事件名称。
  * @param fn - 要移除的事件监听器函数。
  */
-export declare function off(el: HTMLElement | ShadowRoot | Document | HTMLCollection | NodeListOf<HTMLElement> | HTMLElement[], listener: string, fn: EventListener, option?: boolean | EventListenerOptions): void;
+export declare function off(el: HTMLElement | ShadowRoot | Document | HTMLCollection | NodeListOf<HTMLElement> | HTMLElement[], listener: string, fn: EventHandler, option?: boolean | EventListenerOptions): void;
 /**
  * 判断事件是否应该继续传递。
  * 从事件目标开始向上遍历DOM树，检查每个节点上是否存在指定的属性。

package/lib/dom.js

@@ -55,7 +55,7 @@ export function create(tag, option = {}, ctx) {
                     if (value === true) {
                         $el.setAttribute(key, "");
                     }
-                    else if (typeof value === "string") {
+                    else {
                         $el.setAttribute(key, value);
                     }
                 }

package/lib/server.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { SpawnOptions } from "node:child_process";
 /**
  * 执行命令

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/package.json

@@ -68,7 +68,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.16.2",
+  "version": "0.16.3",
   "type": "module",
   "repository": {
     "type": "git",