@fnndsc/cumin 3.2.4

package/dist/resources/chrisResources.js

@@ -0,0 +1,415 @@
+"use strict";
+/**
+ * @file ChRIS Resource Management
+ *
+ * This module defines the base class and interfaces for managing ChRIS resources.
+ * It provides functionality for listing, filtering, and manipulating resource items.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISResource = void 0;
+exports.resourceFields_get = resourceFields_get;
+const chrisapi_1 = require("@fnndsc/chrisapi");
+const chrisConnection_js_1 = require("../connect/chrisConnection.js");
+const config_js_1 = require("../config/config.js");
+/**
+ * Base class for managing ChRIS resources.
+ */
+class ChRISResource {
+    constructor() {
+        this._client = null;
+        this._resourceName = "";
+        this._resourceCollection = null;
+        this._resourceArrayItems = null;
+        this._resourceArray = null;
+        this._resourceItem = null;
+        this.resourceMethod = null;
+        this._lazyMethodName = null;
+        this._lazyObjProvider = null;
+        // Client initialization is deferred
+    }
+    /**
+     * Retrieves the ChRIS client instance asynchronously.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    async client_get() {
+        if (!this._client) {
+            this._client = await chrisConnection_js_1.chrisConnection.client_get();
+        }
+        return this._client;
+    }
+    get resourceName() {
+        return this._resourceName;
+    }
+    set resourceName(name) {
+        this._resourceName = name;
+    }
+    set resourceCollection(collection) {
+        this._resourceCollection = collection;
+    }
+    /**
+     * Converts a resource item to a dictionary.
+     * @param item - The item to convert.
+     * @returns A dictionary representation of the item.
+     */
+    resourceItem_toDict(item) {
+        return item.data.reduce((acc, { name, value }) => {
+            acc[name] = value;
+            return acc;
+        }, {});
+    }
+    /**
+     * Converts a list of resource items to dictionaries.
+     * @param items - The list of items to convert.
+     * @returns An array of dictionaries.
+     */
+    resourceItems_toDicts(items) {
+        return items.map(this.resourceItem_toDict);
+    }
+    /**
+     * Deletes a resource item by its ID.
+     * @param id - The ID of the item to delete.
+     * @returns A Promise resolving to true on success, false otherwise.
+     */
+    async resourceItem_delete(id) {
+        if (!(this._resourceCollection instanceof chrisapi_1.ListResource)) {
+            return false;
+        }
+        const res = this._resourceCollection?.getItem(id);
+        try {
+            await res._delete();
+            return true;
+        }
+        catch (e) {
+            return false;
+        }
+    }
+    /**
+     * Builds a list of items from a resource collection.
+     * @param resources - The resource collection.
+     * @returns An array of Items or null.
+     */
+    resourceItems_buildFromCollection(resources) {
+        if (!resources || !resources.collection) {
+            return null;
+        }
+        return resources.collection.items.map((item) => ({
+            data: item.data,
+            href: item.href,
+            links: item.links,
+        }));
+    }
+    /**
+     * Binds a resource fetching method to an object.
+     * @param obj - The object context.
+     * @param resourceMethod - The method to bind.
+     * @param resourceName - Optional name for the resource.
+     */
+    binding_applyGet(obj, resourceMethod, resourceName) {
+        // this._resourceObj = obj;
+        this.resourceMethod = resourceMethod.bind(obj);
+        if (resourceName)
+            this._resourceName = resourceName;
+    }
+    /**
+     * Binds a resource fetching method lazily.
+     * @param objProvider - A function returning a Promise to the object context.
+     * @param methodName - The name of the method to bind.
+     * @param resourceName - Optional name for the resource.
+     */
+    binding_applyLazy(objProvider, methodName, resourceName) {
+        this._lazyObjProvider = objProvider;
+        this._lazyMethodName = methodName;
+        if (resourceName)
+            this._resourceName = resourceName;
+    }
+    async lazyBinding_resolve() {
+        if (!this.resourceMethod && this._lazyObjProvider && this._lazyMethodName) {
+            const obj = await this._lazyObjProvider();
+            if (obj) {
+                const method = obj[this._lazyMethodName];
+                if (typeof method === 'function') {
+                    this.resourceMethod = method.bind(obj);
+                }
+                else {
+                    console.error(`Method ${this._lazyMethodName} not found on object.`);
+                }
+            }
+        }
+    }
+    get hasNextPage() {
+        if (this._resourceCollection instanceof chrisapi_1.ListResource) {
+            return this._resourceCollection.hasNext;
+        }
+        return false;
+    }
+    /**
+     * Lists *all* resources by automatically handling pagination.
+     * @param options - Filtering options. Limit and offset will be managed internally.
+     * @returns A Promise resolving to FilteredResourceData containing all matching resources, or null.
+     */
+    async resources_getAll(options) {
+        const limit = 100;
+        let offset = 0;
+        let allTableData = [];
+        let selectedFields = [];
+        // If options has a limit, we should respect it? No, getAll implies fetching everything.
+        // But we should respect filters.
+        while (true) {
+            const pageOptions = { ...options, limit, offset };
+            const result = await this.resources_listAndFilterByOptions(pageOptions);
+            if (!result || !result.tableData) {
+                break;
+            }
+            if (selectedFields.length === 0) {
+                selectedFields = result.selectedFields;
+            }
+            allTableData = allTableData.concat(result.tableData);
+            // Robust exit conditions:
+            // 1. If we got 0 items, we are definitely done.
+            if (result.tableData.length === 0) {
+                break;
+            }
+            // 2. If we got fewer items than the limit, this must be the last page.
+            if (result.tableData.length < limit) {
+                break;
+            }
+            // 3. If API explicitly says no next page (and it's not undefined).
+            if (this.hasNextPage === false) {
+                break;
+            }
+            // If we got a full page and hasNextPage is not explicitly false, continue
+            offset += limit;
+        }
+        if (allTableData.length === 0) {
+            return null;
+        }
+        return {
+            tableData: allTableData,
+            selectedFields,
+            totalCount: allTableData.length,
+        };
+    }
+    /**
+     * Lists and filters resources based on options.
+     * @param options - Filtering and listing options.
+     * @returns A Promise resolving to filtered resource data or null.
+     */
+    async resources_listAndFilterByOptions(options) {
+        const results = this.resources_filterByFields(await this.resourceFields_get(await this.resources_getList(options)));
+        if (results && this._resourceCollection instanceof chrisapi_1.ListResource) {
+            const total = this._resourceCollection.totalCount;
+            if (total >= 0)
+                results.totalCount = total;
+        }
+        return results;
+    }
+    /**
+     * Filters resources by specific fields.
+     * @param resourcesByFields - The resources and fields to filter.
+     * @returns Filtered data suitable for table display.
+     */
+    resources_filterByFields(resourcesByFields) {
+        if (!resourcesByFields) {
+            return null;
+        }
+        const resources = resourcesByFields.items;
+        const selectedFields = resourcesByFields.fields;
+        if (!resources)
+            return null;
+        const tableData = resources.map((resource) => {
+            const rowData = {
+                id: resource.href.split("/").slice(-2)[0],
+            };
+            resource.data.forEach((item) => {
+                if (selectedFields.includes(item.name)) {
+                    rowData[item.name] = item.value;
+                }
+            });
+            return rowData;
+        });
+        return { tableData, selectedFields };
+    }
+    resourcesByFields_enumerate(items) {
+        if (!items || !items.length) {
+            return null;
+        }
+        const allFields = ["id", ...items[0].data.map((item) => item.name)];
+        const resourcesFieldsPerItem = {
+            items: items,
+            fields: allFields,
+        };
+        return resourcesFieldsPerItem;
+    }
+    fieldSpec_resolve(fieldFilter, options) {
+        let selectedFields = [];
+        let fieldSpec = "";
+        if (typeof options?.fields === "string") {
+            fieldSpec = options.fields;
+        }
+        else if (fieldFilter) {
+            fieldSpec = fieldFilter;
+        }
+        if (fieldSpec) {
+            selectedFields = fieldSpec.split(",").map((f) => f.trim());
+        }
+        return selectedFields;
+    }
+    async resourceFields_get(options, fields) {
+        if (!this._resourceCollection) {
+            await this.resources_getList();
+        }
+        if (!this._resourceArrayItems) {
+            return null;
+        }
+        let selectedFields = this.fieldSpec_resolve(fields, options);
+        const resourcesFields = this.resourcesByFields_enumerate(this._resourceArrayItems);
+        if (!resourcesFields) {
+            return null;
+        }
+        if (!selectedFields.length) {
+            if (resourcesFields) {
+                selectedFields = resourcesFields.fields;
+            }
+        }
+        selectedFields = Array.from(new Set(selectedFields));
+        const resourcesByFields = {
+            resources: this._resourceCollection,
+            items: this._resourceArrayItems,
+            options: options,
+            fields: selectedFields,
+        };
+        return resourcesByFields;
+    }
+    async resources_getItems(options) {
+        const params = {
+            limit: options?.limit ?? 20,
+            offset: options?.offset ?? 0,
+        };
+        await this.lazyBinding_resolve();
+        if (!this.resourceMethod) {
+            return null;
+        }
+        const resources = await this.resourceMethod(params);
+        if (!(this._resourceCollection instanceof chrisapi_1.ListResource)) {
+            return null;
+        }
+        this._resourceArray = this._resourceCollection?.getItems();
+        if (this._resourceArray) {
+            // console.log(this._resourceArray);
+            return this._resourceArray;
+        }
+        return null;
+    }
+    options_simplify(options) {
+        const params = {
+            limit: options?.limit ?? 20,
+            offset: options?.offset ?? 0,
+        };
+        return params;
+    }
+    filtering_applyAdditional(originalParams) {
+        if (!this._resourceArrayItems || this._resourceArrayItems.length === 0) {
+            return null;
+        }
+        const filteredItems = this._resourceArrayItems.filter((item) => {
+            return Object.entries(originalParams).every(([paramKey, paramValue]) => {
+                // Skip non-search related parameters
+                if (["limit", "offset"].includes(paramKey)) {
+                    return true;
+                }
+                const dataItem = item.data.find((d) => d.name === paramKey);
+                if (!dataItem) {
+                    return false; // If the field is not found, it doesn't match the filter
+                }
+                const itemValue = String(dataItem.value).toLowerCase();
+                const searchValue = String(paramValue).toLowerCase();
+                // Perform exact match for 'id', partial match for other fields
+                if (paramKey === "id") {
+                    return itemValue === searchValue;
+                }
+                else {
+                    return itemValue.includes(searchValue);
+                }
+            });
+        });
+        return filteredItems.length > 0 ? filteredItems : null;
+    }
+    async resources_getList(options, resourceMethod) {
+        const params = {
+            limit: 20,
+            offset: 0,
+            ...options,
+        };
+        // Remove the "fields" otherwise some list resource ops break
+        const { fields, ...pureparams } = params;
+        let simplifiedParams = pureparams;
+        if (resourceMethod) {
+            this.resourceMethod = resourceMethod;
+        }
+        await this.lazyBinding_resolve();
+        if (!this.resourceMethod)
+            return params;
+        let resources = null;
+        try {
+            resources = await this.resourceMethod(pureparams);
+        }
+        catch (error) {
+            if (config_js_1.connectionConfig && config_js_1.connectionConfig.debug) {
+                console.error(`Error fetching ${this._resourceName}:`, error);
+            }
+            // Attempt simplified params as fallback
+            try {
+                simplifiedParams = this.options_simplify(pureparams);
+                resources = await this.resourceMethod(simplifiedParams);
+            }
+            catch (retryError) {
+                if (config_js_1.connectionConfig && config_js_1.connectionConfig.debug) {
+                    console.error(`Retry failed for ${this._resourceName}:`, retryError);
+                }
+                throw retryError; // Re-throw the error if retry fails
+            }
+        }
+        if (resources == undefined || resources == null) {
+            console.log(this._resourceName + " resource list returned 'undefined' or 'null'");
+            return params;
+        }
+        this._resourceCollection = resources;
+        if (!(this._resourceCollection instanceof chrisapi_1.ListResource)) {
+            return null;
+        }
+        this._resourceArray = this._resourceCollection?.getItems();
+        this._resourceArrayItems =
+            this.resourceItems_buildFromCollection(resources);
+        if (Object.keys(pureparams).length > Object.keys(simplifiedParams).length) {
+            const filteredItems = this.filtering_applyAdditional(pureparams);
+            if (filteredItems === null) {
+                console.log("Warning: No items match the search criteria.");
+            }
+            this._resourceArrayItems = filteredItems;
+        }
+        return params;
+    }
+}
+exports.ChRISResource = ChRISResource;
+/**
+ * Helper to get resource fields from a resource object.
+ * @param obj - The resource object.
+ * @param fields - The fields to extract.
+ * @returns A SimpleRecord of fields or null.
+ */
+function resourceFields_get(obj, fields) {
+    const chrisResource = new ChRISResource();
+    const item = chrisResource.resourceItems_buildFromCollection(obj);
+    const resourceData = chrisResource.resources_filterByFields({
+        resources: obj,
+        items: item,
+        fields: fields,
+    });
+    if (!resourceData) {
+        return null;
+    }
+    return resourceData.tableData[0];
+}
+//# sourceMappingURL=chrisResources.js.map

package/dist/resources/chrisResources.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisResources.js","sourceRoot":"","sources":["../../src/resources/chrisResources.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAqhBH,gDAiBC;AAniBD,+CAAwE;AACxE,sEAAgE;AAChE,mDAAuD;AAuEvD;;GAEG;AACH,MAAa,aAAa;IAWxB;QAVQ,YAAO,GAAkB,IAAI,CAAC;QAC9B,kBAAa,GAAW,EAAE,CAAC;QAC3B,wBAAmB,GAAmC,IAAI,CAAC;QAC3D,wBAAmB,GAAkB,IAAI,CAAC;QAC1C,mBAAc,GAAsC,IAAI,CAAC;QACzD,kBAAa,GAAwB,IAAI,CAAC;QAC1C,mBAAc,GAAuE,IAAI,CAAC;QAC1F,oBAAe,GAAkB,IAAI,CAAC;QACtC,qBAAgB,GAAoC,IAAI,CAAC;QAG/D,oCAAoC;IACtC,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,GAAG,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;QACpD,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,IAAI,YAAY,CAAC,IAAY;QAC3B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;IAC5B,CAAC;IAED,IAAI,kBAAkB,CAAC,UAAmC;QACxD,IAAI,CAAC,mBAAmB,GAAG,UAAU,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,IAAU;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAe,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,EAAE;YAC3D,GAAG,CAAC,IAAI,CAAC,GAAG,KAAkC,CAAC;YAC/C,OAAO,GAAG,CAAC;QACb,CAAC,EAAE,EAAE,CAAC,CAAC;IACT,CAAC;IAED;;;;OAIG;IACH,qBAAqB,CAAC,KAAa;QACjC,OAAO,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;IAC7C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,EAAU;QAClC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,YAAY,uBAAY,CAAC,EAAE,CAAC;YACxD,OAAO,KAAK,CAAC;QACf,CAAC;QACD,MAAM,GAAG,GAAiB,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,EAAE,CAAiB,CAAC;QAChF,IAAI,CAAC;YACH,MAAM,GAAG,CAAC,OAAO,EAAE,CAAC;YACpB,OAAO,IAAI,CAAC;QACd,CAAC;QAAC,OAAO,CAAU,EAAE,CAAC;YACpB,OAAO,KAAK,CAAC;QACf,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,iCAAiC,CAC/B,SAAyC;QAEzC,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YACxC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAQ,SAAS,CAAC,UAA2C,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAU,EAAE,EAAE,CAAC,CAAC;YACvF,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,gBAAgB,CACd,GAAY,EACZ,cAAyE,EACzE,YAAqB;QAErB,2BAA2B;QAC3B,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,YAAY;YAAE,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACtD,CAAC;IAED;;;;;OAKG;IACH,iBAAiB,CACf,WAAmC,EACnC,UAAkB,EAClB,YAAqB;QAErB,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC;QACpC,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC;QAClC,IAAI,YAAY;YAAE,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACtD,CAAC;IAEO,KAAK,CAAC,mBAAmB;QAC/B,IAAI,CAAC,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,gBAAgB,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YAC1E,MAAM,GAAG,GAAY,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACnD,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,MAAM,GAAa,GAA+B,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;gBAC/E,IAAI,OAAO,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC/B,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAC3C,CAAC;qBAAM,CAAC;oBACJ,OAAO,CAAC,KAAK,CAAC,UAAU,IAAI,CAAC,eAAe,uBAAuB,CAAC,CAAC;gBACzE,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,WAAW;QACb,IAAI,IAAI,CAAC,mBAAmB,YAAY,uBAAY,EAAE,CAAC;YACrD,OAAQ,IAAI,CAAC,mBAAkD,CAAC,OAAO,CAAC;QAC1E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gBAAgB,CACpB,OAA8B;QAE9B,MAAM,KAAK,GAAW,GAAG,CAAC;QAC1B,IAAI,MAAM,GAAW,CAAC,CAAC;QACvB,IAAI,YAAY,GAA8B,EAAE,CAAC;QACjD,IAAI,cAAc,GAAa,EAAE,CAAC;QAClC,wFAAwF;QACxF,iCAAiC;QAEjC,OAAO,IAAI,EAAE,CAAC;YACZ,MAAM,WAAW,GAAyB,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;YACxE,MAAM,MAAM,GAAgC,MAAM,IAAI,CAAC,gCAAgC,CAAC,WAAW,CAAC,CAAC;YAErG,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC;gBACjC,MAAM;YACR,CAAC;YAED,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;YACzC,CAAC;YAED,YAAY,GAAG,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAErD,0BAA0B;YAC1B,gDAAgD;YAChD,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAClC,MAAM;YACR,CAAC;YAED,uEAAuE;YACvE,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,GAAG,KAAK,EAAE,CAAC;gBACpC,MAAM;YACR,CAAC;YAED,mEAAmE;YACnE,IAAI,IAAI,CAAC,WAAW,KAAK,KAAK,EAAE,CAAC;gBAC/B,MAAM;YACR,CAAC;YAED,0EAA0E;YAC1E,MAAM,IAAI,KAAK,CAAC;QAClB,CAAC;QAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO;YACL,SAAS,EAAE,YAAY;YACvB,cAAc;YACd,UAAU,EAAE,YAAY,CAAC,MAAM;SAChC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,gCAAgC,CACpC,OAA8B;QAE9B,MAAM,OAAO,GAAgC,IAAI,CAAC,wBAAwB,CACxE,MAAM,IAAI,CAAC,kBAAkB,CAAC,MAAM,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC,CACrE,CAAC;QACF,IAAI,OAAO,IAAI,IAAI,CAAC,mBAAmB,YAAY,uBAAY,EAAE,CAAC;YAChE,MAAM,KAAK,GAAY,IAAI,CAAC,mBAAoC,CAAC,UAAU,CAAC;YAC5E,IAAI,KAAK,IAAI,CAAC;gBAAE,OAAO,CAAC,UAAU,GAAG,KAAK,CAAC;QAC7C,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CACtB,iBAA2C;QAE3C,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,SAAS,GAAkB,iBAAiB,CAAC,KAAK,CAAC;QACzD,MAAM,cAAc,GAAa,iBAAiB,CAAC,MAAM,CAAC;QAE1D,IAAI,CAAC,SAAS;YAAE,OAAO,IAAI,CAAC;QAE5B,MAAM,SAAS,GAA8B,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE;YACtE,MAAM,OAAO,GAA4B;gBACvC,EAAE,EAAE,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC1C,CAAC;YACF,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;gBAC7B,IAAI,cAAc,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;oBACvC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAClC,CAAC;YACH,CAAC,CAAC,CAAC;YACH,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,CAAC;IACvC,CAAC;IAED,2BAA2B,CACzB,KAAoB;QAEpB,IAAI,CAAC,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC;YAC5B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,SAAS,GAAa,CAAC,IAAI,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAC9E,MAAM,sBAAsB,GAA0B;YACpD,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,SAAS;SAClB,CAAC;QACF,OAAO,sBAAsB,CAAC;IAChC,CAAC;IAED,iBAAiB,CACf,WAAoB,EACpB,OAA4B;QAE5B,IAAI,cAAc,GAAa,EAAE,CAAC;QAClC,IAAI,SAAS,GAAW,EAAE,CAAC;QAC3B,IAAI,OAAO,OAAO,EAAE,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxC,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;QAC7B,CAAC;aAAM,IAAI,WAAW,EAAE,CAAC;YACvB,SAAS,GAAG,WAAW,CAAC;QAC1B,CAAC;QACD,IAAI,SAAS,EAAE,CAAC;YACd,cAAc,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,OAA4B,EAC5B,MAAe;QAEf,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC9B,MAAM,IAAI,CAAC,iBAAiB,EAAE,CAAC;QACjC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,cAAc,GAAa,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QACvE,MAAM,eAAe,GACnB,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC7D,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;YAC3B,IAAI,eAAe,EAAE,CAAC;gBACpB,cAAc,GAAG,eAAe,CAAC,MAAM,CAAC;YAC1C,CAAC;QACH,CAAC;QAED,cAAc,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC;QAErD,MAAM,iBAAiB,GAAsB;YAC3C,SAAS,EAAE,IAAI,CAAC,mBAAmB;YACnC,KAAK,EAAE,IAAI,CAAC,mBAAmB;YAC/B,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,cAAc;SACvB,CAAC;QACF,OAAO,iBAAiB,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,OAA8B;QAE9B,MAAM,MAAM,GAAgB;YAC1B,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;SAC7B,CAAC;QAEF,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;YACzB,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,SAAS,GAAmC,MAAM,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QACpF,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,YAAY,uBAAY,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAA2B,CAAC;QACpF,IAAI,IAAI,CAAC,cAAc,EAAE,CAAC;YACxB,oCAAoC;YACpC,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB,CAAC,OAAoB;QACnC,MAAM,MAAM,GAAgB;YAC1B,KAAK,EAAE,OAAO,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;SAC7B,CAAC;QACF,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,yBAAyB,CAAC,cAA2B;QAC3D,IAAI,CAAC,IAAI,CAAC,mBAAmB,IAAI,IAAI,CAAC,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvE,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,aAAa,GAAW,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACrE,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,EAAE,EAAE;gBACrE,qCAAqC;gBACrC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC3C,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,MAAM,QAAQ,GAAiD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;gBAC1G,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,OAAO,KAAK,CAAC,CAAC,yDAAyD;gBACzE,CAAC;gBAED,MAAM,SAAS,GAAW,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;gBAC/D,MAAM,WAAW,GAAW,MAAM,CAAC,UAAU,CAAC,CAAC,WAAW,EAAE,CAAC;gBAE7D,+DAA+D;gBAC/D,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;oBACtB,OAAO,SAAS,KAAK,WAAW,CAAC;gBACnC,CAAC;qBAAM,CAAC;oBACN,OAAO,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;gBACzC,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC;IACzD,CAAC;IAED,KAAK,CAAC,iBAAiB,CACrB,OAA8B,EAC9B,cAA0E;QAE1E,MAAM,MAAM,GAAgB;YAC1B,KAAK,EAAE,EAAE;YACT,MAAM,EAAE,CAAC;YACT,GAAG,OAAO;SACX,CAAC;QACF,6DAA6D;QAC7D,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,EAAE,GAAgB,MAAM,CAAC;QACtD,IAAI,gBAAgB,GAAgB,UAAU,CAAC;QAC/C,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;QAED,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,cAAc;YAAE,OAAO,MAAM,CAAC;QACxC,IAAI,SAAS,GAAmC,IAAI,CAAC;QACrD,IAAI,CAAC;YACH,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;QACpD,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,4BAAgB,IAAI,4BAAgB,CAAC,KAAK,EAAE,CAAC;gBAC/C,OAAO,CAAC,KAAK,CAAC,kBAAkB,IAAI,CAAC,aAAa,GAAG,EAAE,KAAK,CAAC,CAAC;YAChE,CAAC;YACD,wCAAwC;YACxC,IAAI,CAAC;gBACH,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;gBACrD,SAAS,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;YAC1D,CAAC;YAAC,OAAO,UAAmB,EAAE,CAAC;gBAC7B,IAAI,4BAAgB,IAAI,4BAAgB,CAAC,KAAK,EAAE,CAAC;oBAC/C,OAAO,CAAC,KAAK,CAAC,oBAAoB,IAAI,CAAC,aAAa,GAAG,EAAE,UAAU,CAAC,CAAC;gBACvE,CAAC;gBACD,MAAM,UAAU,CAAC,CAAC,oCAAoC;YACxD,CAAC;QACH,CAAC;QACD,IAAI,SAAS,IAAI,SAAS,IAAI,SAAS,IAAI,IAAI,EAAE,CAAC;YAChD,OAAO,CAAC,GAAG,CACT,IAAI,CAAC,aAAa,GAAG,+CAA+C,CACrE,CAAC;YACF,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,IAAI,CAAC,mBAAmB,GAAG,SAAS,CAAC;QACrC,IAAI,CAAC,CAAC,IAAI,CAAC,mBAAmB,YAAY,uBAAY,CAAC,EAAE,CAAC;YACxD,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,mBAAmB,EAAE,QAAQ,EAA2B,CAAC;QACpF,IAAI,CAAC,mBAAmB;YACtB,IAAI,CAAC,iCAAiC,CAAC,SAAS,CAAC,CAAC;QACpD,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,MAAM,EAAE,CAAC;YAC1E,MAAM,aAAa,GAAkB,IAAI,CAAC,yBAAyB,CAAC,UAAU,CAAC,CAAC;YAChF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC3B,OAAO,CAAC,GAAG,CAAC,8CAA8C,CAAC,CAAC;YAC9D,CAAC;YACD,IAAI,CAAC,mBAAmB,GAAG,aAAa,CAAC;QAC3C,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA9bD,sCA8bC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAChC,GAA4B,EAC5B,MAAgB;IAEhB,MAAM,aAAa,GAAkB,IAAI,aAAa,EAAE,CAAC;IACzD,MAAM,IAAI,GACR,aAAa,CAAC,iCAAiC,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,YAAY,GAChB,aAAa,CAAC,wBAAwB,CAAC;QACrC,SAAS,EAAE,GAAG;QACd,KAAK,EAAE,IAAI;QACX,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;IACL,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,YAAY,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;AACnC,CAAC"}

package/dist/tags/chrisTags.d.ts

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

package/dist/tags/chrisTags.js

@@ -0,0 +1,18 @@
+"use strict";
+/**
+ * @file ChRIS Tag resources.
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISTagGroup = void 0;
+const chrisResourceGroup_js_1 = require("../resources/chrisResourceGroup.js");
+/**
+ * Group handler for ChRIS tags.
+ */
+class ChRISTagGroup extends chrisResourceGroup_js_1.ChRISResourceGroup {
+    constructor() {
+        super('Tags', 'getTags');
+    }
+}
+exports.ChRISTagGroup = ChRISTagGroup;
+//# sourceMappingURL=chrisTags.js.map

package/dist/tags/chrisTags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisTags.js","sourceRoot":"","sources":["../../src/tags/chrisTags.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,8EAAwE;AAExE;;GAEG;AACH,MAAa,aAAc,SAAQ,0CAAkB;IACnD;QACE,KAAK,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAC3B,CAAC;CACF;AAJD,sCAIC"}

package/dist/users/chrisUsers.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @file ChRIS User and Group Resource Access
+ *
+ * @module
+ */
+import { Result } from '../utils/result.js';
+/**
+ * Represents a ChRIS group resource.
+ */
+export interface ChrisGroup {
+    id: number;
+    name: string;
+}
+/**
+ * Represents the currently authenticated ChRIS user.
+ */
+export interface ChrisUser {
+    id: number;
+    username: string;
+    email: string;
+    is_staff: boolean;
+}
+/**
+ * Fetches all groups from ChRIS CUBE.
+ *
+ * @returns A Result containing array of ChrisGroup, or Err on failure.
+ */
+export declare function groups_getAll(): Promise<Result<ChrisGroup[]>>;
+/**
+ * Fetches the currently authenticated user from ChRIS CUBE.
+ *
+ * @returns A Result containing ChrisUser, or Err on failure.
+ */
+export declare function currentUser_get(): Promise<Result<ChrisUser>>;

package/dist/users/chrisUsers.js

@@ -0,0 +1,57 @@
+"use strict";
+/**
+ * @file ChRIS User and Group Resource Access
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.groups_getAll = groups_getAll;
+exports.currentUser_get = currentUser_get;
+const chrisConnection_js_1 = require("../connect/chrisConnection.js");
+const errorStack_js_1 = require("../error/errorStack.js");
+const result_js_1 = require("../utils/result.js");
+/**
+ * Fetches all groups from ChRIS CUBE.
+ *
+ * @returns A Result containing array of ChrisGroup, or Err on failure.
+ */
+async function groups_getAll() {
+    try {
+        const client = await chrisConnection_js_1.chrisConnection.client_get();
+        if (!client) {
+            errorStack_js_1.errorStack.stack_push('error', 'Not connected to ChRIS. Please log in.');
+            return (0, result_js_1.Err)();
+        }
+        const groupList = await client.getGroups({ limit: 1000 });
+        const groups = groupList.data || [];
+        return (0, result_js_1.Ok)(groups);
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        errorStack_js_1.errorStack.stack_push('error', `Failed to fetch groups: ${msg}`);
+        return (0, result_js_1.Err)();
+    }
+}
+/**
+ * Fetches the currently authenticated user from ChRIS CUBE.
+ *
+ * @returns A Result containing ChrisUser, or Err on failure.
+ */
+async function currentUser_get() {
+    try {
+        const client = await chrisConnection_js_1.chrisConnection.client_get();
+        if (!client) {
+            errorStack_js_1.errorStack.stack_push('error', 'Not connected to ChRIS. Please log in.');
+            return (0, result_js_1.Err)();
+        }
+        const user = await client.getUser();
+        const userData = user.data;
+        return (0, result_js_1.Ok)(userData);
+    }
+    catch (error) {
+        const msg = error instanceof Error ? error.message : String(error);
+        errorStack_js_1.errorStack.stack_push('error', `Failed to fetch current user: ${msg}`);
+        return (0, result_js_1.Err)();
+    }
+}
+//# sourceMappingURL=chrisUsers.js.map

package/dist/users/chrisUsers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisUsers.js","sourceRoot":"","sources":["../../src/users/chrisUsers.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AA8BH,sCAiBC;AAOD,0CAiBC;AArED,sEAAgE;AAEhE,0DAAoD;AACpD,kDAAqD;AAoBrD;;;;GAIG;AACI,KAAK,UAAU,aAAa;IACjC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wCAAwC,CAAC,CAAC;YACzE,OAAO,IAAA,eAAG,GAAE,CAAC;QACf,CAAC;QAED,MAAM,SAAS,GAAc,MAAM,MAAM,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,MAAM,GAAkB,SAAS,CAAC,IAAgC,IAAI,EAAE,CAAC;QAE/E,OAAO,IAAA,cAAE,EAAC,MAAM,CAAC,CAAC;IACpB,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,2BAA2B,GAAG,EAAE,CAAC,CAAC;QACjE,OAAO,IAAA,eAAG,GAAE,CAAC;IACf,CAAC;AACH,CAAC;AAED;;;;GAIG;AACI,KAAK,UAAU,eAAe;IACnC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;QAClD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,wCAAwC,CAAC,CAAC;YACzE,OAAO,IAAA,eAAG,GAAE,CAAC;QACf,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAc,IAAI,CAAC,IAA4B,CAAC;QAE9D,OAAO,IAAA,cAAE,EAAC,QAAQ,CAAC,CAAC;IACtB,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,iCAAiC,GAAG,EAAE,CAAC,CAAC;QACvE,OAAO,IAAA,eAAG,GAAE,CAAC;IACf,CAAC;AACH,CAAC"}

package/dist/utils/keypair.d.ts

@@ -0,0 +1,77 @@
+/**
+ * @file Key-Pair and CLI Option Parsing Utilities.
+ *
+ * This module provides parsing and transformation utilities for converting key-value strings,
+ * raw CLI parameters, and command options into standardized ChRIS query payloads and objects.
+ *
+ * @module
+ */
+import { ListOptions } from "../resources/chrisResources";
+/**
+ * Base parameters for ChRIS object operations.
+ */
+export interface ChRISObjectParams {
+    limit?: number;
+    offset?: number;
+    page?: string;
+    returnFilter?: string;
+    [key: string]: unknown;
+}
+/**
+ * Parameters for getting ChRIS elements, including search query.
+ */
+export interface ChRISElementsGet extends ChRISObjectParams {
+    search?: string;
+    params?: string;
+}
+/**
+ * Represents hits from a query.
+ */
+export interface QueryHits {
+    hits: Array<unknown>;
+}
+/**
+ * Represents parsed CLI arguments.
+ */
+export interface ClIarguments {
+    [key: string]: string | boolean | number;
+}
+/**
+ * Parse a CLI string into a dictionary of arguments.
+ *
+ * @param cliString - The CLI argument string.
+ * @returns A dictionary of parsed arguments.
+ */
+export declare function dictionary_fromCLI(cliString: string): ClIarguments;
+/**
+ * Parse a key-pair string (e.g., "key:value,key2:value2") into an object.
+ *
+ * @param searchString - The string containing key-value pairs.
+ * @returns A record of parsed key-value pairs.
+ */
+export declare function keyPairString_parse(searchString: string): Record<string, string>;
+/**
+ * Apply key-pair parameters from a search string to an existing params object.
+ *
+ * @param params - The base parameters object.
+ * @param searchString - Optional search string to parse and merge.
+ * @returns The merged parameters object.
+ */
+export declare function keyPairParams_apply<T extends Record<string, any>>(params: T, searchString?: string): T;
+/**
+ * Convert options object to ChRIS list parameters.
+ * Handles pagination, offset, and key-pair filtering.
+ *
+ * @param options - The raw options object.
+ * @param keyPairField - The field name containing the key-pair string.
+ * @returns Formatted ListOptions.
+ */
+export declare function listParams_fromOptions(options: ChRISElementsGet, keyPairField?: keyof ChRISElementsGet): ListOptions;
+/**
+ * Extract a specific field or fields from a list of records into a QueryHits object.
+ *
+ * @param arrayList - The list of records.
+ * @param record - The field name or an array of field names to extract from each record.
+ * @returns A QueryHits object containing the extracted values.
+ */
+export declare function record_extract(arrayList: Array<Record<string, unknown>>, record: string | string[]): QueryHits;