@fnndsc/chili 3.3.0 → 3.5.0

package/dist/filesystem/filesystemHandler.js

@@ -4,6 +4,8 @@
  * @module
  */
 import { ChRISinode_create, listParams_fromOptions, BrowserType, } from "@fnndsc/cumin";
+import { table_render } from "../screen/screen.js";
+import { chiliErrLog, chiliLog } from "../screen/output.js";
 /**
  * Lists resources for a given inode path.
  *
@@ -13,7 +15,7 @@ import { ChRISinode_create, listParams_fromOptions, BrowserType, } from "@fnndsc
 async function inodeResources_list(path, options) {
     const chrisInode = await ChRISinode_create(path);
     if (!chrisInode) {
-        console.error(`Could not find path '${path}' in the CUBE filesystem.`);
+        chiliErrLog(`Could not find path '${path}' in the CUBE filesystem.`);
         return;
     }
     const params = listParams_fromOptions({
@@ -33,28 +35,28 @@ async function inodeResources_list(path, options) {
     for (const browserType of browserTypes) {
         const browser = chrisInode.browser_get(browserType);
         if (!browser) {
-            console.error(`WARNING: ${browserType} browser is not available`);
+            chiliErrLog(`WARNING: ${browserType} browser is not available`);
             continue;
         }
         try {
             const resourceGet = browser.resource_get;
             if (!resourceGet) {
-                console.error(`WARNING: ${browserType} resource is null`);
+                chiliErrLog(`WARNING: ${browserType} resource is null`);
                 continue;
             }
             const resourcesList = await resourceGet.resources_getList(params);
             const resourceFields = await resourceGet.resourceFields_get(resourcesList, fieldOptions[browserType]);
             const results = resourceGet.resources_filterByFields(resourceFields);
             if (results) {
-                console.log(`${browserType} resources:`);
-                console.table(results.tableData, results.selectedFields);
+                chiliLog(`${browserType} resources:`);
+                chiliLog(table_render(results.tableData, results.selectedFields));
             }
             else {
-                console.error(`${browserType} resources: not found or could not be filtered`);
+                chiliErrLog(`${browserType} resources: not found or could not be filtered`);
             }
         }
         catch (error) {
-            console.error(`${browserType} resources: not found`);
+            chiliErrLog(`${browserType} resources: not found`);
         }
     }
 }
@@ -67,12 +69,12 @@ async function inodeResources_list(path, options) {
  */
 function inodeFields_list(inodeType, dataObj) {
     if (!dataObj) {
-        console.log("No " + inodeType + " at this path");
+        chiliLog("No " + inodeType + " at this path");
         return false;
     }
     if (dataObj.fields) {
-        console.log(inodeType);
-        console.table(dataObj.fields);
+        chiliLog(inodeType);
+        chiliLog(table_render(dataObj.fields, ["fields"]));
         return true;
     }
     return false;
@@ -85,7 +87,7 @@ function inodeFields_list(inodeType, dataObj) {
 async function inodeResourceFields_list(path = "") {
     const chrisFiles = await ChRISinode_create(path);
     if (!chrisFiles) {
-        console.error(`Could not create ChRISinode for path: ${path}`);
+        chiliErrLog(`Could not create ChRISinode for path: ${path}`);
         return;
     }
     const fileBrowser = chrisFiles.fileBrowser_get;

package/dist/filesystem/inodeCommand.js

@@ -5,6 +5,7 @@
  */
 import { Command } from "commander";
 import { FileGroupHandler, FileMemberHandler } from "./fileGroupHandler.js";
+import { chiliErrLog } from "../screen/output.js";
 /**
  * Sets up the 'inode' command for interacting with ChRIS filesystem resources.
  *
@@ -30,7 +31,7 @@ export async function inodeCommand_setup(program) {
             await fileProgram.parseAsync(args);
         }
         else {
-            console.error("Usage: chili inode <path> <files|file> [options]");
+            chiliErrLog("Usage: chili inode <path> <files|file> [options]");
             command.help();
         }
     });

package/dist/handlers/baseGroupHandler.d.ts

@@ -4,7 +4,7 @@
  * @module
  */
 import { Command } from "commander";
-import { ChRISPluginGroup, ChRISFeedGroup, ChRISEmbeddedResourceGroup, ChRISPACSGroup } from "@fnndsc/cumin";
+import { ChRISPluginGroup, ChRISFeedGroup, ChRISEmbeddedResourceGroup, ChRISPACSGroup, type CommandEnvelope } from "@fnndsc/cumin";
 import { CLIoptions } from "../utils/cli.js";
 import { TableOptions } from "../screen/screen.js";
 /**
@@ -26,6 +26,15 @@ export declare class BaseGroupHandler {
      * Lists available fields for the current ChRIS resource type.
      */
     resourceFields_list(): Promise<void>;
+    /**
+     * Renders available fields for the current ChRIS resource type as an envelope.
+     *
+     * Sans-I/O counterpart to {@link resourceFields_list} — returns the rendered
+     * text instead of printing it, so hosted surfaces can carry it over the wire.
+     *
+     * @returns An envelope carrying the field listing or an error.
+     */
+    resourceFields_render(): Promise<CommandEnvelope>;
     /**
      * Prompts the user for confirmation before performing an operation.
      *

package/dist/handlers/baseGroupHandler.js

@@ -4,11 +4,12 @@
  * @module
  */
 import { Command } from "commander";
-import { ChRISFeedGroup, record_extract, errorStack, } from "@fnndsc/cumin";
+import { ChRISFeedGroup, record_extract, errorStack, envelope_ok, envelope_error, } from "@fnndsc/cumin";
 import { options_toParams } from "../utils/cli.js";
 import { resourceColumns_removeDuplicates } from "../utils/resourceData.js";
-import { table_display, border_draw } from "../screen/screen.js";
+import { table_display, table_render, border_draw } from "../screen/screen.js";
 import * as readline from "readline";
+import { chiliErrLog, chiliLog } from "../screen/output.js";
 /**
  * Base handler for groups of ChRIS resources.
  * Provides common functionality for listing and deleting resources.
@@ -51,11 +52,11 @@ export class BaseGroupHandler {
             const params = options_toParams(options);
             const results = await this.chrisObject.asset.resources_listAndFilterByOptions(params);
             if (!results) {
-                console.error(`No ${this.assetName} resources found. Perhaps check your current context?`);
+                chiliErrLog(`No ${this.assetName} resources found. Perhaps check your current context?`);
                 return;
             }
             if (results.tableData.length === 0) {
-                console.log(`No ${this.assetName} found matching the criteria.`);
+                chiliLog(`No ${this.assetName} found matching the criteria.`);
             }
             else {
                 const uniqueResults = resourceColumns_removeDuplicates(results);
@@ -73,7 +74,7 @@ export class BaseGroupHandler {
                             return `"${String(val !== undefined ? val : '').split('"').join('""')}"`;
                         }).join(',');
                     }).join('\n');
-                    console.log(header + '\n' + rows);
+                    chiliLog(header + '\n' + rows);
                 }
                 else if (options.table) {
                     // Explicit Table format (with borders and title)
@@ -104,7 +105,7 @@ export class BaseGroupHandler {
             }
         }
         catch (error) {
-            console.log(errorStack.stack_search(this.assetName)[0]);
+            chiliLog(errorStack.stack_search(this.assetName)[0]);
         }
     }
     /**
@@ -114,18 +115,42 @@ export class BaseGroupHandler {
         try {
             const results = await this.chrisObject.asset.resourceFields_get();
             if (!results) {
-                console.error(`An error occurred while fetching resource fields for ${this.assetName}.`);
+                chiliErrLog(`An error occurred while fetching resource fields for ${this.assetName}.`);
                 return;
             }
             if (results.fields.length === 0) {
-                console.log(`No resource fields found for ${this.assetName}.`);
+                chiliLog(`No resource fields found for ${this.assetName}.`);
             }
             else {
                 table_display(results.fields, ["fields"]);
             }
         }
         catch (error) {
-            console.log(errorStack.stack_search(this.assetName)[0]);
+            chiliLog(errorStack.stack_search(this.assetName)[0]);
+        }
+    }
+    /**
+     * Renders available fields for the current ChRIS resource type as an envelope.
+     *
+     * Sans-I/O counterpart to {@link resourceFields_list} — returns the rendered
+     * text instead of printing it, so hosted surfaces can carry it over the wire.
+     *
+     * @returns An envelope carrying the field listing or an error.
+     */
+    async resourceFields_render() {
+        try {
+            const results = await this.chrisObject.asset.resourceFields_get();
+            if (!results) {
+                return envelope_error('', undefined, `An error occurred while fetching resource fields for ${this.assetName}.\n`);
+            }
+            if (results.fields.length === 0) {
+                return envelope_ok(`No resource fields found for ${this.assetName}.\n`);
+            }
+            return envelope_ok(table_render(results.fields, ["fields"]));
+        }
+        catch (error) {
+            const stacked = errorStack.stack_search(this.assetName)[0];
+            return envelope_error('', undefined, `${stacked ?? String(error)}\n`);
         }
     }
     /**
@@ -219,7 +244,7 @@ export class BaseGroupHandler {
                 const searchResults = await this.chrisObject.asset.resources_listAndFilterByOptions({
                     id: id,
                 });
-                console.log(border_draw(`checking ${this.assetName} id ${id} ... ${this.msg_OKorNot(searchResults)}`));
+                chiliLog(border_draw(`checking ${this.assetName} id ${id} ... ${this.msg_OKorNot(searchResults)}`));
                 if (!force) {
                     confirm = await this.user_confirmContinuation(id, "delete");
                     if (!confirm) {
@@ -230,7 +255,7 @@ export class BaseGroupHandler {
                 border_draw(`deleting ${this.assetName} id ${id} ... ${this.msg_OKorNot(true)}`);
             }
             catch (error) {
-                console.error(`${error}`);
+                chiliErrLog(`${error}`);
                 return false;
             }
         }
@@ -260,7 +285,7 @@ export class BaseGroupHandler {
         let nIDs;
         nIDs = await this.IDs_getFromSearch(options);
         if (!nIDs) {
-            console.error(`No ${this.assetName} matched the search criteria.`);
+            chiliErrLog(`No ${this.assetName} matched the search criteria.`);
             return;
         }
         if (nIDs) {
@@ -310,7 +335,7 @@ export class BaseGroupHandler {
             .option("-f, --force", `force the deletion without prompting for user confirmation`)
             .action(async (searchable, options) => {
             const searchParts = searchable.split("++").map((part) => part.trim());
-            // console.log(`searchParts = ${searchParts}`);
+            // chiliLog(`searchParts = ${searchParts}`);
             for (const searchPart of searchParts) {
                 const currentOptions = {
                     ...options,

package/dist/index.js

@@ -11,6 +11,7 @@
  */
 import omelette from "omelette";
 import { run } from "./run.js";
+import { chiliErrLog, chiliLog } from "./screen/output.js";
 /**
  * Sets up shell command completion for the standalone chili CLI using omelette.
  * This is a bin-only concern; in-process hosts provide their own completion.
@@ -50,7 +51,7 @@ function commandCompletion_setup() {
         },
     });
     completion.on("man.doc", ({ reply }) => {
-        console.log("Autocomplete triggered for man doc command");
+        chiliLog("Autocomplete triggered for man doc command");
         reply([]);
     });
     completion.init();
@@ -66,7 +67,7 @@ async function main() {
     await run(process.argv.slice(2));
 }
 main().catch((error) => {
-    console.error("An error occurred:", error);
+    chiliErrLog("An error occurred:", error);
     process.exit(1);
 });
 // Re-export library utilities for consumers that import the package root.

package/dist/lfs/lfs.js

@@ -8,6 +8,8 @@
  */
 import * as fs from 'fs';
 import * as path from 'path';
+import { table_render } from "../screen/screen.js";
+import { chiliErrLog, chiliLog } from "../screen/output.js";
 /**
  * Lists the contents of a directory with details.
  *
@@ -22,10 +24,10 @@ export async function dirContents_list(filepath) {
             return { filename: file, "size(KB)": size, created_at: birthtime };
         });
         const detailedFiles = await Promise.all(detailedFilesPromises);
-        console.table(detailedFiles);
+        chiliLog(table_render(detailedFiles, ["filename", "size(KB)", "created_at"]));
     }
     catch (error) {
-        console.error("Error occurred while reading the directory!", error);
+        chiliErrLog("Error occurred while reading the directory!", error);
     }
 }
 /**
@@ -36,7 +38,7 @@ export async function dirContents_list(filepath) {
 export function dir_create(filepath) {
     if (!fs.existsSync(filepath)) {
         fs.mkdirSync(filepath);
-        console.log("The directory has been created successfully");
+        chiliLog("The directory has been created successfully");
     }
 }
 /**
@@ -46,7 +48,7 @@ export function dir_create(filepath) {
  */
 export function file_create(filepath) {
     fs.openSync(filepath, "w");
-    console.log("An empty file has been created");
+    chiliLog("An empty file has been created");
 }
 /**
  * Sets up the 'lfs' command group in Commander.

package/dist/man/man.js

@@ -1,5 +1,6 @@
 import { topics_list } from "../commands/man/topics.js";
 import { manPage_display } from "../commands/man/doc.js";
+import { chiliLog } from "../screen/output.js";
 /**
  * Sets up the 'man' command for displaying ChILI manual and help pages.
  *
@@ -24,8 +25,8 @@ export function manCommand_setup(program) {
         .description("List the available manual page topics")
         .action(async () => {
         const files = await topics_list();
-        console.log("\n\nThe following topics are available:");
-        console.log("(read more with 'chili man doc <topic>')\n");
-        console.log(files.join("\n"));
+        chiliLog("\n\nThe following topics are available:");
+        chiliLog("(read more with 'chili man doc <topic>')\n");
+        chiliLog(files.join("\n"));
     });
 }

package/dist/man/renderer.js

@@ -9,6 +9,7 @@ import chalk from "chalk";
 import { convert as adoc_convert } from "asciidoctor";
 import { exec } from "child_process";
 import os from "os";
+import { chiliErrLog } from "../screen/output.js";
 const headingStyles = [
     { regex: /<h1.*?>(.*?)<\/h1>/g, font: "Standard", color: chalk.magenta },
     { regex: /<h2.*?>(.*?)<\/h2>/g, font: "Slant", color: chalk.yellow },
@@ -175,11 +176,11 @@ export async function browser_open(filePath) {
                 : "xdg-open";
         exec(`${command} ${tempHtmlPath}`, (error) => {
             if (error) {
-                console.error("Error opening browser:", error);
+                chiliErrLog("Error opening browser:", error);
             }
         });
     }
     catch (error) {
-        console.error("Error opening documentation in browser:", error instanceof Error ? error.message : String(error));
+        chiliErrLog("Error opening documentation in browser:", error instanceof Error ? error.message : String(error));
     }
 }

package/dist/pacs/pacsQueryHandler.js

@@ -9,6 +9,7 @@ import { BaseGroupHandler } from "../handlers/baseGroupHandler.js";
 import { border_draw } from "../screen/screen.js";
 import { pacsQueryResult_renderPretty } from "./pacsResultRender.js";
 import { pacsQueryPayload_build } from "./pacsQueryPayload.js";
+import { chiliLog } from "../screen/output.js";
 /**
  * Handler for PACS queries commands.
  */
@@ -69,7 +70,7 @@ export class PACSQueryGroupHandler {
         const listCommand = this.baseGroupHandler.baseListCommand_create(async (options) => {
             const pacsserver = await this.pacsserverContext_resolve(options.pacsserver);
             if (!pacsserver) {
-                console.log(border_draw("No PACS server in context. Use --pacsserver or set via context."));
+                chiliLog(border_draw("No PACS server in context. Use --pacsserver or set via context."));
                 return;
             }
             const mergedOptions = this.options_withPACSFilter(options, pacsserver);
@@ -111,17 +112,17 @@ export class PACSQueryGroupHandler {
             }
             const payload = pacsQueryPayload_build(queryInput, options.title, options.description);
             if (!payload) {
-                console.log(border_draw("Invalid query format. Provide JSON or comma-separated key:value pairs."));
+                chiliLog(border_draw("Invalid query format. Provide JSON or comma-separated key:value pairs."));
                 return;
             }
             const result = await pacsQueries_create(pacsserver, payload);
             if (!result.ok) {
                 const errors = errorStack_getAllOfType("error");
                 if (errors.length) {
-                    errors.forEach((msg) => console.log(border_draw(msg)));
+                    errors.forEach((msg) => chiliLog(border_draw(msg)));
                 }
                 else {
-                    console.log(border_draw("Failed to create PACS query."));
+                    chiliLog(border_draw("Failed to create PACS query."));
                 }
                 return;
             }
@@ -133,7 +134,7 @@ export class PACSQueryGroupHandler {
                 `pacs=${pacsserver}`,
                 `title="${created.title ?? options.title ?? ""}"`,
             ].join(" ");
-            console.log(border_draw(msg.trim()));
+            chiliLog(border_draw(msg.trim()));
         });
     }
     /**
@@ -149,17 +150,17 @@ export class PACSQueryGroupHandler {
             .action(async (queryId, options) => {
             const idNum = Number(queryId);
             if (Number.isNaN(idNum)) {
-                console.log(border_draw("queryId must be a number."));
+                chiliLog(border_draw("queryId must be a number."));
                 return;
             }
             const result = await pacsQuery_resultDecode(idNum);
             if (!result.ok) {
                 const errors = errorStack_getAllOfType("error");
                 if (errors.length) {
-                    errors.forEach((msg) => console.log(border_draw(msg)));
+                    errors.forEach((msg) => chiliLog(border_draw(msg)));
                 }
                 else {
-                    console.log(border_draw(`Failed to decode PACS query result for ${idNum}.`));
+                    chiliLog(border_draw(`Failed to decode PACS query result for ${idNum}.`));
                 }
                 return;
             }
@@ -167,23 +168,23 @@ export class PACSQueryGroupHandler {
             // Prefer JSON, then text, else indicate base64 length
             if (decoded.json !== undefined) {
                 if (options.raw) {
-                    console.log(border_draw(JSON.stringify(decoded.json, null, 2)));
+                    chiliLog(border_draw(JSON.stringify(decoded.json, null, 2)));
                     return;
                 }
                 const pretty = this.pacsResult_renderPretty(decoded.json);
                 if (pretty) {
-                    console.log(border_draw(pretty));
+                    chiliLog(border_draw(pretty));
                 }
                 else {
-                    console.log(border_draw(JSON.stringify(decoded.json, null, 2)));
+                    chiliLog(border_draw(JSON.stringify(decoded.json, null, 2)));
                 }
             }
             else if (decoded.text) {
-                console.log(border_draw(decoded.text));
+                chiliLog(border_draw(decoded.text));
             }
             else {
                 const len = decoded.raw.length;
-                console.log(border_draw(`Decoded payload available (base64 length ${len}), but not printable.`));
+                chiliLog(border_draw(`Decoded payload available (base64 length ${len}), but not printable.`));
             }
         });
     }

package/dist/pacs/pacsRetrieveHandler.js

@@ -6,6 +6,7 @@
 import { errorStack_getAllOfType, } from "@fnndsc/cumin";
 import { pacsRetrieve_create, pacsRetrieve_delete, pacsRetrieve_statusForQuery, } from "@fnndsc/salsa";
 import { border_draw } from "../screen/screen.js";
+import { chiliLog } from "../screen/output.js";
 /**
  * Handler for PACS retrieve commands.
  */
@@ -52,17 +53,17 @@ export class PACSRetrieveGroupHandler {
     async retrieve_pull(queryIdStr) {
         const queryId = Number(queryIdStr);
         if (Number.isNaN(queryId)) {
-            console.log(border_draw("Query ID must be a number."));
+            chiliLog(border_draw("Query ID must be a number."));
             return;
         }
         const result = await pacsRetrieve_create(queryId);
         if (!result.ok) {
             const errors = errorStack_getAllOfType("error");
             if (errors.length) {
-                errors.forEach((msg) => console.log(border_draw(msg)));
+                errors.forEach((msg) => chiliLog(border_draw(msg)));
             }
             else {
-                console.log(border_draw(`Failed to create PACS retrieve for query ${queryId}.`));
+                chiliLog(border_draw(`Failed to create PACS retrieve for query ${queryId}.`));
             }
             return;
         }
@@ -73,7 +74,7 @@ export class PACSRetrieveGroupHandler {
             `query=${queryId}`,
             `status=${record.status || "created"}`,
         ].join(" ");
-        console.log(border_draw(msg));
+        chiliLog(border_draw(msg));
     }
     /**
      * Handle the 'report' command - show detailed status.
@@ -83,23 +84,23 @@ export class PACSRetrieveGroupHandler {
     async retrieve_report(queryIdStr) {
         const queryId = Number(queryIdStr);
         if (Number.isNaN(queryId)) {
-            console.log(border_draw("Query ID must be a number."));
+            chiliLog(border_draw("Query ID must be a number."));
             return;
         }
         const result = await pacsRetrieve_statusForQuery(queryId);
         if (!result.ok) {
             const errors = errorStack_getAllOfType("error");
             if (errors.length) {
-                errors.forEach((msg) => console.log(border_draw(msg)));
+                errors.forEach((msg) => chiliLog(border_draw(msg)));
             }
             else {
-                console.log(border_draw(`Failed to generate status report for query ${queryId}.`));
+                chiliLog(border_draw(`Failed to generate status report for query ${queryId}.`));
             }
             return;
         }
         const report = result.value;
         const rendered = this.report_render(report);
-        console.log(border_draw(rendered));
+        chiliLog(border_draw(rendered));
     }
     /**
      * Handle the 'cancel' command - delete a retrieve.
@@ -109,21 +110,21 @@ export class PACSRetrieveGroupHandler {
     async retrieve_cancel(retrieveIdStr) {
         const retrieveId = Number(retrieveIdStr);
         if (Number.isNaN(retrieveId)) {
-            console.log(border_draw("Retrieve ID must be a number."));
+            chiliLog(border_draw("Retrieve ID must be a number."));
             return;
         }
         const result = await pacsRetrieve_delete(retrieveId);
         if (!result.ok) {
             const errors = errorStack_getAllOfType("error");
             if (errors.length) {
-                errors.forEach((msg) => console.log(border_draw(msg)));
+                errors.forEach((msg) => chiliLog(border_draw(msg)));
             }
             else {
-                console.log(border_draw(`Failed to cancel PACS retrieve ${retrieveId}.`));
+                chiliLog(border_draw(`Failed to cancel PACS retrieve ${retrieveId}.`));
             }
             return;
         }
-        console.log(border_draw(`PACS retrieve ${retrieveId} cancelled.`));
+        chiliLog(border_draw(`PACS retrieve ${retrieveId} cancelled.`));
     }
     /**
      * Determine overall completion status from series statuses.