@fnndsc/salsa 3.2.4

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 FNNDSC / BCH
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,164 @@
+```
+ ____        _
+/ ___|  __ _| |___  __ _
+\___ \ / _` | / __|/ _` |
+ ___) | (_| | \__ \ (_| |
+|____/ \__,_|_|___/\__,_|
+```
+
+**Salsa Abstracts Logic Service Assets**
+
+`salsa` is the logic layer of the ChRIS interface ecosystem. It encapsulates high-level business intents and operational logic, serving as the bridge between user-facing interfaces (`chell`, `chili`) and the underlying infrastructure (`cumin` and `chrisapi`).
+
+## Installation
+
+```bash
+npm install @fnndsc/salsa
+```
+
+Requires Node.js ≥ 20.12. Ships with TypeScript type definitions. Depends on [`@fnndsc/cumin`](https://github.com/FNNDSC/cumin).
+
+## Usage
+
+```typescript
+import { files_listAll, fileContent_get, vfsDispatcher } from "@fnndsc/salsa";
+
+// Salsa returns pure data / typed objects — no CLI dependencies
+const listing = await files_listAll({ limit: 1000, offset: 0 }, "files", "/home/chris");
+const content = await fileContent_get("/home/chris/uploads/notes.txt");
+```
+
+See [Key Modules](#key-modules) for the full intent catalogue.
+
+## Purpose
+
+- **Consolidate Business Logic**: Centralises intents such as "list directory", "upload file", "register plugin", "fetch feed note". All frontends share identical behaviour.
+- **Frontend Agnostic**: No CLI-specific dependencies (`commander`, `process.stdout`). Returns pure data or typed objects.
+- **Virtual Filesystem**: Owns the VFS dispatcher that maps ChRIS API resources onto Unix-style paths — see [VFS](#virtual-filesystem-vfs) below.
+
+## Architecture: The Sandwich Model
+
+```text
+[ ChELL (REPL) ]  [ Chili (CLI) ]  [ Web App ]  [ Mobile App ]
+       |                 |               |              |
+       +-----------------+---------------+              |
+                         |                              |
+                         v                              v
+              [      Salsa (Logic / Intents)        ]  <-- YOU ARE HERE
+                         |
+                         v
+              [      Cumin (State / Infrastructure) ]
+                         |
+                         v
+              [      @fnndsc/chrisapi (Client)      ]
+```
+
+## Key Modules
+
+### Filesystem
+
+| Function | Description |
+|----------|-------------|
+| `vfsDispatcher` | Routes `list`/`read` calls to the correct VFS provider by path prefix |
+| `files_list` | List a directory (paginated) |
+| `files_listAll` | Full directory listing (all pages) |
+| `fileContent_get` | Read remote file content |
+| `files_uploadPath` | Upload a local file or directory tree to ChRIS |
+| `files_touch` | Create an empty file |
+| `files_mkdir` | Create a directory |
+| `files_rm` | Delete a file or directory |
+| `files_cp` / `files_mv` | Copy / move |
+
+### Plugins & Store
+
+| Function | Description |
+|----------|-------------|
+| `plugins_list` / `plugins_listAll` | Fetch plugin list |
+| `plugin_checkExists` | Check if a plugin is already registered |
+| `plugin_registerWithAdmin` | Register a plugin via the admin endpoint |
+| `plugin_assignToComputeResources` | Assign plugin to compute environments |
+| `plugins_searchPeers` | Search peer ChRIS stores (e.g. cube.chrisproject.org) |
+| `plugin_importFromStore` | Import a plugin from peer store data |
+| `plugin_searchPeersByImage` | Resolve a Docker image to a peer-store plugin |
+
+### Feeds & Sub-resources
+
+| Function | Description |
+|----------|-------------|
+| `feeds_list` / `feeds_listAll` | Fetch feeds |
+| `feedNote_get` / `feedNote_update` | Read or update the singleton note on a feed |
+| `feedComments_list` | List comments on a feed |
+| `feedComment_create` / `feedComment_update` / `feedComment_delete` | Comment CRUD |
+
+### Pipelines & Workflows
+
+| Function | Description |
+|----------|-------------|
+| `pipelines_list` | List registered pipelines |
+| `workflow_create` | Instantiate a pipeline as a workflow on a feed |
+
+### Jobs (Plugin Instance Operations)
+
+| Function | Description |
+|----------|-------------|
+| `job_cancel(id)` | Cancel a running/scheduled instance (`PUT {status: cancelled}`) |
+| `job_delete(id)` | Delete a terminal instance record |
+| `job_statusFetch(id)` | Live-fetch current status from API (bypasses cache) |
+| `job_logFetch(id)` | Fetch stdout/stderr log for an instance |
+| `procCache_refresh([feedID])` | Rebuild the `/proc` job cache, optionally scoped to one feed |
+
+## Virtual Filesystem (VFS)
+
+`vfsDispatcher` translates a ChRIS path into a provider call. Each provider handles a path prefix and maps API resources onto filesystem semantics:
+
+| Path prefix | Provider | Backed by |
+|-------------|----------|-----------|
+| `/home/<user>/` | `HomeVfsProvider` | ChRIS user-file API |
+| `/home/<user>/feeds/` | `FeedVfsProvider` | Feed resources |
+| `/bin` | `BinVfsProvider` | Registered plugins (virtual executables) |
+| `/usr/bin` | `UsrBinVfsProvider` | Built-in shell commands (`whoami`, `whereami`) |
+| `/etc` | `EtcVfsProvider` | Config files (`compute.yaml`, `group`, `passwd`, `cube`) |
+| `/net/pacs/queries/` | `PacsVfsProvider` | PACS query results |
+| `/proc/feeds/` | `ProcVfsProvider` | Job monitoring DAG (backed by `ProcCache` in cumin) |
+| `*.chrislink` | resolved by dispatcher | Symlinks to other ChRIS paths |
+
+Providers implement a common interface: `list(path)` → `Result<VFSItem[]>` and `read(path)` → `Result<string>`.
+
+### `/proc/feeds/` — Job Monitoring
+
+`ProcVfsProvider` mirrors the computation DAG of every visible feed. Each plugin instance is a directory; virtual files inside expose live status, params, and log:
+
+```
+/proc/feeds/feed_123/
+├── status                  ← aggregate: running | finishedSuccessfully | finishedWithError
+├── title
+└── pl-dircopy_456/         ← type=job in VFSItem; ls -l shows colour-coded status
+    ├── status              ← live API fetch if non-terminal
+    ├── params              ← key=value, cached permanently
+    ├── log                 ← never cached, always live
+    └── pl-fshack_789/
+        └── …
+```
+
+The cache (`ProcCache` in cumin) holds two flat maps (`instances`, `children`/`feedRoots`) for O(1) lookup and O(depth) path reconstruction. Structure is permanent; only status of non-terminal nodes is refreshed on read.
+
+## Development
+
+### Build
+
+```bash
+npm run build
+```
+
+### Test
+
+```bash
+npm run test
+```
+
+## License
+
+MIT — part of the [ChRIS Project](https://chrisproject.org).
+
+---
+_-30-_

package/dist/compute/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @file Compute resource operations.
+ * @module
+ */
+import { FilteredResourceData, ListOptions } from '@fnndsc/cumin';
+/**
+ * Lists compute resources (single page).
+ */
+export declare function computeResources_list(options: ListOptions): Promise<FilteredResourceData | null>;
+/**
+ * Lists all compute resources across all pages.
+ */
+export declare function computeResources_listAll(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+/**
+ * Returns available field names for compute resources.
+ */
+export declare function computeResourceFields_get(): Promise<string[] | null>;

package/dist/compute/index.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * @file Compute resource operations.
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.computeResources_list = computeResources_list;
+exports.computeResources_listAll = computeResources_listAll;
+exports.computeResourceFields_get = computeResourceFields_get;
+const cumin_1 = require("@fnndsc/cumin");
+/**
+ * Lists compute resources (single page).
+ */
+async function computeResources_list(options) {
+    const group = new cumin_1.ChRISComputeResourceGroup();
+    return await group.asset.resources_listAndFilterByOptions(options);
+}
+/**
+ * Lists all compute resources across all pages.
+ */
+async function computeResources_listAll(options = {}) {
+    const group = new cumin_1.ChRISComputeResourceGroup();
+    return await group.asset.resources_getAll(options);
+}
+/**
+ * Returns available field names for compute resources.
+ */
+async function computeResourceFields_get() {
+    const group = new cumin_1.ChRISComputeResourceGroup();
+    const result = await group.asset.resourceFields_get();
+    return result ? result.fields : null;
+}
+//# sourceMappingURL=index.js.map

package/dist/compute/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/compute/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;AAOH,sDAGC;AAKD,4DAGC;AAKD,8DAIC;AAzBD,yCAA6F;AAE7F;;GAEG;AACI,KAAK,UAAU,qBAAqB,CAAC,OAAoB;IAC9D,MAAM,KAAK,GAA8B,IAAI,iCAAyB,EAAE,CAAC;IACzE,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;AACrE,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,wBAAwB,CAAC,UAAgC,EAAE;IAC/E,MAAM,KAAK,GAA8B,IAAI,iCAAyB,EAAE,CAAC;IACzE,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACrD,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,yBAAyB;IAC7C,MAAM,KAAK,GAA8B,IAAI,iCAAyB,EAAE,CAAC;IACzE,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/connect/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @file Connect/login and logout operations against a ChRIS backend.
+ *
+ * @module
+ */
+/**
+ * Options for connecting to a ChRIS backend (url, username, password).
+ */
+export interface ConnectOptions {
+    user: string;
+    password: string;
+    debug: boolean;
+    url: string;
+}
+/**
+ * Connects and authenticates against a ChRIS backend.
+ *
+ * @param options - Connection options.
+ * @returns True on success, false otherwise.
+ */
+export declare function connect_do(options: ConnectOptions): Promise<boolean>;
+/**
+ * Logs out of the current ChRIS session, clearing stored credentials.
+ */
+export declare function logout_do(): Promise<void>;

package/dist/connect/index.js

@@ -0,0 +1,27 @@
+"use strict";
+/**
+ * @file Connect/login and logout operations against a ChRIS backend.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.connect_do = connect_do;
+exports.logout_do = logout_do;
+const cumin_1 = require("@fnndsc/cumin");
+/**
+ * Connects and authenticates against a ChRIS backend.
+ *
+ * @param options - Connection options.
+ * @returns True on success, false otherwise.
+ */
+async function connect_do(options) {
+    const token = await cumin_1.chrisConnection.connection_connect(options);
+    return token !== null;
+}
+/**
+ * Logs out of the current ChRIS session, clearing stored credentials.
+ */
+async function logout_do() {
+    await cumin_1.chrisConnection.connection_logout();
+}
+//# sourceMappingURL=index.js.map

package/dist/connect/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/connect/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAoBH,gCAGC;AAKD,8BAEC;AA5BD,yCAAgD;AAYhD;;;;;GAKG;AACI,KAAK,UAAU,UAAU,CAAC,OAAuB;IACtD,MAAM,KAAK,GAAkB,MAAM,uBAAe,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC;IAC/E,OAAO,KAAK,KAAK,IAAI,CAAC;AACxB,CAAC;AAED;;GAEG;AACI,KAAK,UAAU,SAAS;IAC7B,MAAM,uBAAe,CAAC,iBAAiB,EAAE,CAAC;AAC5C,CAAC"}

package/dist/context/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @file Context read/write operations (full and single context) for salsa.
+ *
+ * @module
+ */
+import { FullContext, SingleContext, Result } from "@fnndsc/cumin";
+/**
+ * Options describing a context mutation (URL, user, feed, folder, etc.).
+ */
+export interface ContextOptions {
+    ChRISurl?: string;
+    ChRISuser?: string;
+    ChRISfolder?: string;
+    ChRISfeed?: string;
+    ChRISplugin?: string;
+    pacsserver?: string;
+    full?: boolean;
+    all?: boolean;
+}
+/**
+ * Returns the full current context.
+ *
+ * @returns The full context object.
+ */
+export declare function context_getFull(): FullContext;
+/**
+ * Returns the single (resolved) current context.
+ *
+ * @returns Promise resolving to the single context.
+ */
+export declare function context_getSingle(): Promise<SingleContext>;
+/**
+ * Applies one or more context mutations.
+ *
+ * @param options - The context fields to set.
+ * @returns Result wrapping the list of applied keys.
+ */
+export declare function context_set(options: ContextOptions): Promise<Result<string[]>>;

package/dist/context/index.js

@@ -0,0 +1,58 @@
+"use strict";
+/**
+ * @file Context read/write operations (full and single context) for salsa.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.context_getFull = context_getFull;
+exports.context_getSingle = context_getSingle;
+exports.context_set = context_set;
+const cumin_1 = require("@fnndsc/cumin");
+/**
+ * Returns the full current context.
+ *
+ * @returns The full context object.
+ */
+function context_getFull() {
+    return cumin_1.chrisContext.fullContext_get();
+}
+/**
+ * Returns the single (resolved) current context.
+ *
+ * @returns Promise resolving to the single context.
+ */
+async function context_getSingle() {
+    await cumin_1.chrisContext.currentContext_update();
+    return cumin_1.chrisContext.singleContext;
+}
+/**
+ * Applies one or more context mutations.
+ *
+ * @param options - The context fields to set.
+ * @returns Result wrapping the list of applied keys.
+ */
+async function context_set(options) {
+    const results = [];
+    const setters = [
+        { key: 'ChRISuser', context: cumin_1.Context.ChRISuser },
+        { key: 'ChRISurl', context: cumin_1.Context.ChRISURL },
+        { key: 'ChRISfolder', context: cumin_1.Context.ChRISfolder },
+        { key: 'ChRISfeed', context: cumin_1.Context.ChRISfeed },
+        { key: 'ChRISplugin', context: cumin_1.Context.ChRISplugin },
+        { key: 'pacsserver', context: cumin_1.Context.PACSserver },
+    ];
+    for (const { key, context } of setters) {
+        const value = options[key];
+        if (value !== undefined && typeof value === 'string') {
+            const success = await cumin_1.chrisContext.current_set(context, value);
+            if (!success) {
+                cumin_1.errorStack.stack_push('error', cumin_1.errorStack.allOfType_get('error').join('\n'));
+                return (0, cumin_1.Err)();
+            }
+            results.push(`${context} set to ${value}`);
+        }
+    }
+    return (0, cumin_1.Ok)(results);
+}
+//# sourceMappingURL=index.js.map

package/dist/context/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/context/index.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAgCH,0CAEC;AAOD,8CAGC;AAQD,kCAyBC;AA3ED,yCASuB;AAgBvB;;;;GAIG;AACH,SAAgB,eAAe;IAC7B,OAAO,oBAAY,CAAC,eAAe,EAAE,CAAC;AACxC,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,iBAAiB;IACrC,MAAM,oBAAY,CAAC,qBAAqB,EAAE,CAAC;IAC3C,OAAO,oBAAY,CAAC,aAAa,CAAC;AACpC,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,WAAW,CAAC,OAAuB;IACvD,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,OAAO,GAAsD;QACjE,EAAE,GAAG,EAAE,WAAW,EAAI,OAAO,EAAE,eAAO,CAAC,SAAS,EAAI;QACpD,EAAE,GAAG,EAAE,UAAU,EAAK,OAAO,EAAE,eAAO,CAAC,QAAQ,EAAM;QACrD,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,eAAO,CAAC,WAAW,EAAG;QACrD,EAAE,GAAG,EAAE,WAAW,EAAI,OAAO,EAAE,eAAO,CAAC,SAAS,EAAK;QACrD,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,eAAO,CAAC,WAAW,EAAG;QACrD,EAAE,GAAG,EAAE,YAAY,EAAG,OAAO,EAAE,eAAO,CAAC,UAAU,EAAI;KACtD,CAAC;IAEF,KAAK,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,OAAO,EAAE,CAAC;QACvC,MAAM,KAAK,GAAiC,OAAO,CAAC,GAAG,CAAC,CAAC;QACzD,IAAI,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;YACrD,MAAM,OAAO,GAAY,MAAM,oBAAY,CAAC,WAAW,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YACxE,IAAI,CAAC,OAAO,EAAE,CAAC;gBACb,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,kBAAU,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBAC7E,OAAO,IAAA,WAAG,GAAE,CAAC;YACf,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,WAAW,KAAK,EAAE,CAAC,CAAC;QAC7C,CAAC;IACH,CAAC;IAED,OAAO,IAAA,UAAE,EAAC,OAAO,CAAC,CAAC;AACrB,CAAC"}

package/dist/feeds/index.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @file Feed management operations.
+ * @module
+ */
+import { SimpleRecord, ChRISObjectParams, FilteredResourceData, ListOptions } from '@fnndsc/cumin';
+export { feedNote_get, feedNote_update, feedComments_list, feedComment_create, feedComment_delete, feedComment_update, } from '@fnndsc/cumin';
+export type { FeedNote, FeedComment } from '@fnndsc/cumin';
+/**
+ * List feeds based on options.
+ *
+ * @param options - Search and pagination options.
+ * @returns A Promise resolving to FilteredResourceData or null.
+ */
+export declare function feeds_list(options: ListOptions): Promise<FilteredResourceData | null>;
+/**
+ * Fetches all feeds across all pages.
+ *
+ * @param options - Filter options (limit/offset managed internally).
+ * @returns A Promise resolving to FilteredResourceData or null.
+ */
+export declare function feeds_listAll(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+/**
+ * Get the list of available fields for feeds.
+ *
+ * @returns A Promise resolving to an array of field names or null.
+ */
+export declare function feedFields_get(): Promise<string[] | null>;
+/**
+ * Create a new feed from a set of directories.
+ *
+ * This function orchestrates the creation of a new feed by uploading data
+ * from local directories to the ChRIS system.
+ *
+ * @param dirs - An array of local directory paths to upload.
+ * @param params - Optional parameters for the feed (e.g., name, tags).
+ * @returns A Promise resolving to the created feed record, or null if creation failed.
+ */
+export declare function feed_create(dirs: string[], params?: ChRISObjectParams): Promise<SimpleRecord | null>;
+/**
+ * Interface for feed sharing options.
+ */
+export interface FeedShareOptions {
+    is_public?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * Shares a feed with specified ID and options.
+ *
+ * @param feedId - The ID of the feed to share.
+ * @param options - Sharing options, e.g., { is_public: true } to make public.
+ * @returns A Promise resolving to true on successful sharing, false otherwise.
+ */
+export declare function feeds_share(feedId: number, options: FeedShareOptions): Promise<boolean>;
+/**
+ * Deletes a feed by its ID.
+ *
+ * @param id - The ID of the feed to delete.
+ * @returns A Promise resolving to true on success, false on failure.
+ */
+export declare function feed_delete(id: number): Promise<boolean>;

package/dist/feeds/index.js

@@ -0,0 +1,101 @@
+"use strict";
+/**
+ * @file Feed management operations.
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.feedComment_update = exports.feedComment_delete = exports.feedComment_create = exports.feedComments_list = exports.feedNote_update = exports.feedNote_get = void 0;
+exports.feeds_list = feeds_list;
+exports.feeds_listAll = feeds_listAll;
+exports.feedFields_get = feedFields_get;
+exports.feed_create = feed_create;
+exports.feeds_share = feeds_share;
+exports.feed_delete = feed_delete;
+const cumin_1 = require("@fnndsc/cumin");
+var cumin_2 = require("@fnndsc/cumin");
+Object.defineProperty(exports, "feedNote_get", { enumerable: true, get: function () { return cumin_2.feedNote_get; } });
+Object.defineProperty(exports, "feedNote_update", { enumerable: true, get: function () { return cumin_2.feedNote_update; } });
+Object.defineProperty(exports, "feedComments_list", { enumerable: true, get: function () { return cumin_2.feedComments_list; } });
+Object.defineProperty(exports, "feedComment_create", { enumerable: true, get: function () { return cumin_2.feedComment_create; } });
+Object.defineProperty(exports, "feedComment_delete", { enumerable: true, get: function () { return cumin_2.feedComment_delete; } });
+Object.defineProperty(exports, "feedComment_update", { enumerable: true, get: function () { return cumin_2.feedComment_update; } });
+/**
+ * List feeds based on options.
+ *
+ * @param options - Search and pagination options.
+ * @returns A Promise resolving to FilteredResourceData or null.
+ */
+async function feeds_list(options) {
+    const feedGroup = new cumin_1.ChRISFeedGroup();
+    return await feedGroup.asset.resources_listAndFilterByOptions(options);
+}
+/**
+ * Fetches all feeds across all pages.
+ *
+ * @param options - Filter options (limit/offset managed internally).
+ * @returns A Promise resolving to FilteredResourceData or null.
+ */
+async function feeds_listAll(options) {
+    const feedGroup = new cumin_1.ChRISFeedGroup();
+    return await feedGroup.asset.resources_getAll(options);
+}
+/**
+ * Get the list of available fields for feeds.
+ *
+ * @returns A Promise resolving to an array of field names or null.
+ */
+async function feedFields_get() {
+    const feedGroup = new cumin_1.ChRISFeedGroup(); // Instantiate directly
+    if (!feedGroup) {
+        return null;
+    }
+    const results = await feedGroup.asset.resourceFields_get();
+    return results ? results.fields : null;
+}
+/**
+ * Create a new feed from a set of directories.
+ *
+ * This function orchestrates the creation of a new feed by uploading data
+ * from local directories to the ChRIS system.
+ *
+ * @param dirs - An array of local directory paths to upload.
+ * @param params - Optional parameters for the feed (e.g., name, tags).
+ * @returns A Promise resolving to the created feed record, or null if creation failed.
+ */
+async function feed_create(dirs, params = {}) {
+    const chrisFeed = new cumin_1.ChRISFeed();
+    // For now, assuming dirs is passed as is or joined.
+    const dirsArg = Array.isArray(dirs) ? dirs.join(',') : dirs;
+    return await chrisFeed.createFromDirs(dirsArg, params);
+}
+/**
+ * Shares a feed with specified ID and options.
+ *
+ * @param feedId - The ID of the feed to share.
+ * @param options - Sharing options, e.g., { is_public: true } to make public.
+ * @returns A Promise resolving to true on successful sharing, false otherwise.
+ */
+async function feeds_share(feedId, options) {
+    if (options.is_public === true) {
+        const result = await (0, cumin_1.feed_makePublic)(feedId);
+        return result.ok && result.value;
+    }
+    else if (options.is_public === false) {
+        const result = await (0, cumin_1.feed_makePrivate)(feedId);
+        return result.ok && result.value;
+    }
+    // Implement other sharing mechanisms (user/group) if needed based on options
+    cumin_1.errorStack.stack_push("error", "No valid sharing option specified (e.g., --is_public).");
+    return false;
+}
+/**
+ * Deletes a feed by its ID.
+ *
+ * @param id - The ID of the feed to delete.
+ * @returns A Promise resolving to true on success, false on failure.
+ */
+async function feed_delete(id) {
+    const result = await (0, cumin_1.feed_delete)(id);
+    return result.ok && result.value;
+}
+//# sourceMappingURL=index.js.map

package/dist/feeds/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/feeds/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAgCH,gCAGC;AAQD,sCAGC;AAOD,wCASC;AAYD,kCAMC;AAiBD,kCAYC;AAQD,kCAGC;AAtHD,yCAYuB;AAEvB,uCAOuB;AANrB,qGAAA,YAAY,OAAA;AACZ,wGAAA,eAAe,OAAA;AACf,0GAAA,iBAAiB,OAAA;AACjB,2GAAA,kBAAkB,OAAA;AAClB,2GAAA,kBAAkB,OAAA;AAClB,2GAAA,kBAAkB,OAAA;AAIpB;;;;;GAKG;AACI,KAAK,UAAU,UAAU,CAAC,OAAoB;IACnD,MAAM,SAAS,GAAmB,IAAI,sBAAc,EAAE,CAAC;IACvD,OAAO,MAAM,SAAS,CAAC,KAAK,CAAC,gCAAgC,CAAC,OAAO,CAAC,CAAC;AACzE,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,aAAa,CAAC,OAA8B;IAChE,MAAM,SAAS,GAAmB,IAAI,sBAAc,EAAE,CAAC;IACvD,OAAO,MAAM,SAAS,CAAC,KAAK,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;AACzD,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,cAAc;IAClC,MAAM,SAAS,GAAmB,IAAI,sBAAc,EAAE,CAAC,CAAC,uBAAuB;IAE/E,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,SAAS,CAAC,KAAK,CAAC,kBAAkB,EAAE,CAAC;IAC3D,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;AACzC,CAAC;AAED;;;;;;;;;GASG;AACI,KAAK,UAAU,WAAW,CAAC,IAAc,EAAE,SAA4B,EAAE;IAC9E,MAAM,SAAS,GAAc,IAAI,iBAAS,EAAE,CAAC;IAC7C,oDAAoD;IACpD,MAAM,OAAO,GAAW,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAEpE,OAAO,MAAM,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACzD,CAAC;AAUD;;;;;;GAMG;AACI,KAAK,UAAU,WAAW,CAAC,MAAc,EAAE,OAAyB;IACzE,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC/B,MAAM,MAAM,GAAoB,MAAM,IAAA,uBAAe,EAAC,MAAM,CAAC,CAAC;QAC9D,OAAO,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC;IACnC,CAAC;SAAM,IAAI,OAAO,CAAC,SAAS,KAAK,KAAK,EAAE,CAAC;QACvC,MAAM,MAAM,GAAoB,MAAM,IAAA,wBAAgB,EAAC,MAAM,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC;IACnC,CAAC;IAED,6EAA6E;IAC7E,kBAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wDAAwD,CAAC,CAAC;IACzF,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,WAAW,CAAC,EAAU;IAC1C,MAAM,MAAM,GAAoB,MAAM,IAAA,mBAAiB,EAAC,EAAE,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,KAAK,CAAC;AACnC,CAAC"}