@fnndsc/salsa 3.2.4

package/dist/pipelines/index.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @file Pipeline business logic for salsa.
+ *
+ * Wraps cumin's pipeline primitives to provide higher-level operations:
+ * listing, running, and fetching source YAML for registered pipelines.
+ *
+ * @module
+ */
+import { FilteredResourceData, ListOptions, Result, PipelineRecord, WorkflowResult } from '@fnndsc/cumin';
+export type { PipelineRecord, WorkflowResult };
+/**
+ * Lists registered pipelines, optionally filtered by name substring.
+ * Returns FilteredResourceData for table rendering compatibility.
+ *
+ * @param search - Optional name substring filter.
+ */
+export declare function pipelines_list(search?: string): Promise<FilteredResourceData | null>;
+/**
+ * Lists all pipelines across all pages.
+ *
+ * @param options - Search options (limit/offset managed internally).
+ */
+export declare function pipelines_listAll(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+/**
+ * Returns available field names for pipelines.
+ */
+export declare function pipelineFields_get(): Promise<string[] | null>;
+/**
+ * Returns all registered pipelines as a flat array for /bin listing.
+ * Attaches a filesystem-safe slug derived from each pipeline's source filename.
+ * Pipelines without a source file get a slug generated from their name.
+ *
+ * @returns Result containing array of PipelineRecord (with slug attached).
+ */
+export declare function pipelines_getAll(): Promise<Result<PipelineRecord[]>>;
+/**
+ * Runs a pipeline by name or ID, attaching it to a previous plugin instance.
+ *
+ * @param nameOrId - Pipeline name or numeric ID string.
+ * @param previousPluginInstId - The plugin instance to attach the pipeline root to.
+ * @param computeOverride - Optional compute resource name applied to all nodes.
+ * @returns Result containing workflow ID and created plugin instance IDs.
+ */
+export declare function pipeline_run(nameOrId: string, previousPluginInstId: number, computeOverride?: string): Promise<Result<WorkflowResult>>;
+/**
+ * Fetches the YAML source of a registered pipeline by searching /PIPELINES/ for
+ * a file whose basename matches the pipeline name.
+ *
+ * @param nameOrId - Pipeline name or numeric ID string.
+ * @returns Result containing YAML source string.
+ */
+export declare function pipeline_sourceGet(nameOrId: string): Promise<Result<string>>;
+/**
+ * Gets raw content from a pipeline source URL (legacy helper).
+ *
+ * @param url - Direct URL to the pipeline source file.
+ */
+export declare function pipeline_getContent(url: string): Promise<Result<string>>;

package/dist/pipelines/index.js

@@ -0,0 +1,194 @@
+"use strict";
+/**
+ * @file Pipeline business logic for salsa.
+ *
+ * Wraps cumin's pipeline primitives to provide higher-level operations:
+ * listing, running, and fetching source YAML for registered pipelines.
+ *
+ * @module
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pipelines_list = pipelines_list;
+exports.pipelines_listAll = pipelines_listAll;
+exports.pipelineFields_get = pipelineFields_get;
+exports.pipelines_getAll = pipelines_getAll;
+exports.pipeline_run = pipeline_run;
+exports.pipeline_sourceGet = pipeline_sourceGet;
+exports.pipeline_getContent = pipeline_getContent;
+const cumin_1 = require("@fnndsc/cumin");
+const axios_1 = __importDefault(require("axios"));
+/**
+ * Lists registered pipelines, optionally filtered by name substring.
+ * Returns FilteredResourceData for table rendering compatibility.
+ *
+ * @param search - Optional name substring filter.
+ */
+async function pipelines_list(search) {
+    const result = await (0, cumin_1.pipelines_list)(search);
+    if (!result.ok || result.value.length === 0)
+        return null;
+    const records = result.value;
+    return {
+        tableData: records,
+        selectedFields: ['id', 'name', 'authors', 'category', 'description'],
+    };
+}
+/**
+ * Lists all pipelines across all pages.
+ *
+ * @param options - Search options (limit/offset managed internally).
+ */
+async function pipelines_listAll(options = {}) {
+    const group = new cumin_1.ChRISPipelineGroup();
+    return await group.asset.resources_getAll(options);
+}
+/**
+ * Returns available field names for pipelines.
+ */
+async function pipelineFields_get() {
+    const group = new cumin_1.ChRISPipelineGroup();
+    const result = await group.asset.resourceFields_get();
+    return result ? result.fields : null;
+}
+/**
+ * Returns all registered pipelines as a flat array for /bin listing.
+ * Attaches a filesystem-safe slug derived from each pipeline's source filename.
+ * Pipelines without a source file get a slug generated from their name.
+ *
+ * @returns Result containing array of PipelineRecord (with slug attached).
+ */
+async function pipelines_getAll() {
+    const client = await cumin_1.chrisConnection.client_get();
+    if (!client) {
+        cumin_1.errorStack.stack_push('error', 'Not connected to ChRIS');
+        return (0, cumin_1.Err)();
+    }
+    const [pipelinesResult, sourceFilesResponse] = await Promise.all([
+        (0, cumin_1.pipelines_list)(),
+        client.getPipelineSourceFiles({ limit: 1000 }).catch(() => null),
+    ]);
+    if (!pipelinesResult.ok)
+        return (0, cumin_1.Err)();
+    const idToSlug = new Map();
+    if (sourceFilesResponse) {
+        for (const item of sourceFilesResponse.getItems()) {
+            const { fname, pipeline_id } = item.data;
+            if (pipeline_id && fname) {
+                const base = fname.split('/').pop() ?? '';
+                const slug = base.replace(/\.(ya?ml)$/i, '');
+                idToSlug.set(pipeline_id, slug);
+            }
+        }
+    }
+    const records = pipelinesResult.value.map((pipeline) => {
+        const sourceSlug = idToSlug.get(pipeline.id);
+        const generatedSlug = pipeline.name
+            .replace(/[^a-zA-Z0-9]/g, '_')
+            .replace(/_+/g, '_')
+            .replace(/^_|_$/g, '');
+        const base = sourceSlug ?? generatedSlug;
+        return {
+            ...pipeline,
+            slug: `${base}_id${pipeline.id}`,
+        };
+    });
+    return (0, cumin_1.Ok)(records);
+}
+/**
+ * Runs a pipeline by name or ID, attaching it to a previous plugin instance.
+ *
+ * @param nameOrId - Pipeline name or numeric ID string.
+ * @param previousPluginInstId - The plugin instance to attach the pipeline root to.
+ * @param computeOverride - Optional compute resource name applied to all nodes.
+ * @returns Result containing workflow ID and created plugin instance IDs.
+ */
+async function pipeline_run(nameOrId, previousPluginInstId, computeOverride) {
+    const pipelineResult = await (0, cumin_1.pipeline_resolve)(nameOrId);
+    if (!pipelineResult.ok)
+        return (0, cumin_1.Err)();
+    const pipeline = pipelineResult.value;
+    const options = { previousPluginInstId };
+    if (computeOverride) {
+        const client = await cumin_1.chrisConnection.client_get();
+        if (!client) {
+            cumin_1.errorStack.stack_push('error', 'Not connected to ChRIS');
+            return (0, cumin_1.Err)();
+        }
+        try {
+            const pipelineObj = await client.getPipeline(pipeline.id);
+            if (pipelineObj) {
+                const pipingsResponse = await pipelineObj.getPluginPipings({ limit: 1000 });
+                const pipings = pipingsResponse.getItems();
+                options.nodeOverrides = pipings.map((p) => ({
+                    piping_id: p.data.id,
+                    compute_resource_name: computeOverride,
+                }));
+            }
+        }
+        catch (error) {
+            const msg = error instanceof Error ? error.message : String(error);
+            cumin_1.errorStack.stack_push('error', `pipeline_run: compute override failed: ${msg}`);
+            return (0, cumin_1.Err)();
+        }
+    }
+    return (0, cumin_1.pipeline_createWorkflow)(pipeline.id, options);
+}
+/**
+ * Fetches the YAML source of a registered pipeline by searching /PIPELINES/ for
+ * a file whose basename matches the pipeline name.
+ *
+ * @param nameOrId - Pipeline name or numeric ID string.
+ * @returns Result containing YAML source string.
+ */
+async function pipeline_sourceGet(nameOrId) {
+    const pipelineResult = await (0, cumin_1.pipeline_resolve)(nameOrId);
+    if (!pipelineResult.ok)
+        return (0, cumin_1.Err)();
+    const pipeline = pipelineResult.value;
+    const client = await cumin_1.chrisConnection.client_get();
+    if (!client) {
+        cumin_1.errorStack.stack_push('error', 'Not connected to ChRIS');
+        return (0, cumin_1.Err)();
+    }
+    try {
+        const sourceFiles = await client.getPipelineSourceFiles({ pipeline_id: pipeline.id, limit: 1 });
+        const items = sourceFiles.getItems();
+        if (items.length === 0) {
+            cumin_1.errorStack.stack_push('error', `No source file registered for pipeline '${pipeline.name}' (id=${pipeline.id})`);
+            return (0, cumin_1.Err)();
+        }
+        return (0, cumin_1.pipelineFile_getTextByPath)('/' + items[0].data.fname);
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        cumin_1.errorStack.stack_push('error', `pipeline_sourceGet: ${msg}`);
+        return (0, cumin_1.Err)();
+    }
+}
+/**
+ * Gets raw content from a pipeline source URL (legacy helper).
+ *
+ * @param url - Direct URL to the pipeline source file.
+ */
+async function pipeline_getContent(url) {
+    const token = await cumin_1.chrisConnection.authToken_get();
+    if (!token) {
+        cumin_1.errorStack.stack_push('error', 'Not connected to ChRIS');
+        return (0, cumin_1.Err)();
+    }
+    try {
+        const response = await axios_1.default.get(url, {
+            headers: { Authorization: `Token ${token}` },
+        });
+        return (0, cumin_1.Ok)(response.data);
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        cumin_1.errorStack.stack_push('error', `pipeline_getContent: ${msg}`);
+        return (0, cumin_1.Err)();
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/pipelines/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pipelines/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;;;AA6BH,wCAWC;AAOD,8CAGC;AAKD,gDAIC;AASD,4CA4CC;AAUD,oCA4CC;AASD,gDAqCC;AAOD,kDAiBC;AA1OD,yCAgBuB;AACvB,kDAA0B;AAI1B;;;;;GAKG;AACI,KAAK,UAAU,cAAc,CAClC,MAAe;IAEf,MAAM,MAAM,GAA6B,MAAM,IAAA,sBAAoB,EAAC,MAAM,CAAC,CAAC;IAC5E,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAEzD,MAAM,OAAO,GAA8B,MAAM,CAAC,KAAkC,CAAC;IACrF,OAAO;QACL,SAAS,EAAE,OAAO;QAClB,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,CAAC;KACrE,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,iBAAiB,CAAC,UAAgC,EAAE;IACxE,MAAM,KAAK,GAAuB,IAAI,0BAAkB,EAAE,CAAC;IAC3D,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,kBAAkB;IACtC,MAAM,KAAK,GAAuB,IAAI,0BAAkB,EAAE,CAAC;IAC3D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;IACtD,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACvC,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,gBAAgB;IACpC,MAAM,MAAM,GAAG,MAAM,uBAAe,CAAC,UAAU,EAAE,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QACzD,OAAO,IAAA,WAAG,GAAE,CAAC;IACf,CAAC;IAED,MAAM,CAAC,eAAe,EAAE,mBAAmB,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;QAC/D,IAAA,sBAAoB,GAAE;QACrB,MAIC,CAAC,sBAAsB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC;KAC7D,CAAC,CAAC;IAEH,IAAI,CAAC,eAAe,CAAC,EAAE;QAAE,OAAO,IAAA,WAAG,GAAE,CAAC;IAEtC,MAAM,QAAQ,GAAwB,IAAI,GAAG,EAAkB,CAAC;IAChE,IAAI,mBAAmB,EAAE,CAAC;QACxB,KAAK,MAAM,IAAI,IAAI,mBAAmB,CAAC,QAAQ,EAAE,EAAE,CAAC;YAClD,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC;YACzC,IAAI,WAAW,IAAI,KAAK,EAAE,CAAC;gBACzB,MAAM,IAAI,GAAW,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;gBAClD,MAAM,IAAI,GAAW,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;gBACrD,QAAQ,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;YAClC,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,QAAwB,EAAE,EAAE;QACrE,MAAM,UAAU,GAAuB,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACjE,MAAM,aAAa,GAAW,QAAQ,CAAC,IAAI;aACxC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC;aAC7B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACzB,MAAM,IAAI,GAAW,UAAU,IAAI,aAAa,CAAC;QACjD,OAAO;YACL,GAAG,QAAQ;YACX,IAAI,EAAE,GAAG,IAAI,MAAM,QAAQ,CAAC,EAAE,EAAE;SACjC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO,IAAA,UAAE,EAAC,OAAO,CAAC,CAAC;AACrB,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,YAAY,CAChC,QAAgB,EAChB,oBAA4B,EAC5B,eAAwB;IAExB,MAAM,cAAc,GAA2B,MAAM,IAAA,wBAAgB,EAAC,QAAQ,CAAC,CAAC;IAChF,IAAI,CAAC,cAAc,CAAC,EAAE;QAAE,OAAO,IAAA,WAAG,GAAE,CAAC;IAErC,MAAM,QAAQ,GAAmB,cAAc,CAAC,KAAK,CAAC;IAEtD,MAAM,OAAO,GAA0B,EAAE,oBAAoB,EAAE,CAAC;IAEhE,IAAI,eAAe,EAAE,CAAC;QACpB,MAAM,MAAM,GAAG,MAAM,uBAAe,CAAC,UAAU,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;YACzD,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QAED,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,MAAO,MAMzB,CAAC,WAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAE5B,IAAI,WAAW,EAAE,CAAC;gBAChB,MAAM,eAAe,GAAG,MAAM,WAAW,CAAC,gBAAgB,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;gBAC5E,MAAM,OAAO,GAAG,eAAe,CAAC,QAAQ,EAAE,CAAC;gBAC3C,OAAO,CAAC,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;oBAC1C,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE;oBACpB,qBAAqB,EAAE,eAAe;iBACvC,CAAC,CAAC,CAAC;YACN,CAAC;QACH,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,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,0CAA0C,GAAG,EAAE,CAAC,CAAC;YAChF,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;IACH,CAAC;IAED,OAAO,IAAA,+BAAuB,EAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;AACvD,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,kBAAkB,CACtC,QAAgB;IAEhB,MAAM,cAAc,GAA2B,MAAM,IAAA,wBAAgB,EAAC,QAAQ,CAAC,CAAC;IAChF,IAAI,CAAC,cAAc,CAAC,EAAE;QAAE,OAAO,IAAA,WAAG,GAAE,CAAC;IAErC,MAAM,QAAQ,GAAmB,cAAc,CAAC,KAAK,CAAC;IAEtD,MAAM,MAAM,GAAG,MAAM,uBAAe,CAAC,UAAU,EAAE,CAAC;IAClD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QACzD,OAAO,IAAA,WAAG,GAAE,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAO,MAIzB,CAAC,sBAAsB,CAAC,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAElE,MAAM,KAAK,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAC;QAErC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvB,kBAAU,CAAC,UAAU,CACnB,OAAO,EACP,2CAA2C,QAAQ,CAAC,IAAI,SAAS,QAAQ,CAAC,EAAE,GAAG,CAChF,CAAC;YACF,OAAO,IAAA,WAAG,GAAE,CAAC;QACf,CAAC;QAED,OAAO,IAAA,kCAA0B,EAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC/D,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,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,uBAAuB,GAAG,EAAE,CAAC,CAAC;QAC7D,OAAO,IAAA,WAAG,GAAE,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CAAC,GAAW;IACnD,MAAM,KAAK,GAAkB,MAAM,uBAAe,CAAC,aAAa,EAAE,CAAC;IACnE,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QACzD,OAAO,IAAA,WAAG,GAAE,CAAC;IACf,CAAC;IAED,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,EAAE;YACpC,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,KAAK,EAAE,EAAE;SAC7C,CAAC,CAAC;QACH,OAAO,IAAA,UAAE,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3B,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,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wBAAwB,GAAG,EAAE,CAAC,CAAC;QAC9D,OAAO,IAAA,WAAG,GAAE,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/plugininstances/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @file PluginInstance resource operations.
+ * @module
+ */
+import { FilteredResourceData, ListOptions } from '@fnndsc/cumin';
+/**
+ * Lists all plugin instances / jobs across all pages.
+ *
+ * @param options - Search options (limit/offset managed internally).
+ */
+export declare function pluginInstances_listAll(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+/**
+ * Returns available field names for plugin instances.
+ */
+export declare function pluginInstanceFields_get(): Promise<string[] | null>;

package/dist/plugininstances/index.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * @file PluginInstance resource operations.
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginInstances_listAll = pluginInstances_listAll;
+exports.pluginInstanceFields_get = pluginInstanceFields_get;
+const cumin_1 = require("@fnndsc/cumin");
+/**
+ * Lists all plugin instances / jobs across all pages.
+ *
+ * @param options - Search options (limit/offset managed internally).
+ */
+async function pluginInstances_listAll(options = {}) {
+    const group = new cumin_1.ChRISPluginInstanceGroup();
+    return await group.asset.resources_getAll(options);
+}
+/**
+ * Returns available field names for plugin instances.
+ */
+async function pluginInstanceFields_get() {
+    const group = new cumin_1.ChRISPluginInstanceGroup();
+    const result = await group.asset.resourceFields_get();
+    return result ? result.fields : null;
+}
+//# sourceMappingURL=index.js.map

package/dist/plugininstances/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/plugininstances/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AASH,0DAGC;AAKD,4DAIC;AAnBD,yCAA4F;AAE5F;;;;GAIG;AACI,KAAK,UAAU,uBAAuB,CAAC,UAAgC,EAAE;IAC9E,MAAM,KAAK,GAA6B,IAAI,gCAAwB,EAAE,CAAC;IACvE,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,wBAAwB;IAC5C,MAAM,KAAK,GAA6B,IAAI,gCAAwB,EAAE,CAAC;IACvE,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;IACtD,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACvC,CAAC"}

package/dist/pluginmetas/index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @file PluginMeta resource operations.
+ * @module
+ */
+import { FilteredResourceData, ListOptions } from '@fnndsc/cumin';
+/**
+ * Lists plugin metas (single page).
+ *
+ * @param options - Search and pagination options.
+ */
+export declare function pluginMetas_list(options: ListOptions): Promise<FilteredResourceData | null>;
+/**
+ * Lists all plugin metas across all pages.
+ *
+ * @param options - Search options (limit/offset managed internally).
+ */
+export declare function pluginMetas_listAll(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+/**
+ * Returns available field names for plugin metas.
+ */
+export declare function pluginMetaFields_get(): Promise<string[] | null>;

package/dist/pluginmetas/index.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * @file PluginMeta resource operations.
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluginMetas_list = pluginMetas_list;
+exports.pluginMetas_listAll = pluginMetas_listAll;
+exports.pluginMetaFields_get = pluginMetaFields_get;
+const cumin_1 = require("@fnndsc/cumin");
+/**
+ * Lists plugin metas (single page).
+ *
+ * @param options - Search and pagination options.
+ */
+async function pluginMetas_list(options) {
+    const group = new cumin_1.ChRISPluginMetaGroup();
+    return await group.asset.resources_listAndFilterByOptions(options);
+}
+/**
+ * Lists all plugin metas across all pages.
+ *
+ * @param options - Search options (limit/offset managed internally).
+ */
+async function pluginMetas_listAll(options = {}) {
+    const group = new cumin_1.ChRISPluginMetaGroup();
+    return await group.asset.resources_getAll(options);
+}
+/**
+ * Returns available field names for plugin metas.
+ */
+async function pluginMetaFields_get() {
+    const group = new cumin_1.ChRISPluginMetaGroup();
+    const result = await group.asset.resourceFields_get();
+    return result ? result.fields : null;
+}
+//# sourceMappingURL=index.js.map

package/dist/pluginmetas/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pluginmetas/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AASH,4CAGC;AAOD,kDAGC;AAKD,oDAIC;AA7BD,yCAAwF;AAExF;;;;GAIG;AACI,KAAK,UAAU,gBAAgB,CAAC,OAAoB;IACzD,MAAM,KAAK,GAAyB,IAAI,4BAAoB,EAAE,CAAC;IAC/D,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,mBAAmB,CAAC,UAAgC,EAAE;IAC1E,MAAM,KAAK,GAAyB,IAAI,4BAAoB,EAAE,CAAC;IAC/D,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,oBAAoB;IACxC,MAAM,KAAK,GAAyB,IAAI,4BAAoB,EAAE,CAAC;IAC/D,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;IACtD,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACvC,CAAC"}

package/dist/plugins/index.d.ts

@@ -0,0 +1,118 @@
+/**
+ * @file Plugin management operations.
+ * @module
+ */
+import { Dictionary, FilteredResourceData, ListOptions, Searchable } from '@fnndsc/cumin';
+/**
+ * List plugins based on options.
+ *
+ * @param options - Search and pagination options.
+ * @returns A Promise resolving to FilteredResourceData or null.
+ */
+export declare function plugins_list(options: ListOptions): Promise<FilteredResourceData | null>;
+/**
+ * List *all* plugins by automatically handling pagination.
+ *
+ * @param options - Search options (limit and offset will be overridden/managed internally).
+ * @returns A Promise resolving to FilteredResourceData containing all matching plugins, or null.
+ */
+export declare function plugins_listAll(options?: ListOptions): Promise<FilteredResourceData | null>;
+/**
+ * Get the list of available fields for plugins.
+ *
+ * @returns A Promise resolving to an array of field names or null.
+ */
+export declare function pluginFields_get(): Promise<string[] | null>;
+/**
+ * List plugin instances based on options.
+ *
+ * @param options - Search and pagination options (e.g., { id: 123 }).
+ * @returns A Promise resolving to FilteredResourceData or null.
+ */
+export declare function pluginInstances_list(options: ListOptions): Promise<FilteredResourceData | null>;
+/**
+ * Interface for options when searching for a plugin.
+ * This should be expanded as needed to reflect actual search parameters.
+ */
+export interface PluginSearchOptions {
+    search?: string;
+    name?: string;
+    id?: string;
+    [key: string]: unknown;
+}
+/**
+ * Converts a Dictionary to CLI-style parameter string.
+ *
+ * @param params - Dictionary of parameters.
+ * @returns CLI-style string (e.g., "--key1 value1 --key2 value2").
+ */
+export declare function dictionary_toCLI(params: Dictionary): string;
+/**
+ * Run a plugin instance.
+ *
+ * This function orchestrates the execution of a ChRIS plugin with specified parameters.
+ *
+ * @param searchable - A string that identifies the plugin (e.g., name, ID, or a partial match).
+ * @param parameters - An object containing the parameters for the plugin execution.
+ * @returns A Promise resolving to a Dictionary representing the created plugin instance, or null if execution failed.
+ */
+export declare function plugin_run(searchable: string, parameters: Dictionary): Promise<Dictionary | null>;
+/**
+ * Resolve a searchable plugin string to a list of plugin IDs.
+ *
+ * @param searchable - A string or Searchable object that identifies the plugin (e.g., name, ID, or a partial match).
+ * @returns A Promise resolving to an array of plugin IDs, or null if no plugins match.
+ */
+export declare function plugins_searchableToIDs(searchable: string | Searchable): Promise<string[] | null>;
+/**
+ * Fetch the raw README content from a plugin's repository URL.
+ *
+ * This function attempts to retrieve README files (Markdown or reStructuredText)
+ * from common locations within a given repository URL.
+ *
+ * @param repoUrl - The base URL of the plugin's Git repository.
+ * @returns A Promise resolving to the README content as a string, or null if no README is found or accessible.
+ */
+export declare function pluginMeta_readmeContentFetch(repoUrl: string): Promise<string | null>;
+/**
+ * Retrieve the documentation URL for a specific plugin ID.
+ *
+ * @param pluginId - The ID of the plugin.
+ * @returns A Promise resolving to the documentation URL as a string, or null if not found.
+ */
+export declare function pluginMeta_documentationUrlGet(pluginId: string): Promise<string | null>;
+/**
+ * Retrieve a single plugin ID based on search options.
+ *
+ * This function performs a search for plugins using the provided criteria and
+ * returns the ID of the first matching plugin.
+ *
+ * @param options - An object containing search parameters (e.g., name, id).
+ * @returns A Promise resolving to a plugin ID string, or null if no plugin is found or if the search is ambiguous (multiple results).
+ */
+export declare function pluginMeta_pluginIDFromSearch(options: PluginSearchOptions): Promise<string | null>;
+/**
+ * Delete a plugin by its ID.
+ *
+ * @param id - The ID of the plugin to delete.
+ * @returns A Promise resolving to true on success, false on failure.
+ */
+export declare function plugin_delete(id: number): Promise<boolean>;
+/**
+ * Provides an overview of plugin operations.
+ * Currently a placeholder.
+ *
+ * @returns A Promise resolving to void.
+ */
+export declare function plugins_overview(): Promise<void>;
+/**
+ * Fetch the README for a plugin given its ID.
+ *
+ * @param pluginId - The ID of the plugin.
+ * @returns A Promise resolving to the README content or null.
+ */
+export declare function plugin_readme(pluginId: string): Promise<string | null>;
+export * from './plugin_register.js';
+export * from './peer_search.js';
+export * from './store_import.js';
+export * from './plugin_executeInPlace.js';