@fnndsc/cumin 3.2.4

package/dist/resources/chrisEmbeddedResourceGroup.js

@@ -0,0 +1,148 @@
+"use strict";
+/**
+ * @file ChRIS Embedded Resource Group
+ *
+ * This module manages groups of ChRIS resources that are embedded within other resources
+ * (e.g., files within a folder, parameters of a plugin). It handles context-aware initialization.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISEmbeddedResourceGroup = exports.ChRISContextSpecError = exports.ChRISInitializationError = exports.ChRISConnectionError = void 0;
+exports.context_split = context_split;
+const chrisResourceGroup_js_1 = require("../resources/chrisResourceGroup.js");
+const chrisConnection_js_1 = require("../connect/chrisConnection.js");
+const errorStack_js_1 = require("../error/errorStack.js");
+/**
+ * Error thrown when the ChRIS client is not connected.
+ */
+class ChRISConnectionError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ChRISConnectionError";
+    }
+}
+exports.ChRISConnectionError = ChRISConnectionError;
+/**
+ * Error thrown when ChRIS initialization fails.
+ */
+class ChRISInitializationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ChRISInitializationError";
+    }
+}
+exports.ChRISInitializationError = ChRISInitializationError;
+/**
+ * Error thrown when a context specification is invalid.
+ */
+class ChRISContextSpecError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ChRISContextSpecError";
+    }
+}
+exports.ChRISContextSpecError = ChRISContextSpecError;
+/**
+ * Splits a context string into its type and value components on the first occurrence of a delimiter.
+ *
+ * This function parses strings like "folder:/path/to/folder" or "plugin:123" into an object
+ * containing the type (the prefix before the first delimiter) and the value (the rest of the string).
+ * If the path contains extra delimiters (e.g. "/pacs/queries/2601_AccessionNumber:22548684"), this
+ * function correctly preserves those extra delimiters in the value component.
+ *
+ * @param context - The context string to be split. Must be a string.
+ * @param delimiter - The delimiter character to split on. Defaults to ":".
+ * @returns An object conforming to ContextSpec with the split components.
+ * @throws ChRISContextSpecError If the input is not a string or the delimiter is not found.
+ */
+function context_split(context, delimiter = ":") {
+    if (typeof context !== "string") {
+        throw new ChRISContextSpecError(`Invalid input: Expected a string, but received ${typeof context}`);
+    }
+    const delimiterIndex = context.indexOf(delimiter);
+    if (delimiterIndex === -1) {
+        throw new ChRISContextSpecError(`Invalid input string format: Expected a ${delimiter}-separated string, but got: ${context}`);
+    }
+    const type = context.slice(0, delimiterIndex);
+    const value = context.slice(delimiterIndex + delimiter.length);
+    return { type, value };
+}
+/**
+ * Group of ChRIS resources embedded within a specific context.
+ */
+class ChRISEmbeddedResourceGroup extends chrisResourceGroup_js_1.ChRISResourceGroup {
+    constructor(params) {
+        super(params.resourceName, params.getMethod, params.chrisContext);
+        this.context = params.context;
+        this.chrisContextObj = params.chrisContext;
+    }
+    static async create(resourceName, getMethod, context) {
+        let params;
+        try {
+            const chrisContextObj = await this.context_init(context);
+            if (!chrisContextObj) {
+                errorStack_js_1.errorStack.stack_push("warning", `could not initialize context ${context} for ${resourceName}`);
+                return null;
+            }
+            const params = {
+                resourceName,
+                getMethod,
+                chrisContext: chrisContextObj,
+                context,
+            };
+            return new ChRISEmbeddedResourceGroup(params);
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            //console.error(`DEBUG: create failed for ${resourceName}:`, errorMessage); // Added
+            errorStack_js_1.errorStack.stack_push("error", `Error: ${context} seems invalid for resource ${resourceName}.`);
+            return null;
+        }
+    }
+    static async context_init(context) {
+        const client = await chrisConnection_js_1.chrisConnection.client_get();
+        if (!client) {
+            throw new ChRISConnectionError("ChRIS client is not initialized");
+        }
+        let contextSpec;
+        try {
+            contextSpec = context_split(context);
+        }
+        catch (error) {
+            if (error instanceof ChRISContextSpecError) {
+                console.error(error.message);
+            }
+            throw error;
+        }
+        let chrisContextObj = null;
+        try {
+            switch (contextSpec.type) {
+                case "folder":
+                    chrisContextObj = (await client.getFileBrowserFolderByPath(contextSpec.value));
+                    break;
+                case "plugin":
+                    chrisContextObj = (await client.getPlugin(Number(contextSpec.value)));
+                    break;
+                case "feed":
+                    chrisContextObj = (await client.getFeed(Number(contextSpec.value)));
+                    break;
+                default:
+                    throw new ChRISInitializationError(`Unknown context type: ${contextSpec.type}`);
+            }
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            // console.error("DEBUG: initializeContext failed:", errorMessage); // Added for debugging
+            errorStack_js_1.errorStack.stack_push("error", `Failed to get contextObject of type ${contextSpec.type} for value ${contextSpec.value}: ${errorMessage}`);
+            return null;
+        }
+        if (!chrisContextObj) {
+            errorStack_js_1.errorStack.stack_push("warning", `could not initialize contextObject of type ${contextSpec.type} for value ${contextSpec.value}`);
+            return null;
+        }
+        return chrisContextObj;
+    }
+}
+exports.ChRISEmbeddedResourceGroup = ChRISEmbeddedResourceGroup;
+//# sourceMappingURL=chrisEmbeddedResourceGroup.js.map

package/dist/resources/chrisEmbeddedResourceGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisEmbeddedResourceGroup.js","sourceRoot":"","sources":["../../src/resources/chrisEmbeddedResourceGroup.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAgEH,sCAkBC;AAhFD,8EAAwE;AACxE,sEAAgE;AAChE,0DAAoD;AAGpD;;GAEG;AACH,MAAa,oBAAqB,SAAQ,KAAK;IAC7C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,sBAAsB,CAAC;IACrC,CAAC;CACF;AALD,oDAKC;AAED;;GAEG;AACH,MAAa,wBAAyB,SAAQ,KAAK;IACjD,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,0BAA0B,CAAC;IACzC,CAAC;CACF;AALD,4DAKC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;IACtC,CAAC;CACF;AALD,sDAKC;AAgBD;;;;;;;;;;;;GAYG;AACH,SAAgB,aAAa,CAAC,OAAgB,EAAE,YAAoB,GAAG;IACrE,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;QAChC,MAAM,IAAI,qBAAqB,CAC7B,kDAAkD,OAAO,OAAO,EAAE,CACnE,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAW,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IAC1D,IAAI,cAAc,KAAK,CAAC,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,qBAAqB,CAC7B,2CAA2C,SAAS,+BAA+B,OAAO,EAAE,CAC7F,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAW,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC;IACtD,MAAM,KAAK,GAAW,OAAO,CAAC,KAAK,CAAC,cAAc,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAEvE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACzB,CAAC;AAYD;;GAEG;AACH,MAAa,0BAAwC,SAAQ,0CAAkB;IAI7E,YAAoB,MAA2C;QAC7D,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,YAAY,CAAC,CAAC;QAClE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,eAAe,GAAG,MAAM,CAAC,YAAY,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,MAAM,CACxB,YAAoB,EACpB,SAAiB,EACjB,OAAe;QAEf,IAAI,MAA2C,CAAC;QAChD,IAAI,CAAC;YACH,MAAM,eAAe,GAAa,MAAM,IAAI,CAAC,YAAY,CACvD,OAAO,CACR,CAAC;YACF,IAAI,CAAC,eAAe,EAAE,CAAC;gBACrB,0BAAU,CAAC,UAAU,CACnB,SAAS,EACT,gCAAgC,OAAO,QAAQ,YAAY,EAAE,CAC9D,CAAC;gBACF,OAAO,IAAI,CAAC;YACd,CAAC;YACD,MAAM,MAAM,GAAwC;gBAClD,YAAY;gBACZ,SAAS;gBACT,YAAY,EAAE,eAAe;gBAC7B,OAAO;aACR,CAAC;YACF,OAAO,IAAI,0BAA0B,CAAI,MAAM,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,YAAY,GAAW,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACpF,oFAAoF;YACpF,0BAAU,CAAC,UAAU,CACnB,OAAO,EACP,UAAU,OAAO,+BAA+B,YAAY,GAAG,CAChE,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,YAAY,CAAc,OAAe;QAC5D,MAAM,MAAM,GAAkB,MAAM,oCAAe,CAAC,UAAU,EAAE,CAAC;QACjE,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,oBAAoB,CAAC,iCAAiC,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,WAAwB,CAAC;QAC7B,IAAI,CAAC;YACH,WAAW,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;QACvC,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,KAAK,YAAY,qBAAqB,EAAE,CAAC;gBAC3C,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YAC/B,CAAC;YACD,MAAM,KAAK,CAAC;QACd,CAAC;QAED,IAAI,eAAe,GAAa,IAAI,CAAC;QACrC,IAAI,CAAC;YACH,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;gBACzB,KAAK,QAAQ;oBACX,eAAe,GAAG,CAAC,MAAM,MAAM,CAAC,0BAA0B,CACxD,WAAW,CAAC,KAAK,CAClB,CAAM,CAAC;oBACR,MAAM;gBACR,KAAK,QAAQ;oBACX,eAAe,GAAG,CAAC,MAAM,MAAM,CAAC,SAAS,CACvC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAC1B,CAAM,CAAC;oBACR,MAAM;gBACR,KAAK,MAAM;oBACT,eAAe,GAAG,CAAC,MAAM,MAAM,CAAC,OAAO,CACrC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAC1B,CAAM,CAAC;oBACR,MAAM;gBACR;oBACE,MAAM,IAAI,wBAAwB,CAChC,yBAAyB,WAAW,CAAC,IAAI,EAAE,CAC5C,CAAC;YACN,CAAC;QACH,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,0FAA0F;YAC1F,0BAAU,CAAC,UAAU,CACnB,OAAO,EACP,uCAAuC,WAAW,CAAC,IAAI,cAAc,WAAW,CAAC,KAAK,KAAK,YAAY,EAAE,CAC1G,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,0BAAU,CAAC,UAAU,CACnB,SAAS,EACT,8CAA8C,WAAW,CAAC,IAAI,cAAc,WAAW,CAAC,KAAK,EAAE,CAChG,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;CACF;AAzGD,gEAyGC"}

package/dist/resources/chrisObjContext.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @file Factory for creating context-bound ChRIS embedded resource groups.
+ *
+ * @module
+ */
+import { ChRISEmbeddedResourceGroup } from "./chrisEmbeddedResourceGroup.js";
+type ChRISResourceType = unknown;
+/**
+ * Create a ChRIS Embedded Resource Group for a given context.
+ *
+ * @param type - The type of context object to create (e.g., "ComputesOfPlugin").
+ * @param context - The context string (e.g., "plugin:123").
+ * @returns A promise resolving to the created resource group, or null on failure.
+ */
+export declare function objContext_create(type: string, context: string): Promise<ChRISEmbeddedResourceGroup<ChRISResourceType> | null>;
+export {};

package/dist/resources/chrisObjContext.js

@@ -0,0 +1,109 @@
+"use strict";
+/**
+ * @file Factory for creating context-bound ChRIS embedded resource groups.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objContext_create = objContext_create;
+const chrisEmbeddedResourceGroup_js_1 = require("./chrisEmbeddedResourceGroup.js");
+const errorStack_js_1 = require("../error/errorStack.js");
+class ObjContextCreationError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ObjContextCreationError";
+    }
+}
+class ChRISObjContextFactory {
+    constructor(config) {
+        this.cache = new Map();
+        this.config = config;
+    }
+    async create(context) {
+        const cacheKey = `${this.config.name}:${context}`;
+        if (this.cache.has(cacheKey)) {
+            return this.cache.get(cacheKey);
+        }
+        try {
+            const objContext = await chrisEmbeddedResourceGroup_js_1.ChRISEmbeddedResourceGroup.create(this.config.name, this.config.getMethod, context);
+            if (!objContext) {
+                return null;
+            }
+            this.cache.set(cacheKey, objContext);
+            return objContext;
+        }
+        catch (error) {
+            const errorMessage = error instanceof Error ? error.message : String(error);
+            errorStack_js_1.errorStack.stack_push("error", `Failed to create ${this.config.name}: ${errorMessage}`);
+            console.log(`name = ${this.config.name} context = ${context}`);
+            throw new ObjContextCreationError(`Failed to create ${this.config.name}: ${errorMessage}`);
+            return null;
+        }
+    }
+}
+const ObjContexts = {
+    ComputesOfPlugin: {
+        name: "ComputesOfPlugin",
+        getMethod: "getPluginComputeResources",
+        contextType: "plugin",
+    },
+    InstancesOfPlugin: {
+        name: "InstancesOfPlugin",
+        getMethod: "getPluginInstances",
+        contextType: "plugin",
+    },
+    ParametersOfPlugin: {
+        name: "ParametersOfPlugin",
+        getMethod: "getPluginParameters",
+        contextType: "plugin",
+    },
+    ChRISFilesContext: {
+        name: "Files",
+        getMethod: "getFiles",
+        contextType: "folder",
+    },
+    ChRISLinksContext: {
+        name: "Links",
+        getMethod: "getLinkFiles",
+        contextType: "folder",
+    },
+    ChRISDirsContext: {
+        name: "Directories",
+        getMethod: "getChildren",
+        contextType: "folder",
+    },
+    ChRISFeedGroup: {
+        name: "Feed",
+        getMethod: "getFeeds",
+        contextType: "feed",
+    },
+};
+const objContextFactories = {};
+for (const [key, config] of Object.entries(ObjContexts)) {
+    objContextFactories[key] = new ChRISObjContextFactory(config);
+}
+/**
+ * Create a ChRIS Embedded Resource Group for a given context.
+ *
+ * @param type - The type of context object to create (e.g., "ComputesOfPlugin").
+ * @param context - The context string (e.g., "plugin:123").
+ * @returns A promise resolving to the created resource group, or null on failure.
+ */
+async function objContext_create(type, context) {
+    const factory = objContextFactories[type];
+    if (!factory) {
+        console.error(`Unknown object context type: ${type}`);
+        throw new ObjContextCreationError(`Unknown object context type: ${type}`);
+    }
+    try {
+        return factory.create(context);
+    }
+    catch (error) {
+        throw error;
+        return null;
+    }
+}
+// Usage examples:
+// const pluginComputeResources: ChRISEmbeddedResourceGroup<Plugin> = await objContext_create('PluginComputeResources', 'plugin:123') as ChRISEmbeddedResourceGroup<Plugin>;
+// const filesContext: ChRISEmbeddedResourceGroup<FileBrowserFolder> = await objContext_create('ChRISFilesContext', 'folder:/path/to/folder') as ChRISEmbeddedResourceGroup<FileBrowserFolder>;
+//# sourceMappingURL=chrisObjContext.js.map

package/dist/resources/chrisObjContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisObjContext.js","sourceRoot":"","sources":["../../src/resources/chrisObjContext.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;AAqHH,8CAeC;AAlID,mFAA6E;AAC7E,0DAAoD;AAUpD,MAAM,uBAAwB,SAAQ,KAAK;IACzC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AAED,MAAM,sBAAsB;IAK1B,YAAY,MAAwB;QAH5B,UAAK,GACX,IAAI,GAAG,EAAE,CAAC;QAGV,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,MAAM,CACV,OAAe;QAEf,MAAM,QAAQ,GAAW,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,OAAO,EAAE,CAAC;QAE1D,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;QACnC,CAAC;QAED,IAAI,CAAC;YACH,MAAM,UAAU,GACd,MAAM,0DAA0B,CAAC,MAAM,CACrC,IAAI,CAAC,MAAM,CAAC,IAAI,EAChB,IAAI,CAAC,MAAM,CAAC,SAAS,EACrB,OAAO,CACR,CAAC;YACJ,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,OAAO,IAAI,CAAC;YACd,CAAC;YACD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YACrC,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,MAAM,YAAY,GAChB,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACzD,0BAAU,CAAC,UAAU,CACnB,OAAO,EACP,oBAAoB,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CACxD,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,MAAM,CAAC,IAAI,cAAc,OAAO,EAAE,CAAC,CAAC;YAC/D,MAAM,IAAI,uBAAuB,CAC/B,oBAAoB,IAAI,CAAC,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE,CACxD,CAAC;YACF,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAED,MAAM,WAAW,GAAwC;IACvD,gBAAgB,EAAE;QAChB,IAAI,EAAE,kBAAkB;QACxB,SAAS,EAAE,2BAA2B;QACtC,WAAW,EAAE,QAAQ;KACtB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,mBAAmB;QACzB,SAAS,EAAE,oBAAoB;QAC/B,WAAW,EAAE,QAAQ;KACtB;IACD,kBAAkB,EAAE;QAClB,IAAI,EAAE,oBAAoB;QAC1B,SAAS,EAAE,qBAAqB;QAChC,WAAW,EAAE,QAAQ;KACtB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,UAAU;QACrB,WAAW,EAAE,QAAQ;KACtB;IACD,iBAAiB,EAAE;QACjB,IAAI,EAAE,OAAO;QACb,SAAS,EAAE,cAAc;QACzB,WAAW,EAAE,QAAQ;KACtB;IACD,gBAAgB,EAAE;QAChB,IAAI,EAAE,aAAa;QACnB,SAAS,EAAE,aAAa;QACxB,WAAW,EAAE,QAAQ;KACtB;IACD,cAAc,EAAE;QACd,IAAI,EAAE,MAAM;QACZ,SAAS,EAAE,UAAU;QACrB,WAAW,EAAE,MAAM;KACpB;CACF,CAAC;AAEF,MAAM,mBAAmB,GAA8C,EAAE,CAAC;AAE1E,KAAK,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;IACxD,mBAAmB,CAAC,GAAG,CAAC,GAAG,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAC;AAChE,CAAC;AAED;;;;;;GAMG;AACI,KAAK,UAAU,iBAAiB,CACrC,IAAY,EACZ,OAAe;IAEf,MAAM,OAAO,GAAuC,mBAAmB,CAAC,IAAI,CAAC,CAAC;IAC9E,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,IAAI,uBAAuB,CAAC,gCAAgC,IAAI,EAAE,CAAC,CAAC;IAC5E,CAAC;IACD,IAAI,CAAC;QACH,OAAO,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAAC,OAAO,KAAc,EAAE,CAAC;QACxB,MAAM,KAAK,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED,kBAAkB;AAClB,4KAA4K;AAC5K,+LAA+L"}

package/dist/resources/chrisResourceGroup.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @file ChRIS Resource Group
+ *
+ * This module defines the base class for grouping ChRIS resources.
+ * It handles the initialization and binding of resource fetching methods,
+ * supporting both immediate and lazy binding strategies.
+ *
+ * @module
+ */
+import Client from "@fnndsc/chrisapi";
+import { ChRISResource } from "../resources/chrisResources.js";
+/**
+ * Abstract base class for a group of ChRIS resources.
+ */
+export declare abstract class ChRISResourceGroup {
+    protected _asset: ChRISResource;
+    /**
+     * Constructor for ChRISResourceGroup.
+     * @param resourceName - The name of the resource.
+     * @param getMethod - The method name on the client/object to fetch resources.
+     * @param chrisObj - Optional object to bind the method to. If not provided, uses the global ChRIS client lazily.
+     */
+    constructor(resourceName: string, getMethod: string, chrisObj?: unknown);
+    /**
+     * Retrieves the ChRIS client instance asynchronously.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    client_get(): Promise<Client | null>;
+    get asset(): ChRISResource;
+}

package/dist/resources/chrisResourceGroup.js

@@ -0,0 +1,47 @@
+"use strict";
+/**
+ * @file ChRIS Resource Group
+ *
+ * This module defines the base class for grouping ChRIS resources.
+ * It handles the initialization and binding of resource fetching methods,
+ * supporting both immediate and lazy binding strategies.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChRISResourceGroup = void 0;
+const chrisConnection_js_1 = require("../connect/chrisConnection.js");
+const chrisResources_js_1 = require("../resources/chrisResources.js");
+/**
+ * Abstract base class for a group of ChRIS resources.
+ */
+class ChRISResourceGroup {
+    /**
+     * Constructor for ChRISResourceGroup.
+     * @param resourceName - The name of the resource.
+     * @param getMethod - The method name on the client/object to fetch resources.
+     * @param chrisObj - Optional object to bind the method to. If not provided, uses the global ChRIS client lazily.
+     */
+    constructor(resourceName, getMethod, chrisObj) {
+        this._asset = new chrisResources_js_1.ChRISResource();
+        this._asset.resourceName = resourceName;
+        if (chrisObj) {
+            this._asset.binding_applyGet(chrisObj, chrisObj[getMethod]);
+        }
+        else {
+            this._asset.binding_applyLazy(() => chrisConnection_js_1.chrisConnection.client_get(), getMethod);
+        }
+    }
+    /**
+     * Retrieves the ChRIS client instance asynchronously.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    async client_get() {
+        return chrisConnection_js_1.chrisConnection.client_get();
+    }
+    get asset() {
+        return this._asset;
+    }
+}
+exports.ChRISResourceGroup = ChRISResourceGroup;
+//# sourceMappingURL=chrisResourceGroup.js.map

package/dist/resources/chrisResourceGroup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisResourceGroup.js","sourceRoot":"","sources":["../../src/resources/chrisResourceGroup.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAGH,sEAAgE;AAChE,sEAA4E;AAE5E;;GAEG;AACH,MAAsB,kBAAkB;IAGtC;;;;;OAKG;IACH,YAAY,YAAoB,EAAE,SAAiB,EAAE,QAAkB;QACrE,IAAI,CAAC,MAAM,GAAG,IAAI,iCAAa,EAAE,CAAC;QAClC,IAAI,CAAC,MAAM,CAAC,YAAY,GAAG,YAAY,CAAC;QAExC,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAC1B,QAAQ,EACP,QAAsF,CAAC,SAAS,CAAC,CACnG,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAC3B,GAAG,EAAE,CAAC,oCAAe,CAAC,UAAU,EAAE,EAClC,SAAS,CACV,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,OAAO,oCAAe,CAAC,UAAU,EAAE,CAAC;IACtC,CAAC;IAED,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;CACF;AArCD,gDAqCC"}

package/dist/resources/chrisResources.d.ts

@@ -0,0 +1,163 @@
+/**
+ * @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
+ */
+import Client from "@fnndsc/chrisapi";
+import { ListResource, Resource, ItemResource } from "@fnndsc/chrisapi";
+/**
+ * A simple record with string keys and unknown values.
+ */
+export interface SimpleRecord {
+    [key: string]: unknown;
+}
+/**
+ * Options for listing resources, including pagination.
+ */
+export interface ListOptions extends SimpleRecord {
+    limit?: number;
+    offset?: number;
+}
+/**
+ * Represents an item in a resource collection.
+ */
+export interface Item {
+    data: Array<{
+        name: string;
+        value: unknown;
+    }>;
+    href: string;
+    links: Array<unknown>;
+}
+interface ResourcesFromOptions {
+    resources: ListResource | Resource | null;
+    options?: ListOptions | null;
+}
+/**
+ * Contains items and the fields available for them.
+ */
+export interface ResourceFieldsPerItem {
+    items: Item[];
+    fields: string[];
+}
+/**
+ * Contains resources, items, options, and selected fields.
+ */
+export interface ResourcesByFields extends ResourcesFromOptions {
+    items: Item[] | null;
+    fields: string[];
+}
+/**
+ * Contains data filtered for table display and selected fields.
+ */
+export interface FilteredResourceData {
+    tableData: Record<string, unknown>[];
+    selectedFields: string[];
+    /** Total count of items in the full collection (may exceed tableData.length when paginated). */
+    totalCount?: number;
+}
+/**
+ * A dictionary with string keys and primitive values.
+ */
+export interface Dictionary {
+    [key: string]: string | number | boolean;
+}
+/**
+ * Base class for managing ChRIS resources.
+ */
+export declare class ChRISResource {
+    private _client;
+    private _resourceName;
+    private _resourceCollection;
+    private _resourceArrayItems;
+    private _resourceArray;
+    private _resourceItem;
+    private resourceMethod;
+    private _lazyMethodName;
+    private _lazyObjProvider;
+    constructor();
+    /**
+     * Retrieves the ChRIS client instance asynchronously.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    client_get(): Promise<Client | null>;
+    get resourceName(): string;
+    set resourceName(name: string);
+    set resourceCollection(collection: ListResource | Resource);
+    /**
+     * Converts a resource item to a dictionary.
+     * @param item - The item to convert.
+     * @returns A dictionary representation of the item.
+     */
+    resourceItem_toDict(item: Item): Dictionary;
+    /**
+     * Converts a list of resource items to dictionaries.
+     * @param items - The list of items to convert.
+     * @returns An array of dictionaries.
+     */
+    resourceItems_toDicts(items: Item[]): Dictionary[];
+    /**
+     * 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.
+     */
+    resourceItem_delete(id: number): Promise<boolean>;
+    /**
+     * Builds a list of items from a resource collection.
+     * @param resources - The resource collection.
+     * @returns An array of Items or null.
+     */
+    resourceItems_buildFromCollection(resources: ListResource | Resource | null): Item[] | null;
+    /**
+     * 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: unknown, resourceMethod: (params: ListOptions) => Promise<ListResource | Resource>, resourceName?: string): void;
+    /**
+     * 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: () => Promise<unknown>, methodName: string, resourceName?: string): void;
+    private lazyBinding_resolve;
+    get hasNextPage(): boolean;
+    /**
+     * 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.
+     */
+    resources_getAll(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+    /**
+     * Lists and filters resources based on options.
+     * @param options - Filtering and listing options.
+     * @returns A Promise resolving to filtered resource data or null.
+     */
+    resources_listAndFilterByOptions(options?: Partial<ListOptions>): Promise<FilteredResourceData | null>;
+    /**
+     * Filters resources by specific fields.
+     * @param resourcesByFields - The resources and fields to filter.
+     * @returns Filtered data suitable for table display.
+     */
+    resources_filterByFields(resourcesByFields: ResourcesByFields | null): FilteredResourceData | null;
+    resourcesByFields_enumerate(items: Item[] | null): ResourceFieldsPerItem | null;
+    fieldSpec_resolve(fieldFilter?: string, options?: ListOptions | null): string[];
+    resourceFields_get(options?: ListOptions | null, fields?: string): Promise<ResourcesByFields | null>;
+    resources_getItems(options?: Partial<ListOptions>): Promise<ItemResource[] | null>;
+    options_simplify(options: ListOptions): ListOptions;
+    private filtering_applyAdditional;
+    resources_getList(options?: Partial<ListOptions>, resourceMethod?: (params: ListOptions) => Promise<ListResource | Resource>): Promise<ListOptions | null>;
+}
+/**
+ * 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.
+ */
+export declare function resourceFields_get(obj: Resource | ListResource, fields: string[]): SimpleRecord | null;
+export {};