@fnndsc/chili 3.2.5

package/dist/commands/pipeline/run.js

@@ -0,0 +1,33 @@
+/**
+ * @file Pipeline run command — creates a workflow from a registered pipeline.
+ * @module
+ */
+import { chrisContext, errorStack, Err, } from "@fnndsc/cumin";
+import { pipeline_run as salsa_pipeline_run, } from "@fnndsc/salsa";
+/**
+ * Runs a pipeline by name or ID, attaching it to the current plugin context node
+ * or an explicitly supplied previous instance ID.
+ *
+ * @param nameOrId - Pipeline name or numeric ID.
+ * @param options - Optional compute override and explicit previous instance ID.
+ * @returns Result containing workflow ID and created plugin instance IDs.
+ */
+export async function pipeline_execute(nameOrId, options = {}) {
+    let previousInstId;
+    if (options.previousInstId !== undefined) {
+        previousInstId = options.previousInstId;
+    }
+    else {
+        const contextInstStr = await chrisContext.ChRISplugin_get();
+        if (!contextInstStr) {
+            errorStack.stack_push('error', 'No plugin instance in context. Navigate to a feed node first, or supply --previous <id>.');
+            return Err();
+        }
+        previousInstId = parseInt(contextInstStr, 10);
+        if (isNaN(previousInstId)) {
+            errorStack.stack_push('error', `Invalid plugin instance in context: '${contextInstStr}'`);
+            return Err();
+        }
+    }
+    return salsa_pipeline_run(nameOrId, previousInstId, options.compute);
+}

package/dist/commands/plugin/readme.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Fetches the raw README content for a plugin.
+ *
+ * @param pluginId - The ID of the plugin.
+ * @returns A Promise resolving to the README content as a string, or `null` if not available.
+ */
+export declare function pluginReadme_fetch(pluginId: string): Promise<string | null>;
+/**
+ * Renders raw README markdown/rst content for terminal display.
+ *
+ * @param content - Raw README string.
+ * @returns ANSI-styled string ready for console output.
+ */
+export declare function pluginReadme_render(content: string): string;

package/dist/commands/plugin/readme.js

@@ -0,0 +1,49 @@
+/**
+ * @file Implements the logic for retrieving a ChRIS plugin's README.
+ *
+ * This module provides functionality to fetch the README content
+ * for a specific plugin by its ID.
+ *
+ * @module
+ */
+import { plugin_readme as salsaPlugin_readme } from "@fnndsc/salsa";
+import { marked } from "marked";
+import TerminalRenderer from "marked-terminal";
+import chalk from "chalk";
+marked.setOptions({
+    renderer: new TerminalRenderer({
+        code: chalk.yellow,
+        blockquote: chalk.gray.italic,
+        html: chalk.gray,
+        heading: chalk.green.bold,
+        firstHeading: chalk.magenta.underline.bold,
+        hr: chalk.reset,
+        listitem: chalk.cyan,
+        table: chalk.white,
+        paragraph: chalk.white,
+        strong: chalk.bold,
+        em: chalk.italic,
+        codespan: chalk.yellow,
+        del: chalk.dim.gray.strikethrough,
+        link: chalk.cyan,
+        href: chalk.blueBright.underline,
+    }),
+});
+/**
+ * Fetches the raw README content for a plugin.
+ *
+ * @param pluginId - The ID of the plugin.
+ * @returns A Promise resolving to the README content as a string, or `null` if not available.
+ */
+export async function pluginReadme_fetch(pluginId) {
+    return await salsaPlugin_readme(pluginId);
+}
+/**
+ * Renders raw README markdown/rst content for terminal display.
+ *
+ * @param content - Raw README string.
+ * @returns ANSI-styled string ready for console output.
+ */
+export function pluginReadme_render(content) {
+    return marked(content);
+}

package/dist/commands/plugin/run.d.ts

@@ -0,0 +1,10 @@
+import { PluginInstance } from "../../models/plugin.js";
+/**
+ * Executes a ChRIS plugin with the specified parameters.
+ *
+ * @param searchable - The plugin identifier (ID or name) to run.
+ * @param params - The raw parameter string from the CLI (e.g., "--param1 value1 --param2 value2").
+ * @returns A Promise resolving to the created plugin instance, or `null` on failure.
+ * @throws {Error} If the parameter string cannot be parsed.
+ */
+export declare function plugin_execute(searchable: string, params: string): Promise<PluginInstance | null>;

package/dist/commands/plugin/run.js

@@ -0,0 +1,29 @@
+/**
+ * @file Implements the logic for running (executing) a ChRIS plugin.
+ *
+ * This module provides functionality to parse CLI parameters and trigger
+ * a plugin instance execution on the ChRIS backend.
+ *
+ * @module
+ */
+import { dictionary_fromCLI } from "@fnndsc/cumin";
+import { plugin_run as salsaPlugin_run } from "@fnndsc/salsa";
+/**
+ * Executes a ChRIS plugin with the specified parameters.
+ *
+ * @param searchable - The plugin identifier (ID or name) to run.
+ * @param params - The raw parameter string from the CLI (e.g., "--param1 value1 --param2 value2").
+ * @returns A Promise resolving to the created plugin instance, or `null` on failure.
+ * @throws {Error} If the parameter string cannot be parsed.
+ */
+export async function plugin_execute(searchable, params) {
+    let parsedParams = {};
+    try {
+        parsedParams = dictionary_fromCLI(params);
+    }
+    catch (e) {
+        throw new Error(`Error parsing plugin parameters: ${e}`);
+    }
+    const result = await salsaPlugin_run(searchable, parsedParams);
+    return result;
+}

package/dist/commands/plugin/search.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Resolves a search term (name or ID) to a list of matching plugin IDs.
+ *
+ * @param searchable - The search string (e.g., plugin name or "id:123").
+ * @returns A Promise resolving to an array of plugin ID strings, or `null` if none found.
+ */
+export declare function pluginIds_resolve(searchable: string): Promise<string[] | null>;

package/dist/commands/plugin/search.js

@@ -0,0 +1,18 @@
+/**
+ * @file Implements the logic for resolving plugin identifiers to IDs.
+ *
+ * This module provides functionality to search for plugins and retrieve
+ * their IDs, often used as a precursor to other operations like `run` or `readme`.
+ *
+ * @module
+ */
+import { plugins_searchableToIDs as salsaPlugins_searchableToIDs } from "@fnndsc/salsa";
+/**
+ * Resolves a search term (name or ID) to a list of matching plugin IDs.
+ *
+ * @param searchable - The search string (e.g., plugin name or "id:123").
+ * @returns A Promise resolving to an array of plugin ID strings, or `null` if none found.
+ */
+export async function pluginIds_resolve(searchable) {
+    return await salsaPlugins_searchableToIDs(searchable);
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Fetches the available plugin-instance field names.
+ *
+ * @returns The plugin-instance field names, or null on failure.
+ */
+export declare function pluginInstanceFields_fetch(): Promise<string[] | null>;

package/dist/commands/plugininstances/fields.js

@@ -0,0 +1,13 @@
+/**
+ * @file Fetches available fields for plugin instance resources.
+ * @module
+ */
+import { pluginInstanceFields_get } from '@fnndsc/salsa';
+/**
+ * Fetches the available plugin-instance field names.
+ *
+ * @returns The plugin-instance field names, or null on failure.
+ */
+export async function pluginInstanceFields_fetch() {
+    return await pluginInstanceFields_get();
+}

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

@@ -0,0 +1,16 @@
+import { CLIoptions } from '../../utils/cli.js';
+/**
+ * Result of listing plugin-instances (table data plus selected fields).
+ */
+export interface PluginInstanceListResult {
+    pluginInstances: Record<string, unknown>[];
+    selectedFields: string[];
+    totalCount?: number;
+}
+/**
+ * Fetches a list of plugin-instances.
+ *
+ * @param options - List and filter options.
+ * @returns The plugin-instances list result.
+ */
+export declare function pluginInstances_fetchList(options: CLIoptions): Promise<PluginInstanceListResult>;

package/dist/commands/plugininstances/list.js

@@ -0,0 +1,26 @@
+/**
+ * @file Implements listing ChRIS plugin instances (jobs).
+ * @module
+ */
+import { pluginInstances_list as salsaPluginInstances_list, pluginInstances_listAll as salsaPluginInstances_listAll } from '@fnndsc/salsa';
+import { options_toParams } from '../../utils/cli.js';
+import { list_applySort } from '../../utils/sort.js';
+/**
+ * Fetches a list of plugin-instances.
+ *
+ * @param options - List and filter options.
+ * @returns The plugin-instances list result.
+ */
+export async function pluginInstances_fetchList(options) {
+    const params = options_toParams(options);
+    const result = options.all
+        ? await salsaPluginInstances_listAll(params)
+        : await salsaPluginInstances_list(params);
+    if (result && result.tableData) {
+        let pluginInstances = result.tableData;
+        if (options.sort)
+            pluginInstances = list_applySort(pluginInstances, options.sort, options.reverse);
+        return { pluginInstances, selectedFields: result.selectedFields || [], totalCount: result.totalCount };
+    }
+    return { pluginInstances: [], selectedFields: [] };
+}

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

@@ -0,0 +1,6 @@
+/**
+ * Fetches the available plugin-meta field names.
+ *
+ * @returns The plugin-meta field names, or null on failure.
+ */
+export declare function pluginMetaFields_fetch(): Promise<string[] | null>;

package/dist/commands/pluginmetas/fields.js

@@ -0,0 +1,13 @@
+/**
+ * @file Fetches available fields for plugin meta resources.
+ * @module
+ */
+import { pluginMetaFields_get } from '@fnndsc/salsa';
+/**
+ * Fetches the available plugin-meta field names.
+ *
+ * @returns The plugin-meta field names, or null on failure.
+ */
+export async function pluginMetaFields_fetch() {
+    return await pluginMetaFields_get();
+}

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

@@ -0,0 +1,16 @@
+import { CLIoptions } from '../../utils/cli.js';
+/**
+ * Result of listing plugin-metas (table data plus selected fields).
+ */
+export interface PluginMetaListResult {
+    pluginMetas: Record<string, unknown>[];
+    selectedFields: string[];
+    totalCount?: number;
+}
+/**
+ * Fetches a list of plugin-metas.
+ *
+ * @param options - List and filter options.
+ * @returns The plugin-metas list result.
+ */
+export declare function pluginMetas_fetchList(options: CLIoptions): Promise<PluginMetaListResult>;

package/dist/commands/pluginmetas/list.js

@@ -0,0 +1,26 @@
+/**
+ * @file Implements listing ChRIS plugin metas.
+ * @module
+ */
+import { pluginMetas_list as salsaPluginMetas_list, pluginMetas_listAll as salsaPluginMetas_listAll } from '@fnndsc/salsa';
+import { options_toParams } from '../../utils/cli.js';
+import { list_applySort } from '../../utils/sort.js';
+/**
+ * Fetches a list of plugin-metas.
+ *
+ * @param options - List and filter options.
+ * @returns The plugin-metas list result.
+ */
+export async function pluginMetas_fetchList(options) {
+    const params = options_toParams(options);
+    const result = options.all
+        ? await salsaPluginMetas_listAll(params)
+        : await salsaPluginMetas_list(params);
+    if (result && result.tableData) {
+        let pluginMetas = result.tableData;
+        if (options.sort)
+            pluginMetas = list_applySort(pluginMetas, options.sort, options.reverse);
+        return { pluginMetas, selectedFields: result.selectedFields || [], totalCount: result.totalCount };
+    }
+    return { pluginMetas: [], selectedFields: [] };
+}

package/dist/commands/plugins/add.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @file Implements the logic for adding (registering) new ChRIS plugins.
+ *
+ * This module orchestrates a three-phase plugin registration strategy:
+ * 1. Check if plugin exists in current CUBE → assign to compute resources
+ * 2. Search peer stores → import from store if found
+ * 3. Docker extraction → pull image, extract JSON, register
+ *
+ * @module
+ */
+import { CLIoptions } from '../../utils/cli.js';
+/**
+ * Options specific to plugin add command.
+ */
+interface PluginAddOptions extends CLIoptions {
+    compute?: string;
+    store?: string;
+    adminUser?: string;
+    adminPassword?: string;
+    public_repo?: string;
+}
+/**
+ * Outcome of a plugin add operation.
+ */
+export type PluginAddOutcome = 'installed' | 'already_exists' | 'failed';
+/**
+ * Adds a plugin to the ChRIS store from the given input.
+ *
+ * @param input - Plugin source (image, URL, or path).
+ * @param options - Plugin add options.
+ * @returns The add outcome.
+ */
+export declare function plugin_add(input: string, options: PluginAddOptions): Promise<PluginAddOutcome>;
+export {};