@fnndsc/cumin 3.2.4

package/dist/connect/chrisConnection.d.ts

@@ -0,0 +1,121 @@
+/**
+ * @file ChRIS Connection Management
+ *
+ * This module provides the `ChRISConnection` class, responsible for managing
+ * the connection to a ChRIS CUBE, including authentication, token handling,
+ * and context setting. It abstracts away the underlying storage mechanisms
+ * for configuration and tokens using `IStorageProvider`.
+ *
+ * @module
+ */
+import Client from "@fnndsc/chrisapi";
+import { ConnectionConfig } from "../config/config.js";
+import { IStorageProvider } from "../io/io.js";
+/**
+ * Re-exports the ChRIS API client for convenience.
+ */
+export { Client };
+/**
+ * Interface defining options for establishing a ChRIS connection.
+ */
+interface ConnectOptions {
+    user: string;
+    password: string;
+    debug: boolean;
+    url: string;
+}
+/**
+ * Manages the connection and authentication with a ChRIS CUBE.
+ */
+export declare class ChRISConnection {
+    private authToken;
+    private tokenFile;
+    private user;
+    private chrisURL;
+    private client;
+    private _config?;
+    private storageProvider?;
+    /**
+     * Constructs a new ChRISConnection instance.
+     * @param config - The connection configuration object.
+     * @param storageProvider - The storage provider for persistence.
+     */
+    constructor(config?: ConnectionConfig, storageProvider?: IStorageProvider);
+    /**
+     * Access the connection configuration.
+     */
+    get config(): ConnectionConfig | undefined;
+    /**
+     * Initializes the connection with configuration and storage provider.
+     * @param config - The connection configuration object.
+     * @param storageProvider - The storage provider for persistence.
+     */
+    init(config: ConnectionConfig, storageProvider: IStorageProvider): void;
+    /**
+     * Establishes a connection to the ChRIS CUBE and authenticates the user.
+     * @param options - Connection options including user, password, debug flag, and URL.
+     * @returns A Promise resolving to the authentication token on success, or null on failure.
+     */
+    connection_connect(options: ConnectOptions): Promise<string | null>;
+    /**
+     * Sets the ChRIS context based on a context string (e.g., user@url?folder=...).
+     * @param context - The context string.
+     * @returns A Promise resolving to true on success, false otherwise.
+     */
+    context_set(context: string): Promise<boolean>;
+    /**
+     * Retrieves the authentication token.
+     * @param forceLoad - If true, forces loading the token from storage.
+     * @returns A Promise resolving to the authentication token or null.
+     */
+    authToken_get(forceLoad?: boolean): Promise<string | null>;
+    /**
+     * Retrieves the current authenticated user's username.
+     * @returns A Promise resolving to the username string or null if not authenticated.
+     */
+    user_get(): Promise<string | null>;
+    /**
+     * Retrieves the ChRIS CUBE URL.
+     * @returns A Promise resolving to the ChRIS URL or null.
+     */
+    chrisURL_get(): Promise<string | null>;
+    /**
+     * Refreshes the ChRIS API client with current token and URL.
+     * @returns A Promise resolving to the refreshed Client instance or null.
+     */
+    client_refresh(): Promise<Client | null>;
+    /**
+     * Retrieves the ChRIS API client instance.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    client_get(): Promise<Client | null>;
+    /**
+     * Checks if the client is currently connected.
+     * @returns True if connected, false otherwise.
+     */
+    connection_isConnected(): boolean;
+    /**
+     * Logs out the user by clearing the authentication token from storage.
+     */
+    connection_logout(): Promise<void>;
+    /**
+     * Saves data to a specified file using the storage provider.
+     * @param file - The path to the file.
+     * @param info - The string data to save.
+     */
+    private token_saveToFile;
+    /**
+     * Loads the authentication token from storage.
+     * @returns A Promise that resolves when the token is loaded.
+     */
+    private token_load;
+}
+/**
+ * Global instance of ChRISConnection, initialized as a constant singleton.
+ */
+export declare let chrisConnection: ChRISConnection;
+/**
+ * Initializes the global ChRISConnection instance.
+ * @param storageProvider - The storage provider to use for the connection.
+ */
+export declare function chrisConnection_init(storageProvider: IStorageProvider): Promise<ChRISConnection>;

package/dist/connect/chrisConnection.js

@@ -0,0 +1,303 @@
+"use strict";
+/**
+ * @file ChRIS Connection Management
+ *
+ * This module provides the `ChRISConnection` class, responsible for managing
+ * the connection to a ChRIS CUBE, including authentication, token handling,
+ * and context setting. It abstracts away the underlying storage mechanisms
+ * for configuration and tokens using `IStorageProvider`.
+ *
+ * @module
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chrisConnection = exports.ChRISConnection = exports.Client = void 0;
+exports.chrisConnection_init = chrisConnection_init;
+const chrisapi_1 = __importDefault(require("@fnndsc/chrisapi"));
+exports.Client = chrisapi_1.default;
+const config_js_1 = require("../config/config.js");
+const chrisContext_js_1 = require("../context/chrisContext.js");
+const chrisIO_js_1 = require("../io/chrisIO.js");
+const errorStack_js_1 = require("../error/errorStack.js");
+const chalk_1 = __importDefault(require("chalk"));
+/**
+ * Helper function to validate and format a context string.
+ * @param context - The context string to check.
+ * @returns The formatted context string.
+ */
+function contextString_check(context) {
+    if (context.includes("://")) {
+        return context;
+    }
+    if (context.startsWith("?")) {
+        return context;
+    }
+    return "?" + context;
+}
+/**
+ * Manages the connection and authentication with a ChRIS CUBE.
+ */
+class ChRISConnection {
+    /**
+     * Constructs a new ChRISConnection instance.
+     * @param config - The connection configuration object.
+     * @param storageProvider - The storage provider for persistence.
+     */
+    constructor(config, storageProvider) {
+        this.authToken = null;
+        this.user = null;
+        this.chrisURL = null;
+        this.client = null;
+        if (config && storageProvider) {
+            this.init(config, storageProvider);
+        }
+        // Ensure that config and storageProvider are not undefined if no args were passed.
+        // This allows the initial `new ChRISConnection()` to create a valid, though uninitialized, object.
+        this._config = config;
+        this.storageProvider = storageProvider;
+    }
+    /**
+     * Access the connection configuration.
+     */
+    get config() {
+        return this._config;
+    }
+    /**
+     * Initializes the connection with configuration and storage provider.
+     * @param config - The connection configuration object.
+     * @param storageProvider - The storage provider for persistence.
+     */
+    init(config, storageProvider) {
+        this._config = config;
+        this.storageProvider = storageProvider;
+        this.tokenFile = this._config.tokenFilepath;
+    }
+    /**
+     * Establishes a connection to the ChRIS CUBE and authenticates the user.
+     * @param options - Connection options including user, password, debug flag, and URL.
+     * @returns A Promise resolving to the authentication token on success, or null on failure.
+     */
+    async connection_connect(options) {
+        const { user, password, debug, url } = options;
+        // Ensure configuration is initialized before use
+        if (this.storageProvider) {
+            await (0, config_js_1.config_init)(this.storageProvider);
+            this._config = config_js_1.connectionConfig;
+        }
+        const authUrl = url + "auth-token/";
+        this.user = user;
+        this.chrisURL = url;
+        console.log(`Connecting to ${url} with user ${user}`);
+        await this._config.context_set(user, url);
+        this.tokenFile = this._config.tokenFilepath;
+        try {
+            this.authToken = await chrisapi_1.default.getAuthToken(authUrl, user, password);
+            if (this.authToken) {
+                // console.log("Auth token: " + this.authToken);
+                await this.token_saveToFile(this.tokenFile, this.authToken);
+                console.log("Auth token saved successfully");
+                console.log("ChRIS URL saved successfully");
+                return this.authToken;
+            }
+            else {
+                console.log("Failed to receive auth token");
+                return null;
+            }
+        }
+        catch (error) {
+            console.error("\nSome error seems to have been thrown while attempting to log in.");
+            console.error("If the ChRIS CUBE is reachable, then it's quite possible this means");
+            console.error("an incorrect login. Please check your login credentials carefully.");
+            console.error("Also, if your password has 'special' character, make sure how you");
+            console.error("are specifying it is compatible with your shell!");
+            console.error("\nExiting to system with code 1...");
+            if (debug) {
+                throw error;
+            }
+            process.exit(1);
+        }
+    }
+    /**
+     * Sets the ChRIS context based on a context string (e.g., user@url?folder=...).
+     * @param context - The context string.
+     * @returns A Promise resolving to true on success, false otherwise.
+     */
+    async context_set(context) {
+        context = contextString_check(context);
+        const parsedContext = await (0, chrisContext_js_1.chrisContextURL_parse)(context);
+        if (errorStack_js_1.errorStack.messagesOfType_has('error')) {
+            const error = errorStack_js_1.errorStack.stack_pop();
+            console.error(chalk_1.default.red('Context error:', error?.message));
+            // Clear any remaining errors to prevent them from affecting subsequent operations
+            errorStack_js_1.errorStack.type_clear('error');
+            return false;
+        }
+        let status = true;
+        let needsRefresh = false;
+        if (parsedContext.user) {
+            status =
+                status &&
+                    (await chrisContext_js_1.chrisContext.current_set(chrisContext_js_1.Context.ChRISuser, parsedContext.user)); // Await this call
+            this.user = parsedContext.user;
+            needsRefresh = true;
+            await this._config.context_set(parsedContext.user, parsedContext.URL || '');
+        }
+        if (parsedContext.URL) {
+            status =
+                status && (await chrisContext_js_1.chrisContext.current_set(chrisContext_js_1.Context.ChRISURL, parsedContext.URL)); // Await this call
+            this.chrisURL = parsedContext.URL;
+            needsRefresh = true;
+            await this._config.context_set(this.user || "", parsedContext.URL);
+        }
+        if (parsedContext.folder) {
+            status =
+                status &&
+                    (await chrisContext_js_1.chrisContext.current_set(chrisContext_js_1.Context.ChRISfolder, parsedContext.folder)); // Await this call
+        }
+        if (parsedContext.feed) {
+            status =
+                status &&
+                    (await chrisContext_js_1.chrisContext.current_set(chrisContext_js_1.Context.ChRISfeed, parsedContext.feed)); // Await this call
+        }
+        if (parsedContext.plugin) {
+            status =
+                status &&
+                    (await chrisContext_js_1.chrisContext.current_set(chrisContext_js_1.Context.ChRISplugin, parsedContext.plugin)); // Await this call
+        }
+        // Refresh the client with the new context
+        if (needsRefresh) {
+            await this.client_refresh();
+        }
+        return status;
+    }
+    /**
+     * Retrieves the authentication token.
+     * @param forceLoad - If true, forces loading the token from storage.
+     * @returns A Promise resolving to the authentication token or null.
+     */
+    async authToken_get(forceLoad) {
+        if (!this.authToken || forceLoad) {
+            await this.token_load();
+        }
+        return this.authToken;
+    }
+    /**
+     * Retrieves the current authenticated user's username.
+     * @returns A Promise resolving to the username string or null if not authenticated.
+     */
+    async user_get() {
+        // Ensure token is loaded if not already present, as user is set during connection.
+        if (!this.user && this.authToken) {
+            // Re-load config if necessary, or simply return stored user.
+            // For now, assume this.user is reliably set during connection_connect
+            // or if auth token is loaded from storage (which would imply context reload).
+            // A more robust implementation might re-derive user from token or context.
+        }
+        return this.user;
+    }
+    /**
+     * Retrieves the ChRIS CUBE URL.
+     * @returns A Promise resolving to the ChRIS URL or null.
+     */
+    async chrisURL_get() {
+        if (!this.chrisURL) {
+            if (!this._config) {
+                return null; // config not initialized
+            }
+            this.chrisURL = await this._config.chrisURL_load();
+        }
+        return this.chrisURL;
+    }
+    /**
+     * Refreshes the ChRIS API client with current token and URL.
+     * @returns A Promise resolving to the refreshed Client instance or null.
+     */
+    async client_refresh() {
+        this.tokenFile = this._config.tokenFilepath;
+        this.chrisURL = await this.chrisURL_get();
+        this.authToken = await this.authToken_get(true); // Pass true directly
+        if (this.chrisURL && this.authToken) {
+            this.client = new chrisapi_1.default(this.chrisURL, { token: this.authToken });
+        }
+        return this.client;
+    }
+    /**
+     * Retrieves the ChRIS API client instance.
+     * @returns A Promise resolving to the Client instance or null.
+     */
+    async client_get() {
+        if ((await this.authToken_get()) &&
+            (await this.chrisURL_get()) &&
+            this.chrisURL &&
+            this.authToken) {
+            if (!this.client) {
+                this.client = new chrisapi_1.default(this.chrisURL, { token: this.authToken });
+            }
+        }
+        return this.client;
+    }
+    /**
+     * Checks if the client is currently connected.
+     * @returns True if connected, false otherwise.
+     */
+    connection_isConnected() {
+        return this.authToken !== null;
+    }
+    /**
+     * Logs out the user by clearing the authentication token from storage.
+     */
+    async connection_logout() {
+        this.authToken = null;
+        try {
+            await this.storageProvider.remove(this.tokenFile);
+            console.log("Logged out successfully");
+        }
+        catch (error) {
+            console.error("Error during logout:", error);
+        }
+    }
+    /**
+     * Saves data to a specified file using the storage provider.
+     * @param file - The path to the file.
+     * @param info - The string data to save.
+     */
+    async token_saveToFile(file, info) {
+        try {
+            await this.storageProvider.write(file, info || "");
+        }
+        catch (error) {
+            console.error("For info: ", info);
+            console.error("Error saving to file ", file, ": ", error);
+        }
+    }
+    /**
+     * Loads the authentication token from storage.
+     * @returns A Promise that resolves when the token is loaded.
+     */
+    async token_load() {
+        try {
+            this.authToken = await this.storageProvider.read(this.tokenFile);
+        }
+        catch (error) {
+            this.authToken = null;
+        }
+    }
+}
+exports.ChRISConnection = ChRISConnection;
+/**
+ * Global instance of ChRISConnection, initialized as a constant singleton.
+ */
+exports.chrisConnection = new ChRISConnection();
+/**
+ * Initializes the global ChRISConnection instance.
+ * @param storageProvider - The storage provider to use for the connection.
+ */
+async function chrisConnection_init(storageProvider) {
+    await (0, config_js_1.config_init)(storageProvider); // This sets the global connectionConfig
+    exports.chrisConnection = new ChRISConnection(config_js_1.connectionConfig, storageProvider);
+    chrisIO_js_1.chrisIO.storageProvider_set(storageProvider);
+    return exports.chrisConnection;
+}
+//# sourceMappingURL=chrisConnection.js.map

package/dist/connect/chrisConnection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisConnection.js","sourceRoot":"","sources":["../../src/connect/chrisConnection.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;;;;AAoVH,oDAKC;AAvVD,gEAAsC;AAgB7B,iBAhBF,kBAAM,CAgBE;AAff,mDAAsF;AACtF,gEAKoC;AAEpC,iDAA2C;AAC3C,0DAAoD;AACpD,kDAA0B;AAiB1B;;;;GAIG;AACH,SAAS,mBAAmB,CAAC,OAAe;IAC1C,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,IAAI,OAAO,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAC5B,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,GAAG,GAAG,OAAO,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,MAAa,eAAe;IAS1B;;;;OAIG;IACH,YAAY,MAAyB,EAAE,eAAkC;QAbjE,cAAS,GAAkB,IAAI,CAAC;QAEhC,SAAI,GAAkB,IAAI,CAAC;QAC3B,aAAQ,GAAkB,IAAI,CAAC;QAC/B,WAAM,GAAkB,IAAI,CAAC;QAUnC,IAAI,MAAM,IAAI,eAAe,EAAE,CAAC;YAC9B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;QACrC,CAAC;QACD,mFAAmF;QACnF,mGAAmG;QACnG,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IACzC,CAAC;IAED;;OAEG;IACH,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,MAAwB,EAAE,eAAiC;QAC9D,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;QACvC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAAuB;QAC9C,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,GAAmB,OAAO,CAAC;QAE/D,iDAAiD;QACjD,IAAI,IAAI,CAAC,eAAe,EAAE,CAAC;YACzB,MAAM,IAAA,uBAAW,EAAC,IAAI,CAAC,eAAe,CAAC,CAAC;YACxC,IAAI,CAAC,OAAO,GAAG,4BAAgB,CAAC;QAClC,CAAC;QAED,MAAM,OAAO,GAAW,GAAG,GAAG,aAAa,CAAC;QAC5C,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC;QACpB,OAAO,CAAC,GAAG,CAAC,iBAAiB,GAAG,cAAc,IAAI,EAAE,CAAC,CAAC;QACtD,MAAM,IAAI,CAAC,OAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC3C,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAQ,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,MAAM,kBAAM,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;YACpE,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBACnB,gDAAgD;gBAChD,MAAM,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC5D,OAAO,CAAC,GAAG,CAAC,+BAA+B,CAAC,CAAC;gBAC7C,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,OAAO,IAAI,CAAC,SAAS,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,8BAA8B,CAAC,CAAC;gBAC5C,OAAO,IAAI,CAAC;YACd,CAAC;QACH,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,OAAO,CAAC,KAAK,CACX,oEAAoE,CACrE,CAAC;YACF,OAAO,CAAC,KAAK,CACX,qEAAqE,CACtE,CAAC;YACF,OAAO,CAAC,KAAK,CACX,oEAAoE,CACrE,CAAC;YACF,OAAO,CAAC,KAAK,CACX,mEAAmE,CACpE,CAAC;YACF,OAAO,CAAC,KAAK,CAAC,kDAAkD,CAAC,CAAC;YAClE,OAAO,CAAC,KAAK,CAAC,oCAAoC,CAAC,CAAC;YACpD,IAAI,KAAK,EAAE,CAAC;gBACV,MAAM,KAAK,CAAC;YACd,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,aAAa,GAAkB,MAAM,IAAA,uCAAqB,EAAC,OAAO,CAAC,CAAC;QAE1E,IAAI,0BAAU,CAAC,kBAAkB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC3C,MAAM,KAAK,GAAG,0BAAU,CAAC,SAAS,EAAE,CAAC;YACrC,OAAO,CAAC,KAAK,CAAC,eAAK,CAAC,GAAG,CAAC,gBAAgB,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;YAC3D,kFAAkF;YAClF,0BAAU,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YAC/B,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,MAAM,GAAY,IAAI,CAAC;QAC3B,IAAI,YAAY,GAAY,KAAK,CAAC;QAElC,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;YACvB,MAAM;gBACJ,MAAM;oBACN,CAAC,MAAM,8BAAY,CAAC,WAAW,CAAC,yBAAO,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAkB;YAC7F,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC,IAAI,CAAC;YAC/B,YAAY,GAAG,IAAI,CAAC;YACpB,MAAM,IAAI,CAAC,OAAQ,CAAC,WAAW,CAC7B,aAAa,CAAC,IAAI,EAClB,aAAa,CAAC,GAAG,IAAI,EAAE,CACxB,CAAC;QACJ,CAAC;QAED,IAAI,aAAa,CAAC,GAAG,EAAE,CAAC;YACtB,MAAM;gBACJ,MAAM,IAAI,CAAC,MAAM,8BAAY,CAAC,WAAW,CAAC,yBAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,kBAAkB;YACrG,IAAI,CAAC,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC;YAClC,YAAY,GAAG,IAAI,CAAC;YACpB,MAAM,IAAI,CAAC,OAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;QACtE,CAAC;QAED,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM;gBACJ,MAAM;oBACN,CAAC,MAAM,8BAAY,CAAC,WAAW,CAAC,yBAAO,CAAC,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,kBAAkB;QACnG,CAAC;QAED,IAAI,aAAa,CAAC,IAAI,EAAE,CAAC;YACvB,MAAM;gBACJ,MAAM;oBACN,CAAC,MAAM,8BAAY,CAAC,WAAW,CAAC,yBAAO,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,kBAAkB;QAC/F,CAAC;QAED,IAAI,aAAa,CAAC,MAAM,EAAE,CAAC;YACzB,MAAM;gBACJ,MAAM;oBACN,CAAC,MAAM,8BAAY,CAAC,WAAW,CAAC,yBAAO,CAAC,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,kBAAkB;QACnG,CAAC;QAED,0CAA0C;QAC1C,IAAI,YAAY,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC9B,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,aAAa,CAAC,SAAmB;QACrC,IAAI,CAAC,IAAI,CAAC,SAAS,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QAC1B,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,QAAQ;QACZ,mFAAmF;QACnF,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACjC,6DAA6D;YAC7D,sEAAsE;YACtE,8EAA8E;YAC9E,2EAA2E;QAC7E,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY;QAChB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO,IAAI,CAAC,CAAC,yBAAyB;YACxC,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,CAAC;QACrD,CAAC;QACD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,cAAc;QAClB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,OAAQ,CAAC,aAAa,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC1C,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,qBAAqB;QACtE,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACpC,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;QACrE,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,UAAU;QACd,IACE,CAAC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC5B,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;YAC3B,IAAI,CAAC,QAAQ;YACb,IAAI,CAAC,SAAS,EACd,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;gBACjB,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAC;YACrE,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,eAAgB,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACnD,OAAO,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;QACzC,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,sBAAsB,EAAE,KAAK,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,gBAAgB,CAAC,IAAY,EAAE,IAAY;QACvD,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,eAAgB,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;QACtD,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,OAAO,CAAC,KAAK,CAAC,YAAY,EAAE,IAAI,CAAC,CAAC;YAClC,OAAO,CAAC,KAAK,CAAC,uBAAuB,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;QAC5D,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,KAAK,CAAC,UAAU;QACtB,IAAI,CAAC;YACH,IAAI,CAAC,SAAS,GAAG,MAAM,IAAI,CAAC,eAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACpE,CAAC;QAAC,OAAO,KAAc,EAAE,CAAC;YACxB,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;IACH,CAAC;CACF;AAzRD,0CAyRC;AAED;;GAEG;AACQ,QAAA,eAAe,GAAoB,IAAI,eAAe,EAAE,CAAC;AAEpE;;;GAGG;AACI,KAAK,UAAU,oBAAoB,CAAC,eAAiC;IAC1E,MAAM,IAAA,uBAAW,EAAC,eAAe,CAAC,CAAC,CAAC,wCAAwC;IAC5E,uBAAe,GAAG,IAAI,eAAe,CAAC,4BAAgB,EAAE,eAAe,CAAC,CAAC;IACzE,oBAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAC7C,OAAO,uBAAe,CAAC;AACzB,CAAC"}

package/dist/context/chrisContext.d.ts

@@ -0,0 +1,110 @@
+/**
+ * @file ChRIS Context Management
+ *
+ * This module manages the context of the ChRIS session, including the current user,
+ * URL, feed, folder, and plugin. It interacts with the session configuration to
+ * persist and retrieve context information.
+ *
+ * @module
+ */
+/**
+ * Enum defining the types of context available in ChRIS.
+ */
+export declare enum Context {
+    ChRISURL = "URL",
+    ChRISuser = "user",
+    ChRISfolder = "folder",
+    ChRISfeed = "feed",
+    ChRISplugin = "plugin",
+    PACSserver = "pacsserver"
+}
+/**
+ * Interface representing the context associated with a specific URL.
+ */
+export interface URLContext {
+    folder: string | null;
+    feed: string | null;
+    plugin: string | null;
+    pacsserver: string | null;
+    token: string | null;
+}
+/**
+ * Interface representing a single context, extending URLContext with URL and user.
+ */
+export interface SingleContext extends URLContext {
+    URL: string | null;
+    user: string | null;
+}
+/**
+ * Interface representing the context for a user, including multiple URLs.
+ */
+export interface UserContext {
+    urls: {
+        [url: string]: URLContext;
+    };
+    currentURL: string | null;
+}
+/**
+ * Interface representing the full context of the application, including multiple users.
+ */
+export interface FullContext {
+    users: {
+        [user: string]: UserContext;
+    };
+    currentUser: string | null;
+    currentURL: string | null;
+}
+/**
+ * Parses a ChRIS context URL string into a SingleContext object.
+ *
+ * @param url - The context URL string to parse.
+ * @returns A Promise resolving to a SingleContext object.
+ */
+export declare function chrisContextURL_parse(url: string): Promise<SingleContext>;
+/**
+ * Manages the ChRIS session context.
+ */
+export declare class ChrisContext {
+    private fullContext;
+    private _singleContext;
+    get singleContext(): SingleContext;
+    constructor();
+    /**
+     * Initializes the context by loading data from the configuration directory.
+     */
+    init(): Promise<void>;
+    /**
+     * Get the full context object.
+     * @returns The full context.
+     */
+    fullContext_get(): FullContext;
+    ChRISURL_get(): Promise<string | null>;
+    ChRISuser_get(): Promise<string | null>;
+    ChRISfolder_get(): Promise<string | null>;
+    ChRISfeed_get(): Promise<string | null>;
+    ChRISfolder_set(path: string): Promise<boolean>;
+    ChRISfeed_set(feedID: string): Promise<boolean>;
+    ChRISplugin_set(pluginID: string): Promise<boolean>;
+    ChRISplugin_get(): Promise<string | null>;
+    PACSserver_set(server: string): Promise<boolean>;
+    PACSserver_get(): Promise<string | null>;
+    folderpath_get(): Promise<string | null>;
+    currentContext_update(): Promise<SingleContext>;
+    /**
+     * Get the current value for a specific context type.
+     * @param context - The context type to retrieve.
+     * @returns The current context value or null.
+     */
+    current_get(context: Context): Promise<string | null>;
+    /**
+     * Set the value for a specific context type.
+     * @param context - The context type to set.
+     * @param value - The value to set.
+     * @returns True on success, false on failure.
+     */
+    current_set(context: Context, value: string): Promise<boolean>;
+}
+/**
+ * Global ChRIS context instance.
+ */
+export declare const chrisContext: ChrisContext;