@rapidrest/core 1.0.1

package/dist/lib/decorators/index.js

@@ -0,0 +1,2 @@
+export * as ObjectDecorators from "./ObjectDecorators.js";
+//# sourceMappingURL=index.js.map

package/dist/lib/decorators/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/decorators/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,gBAAgB,MAAM,uBAAuB,CAAC"}

package/dist/lib/index.js

@@ -0,0 +1,18 @@
+export * from "./ApiError.js";
+export * from "./AlertUtils.js";
+export * from "./ClassLoader.js";
+export * from "./decorators/index.js";
+export * from "./FileUtils.js";
+export * from "./JWTUtils.js";
+export * from "./Logger.js";
+export * from "./MessagingUtils.js";
+export * from "./ObjectFactory.js";
+export * from "./ObjectUtils.js";
+export * from "./OASUtils.js";
+export * from "./StringUtils.js";
+export * from "./threads/index.js";
+export * from "./sleep.js";
+export * from "./TelemetryUtils.js";
+export * from "./UserUtils.js";
+export * from "./ValidationUtils.js";
+//# sourceMappingURL=index.js.map

package/dist/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,YAAY,CAAC;AAC3B,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC"}

package/dist/lib/sleep.js

@@ -0,0 +1,15 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Starts a timer to suspend execution for a given number of milliseconds.
+ * @param ms The number of milliseconds to suspend. Default is `1`.
+ */
+export async function sleep(ms = 1) {
+    return await new Promise((resolve) => {
+        setTimeout(async () => {
+            resolve();
+        }, ms);
+    });
+}
+//# sourceMappingURL=sleep.js.map

package/dist/lib/sleep.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sleep.js","sourceRoot":"","sources":["../../src/sleep.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,KAAK,CAAC,KAAa,CAAC;IACtC,OAAO,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QACjC,UAAU,CAAC,KAAK,IAAI,EAAE;YAClB,OAAO,EAAE,CAAC;QACd,CAAC,EAAE,EAAE,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACP,CAAC"}

package/dist/lib/threads/ThreadLogger.js

@@ -0,0 +1,43 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+const { parentPort, threadId } = require("worker_threads");
+/**
+ * Provides a Winston transport for forwarding logs from this thread to the parent's logger instance.
+ *
+ * Constructor requires two properties to be set in the `opts` argument:
+ * - `parentPort`
+ * - `threadId`
+ */
+class ThreadLogger {
+    log(data) {
+        if (typeof data !== "object") {
+            data = {
+                level: "info",
+                message: data,
+            };
+        }
+        // Prefix the thread ID to the message
+        data.message = `[Thread-${threadId}]: ${data.message}`;
+        // Forward the log to the parent thread
+        parentPort?.postMessage({
+            type: "_WorkerLog",
+            data,
+        });
+    }
+    debug(message) {
+        this.log({ level: "debug", message });
+    }
+    error(message) {
+        this.log({ level: "error", message });
+    }
+    info(message) {
+        this.log({ level: "info", message });
+    }
+    warn(message) {
+        this.log({ level: "warn", message });
+    }
+}
+module.exports = ThreadLogger;
+export {};
+//# sourceMappingURL=ThreadLogger.js.map

package/dist/lib/threads/ThreadLogger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThreadLogger.js","sourceRoot":"","sources":["../../../src/threads/ThreadLogger.js"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAE3D;;;;;;GAMG;AACH,MAAM,YAAY;IACd,GAAG,CAAC,IAAI;QACJ,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;YAC3B,IAAI,GAAG;gBACH,KAAK,EAAE,MAAM;gBACb,OAAO,EAAE,IAAI;aAChB,CAAC;QACN,CAAC;QAED,sCAAsC;QACtC,IAAI,CAAC,OAAO,GAAG,WAAW,QAAQ,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;QAEvD,uCAAuC;QACvC,UAAU,EAAE,WAAW,CAAC;YACpB,IAAI,EAAE,YAAY;YAClB,IAAI;SACP,CAAC,CAAC;IACP,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,OAAO;QACT,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,CAAC,OAAO;QACR,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,OAAO;QACR,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;IACzC,CAAC;CACJ;AAED,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC"}

package/dist/lib/threads/ThreadPool.js

@@ -0,0 +1,270 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+import { Worker } from "worker_threads";
+import os from "os";
+import path from "path";
+import { WorkerMessageType } from "./ThreadWorker.js";
+import { sleep } from "../sleep.js";
+import { Config, Destroy, Logger } from "../decorators/ObjectDecorators.js";
+/**
+ * The `ThreadPool` class provides an interface for managing a pool of execution threads that can be used for parallel
+ * code execution. `ThreadPool` is a wrapper to the `worker_threads` API to add support for multiple `Worker` instances.
+ * By default, the pool will create *n* workers corresponding to the number of CPUs (physical + virtual) on the system.
+ *
+ * There are two ways to start worker threads with the pool.
+ *
+ * The first way is to set the `entry` option when calling the `start()` function. This will create a instance of the
+ * `worker_threads` APIs `Worker` class with the specified file as the entry point. Note that this file must be of
+ * type JavaScript (`.js` extension) as the underlying system does not support loading TypeScript. If the `args` option
+ * is set, the value will be passed in as the `workerData` to the entry file.
+ *
+ * The second way to start a worker thread is by setting the `worker` argument when calling the `start()` function. The
+ * specified `worker` file must contain a `default` export. The `default` export must be a class definition which
+ * extends the `ThreadWorker` abstract class interface. The file can be either JavaScript or TypeScript. When using
+ * this method the `start()` function will return only when all worker instances in each thread of the pool has
+ * successfully returned from its `start()` function. When the `args` option is set, the value(s) will be passed in to
+ * the constructor on instantiation by the thread executor.
+ *
+ * When the `restartOnExit` option is specified, the pool will automatically recreate and start a worker thread on
+ * the `exit event`.
+ *
+ * This class exposes worker messages via the `on()` callback handler function. Registering a callback handler via
+ * `on()` will propogate all messages from all underlying threads in the pool.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class ThreadPool {
+    /** The map of event types to a list of callback functions. */
+    callbacks;
+    /** The index of the last worker that was assigned work. */
+    lastThread;
+    /** The instance of Winston logger to forward thread logs to. */
+    logger;
+    /** The maximum number of threads allowed. */
+    maxThreads = os.cpus().length;
+    /** The list of active worker threads. */
+    workers;
+    /** Used to indicate that the pool is shutting down. */
+    shutdown;
+    /**
+     * The maximum number of threads that can be created by the pool.
+     */
+    get max() {
+        return this.maxThreads;
+    }
+    /**
+     * The number of active threads in the pool.
+     */
+    get size() {
+        return this.workers.length;
+    }
+    /**
+     * Creates a new `ThreadPool` instance with the specified defaults.
+     *
+     * @param max The maximum number of threads to create. Default is `os.cpus().length`.
+     * @param logger The Winston logger instance to forward all worker thread logs to.
+     */
+    constructor(max = 0, logger) {
+        this.maxThreads = max || this.maxThreads || os.cpus().length;
+        this.lastThread = 0;
+        this.logger = logger;
+        this.callbacks = new Map();
+        this.shutdown = false;
+        this.workers = new Array();
+    }
+    createWorker(idx, options) {
+        if (!options.entry || !!options.worker) {
+            options.entry = path.join(__dirname, "ThreadWorkerEntry.js");
+        }
+        const workerOptions = {
+            workerData: options && options.worker ? options : options?.args,
+        };
+        this.logger?.debug(`Creating thread worker: ${JSON.stringify(options)}`);
+        const worker = new Worker(options.entry, workerOptions);
+        worker.on("error", (error) => {
+            const listeners = this.callbacks.get("error");
+            if (listeners) {
+                for (const callback of listeners) {
+                    callback(idx, error);
+                }
+            }
+        });
+        worker.on("exit", async (code) => {
+            const listeners = this.callbacks.get("exit");
+            if (listeners) {
+                for (const callback of listeners) {
+                    callback(idx, code);
+                }
+            }
+            // Restart worker thread
+            if (options?.restartOnExit && !this.shutdown) {
+                const worker = this.createWorker(idx, options);
+                this.workers[idx] = worker;
+            }
+        });
+        worker.on("message", (msg) => {
+            switch (msg.type) {
+                case WorkerMessageType.LOG:
+                    this.logger?.log(msg.data);
+                    break;
+                case WorkerMessageType.ONLINE:
+                    {
+                        const listeners = this.callbacks.get("online");
+                        if (listeners) {
+                            for (const callback of listeners) {
+                                callback(idx);
+                            }
+                        }
+                    }
+                    break;
+                default:
+                    {
+                        const listeners = this.callbacks.get("message");
+                        if (listeners) {
+                            for (const callback of listeners) {
+                                callback(idx, msg);
+                            }
+                        }
+                    }
+                    break;
+            }
+        });
+        return worker;
+    }
+    /**
+     * Initializes the thread pool with the initial worker threads and begins execution.
+     *
+     * @param entry The path of the entry create a worker thread from. Default is `ThreadWorkerEntry.js`.
+     * @param options The options to use when creating the worker thread.
+     * @param num The number of initial threads to create, cannot be greater than max. Default is `max`.
+     */
+    start(options, num = this.max) {
+        this.shutdown = false;
+        return new Promise((resolve, reject) => {
+            let numReady = 0;
+            if (!options) {
+                options = {};
+            }
+            options.allowTs = "allowTs" in options ? options.allowTs : true;
+            for (let i = 0; i < num && i < this.maxThreads; i++) {
+                const worker = this.createWorker(i, options);
+                worker.on("online", () => {
+                    if (options && !options.worker) {
+                        numReady++;
+                    }
+                    // When all workers have finished being created resolve
+                    if (numReady >= num || numReady >= this.maxThreads) {
+                        resolve();
+                    }
+                });
+                worker.on("message", (msg) => {
+                    switch (msg.type) {
+                        case WorkerMessageType.ERROR:
+                            reject(msg.data);
+                            break;
+                        case WorkerMessageType.ONLINE:
+                            numReady++;
+                            break;
+                    }
+                    // When all workers have finished being created resolve
+                    if (numReady >= num || numReady >= this.maxThreads) {
+                        resolve();
+                    }
+                });
+                this.workers[i] = worker;
+            }
+            this.logger?.debug(`Created ${this.workers.length} worker(s)`);
+        });
+    }
+    /**
+     * Stops all running thread executions.
+     */
+    async stop() {
+        const listeners = this.callbacks.get("exit");
+        this.shutdown = true;
+        // Send the stop signal so the workers know to terminate
+        this.sendAll({ type: WorkerMessageType.STOP });
+        // Give the message above a chance to propogate
+        await sleep(10);
+        for (let idx = 0; idx < this.workers.length; idx++) {
+            const worker = this.workers[idx];
+            const exitCode = await worker.terminate();
+            if (listeners) {
+                for (const callback of listeners) {
+                    callback(idx, exitCode);
+                }
+            }
+        }
+    }
+    /**
+     * Registers a new callback function to be notified when the given event type is fired.
+     *
+     * @param type The event type to be notified of. Possible values are: `error`, `exit` and `message`.
+     * @param func The callback function to register.
+     */
+    on(type, func) {
+        let listeners = this.callbacks.get(type);
+        if (!listeners) {
+            listeners = new Array();
+        }
+        listeners.push(func);
+        this.callbacks.set(type, listeners);
+    }
+    /**
+     * Sends the provided message to the next available worker thread. Messages are sent in a round-robin order.
+     * @param msg The message to send the next available worker thread.
+     */
+    send(msg) {
+        const startIdx = (this.lastThread + 1) % this.workers.length;
+        let worker = undefined;
+        do {
+            worker = this.workers[startIdx];
+            this.lastThread = startIdx;
+        } while (!worker);
+        worker.postMessage(msg);
+    }
+    /**
+     * Sends the provided message to all worker threads in the pool.
+     * @param msg The message to send to all workers.
+     */
+    sendAll(msg) {
+        for (const worker of this.workers) {
+            worker.postMessage(msg);
+        }
+    }
+    /**
+     * Sends the provided message to the worker thread with the specified id.
+     * @param id The id of the thread to send the message to.
+     * @param msg The message to send the next available worker thread.
+     */
+    sendTo(id, msg) {
+        if (this.workers[id]) {
+            this.workers[id].postMessage(msg);
+        }
+    }
+}
+__decorate([
+    Logger,
+    __metadata("design:type", Object)
+], ThreadPool.prototype, "logger", void 0);
+__decorate([
+    Config("thread_pool:max_threads", os.cpus().length),
+    __metadata("design:type", Number)
+], ThreadPool.prototype, "maxThreads", void 0);
+__decorate([
+    Destroy,
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], ThreadPool.prototype, "stop", null);
+//# sourceMappingURL=ThreadPool.js.map

package/dist/lib/threads/ThreadPool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThreadPool.js","sourceRoot":"","sources":["../../../src/threads/ThreadPool.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AACxC,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,EAAiB,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AACrE,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AA0B5E;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,OAAO,UAAU;IACnB,8DAA8D;IACtD,SAAS,CAAqC;IACtD,2DAA2D;IACnD,UAAU,CAAS;IAC3B,gEAAgE;IAExD,MAAM,CAAO;IACrB,6CAA6C;IAErC,UAAU,GAAW,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC;IAC9C,yCAAyC;IACzB,OAAO,CAAgB;IACvC,uDAAuD;IAC/C,QAAQ,CAAU;IAE1B;;OAEG;IACH,IAAW,GAAG;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACX,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAC/B,CAAC;IAED;;;;;OAKG;IACH,YAAY,MAAc,CAAC,EAAE,MAAY;QACrC,IAAI,CAAC,UAAU,GAAG,GAAG,IAAI,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC;QAC7D,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC;QACpB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,KAAK,EAAE,CAAC;IAC/B,CAAC;IAEO,YAAY,CAAC,GAAW,EAAE,OAAsB;QACpD,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACrC,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;QACjE,CAAC;QACD,MAAM,aAAa,GAAQ;YACvB,UAAU,EAAE,OAAO,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,IAAI;SAClE,CAAC;QACF,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,2BAA2B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACzE,MAAM,MAAM,GAAW,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;QAEhE,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACzB,MAAM,SAAS,GAAsC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;YACjF,IAAI,SAAS,EAAE,CAAC;gBACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBAC/B,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACzB,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE;YAC7B,MAAM,SAAS,GAAsC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YAChF,IAAI,SAAS,EAAE,CAAC;gBACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBAC/B,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;gBACxB,CAAC;YACL,CAAC;YAED,wBAAwB;YACxB,IAAI,OAAO,EAAE,aAAa,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC3C,MAAM,MAAM,GAAW,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;gBACvD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC;YAC/B,CAAC;QACL,CAAC,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAkB,EAAE,EAAE;YACxC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;gBACf,KAAK,iBAAiB,CAAC,GAAG;oBACtB,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBAC3B,MAAM;gBACV,KAAK,iBAAiB,CAAC,MAAM;oBACzB,CAAC;wBACG,MAAM,SAAS,GAAsC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;wBAClF,IAAI,SAAS,EAAE,CAAC;4BACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gCAC/B,QAAQ,CAAC,GAAG,CAAC,CAAC;4BAClB,CAAC;wBACL,CAAC;oBACL,CAAC;oBACD,MAAM;gBACV;oBACI,CAAC;wBACG,MAAM,SAAS,GAAsC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;wBACnF,IAAI,SAAS,EAAE,CAAC;4BACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gCAC/B,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;4BACvB,CAAC;wBACL,CAAC;oBACL,CAAC;oBACD,MAAM;YACd,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAClB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,OAAuB,EAAE,MAAc,IAAI,CAAC,GAAG;QACxD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QAEtB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACnC,IAAI,QAAQ,GAAW,CAAC,CAAC;YACzB,IAAI,CAAC,OAAO,EAAE,CAAC;gBACX,OAAO,GAAG,EAAE,CAAC;YACjB,CAAC;YACD,OAAO,CAAC,OAAO,GAAG,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;YAEhE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,EAAE,EAAE,CAAC;gBAClD,MAAM,MAAM,GAAW,IAAI,CAAC,YAAY,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;gBACrD,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;oBACrB,IAAI,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;wBAC7B,QAAQ,EAAE,CAAC;oBACf,CAAC;oBAED,uDAAuD;oBACvD,IAAI,QAAQ,IAAI,GAAG,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;wBACjD,OAAO,EAAE,CAAC;oBACd,CAAC;gBACL,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,GAAQ,EAAE,EAAE;oBAC9B,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;wBACf,KAAK,iBAAiB,CAAC,KAAK;4BACxB,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;4BACjB,MAAM;wBACV,KAAK,iBAAiB,CAAC,MAAM;4BACzB,QAAQ,EAAE,CAAC;4BACX,MAAM;oBACd,CAAC;oBAED,uDAAuD;oBACvD,IAAI,QAAQ,IAAI,GAAG,IAAI,QAAQ,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;wBACjD,OAAO,EAAE,CAAC;oBACd,CAAC;gBACL,CAAC,CAAC,CAAC;gBACH,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;YAC7B,CAAC;YACD,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,WAAW,IAAI,CAAC,OAAO,CAAC,MAAM,YAAY,CAAC,CAAA;QAClE,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;OAEG;IAEU,AAAN,KAAK,CAAC,IAAI;QACb,MAAM,SAAS,GAAsC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAChF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QAErB,wDAAwD;QACxD,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,iBAAiB,CAAC,IAAI,EAAE,CAAC,CAAC;QAC/C,+CAA+C;QAC/C,MAAM,KAAK,CAAC,EAAE,CAAC,CAAC;QAEhB,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE,CAAC;YACjD,MAAM,MAAM,GAAW,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;YACzC,MAAM,QAAQ,GAAW,MAAM,MAAM,CAAC,SAAS,EAAE,CAAC;YAElD,IAAI,SAAS,EAAE,CAAC;gBACZ,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;oBAC/B,QAAQ,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;gBAC5B,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,EAAE,CAAC,IAAY,EAAE,IAAoB;QACxC,IAAI,SAAS,GAAsC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,EAAE,CAAC;YACb,SAAS,GAAG,IAAI,KAAK,EAAE,CAAC;QAC5B,CAAC;QACD,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACrB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IACxC,CAAC;IAED;;;OAGG;IACI,IAAI,CAAC,GAAQ;QAChB,MAAM,QAAQ,GAAW,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACrE,IAAI,MAAM,GAAuB,SAAS,CAAC;QAC3C,GAAG,CAAC;YACA,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAChC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC;QAC/B,CAAC,QAAQ,CAAC,MAAM,EAAE;QAElB,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,OAAO,CAAC,GAAQ;QACnB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAChC,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5B,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,EAAU,EAAE,GAAQ;QAC9B,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC;YACnB,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QACtC,CAAC;IACL,CAAC;CACJ;AAlOW;IADP,MAAM;;0CACc;AAGb;IADP,MAAM,CAAC,yBAAyB,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,CAAC;;8CACN;AAwJjC;IADZ,OAAO;;;;sCAoBP"}

package/dist/lib/threads/ThreadWorker.js

@@ -0,0 +1,25 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+/**
+ * Describes the types of messages passed between the parent thread pool manager and a worker thread.
+ */
+export var WorkerMessageType;
+(function (WorkerMessageType) {
+    WorkerMessageType["ERROR"] = "_WorkerError";
+    WorkerMessageType["LOG"] = "_WorkerLog";
+    WorkerMessageType["ONLINE"] = "_WorkerOnline";
+    WorkerMessageType["STOP"] = "_StopWorker";
+})(WorkerMessageType || (WorkerMessageType = {}));
+/**
+ * Provides a simple abstract interface for creating thread workers when using the `ThreadPool` system.
+ *
+ * @author Jean-Philippe Steinmetz
+ */
+export class ThreadWorker {
+    logger;
+    constructor(logger) {
+        this.logger = logger;
+    }
+}
+//# sourceMappingURL=ThreadWorker.js.map

package/dist/lib/threads/ThreadWorker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThreadWorker.js","sourceRoot":"","sources":["../../../src/threads/ThreadWorker.ts"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E;;GAEG;AACH,MAAM,CAAN,IAAY,iBAKX;AALD,WAAY,iBAAiB;IACzB,2CAAsB,CAAA;IACtB,uCAAkB,CAAA;IAClB,6CAAwB,CAAA;IACxB,yCAAoB,CAAA;AACxB,CAAC,EALW,iBAAiB,KAAjB,iBAAiB,QAK5B;AAYD;;;;GAIG;AACH,MAAM,OAAgB,YAAY;IACpB,MAAM,CAAM;IAEtB,YAAY,MAAW;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACzB,CAAC;CAkBJ"}

package/dist/lib/threads/ThreadWorkerEntry.js

@@ -0,0 +1,77 @@
+///////////////////////////////////////////////////////////////////////////////
+// Copyright (C) 2020-2026 Jean-Philippe Steinmetz
+///////////////////////////////////////////////////////////////////////////////
+const { parentPort, workerData } = require("worker_threads");
+const Logger = require("./ThreadLogger");
+const logger = new Logger();
+logger.debug(`Starting ThreadWorkerEntry...`);
+logger.debug(`WorkerData: ${JSON.stringify(workerData)}`);
+// Register for parent messages
+if (workerData) {
+    let worker = null;
+    try {
+        // Load the TypeScript environment if enabled
+        if (workerData.allowTs) {
+            require("ts-node").register();
+        }
+        // Import the worker class and initialize
+        logger.debug(`Loading worker: ${workerData.worker}`);
+        const mod = require(workerData.worker);
+        if (typeof mod.default !== "function") {
+            throw new Error(`No default export found for worker: ${workerPath}`);
+        }
+        logger.debug(`Initializing worker...`);
+        const clazz = mod.default;
+        const args = workerData.args || [];
+        worker = new clazz(logger, ...args);
+        void worker.start();
+        parentPort.on("message", async (msg) => {
+            try {
+                switch (msg.type) {
+                    case "_StartWorker":
+                        await worker?.start();
+                        break;
+                    case "_StopWorker":
+                        logger.debug(`Stopping worker...`);
+                        await worker?.stop();
+                        process.exit(0);
+                        break;
+                    default:
+                        await worker?.onMessage(msg);
+                        break;
+                }
+            }
+            catch (error) {
+                parentPort?.postMessage({
+                    type: "_WorkerError",
+                    data: error,
+                });
+            }
+        });
+        parentPort.on("close", async () => {
+            logger.debug(`Stopping worker...`);
+            await worker?.stop();
+            process.exit(0);
+        });
+        // Notify the coordinator that we're ready
+        parentPort?.postMessage({ type: "_WorkerOnline" });
+        logger.debug(`Worker is online!`);
+    }
+    catch (error) {
+        parentPort?.postMessage({
+            type: "_WorkerError",
+            data: error,
+        });
+        logger.error(`An error occurred initializing worker.`);
+        logger.error(error);
+    }
+}
+else {
+    logger.error(`WorkerData is missing.`);
+    parentPort?.postMessage({
+        type: "_WorkerError",
+        data: new Error("WorkerData is missing."),
+    });
+}
+export {};
+//# sourceMappingURL=ThreadWorkerEntry.js.map

package/dist/lib/threads/ThreadWorkerEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThreadWorkerEntry.js","sourceRoot":"","sources":["../../../src/threads/ThreadWorkerEntry.js"],"names":[],"mappings":"AAAA,+EAA+E;AAC/E,kDAAkD;AAClD,+EAA+E;AAC/E,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAC7D,MAAM,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAEzC,MAAM,MAAM,GAAG,IAAI,MAAM,EAAE,CAAC;AAE5B,MAAM,CAAC,KAAK,CAAC,+BAA+B,CAAC,CAAC;AAC9C,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;AAE1D,+BAA+B;AAC/B,IAAI,UAAU,EAAE,CAAC;IACb,IAAI,MAAM,GAAG,IAAI,CAAC;IAElB,IAAI,CAAC;QACD,6CAA6C;QAC7C,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;YACrB,OAAO,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC;QAClC,CAAC;QAED,yCAAyC;QACzC,MAAM,CAAC,KAAK,CAAC,mBAAmB,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QACrD,MAAM,GAAG,GAAG,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACvC,IAAI,OAAO,GAAG,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,uCAAuC,UAAU,EAAE,CAAC,CAAC;QACzE,CAAC;QAED,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACvC,MAAM,KAAK,GAAG,GAAG,CAAC,OAAO,CAAC;QAC1B,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;QACnC,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;QACpC,KAAK,MAAM,CAAC,KAAK,EAAE,CAAC;QAEpB,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,GAAG,EAAE,EAAE;YACnC,IAAI,CAAC;gBACD,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC;oBACf,KAAK,cAAc;wBACf,MAAM,MAAM,EAAE,KAAK,EAAE,CAAC;wBACtB,MAAM;oBACV,KAAK,aAAa;wBACd,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;wBACnC,MAAM,MAAM,EAAE,IAAI,EAAE,CAAC;wBACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;wBAChB,MAAM;oBACV;wBACI,MAAM,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;wBAC7B,MAAM;gBACd,CAAC;YACL,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,UAAU,EAAE,WAAW,CAAC;oBACpB,IAAI,EAAE,cAAc;oBACpB,IAAI,EAAE,KAAK;iBACd,CAAC,CAAC;YACP,CAAC;QACL,CAAC,CAAC,CAAC;QACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;YACnC,MAAM,MAAM,EAAE,IAAI,EAAE,CAAC;YACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;QAEH,0CAA0C;QAC1C,UAAU,EAAE,WAAW,CAAC,EAAE,IAAI,EAAE,eAAe,EAAE,CAAC,CAAC;QACnD,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACtC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,UAAU,EAAE,WAAW,CAAC;YACpB,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,KAAK;SACd,CAAC,CAAC;QACH,MAAM,CAAC,KAAK,CAAC,wCAAwC,CAAC,CAAC;QACvD,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC;AACL,CAAC;KAAM,CAAC;IACJ,MAAM,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IACvC,UAAU,EAAE,WAAW,CAAC;QACpB,IAAI,EAAE,cAAc;QACpB,IAAI,EAAE,IAAI,KAAK,CAAC,wBAAwB,CAAC;KAC5C,CAAC,CAAC;AACP,CAAC"}

package/dist/lib/threads/index.js

@@ -0,0 +1,3 @@
+export * from "./ThreadPool.js";
+export * from "./ThreadWorker.js";
+//# sourceMappingURL=index.js.map

package/dist/lib/threads/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/threads/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC"}

package/dist/types/AlertUtils.d.ts

@@ -0,0 +1,132 @@
+import { ReadStream } from "fs";
+/**
+ * Describes the level of priority for a given alert and an importance for triaging the problem.
+ */
+export declare enum AlertPriority {
+    /** Describes an alert that affects critical operating functionality or infrastructure. */
+    Critical = "P1",
+    /** Describes an alert that affects key systems that have great impact on end-user experiences. */
+    Severe = "P2",
+    /** Describes an alert that affects basic systems that may create a poor end-user experience. */
+    Important = "P3",
+    /** Describes an alert that has no material affect on the end-user experience but with potential to escalate. */
+    Warning = "P4",
+    /** Describes an alert that has no material affect on end-user experience and no potential for escalation. */
+    Notice = "P5"
+}
+/**
+ * Describes a single system failure or other similar critical event that requires immediate attention.
+ */
+export interface Alert {
+    /** The name of the alert that uniquely identifies the report for purposes of de-duplication. */
+    alias: string;
+    /** The detailed information about the event that has occurred. */
+    description: string;
+    /** A key-value map of custom information about the alert. */
+    details?: any;
+    /** Used to specify a category or problem domain for filtering. */
+    entity?: string;
+    /** The basic summary of the alert that describes the event. */
+    message: string;
+    /** Additional detail about the event. */
+    note?: string;
+    /** The priority level of the alert. */
+    priority: AlertPriority;
+    /** The source of the alert. Can be a pod/service name, IP address or other unique identifier. */
+    source: string;
+    /** A list of unique tags to associate with the event. */
+    tags?: string[];
+}
+/**
+ * Describes a single attachment that can be added to an alert.
+ */
+export interface AlertAttachment {
+    /** The content-type of the attachment. */
+    contentType: string;
+    /** The contents of the attachment. */
+    data: Buffer | ReadStream;
+    /** The name of the attachment. */
+    filename: string;
+    /** The size of the attachment. */
+    size?: number;
+}
+/**
+ * Describes a request to close an alert.
+ */
+export interface AlertClose {
+    /** Display name of the request source. */
+    source?: string;
+    /** Additional alert note to add. */
+    note?: string;
+}
+/**
+ * The set of configuration options to pass to AlertUtils when creating an instance.
+ */
+export interface AlertUtilsOptions {
+    /** The value of the Authorization header to apply to all outgoing HTTP requests. */
+    auth: string;
+    /** The full url of the REST API service that alerts will be sent to. */
+    serviceUrl: string;
+    /** The logging utility to use. */
+    logger?: any;
+}
+/**
+ * Describes the alert attachment options to use when creating an alert.
+ */
+export interface AlertUtilsAttachmentOptions {
+    /** The attachment files to upload with the alert. */
+    files: AlertAttachment[];
+    /** The name of the index file when the attachment is a zip file. */
+    indexFile?: string;
+    /**
+     * Set to `true` to to package all files into a single zip before being uploaded, otherwise set to `false` to
+     * upload each file individually.
+     */
+    zip?: boolean;
+}
+/**
+ * The `AlertUtils` class is used to send alerts about important system events that have occurred
+ * and require further monitoring or intervention.
+ */
+export declare class AlertUtils {
+    /** The logging utility to use. */
+    private logger;
+    /** The value of the Authorization header to apply to all outgoing HTTP requests. */
+    private auth;
+    /** The full url of the REST API service that alerts will be sent to. */
+    private serviceUrl;
+    /**
+     * Creates a new instance of `AuthUtils` with the provided defaults.
+     * @param options The configuration options to use.
+     */
+    constructor(options: AlertUtilsOptions);
+    /**
+     * Attempts to close the existing alert with the given identifier.
+     * @param id The unique identifier of the alert to close.
+     * @returns True if the operation was successful, otherwise false.
+     */
+    close(id: string, data?: AlertClose): Promise<boolean>;
+    /**
+     * Attempts to retrieve the existing alert with the given identifier.
+     * @param id The unique identifier of the alert to retrieve.
+     * @returns The retrieved alert if successful, otherwise `null`.
+     */
+    get(id: string): Promise<Alert | null>;
+    /**
+     * Sends the provided alert to the configured monitoring service.
+     *
+     * @param alert The alert to send.
+     * @param vars A map of vars to perform replacement on for the alert's various properties.
+     * @param attachments The attachments to upload along with the alert.
+     * @returns The unique identifier of the created alert if the operation was successful, otherwise `null`.
+     */
+    send(alert: Alert, vars?: any, attachments?: AlertUtilsAttachmentOptions): Promise<string | null>;
+    /**
+     * Uploads a single attachment to the alert with the given unique identifier.
+     * @param id The unique identifier of the alert to add an attachment for.
+     * @param attachment The file to upload as an attachment.
+     * @param indexFile Sets the indexFile parameter of the request.
+     * @returns True if the operation was successful, otherwise false.
+     */
+    addAttachment(id: string, attachment: AlertAttachment, indexFile?: string): Promise<boolean>;
+}

package/dist/types/ApiError.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Describes an error that originates from a API service. This class extends the standard `Error` class to include
+ * a unique code that can be used to trace an error to source code as well as the HTTP response status returned with
+ * the error.
+ */
+export declare class ApiError extends Error {
+    /** The unique code of the error. */
+    code: string;
+    /** The HTTP status associated with the error. */
+    status: number;
+    ApiMessageTemplate(message: string | undefined, templateVariables?: any): string;
+    constructor(code: string, status: number, message?: string, templateVariables?: any);
+}