ph-utils 0.4.0 → 0.4.2

package/lib/copy.js

@@ -4,14 +4,14 @@
  * @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', '');
+    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;
 }
@@ -23,13 +23,13 @@ function copyFromCommand(text) {
     fakeEl.focus();
     fakeEl.select();
     // 执行复制
-    const res = document.execCommand('copy');
+    const res = document.execCommand("copy");
     fakeEl.remove(); // 删除节点
     return Promise.resolve(res);
 }
 /** 使用 navigator.clipboard 复制 */
 function copyFromClipboard(text) {
-    let theClipboard = navigator.clipboard;
+    const theClipboard = navigator.clipboard;
     if (theClipboard != null) {
         return theClipboard
             .writeText(text)
@@ -38,18 +38,16 @@ function copyFromClipboard(text) {
         })
             .catch(() => Promise.resolve(false));
     }
-    else {
-        return Promise.resolve(false);
-    }
+    return Promise.resolve(false);
 }
 /** 解析待复制的文本 */
 function parseCopyText(source) {
     let copyText = null; // 待复制文本
     let sourceEl = null;
     // 获取待复制数据
-    if (typeof source === 'string') {
+    if (typeof source === "string") {
         // 从节点拿数据
-        if (source.startsWith('#') || source.startsWith('.')) {
+        if (source.startsWith("#") || source.startsWith(".")) {
             sourceEl = document.querySelector(source);
             if (sourceEl == null) {
                 copyText = source;
@@ -64,12 +62,12 @@ function parseCopyText(source) {
     }
     // 从节点获取待复制数据
     if (sourceEl != null) {
-        if (sourceEl.hasAttribute('data-copy-text')) {
-            copyText = sourceEl.getAttribute('data-copy-text');
+        if (sourceEl.hasAttribute("data-copy-text")) {
+            copyText = sourceEl.getAttribute("data-copy-text");
         }
         else {
             const tagName = sourceEl.tagName;
-            if (tagName === 'INPUT' || tagName === 'TEXTAREA') {
+            if (tagName === "INPUT" || tagName === "TEXTAREA") {
                 copyText = sourceEl.value;
             }
             else {
@@ -99,7 +97,5 @@ export async function copy(source) {
     if (v === false) {
         return copyFromCommand(copyText);
     }
-    else {
-        return Promise.resolve(true);
-    }
+    return Promise.resolve(true);
 }

package/lib/crypto_node.d.ts

@@ -1,8 +1,8 @@
-type HashAlgorithmName = 'md5' | 'sha1' | 'sha256';
+type HashAlgorithmName = "md5" | "sha1" | "sha256";
 /**
  * 进行 md5|sha1|sha256 数据摘要签名
  * @param d 待加密的数据
- * @param algorithm 签名算法, md5、sha1. Defaults to "md5".
+ * @param algorithm 签名算法, md5、sha1、sha256. Defaults to "sha256".
  * @param upper 返回的结果是否需要大写. Defaults to False.
  */
 export declare function hashDigest(d: string, algorithm?: HashAlgorithmName, upper?: boolean): string;

package/lib/crypto_node.js

@@ -1,12 +1,12 @@
-import { createHash, createCipheriv, randomBytes, generateKeyPair, createDecipheriv, privateDecrypt, publicEncrypt, } from 'node:crypto';
+import { createHash, createCipheriv, randomBytes, generateKeyPair, createDecipheriv, privateDecrypt, publicEncrypt, } from "node:crypto";
 /**
  * 进行 md5|sha1|sha256 数据摘要签名
  * @param d 待加密的数据
- * @param algorithm 签名算法, md5、sha1. Defaults to "md5".
+ * @param algorithm 签名算法, md5、sha1、sha256. Defaults to "sha256".
  * @param upper 返回的结果是否需要大写. Defaults to False.
  */
-export function hashDigest(d, algorithm = 'sha256', upper = false) {
-    const hashed = createHash(algorithm).update(d).digest('hex');
+export function hashDigest(d, algorithm = "sha256", upper = false) {
+    const hashed = createHash(algorithm).update(d).digest("hex");
     return upper ? hashed.toUpperCase() : hashed;
 }
 /**
@@ -15,15 +15,15 @@ export function hashDigest(d, algorithm = 'sha256', upper = false) {
  */
 export async function keyPair() {
     return new Promise((resolve, reject) => {
-        generateKeyPair('rsa', {
+        generateKeyPair("rsa", {
             modulusLength: 2048,
             publicKeyEncoding: {
-                type: 'spki',
-                format: 'pem',
+                type: "spki",
+                format: "pem",
             },
             privateKeyEncoding: {
-                type: 'pkcs8',
-                format: 'pem',
+                type: "pkcs8",
+                format: "pem",
             },
         }, (err, publicKey, privateKey) => {
             if (err == null) {
@@ -44,10 +44,13 @@ export async function keyPair() {
  */
 export function aesEncrypt(key, input, upper = false) {
     const iv = randomBytes(16);
-    const cipher = createCipheriv('aes-256-cbc', Buffer.from(key, 'hex'), iv);
-    let encryptedData = cipher.update(input, 'utf-8', 'hex');
-    encryptedData += cipher.final('hex');
-    return [upper === true ? encryptedData.toUpperCase() : encryptedData, iv.toString('hex')];
+    const cipher = createCipheriv("aes-256-cbc", Buffer.from(key, "hex"), iv);
+    let encryptedData = cipher.update(input, "utf-8", "hex");
+    encryptedData += cipher.final("hex");
+    return [
+        upper === true ? encryptedData.toUpperCase() : encryptedData,
+        iv.toString("hex"),
+    ];
 }
 /**
  * AES 解密
@@ -57,9 +60,9 @@ export function aesEncrypt(key, input, upper = false) {
  * @returns
  */
 export function aesDecrypt(input, key, iv) {
-    const cipher = createDecipheriv('aes-256-cbc', Buffer.from(key, 'hex'), Buffer.from(iv, 'hex'));
-    let decryptedData = cipher.update(input, 'hex', 'utf-8');
-    decryptedData += cipher.final('utf-8');
+    const cipher = createDecipheriv("aes-256-cbc", Buffer.from(key, "hex"), Buffer.from(iv, "hex"));
+    let decryptedData = cipher.update(input, "hex", "utf-8");
+    decryptedData += cipher.final("utf-8");
     return decryptedData;
 }
 /**
@@ -71,8 +74,8 @@ export function aesDecrypt(input, key, iv) {
 export function rsaEncrypt(input, publicKey) {
     return publicEncrypt({
         key: publicKey,
-        oaepHash: 'sha256',
-    }, Buffer.from(input)).toString('base64');
+        oaepHash: "sha256",
+    }, Buffer.from(input)).toString("base64");
 }
 /**
  * RSA 解密
@@ -83,6 +86,6 @@ export function rsaEncrypt(input, publicKey) {
 export function rsaDecrypt(encrtypData, privateKey) {
     return privateDecrypt({
         key: privateKey,
-        oaepHash: 'sha256',
-    }, Buffer.from(encrtypData, 'base64')).toString('utf-8');
+        oaepHash: "sha256",
+    }, Buffer.from(encrtypData, "base64")).toString("utf-8");
 }

package/lib/date.d.ts

@@ -34,15 +34,17 @@ export declare function endOf(date?: Date | string | number, unit?: string): Dat
 /**
  * 获取时间戳
  * @param ctime 时间
- * @param unit 时间戳长度
+ * @param pre 精度, s - 精确到秒, ms - 精确到毫秒, 默认: s
  * @returns
  */
-export declare function timeStamp(ctime?: Date | string | number, unit?: 's' | 'ms'): number;
+export declare function timeStamp(ctime?: Date | string | number, pre?: "s" | "ms"): number;
 /**
  * 日期加上指定时间后的日期
  * @param date 指定的日期
  * @param num  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit 需要添加的单位，date - 加减天数
+ * @param unit 需要添加的单位，date、month、year、hours、minute、second
+ *
+ * 查阅文档: {@link https://gitee.com/towardly/ph/wikis/utils/date ph-utils}
  */
 export declare function add(date: Date | string | number | null, num: number, unit: string): Date;
 /**

package/lib/date.js

@@ -10,13 +10,19 @@ const ofArgs = {
     end: [0, 11, -2, 23, 59, 59, 999],
 };
 const units = {
-    Date: ['date', 'Date', 'day', 'Day', 'D', 'd'],
-    Month: ['Month', 'month', 'm'],
-    Year: ['Year', 'year', 'y'],
-    Hours: ['Hours', 'hours', 'H'],
-    Minutes: ['Minutes', 'Minute', 'minute', 'minutes', 'M'],
-    Seconds: ['Seconds', 'seconds', 'Second', 'second', 's'],
-    Milliseconds: ['Milliseconds', 'Millisecond', 'milliseconds', 'illisecond', 'S'],
+    Date: ["date", "Date", "day", "Day", "D", "d"],
+    Month: ["Month", "month", "m"],
+    Year: ["Year", "year", "y"],
+    Hours: ["Hours", "hours", "H"],
+    Minutes: ["Minutes", "Minute", "minute", "minutes", "M"],
+    Seconds: ["Seconds", "seconds", "Second", "second", "s"],
+    Milliseconds: [
+        "Milliseconds",
+        "Millisecond",
+        "milliseconds",
+        "illisecond",
+        "S",
+    ],
 };
 /**
  * 不足位数, 前位补 0
@@ -29,7 +35,7 @@ function p(s, l = 2) {
      * 由于年份最多为4为，所以前面先添3个0
      * slice() 从后开始提前字符串
      */
-    return ('000' + s).slice(l * -1);
+    return `000${s}`.slice(l * -1);
 }
 /**
  * 将单位转换为首字母大写, 例如：hours -> Hours
@@ -38,7 +44,7 @@ function p(s, l = 2) {
  */
 function getUnit(unit) {
     let period = null;
-    for (let [key, value] of Object.entries(units)) {
+    for (const [key, value] of Object.entries(units)) {
         if (value.includes(unit)) {
             period = key;
             break;
@@ -68,16 +74,16 @@ function getLastDayOfYear(date, month) {
  * @param date      日期
  * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
  */
-export function format(date, pattern = 'yyyy-mm-dd HH:MM') {
+export function format(date, pattern = "yyyy-mm-dd HH:MM") {
     // eslint-disable-next-line
     date = parse(date);
-    let d = date.getDate();
-    let y = date.getFullYear();
-    let m = date.getMonth();
-    let H = date.getHours();
-    let M = date.getMinutes();
-    let s = date.getSeconds();
-    let flags = {
+    const d = date.getDate();
+    const y = date.getFullYear();
+    const m = date.getMonth();
+    const H = date.getHours();
+    const M = date.getMinutes();
+    const s = date.getSeconds();
+    const flags = {
         yy: p(y),
         yyyy: y,
         m: m + 1,
@@ -111,13 +117,13 @@ export function parse(date) {
         return new Date();
     if (date instanceof Date)
         return date;
-    if (typeof date === 'string' && !/Z$/i.test(date)) {
+    if (typeof date === "string" && !/Z$/i.test(date)) {
         const d = date.match(REGEX_PARSE);
         if (d) {
             return new Date(d[1], d[2] - 1, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, d[7] || 0);
         }
     }
-    if (typeof date === 'number') {
+    if (typeof date === "number") {
         return new Date(date <= 9999999999 ? date * 1000 : date);
     }
     return new Date();
@@ -130,18 +136,28 @@ export function parse(date) {
  */
 export function dateOf(date, unit, isEnd = false) {
     /* 如果是设置某一天的开始时刻, 就需要将时、分、秒、毫秒设置为0，依次类推设置 */
-    const periods = ['Year', 'Month', 'Date', 'Hours', 'Minutes', 'Seconds', 'Milliseconds'];
-    let index = periods.indexOf(getUnit(unit || 'Date'));
+    const periods = [
+        "Year",
+        "Month",
+        "Date",
+        "Hours",
+        "Minutes",
+        "Seconds",
+        "Milliseconds",
+    ];
+    let index = periods.indexOf(getUnit(unit || "Date"));
     const clone = parse(date);
     index++;
-    const setValues = ofArgs[isEnd === true ? 'end' : 'start'];
+    const setValues = ofArgs[isEnd === true ? "end" : "start"];
     for (const len = periods.length; index < len; index++) {
         let value = setValues[index];
         if (value === -2) {
             // 设置为某个月的最后一天的日期
             value = getLastDayOfYear(clone);
         }
-        Date.prototype['set' + periods[index]].apply(clone, [setValues[index]]);
+        Date.prototype["set" + periods[index]].apply(clone, [
+            setValues[index],
+        ]);
     }
     return clone;
 }
@@ -166,12 +182,12 @@ export function endOf(date, unit) {
 /**
  * 获取时间戳
  * @param ctime 时间
- * @param unit 时间戳长度
+ * @param pre 精度, s - 精确到秒, ms - 精确到毫秒, 默认: s
  * @returns
  */
-export function timeStamp(ctime, unit = 's') {
+export function timeStamp(ctime, pre = "s") {
     let tm = parse(ctime).getTime();
-    return unit === 's' ? Math.floor(tm / 1000) : tm;
+    return pre === "s" ? Math.floor(tm / 1000) : tm;
 }
 /**
  * 日期加上指定时间后的日期
@@ -188,13 +204,13 @@ export function add(date, num, unit, fmt) {
     }
     // eslint-disable-next-line
     unit = getUnit(unit);
-    let fn = 'set' + unit;
-    let gn = 'get' + unit;
+    let fn = "set" + unit;
+    let gn = "get" + unit;
     // @ts-ignore
     let oldValue = Date.prototype[gn].apply(sdate);
     // @ts-ignore
     Date.prototype[fn].apply(sdate, [oldValue + num]);
-    if (typeof fmt === 'string') {
+    if (typeof fmt === "string") {
         return format(sdate, fmt);
     }
     else {

package/lib/index.d.ts

@@ -80,4 +80,10 @@ export declare class BaseError extends Error {
  * @return string
  */
 export declare function formatMoney(number: number): string;
+/**
+ * 将风格由大写风格转换为下划线风格: IconFont -> icon_font
+ * @param name 命名, 例如: IconFont
+ * @param connector 连接符, 默认为: _
+ */
+export declare function snakeCaseStyle(name: string, connector?: string): string;
 export {};

package/lib/index.js

@@ -2,9 +2,9 @@
  * node 和 web 通用的工具类
  */
 /** 包含字母+数字的随机数字符 */
-const RANDOM_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+const RANDOM_CHARS = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
 /** 只包含字母的随机数字符 */
-const NUMBER_RANDOM_CHARTS = '0123456789';
+const NUMBER_RANDOM_CHARTS = "0123456789";
 /**
  * 验证字符串是否为空
  * @param str               待验证的字符串
@@ -22,14 +22,14 @@ export function isBlank(str, ignoreWhitespace = true) {
  * @returns 屏蔽后的手机号，例如：123 **** 1234
  */
 export function shieldMobile(mobile) {
-    let x1 = Math.floor(mobile.length / 2);
-    let x2 = Math.ceil(x1 / 2);
-    let shields = [' '];
+    const x1 = Math.floor(mobile.length / 2);
+    const x2 = Math.ceil(x1 / 2);
+    const shields = [" "];
     for (let i = 0; i < x1 - 1; i++) {
-        shields.push('*');
+        shields.push("*");
     }
-    shields.push(' ');
-    return mobile.substring(0, x2) + shields.join('') + mobile.substring(x2 + x1 - 1);
+    shields.push(" ");
+    return (mobile.substring(0, x2) + shields.join("") + mobile.substring(x2 + x1 - 1));
 }
 /**
  * 验证参数是否是数字
@@ -41,9 +41,9 @@ export function shieldMobile(mobile) {
  */
 export function isNumeric(str, numericParam) {
     numericParam = { isPositive: false, isFloat: true, ...(numericParam || {}) };
-    let symbol = numericParam.isPositive ? '[+]?' : '[+-]?';
-    let main = numericParam.isFloat ? '([0-9]*[.])?[0-9]+' : '[0-9]+';
-    return new RegExp('^' + symbol + main + '$').test(str);
+    const symbol = numericParam.isPositive ? "[+]?" : "[+-]?";
+    const main = numericParam.isFloat ? "([0-9]*[.])?[0-9]+" : "[0-9]+";
+    return new RegExp("^" + symbol + main + "$").test(str);
 }
 /**
  * 验证参数是否是Boolean 类型
@@ -51,7 +51,7 @@ export function isNumeric(str, numericParam) {
  * @returns
  */
 export function isBoolean(str) {
-    return ['true', 'false'].indexOf(str) >= 0;
+    return ["true", "false"].indexOf(str) >= 0;
 }
 /**
  * 生成随机数
@@ -61,7 +61,7 @@ export function isBoolean(str) {
  * @returns
  */
 export function random(opts) {
-    if (typeof opts === 'object' && opts.min != null && opts.max != null) {
+    if (typeof opts === "object" && opts.min != null && opts.max != null) {
         const randomNum = Math.random();
         /* 生成两个数字之间的随机数(number) */
         const end = opts.hasEnd ? 1 : 0;
@@ -69,18 +69,20 @@ export function random(opts) {
         return opts.isInteger !== false ? Math.floor(resRandom) : resRandom;
     }
     else {
-        if (typeof opts === 'object' && opts.length == null) {
-            throw new Error('random_length_cannot_null');
+        if (typeof opts === "object" && opts.length == null) {
+            throw new Error("random_length_cannot_null");
         }
-        const len = typeof opts === 'object' ? opts.length : opts;
+        const len = typeof opts === "object" ? opts.length : opts;
         /* 生成指定长度的随机数 */
         const charLens = RANDOM_CHARS.length;
         let chars = RANDOM_CHARS;
-        if (typeof opts === 'object' && opts.hasLetter === false) {
+        if (typeof opts === "object" && opts.hasLetter === false) {
             chars = NUMBER_RANDOM_CHARTS;
         }
-        const resRandom = Array.from({ length: len }, () => chars.charAt(Math.floor(Math.random() * charLens))).join('');
-        if (typeof opts === 'object' && opts.firstIsZero === false && resRandom.indexOf('0') === 0) {
+        const resRandom = Array.from({ length: len }, () => chars.charAt(Math.floor(Math.random() * charLens))).join("");
+        if (typeof opts === "object" &&
+            opts.firstIsZero === false &&
+            resRandom.indexOf("0") === 0) {
             return random(opts);
         }
         else {
@@ -100,7 +102,7 @@ export class BaseError extends Error {
     constructor() {
         if (arguments.length === 1) {
             super(arguments[0]);
-            this.name = 'BaseError';
+            this.name = "BaseError";
         }
         else {
             super(arguments[1]);
@@ -114,25 +116,40 @@ export class BaseError extends Error {
  * @return string
  */
 export function formatMoney(number) {
-    if (typeof Intl.NumberFormat !== 'undefined') {
-        const formatter = new Intl.NumberFormat('zh-CN', {
-            style: 'decimal',
+    if (typeof Intl.NumberFormat !== "undefined") {
+        const formatter = new Intl.NumberFormat("zh-CN", {
+            style: "decimal",
             maximumFractionDigits: 2,
         });
         return formatter.format(number);
     }
     else {
         number = number || 0;
-        let negative = '';
-        let base = String(parseInt(number, 10)); // 获取数字整数部分
-        let mod = base.length > 3 ? base.length % 3 : 0;
+        const negative = "";
+        const base = String(parseInt(number, 10)); // 获取数字整数部分
+        const mod = base.length > 3 ? base.length % 3 : 0;
         /*
          * 利用 正则前瞻 (?=) 将3位数字后面还紧跟一位数字的三位数字替换为 数字, 的形式
          */
-        let numberStr = String(number);
-        let usePrecision = numberStr.indexOf('.');
-        let dotStr = usePrecision > 0 ? numberStr.slice(usePrecision + 1) : '00';
+        const numberStr = String(number);
+        const usePrecision = numberStr.indexOf(".");
+        let dotStr = usePrecision > 0 ? numberStr.slice(usePrecision + 1) : "00";
         dotStr = dotStr.length > 2 ? dotStr.slice(0, 2) : dotStr;
-        return (negative + (mod ? base.slice(0, mod) + ',' : '') + base.slice(mod).replace(/(\d{3})(?=\d)/g, '$1,') + '.' + dotStr);
+        return (negative +
+            (mod ? base.slice(0, mod) + "," : "") +
+            base.slice(mod).replace(/(\d{3})(?=\d)/g, "$1,") +
+            "." +
+            dotStr);
     }
 }
+/**
+ * 将风格由大写风格转换为下划线风格: IconFont -> icon_font
+ * @param name 命名, 例如: IconFont
+ * @param connector 连接符, 默认为: _
+ */
+export function snakeCaseStyle(name, connector = "_") {
+    const snakeName = name.replace(/([A-Z])/g, (match) => {
+        return `${connector}${match.toLowerCase()}`;
+    });
+    return snakeName[0] === connector ? snakeName.substring(1) : snakeName;
+}

package/lib/storage.d.ts

@@ -1,7 +1,7 @@
 /**
  * 缓存相关
  */
-type StorageType = 'session' | 'local';
+type StorageType = "session" | "local";
 interface StorageSetOption {
     storage?: StorageType;
     /** 数据有效期, 单位秒, 默认: -1 - 永久存储 */

package/lib/storage.js

@@ -1,5 +1,5 @@
-function getStorage(storage = 'session') {
-    return storage === 'session' ? sessionStorage : localStorage;
+function getStorage(storage = "session") {
+    return storage === "session" ? sessionStorage : localStorage;
 }
 /**
  * 存储值到 Storage 中
@@ -9,7 +9,11 @@ function getStorage(storage = 'session') {
  * @param expire 数据有效期, 单位秒, 默认: -1 - 永久存储
  */
 export function set(key, value, option) {
-    const opts = { expire: -1, storage: 'session', ...(option || {}) };
+    const opts = {
+        expire: -1,
+        storage: "session",
+        ...(option || {}),
+    };
     const saveData = JSON.stringify({
         value,
         time: Date.now(),
@@ -41,7 +45,7 @@ export function remove(key, storage) {
  * @returns Storage 中 key 对应的数据
  */
 export function get(key, defaultValue, option) {
-    let opts = (option || { delete: false });
+    const opts = (option || { delete: false });
     const storage = getStorage(opts.storage);
     let data = storage.getItem(key);
     if (data == null) {

package/package.json

@@ -48,7 +48,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.4.0",
+  "version": "0.4.2",
   "type": "module",
   "repository": {
     "type": "git",