feat: wire onDownloadProgress, add download progress tracking, bump 2.0.3

- Wire onDownloadProgress config option through convert() -> task.downloadTo()
- Add onProgress parameter to FilesAPI.downloadTo() with Content-Length support
- Add onProgress parameter to Task.downloadTo()
- Fix TypeScript type annotation for nodeStream (NodeJS.ReadableStream)
- Update devDependencies to latest in-range versions
- Add tests for download progress callback wiring

Author: drdmitry

dist/index.cjs

@@ -528,7 +528,7 @@ var FilesAPI = class {
   /**
    * Download file to path
    */
-  async downloadTo(fileId, outputPath) {
+  async downloadTo(fileId, outputPath, onProgress) {
     validateFileId(fileId);
     const response = await this.http.get(`/files/${encodeURIComponent(fileId)}`, {
       raw: true
@@ -553,7 +553,12 @@ var FilesAPI = class {
     if (!response.body) {
       throw new ValidationError("No response body");
     }
-    const nodeStream = stream.Readable.fromWeb(response.body);
+    const contentLength = response.headers.get("content-length");
+    const total = contentLength ? parseInt(contentLength, 10) : void 0;
+    let nodeStream = stream.Readable.fromWeb(response.body);
+    if (onProgress) {
+      nodeStream = trackStreamProgress(nodeStream, onProgress, total);
+    }
     const writeStream = fs__namespace.createWriteStream(filename);
     await new Promise((resolve, reject) => {
       nodeStream.pipe(writeStream);
@@ -810,14 +815,14 @@ var Task = class {
   /**
    * Download result file to path
    */
-  async downloadTo(outputPath) {
+  async downloadTo(outputPath, onProgress) {
     if (!this._fileId) {
       throw new ConversionError(
         "No result file available. Task may not be complete.",
         this.id
       );
     }
-    return this.filesAPI.downloadTo(this._fileId, outputPath);
+    return this.filesAPI.downloadTo(this._fileId, outputPath, onProgress);
   }
   /**
    * Update task state from API response
@@ -941,7 +946,7 @@ var ConversionToolsClient = class {
         }
       }
     });
-    const outputPath = await task.downloadTo(output);
+    const outputPath = await task.downloadTo(output, this.config.onDownloadProgress);
     return outputPath;
   }
   /**

dist/index.cjs.map

@@ -700,7 +700,7 @@ declare class FilesAPI {
     /**
      * Download file to path
      */
-    downloadTo(fileId: string, outputPath?: string): Promise<string>;
+    downloadTo(fileId: string, outputPath?: string, onProgress?: (progress: ProgressEvent) => void): Promise<string>;
 }
 
 /**
@@ -839,7 +839,7 @@ declare class Task {
     /**
      * Download result file to path
      */
-    downloadTo(outputPath?: string): Promise<string>;
+    downloadTo(outputPath?: string, onProgress?: (progress: ProgressEvent) => void): Promise<string>;
     /**
      * Update task state from API response
      */

dist/index.d.cts

@@ -700,7 +700,7 @@ declare class FilesAPI {
     /**
      * Download file to path
      */
-    downloadTo(fileId: string, outputPath?: string): Promise<string>;
+    downloadTo(fileId: string, outputPath?: string, onProgress?: (progress: ProgressEvent) => void): Promise<string>;
 }
 
 /**
@@ -839,7 +839,7 @@ declare class Task {
     /**
      * Download result file to path
      */
-    downloadTo(outputPath?: string): Promise<string>;
+    downloadTo(outputPath?: string, onProgress?: (progress: ProgressEvent) => void): Promise<string>;
     /**
      * Update task state from API response
      */

dist/index.d.ts

@@ -528,7 +528,7 @@ var FilesAPI = class {
   /**
    * Download file to path
    */
-  async downloadTo(fileId, outputPath) {
+  async downloadTo(fileId, outputPath, onProgress) {
     validateFileId(fileId);
     const response = await this.http.get(`/files/${encodeURIComponent(fileId)}`, {
       raw: true
@@ -553,7 +553,12 @@ var FilesAPI = class {
     if (!response.body) {
       throw new ValidationError("No response body");
     }
-    const nodeStream = stream.Readable.fromWeb(response.body);
+    const contentLength = response.headers.get("content-length");
+    const total = contentLength ? parseInt(contentLength, 10) : void 0;
+    let nodeStream = stream.Readable.fromWeb(response.body);
+    if (onProgress) {
+      nodeStream = trackStreamProgress(nodeStream, onProgress, total);
+    }
     const writeStream = fs__namespace.createWriteStream(filename);
     await new Promise((resolve, reject) => {
       nodeStream.pipe(writeStream);
@@ -810,14 +815,14 @@ var Task = class {
   /**
    * Download result file to path
    */
-  async downloadTo(outputPath) {
+  async downloadTo(outputPath, onProgress) {
     if (!this._fileId) {
       throw new ConversionError(
         "No result file available. Task may not be complete.",
         this.id
       );
     }
-    return this.filesAPI.downloadTo(this._fileId, outputPath);
+    return this.filesAPI.downloadTo(this._fileId, outputPath, onProgress);
   }
   /**
    * Update task state from API response
@@ -941,7 +946,7 @@ var ConversionToolsClient = class {
         }
       }
     });
-    const outputPath = await task.downloadTo(output);
+    const outputPath = await task.downloadTo(output, this.config.onDownloadProgress);
     return outputPath;
   }
   /**