xshell 1.0.54 → 1.0.55

package/file.d.ts

@@ -55,7 +55,11 @@ export declare function fread_json<T = any>(fp: string, options?: {
     - data: 支持下面几种类型
         - string: 写入文本
         - Uint8Array, Buffer: 写入二进制 buffer
-        - any: 通过 JSON.stringify 转为文本后写入文件 */
+        - any: 通过 JSON.stringify 转为文本后写入文件
+    - options?:
+        - dir?: 文件夹
+        - print?
+        - mkdir: `false` 自动创建 fp 所在的文件夹 */
 export declare function fwrite(fp: string | FileHandle, data: string | Uint8Array | any, { dir, print, mkdir, }?: {
     dir?: string;
     print?: boolean;
@@ -104,6 +108,7 @@ export declare function fdelete(fp: string, { print }?: {
     print?: boolean;
 }): Promise<boolean>;
 /** 复制文件或文件夹  copy file or direcotry
+    会自动创建目标路径所在的文件夹
     - fp_src: 源 文件/文件夹 完整路径  src file/directory absolute path
     - fp_dst: 目标 文件/文件夹 完整路径  dst file/directory absolute path
     - options?:

package/file.js

@@ -59,7 +59,11 @@ export async function fread_json(fp, options = {}) {
     - data: 支持下面几种类型
         - string: 写入文本
         - Uint8Array, Buffer: 写入二进制 buffer
-        - any: 通过 JSON.stringify 转为文本后写入文件 */
+        - any: 通过 JSON.stringify 转为文本后写入文件
+    - options?:
+        - dir?: 文件夹
+        - print?
+        - mkdir: `false` 自动创建 fp 所在的文件夹 */
 export async function fwrite(fp, data, { dir, print = true, mkdir = false, } = {}) {
     const is_handle = typeof fp === 'object' && fp && 'fd' in fp;
     if (is_handle) {
@@ -81,10 +85,12 @@ export async function fwrite(fp, data, { dir, print = true, mkdir = false, } = {
         await fsp.writeFile(fp, data);
     }
     catch (error) {
-        if (!mkdir || error.code !== 'ENOENT' || is_handle)
+        if (mkdir && error.code === 'ENOENT' && !is_handle) {
+            await fmkdir(fp.fdir);
+            await fsp.writeFile(fp, data);
+        }
+        else
             throw error;
-        await fmkdir(fp.fdir);
-        await fsp.writeFile(fp, data);
     }
 }
 export async function fappend(fp, data, { dir, print = true } = {}) {
@@ -211,6 +217,7 @@ export async function fdelete(fp, { print = true } = {}) {
     }
 }
 /** 复制文件或文件夹  copy file or direcotry
+    会自动创建目标路径所在的文件夹
     - fp_src: 源 文件/文件夹 完整路径  src file/directory absolute path
     - fp_dst: 目标 文件/文件夹 完整路径  dst file/directory absolute path
     - options?:

package/net.browser.d.ts

@@ -63,12 +63,14 @@ export declare function request(url: string | URL, options: RequestOptions): Pro
 export declare function request_json<T = any>(url: string, options?: RequestOptions): Promise<T>;
 export declare class WebSocketConnectionError extends Error {
     name: string;
+    url: string;
+    protocols?: string[];
     websocket: WebSocket;
     event: CloseEvent | /* error 事件时的 event，没有 event.error */ Event;
     type: 'close' | 'error';
     code?: number;
     reason?: string;
-    constructor(websocket: WebSocket, event: CloseEvent | Event, message?: string);
+    constructor(url: string, protocols: string[] | undefined, event: CloseEvent | Event, message?: string);
 }
 /** 连接 websocket url, 设置各种事件监听器。在 open 事件后 resolve, 返回 websocket
     遇到 error 时会创建 WebSocketConnectionError:
@@ -86,7 +88,7 @@ export declare class WebSocketConnectionError extends Error {
         - on_close?: 和 websocket 的 'close' 事件不相同，只在正常关闭 (close code 为 1000) 时才调用，否则都会调用 on_error
             https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent#Status_codes  */
 export declare function connect_websocket(url: string | URL, { protocols, on_message, on_error, on_close, }: {
-    protocols?: string | string[];
+    protocols?: string[];
     on_message(data: ArrayBuffer | string, websocket: WebSocket): any;
     on_error?(error: WebSocketConnectionError, websocket: WebSocket): any;
     on_close?(event: CloseEvent, websocket: WebSocket): any;

package/net.browser.js

@@ -147,14 +147,18 @@ let decoder = new TextDecoder();
 let encoder = new TextEncoder();
 export class WebSocketConnectionError extends Error {
     name = 'WebSocketConnectionError';
+    // 这里不保留 websocket 引用，防止循环引用导致 JSON 序列化失败
+    url;
+    protocols;
     websocket;
     event;
     type;
     code;
     reason;
-    constructor(websocket, event, message) {
-        super(`${websocket.url} ${t('连接出错了')}. ${message || ''}`);
-        this.websocket = websocket;
+    constructor(url, protocols, event, message) {
+        super(`${url}${protocols ? ' ' + protocols.join(', ').bracket() : ''} ${t('连接出错了')}. ${message || ''}`);
+        this.url = url;
+        this.protocols = protocols;
         this.event = event;
         this.type = event.type;
         if (this.type === 'close') {
@@ -186,10 +190,7 @@ export async function connect_websocket(url, { protocols, on_message, on_error,
         let settled = false;
         websocket.addEventListener('open', event => {
             console.log(websocket.url +
-                (protocols ?
-                    ' ' + (typeof protocols === 'string' ? protocols : protocols.join(', ').bracket('square')).bracket()
-                    :
-                        '') +
+                (websocket.protocol ? websocket.protocol.bracket() : '') +
                 t(' 已连接'));
             settled = true;
             resolve(websocket);
@@ -201,7 +202,7 @@ export async function connect_websocket(url, { protocols, on_message, on_error,
                 else
                     console.log(`${websocket.url} ${t('已正常关闭')}`);
             else { // 异常关闭，认为发生了错误，进行错误处理
-                const error = new WebSocketConnectionError(websocket, event, `${t('连接被关闭')}, code: ${event.code}${event.reason ? `, ${t('原因')}: ${event.reason}` : ''}`);
+                const error = new WebSocketConnectionError(websocket.url, protocols, event, `${t('连接被关闭')}, code: ${event.code}${event.reason ? `, ${t('原因')}: ${event.reason}` : ''}`);
                 if (settled)
                     if (on_error)
                         on_error(error, websocket);
@@ -214,7 +215,7 @@ export async function connect_websocket(url, { protocols, on_message, on_error,
             }
         });
         websocket.addEventListener('error', event => {
-            const error = new WebSocketConnectionError(websocket, event);
+            const error = new WebSocketConnectionError(websocket.url, protocols, event);
             // https://blog.insiderattack.net/promises-next-ticks-and-immediates-nodejs-event-loop-part-3-9226cbe7a6aa
             // close 的错误信息比较多，这里延后触发 error 事件，放到微任务队列之后的 timers 队列中
             setTimeout(() => {

package/net.d.ts

@@ -107,7 +107,8 @@ export declare function rpc(func: string, args?: any[], { url, async: _async, ig
 }): Promise<any>;
 export declare class WebSocketConnectionError extends Error {
     name: string;
-    websocket: WebSocket;
+    url: string;
+    protocols?: string[];
     event: CloseEvent | ErrorEvent;
     type: 'close' | 'error';
     address?: string;
@@ -117,7 +118,7 @@ export declare class WebSocketConnectionError extends Error {
     /** close 事件时为 close code, error 事件为 error code */
     code?: string | number;
     reason?: string;
-    constructor(websocket: WebSocket, event: CloseEvent | ErrorEvent, message?: string);
+    constructor(url: string, protocols: string[] | undefined, event: CloseEvent | ErrorEvent, message?: string);
 }
 /** 连接 websocket url, 设置各种事件监听器。在 open 事件后 resolve, 返回 websocket
     遇到 error 时会创建 WebSocketConnectionError:
@@ -137,7 +138,7 @@ export declare class WebSocketConnectionError extends Error {
             https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent#Status_codes  */
 export declare function connect_websocket(url: string | URL, { protocols, max_payload, // 8 GB
 on_message, on_error, on_close }: {
-    protocols?: string | string[];
+    protocols?: string[];
     max_payload?: number;
     on_message(data: ArrayBuffer | string, websocket: WebSocket): any;
     on_error?(error: WebSocketConnectionError, websocket: WebSocket): any;

package/net.js

@@ -290,7 +290,9 @@ let decoder = new TextDecoder();
 let encoder = new TextEncoder();
 export class WebSocketConnectionError extends Error {
     name = 'WebSocketConnectionError';
-    websocket;
+    // 这里不保留 websocket 引用，防止循环引用导致 JSON 序列化失败
+    url;
+    protocols;
     event;
     type;
     address;
@@ -300,9 +302,10 @@ export class WebSocketConnectionError extends Error {
     /** close 事件时为 close code, error 事件为 error code */
     code;
     reason;
-    constructor(websocket, event, message = '') {
-        super(`${websocket.url} ${t('连接出错了')}. ${message}`);
-        this.websocket = websocket;
+    constructor(url, protocols, event, message = '') {
+        super(`${url}${protocols ? ' ' + protocols.join(', ').bracket() : ''} ${t('连接出错了')}. ${message}`);
+        this.url = url;
+        this.protocols = protocols;
         this.event = event;
         this.type = event.type;
         if (this.type === 'error') {
@@ -351,10 +354,7 @@ on_message, on_error, on_close }) {
         let settled = false;
         websocket.addEventListener('open', event => {
             console.log(websocket.url +
-                (protocols ?
-                    ' ' + (typeof protocols === 'string' ? protocols : protocols.join(', ').bracket('square')).bracket()
-                    :
-                        '') +
+                (websocket.protocol ? websocket.protocol.bracket() : '') +
                 t(' 已连接'));
             settled = true;
             resolve(websocket);
@@ -372,7 +372,7 @@ on_message, on_error, on_close }) {
                         console.log(`${websocket.url} ${t('已正常关闭')}`);
                 else { // 异常关闭，认为发生了错误，进行错误处理
                     assert(settled, t('websocket close 事件时应该已经 settled'));
-                    const error = new WebSocketConnectionError(websocket, event, `${t('连接被关闭')}, code: ${event.code}${event.reason ? `, ${t('原因')}: ${event.reason}` : ''}`);
+                    const error = new WebSocketConnectionError(websocket.url, protocols, event, `${t('连接被关闭')}, code: ${event.code}${event.reason ? `, ${t('原因')}: ${event.reason}` : ''}`);
                     if (on_error)
                         on_error(error, websocket);
                     else // 既然用户不传 on_error, 就当 unhandled error 抛出来
@@ -381,7 +381,7 @@ on_message, on_error, on_close }) {
             });
         });
         websocket.addEventListener('error', event => {
-            const error = new WebSocketConnectionError(websocket, event, event.error?.message);
+            const error = new WebSocketConnectionError(websocket.url, protocols, event, event.error?.message);
             if (settled)
                 if (on_error)
                     on_error(error, websocket);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xshell",
-  "version": "1.0.54",
+  "version": "1.0.55",
   "type": "module",
   "main": "./index.js",
   "bin": {
@@ -95,7 +95,7 @@
     "@types/koa-compress": "^4.0.3",
     "@types/lodash": "^4.14.197",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^20.5.3",
+    "@types/node": "^20.5.4",
     "@types/react": "^18.2.21",
     "@types/through2": "^2.0.38",
     "@types/tough-cookie": "^4.0.2",