trzsz2 1.0.0

package/dist/esm/progress.js

@@ -0,0 +1,313 @@
+/**
+ * trzsz2: https://github.com/zxdong262/trzsz2
+ * Copyright(c) 2024 Lonny Wong
+ * @license MIT
+ *
+ * Pure protocol implementation without fs/browser dependencies.
+ */
+function getLength(str) {
+  return str.replace(/[\u4e00-\u9fa5]/g, "**").length;
+}
+function getEllipsisString(str, max) {
+  max -= 3;
+  let len = 0;
+  let sub = "";
+  for (let i = 0; i < str.length; i++) {
+    if (str.charCodeAt(i) >= 19968 && str.charCodeAt(i) <= 40869) {
+      if (len + 2 > max) {
+        return { sub: sub + "...", len: len + 3 };
+      }
+      len += 2;
+    } else {
+      if (len + 1 > max) {
+        return { sub: sub + "...", len: len + 3 };
+      }
+      len += 1;
+    }
+    sub += str[i];
+  }
+  return { sub: sub + "...", len: len + 3 };
+}
+function convertSizeToString(size) {
+  let unit = "B";
+  do {
+    if (size < 1024) {
+      break;
+    }
+    size = size / 1024;
+    unit = "KB";
+    if (size < 1024) {
+      break;
+    }
+    size = size / 1024;
+    unit = "MB";
+    if (size < 1024) {
+      break;
+    }
+    size = size / 1024;
+    unit = "GB";
+    if (size < 1024) {
+      break;
+    }
+    size = size / 1024;
+    unit = "TB";
+  } while (false);
+  if (size >= 100) {
+    return `${size.toFixed(0)} ${unit}`;
+  } else if (size >= 10) {
+    return `${size.toFixed(1)} ${unit}`;
+  } else {
+    return `${size.toFixed(2)} ${unit}`;
+  }
+}
+function convertTimeToString(seconds) {
+  let result = "";
+  if (seconds >= 3600) {
+    result += Math.floor(seconds / 3600).toString() + ":";
+    seconds %= 3600;
+  }
+  const minute = Math.floor(seconds / 60);
+  result += minute >= 10 ? minute.toString() : "0" + minute.toString();
+  result += ":";
+  const second = Math.round(seconds % 60);
+  result += second >= 10 ? second.toString() : "0" + second.toString();
+  return result;
+}
+const kSpeedArraySize = 30;
+class TextProgressBar {
+  /**
+   * Create a TextProgressBar.
+   * @param writer - The output writer function.
+   * @param columns - The terminal columns.
+   * @param tmuxPaneColumns - The tmux pane columns (optional).
+   */
+  constructor(writer, columns, tmuxPaneColumns = void 0) {
+    this.lastUpdateTime = 0;
+    this.fileCount = 0;
+    this.fileIdx = 0;
+    this.fileName = "";
+    this.fileSize = 0;
+    this.fileStep = 0;
+    this.startTime = 0;
+    this.firstWrite = true;
+    this.speedCnt = 0;
+    this.speedIdx = 0;
+    this.timeArray = new Array(kSpeedArraySize);
+    this.stepArray = new Array(kSpeedArraySize);
+    this.writer = writer;
+    this.tmuxPaneColumns = tmuxPaneColumns ?? 0;
+    this.columns = this.tmuxPaneColumns > 1 ? this.tmuxPaneColumns - 1 : columns;
+  }
+  /**
+   * Set the terminal columns.
+   * @param columns - The terminal columns.
+   */
+  setTerminalColumns(columns) {
+    this.columns = columns;
+    if (this.tmuxPaneColumns > 0) {
+      this.tmuxPaneColumns = 0;
+    }
+  }
+  /**
+   * Called when the number of files is known.
+   * @param num - The number of files.
+   */
+  onNum(num) {
+    this.fileCount = num;
+    this.fileIdx = 0;
+  }
+  /**
+   * Called when a file name is known.
+   * @param name - The file name.
+   */
+  onName(name) {
+    this.fileName = name;
+    this.fileIdx += 1;
+    this.startTime = Date.now();
+    this.timeArray[0] = this.startTime;
+    this.stepArray[0] = 0;
+    this.speedCnt = 1;
+    this.speedIdx = 1;
+    this.fileStep = -1;
+  }
+  /**
+   * Called when the file size is known.
+   * @param size - The file size.
+   */
+  onSize(size) {
+    this.fileSize = size;
+  }
+  /**
+   * Called when a step is completed.
+   * @param step - The step number.
+   */
+  onStep(step) {
+    if (step <= this.fileStep) {
+      return;
+    }
+    this.fileStep = step;
+    this.showProgress();
+  }
+  /**
+   * Hide the cursor.
+   */
+  hideCursor() {
+    this.writer("\x1B[?25l");
+  }
+  /**
+   * Show the cursor.
+   */
+  showCursor() {
+    this.writer("\x1B[?25h");
+  }
+  /**
+   * Show the progress.
+   */
+  showProgress() {
+    const now = Date.now();
+    if (now - this.lastUpdateTime < 200) {
+      return;
+    }
+    this.lastUpdateTime = now;
+    let percentage = "100%";
+    if (this.fileSize !== 0) {
+      percentage = Math.round(this.fileStep * 100 / this.fileSize).toString() + "%";
+    }
+    const total = convertSizeToString(this.fileStep);
+    const speed = this.getSpeed(now);
+    let speedStr = "--- B/s";
+    let etaStr = "--- ETA";
+    if (speed > 0) {
+      speedStr = convertSizeToString(speed) + "/s";
+      etaStr = convertTimeToString(Math.round((this.fileSize - this.fileStep) / speed)) + " ETA";
+    }
+    const progressText = this.getProgressText(percentage, total, speedStr, etaStr);
+    if (this.firstWrite) {
+      this.firstWrite = false;
+      this.writer(progressText);
+      return;
+    }
+    if (this.tmuxPaneColumns > 0) {
+      this.writer(`\x1B[${this.columns}D${progressText}`);
+    } else {
+      this.writer(`\r${progressText}`);
+    }
+  }
+  /**
+   * Get the current transfer speed.
+   * @param now - The current time.
+   * @return The speed in bytes per second.
+   */
+  getSpeed(now) {
+    let speed;
+    if (this.speedCnt <= kSpeedArraySize) {
+      this.speedCnt++;
+      speed = (this.fileStep - this.stepArray[0]) * 1e3 / (now - this.timeArray[0]);
+    } else {
+      speed = (this.fileStep - this.stepArray[this.speedIdx]) * 1e3 / (now - this.timeArray[this.speedIdx]);
+    }
+    this.timeArray[this.speedIdx] = now;
+    this.stepArray[this.speedIdx] = this.fileStep;
+    this.speedIdx++;
+    if (this.speedIdx >= kSpeedArraySize) {
+      this.speedIdx %= kSpeedArraySize;
+    }
+    return isFinite(speed) ? speed : -1;
+  }
+  /**
+   * Get the progress text.
+   * @param percentage - The percentage string.
+   * @param total - The total string.
+   * @param speed - The speed string.
+   * @param eta - The ETA string.
+   * @return The progress text.
+   */
+  getProgressText(percentage, total, speed, eta) {
+    const barMinLength = 24;
+    let left = this.fileCount > 1 ? `(${this.fileIdx}/${this.fileCount}) ${this.fileName}` : this.fileName;
+    let leftLength = getLength(left);
+    let right = ` ${percentage} | ${total} | ${speed} | ${eta}`;
+    do {
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      if (leftLength > 50) {
+        ({ sub: left, len: leftLength } = getEllipsisString(left, 50));
+      }
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      if (leftLength > 40) {
+        ({ sub: left, len: leftLength } = getEllipsisString(left, 40));
+      }
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      right = ` ${percentage} | ${speed} | ${eta}`;
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      if (leftLength > 30) {
+        ({ sub: left, len: leftLength } = getEllipsisString(left, 30));
+      }
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      right = ` ${percentage} | ${eta}`;
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      right = ` ${percentage}`;
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      if (leftLength > 20) {
+        ({ sub: left, len: leftLength } = getEllipsisString(left, 20));
+      }
+      if (this.columns - leftLength - right.length >= barMinLength) {
+        break;
+      }
+      left = "";
+      leftLength = 0;
+    } while (false);
+    let barLength = this.columns - right.length;
+    if (leftLength > 0) {
+      barLength -= leftLength + 1;
+      left += " ";
+    }
+    const bar = this.getProgressBar(barLength);
+    return (left + bar + right).trim();
+  }
+  /**
+   * Get the progress bar string.
+   * @param len - The length of the bar.
+   * @return The progress bar string.
+   */
+  getProgressBar(len) {
+    if (len < 12) {
+      return "";
+    }
+    const total = len - 2;
+    let complete = total;
+    if (this.fileSize !== 0) {
+      complete = Math.round(total * this.fileStep / this.fileSize);
+    }
+    return "[\x1B[36m" + "█".repeat(complete) + "░".repeat(total - complete) + "\x1B[0m]";
+  }
+  /**
+   * Called when the transfer is done.
+   */
+  onDone() {
+    if (this.fileSize === 0) {
+      return;
+    }
+    this.fileStep = this.fileSize;
+    this.lastUpdateTime = 0;
+    this.showProgress();
+  }
+}
+export {
+  TextProgressBar,
+  getEllipsisString
+};
+//# sourceMappingURL=progress.js.map

package/dist/esm/progress.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress.js","sources":["../../src/progress.ts"],"sourcesContent":["/**\n * trzsz2: https://github.com/zxdong262/trzsz2\n * Copyright(c) 2024 Lonny Wong\n * @license MIT\n *\n * Pure protocol implementation without fs/browser dependencies.\n */\n\nimport type { ProgressCallback } from './comm'\n\n/**\n * Get the display length of a string (Chinese characters count as 2).\n * @param str - The input string.\n * @return The display length.\n */\nfunction getLength (str: string): number {\n  return str.replace(/[\\u4e00-\\u9fa5]/g, '**').length\n}\n\n/**\n * Get ellipsis string if the string is too long.\n * @param str - The input string.\n * @param max - The maximum length.\n * @return The ellipsis string and its length.\n */\nexport function getEllipsisString (str: string, max: number): { sub: string, len: number } {\n  max -= 3\n  let len = 0\n  let sub = ''\n  for (let i = 0; i < str.length; i++) {\n    if (str.charCodeAt(i) >= 0x4e00 && str.charCodeAt(i) <= 0x9fa5) {\n      if (len + 2 > max) {\n        return { sub: sub + '...', len: len + 3 }\n      }\n      len += 2\n    } else {\n      if (len + 1 > max) {\n        return { sub: sub + '...', len: len + 3 }\n      }\n      len += 1\n    }\n    sub += str[i]\n  }\n  return { sub: sub + '...', len: len + 3 }\n}\n\n/**\n * Convert size to human-readable string.\n * @param size - The size in bytes.\n * @return The human-readable string.\n */\nfunction convertSizeToString (size: number): string {\n  let unit = 'B'\n  do {\n    if (size < 1024) {\n      break\n    }\n    size = size / 1024\n    unit = 'KB'\n\n    if (size < 1024) {\n      break\n    }\n    size = size / 1024\n    unit = 'MB'\n\n    if (size < 1024) {\n      break\n    }\n    size = size / 1024\n    unit = 'GB'\n\n    if (size < 1024) {\n      break\n    }\n    size = size / 1024\n    unit = 'TB'\n  } while (false)\n\n  if (size >= 100) {\n    return `${size.toFixed(0)} ${unit}`\n  } else if (size >= 10) {\n    return `${size.toFixed(1)} ${unit}`\n  } else {\n    return `${size.toFixed(2)} ${unit}`\n  }\n}\n\n/**\n * Convert time to human-readable string.\n * @param seconds - The time in seconds.\n * @return The human-readable string.\n */\nfunction convertTimeToString (seconds: number): string {\n  let result = ''\n  if (seconds >= 3600) {\n    result += Math.floor(seconds / 3600).toString() + ':'\n    seconds %= 3600\n  }\n\n  const minute = Math.floor(seconds / 60)\n  result += minute >= 10 ? minute.toString() : '0' + minute.toString()\n  result += ':'\n\n  const second = Math.round(seconds % 60)\n  result += second >= 10 ? second.toString() : '0' + second.toString()\n\n  return result\n}\n\nconst kSpeedArraySize: number = 30\n\n/**\n * TextProgressBar class for displaying file transfer progress.\n */\nexport class TextProgressBar implements ProgressCallback {\n  private readonly writer: (output: string) => void\n  private lastUpdateTime: number = 0\n  private columns: number\n  private fileCount: number = 0\n  private fileIdx: number = 0\n  private fileName: string = ''\n  private fileSize: number = 0\n  private fileStep: number = 0\n  private startTime: number = 0\n  private tmuxPaneColumns: number\n  private firstWrite: boolean = true\n  private speedCnt: number = 0\n  private speedIdx: number = 0\n  private timeArray: number[] = new Array(kSpeedArraySize)\n  private stepArray: number[] = new Array(kSpeedArraySize)\n\n  /**\n   * Create a TextProgressBar.\n   * @param writer - The output writer function.\n   * @param columns - The terminal columns.\n   * @param tmuxPaneColumns - The tmux pane columns (optional).\n   */\n  public constructor (\n    writer: (output: string) => void,\n    columns: number,\n    tmuxPaneColumns: number | undefined = undefined\n  ) {\n    this.writer = writer\n    this.tmuxPaneColumns = tmuxPaneColumns ?? 0\n    // -1 to avoid xterm.js messing up the tmux pane\n    this.columns = this.tmuxPaneColumns > 1 ? this.tmuxPaneColumns - 1 : columns\n  }\n\n  /**\n   * Set the terminal columns.\n   * @param columns - The terminal columns.\n   */\n  public setTerminalColumns (columns: number): void {\n    this.columns = columns\n    // resizing tmux panes is not supported\n    if (this.tmuxPaneColumns > 0) {\n      this.tmuxPaneColumns = 0\n    }\n  }\n\n  /**\n   * Called when the number of files is known.\n   * @param num - The number of files.\n   */\n  public onNum (num: number): void {\n    this.fileCount = num\n    this.fileIdx = 0\n  }\n\n  /**\n   * Called when a file name is known.\n   * @param name - The file name.\n   */\n  public onName (name: string): void {\n    this.fileName = name\n    this.fileIdx += 1\n    this.startTime = Date.now()\n    this.timeArray[0] = this.startTime\n    this.stepArray[0] = 0\n    this.speedCnt = 1\n    this.speedIdx = 1\n    this.fileStep = -1\n  }\n\n  /**\n   * Called when the file size is known.\n   * @param size - The file size.\n   */\n  public onSize (size: number): void {\n    this.fileSize = size\n  }\n\n  /**\n   * Called when a step is completed.\n   * @param step - The step number.\n   */\n  public onStep (step: number): void {\n    if (step <= this.fileStep) {\n      return\n    }\n    this.fileStep = step\n    this.showProgress()\n  }\n\n  /**\n   * Hide the cursor.\n   */\n  public hideCursor (): void {\n    this.writer('\\x1b[?25l')\n  }\n\n  /**\n   * Show the cursor.\n   */\n  public showCursor (): void {\n    this.writer('\\x1b[?25h')\n  }\n\n  /**\n   * Show the progress.\n   */\n  private showProgress (): void {\n    const now = Date.now()\n    if (now - this.lastUpdateTime < 200) {\n      return\n    }\n    this.lastUpdateTime = now\n\n    let percentage = '100%'\n    if (this.fileSize !== 0) {\n      percentage = Math.round((this.fileStep * 100) / this.fileSize).toString() + '%'\n    }\n    const total = convertSizeToString(this.fileStep)\n    const speed = this.getSpeed(now)\n    let speedStr = '--- B/s'\n    let etaStr = '--- ETA'\n    if (speed > 0) {\n      speedStr = convertSizeToString(speed) + '/s'\n      etaStr = convertTimeToString(Math.round((this.fileSize - this.fileStep) / speed)) + ' ETA'\n    }\n\n    const progressText = this.getProgressText(percentage, total, speedStr, etaStr)\n\n    if (this.firstWrite) {\n      this.firstWrite = false\n      this.writer(progressText)\n      return\n    }\n\n    if (this.tmuxPaneColumns > 0) {\n      this.writer(`\\x1b[${this.columns}D${progressText}`)\n    } else {\n      this.writer(`\\r${progressText}`)\n    }\n  }\n\n  /**\n   * Get the current transfer speed.\n   * @param now - The current time.\n   * @return The speed in bytes per second.\n   */\n  private getSpeed (now: number): number {\n    let speed: number\n    if (this.speedCnt <= kSpeedArraySize) {\n      this.speedCnt++\n      speed = ((this.fileStep - this.stepArray[0]) * 1000) / (now - this.timeArray[0])\n    } else {\n      speed =\n        ((this.fileStep - this.stepArray[this.speedIdx]) * 1000) /\n        (now - this.timeArray[this.speedIdx])\n    }\n\n    this.timeArray[this.speedIdx] = now\n    this.stepArray[this.speedIdx] = this.fileStep\n\n    this.speedIdx++\n    if (this.speedIdx >= kSpeedArraySize) {\n      this.speedIdx %= kSpeedArraySize\n    }\n\n    return isFinite(speed) ? speed : -1\n  }\n\n  /**\n   * Get the progress text.\n   * @param percentage - The percentage string.\n   * @param total - The total string.\n   * @param speed - The speed string.\n   * @param eta - The ETA string.\n   * @return The progress text.\n   */\n  private getProgressText (\n    percentage: string,\n    total: string,\n    speed: string,\n    eta: string\n  ): string {\n    const barMinLength = 24\n    let left =\n      this.fileCount > 1 ? `(${this.fileIdx}/${this.fileCount}) ${this.fileName}` : this.fileName\n    let leftLength = getLength(left)\n    let right = ` ${percentage} | ${total} | ${speed} | ${eta}`\n\n    do {\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      if (leftLength > 50) {\n        ;({ sub: left, len: leftLength } = getEllipsisString(left, 50))\n      }\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      if (leftLength > 40) {\n        ;({ sub: left, len: leftLength } = getEllipsisString(left, 40))\n      }\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      right = ` ${percentage} | ${speed} | ${eta}`\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      if (leftLength > 30) {\n        ;({ sub: left, len: leftLength } = getEllipsisString(left, 30))\n      }\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      right = ` ${percentage} | ${eta}`\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      right = ` ${percentage}`\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      if (leftLength > 20) {\n        ;({ sub: left, len: leftLength } = getEllipsisString(left, 20))\n      }\n\n      if (this.columns - leftLength - right.length >= barMinLength) {\n        break\n      }\n      left = ''\n      leftLength = 0\n    } while (false)\n\n    let barLength = this.columns - right.length\n    if (leftLength > 0) {\n      barLength -= leftLength + 1\n      left += ' '\n    }\n\n    const bar = this.getProgressBar(barLength)\n    return (left + bar + right).trim()\n  }\n\n  /**\n   * Get the progress bar string.\n   * @param len - The length of the bar.\n   * @return The progress bar string.\n   */\n  private getProgressBar (len: number): string {\n    if (len < 12) {\n      return ''\n    }\n    const total = len - 2\n    let complete = total\n    if (this.fileSize !== 0) {\n      complete = Math.round((total * this.fileStep) / this.fileSize)\n    }\n    return '[\\u001b[36m' + '\\u2588'.repeat(complete) + '\\u2591'.repeat(total - complete) + '\\u001b[0m]'\n  }\n\n  /**\n   * Called when the transfer is done.\n   */\n  public onDone (): void {\n    if (this.fileSize === 0) {\n      return\n    }\n    this.fileStep = this.fileSize\n    this.lastUpdateTime = 0\n    this.showProgress()\n  }\n}\n"],"names":[],"mappings":"AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAeA,SAAS,UAAW,KAAqB;AACvC,SAAO,IAAI,QAAQ,oBAAoB,IAAI,EAAE;AAC/C;AAQO,SAAS,kBAAmB,KAAa,KAA2C;AACzF,SAAO;AACP,MAAI,MAAM;AACV,MAAI,MAAM;AACV,WAAS,IAAI,GAAG,IAAI,IAAI,QAAQ,KAAK;AACnC,QAAI,IAAI,WAAW,CAAC,KAAK,SAAU,IAAI,WAAW,CAAC,KAAK,OAAQ;AAC9D,UAAI,MAAM,IAAI,KAAK;AACjB,eAAO,EAAE,KAAK,MAAM,OAAO,KAAK,MAAM,EAAA;AAAA,MACxC;AACA,aAAO;AAAA,IACT,OAAO;AACL,UAAI,MAAM,IAAI,KAAK;AACjB,eAAO,EAAE,KAAK,MAAM,OAAO,KAAK,MAAM,EAAA;AAAA,MACxC;AACA,aAAO;AAAA,IACT;AACA,WAAO,IAAI,CAAC;AAAA,EACd;AACA,SAAO,EAAE,KAAK,MAAM,OAAO,KAAK,MAAM,EAAA;AACxC;AAOA,SAAS,oBAAqB,MAAsB;AAClD,MAAI,OAAO;AACX,KAAG;AACD,QAAI,OAAO,MAAM;AACf;AAAA,IACF;AACA,WAAO,OAAO;AACd,WAAO;AAEP,QAAI,OAAO,MAAM;AACf;AAAA,IACF;AACA,WAAO,OAAO;AACd,WAAO;AAEP,QAAI,OAAO,MAAM;AACf;AAAA,IACF;AACA,WAAO,OAAO;AACd,WAAO;AAEP,QAAI,OAAO,MAAM;AACf;AAAA,IACF;AACA,WAAO,OAAO;AACd,WAAO;AAAA,EACT,SAAS;AAET,MAAI,QAAQ,KAAK;AACf,WAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,IAAI,IAAI;AAAA,EACnC,WAAW,QAAQ,IAAI;AACrB,WAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,IAAI,IAAI;AAAA,EACnC,OAAO;AACL,WAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,IAAI,IAAI;AAAA,EACnC;AACF;AAOA,SAAS,oBAAqB,SAAyB;AACrD,MAAI,SAAS;AACb,MAAI,WAAW,MAAM;AACnB,cAAU,KAAK,MAAM,UAAU,IAAI,EAAE,aAAa;AAClD,eAAW;AAAA,EACb;AAEA,QAAM,SAAS,KAAK,MAAM,UAAU,EAAE;AACtC,YAAU,UAAU,KAAK,OAAO,aAAa,MAAM,OAAO,SAAA;AAC1D,YAAU;AAEV,QAAM,SAAS,KAAK,MAAM,UAAU,EAAE;AACtC,YAAU,UAAU,KAAK,OAAO,aAAa,MAAM,OAAO,SAAA;AAE1D,SAAO;AACT;AAEA,MAAM,kBAA0B;AAKzB,MAAM,gBAA4C;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAuBhD,YACL,QACA,SACA,kBAAsC,QACtC;AAzBF,SAAQ,iBAAyB;AAEjC,SAAQ,YAAoB;AAC5B,SAAQ,UAAkB;AAC1B,SAAQ,WAAmB;AAC3B,SAAQ,WAAmB;AAC3B,SAAQ,WAAmB;AAC3B,SAAQ,YAAoB;AAE5B,SAAQ,aAAsB;AAC9B,SAAQ,WAAmB;AAC3B,SAAQ,WAAmB;AAC3B,SAAQ,YAAsB,IAAI,MAAM,eAAe;AACvD,SAAQ,YAAsB,IAAI,MAAM,eAAe;AAarD,SAAK,SAAS;AACd,SAAK,kBAAkB,mBAAmB;AAE1C,SAAK,UAAU,KAAK,kBAAkB,IAAI,KAAK,kBAAkB,IAAI;AAAA,EACvE;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,mBAAoB,SAAuB;AAChD,SAAK,UAAU;AAEf,QAAI,KAAK,kBAAkB,GAAG;AAC5B,WAAK,kBAAkB;AAAA,IACzB;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,MAAO,KAAmB;AAC/B,SAAK,YAAY;AACjB,SAAK,UAAU;AAAA,EACjB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAQ,MAAoB;AACjC,SAAK,WAAW;AAChB,SAAK,WAAW;AAChB,SAAK,YAAY,KAAK,IAAA;AACtB,SAAK,UAAU,CAAC,IAAI,KAAK;AACzB,SAAK,UAAU,CAAC,IAAI;AACpB,SAAK,WAAW;AAChB,SAAK,WAAW;AAChB,SAAK,WAAW;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAQ,MAAoB;AACjC,SAAK,WAAW;AAAA,EAClB;AAAA;AAAA;AAAA;AAAA;AAAA,EAMO,OAAQ,MAAoB;AACjC,QAAI,QAAQ,KAAK,UAAU;AACzB;AAAA,IACF;AACA,SAAK,WAAW;AAChB,SAAK,aAAA;AAAA,EACP;AAAA;AAAA;AAAA;AAAA,EAKO,aAAoB;AACzB,SAAK,OAAO,WAAW;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKO,aAAoB;AACzB,SAAK,OAAO,WAAW;AAAA,EACzB;AAAA;AAAA;AAAA;AAAA,EAKQ,eAAsB;AAC5B,UAAM,MAAM,KAAK,IAAA;AACjB,QAAI,MAAM,KAAK,iBAAiB,KAAK;AACnC;AAAA,IACF;AACA,SAAK,iBAAiB;AAEtB,QAAI,aAAa;AACjB,QAAI,KAAK,aAAa,GAAG;AACvB,mBAAa,KAAK,MAAO,KAAK,WAAW,MAAO,KAAK,QAAQ,EAAE,SAAA,IAAa;AAAA,IAC9E;AACA,UAAM,QAAQ,oBAAoB,KAAK,QAAQ;AAC/C,UAAM,QAAQ,KAAK,SAAS,GAAG;AAC/B,QAAI,WAAW;AACf,QAAI,SAAS;AACb,QAAI,QAAQ,GAAG;AACb,iBAAW,oBAAoB,KAAK,IAAI;AACxC,eAAS,oBAAoB,KAAK,OAAO,KAAK,WAAW,KAAK,YAAY,KAAK,CAAC,IAAI;AAAA,IACtF;AAEA,UAAM,eAAe,KAAK,gBAAgB,YAAY,OAAO,UAAU,MAAM;AAE7E,QAAI,KAAK,YAAY;AACnB,WAAK,aAAa;AAClB,WAAK,OAAO,YAAY;AACxB;AAAA,IACF;AAEA,QAAI,KAAK,kBAAkB,GAAG;AAC5B,WAAK,OAAO,QAAQ,KAAK,OAAO,IAAI,YAAY,EAAE;AAAA,IACpD,OAAO;AACL,WAAK,OAAO,KAAK,YAAY,EAAE;AAAA,IACjC;AAAA,EACF;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,SAAU,KAAqB;AACrC,QAAI;AACJ,QAAI,KAAK,YAAY,iBAAiB;AACpC,WAAK;AACL,eAAU,KAAK,WAAW,KAAK,UAAU,CAAC,KAAK,OAAS,MAAM,KAAK,UAAU,CAAC;AAAA,IAChF,OAAO;AACL,eACI,KAAK,WAAW,KAAK,UAAU,KAAK,QAAQ,KAAK,OAClD,MAAM,KAAK,UAAU,KAAK,QAAQ;AAAA,IACvC;AAEA,SAAK,UAAU,KAAK,QAAQ,IAAI;AAChC,SAAK,UAAU,KAAK,QAAQ,IAAI,KAAK;AAErC,SAAK;AACL,QAAI,KAAK,YAAY,iBAAiB;AACpC,WAAK,YAAY;AAAA,IACnB;AAEA,WAAO,SAAS,KAAK,IAAI,QAAQ;AAAA,EACnC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUQ,gBACN,YACA,OACA,OACA,KACQ;AACR,UAAM,eAAe;AACrB,QAAI,OACF,KAAK,YAAY,IAAI,IAAI,KAAK,OAAO,IAAI,KAAK,SAAS,KAAK,KAAK,QAAQ,KAAK,KAAK;AACrF,QAAI,aAAa,UAAU,IAAI;AAC/B,QAAI,QAAQ,IAAI,UAAU,MAAM,KAAK,MAAM,KAAK,MAAM,GAAG;AAEzD,OAAG;AACD,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,UAAI,aAAa,IAAI;AAClB,SAAC,EAAE,KAAK,MAAM,KAAK,eAAe,kBAAkB,MAAM,EAAE;AAAA,MAC/D;AAEA,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,UAAI,aAAa,IAAI;AAClB,SAAC,EAAE,KAAK,MAAM,KAAK,eAAe,kBAAkB,MAAM,EAAE;AAAA,MAC/D;AAEA,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,cAAQ,IAAI,UAAU,MAAM,KAAK,MAAM,GAAG;AAE1C,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,UAAI,aAAa,IAAI;AAClB,SAAC,EAAE,KAAK,MAAM,KAAK,eAAe,kBAAkB,MAAM,EAAE;AAAA,MAC/D;AAEA,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,cAAQ,IAAI,UAAU,MAAM,GAAG;AAE/B,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,cAAQ,IAAI,UAAU;AAEtB,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,UAAI,aAAa,IAAI;AAClB,SAAC,EAAE,KAAK,MAAM,KAAK,eAAe,kBAAkB,MAAM,EAAE;AAAA,MAC/D;AAEA,UAAI,KAAK,UAAU,aAAa,MAAM,UAAU,cAAc;AAC5D;AAAA,MACF;AACA,aAAO;AACP,mBAAa;AAAA,IACf,SAAS;AAET,QAAI,YAAY,KAAK,UAAU,MAAM;AACrC,QAAI,aAAa,GAAG;AAClB,mBAAa,aAAa;AAC1B,cAAQ;AAAA,IACV;AAEA,UAAM,MAAM,KAAK,eAAe,SAAS;AACzC,YAAQ,OAAO,MAAM,OAAO,KAAA;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOQ,eAAgB,KAAqB;AAC3C,QAAI,MAAM,IAAI;AACZ,aAAO;AAAA,IACT;AACA,UAAM,QAAQ,MAAM;AACpB,QAAI,WAAW;AACf,QAAI,KAAK,aAAa,GAAG;AACvB,iBAAW,KAAK,MAAO,QAAQ,KAAK,WAAY,KAAK,QAAQ;AAAA,IAC/D;AACA,WAAO,cAAgB,IAAS,OAAO,QAAQ,IAAI,IAAS,OAAO,QAAQ,QAAQ,IAAI;AAAA,EACzF;AAAA;AAAA;AAAA;AAAA,EAKO,SAAgB;AACrB,QAAI,KAAK,aAAa,GAAG;AACvB;AAAA,IACF;AACA,SAAK,WAAW,KAAK;AACrB,SAAK,iBAAiB;AACtB,SAAK,aAAA;AAAA,EACP;AACF;"}

package/dist/esm/transfer.d.ts

@@ -0,0 +1,259 @@
+import { OpenSaveFile, TrzszFileReader, ProgressCallback } from './comm';
+/**
+ * TrzszTransfer class for handling file transfer protocol.
+ */
+export declare class TrzszTransfer {
+    private readonly buffer;
+    private readonly writer;
+    private readonly isWindowsShell;
+    private remoteIsWindows;
+    private lastInputTime;
+    private readonly openedFiles;
+    private readonly createdFiles;
+    private tmuxOutputJunk;
+    private cleanTimeoutInMilliseconds;
+    private transferConfig;
+    private stopped;
+    private maxChunkTimeInMilliseconds;
+    private protocolNewline;
+    /**
+     * Create a TrzszTransfer.
+     * @param writer - The output writer function.
+     * @param isWindowsShell - Whether the shell is Windows.
+     */
+    constructor(writer: (data: string | Uint8Array) => void, isWindowsShell?: boolean);
+    /**
+     * Cleanup resources.
+     */
+    cleanup(): void;
+    /**
+     * Add received data to the buffer.
+     * @param data - The received data.
+     */
+    addReceivedData(data: string | ArrayBuffer | Uint8Array | Blob): void;
+    /**
+     * Stop transferring.
+     */
+    stopTransferring(): Promise<void>;
+    /**
+     * Clean input buffer.
+     * @param timeoutInMilliseconds - The timeout in milliseconds.
+     */
+    private cleanInput;
+    /**
+     * Send a line.
+     * @param typ - The type.
+     * @param buf - The buffer.
+     */
+    private sendLine;
+    /**
+     * Receive a line.
+     * @param expectType - The expected type.
+     * @param mayHasJunk - Whether there may be junk.
+     */
+    private recvLine;
+    /**
+     * Receive and check a line.
+     * @param expectType - The expected type.
+     * @param mayHasJunk - Whether there may be junk.
+     */
+    private recvCheck;
+    /**
+     * Send an integer.
+     * @param typ - The type.
+     * @param val - The value.
+     */
+    private sendInteger;
+    /**
+     * Receive an integer.
+     * @param typ - The type.
+     * @param mayHasJunk - Whether there may be junk.
+     */
+    private recvInteger;
+    /**
+     * Check an integer.
+     * @param expect - The expected value.
+     */
+    private checkInteger;
+    /**
+     * Send a string.
+     * @param typ - The type.
+     * @param str - The string.
+     */
+    private sendString;
+    /**
+     * Receive a string.
+     * @param typ - The type.
+     * @param mayHasJunk - Whether there may be junk.
+     */
+    private recvString;
+    /**
+     * Check a string.
+     * @param expect - The expected string.
+     */
+    protected checkString(expect: string): Promise<void>;
+    /**
+     * Send binary data.
+     * @param typ - The type.
+     * @param buf - The buffer.
+     */
+    private sendBinary;
+    /**
+     * Receive binary data.
+     * @param typ - The type.
+     * @param mayHasJunk - Whether there may be junk.
+     */
+    private recvBinary;
+    /**
+     * Check binary data.
+     * @param expect - The expected buffer.
+     */
+    private checkBinary;
+    /**
+     * Send data.
+     * @param data - The data.
+     * @param binary - Whether to use binary mode.
+     * @param escapeCodes - The escape codes.
+     */
+    private sendData;
+    /**
+     * Receive data.
+     * @param binary - Whether to use binary mode.
+     * @param escapeCodes - The escape codes.
+     * @param timeoutInMilliseconds - The timeout in milliseconds.
+     */
+    private recvData;
+    /**
+     * Send action.
+     * @param confirm - Whether to confirm.
+     * @param remoteIsWindows - Whether the remote is Windows.
+     */
+    sendAction(confirm: boolean, remoteIsWindows: boolean): Promise<void>;
+    /**
+     * Receive action.
+     */
+    recvAction(): Promise<Record<string, unknown>>;
+    /**
+     * Send config.
+     * @param args - The config arguments.
+     * @param escapeChars - The escape characters.
+     * @param tmuxMode - The tmux mode.
+     * @param tmuxPaneWidth - The tmux pane width.
+     */
+    sendConfig(args: Record<string, unknown>, escapeChars: string[][], tmuxMode: number, tmuxPaneWidth: number): Promise<void>;
+    /**
+     * Receive config.
+     */
+    recvConfig(): Promise<Record<string, unknown>>;
+    /**
+     * Send client exit.
+     * @param msg - The message.
+     */
+    clientExit(msg: string): Promise<void>;
+    /**
+     * Receive exit.
+     */
+    recvExit(): Promise<string>;
+    /**
+     * Delete created files.
+     */
+    private deleteCreatedFiles;
+    /**
+     * Handle client error.
+     * @param err - The error.
+     */
+    clientError(err: Error): Promise<void>;
+    /**
+     * Handle server error.
+     * @param err - The error.
+     */
+    serverError(err: Error): Promise<void>;
+    /**
+     * Server exit - to be implemented by subclass or user.
+     * @param msg - The message.
+     */
+    serverExit(_msg: string): Promise<void>;
+    /**
+     * Send file number.
+     * @param num - The number of files.
+     * @param progressCallback - The progress callback.
+     */
+    private sendFileNum;
+    /**
+     * Send file name.
+     * @param file - The file reader.
+     * @param directory - Whether it's a directory.
+     * @param progressCallback - The progress callback.
+     */
+    private sendFileName;
+    /**
+     * Send file size.
+     * @param size - The file size.
+     * @param progressCallback - The progress callback.
+     */
+    private sendFileSize;
+    /**
+     * Send file data.
+     * @param file - The file reader.
+     * @param size - The file size.
+     * @param binary - Whether to use binary mode.
+     * @param escapeCodes - The escape codes.
+     * @param maxBufSize - The maximum buffer size.
+     * @param progressCallback - The progress callback.
+     */
+    private sendFileData;
+    /**
+     * Send file MD5.
+     * @param digest - The MD5 digest.
+     * @param progressCallback - The progress callback.
+     */
+    private sendFileMD5;
+    /**
+     * Send files.
+     * @param files - The file readers.
+     * @param progressCallback - The progress callback.
+     */
+    sendFiles(files: TrzszFileReader[], progressCallback: ProgressCallback | null): Promise<string[]>;
+    /**
+     * Receive file number.
+     * @param progressCallback - The progress callback.
+     */
+    private recvFileNum;
+    /**
+     * Receive file name.
+     * @param saveParam - The save parameter.
+     * @param openSaveFile - The open save file function.
+     * @param directory - Whether it's a directory.
+     * @param overwrite - Whether to overwrite.
+     * @param progressCallback - The progress callback.
+     */
+    private recvFileName;
+    /**
+     * Receive file size.
+     * @param progressCallback - The progress callback.
+     */
+    private recvFileSize;
+    /**
+     * Receive file data.
+     * @param file - The file writer.
+     * @param size - The file size.
+     * @param binary - Whether to use binary mode.
+     * @param escapeCodes - The escape codes.
+     * @param timeoutInMilliseconds - The timeout in milliseconds.
+     * @param progressCallback - The progress callback.
+     */
+    private recvFileData;
+    /**
+     * Receive file MD5.
+     * @param digest - The MD5 digest.
+     * @param progressCallback - The progress callback.
+     */
+    private recvFileMD5;
+    /**
+     * Receive files.
+     * @param saveParam - The save parameter.
+     * @param openSaveFile - The open save file function.
+     * @param progressCallback - The progress callback.
+     */
+    recvFiles(saveParam: unknown, openSaveFile: OpenSaveFile, progressCallback: ProgressCallback | null): Promise<string[]>;
+}