@fnndsc/chili 3.3.0 → 3.5.0

package/dist/chefs/chefs.js

@@ -9,6 +9,7 @@ import { files_rm } from '../commands/fs/rm.js';
 import { files_cp } from '../commands/fs/cp.js';
 import { files_mv } from '../commands/fs/mv.js';
 import { mkdir_render, touch_render, upload_render, cat_render, rm_render, cp_render, mv_render } from '../views/fs.js';
+import { chiliLog } from "../screen/output.js";
 /**
  * Lists directory contents.
  *
@@ -21,10 +22,10 @@ async function chefs_ls(options, pathStr = "") {
         return;
     }
     if (options.long) {
-        console.log(long_render(items, { human: !!options.human }));
+        chiliLog(long_render(items, { human: !!options.human }));
     }
     else {
-        console.log(grid_render(items));
+        chiliLog(grid_render(items));
     }
 }
 /**
@@ -36,7 +37,7 @@ async function chefs_ls(options, pathStr = "") {
  */
 async function chefs_cp(src, dest, options) {
     const success = await files_cp(src, dest, options);
-    console.log(cp_render(src, dest, success));
+    chiliLog(cp_render(src, dest, success));
 }
 /**
  * Moves a file or directory.
@@ -47,7 +48,7 @@ async function chefs_cp(src, dest, options) {
  */
 async function chefs_mv(src, dest, _options) {
     const success = await files_mv(src, dest);
-    console.log(mv_render(src, dest, success));
+    chiliLog(mv_render(src, dest, success));
 }
 /**
  * Creates a directory.
@@ -56,7 +57,7 @@ async function chefs_mv(src, dest, _options) {
  */
 async function chefs_mkdir(dirPath) {
     const success = await files_mkdir(dirPath);
-    console.log(mkdir_render(dirPath, success));
+    chiliLog(mkdir_render(dirPath, success));
 }
 /**
  * Creates an empty file.
@@ -65,7 +66,7 @@ async function chefs_mkdir(dirPath) {
  */
 async function chefs_touch(filePath) {
     const success = await files_touch(filePath);
-    console.log(touch_render(filePath, success));
+    chiliLog(touch_render(filePath, success));
 }
 /**
  * Uploads a local file or directory to ChRIS.
@@ -74,9 +75,9 @@ async function chefs_touch(filePath) {
  * @param remotePath - Remote ChRIS path.
  */
 async function chefs_upload(localPath, remotePath) {
-    console.log(`Uploading ${localPath} to ${remotePath}...`);
+    chiliLog(`Uploading ${localPath} to ${remotePath}...`);
     const success = await files_upload(localPath, remotePath);
-    console.log(upload_render(localPath, remotePath, success));
+    chiliLog(upload_render(localPath, remotePath, success));
 }
 /**
  * Changes the current working directory.
@@ -96,7 +97,7 @@ async function chefs_cd(path) {
  */
 async function chefs_pwd() {
     const current = await chrisContext.current_get(Context.ChRISfolder);
-    console.log(current || "/");
+    chiliLog(current || "/");
 }
 /**
  * Displays file content.
@@ -106,7 +107,7 @@ async function chefs_pwd() {
 async function chefs_cat(filePath) {
     const result = await files_cat(filePath);
     const content = result.ok ? result.value : null;
-    console.log(cat_render(content, filePath));
+    chiliLog(cat_render(content, filePath));
 }
 /**
  * Removes a file or directory.
@@ -116,7 +117,7 @@ async function chefs_cat(filePath) {
  */
 async function chefs_rm(targetPath, options) {
     const result = await files_rm(targetPath, options);
-    console.log(rm_render(result));
+    chiliLog(rm_render(result));
 }
 /**
  * Sets up the 'chefs' command group in Commander.

package/dist/commands/fs/download.d.ts

@@ -13,13 +13,28 @@ export interface DownloadSummary {
     duration: number;
     speed: number;
 }
+/** Download progress fact emitted to callers that want to render progress. */
+export interface DownloadProgressEvent {
+    operation: "download";
+    kind: "transfer";
+    phase: "scanning" | "transferring" | "complete" | "failed";
+    label?: string;
+    current?: number;
+    total?: number;
+    percent?: number;
+    unit?: "files" | "bytes";
+    status?: "running" | "done" | "error";
+}
+/** Options for download execution. */
+export interface DownloadOptions {
+    force?: boolean;
+    onProgress?: (event: DownloadProgressEvent) => void;
+}
 /**
- * Downloads files from ChRIS with a progress bar display.
+ * Downloads files from ChRIS and optionally emits structured progress events.
  * @param chrisPath - Remote ChRIS path (file or directory).
  * @param localPath - Local filesystem path.
  * @param options - Download options.
  * @returns Promise<DownloadSummary> with download statistics.
  */
-export declare function files_downloadWithProgress(chrisPath: string, localPath: string, options?: {
-    force?: boolean;
-}): Promise<DownloadSummary>;
+export declare function files_downloadWithProgress(chrisPath: string, localPath: string, options?: DownloadOptions): Promise<DownloadSummary>;

package/dist/commands/fs/download.js

@@ -6,11 +6,11 @@ import { fileContent_getBinaryStream, files_listRecursive } from "@fnndsc/salsa"
 import { path_resolveChrisFs } from "../../utils/cli.js";
 import fs from "fs";
 import path from "path";
-import cliProgress from "cli-progress";
 import chalk from "chalk";
 import { pipeline } from "stream/promises";
-import { bytes_format, eta_format, rate_format } from "./upload.js";
+import { bytes_format } from "./upload.js";
 import { prompt_confirmOrThrow } from "../../utils/input_format.js";
+import { chiliLog } from "../../screen/output.js";
 export { bytes_format };
 /**
  * Recursively creates a directory and all parent directories.
@@ -36,7 +36,7 @@ async function chrisPath_isDirectory(chrisPath) {
     }
 }
 /**
- * Downloads files from ChRIS with a progress bar display.
+ * Downloads files from ChRIS and optionally emits structured progress events.
  * @param chrisPath - Remote ChRIS path (file or directory).
  * @param localPath - Local filesystem path.
  * @param options - Download options.
@@ -93,61 +93,66 @@ export async function files_downloadWithProgress(chrisPath, localPath, options =
             // Ensure parent directory exists
             const parentDir = path.dirname(finalLocalPath);
             await directory_ensureExists(parentDir);
-            const showProgress = !!process.stdout.isTTY;
-            const progressBar = typeof size === "number" && showProgress
-                ? new cliProgress.SingleBar({
-                    format: "Downloading [{bar}] {percentage}% | ETA: {etaHuman} | Rate: {rate} | {bytes}/{totalBytes}",
-                }, cliProgress.Presets.shades_classic)
-                : null;
-            if (progressBar) {
-                progressBar.start(size, 0, {
-                    etaHuman: "--",
-                    rate: "--",
-                    bytes: bytes_format(0),
-                    totalBytes: bytes_format(size),
-                });
-            }
             let transferred = 0;
             const writeStream = fs.createWriteStream(finalLocalPath);
             stream.on("data", (chunk) => {
                 transferred += chunk.length;
-                if (progressBar) {
-                    const elapsedSeconds = Math.max(1e-6, (Date.now() - summary.startTime) / 1000);
-                    const rateCurrent = transferred / elapsedSeconds;
-                    const remainingBytes = Math.max(0, (size ?? transferred) - transferred);
-                    const etaSeconds = rateCurrent > 0 ? remainingBytes / rateCurrent : null;
-                    progressBar.update(Math.min(transferred, size || transferred), {
-                        etaHuman: eta_format(etaSeconds),
-                        rate: rate_format(rateCurrent),
-                        bytes: bytes_format(transferred),
-                        totalBytes: bytes_format(size ?? transferred),
-                    });
-                }
+                options.onProgress?.({
+                    operation: "download",
+                    kind: "transfer",
+                    phase: "transferring",
+                    label: `Downloading ${path.basename(finalLocalPath)}`,
+                    current: transferred,
+                    total: size,
+                    percent: typeof size === "number" && size > 0 ? (Math.min(transferred, size) / size) * 100 : undefined,
+                    unit: "bytes",
+                    status: "running",
+                });
             });
             await pipeline(stream, writeStream);
-            if (progressBar) {
-                progressBar.update(size || transferred);
-                progressBar.stop();
-            }
             summary.totalFiles = 1;
             summary.transferredCount = 1;
             summary.transferSize = transferred;
             summary.endTime = Date.now();
             summary.duration = (summary.endTime - summary.startTime) / 1000;
             summary.speed = summary.duration > 0 ? summary.transferSize / summary.duration : 0;
+            options.onProgress?.({
+                operation: "download",
+                kind: "transfer",
+                phase: "complete",
+                label: "Download complete",
+                current: transferred,
+                total: size,
+                percent: typeof size === "number" && size > 0 ? 100 : undefined,
+                unit: "bytes",
+                status: "done",
+            });
             return summary;
         }
         catch (error) {
             summary.failedCount = 1;
+            options.onProgress?.({
+                operation: "download",
+                kind: "transfer",
+                phase: "failed",
+                label: "Download failed",
+                status: "error",
+            });
             throw error;
         }
     }
     // Download directory
-    console.log(chalk.cyan("Scanning files to download..."));
+    chiliLog(chalk.cyan("Scanning files to download..."));
+    options.onProgress?.({
+        operation: "download",
+        kind: "transfer",
+        phase: "scanning",
+        label: "Scanning files to download",
+        status: "running",
+    });
     const items = await files_listRecursive(resolvedChris);
     const files = items.filter((item) => item.type === 'file');
     summary.totalFiles = files.length;
-    const totalSize = files.reduce((sum, f) => sum + (f.size || 0), 0);
     // Apply Unix semantics: trailing slash determines merge behavior
     const targetDir = resolvedChris.endsWith('/')
         ? localPath // Merge contents
@@ -169,27 +174,24 @@ export async function files_downloadWithProgress(chrisPath, localPath, options =
     }
     // Ensure target directory exists
     await directory_ensureExists(targetDir);
-    const showProgress = !!process.stdout.isTTY;
-    const progressBar = showProgress
-        ? new cliProgress.SingleBar({
-            format: "Downloading [{bar}] {percentage}% | ETA: {etaHuman} | Rate: {rate} | {value}/{total} files | {bytes}/{totalBytes}",
-        }, cliProgress.Presets.shades_classic)
-        : null;
-    if (progressBar) {
-        progressBar.start(files.length, 0, {
-            bytes: bytes_format(0),
-            totalBytes: bytes_format(totalSize),
-            etaHuman: "--",
-            rate: "--",
-        });
-    }
+    options.onProgress?.({
+        operation: "download",
+        kind: "transfer",
+        phase: "transferring",
+        label: "Downloading files",
+        current: 0,
+        total: files.length,
+        percent: files.length === 0 ? 100 : 0,
+        unit: "files",
+        status: "running",
+    });
     // Download each file
     for (const [index, file] of files.entries()) {
         try {
             const result = await fileContent_getBinaryStream(file.path);
             if (!result.ok) {
                 summary.failedCount++;
-                console.log(chalk.yellow(`\nFailed to download: ${file.path}`));
+                chiliLog(chalk.yellow(`\nFailed to download: ${file.path}`));
                 continue;
             }
             const { stream, size } = result.value;
@@ -211,25 +213,33 @@ export async function files_downloadWithProgress(chrisPath, localPath, options =
         catch (error) {
             summary.failedCount++;
             const msg = error instanceof Error ? error.message : String(error);
-            console.log(chalk.red(`\nError downloading ${file.path}: ${msg}`));
-        }
-        const elapsedSeconds = Math.max(1e-6, (Date.now() - summary.startTime) / 1000);
-        const rateCurrent = summary.transferSize > 0 ? summary.transferSize / elapsedSeconds : 0;
-        const remainingBytes = Math.max(0, totalSize - summary.transferSize);
-        const etaSeconds = rateCurrent > 0 ? remainingBytes / rateCurrent : null;
-        if (progressBar) {
-            progressBar.update(index + 1, {
-                bytes: bytes_format(summary.transferSize),
-                etaHuman: eta_format(etaSeconds),
-                rate: rate_format(rateCurrent),
-            });
+            chiliLog(chalk.red(`\nError downloading ${file.path}: ${msg}`));
         }
-    }
-    if (progressBar) {
-        progressBar.stop();
+        options.onProgress?.({
+            operation: "download",
+            kind: "transfer",
+            phase: "transferring",
+            label: "Downloading files",
+            current: index + 1,
+            total: files.length,
+            percent: files.length === 0 ? 100 : ((index + 1) / files.length) * 100,
+            unit: "files",
+            status: "running",
+        });
     }
     summary.endTime = Date.now();
     summary.duration = (summary.endTime - summary.startTime) / 1000;
     summary.speed = summary.duration > 0 ? summary.transferSize / summary.duration : 0;
+    options.onProgress?.({
+        operation: "download",
+        kind: "transfer",
+        phase: summary.failedCount === 0 ? "complete" : "failed",
+        label: "Download complete",
+        current: summary.transferredCount,
+        total: summary.totalFiles,
+        percent: summary.totalFiles === 0 ? 100 : (summary.transferredCount / summary.totalFiles) * 100,
+        unit: "files",
+        status: summary.failedCount === 0 ? "done" : "error",
+    });
     return summary;
 }

package/dist/commands/fs/upload.d.ts

@@ -20,6 +20,23 @@ export interface UploadSummary {
     speed: number;
     actualTargetPath: string;
 }
+/** Upload progress fact emitted to callers that want to render progress. */
+export interface UploadProgressEvent {
+    operation: "upload";
+    kind: "transfer";
+    phase: "scanning" | "transferring" | "complete" | "failed";
+    label?: string;
+    current?: number;
+    total?: number;
+    percent?: number;
+    unit?: "files";
+    status?: "running" | "done" | "error";
+}
+/** Options for upload execution. */
+export interface UploadOptions {
+    force?: boolean;
+    onProgress?: (event: UploadProgressEvent) => void;
+}
 /**
  * Formats bytes into human-readable format.
  * @param bytes - Number of bytes.
@@ -37,14 +54,13 @@ export declare function eta_format(seconds: number | null): string;
  */
 export declare function rate_format(rateBytesPerSec: number): string;
 /**
- * Uploads files with a progress bar display.
+ * Uploads files and optionally emits structured progress events.
  * @param localPath - Local path (file or directory).
  * @param remotePath - Remote ChRIS path.
+ * @param options - Upload options, including an optional progress callback.
  * @returns Promise<UploadSummary> with upload statistics.
  */
-export declare function files_uploadWithProgress(localPath: string, remotePath: string, options?: {
-    force?: boolean;
-}): Promise<UploadSummary>;
+export declare function files_uploadWithProgress(localPath: string, remotePath: string, options?: UploadOptions): Promise<UploadSummary>;
 /**
  * Uploads a local file or directory to ChRIS.
  *

package/dist/commands/fs/upload.js

@@ -7,9 +7,9 @@ import { chrisIO } from "@fnndsc/cumin";
 import { path_resolveChrisFs } from "../../utils/cli.js";
 import fs from "fs";
 import path from "path";
-import cliProgress from "cli-progress";
 import chalk from "chalk";
 import { prompt_confirmOrThrow } from "../../utils/input_format.js";
+import { chiliLog } from "../../screen/output.js";
 /**
  * Formats bytes into human-readable format.
  * @param bytes - Number of bytes.
@@ -101,17 +101,24 @@ async function localFiles_scan(localPath, remotePath) {
     return files;
 }
 /**
- * Uploads files with a progress bar display.
+ * Uploads files and optionally emits structured progress events.
  * @param localPath - Local path (file or directory).
  * @param remotePath - Remote ChRIS path.
+ * @param options - Upload options, including an optional progress callback.
  * @returns Promise<UploadSummary> with upload statistics.
  */
 export async function files_uploadWithProgress(localPath, remotePath, options = {}) {
     const resolvedRemote = await path_resolveChrisFs(remotePath, {});
     // Scan files
-    console.log(chalk.cyan("Scanning files to upload..."));
+    chiliLog(chalk.cyan("Scanning files to upload..."));
+    options.onProgress?.({
+        operation: "upload",
+        kind: "transfer",
+        phase: "scanning",
+        label: "Scanning files to upload",
+        status: "running",
+    });
     const fileList = await localFiles_scan(localPath, resolvedRemote);
-    const totalSize = fileList.reduce((sum, f) => sum + f.size, 0);
     // Determine actual target path (where files will be uploaded)
     const stats = await fs.promises.stat(localPath);
     let actualTarget = resolvedRemote;
@@ -140,20 +147,6 @@ export async function files_uploadWithProgress(localPath, remotePath, options =
     else {
         // Force mode: if target exists and is a directory, no prompt. If it's a file and we're uploading a single file, proceed.
     }
-    const showProgress = !!process.stdout.isTTY;
-    const progressBar = showProgress
-        ? new cliProgress.SingleBar({
-            format: "Transferring [{bar}] {percentage}% | ETA: {etaHuman} | Rate: {rate} | {value}/{total} files | {bytes}/{totalBytes}",
-        }, cliProgress.Presets.shades_classic)
-        : null;
-    if (progressBar) {
-        progressBar.start(fileList.length, 0, {
-            bytes: "0 B",
-            totalBytes: bytes_format(totalSize),
-            etaHuman: "--",
-            rate: "--",
-        });
-    }
     // Upload files
     const summary = {
         startTime: Date.now(),
@@ -166,6 +159,17 @@ export async function files_uploadWithProgress(localPath, remotePath, options =
         speed: 0,
         actualTargetPath: actualTarget,
     };
+    options.onProgress?.({
+        operation: "upload",
+        kind: "transfer",
+        phase: "transferring",
+        label: "Uploading files",
+        current: 0,
+        total: fileList.length,
+        percent: fileList.length === 0 ? 100 : 0,
+        unit: "files",
+        status: "running",
+    });
     for (const [index, file] of fileList.entries()) {
         try {
             const fileContent = await fs.promises.readFile(file.hostPath);
@@ -181,31 +185,39 @@ export async function files_uploadWithProgress(localPath, remotePath, options =
             }
             else {
                 summary.failedCount++;
-                console.log(chalk.yellow(`Failed to upload: ${file.hostPath}`));
+                chiliLog(chalk.yellow(`Failed to upload: ${file.hostPath}`));
             }
         }
         catch (error) {
             summary.failedCount++;
-            console.log(chalk.red(`Error uploading ${file.hostPath}: ${error instanceof Error ? error.message : String(error)}`));
-        }
-        const elapsedSeconds = Math.max(1e-6, (Date.now() - summary.startTime) / 1000);
-        const rateCurrent = summary.transferSize > 0 ? summary.transferSize / elapsedSeconds : 0;
-        const remainingBytes = Math.max(0, totalSize - summary.transferSize);
-        const etaSeconds = rateCurrent > 0 ? remainingBytes / rateCurrent : null;
-        if (progressBar) {
-            progressBar.update(index + 1, {
-                bytes: bytes_format(summary.transferSize),
-                etaHuman: eta_format(etaSeconds),
-                rate: rate_format(rateCurrent),
-            });
+            chiliLog(chalk.red(`Error uploading ${file.hostPath}: ${error instanceof Error ? error.message : String(error)}`));
         }
-    }
-    if (progressBar) {
-        progressBar.stop();
+        options.onProgress?.({
+            operation: "upload",
+            kind: "transfer",
+            phase: "transferring",
+            label: "Uploading files",
+            current: index + 1,
+            total: fileList.length,
+            percent: fileList.length === 0 ? 100 : ((index + 1) / fileList.length) * 100,
+            unit: "files",
+            status: "running",
+        });
     }
     summary.endTime = Date.now();
     summary.duration = (summary.endTime - summary.startTime) / 1000; // seconds
     summary.speed = summary.transferSize / summary.duration; // bytes per second
+    options.onProgress?.({
+        operation: "upload",
+        kind: "transfer",
+        phase: summary.failedCount === 0 ? "complete" : "failed",
+        label: "Upload complete",
+        current: summary.transferredCount,
+        total: summary.totalFiles,
+        percent: summary.totalFiles === 0 ? 100 : (summary.transferredCount / summary.totalFiles) * 100,
+        unit: "files",
+        status: summary.failedCount === 0 ? "done" : "error",
+    });
     return summary;
 }
 /**

package/dist/commands/man/doc.js

@@ -9,6 +9,7 @@
 import fs from "fs";
 import path from "path";
 import { projectDir_get, browser_open, asciidoc_render } from "../../man/renderer.js";
+import { chiliErrLog, chiliLog } from "../../screen/output.js";
 /**
  * Displays a documentation page for a specific topic.
  *
@@ -19,7 +20,7 @@ export async function manPage_display(options) {
     const docDir = path.join(projectDir_get(), "doc");
     const docPath = path.join(docDir, `${options.topic}.adoc`);
     if (!fs.existsSync(docPath)) {
-        console.error(`Documentation for '${options.topic}' not found.`);
+        chiliErrLog(`Documentation for '${options.topic}' not found.`);
         return;
     }
     if (options.browser) {
@@ -27,6 +28,6 @@ export async function manPage_display(options) {
     }
     else {
         const content = fs.readFileSync(docPath, "utf-8");
-        console.log(await asciidoc_render(content, options.style, options.width));
+        chiliLog(await asciidoc_render(content, options.style, options.width));
     }
 }