ph-utils 0.11.2 → 0.11.4

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

@@ -1,3 +1,8 @@
+/**
+ * web(浏览器端) DOM 文件操作
+ * 现今不推荐在使用这种方式，现在开发前端的时候，推荐使用一些成熟的框架例如：React、Preact、Vue、Angular、Svelte、Ember、Knockout等
+ * 在使用这些框架的时候额外的一些不可避免的 dom 操作时才使用这个工具；如果确实需要使用原生开发推荐使用 jquery 或者想要更精简的话可以使用 https://github.com/finom/bala 封装
+ */
 /**
  * 根据选择器获取节点
  * @param {string} selector 选择器
@@ -37,17 +42,12 @@ export declare function removeClass(elem: HTMLElement, clazz: string): void;
  */
 export declare function hasClass(elem: HTMLElement, clazz: string): boolean;
 /**
- * 为节点添加 transition 属性，包括浏览器前缀
- * @param {HTMLElement} element 需要添加 css Transition 属性的节点
- * @param {string}      value   css transition 值
- */
-export declare function transition(element: HTMLElement, value: string): void;
-/**
- * 为节点添加 transform 属性，包括浏览器前缀
- * @param {HTMLElement} element  需要添加 css transform 属性的节点
- * @param {string}      value     css transform 值
+ * 切换指定元素的类名。
+ * 如果元素已包含该类名，则移除它；否则添加它。
+ * @param el - 要操作的 HTML 元素。
+ * @param clazz - 要切换的类名。
  */
-export declare function transform(element: HTMLElement, value: string): void;
+export declare function toggleClass(el: HTMLElement, clazz: string): void;
 /**
  * 为节点添加事件处理
  * @param {HTMLElement} element   添加事件的节点
@@ -173,7 +173,7 @@ export declare function formatStyle(styleObj: (string | undefined | null | "")[]
   ]);
  * ```
  */
-export declare function startTransition(target: HTMLElement, properties: [string, string][], duration?: string): void;
+export declare function startTransition(target: HTMLElement, properties: [string, string][], duration?: string | undefined | null): void;
 /**
  * 结束元素的过渡效果，并在过渡结束后隐藏元素。
  * @param target - 要操作的 HTML 元素。

package/lib/dom.js

@@ -3,7 +3,6 @@
  * 现今不推荐在使用这种方式，现在开发前端的时候，推荐使用一些成熟的框架例如：React、Preact、Vue、Angular、Svelte、Ember、Knockout等
  * 在使用这些框架的时候额外的一些不可避免的 dom 操作时才使用这个工具；如果确实需要使用原生开发推荐使用 jquery 或者想要更精简的话可以使用 https://github.com/finom/bala 封装
  */
-const vendorPrefix = ["", "-webkit", "-moz-"];
 /**
  * 根据选择器获取节点
  * @param {string} selector 选择器
@@ -60,26 +59,18 @@ export function hasClass(elem, clazz) {
     return elem.classList.contains(clazz);
 }
 /**
- * 为节点添加 transition 属性，包括浏览器前缀
- * @param {HTMLElement} element 需要添加 css Transition 属性的节点
- * @param {string}      value   css transition 值
+ * 切换指定元素的类名。
+ * 如果元素已包含该类名，则移除它；否则添加它。
+ * @param el - 要操作的 HTML 元素。
+ * @param clazz - 要切换的类名。
  */
-export function transition(element, value) {
-    vendorPrefix.forEach((prefix) => {
-        let t = prefix === "" ? "transition" : prefix + "Transition";
-        element.style[t] = value;
-    });
-}
-/**
- * 为节点添加 transform 属性，包括浏览器前缀
- * @param {HTMLElement} element  需要添加 css transform 属性的节点
- * @param {string}      value     css transform 值
- */
-export function transform(element, value) {
-    vendorPrefix.forEach((prefix) => {
-        let t = prefix === "" ? "transform" : prefix + "Transform";
-        element.style[t] = value;
-    });
+export function toggleClass(el, clazz) {
+    if (hasClass(el, clazz)) {
+        removeClass(el, clazz);
+    }
+    else {
+        addClass(el, clazz);
+    }
 }
 /**
  * 为节点添加事件处理
@@ -356,7 +347,7 @@ export function formatStyle(styleObj) {
   ]);
  * ```
  */
-export function startTransition(target, properties, duration) {
+export function startTransition(target, properties, duration = "0.3s") {
     target.style.setProperty("display", "none");
     const trans = [];
     for (let i = 0, len = properties.length; i < len; i++) {
@@ -367,14 +358,12 @@ export function startTransition(target, properties, duration) {
     if (duration) {
         target.style.setProperty("transition", trans.join(", "));
     }
-    queueMicrotask(() => {
-        target.style.removeProperty("display");
-        queueMicrotask(() => {
-            for (let i = 0, len = properties.length; i < len; i++) {
-                const rec = properties[i];
-                target.style.removeProperty(rec[0]);
-            }
-        });
+    target.style.removeProperty("display");
+    requestAnimationFrame(() => {
+        for (let i = 0, len = properties.length; i < len; i++) {
+            const rec = properties[i];
+            target.style.removeProperty(rec[0]);
+        }
     });
 }
 /**

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

@@ -60,7 +60,10 @@ declare class Validator {
      * @param value 待验证的数据
      * @param data 原始数据，当验证确认密码时需要使用
      */
-    validateKey(key: string, value: any, data?: any): Promise<boolean>;
+    validateKey(key: string, value: any, data?: any): Promise<{
+        key: string;
+        value: any;
+    }>;
     private _validateRule;
     private _parseSchemaRules;
     private _parseStringRule;

package/lib/validator.js

@@ -112,7 +112,7 @@ class Validator {
         return new Promise((resolve, reject) => {
             let keyRules = this.rules[key];
             if (keyRules == null) {
-                resolve(true);
+                resolve({ key, value });
                 return;
             }
             let errMsg = this._validateRule(keyRules, value, data);
@@ -121,7 +121,7 @@ class Validator {
                 reject(new ValidateError({ [key]: errMsg }, key, errMsg));
             }
             else {
-                resolve(true);
+                resolve({ key, value });
             }
         });
     }

package/package.json

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