@queuedash/sdk 0.2.0 → 1.0.0

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-export { QueueDashClient } from "./client";
-export { attachToBullMQ } from "./integrations/bullmq";
-export { attachToBull } from "./integrations/bull";
-export { attachToBeeQueue } from "./integrations/bee";
-export type { QueueDashClientOptions, JobData, SyncResponse } from "./types";
+export { Queuedash } from "./client";
+export type { QueuedashOptions, JobData, SyncResponse } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAC3C,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,YAAY,EAAE,sBAAsB,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AACrC,YAAY,EAAE,gBAAgB,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,11 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachToBeeQueue = exports.attachToBull = exports.attachToBullMQ = exports.QueueDashClient = void 0;
+exports.Queuedash = void 0;
 var client_1 = require("./client");
-Object.defineProperty(exports, "QueueDashClient", { enumerable: true, get: function () { return client_1.QueueDashClient; } });
-var bullmq_1 = require("./integrations/bullmq");
-Object.defineProperty(exports, "attachToBullMQ", { enumerable: true, get: function () { return bullmq_1.attachToBullMQ; } });
-var bull_1 = require("./integrations/bull");
-Object.defineProperty(exports, "attachToBull", { enumerable: true, get: function () { return bull_1.attachToBull; } });
-var bee_1 = require("./integrations/bee");
-Object.defineProperty(exports, "attachToBeeQueue", { enumerable: true, get: function () { return bee_1.attachToBeeQueue; } });
+Object.defineProperty(exports, "Queuedash", { enumerable: true, get: function () { return client_1.Queuedash; } });

package/dist/types.d.ts

@@ -1,13 +1,20 @@
-export interface QueueDashClientOptions {
+export interface QueuedashOptions {
+    /** Your Queuedash API key */
     apiKey: string;
+    /** Override the API URL (defaults to https://api.queuedash.com in production) */
+    baseUrl?: string;
+    /** Number of jobs to batch before syncing (default: 50) */
     batchSize?: number;
+    /** How often to flush batched jobs in ms (default: 100) */
     flushInterval?: number;
+    /** Max retry attempts for failed syncs (default: 5) */
     maxRetries?: number;
+    /** HTTP request timeout in ms (default: 30000) */
     requestTimeout?: number;
+    /** Max jobs to queue in memory (default: 10000) */
     maxQueueSize?: number;
+    /** Custom error handler */
     onError?: (error: Error) => void;
-    /** @internal - Not for public use. Override API URL for staging environments only. */
-    __dangerouslyOverrideApiUrl?: string;
 }
 export interface JobData {
     jobId: string;

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,sBAAsB;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;IACjC,sFAAsF;IACtF,2BAA2B,CAAC,EAAE,MAAM,CAAC;CACtC;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,6BAA6B;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,iFAAiF;IACjF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,2DAA2D;IAC3D,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kDAAkD;IAClD,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,mDAAmD;IACnD,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,2BAA2B;IAC3B,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAC;CAClC;AAED,MAAM,WAAW,OAAO;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,EAAE,IAAI,CAAC;IACd,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@queuedash/sdk",
-  "version": "0.2.0",
-  "description": "QueueDash SDK for real-time queue monitoring",
+  "version": "1.0.0",
+  "description": "Queuedash SDK for real-time queue monitoring",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
@@ -13,15 +13,16 @@
     "bullmq",
     "bull",
     "bee-queue",
+    "groupmq",
     "monitoring",
     "dashboard"
   ],
-  "author": "QueueDash",
+  "author": "Alex Budure",
   "license": "MIT",
   "peerDependencies": {
-    "bullmq": ">=5.0.0",
+    "bee-queue": ">=1.0.0",
     "bull": ">=4.0.0",
-    "bee-queue": ">=1.0.0"
+    "bullmq": ">=5.0.0"
   },
   "peerDependenciesMeta": {
     "bullmq": {
@@ -35,10 +36,24 @@
     }
   },
   "devDependencies": {
-    "@types/node": "^20.0.0",
+    "@changesets/changelog-github": "^0.5.1",
+    "@changesets/cli": "^2.29.7",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.14.0",
+    "husky": "^9.1.7",
+    "jest": "^29.7.0",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.7.1",
+    "ts-jest": "^29.2.5",
     "typescript": "^5.9.3"
   },
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "format": "prettier --write \"**/*.{ts,tsx,js,jsx,json,md}\"",
+    "release": "pnpm build && changeset publish",
+    "preinstall": "npx only-allow pnpm"
   }
 }

package/dist/integrations/bee.d.ts

@@ -1,8 +0,0 @@
-import { QueueDashClient } from "../client";
-type BeeQueue = any;
-/**
- * Attach QueueDash monitoring to a Bee-Queue
- */
-export declare function attachToBeeQueue(queue: BeeQueue, client: QueueDashClient): void;
-export {};
-//# sourceMappingURL=bee.d.ts.map

package/dist/integrations/bee.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bee.d.ts","sourceRoot":"","sources":["../../src/integrations/bee.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAG5C,KAAK,QAAQ,GAAG,GAAG,CAAC;AAGpB;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,QAAQ,EACf,MAAM,EAAE,eAAe,GACtB,IAAI,CAwCN"}

package/dist/integrations/bee.js

@@ -1,43 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachToBeeQueue = attachToBeeQueue;
-/**
- * Attach QueueDash monitoring to a Bee-Queue
- */
-function attachToBeeQueue(queue, client) {
-    const queueName = queue.name;
-    const extractJobData = (job) => {
-        return {
-            jobId: String(job.id),
-            name: "default", // Bee-Queue doesn't have job names
-            queueName,
-            data: job.data,
-            opts: job.options || {},
-            addedAt: job.options?.timestamp
-                ? new Date(job.options.timestamp)
-                : new Date(),
-            processedAt: null,
-            finishedAt: null,
-            priority: null,
-            delay: job.options?.delay,
-        };
-    };
-    // Listen to queue events
-    queue.on("succeeded", (job) => {
-        const jobData = extractJobData(job);
-        jobData.finishedAt = new Date();
-        client.syncJob(jobData);
-    });
-    queue.on("failed", (job, err) => {
-        const jobData = extractJobData(job);
-        jobData.failedReason = err.message;
-        jobData.stacktrace = err.stack ? [err.stack] : undefined;
-        jobData.finishedAt = new Date();
-        client.syncJob(jobData);
-    });
-    queue.on("retrying", (job) => {
-        const jobData = extractJobData(job);
-        jobData.retriedAt = new Date();
-        client.syncJob(jobData);
-    });
-}

package/dist/integrations/bull.d.ts

@@ -1,7 +0,0 @@
-import { QueueDashClient } from "../client";
-import { type Queue as BullQueue } from "bull";
-/**
- * Attach QueueDash monitoring to a Bull queue
- */
-export declare function attachToBull(queue: BullQueue, client: QueueDashClient): void;
-//# sourceMappingURL=bull.d.ts.map

package/dist/integrations/bull.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bull.d.ts","sourceRoot":"","sources":["../../src/integrations/bull.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EAAE,KAAK,KAAK,IAAI,SAAS,EAAuB,MAAM,MAAM,CAAC;AAEpE;;GAEG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,eAAe,GAAG,IAAI,CA6C5E"}

package/dist/integrations/bull.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachToBull = attachToBull;
-/**
- * Attach QueueDash monitoring to a Bull queue
- */
-function attachToBull(queue, client) {
-    const queueName = queue.name;
-    const extractJobData = (job) => {
-        return {
-            jobId: job.id,
-            name: job.name || "default",
-            queueName,
-            data: job.data,
-            // @ts-expect-error
-            opts: job.opts,
-            addedAt: new Date(job.timestamp),
-            processedAt: job.processedOn ? new Date(job.processedOn) : null,
-            finishedAt: job.finishedOn ? new Date(job.finishedOn) : null,
-            failedReason: job.failedReason,
-            stacktrace: job.stacktrace,
-            priority: job.opts?.priority,
-            delay: job.opts?.delay,
-            timestamp: job.timestamp,
-            progress: job.progress(),
-        };
-    };
-    // Listen to queue events
-    queue.on("global:completed", (job) => {
-        client.syncJob(extractJobData(job));
-    });
-    queue.on("global:failed", (job) => {
-        if (job) {
-            client.syncJob(extractJobData(job));
-        }
-    });
-    queue.on("active", (job) => {
-        client.syncJob(extractJobData(job));
-    });
-    queue.on("progress", (job) => {
-        client.syncJob(extractJobData(job));
-    });
-    queue.on("removed", (job) => {
-        client.syncJob(extractJobData(job));
-    });
-}

package/dist/integrations/bullmq.d.ts

@@ -1,7 +0,0 @@
-import { QueueDashClient } from "../client";
-import { type Queue as BullMQQueue, type QueueEvents } from "bullmq";
-/**
- * Attach QueueDash monitoring to a BullMQ queue
- */
-export declare function attachToBullMQ(queue: BullMQQueue, events: QueueEvents, client: QueueDashClient): void;
-//# sourceMappingURL=bullmq.d.ts.map

package/dist/integrations/bullmq.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bullmq.d.ts","sourceRoot":"","sources":["../../src/integrations/bullmq.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAE5C,OAAO,EACL,KAAK,KAAK,IAAI,WAAW,EAEzB,KAAK,WAAW,EACjB,MAAM,QAAQ,CAAC;AAEhB;;GAEG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,WAAW,EACnB,MAAM,EAAE,eAAe,GACtB,IAAI,CA2CN"}

package/dist/integrations/bullmq.js

@@ -1,47 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.attachToBullMQ = attachToBullMQ;
-/**
- * Attach QueueDash monitoring to a BullMQ queue
- */
-function attachToBullMQ(queue, events, client) {
-    const queueName = queue.name;
-    const extractJobData = (job) => {
-        return {
-            jobId: job.id,
-            name: job.name,
-            queueName,
-            data: job.data,
-            // @ts-expect-error
-            opts: job.opts,
-            addedAt: new Date(job.timestamp),
-            processedAt: job.processedOn ? new Date(job.processedOn) : null,
-            finishedAt: job.finishedOn ? new Date(job.finishedOn) : null,
-            failedReason: job.failedReason,
-            stacktrace: job.stacktrace,
-            priority: job.opts?.priority,
-            delay: job.opts?.delay,
-            timestamp: job.timestamp,
-            progress: typeof job.progress === "number" ? job.progress : null,
-        };
-    };
-    const syncJobById = (jobId) => {
-        queue.getJob(jobId).then((job) => {
-            if (job) {
-                client.syncJob(extractJobData(job));
-            }
-        });
-    };
-    events.on("waiting", async ({ jobId }) => syncJobById(jobId));
-    events.on("progress", async ({ jobId }) => syncJobById(jobId));
-    events.on("completed", async ({ jobId }) => syncJobById(jobId));
-    events.on("failed", async ({ jobId }) => syncJobById(jobId));
-    events.on("waiting-children", async ({ jobId }) => syncJobById(jobId));
-    events.on("added", async ({ jobId }) => syncJobById(jobId));
-    events.on("active", async ({ jobId }) => syncJobById(jobId));
-    events.on("delayed", async ({ jobId }) => syncJobById(jobId));
-    events.on("deduplicated", async ({ jobId }) => syncJobById(jobId));
-    events.on("removed", async ({ jobId }) => client.deleteJob(jobId, queueName));
-    events.on("stalled", async ({ jobId }) => syncJobById(jobId));
-    events.on("retries-exhausted", async ({ jobId }) => syncJobById(jobId));
-}