@zintrust/queue-monitor 0.1.27

package/README.md

@@ -0,0 +1,38 @@
+# @zintrust/queue-monitor
+
+Queue monitoring scaffolding for ZinTrust.
+
+- Docs: https://zintrust.com/queue
+
+## Install
+
+```bash
+npm i @zintrust/queue-monitor
+```
+
+## Usage
+
+```ts
+import { QueueMonitor, type IRouter } from '@zintrust/core';
+import { QueueMonitor as QueueMonitorPlugin } from '@zintrust/queue-monitor';
+
+const monitor = QueueMonitorPlugin.create({
+  basePath: '/queue-monitor',
+  middleware: ['auth'],
+});
+
+export function registerRoutes(router: IRouter): void {
+  monitor.registerRoutes(router);
+}
+```
+
+## When to use
+
+- ✅ Use `@zintrust/queue-monitor` if you need full queue management (enqueue + process + monitor + retry)
+- ✅✅ Use `@zintrust/queue-redis` if you only need to **enqueue jobs** and another service will process them
+
+**Note:** The monitor package can do everything queue-redis does, plus much more. So if you install `@zintrust/queue-monitor`, there's no need for `@zintrust/queue-redis`.
+
+## License
+
+This package and its dependencies are MIT licensed, permitting free commercial use.

package/dist/api/workerClient.d.ts

@@ -0,0 +1,20 @@
+type WorkerApiResponse<T> = {
+    ok: boolean;
+    error?: string;
+} & T;
+export declare const WorkerClient: Readonly<{
+    listWorkers(): Promise<string[]>;
+    getWorker(name: string): Promise<unknown>;
+    getStatus(name: string): Promise<unknown>;
+    getHealth(name: string): Promise<unknown>;
+    startWorker(name: string): Promise<WorkerApiResponse<{
+        message?: string;
+    }>>;
+    stopWorker(name: string): Promise<WorkerApiResponse<{
+        message?: string;
+    }>>;
+    restartWorker(name: string): Promise<WorkerApiResponse<{
+        message?: string;
+    }>>;
+}>;
+export {};

package/dist/api/workerClient.js

@@ -0,0 +1,45 @@
+import { ErrorFactory, Logger } from '@zintrust/core';
+import { WorkerConfig } from '../config/workerConfig';
+const requestJson = async (path, options = {}) => {
+    const baseUrl = WorkerConfig.getWorkerBaseUrl();
+    const url = `${baseUrl}${path}`;
+    const response = await fetch(url, {
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers,
+        },
+    });
+    if (!response.ok) {
+        Logger.error('Worker API request failed', { url, status: response.status });
+        throw ErrorFactory.createWorkerError(`Worker API request failed (${response.status})`);
+    }
+    return (await response.json());
+};
+export const WorkerClient = Object.freeze({
+    async listWorkers() {
+        const response = await requestJson('/api/workers');
+        return response.workers ?? [];
+    },
+    async getWorker(name) {
+        const response = await requestJson(`/api/workers/${name}`);
+        return response.worker;
+    },
+    async getStatus(name) {
+        const response = await requestJson(`/api/workers/${name}/status`);
+        return response.status;
+    },
+    async getHealth(name) {
+        const response = await requestJson(`/api/workers/${name}/health`);
+        return response.health;
+    },
+    async startWorker(name) {
+        return requestJson(`/api/workers/${name}/start`, { method: 'POST' });
+    },
+    async stopWorker(name) {
+        return requestJson(`/api/workers/${name}/stop`, { method: 'POST' });
+    },
+    async restartWorker(name) {
+        return requestJson(`/api/workers/${name}/restart`, { method: 'POST' });
+    },
+});

package/dist/build-manifest.json

@@ -0,0 +1,120 @@
+{
+  "name": "@zintrust/queue-monitor",
+  "version": "0.1.0",
+  "buildDate": "2026-01-28T12:31:01.364Z",
+  "buildEnvironment": {
+    "node": "v22.20.0",
+    "platform": "darwin",
+    "arch": "arm64"
+  },
+  "git": {
+    "commit": "2d1585bf",
+    "branch": "dev"
+  },
+  "package": {
+    "engines": {
+      "node": ">=20.0.0"
+    },
+    "dependencies": [
+      "bullmq",
+      "ioredis"
+    ],
+    "peerDependencies": [
+      "@zintrust/core"
+    ]
+  },
+  "files": {
+    "api/workerClient.d.ts": {
+      "size": 597,
+      "sha256": "1d712bfa9127aa2df4f1fbd0efbb6d84069e1888ed73aca5542a41eee865d4bb"
+    },
+    "api/workerClient.js": {
+      "size": 1626,
+      "sha256": "7a41c5e560fe5e2248e94dadf06a751c8f0c8dd04a8ef699410a668782c9c3f0"
+    },
+    "build-manifest.json": {
+      "size": 3572,
+      "sha256": "155b1749c79e6afe4075a44bf59aaa8e7997c68a4aef412dbcd23a2bdf2d42c8"
+    },
+    "config/queueMonitor.d.ts": {
+      "size": 407,
+      "sha256": "4541f47e64c8ede1bfd8fc0cb7edb76c4e885311b28b1f51c9be7639e5d87eca"
+    },
+    "config/queueMonitor.js": {
+      "size": 689,
+      "sha256": "0b95e6b65d4b6ffdd69788cdfd19e0e76400a39ad69dce018d8827a3b298e419"
+    },
+    "config/workerConfig.d.ts": {
+      "size": 86,
+      "sha256": "b669205d50c8844455a2d9b34a54f48a71118eb6ac99bad5372683ab666f5a22"
+    },
+    "config/workerConfig.js": {
+      "size": 628,
+      "sha256": "ca1c6dbaa751893f0e6b7c8a7fd41a80f7d5e8fc9aaaa4877ca12821bb25f56f"
+    },
+    "connection.d.ts": {
+      "size": 107,
+      "sha256": "653b300a25df08a2380bdc74ea38342190771386cb1847dc92802e6eef88a88f"
+    },
+    "connection.js": {
+      "size": 56,
+      "sha256": "1d4e9b5f2a03e0a3885d578276eb5c6a05c50ce4a2d84b241e68fe6ace76e7dd"
+    },
+    "dashboard-ui.d.ts": {
+      "size": 175,
+      "sha256": "b07a5a2d27f2839c693bd76a0b3060b57ec7b62e3b97b5c253bce747680f50eb"
+    },
+    "dashboard-ui.js": {
+      "size": 28875,
+      "sha256": "d7e1239f91755043102a82dbc08b092a67f23625116d5e6573cb4d1124af1af5"
+    },
+    "driver.d.ts": {
+      "size": 712,
+      "sha256": "bfb0c3c914519c0bc988ab4d5be2275da165fc4ed977c72e73f90e6dcf4b1667"
+    },
+    "driver.js": {
+      "size": 3957,
+      "sha256": "7894338fb4e1f1a5e785f50da96f165bcb32ec1155883a07068c29c0c4c09fd9"
+    },
+    "index.d.ts": {
+      "size": 1932,
+      "sha256": "e9f05b27068667aaaf31d4ab55f1ed871a53a4c0692cc0833ca288f18f662d70"
+    },
+    "index.js": {
+      "size": 10761,
+      "sha256": "db68589bff2508da316758204495a075ffc2555e391d348da2609687cca55b66"
+    },
+    "metrics.d.ts": {
+      "size": 795,
+      "sha256": "73e93750749cc70a972794a956bcb2a8127289127287893b8f1850d80e20df7d"
+    },
+    "metrics.js": {
+      "size": 2920,
+      "sha256": "b552cb906fcdec5aa2408b17815157f1aa19d409278fc68d091a77cec63e2950"
+    },
+    "routes/workers.d.ts": {
+      "size": 477,
+      "sha256": "cfcc3527c47d1a796a3ced2d4777b339dd767f7feb3ecc66c5ce0a91d8ff1bc8"
+    },
+    "routes/workers.js": {
+      "size": 895,
+      "sha256": "a2e73b5879c5f572005b0b2b2aae6e19cefaefee91c07b3a44f95703b86c4cb3"
+    },
+    "worker.d.ts": {
+      "size": 332,
+      "sha256": "97cddbc991c6e6724950090cd92f06671932ab848c16dd94a030d9fba3fbae26"
+    },
+    "worker.js": {
+      "size": 823,
+      "sha256": "fb9c348f6599d402ab656885a7c98410b396e29942e2d8e8fcbdbcf1315f6e40"
+    },
+    "workers-ui.d.ts": {
+      "size": 214,
+      "sha256": "4f5fd3bbd077d0dee2cc6c73d2c736fc52119b0d3a5f4a1878a4f3d3d3edf299"
+    },
+    "workers-ui.js": {
+      "size": 24928,
+      "sha256": "ba2c5cbf890fe875cc5336c76bd29b146089bc8ba3a70de4a2c383f395f9be73"
+    }
+  }
+}

package/dist/config/queueMonitor.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Queue Monitor Configuration (default override)
+ *
+ * Keep this file declarative:
+ * - Core owns env parsing/default logic.
+ * - Projects can override config by editing values below.
+ */
+declare const _default: {
+    enabled: boolean;
+    basePath: string;
+    middleware: string[];
+    redis: {
+        host: string;
+        port: number;
+        password: string;
+    };
+};
+export default _default;

package/dist/config/queueMonitor.js

@@ -0,0 +1,21 @@
+import { Env } from '@zintrust/core';
+/**
+ * Queue Monitor Configuration (default override)
+ *
+ * Keep this file declarative:
+ * - Core owns env parsing/default logic.
+ * - Projects can override config by editing values below.
+ */
+export default {
+    enabled: Env.getBool('QUEUE_MONITOR_ENABLED', true),
+    basePath: Env.get('QUEUE_MONITOR_BASE_PATH', '/queue-monitor'),
+    middleware: Env.get('QUEUE_MONITOR_MIDDLEWARE', 'auth')
+        .split(',')
+        .map((m) => m.trim())
+        .filter((m) => m.length > 0),
+    redis: {
+        host: Env.get('REDIS_HOST', 'localhost'),
+        port: Env.getInt('REDIS_PORT', 6379),
+        password: Env.get('REDIS_PASSWORD', ''),
+    },
+};

package/dist/config/workerConfig.d.ts

@@ -0,0 +1,3 @@
+export declare const WorkerConfig: Readonly<{
+    getWorkerBaseUrl: () => string;
+}>;

package/dist/config/workerConfig.js

@@ -0,0 +1,19 @@
+import { Env } from '@zintrust/core';
+const normalizeBaseUrl = (value) => {
+    let end = value.length;
+    while (end > 0 && value.charAt(end - 1) === '/') {
+        end--;
+    }
+    return value.slice(0, end);
+};
+const withHttpScheme = (value) => value.startsWith('http://') || value.startsWith('https://') ? value : `http://${value}`;
+const resolveWorkerApiUrl = () => {
+    const workerApiUrl = Env.get('WORKER_API_URL');
+    if (workerApiUrl) {
+        return normalizeBaseUrl(withHttpScheme(workerApiUrl));
+    }
+    return '';
+};
+export const WorkerConfig = Object.freeze({
+    getWorkerBaseUrl: resolveWorkerApiUrl,
+});

package/dist/connection.d.ts

@@ -0,0 +1,2 @@
+export { createRedisConnection } from '@zintrust/core';
+export type { RedisConfig } from '@zintrust/core';

package/dist/connection.js

@@ -0,0 +1 @@
+export { createRedisConnection } from '@zintrust/core';

package/dist/dashboard-ui.d.ts

@@ -0,0 +1,5 @@
+export type DashboardUiOptions = {
+    autoRefresh: boolean;
+    refreshIntervalMs: number;
+};
+export declare const getDashboardHtml: (options: DashboardUiOptions) => string;