@fnndsc/cumin 3.2.4

package/dist/path/chrisPath.js

@@ -0,0 +1,190 @@
+"use strict";
+/**
+ * @file ChRIS Path Analysis
+ *
+ * This module provides utilities for analyzing ChRIS filesystem paths.
+ * It determines execution context based on directory structure and extracts
+ * metadata from path components.
+ *
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.path_isInFeed = path_isInFeed;
+exports.path_extractPluginInstanceID = path_extractPluginInstanceID;
+exports.path_extractFeedID = path_extractFeedID;
+exports.path_findLatestDircopy = path_findLatestDircopy;
+const path = __importStar(require("path"));
+/**
+ * Determines if a path is within a ChRIS feed directory.
+ *
+ * Checks if the path contains the pattern: /feeds/feed_<numeric-id>/
+ *
+ * @param dirPath - The directory path to check.
+ * @returns True if the path is within a feed directory, false otherwise.
+ *
+ * @example
+ * ```typescript
+ * path_isInFeed('/home/chris/feeds/feed_123/pl-dircopy_456/data/')  // true
+ * path_isInFeed('/home/chris/uploads/data/')                         // false
+ * ```
+ */
+function path_isInFeed(dirPath) {
+    // Pattern: /feeds/feed_<digits>/
+    const feedPattern = /\/feeds\/feed_\d+\//;
+    return feedPattern.test(dirPath);
+}
+/**
+ * Extracts the plugin instance ID from a path by finding the nearest
+ * ancestor directory matching the pattern: <plugin-name>_<instanceID>
+ *
+ * Walks up the directory tree from the given path until finding a directory
+ * that matches the plugin instance naming pattern.
+ *
+ * @param dirPath - The directory path to analyze.
+ * @returns The plugin instance ID as a number, or null if not found.
+ *
+ * @example
+ * ```typescript
+ * // From deep subdirectory
+ * path_extractPluginInstanceID('/home/chris/feeds/feed_123/pl-dircopy_456/data/sub/dir/')
+ * // Returns: 456
+ *
+ * // From data directory
+ * path_extractPluginInstanceID('/home/chris/feeds/feed_123/pl-dcm2niix_789/data/')
+ * // Returns: 789
+ * ```
+ */
+function path_extractPluginInstanceID(dirPath) {
+    // Pattern: <plugin-name>_<digits>
+    const instancePattern = /^(.+)_(\d+)$/;
+    // Walk up the directory tree
+    let currentPath = path.normalize(dirPath);
+    const root = path.parse(currentPath).root;
+    while (currentPath !== root) {
+        const dirname = path.basename(currentPath);
+        const match = dirname.match(instancePattern);
+        if (match) {
+            // Found a match: extract the instance ID
+            const instanceID = parseInt(match[2], 10);
+            return instanceID;
+        }
+        // Move up one directory
+        const parent = path.dirname(currentPath);
+        if (parent === currentPath) {
+            // Reached root without finding a match
+            break;
+        }
+        currentPath = parent;
+    }
+    return null;
+}
+/**
+ * Extracts the feed ID from a path.
+ *
+ * Looks for the pattern: /feeds/feed_<numeric-id>/ in the path.
+ *
+ * @param dirPath - The directory path to analyze.
+ * @returns The feed ID as a number, or null if not found.
+ *
+ * @example
+ * ```typescript
+ * path_extractFeedID('/home/chris/feeds/feed_123/pl-dircopy_456/data/')
+ * // Returns: 123
+ * ```
+ */
+function path_extractFeedID(dirPath) {
+    // Pattern: /feeds/feed_<digits>/
+    const feedPattern = /\/feeds\/feed_(\d+)\//;
+    const match = dirPath.match(feedPattern);
+    if (match) {
+        return parseInt(match[1], 10);
+    }
+    return null;
+}
+/**
+ * Finds the highest version of pl-dircopy in a bin listing.
+ *
+ * If multiple pl-dircopy versions exist (e.g., pl-dircopy-v1.0.0, pl-dircopy-v2.1.0),
+ * returns the one with the highest version number.
+ *
+ * @param binListing - Array of plugin names from /bin directory.
+ * @returns The full name of the latest pl-dircopy plugin, or null if not found.
+ *
+ * @example
+ * ```typescript
+ * const plugins = ['pl-dircopy-v1.0.0', 'pl-dircopy-v2.1.0', 'pl-other-v1.0.0'];
+ * path_findLatestDircopy(plugins);
+ * // Returns: 'pl-dircopy-v2.1.0'
+ * ```
+ */
+function path_findLatestDircopy(binListing) {
+    const dircopyPlugins = binListing.filter((name) => name.startsWith('pl-dircopy-v'));
+    if (dircopyPlugins.length === 0) {
+        return null;
+    }
+    if (dircopyPlugins.length === 1) {
+        return dircopyPlugins[0];
+    }
+    // Multiple versions - parse and find highest
+    // Pattern: pl-dircopy-vX.Y.Z
+    const versionPattern = /^pl-dircopy-v(\d+)\.(\d+)\.(\d+)$/;
+    const versioned = dircopyPlugins
+        .map((name) => {
+        const match = name.match(versionPattern);
+        if (!match)
+            return null;
+        return {
+            name,
+            major: parseInt(match[1], 10),
+            minor: parseInt(match[2], 10),
+            patch: parseInt(match[3], 10),
+        };
+    })
+        .filter((v) => v !== null);
+    if (versioned.length === 0) {
+        // Fallback: return first if version parsing failed
+        return dircopyPlugins[0];
+    }
+    versioned.sort((a, b) => {
+        if (a.major !== b.major)
+            return b.major - a.major;
+        if (a.minor !== b.minor)
+            return b.minor - a.minor;
+        return b.patch - a.patch;
+    });
+    return versioned[0].name;
+}
+//# sourceMappingURL=chrisPath.js.map

package/dist/path/chrisPath.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisPath.js","sourceRoot":"","sources":["../../src/path/chrisPath.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBH,sCAIC;AAuBD,oEA4BC;AAgBD,gDAUC;AAkBD,wDA+CC;AAlKD,2CAA6B;AAE7B;;;;;;;;;;;;;GAaG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,iCAAiC;IACjC,MAAM,WAAW,GAAW,qBAAqB,CAAC;IAClD,OAAO,WAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAgB,4BAA4B,CAAC,OAAe;IAC1D,kCAAkC;IAClC,MAAM,eAAe,GAAW,cAAc,CAAC;IAE/C,6BAA6B;IAC7B,IAAI,WAAW,GAAW,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAClD,MAAM,IAAI,GAAW,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC;IAElD,OAAO,WAAW,KAAK,IAAI,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAW,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QACnD,MAAM,KAAK,GAA4B,OAAO,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QAEtE,IAAI,KAAK,EAAE,CAAC;YACV,yCAAyC;YACzC,MAAM,UAAU,GAAW,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YAClD,OAAO,UAAU,CAAC;QACpB,CAAC;QAED,wBAAwB;QACxB,MAAM,MAAM,GAAW,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACjD,IAAI,MAAM,KAAK,WAAW,EAAE,CAAC;YAC3B,uCAAuC;YACvC,MAAM;QACR,CAAC;QACD,WAAW,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAAC,OAAe;IAChD,iCAAiC;IACjC,MAAM,WAAW,GAAW,uBAAuB,CAAC;IACpD,MAAM,KAAK,GAA4B,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAElE,IAAI,KAAK,EAAE,CAAC;QACV,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAChC,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,SAAgB,sBAAsB,CAAC,UAAoB;IACzD,MAAM,cAAc,GAAa,UAAU,CAAC,MAAM,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC,CAAC;IAEtG,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAChC,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,6CAA6C;IAC7C,6BAA6B;IAC7B,MAAM,cAAc,GAAW,mCAAmC,CAAC;IASnE,MAAM,SAAS,GAAsB,cAAc;SAChD,GAAG,CAAC,CAAC,IAAY,EAAE,EAAE;QACpB,MAAM,KAAK,GAA4B,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAClE,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QACxB,OAAO;YACL,IAAI;YACJ,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YAC7B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YAC7B,KAAK,EAAE,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;SAC9B,CAAC;IACJ,CAAC,CAAC;SACD,MAAM,CAAC,CAAC,CAAC,EAAwB,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IAEnD,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC3B,mDAAmD;QACnD,OAAO,cAAc,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,SAAS,CAAC,IAAI,CAAC,CAAC,CAAkB,EAAE,CAAkB,EAAE,EAAE;QACxD,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;QAClD,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;YAAE,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;QAClD,OAAO,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAC3B,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3B,CAAC"}

package/dist/pipelines/chrisPipeline.d.ts

@@ -0,0 +1,86 @@
+/**
+ * @file ChRIS Pipeline and Workflow operations.
+ *
+ * Provides functions to list registered pipelines, resolve them by name or ID,
+ * and create workflow instances (the runtime execution of a pipeline on a feed node).
+ *
+ * Terminology:
+ *   Pipeline  — the registered DAG template in CUBE
+ *   Workflow  — a pipeline instantiated on a specific plugin instance node
+ *
+ * @module
+ */
+import { ChRISResourceGroup } from "../resources/chrisResourceGroup.js";
+import { Result } from "../utils/result.js";
+/**
+ * Group handler for ChRIS pipelines.
+ */
+export declare class ChRISPipelineGroup extends ChRISResourceGroup {
+    constructor();
+}
+/**
+ * Minimal shape of a pipeline record as returned by the ChRIS API.
+ */
+export interface PipelineRecord {
+    id: number;
+    name: string;
+    description?: string;
+    authors?: string;
+    category?: string;
+    locked?: boolean;
+    /** Filesystem-safe slug derived from the pipeline source filename (e.g. "Varus_valgus_full_4crg2N7"). */
+    slug?: string;
+    [key: string]: unknown;
+}
+/**
+ * Per-node override for a workflow execution.
+ * All fields are optional — omitted fields use the pipeline's defaults.
+ */
+export interface WorkflowNodeOverride {
+    piping_id: number;
+    compute_resource_name?: string;
+    title?: string;
+    plugin_parameter_defaults?: Array<{
+        name: string;
+        default: unknown;
+    }>;
+}
+/**
+ * Options for creating a workflow.
+ */
+export interface WorkflowCreateOptions {
+    /** Numeric ID of the previous plugin instance to attach the workflow root to. */
+    previousPluginInstId: number;
+    /** Per-node overrides. If omitted, all nodes run with pipeline defaults. */
+    nodeOverrides?: WorkflowNodeOverride[];
+}
+/**
+ * Result of a successful workflow creation.
+ */
+export interface WorkflowResult {
+    workflowId: number;
+    /** Plugin instance IDs created by this workflow, in DAG order. */
+    pluginInstanceIds: number[];
+}
+/**
+ * Lists all registered pipelines, optionally filtered by name substring.
+ *
+ * @param search - Optional name substring filter.
+ * @returns Result containing array of PipelineRecord on success.
+ */
+export declare function pipelines_list(search?: string): Promise<Result<PipelineRecord[]>>;
+/**
+ * Resolves a pipeline by name (exact match first, then substring) or numeric ID string.
+ *
+ * @param nameOrId - Pipeline name or numeric ID.
+ * @returns Result containing the matched PipelineRecord.
+ */
+export declare function pipeline_resolve(nameOrId: string): Promise<Result<PipelineRecord>>;
+/**
+ * Creates a workflow — instantiates a pipeline on a specific plugin instance node.
+ *
+ * @param pipelineId - Numeric ID of the registered pipeline.
+ * @param options - Execution options including the previous node and optional overrides.
+ * @returns Result containing workflow ID and created plugin instance IDs.
+ */
+export declare function pipeline_createWorkflow(pipelineId: number, options: WorkflowCreateOptions): Promise<Result<WorkflowResult>>;

package/dist/pipelines/chrisPipeline.js

@@ -0,0 +1,180 @@
+"use strict";
+/**
+ * @file ChRIS Pipeline and Workflow operations.
+ *
+ * Provides functions to list registered pipelines, resolve them by name or ID,
+ * and create workflow instances (the runtime execution of a pipeline on a feed node).
+ *
+ * Terminology:
+ *   Pipeline  — the registered DAG template in CUBE
+ *   Workflow  — a pipeline instantiated on a specific plugin instance node
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISPipelineGroup = void 0;
+exports.pipelines_list = pipelines_list;
+exports.pipeline_resolve = pipeline_resolve;
+exports.pipeline_createWorkflow = pipeline_createWorkflow;
+const chrisConnection_js_1 = require("../connect/chrisConnection.js");
+const chrisResourceGroup_js_1 = require("../resources/chrisResourceGroup.js");
+const errorStack_js_1 = require("../error/errorStack.js");
+const result_js_1 = require("../utils/result.js");
+/**
+ * Group handler for ChRIS pipelines.
+ */
+class ChRISPipelineGroup extends chrisResourceGroup_js_1.ChRISResourceGroup {
+    constructor() {
+        super('Pipelines', 'getPipelines');
+    }
+}
+exports.ChRISPipelineGroup = ChRISPipelineGroup;
+/**
+ * Lists all registered pipelines, optionally filtered by name substring.
+ *
+ * @param search - Optional name substring filter.
+ * @returns Result containing array of PipelineRecord on success.
+ */
+async function pipelines_list(search) {
+    try {
+        const group = new ChRISPipelineGroup();
+        const params = search ? { name: search } : {};
+        const result = await group.asset.resources_getAll(params);
+        if (!result || !result.tableData)
+            return (0, result_js_1.Ok)([]);
+        return (0, result_js_1.Ok)(result.tableData);
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        errorStack_js_1.errorStack.stack_push('error', `pipelines_list: ${msg}`);
+        return (0, result_js_1.Err)();
+    }
+}
+/**
+ * Resolves a pipeline by name (exact match first, then substring) or numeric ID string.
+ *
+ * @param nameOrId - Pipeline name or numeric ID.
+ * @returns Result containing the matched PipelineRecord.
+ */
+async function pipeline_resolve(nameOrId) {
+    const numericId = parseInt(nameOrId, 10);
+    if (!isNaN(numericId)) {
+        const client = await chrisConnection_js_1.chrisConnection.client_get();
+        if (!client) {
+            errorStack_js_1.errorStack.stack_push('error', 'Not connected to ChRIS');
+            return (0, result_js_1.Err)();
+        }
+        try {
+            const pipeline = await client.getPipeline(numericId);
+            if (!pipeline) {
+                errorStack_js_1.errorStack.stack_push('error', `Pipeline with ID ${numericId} not found`);
+                return (0, result_js_1.Err)();
+            }
+            const data = pipeline.data;
+            return (0, result_js_1.Ok)(data);
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            errorStack_js_1.errorStack.stack_push('error', `pipeline_resolve: ${msg}`);
+            return (0, result_js_1.Err)();
+        }
+    }
+    const listResult = await pipelines_list(nameOrId);
+    if (!listResult.ok)
+        return (0, result_js_1.Err)();
+    const exact = listResult.value.find((p) => p.name === nameOrId);
+    if (exact)
+        return (0, result_js_1.Ok)(exact);
+    if (listResult.value.length === 1)
+        return (0, result_js_1.Ok)(listResult.value[0]);
+    if (listResult.value.length === 0) {
+        const fallbackClient = await chrisConnection_js_1.chrisConnection.client_get();
+        if (fallbackClient) {
+            // ID-suffix fallback: slug of form "{name}_id{N}" generated for pipelines without source files
+            const idSuffixMatch = nameOrId.match(/_id(\d+)$/);
+            if (idSuffixMatch) {
+                const directId = parseInt(idSuffixMatch[1], 10);
+                try {
+                    const pipeline = await fallbackClient.getPipeline(directId);
+                    if (pipeline) {
+                        return (0, result_js_1.Ok)(pipeline.data);
+                    }
+                }
+                catch (_e) { }
+            }
+            // Slug fallback: treat nameOrId as a source file fname fragment
+            try {
+                const sfList = await fallbackClient.getPipelineSourceFiles({ fname: nameOrId, limit: 1 });
+                const sfItems = sfList.getItems().filter((item) => {
+                    const base = item.data.fname.split('/').pop() ?? '';
+                    return base.replace(/\.(ya?ml)$/i, '') === nameOrId;
+                });
+                if (sfItems.length > 0 && sfItems[0].data.pipeline_name) {
+                    const byName = await pipelines_list(sfItems[0].data.pipeline_name);
+                    if (byName.ok) {
+                        const exactByName = byName.value.find((p) => p.name === sfItems[0].data.pipeline_name);
+                        if (exactByName)
+                            return (0, result_js_1.Ok)(exactByName);
+                    }
+                }
+            }
+            catch (_e) { }
+        }
+        errorStack_js_1.errorStack.stack_push('error', `No pipeline matching '${nameOrId}'`);
+        return (0, result_js_1.Err)();
+    }
+    errorStack_js_1.errorStack.stack_push('error', `Ambiguous: ${listResult.value.length} pipelines match '${nameOrId}'. Use ID or full name.`);
+    return (0, result_js_1.Err)();
+}
+/**
+ * Creates a workflow — instantiates a pipeline on a specific plugin instance node.
+ *
+ * @param pipelineId - Numeric ID of the registered pipeline.
+ * @param options - Execution options including the previous node and optional overrides.
+ * @returns Result containing workflow ID and created plugin instance IDs.
+ */
+async function pipeline_createWorkflow(pipelineId, options) {
+    const client = await chrisConnection_js_1.chrisConnection.client_get();
+    if (!client) {
+        errorStack_js_1.errorStack.stack_push('error', 'Not connected to ChRIS');
+        return (0, result_js_1.Err)();
+    }
+    try {
+        let nodes_info;
+        if (options.nodeOverrides && options.nodeOverrides.length > 0) {
+            nodes_info = options.nodeOverrides;
+        }
+        else {
+            const pipeline = await client.getPipeline(pipelineId);
+            if (!pipeline) {
+                errorStack_js_1.errorStack.stack_push('error', `Pipeline ${pipelineId} not found`);
+                return (0, result_js_1.Err)();
+            }
+            const pipelineWithPipings = pipeline;
+            const pipingsResponse = await pipelineWithPipings.getPluginPipings({ limit: 1000 });
+            const pipings = pipingsResponse.getItems();
+            nodes_info = pipings.map((p) => ({ piping_id: p.data.id }));
+        }
+        const clientWithWorkflow = client;
+        const workflow = await clientWithWorkflow.createWorkflow(pipelineId, {
+            previous_plugin_inst_id: options.previousPluginInstId,
+            nodes_info: JSON.stringify(nodes_info),
+        });
+        if (!workflow) {
+            errorStack_js_1.errorStack.stack_push('error', 'createWorkflow returned empty response');
+            return (0, result_js_1.Err)();
+        }
+        const workflowWithData = workflow;
+        const workflowId = workflowWithData.data.id;
+        const instancesResponse = await workflowWithData.getPluginInstances({ limit: 1000 });
+        const instances = instancesResponse.getItems();
+        const pluginInstanceIds = instances.map((inst) => inst.data.id);
+        return (0, result_js_1.Ok)({ workflowId, pluginInstanceIds });
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        errorStack_js_1.errorStack.stack_push('error', `pipeline_createWorkflow: ${msg}`);
+        return (0, result_js_1.Err)();
+    }
+}
+//# sourceMappingURL=chrisPipeline.js.map

package/dist/pipelines/chrisPipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisPipeline.js","sourceRoot":"","sources":["../../src/pipelines/chrisPipeline.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AA0EH,wCAcC;AAQD,4CAmFC;AASD,0DAwEC;AAlQD,sEAAgE;AAChE,8EAAwE;AACxE,0DAAoD;AACpD,kDAAqD;AASrD;;GAEG;AACH,MAAa,kBAAmB,SAAQ,0CAAkB;IACxD;QACE,KAAK,CAAC,WAAW,EAAE,cAAc,CAAC,CAAC;IACrC,CAAC;CACF;AAJD,gDAIC;AA+CD;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAClC,MAAe;IAEf,IAAI,CAAC;QACH,MAAM,KAAK,GAAuB,IAAI,kBAAkB,EAAE,CAAC;QAC3D,MAAM,MAAM,GAAyB,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC;QAC1D,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS;YAAE,OAAO,IAAA,cAAE,EAAC,EAAE,CAAC,CAAC;QAChD,OAAO,IAAA,cAAE,EAAC,MAAM,CAAC,SAAwC,CAAC,CAAC;IAC7D,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,GAAG,GAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3E,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,mBAAmB,GAAG,EAAE,CAAC,CAAC;QACzD,OAAO,IAAA,eAAG,GAAE,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,gBAAgB,CACpC,QAAgB;IAEhB,MAAM,SAAS,GAAW,QAAQ,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACjD,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;YACzD,OAAO,IAAA,eAAG,GAAE,CAAC;QACf,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;YACrD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,oBAAoB,SAAS,YAAY,CAAC,CAAC;gBAC1E,OAAO,IAAA,eAAG,GAAE,CAAC;YACf,CAAC;YACD,MAAM,IAAI,GAAoB,QAAgD,CAAC,IAAI,CAAC;YACpF,OAAO,IAAA,cAAE,EAAC,IAAI,CAAC,CAAC;QAClB,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,GAAG,GAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC3E,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,qBAAqB,GAAG,EAAE,CAAC,CAAC;YAC3D,OAAO,IAAA,eAAG,GAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED,MAAM,UAAU,GAA6B,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;IAC5E,IAAI,CAAC,UAAU,CAAC,EAAE;QAAE,OAAO,IAAA,eAAG,GAAE,CAAC;IAEjC,MAAM,KAAK,GAA+B,UAAU,CAAC,KAAK,CAAC,IAAI,CAC7D,CAAC,CAAiB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAC3C,CAAC;IACF,IAAI,KAAK;QAAE,OAAO,IAAA,cAAE,EAAC,KAAK,CAAC,CAAC;IAE5B,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAA,cAAE,EAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;IAElE,IAAI,UAAU,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,MAAM,cAAc,GAAG,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;QAC1D,IAAI,cAAc,EAAE,CAAC;YACnB,+FAA+F;YAC/F,MAAM,aAAa,GAA4B,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAC3E,IAAI,aAAa,EAAE,CAAC;gBAClB,MAAM,QAAQ,GAAW,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACxD,IAAI,CAAC;oBACH,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;oBAC5D,IAAI,QAAQ,EAAE,CAAC;wBACb,OAAO,IAAA,cAAE,EAAE,QAAgD,CAAC,IAAI,CAAC,CAAC;oBACpE,CAAC;gBACH,CAAC;gBAAC,OAAO,EAAW,EAAE,CAAC,CAAA,CAAC;YAC1B,CAAC;YAED,gEAAgE;YAChE,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,MAAO,cAIpB,CAAC,sBAAsB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;gBACzD,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,MAAM,CACtC,CAAC,IAAyD,EAAE,EAAE;oBAC5D,MAAM,IAAI,GAAW,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;oBAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,KAAK,QAAQ,CAAC;gBACtD,CAAC,CACF,CAAC;gBACF,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC;oBACxD,MAAM,MAAM,GAA6B,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;oBAC7F,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;wBACd,MAAM,WAAW,GAA+B,MAAM,CAAC,KAAK,CAAC,IAAI,CAC/D,CAAC,CAAiB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAChE,CAAC;wBACF,IAAI,WAAW;4BAAE,OAAO,IAAA,cAAE,EAAC,WAAW,CAAC,CAAC;oBAC1C,CAAC;gBACH,CAAC;YACH,CAAC;YAAC,OAAO,EAAW,EAAE,CAAC,CAAA,CAAC;QAC1B,CAAC;QACD,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,yBAAyB,QAAQ,GAAG,CAAC,CAAC;QACrE,OAAO,IAAA,eAAG,GAAE,CAAC;IACf,CAAC;IAED,0BAAU,CAAC,UAAU,CACnB,OAAO,EACP,cAAc,UAAU,CAAC,KAAK,CAAC,MAAM,qBAAqB,QAAQ,yBAAyB,CAC5F,CAAC;IACF,OAAO,IAAA,eAAG,GAAE,CAAC;AACf,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,uBAAuB,CAC3C,UAAkB,EAClB,OAA8B;IAE9B,MAAM,MAAM,GAAG,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QACzD,OAAO,IAAA,eAAG,GAAE,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,IAAI,UAAkC,CAAC;QAEvC,IAAI,OAAO,CAAC,aAAa,IAAI,OAAO,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC9D,UAAU,GAAG,OAAO,CAAC,aAAa,CAAC;QACrC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;YACtD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,YAAY,UAAU,YAAY,CAAC,CAAC;gBACnE,OAAO,IAAA,eAAG,GAAE,CAAC;YACf,CAAC;YACD,MAAM,mBAAmB,GAAG,QAK3B,CAAC;YAEF,MAAM,eAAe,GAAG,MAAM,mBAAmB,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;YACpF,MAAM,OAAO,GAAG,eAAe,CAAC,QAAQ,EAAqC,CAAC;YAC9E,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAA2B,EAAE,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,kBAAkB,GAAG,MAM1B,CAAC;QAEF,MAAM,QAAQ,GAAY,MAAM,kBAAkB,CAAC,cAAc,CAAC,UAAU,EAAE;YAC5E,uBAAuB,EAAE,OAAO,CAAC,oBAAoB;YACrD,UAAU,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;SACvC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wCAAwC,CAAC,CAAC;YACzE,OAAO,IAAA,eAAG,GAAE,CAAC;QACf,CAAC;QAED,MAAM,gBAAgB,GAAG,QAKxB,CAAC;QAEF,MAAM,UAAU,GAAW,gBAAgB,CAAC,IAAI,CAAC,EAAE,CAAC;QAEpD,MAAM,iBAAiB,GAAG,MAAM,gBAAgB,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACrF,MAAM,SAAS,GAAG,iBAAiB,CAAC,QAAQ,EAAE,CAAC;QAC/C,MAAM,iBAAiB,GAAa,SAAS,CAAC,GAAG,CAC/C,CAAC,IAA8B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CACjD,CAAC;QAEF,OAAO,IAAA,cAAE,EAAC,EAAE,UAAU,EAAE,iBAAiB,EAAE,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,GAAG,GAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC3E,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,4BAA4B,GAAG,EAAE,CAAC,CAAC;QAClE,OAAO,IAAA,eAAG,GAAE,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/pluginmetas/chrisPluginMetas.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @file ChRIS PluginMeta resources.
+ * @module
+ */
+import { ChRISResourceGroup } from '../resources/chrisResourceGroup.js';
+/**
+ * Group handler for ChRIS plugin metas.
+ */
+export declare class ChRISPluginMetaGroup extends ChRISResourceGroup {
+    constructor();
+}

package/dist/pluginmetas/chrisPluginMetas.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @file ChRIS PluginMeta resources.
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISPluginMetaGroup = void 0;
+const chrisResourceGroup_js_1 = require("../resources/chrisResourceGroup.js");
+/**
+ * Group handler for ChRIS plugin metas.
+ */
+class ChRISPluginMetaGroup extends chrisResourceGroup_js_1.ChRISResourceGroup {
+    constructor() {
+        super('PluginMetas', 'getPluginMetas');
+    }
+}
+exports.ChRISPluginMetaGroup = ChRISPluginMetaGroup;
+//# sourceMappingURL=chrisPluginMetas.js.map

package/dist/pluginmetas/chrisPluginMetas.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisPluginMetas.js","sourceRoot":"","sources":["../../src/pluginmetas/chrisPluginMetas.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,8EAAwE;AAExE;;GAEG;AACH,MAAa,oBAAqB,SAAQ,0CAAkB;IAC1D;QACE,KAAK,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;IACzC,CAAC;CACF;AAJD,oDAIC"}

package/dist/plugins/chrisPluginMetaPlugins.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @file Resource group for the plugins belonging to a ChRIS plugin-meta.
+ *
+ * @module
+ */
+import { ChRISResourceGroup } from "../resources/chrisResourceGroup";
+/**
+ * Group handler for ChRIS plugin metadata (PluginMeta).
+ */
+export declare class ChRISPluginMetaPluginGroup extends ChRISResourceGroup {
+    constructor();
+}

package/dist/plugins/chrisPluginMetaPlugins.js

@@ -0,0 +1,19 @@
+"use strict";
+/**
+ * @file Resource group for the plugins belonging to a ChRIS plugin-meta.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISPluginMetaPluginGroup = void 0;
+const chrisResourceGroup_1 = require("../resources/chrisResourceGroup");
+/**
+ * Group handler for ChRIS plugin metadata (PluginMeta).
+ */
+class ChRISPluginMetaPluginGroup extends chrisResourceGroup_1.ChRISResourceGroup {
+    constructor() {
+        super("PluginMetaPlugins", "getPluginMetas");
+    }
+}
+exports.ChRISPluginMetaPluginGroup = ChRISPluginMetaPluginGroup;
+//# sourceMappingURL=chrisPluginMetaPlugins.js.map

package/dist/plugins/chrisPluginMetaPlugins.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisPluginMetaPlugins.js","sourceRoot":"","sources":["../../src/plugins/chrisPluginMetaPlugins.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAEH,wEAAqE;AAErE;;GAEG;AACH,MAAa,0BAA2B,SAAQ,uCAAkB;IAChE;QACE,KAAK,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAAC;IAC/C,CAAC;CACF;AAJD,gEAIC"}

package/dist/plugins/chrisPlugins.d.ts

@@ -0,0 +1,127 @@
+/**
+ * @file ChRIS Plugin Management
+ *
+ * This module provides classes for managing ChRIS plugins.
+ * It includes the `ChRISPluginGroup` for collection operations and `ChRISPlugin` for individual plugin operations,
+ * such as searching for plugins and creating plugin instances.
+ *
+ * @module
+ */
+import Client, { PluginInstance } from "@fnndsc/chrisapi";
+import { Dictionary } from "../resources/chrisResources.js";
+import { ChRISResourceGroup } from "../resources/chrisResourceGroup.js";
+import { ChRISElementsGet, QueryHits, ChRISObjectParams } from "../utils/keypair.js";
+import { Searchable } from "../utils/searchable.js";
+import { Result } from "../utils/result.js";
+/**
+ * Group handler for ChRIS plugins.
+ */
+export declare class ChRISPluginGroup extends ChRISResourceGroup {
+    constructor();
+}
+/**
+ * Group handler for ChRIS plugin instances.
+ */
+export declare class ChRISPluginInstanceGroup extends ChRISResourceGroup {
+    constructor();
+}
+/**
+ * Class for managing individual ChRIS plugins.
+ */
+export declare class ChRISPlugin {
+    private _client;
+    constructor();
+    /**
+     * Retrieves the ChRIS client instance asynchronously.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    client_get(): Promise<Client | null>;
+    /**
+     * Converts a plain string to a searchable format.
+     * @deprecated Use Searchable.from() instead.
+     */
+    pluginString_makeSearchable(plugin: string): string;
+    /**
+     * Resolves a searchable string or object to plugin IDs.
+     * @param pluginSearchable - A searchable string or Searchable object.
+     * @returns A Promise resolving to QueryHits containing matching plugin IDs.
+     */
+    pluginIDs_resolve(pluginSearchable: string | Searchable): Promise<QueryHits | null>;
+    previousID_get(): Promise<number | null>;
+    plugin_runOnCUBE(pluginID: number, previousID: number, options: ChRISObjectParams): Promise<PluginInstance | undefined | null>;
+    pluginInstance_toDict(pluginInstance: PluginInstance | undefined | null): Dictionary | null;
+    plugin_run(plugin: string, params: string): Promise<Dictionary | null>;
+    pluginData_getFromSearch(searchOptions: ChRISElementsGet, dataField: string | string[]): Promise<QueryHits | null>;
+    /**
+     * Gets plugin IDs from a searchable.
+     * @param searchable - A searchable string or Searchable object.
+     * @returns A Promise resolving to QueryHits containing matching plugin IDs.
+     */
+    pluginIDs_getFromSearchable(searchable: string | Searchable): Promise<QueryHits | null>;
+    pluginIDs_get(name_exact: string): Promise<QueryHits | null>;
+    /**
+     * Uploads a plugin representation file to create a new plugin admin resource.
+     *
+     * Requires admin credentials. Will push error to errorStack if authentication fails.
+     *
+     * @param pluginData - Plugin descriptor JSON data.
+     * @param computeResources - Array of compute resource names to assign plugin to.
+     * @param adminToken - Optional admin authentication token (if different from current user).
+     * @returns Promise resolving to the created plugin data or null on failure.
+     */
+    plugin_registerWithAdmin(pluginData: Record<string, unknown>, computeResources?: string[], adminToken?: string): Promise<Record<string, unknown> | null>;
+    /**
+     * Searches for a plugin in a peer ChRIS store (public plugin repository).
+     *
+     * Uses anonymous client to query public plugin stores without authentication.
+     *
+     * @param pluginName - Name of the plugin to search for.
+     * @param version - Optional version of the plugin to search for.
+     * @param peerStoreUrl - URL of the peer ChRIS store (default: cube.chrisproject.org).
+     * @returns Promise resolving to plugin data and store URL, or null if not found.
+     */
+    plugin_searchPeerStore(pluginName: string, version?: string, peerStoreUrl?: string): Promise<{
+        plugin: Record<string, unknown>;
+        storeUrl: string;
+    } | null>;
+    /**
+     * Checks if a plugin with given name or dock_image already exists in current CUBE.
+     *
+     * @param nameOrImage - Plugin name or docker image to search for.
+     * @returns Promise resolving to plugin data if found, null otherwise.
+     */
+    plugin_existsInCube(nameOrImage: string): Promise<Record<string, unknown> | null>;
+    /**
+     * Lists plugins from a peer ChRIS store.
+     * Handles pagination to fetch all results.
+     *
+     * @param peerStoreUrl - URL of the peer store.
+     * @param searchParams - Optional search parameters.
+     * @returns Promise resolving to array of plugin data objects.
+     */
+    plugin_listPeerStore(peerStoreUrl?: string, searchParams?: Record<string, string>): Promise<Record<string, unknown>[] | null>;
+    /**
+     * Gets the compute resources currently assigned to a plugin.
+     *
+     * @param pluginId - ID of the plugin.
+     * @returns Promise resolving to array of compute resource names.
+     */
+    plugin_getComputeResources(pluginId: number): Promise<string[]>;
+}
+/**
+ * Registers a plugin using the legacy non-admin PluginList._post() method.
+ *
+ * **DEPRECATED:** This method uses the legacy non-admin plugin registration endpoint
+ * which may not be available in modern ChRIS CUBE installations. Prefer using
+ * ChRISPlugin.plugin_registerWithAdmin() instead.
+ *
+ * This function is provided for backward compatibility only and will be removed
+ * in a future release.
+ *
+ * @param pluginData - Plugin descriptor data (name, dock_image, etc.).
+ * @param computeResources - Optional array of compute resource names to assign.
+ * @returns A Result containing the registered plugin data, or an error.
+ *
+ * @deprecated Use ChRISPlugin.plugin_registerWithAdmin() instead.
+ */
+export declare function plugin_registerDirect(pluginData: Record<string, unknown>, computeResources?: string[]): Promise<Result<Record<string, unknown>>>;