@fnndsc/cumin 3.2.4

package/dist/context/chrisContext.js

@@ -0,0 +1,324 @@
+"use strict";
+/**
+ * @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
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chrisContext = exports.ChrisContext = exports.Context = void 0;
+exports.chrisContextURL_parse = chrisContextURL_parse;
+const config_js_1 = require("../config/config.js");
+const path = __importStar(require("path"));
+const searchable_js_1 = require("../utils/searchable.js");
+const chrisPlugins_js_1 = require("../plugins/chrisPlugins.js");
+const index_js_1 = require("../cache/index.js");
+const errorStack_js_1 = require("../error/errorStack.js");
+/**
+ * Enum defining the types of context available in ChRIS.
+ */
+var Context;
+(function (Context) {
+    Context["ChRISURL"] = "URL";
+    Context["ChRISuser"] = "user";
+    Context["ChRISfolder"] = "folder";
+    Context["ChRISfeed"] = "feed";
+    Context["ChRISplugin"] = "plugin";
+    Context["PACSserver"] = "pacsserver";
+})(Context || (exports.Context = Context = {}));
+/**
+ * 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.
+ */
+async function chrisContextURL_parse(url) {
+    const result = {
+        URL: null,
+        user: null,
+        folder: null,
+        feed: null,
+        plugin: null,
+        pacsserver: null,
+        token: null,
+    };
+    // Split the URL at the @ symbol
+    const parts = url.split("@");
+    if (parts.length > 1) {
+        result.user = parts[0];
+        url = parts[1];
+    }
+    const urlMatch = url.match(/(https?:\/\/[^?]+)/);
+    if (urlMatch) {
+        result.URL = urlMatch[1];
+    }
+    const queryString = url.split("?")[1];
+    if (queryString) {
+        const queryParams = new URLSearchParams(queryString);
+        result.folder = queryParams.get("folder");
+        result.feed = queryParams.get("feed");
+        // Handle 'plugin' matches with an "includes" vs "equals"
+        for (const [key, value] of queryParams.entries()) {
+            if (key.includes("plugin")) {
+                if (value.includes(":")) {
+                    result.plugin = await searchable_toID(value);
+                }
+                else {
+                    result.plugin = value;
+                }
+                break; // Stop after finding the first match
+            }
+        }
+        // Note: token is not present in the URL, so it remains null
+    }
+    return result;
+}
+/**
+ * Helper to get plugin ID from a searchable string.
+ *
+ * @param searchable - The searchable string or object to search for.
+ * @returns A Promise resolving to the plugin ID or null.
+ */
+async function searchable_toID(searchable) {
+    const searchableObj = typeof searchable === 'string'
+        ? searchable_js_1.Searchable.from(searchable)
+        : searchable;
+    const plugin = new chrisPlugins_js_1.ChRISPlugin();
+    const ids = await plugin.pluginIDs_getFromSearchable(searchableObj);
+    if (ids && ids.hits.length > 0) {
+        const id = ids.hits[0];
+        const ID = id.toString();
+        return ID;
+    }
+    errorStack_js_1.errorStack.stack_push('error', `Could not resolve searchable "${searchable}" to a plugin ID.`);
+    return null;
+}
+/**
+ * Manages the ChRIS session context.
+ */
+class ChrisContext {
+    get singleContext() {
+        return this._singleContext;
+    }
+    constructor() {
+        this.fullContext = {
+            users: {},
+            currentUser: null,
+            currentURL: null,
+        };
+        this._singleContext = {
+            URL: null,
+            user: null,
+            folder: null,
+            feed: null,
+            plugin: null,
+            pacsserver: null,
+            token: null,
+        };
+        // Initialize is async, so we can't await it in constructor.
+        // Consumers should rely on the state being eventually consistent or call methods that ensure initialization.
+        // this.init(); // Removed to avoid accessing uninitialized sessionConfig
+    }
+    /**
+     * Initializes the context by loading data from the configuration directory.
+     */
+    async init() {
+        const configDir = config_js_1.sessionConfig.connection.configDir;
+        const storage = config_js_1.sessionConfig.connection.storage;
+        if (!(await storage.exists(configDir))) {
+            return;
+        }
+        const files = await storage.readdir(configDir);
+        const users = [];
+        for (const file of files) {
+            if (await storage.isDirectory(path.join(configDir, file))) {
+                users.push(file);
+            }
+        }
+        this.fullContext.currentUser = await config_js_1.sessionConfig.connection.lastUser_load();
+        const currentURL = await config_js_1.sessionConfig.connection.chrisURL_load();
+        this.fullContext.currentURL = currentURL;
+        for (const user of users) {
+            this.fullContext.users[user] = { urls: {}, currentURL: null };
+            const userDir = path.join(configDir, user);
+            const chrisURLFile = path.join(userDir, config_js_1.sessionConfig.connection.chrisURLfile);
+            if (await storage.exists(chrisURLFile)) {
+                this.fullContext.users[user].currentURL = await storage.read(chrisURLFile);
+            }
+            if (!(await storage.exists(userDir)))
+                continue;
+            const userFiles = await storage.readdir(userDir);
+            const urlDirs = [];
+            for (const file of userFiles) {
+                if (await storage.isDirectory(path.join(userDir, file))) {
+                    urlDirs.push(file);
+                }
+            }
+            for (const urlDir of urlDirs) {
+                let url = config_js_1.sessionConfig.connection.dir_toUri(urlDir);
+                this.fullContext.users[user].urls[url] = {
+                    folder: await storage.read(path.join(userDir, urlDir, config_js_1.sessionConfig.cwdFile)),
+                    feed: await storage.read(path.join(userDir, urlDir, config_js_1.sessionConfig.feedFile)),
+                    plugin: await storage.read(path.join(userDir, urlDir, config_js_1.sessionConfig.pluginFile)),
+                    pacsserver: await storage.read(path.join(userDir, urlDir, config_js_1.sessionConfig.pacsserverFile)),
+                    token: await storage.read(path.join(userDir, urlDir, config_js_1.sessionConfig.connection.tokenFile)),
+                };
+            }
+        }
+    }
+    /**
+     * Get the full context object.
+     * @returns The full context.
+     */
+    fullContext_get() {
+        return this.fullContext;
+    }
+    async ChRISURL_get() {
+        return config_js_1.sessionConfig.connection.chrisURL_load();
+    }
+    async ChRISuser_get() {
+        return config_js_1.sessionConfig.connection.lastUser_load();
+    }
+    async ChRISfolder_get() {
+        return config_js_1.sessionConfig.pathContext_get();
+    }
+    async ChRISfeed_get() {
+        return config_js_1.sessionConfig.feedContext_get();
+    }
+    async ChRISfolder_set(path) {
+        return config_js_1.sessionConfig.pathContext_set(path);
+    }
+    async ChRISfeed_set(feedID) {
+        return config_js_1.sessionConfig.feedContext_set(feedID);
+    }
+    async ChRISplugin_set(pluginID) {
+        return config_js_1.sessionConfig.pluginContext_set(pluginID);
+    }
+    async ChRISplugin_get() {
+        return config_js_1.sessionConfig.pluginContext_get();
+    }
+    async PACSserver_set(server) {
+        return config_js_1.sessionConfig.pacsserverContext_set(server);
+    }
+    async PACSserver_get() {
+        return config_js_1.sessionConfig.pacsserverContext_get();
+    }
+    async folderpath_get() {
+        return config_js_1.sessionConfig.pathContext_get();
+    }
+    async currentContext_update() {
+        this._singleContext.URL = await this.ChRISURL_get();
+        this._singleContext.user = await this.ChRISuser_get();
+        this._singleContext.folder = await this.ChRISfolder_get();
+        this._singleContext.feed = await this.ChRISfeed_get();
+        this._singleContext.plugin = await this.ChRISplugin_get();
+        this._singleContext.pacsserver = await this.PACSserver_get();
+        return this._singleContext;
+    }
+    /**
+     * Get the current value for a specific context type.
+     * @param context - The context type to retrieve.
+     * @returns The current context value or null.
+     */
+    async current_get(context) {
+        await this.currentContext_update();
+        switch (context) {
+            case Context.ChRISURL:
+                return this._singleContext.URL;
+            case Context.ChRISuser:
+                return this._singleContext.user;
+            case Context.ChRISfolder:
+                return this._singleContext.folder;
+            case Context.ChRISfeed:
+                return this._singleContext.feed;
+            case Context.ChRISplugin:
+                return this._singleContext.plugin;
+            case Context.PACSserver:
+                return this._singleContext.pacsserver;
+        }
+        return 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.
+     */
+    async current_set(context, value) {
+        let status = false;
+        switch (context) {
+            case Context.ChRISuser:
+                this._singleContext.user = value;
+                status = await config_js_1.sessionConfig.connection.lastUser_save(value);
+                break;
+            case Context.ChRISURL:
+                this._singleContext.URL = value;
+                status = await config_js_1.sessionConfig.connection.chrisURL_save(value);
+                break;
+            case Context.ChRISfolder:
+                this._singleContext.folder = value;
+                status = await this.ChRISfolder_set(value);
+                // Invalidate listing cache on CWD change
+                const listCache = (0, index_js_1.listCache_get)();
+                listCache.cwd_update(value);
+                break;
+            case Context.ChRISfeed:
+                this._singleContext.feed = value;
+                status = await this.ChRISfeed_set(value);
+                break;
+            case Context.ChRISplugin:
+                this._singleContext.plugin = value;
+                status = await this.ChRISplugin_set(value);
+                break;
+            case Context.PACSserver:
+                this._singleContext.pacsserver = value;
+                status = await this.PACSserver_set(value);
+                break;
+        }
+        await config_js_1.sessionConfig.connection.init();
+        await config_js_1.sessionConfig.init();
+        return status;
+    }
+}
+exports.ChrisContext = ChrisContext;
+/**
+ * Global ChRIS context instance.
+ */
+exports.chrisContext = new ChrisContext();
+//# sourceMappingURL=chrisContext.js.map

package/dist/context/chrisContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chrisContext.js","sourceRoot":"","sources":["../../src/context/chrisContext.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoEH,sDA+CC;AAjHD,mDAAmF;AACnF,2CAA6B;AAE7B,0DAAoD;AACpD,gEAAyD;AACzD,gDAAkD;AAClD,0DAAoD;AAEpD;;GAEG;AACH,IAAY,OAOX;AAPD,WAAY,OAAO;IACjB,2BAAgB,CAAA;IAChB,6BAAkB,CAAA;IAClB,iCAAsB,CAAA;IACtB,6BAAkB,CAAA;IAClB,iCAAsB,CAAA;IACtB,oCAAyB,CAAA;AAC3B,CAAC,EAPW,OAAO,uBAAP,OAAO,QAOlB;AA0CD;;;;;GAKG;AACI,KAAK,UAAU,qBAAqB,CACzC,GAAW;IAEX,MAAM,MAAM,GAAkB;QAC5B,GAAG,EAAE,IAAI;QACT,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,IAAI;QACV,MAAM,EAAE,IAAI;QACZ,UAAU,EAAE,IAAI;QAChB,KAAK,EAAE,IAAI;KACZ,CAAC;IAEF,gCAAgC;IAChC,MAAM,KAAK,GAAa,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACvC,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrB,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACvB,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;IACjB,CAAC;IAED,MAAM,QAAQ,GAA4B,GAAG,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;IAC1E,IAAI,QAAQ,EAAE,CAAC;QACb,MAAM,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC3B,CAAC;IAED,MAAM,WAAW,GAAW,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9C,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,WAAW,GAAoB,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;QAEtE,MAAM,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC1C,MAAM,CAAC,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAEtC,yDAAyD;QACzD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC;YACjD,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAC3B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxB,MAAM,CAAC,MAAM,GAAG,MAAM,eAAe,CAAC,KAAK,CAAC,CAAC;gBAC/C,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,MAAM,GAAG,KAAK,CAAC;gBACxB,CAAC;gBACD,MAAM,CAAC,qCAAqC;YAC9C,CAAC;QACH,CAAC;QAED,4DAA4D;IAC9D,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,eAAe,CAAC,UAA+B;IAC5D,MAAM,aAAa,GAAe,OAAO,UAAU,KAAK,QAAQ;QAC9D,CAAC,CAAC,0BAAU,CAAC,IAAI,CAAC,UAAU,CAAC;QAC7B,CAAC,CAAC,UAAU,CAAC;IAEf,MAAM,MAAM,GAAgB,IAAI,6BAAW,EAAE,CAAC;IAC9C,MAAM,GAAG,GAAqB,MAAM,MAAM,CAAC,2BAA2B,CACpE,aAAa,CACd,CAAC;IACF,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,MAAM,EAAE,GAAW,GAAG,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;QACzC,MAAM,EAAE,GAAW,EAAE,CAAC,QAAQ,EAAE,CAAC;QACjC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,0BAAU,CAAC,UAAU,CAAC,OAAO,EAAE,iCAAiC,UAAU,mBAAmB,CAAC,CAAC;IAC/F,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,MAAa,YAAY;IAiBvB,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;QApBQ,gBAAW,GAAgB;YACjC,KAAK,EAAE,EAAE;YACT,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,IAAI;SACjB,CAAC;QAEM,mBAAc,GAAkB;YACtC,GAAG,EAAE,IAAI;YACT,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI;YACZ,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,IAAI;SACZ,CAAC;QAOA,4DAA4D;QAC5D,6GAA6G;QAC7G,yEAAyE;IAC3E,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,IAAI;QACR,MAAM,SAAS,GAAW,yBAAa,CAAC,UAAU,CAAC,SAAS,CAAC;QAC7D,MAAM,OAAO,GAAG,yBAAa,CAAC,UAAU,CAAC,OAAO,CAAC;QAEjD,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAa,MAAM,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QACzD,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;gBAC1D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,WAAW,GAAG,MAAM,yBAAa,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;QAC9E,MAAM,UAAU,GAAkB,MAAM,yBAAa,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;QACjF,IAAI,CAAC,WAAW,CAAC,UAAU,GAAG,UAAU,CAAC;QAEzC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;YAC9D,MAAM,OAAO,GAAW,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YACnD,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAC5B,OAAO,EACP,yBAAa,CAAC,UAAU,CAAC,YAAY,CACtC,CAAC;YACF,IAAI,MAAM,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE,CAAC;gBACvC,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7E,CAAC;YAED,IAAI,CAAC,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;gBAAE,SAAS;YAE/C,MAAM,SAAS,GAAa,MAAM,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YAC3D,MAAM,OAAO,GAAa,EAAE,CAAC;YAE7B,KAAK,MAAM,IAAI,IAAI,SAAS,EAAE,CAAC;gBAC3B,IAAI,MAAM,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;oBACtD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACvB,CAAC;YACL,CAAC;YAED,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;gBAC7B,IAAI,GAAG,GACL,yBAAa,CAAC,UACf,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBAEpB,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG;oBACvC,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,yBAAa,CAAC,OAAO,CAAC,CAAC;oBAC7E,IAAI,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,yBAAa,CAAC,QAAQ,CAAC,CAAC;oBAC5E,MAAM,EAAE,MAAM,OAAO,CAAC,IAAI,CACxB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,yBAAa,CAAC,UAAU,CAAC,CACrD;oBACD,UAAU,EAAE,MAAM,OAAO,CAAC,IAAI,CAC5B,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,yBAAa,CAAC,cAAc,CAAC,CACzD;oBACD,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CACvB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,yBAAa,CAAC,UAAU,CAAC,SAAS,CAAC,CAC/D;iBACF,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,eAAe;QACb,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,yBAAa,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,yBAAa,CAAC,UAAU,CAAC,aAAa,EAAE,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,OAAO,yBAAa,CAAC,eAAe,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,aAAa;QACjB,OAAO,yBAAa,CAAC,eAAe,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,IAAY;QAChC,OAAO,yBAAa,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,MAAc;QAChC,OAAO,yBAAa,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,QAAgB;QACpC,OAAO,yBAAa,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACnD,CAAC;IAED,KAAK,CAAC,eAAe;QACnB,OAAO,yBAAa,CAAC,iBAAiB,EAAE,CAAC;IAC3C,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,MAAc;QACjC,OAAO,yBAAa,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,yBAAa,CAAC,qBAAqB,EAAE,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,cAAc;QAClB,OAAO,yBAAa,CAAC,eAAe,EAAE,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,qBAAqB;QACzB,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACpD,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QACtD,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC1D,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QACtD,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;QAC1D,IAAI,CAAC,cAAc,CAAC,UAAU,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,CAAC;QAC7D,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,WAAW,CAAC,OAAgB;QAChC,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;QACnC,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,OAAO,CAAC,QAAQ;gBACnB,OAAO,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC;YACjC,KAAK,OAAO,CAAC,SAAS;gBACpB,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;YAClC,KAAK,OAAO,CAAC,WAAW;gBACtB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;YACpC,KAAK,OAAO,CAAC,SAAS;gBACpB,OAAO,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC;YAClC,KAAK,OAAO,CAAC,WAAW;gBACtB,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC;YACpC,KAAK,OAAO,CAAC,UAAU;gBACrB,OAAO,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC;QAC1C,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,WAAW,CAAC,OAAgB,EAAE,KAAa;QAC/C,IAAI,MAAM,GAAY,KAAK,CAAC;QAC5B,QAAQ,OAAO,EAAE,CAAC;YAChB,KAAK,OAAO,CAAC,SAAS;gBACpB,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,KAAK,CAAC;gBACjC,MAAM,GAAG,MAAM,yBAAa,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC7D,MAAM;YACR,KAAK,OAAO,CAAC,QAAQ;gBACnB,IAAI,CAAC,cAAc,CAAC,GAAG,GAAG,KAAK,CAAC;gBAChC,MAAM,GAAG,MAAM,yBAAa,CAAC,UAAU,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBAC7D,MAAM;YACR,KAAK,OAAO,CAAC,WAAW;gBACtB,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,KAAK,CAAC;gBACnC,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;gBAC3C,yCAAyC;gBACzC,MAAM,SAAS,GAAG,IAAA,wBAAa,GAAE,CAAC;gBAClC,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;gBAC5B,MAAM;YACR,KAAK,OAAO,CAAC,SAAS;gBACpB,IAAI,CAAC,cAAc,CAAC,IAAI,GAAG,KAAK,CAAC;gBACjC,MAAM,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;gBACzC,MAAM;YACR,KAAK,OAAO,CAAC,WAAW;gBACtB,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,KAAK,CAAC;gBACnC,MAAM,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;gBAC3C,MAAM;YACR,KAAK,OAAO,CAAC,UAAU;gBACrB,IAAI,CAAC,cAAc,CAAC,UAAU,GAAG,KAAK,CAAC;gBACvC,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;gBAC1C,MAAM;QACV,CAAC;QACD,MAAM,yBAAa,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QACtC,MAAM,yBAAa,CAAC,IAAI,EAAE,CAAC;QAC3B,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AA9ND,oCA8NC;AAED;;GAEG;AACU,QAAA,YAAY,GAAiB,IAAI,YAAY,EAAE,CAAC"}

package/dist/error/errorStack.d.ts

@@ -0,0 +1,115 @@
+/**
+ * @file Process-wide error/message stack for deferred, structured reporting.
+ *
+ * @module
+ */
+type MessageType = "error" | "warning";
+/**
+ * Represents a single message in the error stack.
+ */
+export interface StackMessage {
+    type: MessageType;
+    message: string;
+}
+/**
+ * Options for configuring the ErrorStack.
+ */
+interface ErrorStackOptions {
+    functionNamePadWidth?: number;
+}
+/**
+ * Singleton class for managing a stack of error and warning messages.
+ * Provides methods to push, pop, search, and filter messages.
+ */
+declare class ErrorStack {
+    private static instance;
+    private stack;
+    private functionNamePadWidth;
+    private constructor();
+    /**
+     * Get the singleton instance of the ErrorStack.
+     *
+     * @param options - Optional configuration options for the stack.
+     * @returns The singleton ErrorStack instance.
+     */
+    static instance_get(options?: ErrorStackOptions): ErrorStack;
+    /**
+     * Push a new message onto the stack.
+     *
+     * Captures the calling function name and formats the message.
+     *
+     * @param type - The type of message ("error" or "warning").
+     * @param message - The message string.
+     */
+    stack_push(type: MessageType, message: string): void;
+    /**
+     * Pop the last message from the stack.
+     *
+     * @returns The last message object or undefined if the stack is empty.
+     */
+    stack_pop(): StackMessage | undefined;
+    /**
+     * Search the stack for messages containing a substring.
+     *
+     * @param substring - The string to search for (case-insensitive).
+     * @returns An array of formatted strings matching the search.
+     */
+    stack_getAll(): StackMessage[];
+    stack_search(substring: string): string[];
+    /**
+     * Get all messages of a specific type.
+     *
+     * @param type - The message type to filter by.
+     * @returns An array of message strings.
+     */
+    allOfType_get(type: MessageType): string[];
+    /**
+     * Search for messages of a specific type containing a substring.
+     *
+     * @param type - The message type to filter by.
+     * @param substring - The string to search for (case-insensitive).
+     * @returns An array of matching message strings.
+     */
+    messagesOfType_search(type: MessageType, substring: string): string[];
+    /**
+     * Clear all messages from the stack.
+     */
+    stack_clear(): void;
+    /**
+     * Clear all messages of a specific type from the stack.
+     *
+     * @param type - The message type to clear.
+     */
+    type_clear(type: MessageType): void;
+    /**
+     * Check if the stack contains any messages.
+     *
+     * @returns True if the stack is not empty, false otherwise.
+     */
+    messages_has(): boolean;
+    /**
+     * Check if the stack contains any messages of a specific type.
+     *
+     * @param type - The message type to check for.
+     * @returns True if messages of the given type exist, false otherwise.
+     */
+    messagesOfType_has(type: MessageType): boolean;
+}
+/**
+ * The global singleton instance of the ErrorStack.
+ */
+export declare const errorStack: ErrorStack;
+/**
+ * Reconfigures the error stack with new options.
+ *
+ * @param options - The new configuration options.
+ */
+export declare function errorStack_configure(options: ErrorStackOptions): void;
+/**
+ * Get all messages of a specific type from the global error stack.
+ *
+ * @param type - The message type to filter by.
+ * @returns An array of message strings.
+ */
+export declare function errorStack_getAllOfType(type: MessageType): string[];
+export {};

package/dist/error/errorStack.js

@@ -0,0 +1,175 @@
+"use strict";
+/**
+ * @file Process-wide error/message stack for deferred, structured reporting.
+ *
+ * @module
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorStack = void 0;
+exports.errorStack_configure = errorStack_configure;
+exports.errorStack_getAllOfType = errorStack_getAllOfType;
+/**
+ * Pads a string to the right with spaces to a specified length.
+ * If the string is longer than the length, it is truncated with ellipses.
+ *
+ * @param str - The string to pad.
+ * @param length - The target length.
+ * @returns The padded or truncated string.
+ */
+function str_padRight(str, length) {
+    if (str.length > length) {
+        return str.substring(0, length - 3) + "...";
+    }
+    return str.padEnd(length);
+}
+/**
+ * Retrieves the name of the function that called the current function.
+ * Uses the error stack trace to parse the caller's name.
+ *
+ * @returns The name of the calling function, or a default string if not found.
+ */
+function functionName_getCurrent() {
+    const error = new Error();
+    const stack = error.stack?.split("\n");
+    if (!stack || stack.length < 4) {
+        return "Unknown Function";
+    }
+    const callerLine = stack[3];
+    const functionNameMatch = callerLine.match(/at\s+([\w\.<>]+)\s*\(/);
+    return functionNameMatch ? functionNameMatch[1] : "Anonymous Function";
+}
+/**
+ * Singleton class for managing a stack of error and warning messages.
+ * Provides methods to push, pop, search, and filter messages.
+ */
+class ErrorStack {
+    constructor(options = {}) {
+        this.stack = [];
+        this.functionNamePadWidth = options.functionNamePadWidth || 45; // Default to 45 if not specified
+    }
+    /**
+     * Get the singleton instance of the ErrorStack.
+     *
+     * @param options - Optional configuration options for the stack.
+     * @returns The singleton ErrorStack instance.
+     */
+    static instance_get(options) {
+        if (!ErrorStack.instance) {
+            ErrorStack.instance = new ErrorStack(options);
+        }
+        return ErrorStack.instance;
+    }
+    /**
+     * Push a new message onto the stack.
+     *
+     * Captures the calling function name and formats the message.
+     *
+     * @param type - The type of message ("error" or "warning").
+     * @param message - The message string.
+     */
+    stack_push(type, message) {
+        const functionName = functionName_getCurrent();
+        const paddedFunctionName = str_padRight(functionName, this.functionNamePadWidth);
+        const enhancedMessage = `[${paddedFunctionName}] | ${message}`;
+        this.stack.push({ type, message: enhancedMessage });
+    }
+    /**
+     * Pop the last message from the stack.
+     *
+     * @returns The last message object or undefined if the stack is empty.
+     */
+    stack_pop() {
+        return this.stack.pop();
+    }
+    /**
+     * Search the stack for messages containing a substring.
+     *
+     * @param substring - The string to search for (case-insensitive).
+     * @returns An array of formatted strings matching the search.
+     */
+    stack_getAll() {
+        return [...this.stack];
+    }
+    stack_search(substring) {
+        return this.stack
+            .filter((item) => item.message.toLowerCase().includes(substring.toLowerCase()))
+            .map((item) => `${item.type}: ${item.message}`);
+    }
+    /**
+     * Get all messages of a specific type.
+     *
+     * @param type - The message type to filter by.
+     * @returns An array of message strings.
+     */
+    allOfType_get(type) {
+        return this.stack
+            .filter((item) => item.type === type)
+            .map((item) => item.message);
+    }
+    /**
+     * Search for messages of a specific type containing a substring.
+     *
+     * @param type - The message type to filter by.
+     * @param substring - The string to search for (case-insensitive).
+     * @returns An array of matching message strings.
+     */
+    messagesOfType_search(type, substring) {
+        return this.stack
+            .filter((item) => item.type === type &&
+            item.message.toLowerCase().includes(substring.toLowerCase()))
+            .map((item) => item.message);
+    }
+    /**
+     * Clear all messages from the stack.
+     */
+    stack_clear() {
+        this.stack = [];
+    }
+    /**
+     * Clear all messages of a specific type from the stack.
+     *
+     * @param type - The message type to clear.
+     */
+    type_clear(type) {
+        this.stack = this.stack.filter((item) => item.type !== type);
+    }
+    /**
+     * Check if the stack contains any messages.
+     *
+     * @returns True if the stack is not empty, false otherwise.
+     */
+    messages_has() {
+        return this.stack.length > 0;
+    }
+    /**
+     * Check if the stack contains any messages of a specific type.
+     *
+     * @param type - The message type to check for.
+     * @returns True if messages of the given type exist, false otherwise.
+     */
+    messagesOfType_has(type) {
+        return this.stack.some((item) => item.type === type);
+    }
+}
+/**
+ * The global singleton instance of the ErrorStack.
+ */
+exports.errorStack = ErrorStack.instance_get({ functionNamePadWidth: 40 });
+/**
+ * Reconfigures the error stack with new options.
+ *
+ * @param options - The new configuration options.
+ */
+function errorStack_configure(options) {
+    ErrorStack.instance_get(options);
+}
+/**
+ * Get all messages of a specific type from the global error stack.
+ *
+ * @param type - The message type to filter by.
+ * @returns An array of message strings.
+ */
+function errorStack_getAllOfType(type) {
+    return exports.errorStack.allOfType_get(type);
+}
+//# sourceMappingURL=errorStack.js.map

package/dist/error/errorStack.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errorStack.js","sourceRoot":"","sources":["../../src/error/errorStack.ts"],"names":[],"mappings":";AAAA;;;;GAIG;;;AAyMH,oDAEC;AAQD,0DAEC;AAjMD;;;;;;;GAOG;AACH,SAAS,YAAY,CAAC,GAAW,EAAE,MAAc;IAC/C,IAAI,GAAG,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC5B,CAAC;AAED;;;;;GAKG;AACH,SAAS,uBAAuB;IAC9B,MAAM,KAAK,GAAU,IAAI,KAAK,EAAE,CAAC;IACjC,MAAM,KAAK,GAAyB,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC;IAE7D,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,OAAO,kBAAkB,CAAC;IAC5B,CAAC;IAED,MAAM,UAAU,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC;IACpC,MAAM,iBAAiB,GAA4B,UAAU,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAE7F,OAAO,iBAAiB,CAAC,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC;AACzE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU;IAKd,YAAoB,UAA6B,EAAE;QAH3C,UAAK,GAAmB,EAAE,CAAC;QAIjC,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,IAAI,EAAE,CAAC,CAAC,iCAAiC;IACnG,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,YAAY,CAAC,OAA2B;QACpD,IAAI,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;YACzB,UAAU,CAAC,QAAQ,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,UAAU,CAAC,QAAQ,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACI,UAAU,CAAC,IAAiB,EAAE,OAAe;QAClD,MAAM,YAAY,GAAW,uBAAuB,EAAE,CAAC;QACvD,MAAM,kBAAkB,GAAW,YAAY,CAC7C,YAAY,EACZ,IAAI,CAAC,oBAAoB,CAC1B,CAAC;QACF,MAAM,eAAe,GAAW,IAAI,kBAAkB,OAAO,OAAO,EAAE,CAAC;QACvE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,eAAe,EAAE,CAAC,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACI,SAAS;QACd,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACI,YAAY;QACjB,OAAO,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;IACzB,CAAC;IAEM,YAAY,CAAC,SAAiB;QACnC,OAAO,IAAI,CAAC,KAAK;aACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CACf,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAC7D;aACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACpD,CAAC;IAED;;;;;OAKG;IACI,aAAa,CAAC,IAAiB;QACpC,OAAO,IAAI,CAAC,KAAK;aACd,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC;aACpC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;OAMG;IACI,qBAAqB,CAAC,IAAiB,EAAE,SAAiB;QAC/D,OAAO,IAAI,CAAC,KAAK;aACd,MAAM,CACL,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,IAAI,KAAK,IAAI;YAClB,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAC/D;aACA,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,WAAW;QAChB,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;IAClB,CAAC;IAED;;;;OAIG;IACI,UAAU,CAAC,IAAiB;QACjC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACI,YAAY;QACjB,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACI,kBAAkB,CAAC,IAAiB;QACzC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;IACvD,CAAC;CACF;AAED;;GAEG;AACU,QAAA,UAAU,GAAe,UAAU,CAAC,YAAY,CAAC,EAAE,oBAAoB,EAAE,EAAE,EAAE,CAAC,CAAC;AAE5F;;;;GAIG;AACH,SAAgB,oBAAoB,CAAC,OAA0B;IAC7D,UAAU,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC;AACnC,CAAC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,IAAiB;IACvD,OAAO,kBAAU,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;AACxC,CAAC"}