@fnndsc/chili 3.2.5

package/dist/commands/feeds/delete.js

@@ -0,0 +1,34 @@
+/**
+ * @file Implements the logic for searching and deleting ChRIS feeds.
+ *
+ * This module provides functionality to search for feeds by term
+ * and delete them by ID using the `@fnndsc/salsa` library.
+ *
+ * @module
+ */
+import { feeds_list as salsaFeeds_list, feed_delete as salsaFeed_delete } from "@fnndsc/salsa";
+import { options_toParams } from "../../utils/cli.js";
+/**
+ * Resolves search terms to a list of feed items.
+ *
+ * @param searchable - The search string.
+ * @returns A Promise resolving to an array of feed items (table data).
+ */
+export async function feeds_searchByTerm(searchable) {
+    const options = { search: searchable };
+    const params = options_toParams(options);
+    const results = await salsaFeeds_list(params);
+    if (!results || !results.tableData) {
+        return [];
+    }
+    return results.tableData;
+}
+/**
+ * Deletes a feed by its ID.
+ *
+ * @param id - The ID of the feed to delete.
+ * @returns A Promise resolving to `true` on success, `false` otherwise.
+ */
+export async function feed_deleteById(id) {
+    return await salsaFeed_delete(id);
+}

package/dist/commands/feeds/fields.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Fetches the list of available fields for feeds.
+ *
+ * @returns A Promise resolving to an array of field names, or `null` if retrieval fails.
+ */
+export declare function feedFields_fetch(): Promise<string[] | null>;

package/dist/commands/feeds/fields.js

@@ -0,0 +1,17 @@
+/**
+ * @file Implements the logic for retrieving available fields for ChRIS feeds.
+ *
+ * This module provides functionality to fetch the list of valid fields
+ * that can be displayed or queried for feeds.
+ *
+ * @module
+ */
+import { feedFields_get as salsaFeedFields_get } from "@fnndsc/salsa";
+/**
+ * Fetches the list of available fields for feeds.
+ *
+ * @returns A Promise resolving to an array of field names, or `null` if retrieval fails.
+ */
+export async function feedFields_fetch() {
+    return await salsaFeedFields_get();
+}

package/dist/commands/feeds/list.d.ts

@@ -0,0 +1,17 @@
+import { CLIoptions } from "../../utils/cli.js";
+import { Feed } from "../../models/feed.js";
+/**
+ * Result structure for feed listing.
+ */
+export interface FeedListResult {
+    feeds: Feed[];
+    selectedFields: string[];
+    totalCount?: number;
+}
+/**
+ * Fetches a list of ChRIS feeds based on options.
+ *
+ * @param options - CLI options containing filtering/pagination parameters.
+ * @returns A Promise resolving to a `FeedListResult` object.
+ */
+export declare function feeds_fetchList(options: CLIoptions): Promise<FeedListResult>;

package/dist/commands/feeds/list.js

@@ -0,0 +1,38 @@
+/**
+ * @file Implements the logic for listing ChRIS feeds.
+ *
+ * This module provides functionality to fetch lists of feeds
+ * from ChRIS using the `@fnndsc/salsa` library.
+ *
+ * @module
+ */
+import { feeds_list as salsaFeeds_list, feeds_listAll as salsaFeeds_listAll } from "@fnndsc/salsa";
+import { options_toParams } from "../../utils/cli.js";
+import { list_applySort } from "../../utils/sort.js";
+/**
+ * Fetches a list of ChRIS feeds based on options.
+ *
+ * @param options - CLI options containing filtering/pagination parameters.
+ * @returns A Promise resolving to a `FeedListResult` object.
+ */
+export async function feeds_fetchList(options) {
+    const params = options_toParams(options);
+    if (options.user)
+        params.owner_username = options.user;
+    const result = options.all
+        ? await salsaFeeds_listAll(params)
+        : await salsaFeeds_list(params);
+    if (result && result.tableData) {
+        let feeds = result.tableData;
+        // Apply sorting if specified
+        if (options.sort) {
+            feeds = list_applySort(feeds, options.sort, options.reverse);
+        }
+        return {
+            feeds,
+            selectedFields: result.selectedFields || [],
+            totalCount: result.totalCount,
+        };
+    }
+    return { feeds: [], selectedFields: [] };
+}

package/dist/commands/feeds/share.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Implements the logic for sharing ChRIS feeds.
+ *
+ * This module provides functionality to share a specific feed
+ * with other users using the `@fnndsc/salsa` library.
+ *
+ * @module
+ */
+import { FeedShareOptions } from "@fnndsc/salsa";
+/**
+ * Shares a feed with other users.
+ *
+ * @param feedId - The ID of the feed to share.
+ * @param options - Sharing options (e.g., list of users).
+ * @returns A Promise resolving to `true` on success, `false` otherwise.
+ */
+export declare function feed_shareById(feedId: number, options: FeedShareOptions): Promise<boolean>;

package/dist/commands/feeds/share.js

@@ -0,0 +1,19 @@
+/**
+ * @file Implements the logic for sharing ChRIS feeds.
+ *
+ * This module provides functionality to share a specific feed
+ * with other users using the `@fnndsc/salsa` library.
+ *
+ * @module
+ */
+import { feeds_share as salsaFeeds_share } from "@fnndsc/salsa";
+/**
+ * Shares a feed with other users.
+ *
+ * @param feedId - The ID of the feed to share.
+ * @param options - Sharing options (e.g., list of users).
+ * @returns A Promise resolving to `true` on success, `false` otherwise.
+ */
+export async function feed_shareById(feedId, options) {
+    return await salsaFeeds_share(feedId, options);
+}

package/dist/commands/file/view.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Fetches the content of a ChRIS file as a UTF-8 string.
+ *
+ * @param fileIdentifier - The path of the file to view.
+ * @returns A Promise resolving to the file content as a string, or `null` if empty/not found.
+ * @throws {Error} If the operation fails and an error is pushed to the stack.
+ */
+export declare function files_viewContent(fileIdentifier: string): Promise<string | null>;

package/dist/commands/file/view.js

@@ -0,0 +1,25 @@
+/**
+ * @file Implements the logic for viewing the content of ChRIS files.
+ *
+ * This module provides functionality to retrieve the content of a file
+ * either by its direct ID or by resolving a name/path search term.
+ *
+ * @module
+ */
+import { fileContent_get } from "@fnndsc/salsa";
+/**
+ * Fetches the content of a ChRIS file as a UTF-8 string.
+ *
+ * @param fileIdentifier - The path of the file to view.
+ * @returns A Promise resolving to the file content as a string, or `null` if empty/not found.
+ * @throws {Error} If the operation fails and an error is pushed to the stack.
+ */
+export async function files_viewContent(fileIdentifier) {
+    const result = await fileContent_get(fileIdentifier);
+    if (!result.ok) {
+        // Errors are pushed to the stack within salsa, so we can just throw a generic error here
+        // or let the controller handle it by checking the error stack. For now, let's throw.
+        throw new Error(`Failed to view content for: ${fileIdentifier}`);
+    }
+    return result.value;
+}

package/dist/commands/files/delete.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Resolves search terms to a list of file items.
+ *
+ * @param searchable - The search string.
+ * @param assetName - The asset name ('files', 'links', 'dirs').
+ * @returns A Promise resolving to an array of file items (table data).
+ */
+export declare function files_searchByTerm(searchable: string, assetName: string): Promise<Record<string, unknown>[]>;
+/**
+ * Deletes a file resource by its ID.
+ *
+ * @param id - The ID of the file/resource to delete.
+ * @param assetName - The asset name ('files', 'links', 'dirs').
+ * @returns A Promise resolving to `true` on success, `false` otherwise.
+ */
+export declare function files_deleteById(id: number, assetName: string): Promise<boolean>;

package/dist/commands/files/delete.js

@@ -0,0 +1,36 @@
+/**
+ * @file Implements the logic for searching and deleting ChRIS file resources.
+ *
+ * This module provides functionality to search for files by term and delete them
+ * by ID, utilizing the `@fnndsc/salsa` library.
+ *
+ * @module
+ */
+import { files_list as salsaFiles_list, files_delete as salsaFiles_delete } from "@fnndsc/salsa";
+import { options_toParams } from "../../utils/cli.js";
+/**
+ * Resolves search terms to a list of file items.
+ *
+ * @param searchable - The search string.
+ * @param assetName - The asset name ('files', 'links', 'dirs').
+ * @returns A Promise resolving to an array of file items (table data).
+ */
+export async function files_searchByTerm(searchable, assetName) {
+    const options = { search: searchable };
+    const params = options_toParams(options);
+    const results = await salsaFiles_list(params, assetName);
+    if (!results || !results.tableData) {
+        return [];
+    }
+    return results.tableData;
+}
+/**
+ * Deletes a file resource by its ID.
+ *
+ * @param id - The ID of the file/resource to delete.
+ * @param assetName - The asset name ('files', 'links', 'dirs').
+ * @returns A Promise resolving to `true` on success, `false` otherwise.
+ */
+export async function files_deleteById(id, assetName) {
+    return await salsaFiles_delete(id, assetName);
+}

package/dist/commands/files/fields.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Fetches the list of available fields for a given asset type.
+ *
+ * @param assetName - The asset name ('files', 'links', 'dirs'). Defaults to 'files'.
+ * @returns A Promise resolving to an array of field names, or `null` if retrieval fails.
+ */
+export declare function fileFields_fetch(assetName?: string): Promise<string[] | null>;

package/dist/commands/files/fields.js

@@ -0,0 +1,18 @@
+/**
+ * @file Implements the logic for retrieving available fields for ChRIS file resources.
+ *
+ * This module provides functionality to fetch the list of valid fields
+ * that can be displayed or queried for files, directories, or links.
+ *
+ * @module
+ */
+import { fileFields_get as salsaFileFields_get } from "@fnndsc/salsa";
+/**
+ * Fetches the list of available fields for a given asset type.
+ *
+ * @param assetName - The asset name ('files', 'links', 'dirs'). Defaults to 'files'.
+ * @returns A Promise resolving to an array of field names, or `null` if retrieval fails.
+ */
+export async function fileFields_fetch(assetName = "files") {
+    return await salsaFileFields_get(assetName);
+}

package/dist/commands/files/list.d.ts

@@ -0,0 +1,11 @@
+import { FilteredResourceData } from "@fnndsc/cumin";
+import { CLIoptions } from "../../utils/cli.js";
+/**
+ * Fetches a list of ChRIS resources (files, links, or dirs) based on options.
+ *
+ * @param options - CLI options containing filtering/pagination parameters.
+ * @param assetName - The type of asset to list ('files', 'links', 'dirs'). Defaults to 'files'.
+ * @param path - Optional ChRIS path to list resources from.
+ * @returns A Promise resolving to `FilteredResourceData` or `null` if the request fails/returns nothing.
+ */
+export declare function files_fetchList(options: CLIoptions, assetName?: string, path?: string): Promise<FilteredResourceData | null>;

package/dist/commands/files/list.js

@@ -0,0 +1,23 @@
+/**
+ * @file Implements the logic for listing ChRIS file resources.
+ *
+ * This module provides functionality to fetch lists of files, directories, or links
+ * from ChRIS using the `@fnndsc/salsa` library. It handles option parsing
+ * and delegates the actual API call.
+ *
+ * @module
+ */
+import { files_list as salsaFiles_list } from "@fnndsc/salsa";
+import { options_toParams } from "../../utils/cli.js";
+/**
+ * Fetches a list of ChRIS resources (files, links, or dirs) based on options.
+ *
+ * @param options - CLI options containing filtering/pagination parameters.
+ * @param assetName - The type of asset to list ('files', 'links', 'dirs'). Defaults to 'files'.
+ * @param path - Optional ChRIS path to list resources from.
+ * @returns A Promise resolving to `FilteredResourceData` or `null` if the request fails/returns nothing.
+ */
+export async function files_fetchList(options, assetName = "files", path) {
+    const params = options_toParams(options);
+    return await salsaFiles_list(params, assetName, path);
+}

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

@@ -0,0 +1,15 @@
+import { Result } from "@fnndsc/cumin";
+/**
+ * Retrieves the content of a file.
+ *
+ * @param filePath - The path to the file.
+ * @returns Promise resolving to content string or null.
+ */
+export declare function files_cat(filePath: string): Promise<Result<string>>;
+/**
+ * Retrieves the binary content of a file.
+ *
+ * @param filePath - The path to the file.
+ * @returns Promise resolving to content Buffer or error.
+ */
+export declare function files_catBinary(filePath: string): Promise<Result<Buffer>>;

package/dist/commands/fs/cat.js

@@ -0,0 +1,26 @@
+/**
+ * @file Implements the core logic for the `cat` command.
+ * @module
+ */
+import { fileContent_get, fileContent_getBinary } from "@fnndsc/salsa";
+import { path_resolveChrisFs } from "../../utils/cli.js";
+/**
+ * Retrieves the content of a file.
+ *
+ * @param filePath - The path to the file.
+ * @returns Promise resolving to content string or null.
+ */
+export async function files_cat(filePath) {
+    const resolved = await path_resolveChrisFs(filePath, {});
+    return await fileContent_get(resolved);
+}
+/**
+ * Retrieves the binary content of a file.
+ *
+ * @param filePath - The path to the file.
+ * @returns Promise resolving to content Buffer or error.
+ */
+export async function files_catBinary(filePath) {
+    const resolved = await path_resolveChrisFs(filePath, {});
+    return await fileContent_getBinary(resolved);
+}

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

@@ -0,0 +1,17 @@
+/**
+ * Options for the copy operation.
+ */
+export interface CpOptions {
+    /** Recursively copy directories. */
+    recursive?: boolean;
+}
+/**
+ * Copies a file or directory.
+ * Delegates the operation directly to the centralized vfsDispatcher.
+ *
+ * @param src - Source path.
+ * @param dest - Destination path.
+ * @param options - Copy options (recursive).
+ * @returns Promise<boolean> success.
+ */
+export declare function files_cp(src: string, dest: string, options: CpOptions): Promise<boolean>;

package/dist/commands/fs/cp.js

@@ -0,0 +1,26 @@
+/**
+ * @file Copy command logic.
+ *
+ * @module
+ */
+import { vfsDispatcher } from "@fnndsc/salsa";
+import { errorStack } from "@fnndsc/cumin";
+/**
+ * Copies a file or directory.
+ * Delegates the operation directly to the centralized vfsDispatcher.
+ *
+ * @param src - Source path.
+ * @param dest - Destination path.
+ * @param options - Copy options (recursive).
+ * @returns Promise<boolean> success.
+ */
+export async function files_cp(src, dest, options) {
+    try {
+        return await vfsDispatcher.cp(src, dest, options);
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        errorStack.stack_push("error", `cp command failed: ${msg}`);
+        return false;
+    }
+}

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

@@ -0,0 +1,15 @@
+import { CLIoptions } from "../../utils/cli.js";
+/**
+ * Core logic for the 'file create' command.
+ *
+ * This function handles the creation of a new file in the ChRIS file system.
+ * It resolves the target path, retrieves the content, and calls the
+ * underlying file creation service. It also includes robust error handling
+ * and provides informative error messages.
+ *
+ * @param fileIdentifier - The primary argument for the file (name or path). Can be undefined if options.name is provided.
+ * @param options - CLI options including `--content`, `--from-file`, `--path`, `--name`.
+ * @returns A Promise resolving to `true` on successful file creation, `false` otherwise.
+ * @throws {Error} On invalid input (e.g., missing filename), issues with content retrieval, or if underlying file creation operations fail.
+ */
+export declare function files_create(fileIdentifier: string | undefined, options: CLIoptions): Promise<boolean>;

package/dist/commands/fs/create.js

@@ -0,0 +1,83 @@
+/**
+ * @file Implements the core logic for the `create` command in the ChRIS CLI.
+ *
+ * This module provides functionality to create new files within the ChRIS
+ * file system, allowing content to be specified directly or read from a local file.
+ * It interacts with `@fnndsc/salsa` for file creation and `@fnndsc/cumin`
+ * for error handling.
+ *
+ * @module
+ */
+import { files_create as salsaFiles_create } from "@fnndsc/salsa";
+import { path_resolveChrisFs } from "../../utils/cli.js";
+import * as fs from "fs";
+import { errorStack_getAllOfType } from "@fnndsc/cumin";
+/**
+ * Retrieves the content for a new file based on provided CLI options.
+ *
+ * This function handles content specified directly via `--content` or
+ * read from a local file path via `--from-file`. It ensures that only one
+ * content source is used and validates the existence of local files.
+ *
+ * @param options - CLI options, which may include `content` (string) or `fromFile` (path to a local file).
+ * @returns The file content as a `string` or `Buffer`.
+ * @throws {Error} If both `--content` and `--from-file` are used, or if the local file specified by `--from-file` is not found.
+ */
+function content_get(options) {
+    if (options.content && options.fromFile) {
+        throw new Error('Cannot use both --content and --from-file. Please choose one.');
+    }
+    if (options.content) {
+        return options.content;
+    }
+    if (options.fromFile) {
+        if (!fs.existsSync(options.fromFile)) {
+            throw new Error(`Local file not found at ${options.fromFile}`);
+        }
+        return fs.readFileSync(options.fromFile);
+    }
+    // Default to empty content if no source is specified
+    return "";
+}
+/**
+ * Core logic for the 'file create' command.
+ *
+ * This function handles the creation of a new file in the ChRIS file system.
+ * It resolves the target path, retrieves the content, and calls the
+ * underlying file creation service. It also includes robust error handling
+ * and provides informative error messages.
+ *
+ * @param fileIdentifier - The primary argument for the file (name or path). Can be undefined if options.name is provided.
+ * @param options - CLI options including `--content`, `--from-file`, `--path`, `--name`.
+ * @returns A Promise resolving to `true` on successful file creation, `false` otherwise.
+ * @throws {Error} On invalid input (e.g., missing filename), issues with content retrieval, or if underlying file creation operations fail.
+ */
+export async function files_create(fileIdentifier, options) {
+    if (!fileIdentifier && !options.name) {
+        throw new Error('Filename or path is required.');
+    }
+    try {
+        const content = content_get(options);
+        const resolvedChRISPath = await path_resolveChrisFs(fileIdentifier, options);
+        const success = await salsaFiles_create(content, resolvedChRISPath);
+        if (!success) {
+            const errorStackItems = errorStack_getAllOfType("error");
+            if (errorStackItems.length > 0) {
+                // We throw here so that the calling handler can decide how to display the error.
+                throw new Error(errorStackItems.join(', '));
+            }
+            else {
+                throw new Error(`An unknown error occurred while creating the file at ${resolvedChRISPath}.`);
+            }
+        }
+        return success;
+    }
+    catch (error) {
+        if (error instanceof Error) {
+            // Re-throw with a more specific prefix to aid debugging
+            throw new Error(`Error creating file: ${error.message}`);
+        }
+        // Re-throw anything else
+        throw error;
+    }
+}

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

@@ -0,0 +1,25 @@
+import { bytes_format } from "./upload.js";
+export { bytes_format };
+/**
+ * Download summary statistics.
+ */
+export interface DownloadSummary {
+    startTime: number;
+    endTime: number;
+    totalFiles: number;
+    transferredCount: number;
+    failedCount: number;
+    transferSize: number;
+    duration: number;
+    speed: number;
+}
+/**
+ * Downloads files from ChRIS with a progress bar display.
+ * @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>;