@fnndsc/chili 3.2.5

package/dist/controllers/feedController.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @file Controller for feed business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISFeedGroup, SimpleRecord } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+import { CLIoptions } from "../utils/cli.js";
+/**
+ * Controller for managing ChRIS feeds.
+ * Handles feed creation, sharing, and other feed-specific operations.
+ */
+export declare class FeedController extends BaseController {
+    constructor(chrisObject: ChRISFeedGroup);
+    /**
+     * Factory method to create a new FeedController.
+     *
+     * @returns A new FeedController instance.
+     */
+    static controller_create(): FeedController;
+    /**
+     * Shares feeds based on CLI options.
+     *
+     * @param options - CLI options for sharing.
+     * @returns A Promise resolving to void.
+     */
+    feeds_share(options: CLIoptions): Promise<void>;
+    /**
+     * Creates a new feed from directories.
+     *
+     * @param options - CLI options containing 'dirs' and other feed params.
+     * @returns A Promise resolving to the created feed's SimpleRecord or null.
+     */
+    feed_create(options: CLIoptions): Promise<SimpleRecord | null>;
+}

package/dist/controllers/feedController.js

@@ -0,0 +1,53 @@
+/**
+ * @file Controller for feed business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISFeedGroup, ChRISFeed, listParams_fromOptions } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+/**
+ * Controller for managing ChRIS feeds.
+ * Handles feed creation, sharing, and other feed-specific operations.
+ */
+export class FeedController extends BaseController {
+    constructor(chrisObject) {
+        super(chrisObject);
+    }
+    /**
+     * Factory method to create a new FeedController.
+     *
+     * @returns A new FeedController instance.
+     */
+    static controller_create() {
+        const chrisFeedGroup = new ChRISFeedGroup();
+        return new FeedController(chrisFeedGroup);
+    }
+    /**
+     * Shares feeds based on CLI options.
+     *
+     * @param options - CLI options for sharing.
+     * @returns A Promise resolving to void.
+     */
+    async feeds_share(options) {
+        // Placeholder logic
+        return Promise.resolve();
+    }
+    /**
+     * Creates a new feed from directories.
+     *
+     * @param options - CLI options containing 'dirs' and other feed params.
+     * @returns A Promise resolving to the created feed's SimpleRecord or null.
+     */
+    async feed_create(options) {
+        const chrisFeed = new ChRISFeed();
+        try {
+            const dirs = options.dirs;
+            const feedParams = listParams_fromOptions({ ...options, returnFilter: "params" });
+            return await chrisFeed.createFromDirs(dirs, feedParams);
+        }
+        catch (error) {
+            // Logging handled by cumin errorStack or caller
+            return null;
+        }
+    }
+}

package/dist/controllers/fileController.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @file Controller for file business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISEmbeddedResourceGroup, ChrisPathNode } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+import { CLIoptions } from "../utils/cli.js";
+/**
+ * Controller for managing ChRIS file system resources (files, links, directories).
+ * Extends BaseController to provide file-specific functionality.
+ * This class now acts as a CLI-specific adapter for the core file logic in Salsa.
+ */
+export declare class FileController extends BaseController {
+    private _path;
+    private _assetName;
+    constructor(chrisObject: ChRISEmbeddedResourceGroup<ChrisPathNode>, path: string, assetName: string);
+    /**
+     * Factory method to create a FileController for a specific asset type.
+     * Now leverages `salsa`'s `files_getGroup`.
+     *
+     * @param assetName - The type of asset ('files', 'links', 'dirs').
+     * @param path - Optional path. Defaults to current context.
+     * @returns A Promise resolving to a new FileController instance, or null on error.
+     * @throws Error if asset type is unsupported or context creation fails.
+     */
+    static handler_create(assetName: string, path?: string): Promise<FileController | null>;
+    /**
+     * Factory method to create a FileController for a single file.
+     * Now leverages `salsa`'s `files_getSingle`.
+     *
+     * @param path - The path to the file.
+     * @returns A Promise resolving to a new FileController, or null on error.
+     * @throws Error if context creation fails.
+     */
+    static member_create(path: string): Promise<FileController | null>;
+    /**
+     * Shares files using `salsa`'s logic.
+     *
+     * @param options - CLI options for sharing. Expected to contain `fileId` and other sharing parameters.
+     * @returns A Promise resolving to void.
+     */
+    files_share(options: CLIoptions): Promise<void>;
+    /**
+     * Views content of a file using `salsa`'s logic.
+     *
+     * @param options - CLI options for viewing. Expected to contain `fileId` and other viewing parameters.
+     * @returns A Promise resolving to void (output is handled by salsa or logged).
+     */
+    file_view(filePath: string): Promise<void>;
+    /**
+     * Gets the current path associated with this controller.
+     * @returns The path string.
+     */
+    get path_get(): string;
+}

package/dist/controllers/fileController.js

@@ -0,0 +1,93 @@
+/**
+ * @file Controller for file business logic and presentation.
+ *
+ * @module
+ */
+import { errorStack } from "@fnndsc/cumin";
+import chalk from 'chalk';
+import { BaseController } from "./baseController.js";
+import { files_getGroup, files_getSingle, files_share as salsaFiles_share, fileContent_get } from "@fnndsc/salsa";
+/**
+ * Controller for managing ChRIS file system resources (files, links, directories).
+ * Extends BaseController to provide file-specific functionality.
+ * This class now acts as a CLI-specific adapter for the core file logic in Salsa.
+ */
+export class FileController extends BaseController {
+    constructor(chrisObject, path, assetName) {
+        super(chrisObject);
+        this._path = path;
+        this._assetName = assetName;
+    }
+    /**
+     * Factory method to create a FileController for a specific asset type.
+     * Now leverages `salsa`'s `files_getGroup`.
+     *
+     * @param assetName - The type of asset ('files', 'links', 'dirs').
+     * @param path - Optional path. Defaults to current context.
+     * @returns A Promise resolving to a new FileController instance, or null on error.
+     * @throws Error if asset type is unsupported or context creation fails.
+     */
+    static async handler_create(assetName, path) {
+        const chrisFileSystemGroup = await files_getGroup(assetName, path);
+        if (!chrisFileSystemGroup) {
+            // Error handling is done in salsa, so we just pass null here
+            return null;
+        }
+        const groupWithFolder = chrisFileSystemGroup;
+        const effectivePath = path || groupWithFolder.folder || "";
+        return new FileController(chrisFileSystemGroup, effectivePath, assetName);
+    }
+    /**
+     * Factory method to create a FileController for a single file.
+     * Now leverages `salsa`'s `files_getSingle`.
+     *
+     * @param path - The path to the file.
+     * @returns A Promise resolving to a new FileController, or null on error.
+     * @throws Error if context creation fails.
+     */
+    static async member_create(path) {
+        const chrisFilesGroup = await files_getSingle(path);
+        if (!chrisFilesGroup) {
+            // Error handling is done in salsa, so we just pass null here
+            return null;
+        }
+        return new FileController(chrisFilesGroup, path, "file");
+    }
+    /**
+     * Shares files using `salsa`'s logic.
+     *
+     * @param options - CLI options for sharing. Expected to contain `fileId` and other sharing parameters.
+     * @returns A Promise resolving to void.
+     */
+    async files_share(options) {
+        const fileId = options.fileId; // Assuming CLIoptions has a fileId property
+        if (fileId === undefined) {
+            console.error("Error: fileId is required for sharing.");
+            return;
+        }
+        const shareOptions = { ...options }; // Pass all CLI options as share options for now
+        await salsaFiles_share(fileId, shareOptions);
+    }
+    /**
+     * Views content of a file using `salsa`'s logic.
+     *
+     * @param options - CLI options for viewing. Expected to contain `fileId` and other viewing parameters.
+     * @returns A Promise resolving to void (output is handled by salsa or logged).
+     */
+    async file_view(filePath) {
+        const result = await fileContent_get(filePath);
+        if (!result.ok) {
+            const error = errorStack.stack_pop();
+            console.error(chalk.red(`Error viewing file: ${error?.message || 'Unknown error'}`));
+            return;
+        }
+        console.log(result.value);
+    }
+    /**
+     * Gets the current path associated with this controller.
+     * @returns The path string.
+     */
+    get path_get() {
+        return this._path;
+    }
+}

package/dist/controllers/pluginContextController.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @file Controller for plugin-context business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISEmbeddedResourceGroup, ChrisPluginSummary } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+/**
+ * Controller for managing plugin context resources (computes, instances, parameters).
+ */
+export declare class PluginContextController extends BaseController {
+    private _id;
+    private _assetName;
+    constructor(chrisObject: ChRISEmbeddedResourceGroup<ChrisPluginSummary>, id: number | null, assetName: string);
+    /**
+     * Factory method to create a new PluginContextController instance.
+     *
+     * @param assetName - The type of plugin context to handle ('computesofplugin', 'instancesofplugin', 'parametersofplugin').
+     * @param id - Optional plugin ID. Defaults to current ChRIS plugin context.
+     * @returns A Promise resolving to a new PluginContextController instance.
+     * @throws Error if an unsupported asset type is provided or initialization fails.
+     */
+    static controller_create(assetName: string, id?: number | null): Promise<PluginContextController>;
+}

package/dist/controllers/pluginContextController.js

@@ -0,0 +1,49 @@
+/**
+ * @file Controller for plugin-context business logic and presentation.
+ *
+ * @module
+ */
+import { objContext_create, chrisContext, Context, } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+/**
+ * Controller for managing plugin context resources (computes, instances, parameters).
+ */
+export class PluginContextController extends BaseController {
+    constructor(chrisObject, id, assetName) {
+        super(chrisObject);
+        this._id = id;
+        this._assetName = assetName;
+    }
+    /**
+     * Factory method to create a new PluginContextController instance.
+     *
+     * @param assetName - The type of plugin context to handle ('computesofplugin', 'instancesofplugin', 'parametersofplugin').
+     * @param id - Optional plugin ID. Defaults to current ChRIS plugin context.
+     * @returns A Promise resolving to a new PluginContextController instance.
+     * @throws Error if an unsupported asset type is provided or initialization fails.
+     */
+    static async controller_create(assetName, id) {
+        if (!id) {
+            const pluginContext = await chrisContext.current_get(Context.ChRISplugin);
+            id = pluginContext ? Number(pluginContext) : 1;
+        }
+        let chrisPluginSystemGroup = null;
+        switch (assetName) {
+            case "computesofplugin":
+                chrisPluginSystemGroup = (await objContext_create("ComputesOfPlugin", `plugin:${id}`));
+                break;
+            case "instancesofplugin":
+                chrisPluginSystemGroup = (await objContext_create("InstancesOfPlugin", `plugin:${id}`));
+                break;
+            case "parametersofplugin":
+                chrisPluginSystemGroup = (await objContext_create("ParametersOfPlugin", `plugin:${id}`));
+                break;
+            default:
+                throw new Error(`Unsupported asset type: ${assetName}`);
+        }
+        if (!chrisPluginSystemGroup) {
+            throw new Error(`Failed to initialize plugin context group for ${assetName}`);
+        }
+        return new PluginContextController(chrisPluginSystemGroup, id, assetName);
+    }
+}

package/dist/controllers/pluginController.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @file Controller for plugin business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISPluginGroup, Dictionary } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+import { CLIoptions } from "../utils/cli.js";
+/**
+ * Controller for managing ChRIS plugins.
+ * Handles plugin searching, running, and group operations.
+ */
+export declare class PluginController extends BaseController {
+    constructor(chrisObject: ChRISPluginGroup);
+    /**
+     * Factory method to create a new PluginController.
+     *
+     * @returns A new PluginController instance.
+     */
+    static controller_create(): PluginController;
+    /**
+     * Provides an overview of plugin-group operations (placeholder).
+     *
+     * @returns A Promise resolving to void.
+     */
+    plugins_overview(): Promise<void>;
+    /**
+     * Fetches detailed information for a specific plugin (placeholder).
+     *
+     * @param pluginId - The ID of the plugin.
+     * @returns A Promise resolving to void (logging happens in handler for now, or should move here?).
+     */
+    plugin_infoGet(pluginId: string): Promise<void>;
+    /**
+     * Runs a plugin instance.
+     *
+     * @param searchable - The plugin search string.
+     * @param params - The plugin parameters.
+     * @returns A Promise resolving to the created instance dictionary or null.
+     */
+    plugin_run(searchable: string, params: string): Promise<Dictionary | null>;
+    /**
+     * Resolves a searchable plugin string to a list of IDs.
+     *
+     * @param searchable - The search string.
+     * @returns A Promise resolving to an array of IDs or null.
+     */
+    plugin_searchableToIDs(searchable: string): Promise<string[] | null>;
+    /**
+     * Retrieves the raw README content from a repository URL.
+     *
+     * @param repoUrl - The base URL of the plugin repository.
+     * @returns A Promise resolving to the README content string or null if not found.
+     */
+    readmeContent_fetch(repoUrl: string): Promise<string | null>;
+    /**
+     * Retrieves the documentation URL for a specific plugin ID.
+     *
+     * @param pluginId - The ID of the plugin.
+     * @returns A Promise resolving to the documentation URL or null.
+     */
+    documentationUrl_get(pluginId: string): Promise<string | null>;
+    /**
+     * Retrieves a plugin ID based on search options.
+     *
+     * @param options - CLI options for searching for a plugin.
+     * @returns A Promise resolving to the plugin ID as a string, or null if not found/ambiguous.
+     */
+    pluginID_fromSearch(options: CLIoptions): Promise<string | null>;
+}

package/dist/controllers/pluginController.js

@@ -0,0 +1,98 @@
+/**
+ * @file Controller for plugin business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISPluginGroup, dictionary_fromCLI } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+import { plugin_run as salsaPlugin_run, plugins_searchableToIDs as salsaPlugins_searchableToIDs, pluginMeta_readmeContentFetch, pluginMeta_documentationUrlGet, pluginMeta_pluginIDFromSearch } from "@fnndsc/salsa";
+/**
+ * Controller for managing ChRIS plugins.
+ * Handles plugin searching, running, and group operations.
+ */
+export class PluginController extends BaseController {
+    constructor(chrisObject) {
+        super(chrisObject);
+    }
+    /**
+     * Factory method to create a new PluginController.
+     *
+     * @returns A new PluginController instance.
+     */
+    static controller_create() {
+        const chrisPluginGroup = new ChRISPluginGroup();
+        return new PluginController(chrisPluginGroup);
+    }
+    /**
+     * Provides an overview of plugin-group operations (placeholder).
+     *
+     * @returns A Promise resolving to void.
+     */
+    async plugins_overview() {
+        return Promise.resolve();
+    }
+    /**
+     * Fetches detailed information for a specific plugin (placeholder).
+     *
+     * @param pluginId - The ID of the plugin.
+     * @returns A Promise resolving to void (logging happens in handler for now, or should move here?).
+     */
+    async plugin_infoGet(pluginId) {
+        // Placeholder, logic was mainly logging in handler
+        return Promise.resolve();
+    }
+    /**
+     * Runs a plugin instance.
+     *
+     * @param searchable - The plugin search string.
+     * @param params - The plugin parameters.
+     * @returns A Promise resolving to the created instance dictionary or null.
+     */
+    async plugin_run(searchable, params) {
+        let parsedParams = {};
+        try {
+            parsedParams = dictionary_fromCLI(params);
+        }
+        catch (e) {
+            console.error("Error parsing plugin parameters:", e);
+            return null;
+        }
+        return await salsaPlugin_run(searchable, parsedParams);
+    }
+    /**
+     * Resolves a searchable plugin string to a list of IDs.
+     *
+     * @param searchable - The search string.
+     * @returns A Promise resolving to an array of IDs or null.
+     */
+    async plugin_searchableToIDs(searchable) {
+        return await salsaPlugins_searchableToIDs(searchable);
+    }
+    /**
+     * Retrieves the raw README content from a repository URL.
+     *
+     * @param repoUrl - The base URL of the plugin repository.
+     * @returns A Promise resolving to the README content string or null if not found.
+     */
+    async readmeContent_fetch(repoUrl) {
+        return await pluginMeta_readmeContentFetch(repoUrl);
+    }
+    /**
+     * Retrieves the documentation URL for a specific plugin ID.
+     *
+     * @param pluginId - The ID of the plugin.
+     * @returns A Promise resolving to the documentation URL or null.
+     */
+    async documentationUrl_get(pluginId) {
+        return await pluginMeta_documentationUrlGet(pluginId);
+    }
+    /**
+     * Retrieves a plugin ID based on search options.
+     *
+     * @param options - CLI options for searching for a plugin.
+     * @returns A Promise resolving to the plugin ID as a string, or null if not found/ambiguous.
+     */
+    async pluginID_fromSearch(options) {
+        return await pluginMeta_pluginIDFromSearch(options);
+    }
+}

package/dist/controllers/pluginMetaController.d.ts

@@ -0,0 +1,41 @@
+/**
+ * @file Controller mediating plugin-meta business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISPluginMetaPluginGroup } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+import { CLIoptions } from "../utils/cli.js";
+/**
+ * Controller for managing ChRIS plugin metadata.
+ */
+export declare class PluginMetaController extends BaseController {
+    constructor(chrisObject: ChRISPluginMetaPluginGroup);
+    /**
+     * Factory method to create a new PluginMetaController.
+     *
+     * @returns A new PluginMetaController instance.
+     */
+    static controller_create(): PluginMetaController;
+    /**
+     * Retrieves the raw README content from a repository URL.
+     *
+     * @param repoUrl - The base URL of the plugin repository.
+     * @returns A Promise resolving to the README content string or null if not found.
+     */
+    readmeContent_fetch(repoUrl: string): Promise<string | null>;
+    /**
+     * Retrieves the documentation URL for a specific plugin ID.
+     *
+     * @param pluginId - The ID of the plugin.
+     * @returns A Promise resolving to the documentation URL or null.
+     */
+    documentationUrl_get(pluginId: string): Promise<string | null>;
+    /**
+     * Retrieves a plugin ID based on search options.
+     *
+     * @param options - CLI options for searching for a plugin.
+     * @returns A Promise resolving to the plugin ID as a string, or null if not found/ambiguous.
+     */
+    pluginID_fromSearch(options: CLIoptions): Promise<string | null>;
+}

package/dist/controllers/pluginMetaController.js

@@ -0,0 +1,52 @@
+/**
+ * @file Controller mediating plugin-meta business logic and presentation.
+ *
+ * @module
+ */
+import { ChRISPluginMetaPluginGroup, } from "@fnndsc/cumin";
+import { BaseController } from "./baseController.js";
+import { pluginMeta_readmeContentFetch, pluginMeta_documentationUrlGet, pluginMeta_pluginIDFromSearch } from "@fnndsc/salsa";
+/**
+ * Controller for managing ChRIS plugin metadata.
+ */
+export class PluginMetaController extends BaseController {
+    constructor(chrisObject) {
+        super(chrisObject);
+    }
+    /**
+     * Factory method to create a new PluginMetaController.
+     *
+     * @returns A new PluginMetaController instance.
+     */
+    static controller_create() {
+        const chrisPluginMetaGroup = new ChRISPluginMetaPluginGroup();
+        return new PluginMetaController(chrisPluginMetaGroup);
+    }
+    /**
+     * Retrieves the raw README content from a repository URL.
+     *
+     * @param repoUrl - The base URL of the plugin repository.
+     * @returns A Promise resolving to the README content string or null if not found.
+     */
+    async readmeContent_fetch(repoUrl) {
+        return await pluginMeta_readmeContentFetch(repoUrl);
+    }
+    /**
+     * Retrieves the documentation URL for a specific plugin ID.
+     *
+     * @param pluginId - The ID of the plugin.
+     * @returns A Promise resolving to the documentation URL or null.
+     */
+    async documentationUrl_get(pluginId) {
+        return await pluginMeta_documentationUrlGet(pluginId);
+    }
+    /**
+     * Retrieves a plugin ID based on search options.
+     *
+     * @param options - CLI options for searching for a plugin.
+     * @returns A Promise resolving to the plugin ID as a string, or null if not found/ambiguous.
+     */
+    async pluginID_fromSearch(options) {
+        return await pluginMeta_pluginIDFromSearch(options);
+    }
+}

package/dist/feeds/feedHandler.d.ts

@@ -0,0 +1,64 @@
+/**
+ * @file Manages command groups and member operations for ChRIS feeds.
+ *
+ * This module defines the `FeedGroupHandler` and `FeedMemberHandler` classes,
+ * which orchestrate CLI commands for lists of feeds and individual feed operations.
+ *
+ * @module
+ */
+import { Command } from "commander";
+import { CLIoptions } from "../utils/cli.js";
+import { Feed } from "../models/feed.js";
+/**
+ * Handles commands related to groups of ChRIS feeds.
+ */
+export declare class FeedGroupHandler {
+    private baseGroupHandler;
+    private controller;
+    assetName: string;
+    constructor();
+    /**
+     * Lists feed fields using the new command logic.
+     */
+    feeds_fields(): Promise<void>;
+    /**
+     * Shares feeds matching a search term.
+     *
+     * @param searchable - The search term to find feeds.
+     * @param options - Sharing options (e.g. is_public).
+     */
+    feeds_share(searchable: string, options: CLIoptions): Promise<void>;
+    /**
+     * Deletes feeds using the new command logic.
+     * @param searchable - A string resolving to feed IDs.
+     * @param options - CLI options, including --force.
+     */
+    feeds_delete(searchable: string, options: CLIoptions): Promise<void>;
+    /**
+     * Sets up the Commander.js commands for feed group operations.
+     *
+     * @param program - The Commander.js program instance.
+     */
+    feedGroupCommand_setup(program: Command): void;
+}
+/**
+ * Handles commands related to individual ChRIS feeds.
+ */
+export declare class FeedMemberHandler {
+    private assetName;
+    private controller;
+    constructor();
+    /**
+     * Creates a new ChRIS feed based on CLI options.
+     *
+     * @param options - CLI options for feed creation.
+     * @returns A Promise resolving to the created Feed object, or null on failure.
+     */
+    feed_create(options: CLIoptions): Promise<Feed | null>;
+    /**
+     * Sets up the Commander.js commands for individual feed operations.
+     *
+     * @param program - The Commander.js program instance.
+     */
+    feedCommand_setup(program: Command): void;
+}