pubo-node 1.0.198 → 1.0.202

package/README.md

@@ -0,0 +1,320 @@
+# pubo-node
+
+Node.js 工具库，提供文件存储、FTP 客户端、gRPC 客户端、进程管理、网络工具、ROS 主题管理和文件系统操作等功能。
+
+## 安装
+
+```bash
+npm install pubo-node
+```
+
+## API 文档
+
+### JsonStorage
+
+基于 JSON 的文件存储类，支持多进程同步。
+
+**构造函数**
+```typescript
+constructor(path: string, options: JsonStorageOptions = {})
+```
+- `path`: 存储文件路径
+- `options`: 可选配置
+  - `initialState`: 初始状态，程序运行时会重置为初始值
+  - `defaultState`: 默认状态
+
+**方法**
+- `async get(key?: string): Promise<any>`
+  - 获取指定键的值，不传键则返回整个状态
+- `async set(key: string, values: any): Promise<void>`
+  - 设置指定键的值
+- `async merge(values: any): Promise<void>`
+  - 合并多个键值到状态
+- `async remove(key: string): Promise<void>`
+  - 删除指定键
+
+### FtpClient
+
+FTP 客户端类，支持连接池和异步操作。
+
+**构造函数**
+```typescript
+constructor(options: FtpConnectOptions)
+```
+- `options`: 连接选项
+  - `user`: 用户名
+  - `host`: 主机地址
+  - `password`: 密码
+  - `driver`: FTP 驱动
+
+**方法**
+- `async get(path: string): Promise<Buffer>`
+  - 下载文件
+- `async put(input: string | Buffer | Stream, path: string): Promise<string>`
+  - 上传文件
+- `async delete(path: string): Promise<string>`
+  - 删除文件
+- `async list(path: string): Promise<FtpFile[]>`
+  - 列出目录文件
+- `async rename(path: string, old: string): Promise<string>`
+  - 重命名文件
+
+### FtpClientPool
+
+FTP 客户端连接池，管理多个 FTP 连接。
+
+**构造函数**
+```typescript
+constructor({ maxConnection = 5, ...options }: { maxConnection?: number } & FtpConnectOptions)
+```
+- `maxConnection`: 最大连接数，默认 5
+- `options`: 同 FtpClient 连接选项
+
+**方法**
+同 FtpClient 接口。
+
+### createRpcClient
+
+创建 gRPC 客户端。
+
+**函数签名**
+```typescript
+function createRpcClient<T>({ url, options = {}, ServiceImp, Grpc, cert }: CreateClientProps): T
+```
+- `url`: gRPC 服务地址
+- `options`: 连接选项
+- `ServiceImp`: 服务实现类
+- `Grpc`: gRPC 模块
+- `cert`: TLS 证书缓冲区
+
+### GrpcList
+
+全局 gRPC 客户端列表，用于管理所有创建的 gRPC 客户端。
+
+### isPortAvailable
+
+检查端口是否可用。
+
+**函数签名**
+```typescript
+function isPortAvailable(port: number): Promise<boolean>
+```
+
+### 进程管理函数
+
+以下函数由 `PProcess` 接口提供，具体实现根据操作系统（Linux/Windows）不同。
+
+#### getProcessName
+```typescript
+function getProcessName(pid: number): Promise<string>
+```
+获取进程名称。
+
+#### getPidByPort
+```typescript
+function getPidByPort(port: number): Promise<number>
+```
+根据端口号获取进程 PID。
+
+#### getProcessCpuUseByPid
+```typescript
+function getProcessCpuUseByPid(pid: number): Promise<number>
+```
+获取进程 CPU 使用率（百分比）。
+
+#### getProcessCommandByPid
+```typescript
+function getProcessCommandByPid(pid: number): Promise<string>
+```
+获取进程命令行。
+
+#### isProcessDied
+```typescript
+function isProcessDied(pid: number): Promise<boolean>
+```
+判断进程是否已死亡。
+
+#### getProcessByPpid
+```typescript
+function getProcessByPpid(ppid: number): Promise<number[]>
+```
+获取指定父进程的所有子进程 PID 列表。
+
+#### getProcessTree
+```typescript
+function getProcessTree(pid: number, tree?: any): Promise<any>
+```
+获取进程树结构。
+
+#### getProcessList
+```typescript
+function getProcessList(pid: number): Promise<number[]>
+```
+获取从叶子到根的所有进程 PID 列表。
+
+#### SIGKILL
+```typescript
+function SIGKILL(pid: number, signal = 2, times = 1): Promise<{ success: boolean; error: string }>
+```
+杀死进程及其子进程。
+
+#### heartbeat
+```typescript
+function heartbeat(): void
+```
+子进程心跳包，每6秒发送一次。
+
+#### getAudioCards
+```typescript
+function getAudioCards(filter?: string): Promise<{ text: string; index: string }[]>
+```
+获取音频设备列表（仅 Linux）。
+
+#### getDiskUsage
+```typescript
+function getDiskUsage(): Promise<DiskInfo[]>
+```
+获取磁盘使用情况。
+
+### 网络工具
+
+#### getNetworks
+```typescript
+function getNetworks(): Promise<any[]>
+```
+获取网络接口信息（通过 lshw 命令）。
+
+#### getWifiName
+```typescript
+function getWifiName(): Promise<string>
+```
+获取无线网络接口名称。
+
+### RosTopicManager
+
+ROS 主题管理器，用于创建和管理 ROS 主题。
+
+**方法**
+- `getTopic(topic: string, messageType: string): RosTopic`
+  - 获取或创建 ROS 主题实例
+
+### RosTopic
+
+ROS 主题类，支持订阅、取消订阅和发布消息。
+
+**构造函数**
+```typescript
+constructor(topic: string, messageType: string)
+```
+
+**方法**
+- `async subscribe(): Promise<void>`
+  - 订阅主题
+- `async unsubscribe(): Promise<void>`
+  - 取消订阅
+- `async publish(payload: any): Promise<void>`
+  - 发布消息到主题
+
+### PuboFileSystem
+
+文件系统操作接口，提供 Promise 化的 fs 方法。
+
+**方法**
+- `read<TBuffer extends NodeJS.ArrayBufferView>(fd: number, buffer?: TBuffer, offset?: number, length?: number, position?: fs.ReadPosition | null): Promise<[number, TBuffer]>`
+  - 从文件描述符读取数据
+- `stat(path: fs.PathLike): Promise<fs.Stats>`
+  - 获取文件状态
+- `readFile(path: fs.PathOrFileDescriptor, options?: { encoding?: null; flag?: string } & EventEmitter.Abortable | null): Promise<Buffer>`
+  - 读取文件内容
+- `writeFile(file: fs.PathOrFileDescriptor, data: string | NodeJS.ArrayBufferView, options?: fs.WriteFileOptions): Promise<void>`
+  - 写入文件
+- `readdir(path: fs.PathLike, options?: BufferEncoding | { encoding: BufferEncoding | null; withFileTypes: false } | null): Promise<string[]>`
+  - 读取目录内容
+- `open(path: fs.PathLike, flags?: fs.OpenMode, mode?: fs.Mode | null): Promise<number>`
+  - 打开文件
+- `close(fd: number): Promise<void>`
+  - 关闭文件描述符
+- `mkdir(path: fs.PathLike, options?: fs.MakeDirectoryOptions): Promise<void>`
+  - 创建目录
+- `rm(path: fs.PathLike): Promise<void>`
+  - 删除文件或目录
+- `write<TBuffer extends NodeJS.ArrayBufferView>(fd: number, buffer: TBuffer, offset?: number | null, length?: number | null, position?: number | null): Promise<void>`
+  - 写入数据到文件描述符
+
+### PProcess
+
+进程管理接口，定义了跨平台的进程操作方法。由 `PProcessLinux` 和 `PProcessWin32` 实现。
+
+**方法**
+参见上述进程管理函数。
+
+## 类型定义
+
+### FtpConnectOptions
+```typescript
+interface FtpConnectOptions {
+  user: string;
+  host: string;
+  password: string;
+  driver: any;
+}
+```
+
+### FtpFile
+```typescript
+interface FtpFile {
+  name: string;
+  owner: string;
+  group: string;
+  size: number;
+  date: Date;
+  type: string;
+}
+```
+
+### DiskInfo
+```typescript
+interface DiskInfo {
+  fileSystem: string;
+  size: number;
+  used: number;
+  avail: number;
+  usedPercent: number;
+  mounted: number;
+}
+```
+
+### JsonStorageOptions
+```typescript
+interface JsonStorageOptions {
+  initialState?: any;
+  defaultState?: any;
+}
+```
+
+## 示例
+
+```javascript
+const { JsonStorage, FtpClient, isPortAvailable } = require('pubo-node');
+
+// 使用 JsonStorage
+const storage = new JsonStorage('./data.json', { initialState: { count: 0 } });
+await storage.set('count', 1);
+const value = await storage.get('count');
+
+// 使用 FTP 客户端
+const ftp = new FtpClient({
+  user: 'user',
+  host: 'localhost',
+  password: 'pass',
+  driver: require('ftp')
+});
+const files = await ftp.list('/');
+
+// 检查端口
+const available = await isPortAvailable(8080);
+```
+
+## 许可证
+
+MIT

package/lib/child-process/index.d.ts

@@ -1,15 +1,18 @@
 export declare function getProcessName(pid: any): Promise<string>;
-export declare function getPidByPort(port: any): Promise<unknown>;
+export declare function getPidByPort(port: any): Promise<number>;
 export declare function getProcessCpuUseByPid(pid: number): Promise<number>;
 export declare function getProcessCommandByPid(pid: number): Promise<string>;
 export declare function isProcessDied(pid: number): Promise<boolean>;
 export declare function getProcessByPpid(pid: number): Promise<number[]>;
 export declare const getProcessTree: (pid: number, tree?: any) => Promise<any>;
 export declare const getProcessList: (pid: any) => Promise<number[]>;
-export declare function SIGKILL(pid: number, signal?: number, times?: number): Promise<unknown>;
+export declare function SIGKILL(pid: number, signal?: number, times?: number): Promise<{
+    success: boolean;
+    error: string;
+}>;
 export declare const heartbeat: () => void;
 export declare const getAudioCards: (filter?: string) => Promise<{
     text: string;
     index: string;
 }[]>;
-export declare const getDiskUsage: () => Promise<unknown>;
+export declare const getDiskUsage: () => Promise<import("./p-process-type").DiskInfo[]>;

package/lib/child-process/index.js

@@ -8,129 +8,33 @@ exports.getProcessCommandByPid = getProcessCommandByPid;
 exports.isProcessDied = isProcessDied;
 exports.getProcessByPpid = getProcessByPpid;
 exports.SIGKILL = SIGKILL;
-const child_process_1 = require("child_process");
 const pubo_utils_1 = require("pubo-utils");
+const linux_1 = require("./linux");
+const win32_1 = require("./win32");
+const processManager = process.platform === 'win32' ? new win32_1.PProcessWin32() : new linux_1.PProcessLinux();
 // 获取进程名称
 function getProcessName(pid) {
-    if (process.platform === 'win32') {
-        // 使用tasklist命令获取进程信息
-        return new Promise((resolve, reject) => {
-            (0, child_process_1.exec)(`tasklist /fi "PID eq ${pid}" /fo csv /nh`, (err, stdout) => {
-                if (err) {
-                    reject(err);
-                }
-                else {
-                    // 解析CSV格式的输出
-                    const match = stdout.match(/^"(.+?)"/);
-                    if (match && match[1]) {
-                        resolve(match[1]);
-                    }
-                    else {
-                        reject('process not found');
-                    }
-                }
-            });
-        });
-    }
-    return new Promise((resolve, reject) => {
-        (0, child_process_1.exec)(`grep "Name:" /proc/${pid}/status`, (err, data) => {
-            if (err) {
-                reject(err);
-            }
-            else {
-                resolve(data.toString().split(':')[1]?.trim());
-            }
-        });
-    });
+    return processManager.getProcessName(pid);
 }
 // 根据端口号获取进程PID
 async function getPidByPort(port) {
-    if (!port) {
-        return '';
-    }
-    if (process.platform === 'win32') {
-        return new Promise((resolve, reject) => {
-            (0, child_process_1.exec)(`netstat -ano | findstr "${port}"`, (error, stdout) => {
-                if (error) {
-                    reject(error);
-                    return;
-                }
-                const arr = stdout.split('\n');
-                if (!arr[0]) {
-                    resolve('');
-                    return;
-                }
-                const tmp = arr[0].split(' ');
-                const res = tmp.pop();
-                resolve(res);
-            });
-        });
-    }
-    return new Promise((resolve, reject) => {
-        (0, child_process_1.exec)(`lsof -i:${port} | awk '{print $2}'`, (err, stdout) => {
-            if (err) {
-                reject(err);
-            }
-            else {
-                let res = stdout.split('\n')[1];
-                if (res) {
-                    res = res.trim();
-                }
-                resolve(res);
-            }
-        });
-    });
+    return processManager.getPidByPort(port);
 }
 // 获取进程 cpu 使用率
 function getProcessCpuUseByPid(pid) {
-    return new Promise((resolve) => {
-        (0, child_process_1.exec)(`ps -p ${pid} -o %cpu=`, (err, stdout) => {
-            if (err) {
-                resolve(-1);
-            }
-            else {
-                resolve(parseFloat(stdout.toString()));
-            }
-        });
-    });
+    return processManager.getProcessCpuUseByPid(pid);
 }
 // 获取进程 command
 function getProcessCommandByPid(pid) {
-    return new Promise((resolve) => {
-        (0, child_process_1.exec)(`ps -p ${pid} -o command=`, (err, stdout) => {
-            if (err) {
-                resolve('');
-            }
-            else {
-                resolve(stdout.toString().split('\n')[0]);
-            }
-        });
-    });
+    return processManager.getProcessCommandByPid(pid);
 }
 // 判断进程是否死亡
 async function isProcessDied(pid) {
-    const used = await getProcessCpuUseByPid(pid);
-    // console.log(`pid: ${pid}, used: ${used}`);
-    return used < 0;
+    return processManager.isProcessDied(pid);
 }
 // 获取子进程
 function getProcessByPpid(pid) {
-    return new Promise((resolve) => {
-        let child = (0, child_process_1.exec)(`ps -o pid --no-headers --ppid ${pid}`, (err, stdout) => {
-            if (err) {
-                resolve([]);
-                child = null;
-            }
-            else {
-                resolve(stdout
-                    .split('\n')
-                    .filter((item) => !!item)
-                    .map((item) => parseInt(item.trim()))
-                    .filter((item) => item !== child.pid && !isNaN(item)));
-                child = null;
-            }
-        });
-    });
+    return processManager.getProcessByPpid(pid);
 }
 // 获取进程树
 const getProcessTree = async (pid, tree) => {
@@ -154,22 +58,6 @@ const getProcessTree = async (pid, tree) => {
     }
 };
 exports.getProcessTree = getProcessTree;
-// 杀死进程
-async function _SIGKILL(pid, signal = 2, times = 1) {
-    if (times > 5) {
-        throw new Error('SIGKILL 失败. times > 5');
-    }
-    await new Promise((resolve) => (0, child_process_1.exec)(`kill -${signal} ${pid}`, resolve));
-    try {
-        await (0, pubo_utils_1.waitFor)(async () => isProcessDied(pid), {
-            checkTime: 100,
-            timeout: 4000,
-        });
-    }
-    catch (err) {
-        await _SIGKILL(pid, 9, times + 1);
-    }
-}
 // 广度优先遍历进程树，将pid放入tmp
 const flatProcessTree = (tree, tmp) => {
     if (tree.children) {
@@ -195,23 +83,7 @@ const getProcessList = async (pid) => {
 exports.getProcessList = getProcessList;
 // 杀死进程以及子进程
 async function SIGKILL(pid, signal = 2, times = 1) {
-    if (process.platform === 'win32') {
-        return new Promise((resolve) => {
-            (0, child_process_1.exec)(`taskkill /pid ${pid} /T /F`, resolve);
-        });
-    }
-    const tmp = await (0, exports.getProcessList)(pid);
-    const res = { success: true, error: null };
-    for (const item of tmp) {
-        try {
-            await _SIGKILL(item, signal, times);
-        }
-        catch (err) {
-            res.error = err;
-            res.success = false;
-        }
-    }
-    return res;
+    return processManager.SIGKILL(pid, signal, times);
 }
 // 子进程心跳包
 const heartbeat = () => {
@@ -225,61 +97,17 @@ const heartbeat = () => {
     }, 6000);
 };
 exports.heartbeat = heartbeat;
-const parseAudioCard = (v) => {
-    let card = /card \d/.exec(v) ?? ['card 1'];
-    card = parseInt(card[0].replace('card ', ''), 10);
-    let device = /device \d/.exec(v) ?? ['device 0'];
-    device = parseInt(device[0].replace('device ', ''), 10);
-    return { text: v, index: `hw:${card},${device}` };
-};
 const getAudioCards = (filter = '') => {
-    if (process.platform === 'win32') {
-        return Promise.resolve([]);
+    if (processManager.getAudioCards) {
+        return processManager.getAudioCards(filter);
     }
-    return new Promise((resolve, reject) => {
-        (0, child_process_1.exec)(`arecord -l`, (err, stdout) => {
-            if (err) {
-                reject(err);
-            }
-            else {
-                const arr = stdout
-                    .toString()
-                    .split('\n')
-                    .filter((item) => item.includes('card') && (filter ? item.includes(filter) : true))
-                    .map((item) => parseAudioCard(item));
-                resolve(arr);
-            }
-        });
-    });
+    return Promise.resolve([]);
 };
 exports.getAudioCards = getAudioCards;
-const dic = ['fileSystem', 'size', 'used', 'avail', 'usedPercent', 'mounted'];
-const parser = (str) => {
-    return str
-        .split('\n')
-        .filter((item) => item)
-        .map((item) => item.split(' ').filter((s) => !!s))
-        .map((item) => {
-        const res = {};
-        dic.forEach((key, i) => (res[key] = item[i]));
-        return res;
-    })
-        .map((item) => ({
-        ...item,
-        total: parseFloat(item.size),
-        percentage: parseFloat(item['use%']),
-    }));
-};
 const getDiskUsage = async () => {
-    return new Promise((resolve) => {
-        (0, child_process_1.exec)('df -h | grep G', (err, stdout) => {
-            if (err) {
-                resolve([]);
-            }
-            else {
-                resolve(parser(stdout.toString()));
-            }
-        });
-    });
+    if (processManager.getDiskUsage) {
+        return processManager.getDiskUsage();
+    }
+    return Promise.resolve([]);
 };
 exports.getDiskUsage = getDiskUsage;

package/lib/child-process/linux.d.ts

@@ -11,4 +11,9 @@ export declare class PProcessLinux implements PProcess {
         success: boolean;
         error: string;
     }>;
+    getDiskUsage(): Promise<any>;
+    getAudioCards(filter?: string): Promise<{
+        text: string;
+        index: string;
+    }[]>;
 }

package/lib/child-process/linux.js

@@ -113,5 +113,58 @@ class PProcessLinux {
         }
         return res;
     }
+    async getDiskUsage() {
+        return new Promise((resolve) => {
+            (0, child_process_1.exec)('df -h | grep G', (err, stdout) => {
+                if (err) {
+                    resolve([]);
+                }
+                else {
+                    resolve(parser(stdout.toString()));
+                }
+            });
+        });
+    }
+    getAudioCards(filter = '') {
+        return new Promise((resolve, reject) => {
+            (0, child_process_1.exec)(`arecord -l`, (err, stdout) => {
+                if (err) {
+                    reject(err);
+                }
+                else {
+                    const arr = stdout
+                        .toString()
+                        .split('\n')
+                        .filter((item) => item.includes('card') && (filter ? item.includes(filter) : true))
+                        .map((item) => parseAudioCard(item));
+                    resolve(arr);
+                }
+            });
+        });
+    }
 }
 exports.PProcessLinux = PProcessLinux;
+const parseAudioCard = (v) => {
+    let card = /card \d/.exec(v) ?? ['card 1'];
+    card = parseInt(card[0].replace('card ', ''), 10);
+    let device = /device \d/.exec(v) ?? ['device 0'];
+    device = parseInt(device[0].replace('device ', ''), 10);
+    return { text: v, index: `hw:${card},${device}` };
+};
+const dic = ['fileSystem', 'size', 'used', 'avail', 'usedPercent', 'mounted'];
+const parser = (str) => {
+    return str
+        .split('\n')
+        .filter((item) => item)
+        .map((item) => item.split(' ').filter((s) => !!s))
+        .map((item) => {
+        const res = {};
+        dic.forEach((key, i) => (res[key] = item[i]));
+        return res;
+    })
+        .map((item) => ({
+        ...item,
+        total: parseFloat(item.size),
+        percentage: parseFloat(item['use%']),
+    }));
+};

package/lib/child-process/p-process-type.d.ts

@@ -17,8 +17,13 @@ export interface PProcess {
     getProcessCommandByPid(pid: number): Promise<string>;
     isProcessDied(pid: number): Promise<boolean>;
     getProcessByPpid(ppid: number): Promise<number[]>;
-    SIGKILL(pid: number): Promise<{
+    SIGKILL(pid: number, signal?: number, times?: number): Promise<{
         success: boolean;
         error: string;
     }>;
+    getDiskUsage?(): Promise<DiskInfo[]>;
+    getAudioCards?(filter?: string): Promise<{
+        text: string;
+        index: string;
+    }[]>;
 }

package/lib/child-process/win32.d.ts

@@ -6,8 +6,10 @@ export declare class PProcessWin32 implements PProcess {
     getProcessCommandByPid(pid: number): Promise<string>;
     isProcessDied(pid: number): Promise<boolean>;
     getProcessByPpid(ppid: number): Promise<number[]>;
-    SIGKILL(pid: number): Promise<{
+    SIGKILL(pid: number, signal?: number, times?: number): Promise<{
         success: boolean;
         error: string;
     }>;
+    getDiskUsage(): Promise<any>;
+    getAudioCards(): Promise<never[]>;
 }

package/lib/child-process/win32.js

@@ -103,12 +103,57 @@ class PProcessWin32 {
             });
         });
     }
-    async SIGKILL(pid) {
+    async SIGKILL(pid, signal, times) {
         return new Promise((resolve) => {
             (0, child_process_1.exec)(`taskkill /pid ${pid} /T /F`, (err) => {
                 resolve({ success: true, error: err.toString() });
             });
         });
     }
+    async getDiskUsage() {
+        return new Promise((resolve) => {
+            (0, child_process_1.exec)('wmic logicaldisk get Caption,FreeSpace,Size /format:csv', (err, stdout) => {
+                if (err) {
+                    resolve([]);
+                    return;
+                }
+                const lines = stdout.split('\r\n').filter((line) => line.trim() !== '');
+                // format:csv output has a header line "Node,Caption,FreeSpace,Size" usually.
+                // It might also have empty lines.
+                const disks = lines
+                    .map((line) => {
+                    // CSV parsing: simple split by comma
+                    const parts = line.split(',').map((s) => s.trim());
+                    if (parts.length < 4)
+                        return null; // Node, Caption, FreeSpace, Size
+                    // Header check
+                    if (parts[1] === 'Caption')
+                        return null;
+                    const caption = parts[1];
+                    const freeSpace = parseInt(parts[2]);
+                    const size = parseInt(parts[3]);
+                    if (isNaN(size) || isNaN(freeSpace))
+                        return null;
+                    const used = size - freeSpace;
+                    const usedPercent = size > 0 ? (used / size) * 100 : 0;
+                    return {
+                        fileSystem: caption,
+                        size: size, // bytes
+                        used: used,
+                        avail: freeSpace,
+                        usedPercent: `${usedPercent.toFixed(0)}%`,
+                        mounted: caption,
+                        total: size,
+                        percentage: parseFloat(usedPercent.toFixed(0)),
+                    };
+                })
+                    .filter((item) => item);
+                resolve(disks);
+            });
+        });
+    }
+    getAudioCards() {
+        return Promise.resolve([]);
+    }
 }
 exports.PProcessWin32 = PProcessWin32;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pubo-node",
-  "version": "1.0.198",
+  "version": "1.0.202",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "sideEffects": false,
@@ -18,10 +18,10 @@
   },
   "dependencies": {
     "@types/node": "^17.0.25",
-    "pubo-utils": "^1.0.198",
+    "pubo-utils": "^1.0.202",
     "yaml": "^2.5.1"
   },
-  "gitHead": "da780d47ff24acca2543274d7d3e82af581e1485",
+  "gitHead": "6cab20969ce73935cf78b48ddecfab0adca48174",
   "devDependencies": {
     "del": "^5.1.0",
     "eslint": "^8.42.0",