ziya-utils 1.0.2 → 1.0.31

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 glk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+### 搭建步骤
+```bash
+# npm init
+npm init -y
+
+# typescript 环境
+yarn add typescript -D
+
+tsc --init
+
+# package.json 修改
+- "main": "index.js",
++ "main": "./dist/index.cjs.js",
++ "module": "./dist/index.esm.js",
++ "types": "./dist/index.d.ts",
++ "files": [
++   "dist"
++ ],
+
+# rollup打包环境
+yarn add rollup @rollup/plugin-typescript @rollup/plugin-node-resolve @rollup/plugin-commonjs tslib -D
+
+# 配置 rollup.config.js
+import resolve from '@rollup/plugin-node-resolve';
+import typescript from '@rollup/plugin-typescript';
+import commonjs from '@rollup/plugin-commonjs';
+
+export default [
+  {
+    input: './src/index.ts',
+    output: {
+      dir: 'dist',
+      format: 'cjs',
+      entryFileNames: '[name].cjs.js',
+    },
+    plugins: [resolve(), commonjs(), typescript()],
+  }, {
+    input: './src/index.ts',
+    output: {
+      dir: 'dist',
+      format: 'esm',
+      entryFileNames: '[name].esm.js',
+    },
+    plugins: [resolve(), commonjs(), typescript()],
+  }
+];
+
+# 修改 scripts
+"scripts": {
++  "dev": "rollup -w -c",
++  "build": "rollup -c"
+-  "test": "echo \"Error: run tests from root\" && exit 1"
+},
+
+```
+
+
+### 核心结构
+- 正则表达式
+- 安全工具
+- 日期时间
+- websocket
+- 串口通信

package/dist/date/index.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 判断时间戳格式是否正确且有意义
+ * @param timestamp 要验证的时间戳，可以是数字或字符串
+ * @returns 如果时间戳格式正确且有意义则返回true，否则返回false
+ */
+declare function isValidTimestamp(timestamp: string | number): boolean;
+/**
+ * 是不是秒级时间戳
+ * @param timestamp
+ * @returns
+ */
+declare const isSecondTimestamp: (timestamp: string | number) => boolean;
+/**
+ * 是不是毫秒级时间戳
+ * @param timestamp
+ * @returns
+ */
+declare const isMillisecondTimestamp: (timestamp: string | number) => boolean;
+/**
+ * 计算传入时间戳和当前时间的时间差
+ * @param timestamp 时间戳
+ * @returns
+ */
+declare const getElapsedTimeSince: (timestamp: number) => {
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export { isValidTimestamp, isSecondTimestamp, isMillisecondTimestamp, getElapsedTimeSince, };

package/dist/date/index.js

@@ -0,0 +1,76 @@
+/**
+ * 判断时间戳格式是否正确且有意义
+ * @param timestamp 要验证的时间戳，可以是数字或字符串
+ * @returns 如果时间戳格式正确且有意义则返回true，否则返回false
+ */
+function isValidTimestamp(timestamp) {
+    // 如果是字符串，尝试转换为数字
+    if (typeof timestamp === "string") {
+        // 检查是否只包含数字
+        if (!/^\d+$/.test(timestamp)) {
+            return false;
+        }
+        timestamp = Number(timestamp);
+    }
+    // 检查是否为数字且不为NaN
+    if (typeof timestamp !== "number" || isNaN(timestamp)) {
+        return false;
+    }
+    // 检查时间戳范围是否合理
+    // 时间戳下限：1970年1月1日
+    var minTimestamp = 0;
+    // 时间戳上限：设置为一个合理的未来日期，例如2100年1月1日
+    var maxTimestamp = 4102444800000; // 2100-01-01的毫秒时间戳
+    // 检查时间戳是否为13位（毫秒级）或10位（秒级）
+    if (timestamp.toString().length === 13) {
+        // 毫秒级时间戳
+        return timestamp >= minTimestamp && timestamp <= maxTimestamp;
+    }
+    else if (timestamp.toString().length === 10) {
+        // 秒级时间戳，转换为毫秒级进行比较
+        return timestamp >= minTimestamp / 1000 && timestamp <= maxTimestamp / 1000;
+    }
+    // 不符合常见的时间戳长度
+    return false;
+}
+/**
+ * 是不是秒级时间戳
+ * @param timestamp
+ * @returns
+ */
+var isSecondTimestamp = function (timestamp) {
+    return isValidTimestamp(timestamp) && timestamp.toString().length === 10;
+};
+/**
+ * 是不是毫秒级时间戳
+ * @param timestamp
+ * @returns
+ */
+var isMillisecondTimestamp = function (timestamp) {
+    return isValidTimestamp(timestamp) && timestamp.toString().length === 13;
+};
+/**
+ * 计算传入时间戳和当前时间的时间差
+ * @param timestamp 时间戳
+ * @returns
+ */
+var getElapsedTimeSince = function (timestamp) {
+    var now = Date.now();
+    if (!isValidTimestamp(timestamp)) {
+        timestamp = now;
+    }
+    var diff = Math.max(0, now - (isSecondTimestamp(timestamp) ? timestamp * 1000 : timestamp));
+    // 计算小时
+    var hours = Math.floor(diff / (1000 * 60 * 60));
+    // 计算分钟
+    var minutes = Math.floor((diff % (1000 * 60 * 60)) / (1000 * 60));
+    // 计算秒
+    var seconds = Math.floor((diff % (1000 * 60)) / 1000);
+    return {
+        hours: hours,
+        minutes: minutes,
+        seconds: seconds,
+    };
+};
+
+export { getElapsedTimeSince, isMillisecondTimestamp, isSecondTimestamp, isValidTimestamp };

package/dist/file/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 获取文件名
+ * @param file_path 文件路径
+ * @returns
+ */
+declare const getFileName: (file_path: string) => string;
+/**
+ * 文件下载
+ * @param url 文件路径
+ * @param name 文件名
+ */
+declare const downloadFile: (url: string, name?: string) => Promise<void>;
+export { getFileName, downloadFile };

package/dist/file/index.js

@@ -0,0 +1,45 @@
+import { __awaiter, __generator } from '../node_modules/tslib/tslib.es6.js';
+
+/**
+ * 获取文件名
+ * @param file_path 文件路径
+ * @returns
+ */
+var getFileName = function (file_path) {
+    if (!file_path) {
+        return "";
+    }
+    var index = file_path.lastIndexOf("/");
+    if (index === -1) {
+        return "";
+    }
+    return file_path.substring(index + 1);
+};
+/**
+ * 文件下载
+ * @param url 文件路径
+ * @param name 文件名
+ */
+var downloadFile = function (url, name) { return __awaiter(void 0, void 0, void 0, function () {
+    var fileName, blob, blobUrl, link;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                fileName = name || getFileName(url);
+                return [4 /*yield*/, fetch(url).then(function (response) { return response.blob(); })];
+            case 1:
+                blob = _a.sent();
+                blobUrl = URL.createObjectURL(new Blob([blob]));
+                link = document.createElement("a");
+                link.href = blobUrl;
+                link.download = fileName;
+                document.body.appendChild(link);
+                link.click();
+                URL.revokeObjectURL(blobUrl);
+                link.remove();
+                return [2 /*return*/];
+        }
+    });
+}); };
+
+export { downloadFile, getFileName };

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./file";
+export * from "./time";
+export * from "./date";
+export * from "./security";
+export * from "./regexp";

package/dist/index.js

@@ -0,0 +1,5 @@
+export { downloadFile, getFileName } from './file/index.js';
+export { sleep } from './time/index.js';
+export { getElapsedTimeSince, isMillisecondTimestamp, isSecondTimestamp, isValidTimestamp } from './date/index.js';
+export { getUuid } from './security/index.js';
+export { RegexPatterns, RegexValidator } from './regexp/index.js';

package/dist/node_modules/tslib/tslib.es6.js

@@ -0,0 +1,75 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+var extendStatics = function(d, b) {
+    extendStatics = Object.setPrototypeOf ||
+        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+        function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+    return extendStatics(d, b);
+};
+
+function __extends(d, b) {
+    if (typeof b !== "function" && b !== null)
+        throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+    extendStatics(d, b);
+    function __() { this.constructor = d; }
+    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+}
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+export { __awaiter, __extends, __generator };

package/dist/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "ziya-utils",
+  "version": "1.0.31",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "dev": "rollup -w -c --bundleConfigAsCjs",
+    "build": "rollup -c --bundleConfigAsCjs"
+  },
+  "keywords": ["utils", "ziya", "tools", "javascript", "typescript"],
+  "author": "glk",
+  "license": "ISC",
+  "description": "ziya-utils",
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^25.0.3",
+    "@rollup/plugin-node-resolve": "^15.1.0",
+    "@rollup/plugin-strip": "^3.0.4",
+    "@rollup/plugin-typescript": "^11.1.2",
+    "rollup": "^3.26.3",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-node-externals": "5",
+    "tslib": "^2.6.0",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {},
+  "engines": {
+    "node": ">=16"
+  }
+}

package/dist/regexp/index.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 正则表达式工具模块
+ * @module RegexUtils
+ */
+/**
+ * 正则表达式模式类型定义
+ */
+interface IRegexPatterns {
+    /** 手机号码正则 */
+    readonly PHONE: RegExp;
+    /** 邮箱地址正则 */
+    readonly EMAIL: RegExp;
+    /** 身份证号码正则 */
+    readonly ID_CARD: RegExp;
+    /** URL地址正则 */
+    readonly URL: RegExp;
+    /** IPv4地址正则 */
+    readonly IPV4: RegExp;
+    /** 强密码正则 */
+    readonly STRONG_PASSWORD: RegExp;
+    /** 中文字符正则 */
+    readonly CHINESE: RegExp;
+}
+declare const RegexPatterns: IRegexPatterns;
+declare abstract class IRegexValidatorStatic {
+    static isPhone: (phone: string) => boolean;
+    static isEmail: (email: string) => boolean;
+    static isIdCard: (idCard: string) => boolean;
+    static isUrl: (url: string) => boolean;
+    static isIpv4: (ip: string) => boolean;
+    static isStrongPassword: (password: string) => boolean;
+    static isChinese: (text: string) => boolean;
+}
+declare class RegexValidator extends IRegexValidatorStatic {
+    static isPhone(phone: string): boolean;
+    static isEmail(email: string): boolean;
+    static isIdCard(idCard: string): boolean;
+    static isUrl(url: string): boolean;
+    static isIpv4(ip: string): boolean;
+    static isStrongPassword(password: string): boolean;
+    static isChinese(text: string): boolean;
+}
+/**
+ * 默认导出类型定义
+ */
+interface IRegexUtils {
+    patterns: IRegexPatterns;
+    validator: typeof RegexValidator;
+}
+export { RegexPatterns, RegexValidator, };
+export type { IRegexPatterns, IRegexUtils };
+declare const _default: IRegexUtils;
+export default _default;

package/dist/regexp/index.js

@@ -0,0 +1,59 @@
+import { __extends } from '../node_modules/tslib/tslib.es6.js';
+
+/**
+ * 正则表达式工具模块
+ * @module RegexUtils
+ */
+// 正则表达式常量
+var RegexPatterns = {
+    /** 手机号码正则 */
+    PHONE: /^1[3-9]\d{9}$/,
+    /** 邮箱地址正则 */
+    EMAIL: /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/,
+    /** 身份证号码正则(支持15位和18位) */
+    ID_CARD: /(^\d{15}$)|(^\d{17}(\d|X|x)$)/,
+    /** URL地址正则 */
+    URL: /^(https?:\/\/)?([\da-z.-]+)\.([a-z.]{2,6})([/\w .-]*)*\/?$/,
+    /** IPv4地址正则 */
+    IPV4: /^(\d{1,3}\.){3}\d{1,3}$/,
+    /** 强密码正则(至少8位，包含大小写字母、数字和特殊字符) */
+    STRONG_PASSWORD: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[@$!%*?&])[A-Za-z\d@$!%*?&]{8,}$/,
+    /** 中文字符正则 */
+    CHINESE: /^[\u4e00-\u9fa5]+$/
+};
+// 使用 `abstract class` 代替 `interface`，用于静态方法约束
+var IRegexValidatorStatic = /** @class */ (function () {
+    function IRegexValidatorStatic() {
+    }
+    return IRegexValidatorStatic;
+}());
+var RegexValidator = /** @class */ (function (_super) {
+    __extends(RegexValidator, _super);
+    function RegexValidator() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    RegexValidator.isPhone = function (phone) {
+        return RegexPatterns.PHONE.test(phone);
+    };
+    RegexValidator.isEmail = function (email) {
+        return RegexPatterns.EMAIL.test(email);
+    };
+    RegexValidator.isIdCard = function (idCard) {
+        return RegexPatterns.ID_CARD.test(idCard);
+    };
+    RegexValidator.isUrl = function (url) {
+        return RegexPatterns.URL.test(url);
+    };
+    RegexValidator.isIpv4 = function (ip) {
+        return RegexPatterns.IPV4.test(ip);
+    };
+    RegexValidator.isStrongPassword = function (password) {
+        return RegexPatterns.STRONG_PASSWORD.test(password);
+    };
+    RegexValidator.isChinese = function (text) {
+        return RegexPatterns.CHINESE.test(text);
+    };
+    return RegexValidator;
+}(IRegexValidatorStatic));
+
+export { RegexPatterns, RegexValidator };

package/dist/security/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 通用安全工具
+ */
+/**
+ * 生成通用唯一识别码（UUID）
+ * @returns
+ */
+declare const getUuid: () => string;
+export { getUuid, };

package/dist/security/index.js

@@ -0,0 +1,15 @@
+/**
+ * 通用安全工具
+ */
+/**
+ * 生成通用唯一识别码（UUID）
+ * @returns
+ */
+var getUuid = function () {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, function (c) {
+        var r = (Math.random() * 16) | 0, v = c == 'x' ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+};
+
+export { getUuid };

package/dist/time/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @fileoverview 时间模块
+ * @date 2025-04-02
+ * @author glk
+ */
+/**
+ * 休眠
+ * @param time - 休眠时间（s）
+ * @returns
+ */
+declare const sleep: (time: number) => Promise<unknown>;
+export { sleep, };

package/dist/time/index.js

@@ -0,0 +1,19 @@
+/**
+ * @fileoverview 时间模块
+ * @date 2025-04-02
+ * @author glk
+ */
+/**
+ * 休眠
+ * @param time - 休眠时间（s）
+ * @returns
+ */
+var sleep = function (time) {
+    return new Promise(function (resolve) {
+        setTimeout(function () {
+            resolve(true);
+        }, time * 1000);
+    });
+};
+
+export { sleep };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ziya-utils",
-  "version": "1.0.2",
+  "version": "1.0.31",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",
@@ -13,7 +13,7 @@
     "dev": "rollup -w -c --bundleConfigAsCjs",
     "build": "rollup -c --bundleConfigAsCjs"
   },
-  "keywords": [],
+  "keywords": ["utils", "ziya", "tools", "javascript", "typescript"],
   "author": "glk",
   "license": "ISC",
   "description": "ziya-utils",