ph-utils 0.20.1 → 1.0.0

package/lib/node.d.ts

@@ -0,0 +1,115 @@
+import { SpawnOptionsWithoutStdio } from "node:child_process";
+//#region src/crypto_node.d.ts
+type HashAlgorithmName = "md5" | SHAHashAlgorithmName;
+type SHAHashAlgorithmName = "sha1" | "sha256" | "sha512";
+type AESAlgorithmName = "aes-128-cbc" | "aes-192-cbc" | "aes-256-cbc";
+interface HashOptions {
+  algorithm?: HashAlgorithmName;
+  upper?: boolean;
+}
+interface HmacOptions {
+  algorithm?: SHAHashAlgorithmName;
+  upper?: boolean;
+}
+interface AESEncryptOptions {
+  algorithm?: AESAlgorithmName;
+  upper?: boolean;
+}
+interface AESDecryptOptions {
+  algorithm?: AESAlgorithmName;
+  encoding?: "hex" | "base64";
+}
+interface KeyPairOptions {
+  modulusLength?: 2048 | 3072 | 4096;
+}
+/**
+ * 计算数据的哈希摘要
+ * @example
+ * hash("hello world")
+ * // "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
+ */
+declare function hash(data: string, options?: HashOptions): string;
+/**
+ * @deprecated 请直接使用 hash 函数
+ */
+declare function hashDigest(data: string, options?: HashOptions): string;
+/**
+ * 使用 HMAC 算法对消息进行哈希处理
+ */
+declare function hmacHash(message: string, key: string, options?: HmacOptions): string;
+/**
+ * 生成 RSA 密钥对
+ */
+declare function generateRSAKeyPair(options?: KeyPairOptions): Promise<[string, string]>;
+declare function aesEncrypt(key: string, input: string, options?: AESEncryptOptions): [string, string];
+declare function aesDecrypt(input: string, key: string | Buffer, iv?: string | Buffer, options?: AESDecryptOptions): string;
+declare function rsaEncrypt(input: string, publicKey: string, encoding?: BufferEncoding): string;
+declare function rsaDecrypt(encryptedData: string, privateKey: string, encoding?: BufferEncoding): string;
+declare function generateAESKey(bits?: 128 | 192 | 256): string;
+declare function generateIV(): string;
+//#endregion
+//#region src/file.d.ts
+/**
+ * 读取文件内容
+ * @example <caption>1. 读取JSON文件, 内容为字符串列表</caption>
+ * read<string[]>('a.json', []);
+ * @example <caption>2. 读取JSON文件, 内容为对象</caption>
+ * read<{ name: string }>('b.json', {});
+ * @param filepath     文件路径
+ * @param defaultValue 文件不存在时默认值, 不传则抛异常, 如果传递的是对象形式则会将结果转换为 JSON
+ * @returns 文件内容
+ */
+declare function read<T>(filepath: string, defaultValue?: T): Promise<T>;
+/**
+ * 写入 JSON 格式的数据到文件
+ * @param file 待写入的文件
+ * @param data 待写入的数据
+ * @param opts 写入配置
+ * @property opts.json 是否写入 JSON 格式的数据，写入数据时对数据进行 JSON 格式化，默认为：true
+ * @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
+ */
+declare function write(file: string, data: any, opts?: {
+  json: boolean;
+  format: boolean;
+}): Promise<void>;
+/**
+ * 根据文件的 stat 获取文件的 etag
+ * @param filePath 文件地址
+ * @returns file stat etag
+ */
+declare function statTag(filePath: string): Promise<string>;
+//#endregion
+//#region src/server.d.ts
+/**
+ * 执行命令
+ * @param command 待执行的命令
+ * @param args    命令参数
+ */
+declare function exec(command: string, args?: string[]): Promise<{
+  stdout: string;
+  stderr: string;
+}>;
+declare function exec(command: string, options?: SpawnOptions): Promise<{
+  stdout: string;
+  stderr: string;
+}>;
+declare function exec(command: string, args?: string[], options?: SpawnOptions): Promise<{
+  stdout: string;
+  stderr: string;
+}>;
+type SpawnOptions = SpawnOptionsWithoutStdio & {
+  shell?: "powershell";
+};
+/**
+ * 执行命令并返回执行结果的Promise
+ * @param command 要执行的命令
+ * @param args 命令参数数组
+ * @param options 执行选项，支持指定shell类型
+ * @returns Promise对象，成功时resolve包含stdout和stderr的对象，失败时reject包含错误信息
+ */
+declare function spawn(command: string, args?: string[], options?: SpawnOptions): Promise<{
+  stdout: string;
+  stderr: string;
+}>;
+//#endregion
+export { AESAlgorithmName, AESDecryptOptions, AESEncryptOptions, HashAlgorithmName, HashOptions, HmacOptions, KeyPairOptions, SHAHashAlgorithmName, aesDecrypt, aesEncrypt, exec, generateAESKey, generateIV, generateRSAKeyPair, hash, hashDigest, hmacHash, read, rsaDecrypt, rsaEncrypt, spawn, statTag, write };

package/lib/node.js

@@ -0,0 +1,213 @@
+import { constants, createCipheriv, createDecipheriv, createHash, createHmac, generateKeyPair, privateDecrypt, publicEncrypt, randomBytes } from "node:crypto";
+import path from "node:path";
+import fs from "node:fs/promises";
+import { execFile, spawn as spawn$1 } from "node:child_process";
+import { promisify } from "node:util";
+//#region src/crypto_node.ts
+const DEFAULT_HASH_ALGORITHM = "sha256";
+const DEFAULT_AES_ALGORITHM = "aes-256-cbc";
+const DEFAULT_ENCODING = "hex";
+const IV_LENGTH = 16;
+const RSA_MODULUS_LENGTH = 2048;
+/**
+* 计算数据的哈希摘要
+* @example
+* hash("hello world")
+* // "b94d27b9934d3e08a52e52d7da7dabfac484efe37a5380ee9088f7ace2efcde9"
+*/
+function hash(data, options = {}) {
+	const { algorithm = DEFAULT_HASH_ALGORITHM, upper = false } = options;
+	const hashed = createHash(algorithm).update(data).digest("hex");
+	return upper ? hashed.toUpperCase() : hashed;
+}
+/**
+* @deprecated 请直接使用 hash 函数
+*/
+function hashDigest(data, options = {}) {
+	return hash(data, options);
+}
+/**
+* 使用 HMAC 算法对消息进行哈希处理
+*/
+function hmacHash(message, key, options = {}) {
+	const { algorithm = DEFAULT_HASH_ALGORITHM, upper = false } = options;
+	const hashed = createHmac(algorithm, key).update(message).digest("hex");
+	return upper ? hashed.toUpperCase() : hashed;
+}
+/**
+* 生成 RSA 密钥对
+*/
+async function generateRSAKeyPair(options = {}) {
+	const { modulusLength = RSA_MODULUS_LENGTH } = options;
+	return new Promise((resolve, reject) => {
+		generateKeyPair("rsa", {
+			modulusLength,
+			publicKeyEncoding: {
+				type: "spki",
+				format: "pem"
+			},
+			privateKeyEncoding: {
+				type: "pkcs8",
+				format: "pem"
+			}
+		}, (err, publicKey, privateKey) => {
+			if (err) reject(err);
+			else resolve([publicKey, privateKey]);
+		});
+	});
+}
+function aesEncrypt(key, input, options = {}) {
+	const { algorithm = DEFAULT_AES_ALGORITHM, upper = false } = options;
+	const requiredKeyLength = parseInt(algorithm.split("-")[1]) / 8;
+	const keyBuffer = Buffer.from(key, "hex");
+	if (keyBuffer.length !== requiredKeyLength) throw new Error(`Invalid key length for ${algorithm}: expected ${requiredKeyLength} bytes, got ${keyBuffer.length} bytes`);
+	const iv = randomBytes(IV_LENGTH);
+	const cipher = createCipheriv(algorithm, keyBuffer, iv);
+	let encryptedData = cipher.update(input, "utf-8", "hex");
+	encryptedData += cipher.final("hex");
+	return [upper ? encryptedData.toUpperCase() : encryptedData, iv.toString("hex")];
+}
+function aesDecrypt(input, key, iv, options = {}) {
+	const { algorithm = DEFAULT_AES_ALGORITHM, encoding = DEFAULT_ENCODING } = options;
+	const keyBuffer = Buffer.isBuffer(key) ? key : Buffer.from(key, "hex");
+	const requiredKeyLength = parseInt(algorithm.split("-")[1]) / 8;
+	if (keyBuffer.length !== requiredKeyLength) throw new Error(`Invalid key length for ${algorithm}: expected ${requiredKeyLength} bytes, got ${keyBuffer.length} bytes`);
+	const ivBuffer = iv ? Buffer.isBuffer(iv) ? iv : Buffer.from(iv, "hex") : Buffer.alloc(IV_LENGTH, 0);
+	const decipher = createDecipheriv(algorithm, keyBuffer, ivBuffer);
+	let decryptedData = decipher.update(input, encoding, "utf-8");
+	decryptedData += decipher.final("utf-8");
+	return decryptedData;
+}
+function rsaEncrypt(input, publicKey, encoding = "base64") {
+	return publicEncrypt({
+		key: publicKey,
+		oaepHash: "sha256",
+		padding: constants.RSA_PKCS1_OAEP_PADDING
+	}, Buffer.from(input, "utf-8")).toString(encoding);
+}
+function rsaDecrypt(encryptedData, privateKey, encoding = "base64") {
+	return privateDecrypt({
+		key: privateKey,
+		oaepHash: "sha256",
+		padding: constants.RSA_PKCS1_OAEP_PADDING
+	}, Buffer.from(encryptedData, encoding)).toString("utf-8");
+}
+function generateAESKey(bits = 256) {
+	return randomBytes(bits / 8).toString("hex");
+}
+function generateIV() {
+	return randomBytes(IV_LENGTH).toString("hex");
+}
+//#endregion
+//#region src/file.ts
+/** nodejs 文件操作工具类 */
+/**
+* 读取文件内容
+* @example <caption>1. 读取JSON文件, 内容为字符串列表</caption>
+* read<string[]>('a.json', []);
+* @example <caption>2. 读取JSON文件, 内容为对象</caption>
+* read<{ name: string }>('b.json', {});
+* @param filepath     文件路径
+* @param defaultValue 文件不存在时默认值, 不传则抛异常, 如果传递的是对象形式则会将结果转换为 JSON
+* @returns 文件内容
+*/
+async function read(filepath, defaultValue) {
+	let content;
+	try {
+		content = await fs.readFile(filepath, "utf8");
+		if (defaultValue != null && typeof defaultValue === "object") return JSON.parse(content);
+		return content;
+	} catch (error) {
+		if (defaultValue === void 0) throw error;
+		return defaultValue;
+	}
+}
+/**
+* 写入 JSON 格式的数据到文件
+* @param file 待写入的文件
+* @param data 待写入的数据
+* @param opts 写入配置
+* @property opts.json 是否写入 JSON 格式的数据，写入数据时对数据进行 JSON 格式化，默认为：true
+* @property opts.format 是否在写入 json 数据时，将 JSON 数据格式化2个空格写入, 默认为 true
+*/
+async function write(file, data, opts) {
+	let writeData = data.toString();
+	opts = {
+		json: true,
+		format: true,
+		...opts
+	};
+	if (opts.json === true && typeof data === "object") writeData = JSON.stringify(data, null, opts.format === true ? 2 : 0);
+	await fs.writeFile(path.resolve(file), writeData);
+}
+/**
+* 根据文件的 stat 获取文件的 etag
+* @param filePath 文件地址
+* @returns file stat etag
+*/
+async function statTag(filePath) {
+	let stat = await fs.stat(filePath);
+	return `${stat.size.toString(16)}-${stat.mtimeMs.toString(16)}`;
+}
+//#endregion
+//#region src/server.ts
+const execFilePromise = promisify(execFile);
+/**
+* 执行命令
+* @param cmd 执行的命令
+* @returns
+*/
+function exec(command, ...params) {
+	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];
+		} else opts = params[0];
+	}
+	return execFilePromise(cmd, argvs, opts);
+}
+/**
+* 执行命令并返回执行结果的Promise
+* @param command 要执行的命令
+* @param args 命令参数数组
+* @param options 执行选项，支持指定shell类型
+* @returns Promise对象，成功时resolve包含stdout和stderr的对象，失败时reject包含错误信息
+*/
+function spawn(command, args, options = {}) {
+	return new Promise((resolve, reject) => {
+		let execArgs = [];
+		let cmd;
+		if (options.shell === "powershell") {
+			cmd = "powershell.exe";
+			execArgs = [
+				"-NoProfile",
+				"-Command",
+				command,
+				...args || []
+			];
+		} else {
+			cmd = command;
+			execArgs = args || [];
+		}
+		delete options.shell;
+		const child = spawn$1(cmd, execArgs, options);
+		let stdout = "", stderr = "";
+		child.stdout.on("data", (d) => stdout += d);
+		child.stderr.on("data", (d) => stderr += d);
+		child.on("close", (code) => {
+			if (code === 0) resolve({
+				stdout,
+				stderr
+			});
+			else reject(/* @__PURE__ */ new Error(`spawn failed (${code}): ${stderr}`));
+		});
+		child.on("error", reject);
+	});
+}
+//#endregion
+export { aesDecrypt, aesEncrypt, exec, generateAESKey, generateIV, generateRSAKeyPair, hash, hashDigest, hmacHash, read, rsaDecrypt, rsaEncrypt, spawn, statTag, write };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ph-utils",
-  "version": "0.20.1",
+  "version": "1.0.0",
   "description": "js 开发工具集，前后端都可以使用(commonjs和es module)",
   "keywords": [
     "date",
@@ -25,75 +25,21 @@
     "lib"
   ],
   "type": "module",
-  "main": "lib/index.js",
-  "module": "lib/index.js",
+  "sideEffects": false,
   "browser": "lib/index.js",
   "types": "lib/index.d.ts",
   "exports": {
-    ".": {
-      "types": "./lib/index.d.ts",
-      "import": "./lib/index.js"
-    },
-    "./file": {
-      "types": "./lib/file.d.ts",
-      "import": "./lib/file.js"
-    },
-    "./date": {
-      "types": "./lib/date.d.ts",
-      "import": "./lib/date.js"
-    },
-    "./server": {
-      "types": "./lib/server.d.ts",
-      "import": "./lib/server.js"
-    },
-    "./validator": {
-      "types": "./lib/validator.d.ts",
-      "import": "./lib/validator.js"
-    },
-    "./crypto": {
-      "types": "./lib/crypto.d.ts",
-      "import": "./lib/crypto.js"
-    },
-    "./crypto_node": {
-      "types": "./lib/crypto_node.d.ts",
-      "import": "./lib/crypto_node.js"
-    },
-    "./web": {
-      "types": "./lib/web.d.ts",
-      "import": "./lib/web.js"
-    },
-    "./dom": {
-      "types": "./lib/dom.d.ts",
-      "import": "./lib/dom.js"
-    },
-    "./copy": {
-      "types": "./lib/copy.d.ts",
-      "import": "./lib/copy.js"
-    },
-    "./storage": {
-      "types": "./lib/storage.d.ts",
-      "import": "./lib/storage.js"
-    },
-    "./color": {
-      "types": "./lib/color.d.ts",
-      "import": "./lib/color.js"
-    },
-    "./logger": {
-      "types": "./lib/logger.d.ts",
-      "import": "./lib/logger.js"
-    },
-    "./array": {
-      "types": "./lib/array.d.ts",
-      "import": "./lib/array.js"
-    },
-    "./theme": {
-      "types": "./lib/theme.d.ts",
-      "import": "./lib/theme.js"
-    },
-    "./*": "./lib/*"
+    ".": "./lib/index.js",
+    "./browser": "./lib/browser.js",
+    "./node": "./lib/node.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsdown"
   },
   "devDependencies": {
     "@types/node": "^22.8.2",
+    "tsdown": "^0.22.14",
     "typescript": "^5.6.3"
   }
 }

package/lib/array.d.ts

@@ -1,79 +0,0 @@
-/**
- * 数组排序
- * @param arr 待排序数组
- * @param order 排序信息, asc - 升序, desc - 倒序
- * @param orderKey 如果是个对象数组，按哪个字段排序
- * @returns
- */
-export declare function order<T>(arr: T[], order?: "asc" | "desc", orderKey?: string | null): T[];
-/**
- * 返回一个所有集合交集的新集合
- *
- * 如果集合本身支持 intersection, 则调用原生 intersection 函数
- *
- * @param arrs
- *
- * @returns 新集合中的元素在传入的所有集合中同时存在
- */
-export declare function intersection<T>(...arrs: Set<T>[]): Set<T>;
-/**
- * 返回一个所有列表交集的新列表
- *
- * @param arrs
- *
- * @returns 新列表中的元素在传入的所有列表中同时存在
- */
-export declare function intersection<T>(...arrs: T[][]): T[];
-/**
- * 返回一个包含第一个集合中的元素但不包含后续给定集合中元素的新集合
- *
- * 如果集合本身支持 difference 方法，则调用原生 difference 方法
- *
- * @param arrs 集合列表
- *
- * @returns
- */
-export declare function difference<T>(...arrs: Set<T>[]): Set<T>;
-/**
- * 返回一个包含第一个列表中的元素但不包含后续给定列表中元素的新列表
- *
- * @param arrs 二维列表
- *
- * @returns
- */
-export declare function difference<T>(...arrs: T[][]): T[];
-/**
- * 返回多个集合的并集, 如果支持 union，则调用原生 union
- *
- * @param arrs
- *
- * @returns 一个包含所有给定集合的所有元素的新集合
- */
-export declare function union<T>(...arrs: Set<T>[]): Set<T>;
-export declare function union<T>(...arrs: T[][]): T[];
-export declare function symmetricDifference<T>(...arrs: Set<T>[]): Set<T>;
-export declare function symmetricDifference<T>(...arrs: T[][]): T[];
-/**
- * 返回一个布尔值，指示此集合中的所有元素是否都在给定的集合中。
- * @param a1
- * @param a2
- * @returns
- */
-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>): boolean;
-/**
- * 返回一个布尔值，指示此集合是否与给定集合没有公共元素。
- *
- * 判断两个集合是否有交集, 也可以通过 intersection(arr1, arr2).length 判断
- *
- * @param arr1
- * @param arr2
- * @returns
- */
-export declare function isDisjointFrom<T>(arr1: T[] | Set<T>, arr2: T[] | Set<T>): boolean;