@queuedash/sdk 0.1.0 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # @queuedash/sdk
 
-Official SDK for QueueDash - Real-time monitoring for Bull, BullMQ, and Bee-Queue.
+Official SDK for Queuedash - Real-time monitoring for BullMQ, Bull, and Bee-Queue.
 
 ## Installation
 
@@ -14,69 +14,75 @@ yarn add @queuedash/sdk
 
 ## Quick Start
 
+The SDK auto-detects your queue library (BullMQ, Bull, or Bee-Queue) - just use `attach()`:
+
 ### BullMQ
 
 ```typescript
 import { Queue } from "bullmq";
-import { QueueDashClient, attachToBullMQ } from "@queuedash/sdk";
+import { Queuedash } from "@queuedash/sdk";
+
+const qd = new Queuedash({ apiKey: process.env.QUEUEDASH_API_KEY });
 
-// Create your queue
 const myQueue = new Queue("my-queue", {
   connection: { host: "localhost", port: 6379 },
 });
 
-// Initialize QueueDash client
-const queueDash = new QueueDashClient({
-  apiKey: process.env.QUEUEDASH_API_KEY,
-});
-
-// Attach to your queue - that's it!
-attachToBullMQ(myQueue, queueDash);
+qd.attach(myQueue);
 
-// Jobs are now automatically synced to QueueDash
+// Jobs are now automatically synced to Queuedash
 ```
 
 ### Bull
 
 ```typescript
 import Queue from "bull";
-import { QueueDashClient, attachToBull } from "@queuedash/sdk";
+import { Queuedash } from "@queuedash/sdk";
 
-const myQueue = new Queue("my-queue", {
-  redis: { host: "localhost", port: 6379 },
-});
+const qd = new Queuedash({ apiKey: process.env.QUEUEDASH_API_KEY });
 
-const queueDash = new QueueDashClient({
-  apiKey: process.env.QUEUEDASH_API_KEY,
-});
+const myQueue = new Queue("my-queue", "redis://localhost:6379");
 
-attachToBull(myQueue, queueDash);
+qd.attach(myQueue);
 ```
 
 ### Bee-Queue
 
 ```typescript
 import Queue from "bee-queue";
-import { QueueDashClient, attachToBeeQueue } from "@queuedash/sdk";
+import { Queuedash } from "@queuedash/sdk";
+
+const qd = new Queuedash({ apiKey: process.env.QUEUEDASH_API_KEY });
 
 const myQueue = new Queue("my-queue", {
   redis: { host: "localhost", port: 6379 },
 });
 
-const queueDash = new QueueDashClient({
-  apiKey: process.env.QUEUEDASH_API_KEY,
-});
+qd.attach(myQueue);
+```
 
-attachToBeeQueue(myQueue, queueDash);
+### Multiple Queues
+
+```typescript
+import { Queue } from "bullmq";
+import { Queuedash } from "@queuedash/sdk";
+
+const qd = new Queuedash({ apiKey: process.env.QUEUEDASH_API_KEY });
+
+const connection = { host: "localhost", port: 6379 };
+
+qd.attach(new Queue("emails", { connection }));
+qd.attach(new Queue("reports", { connection }));
+qd.attach(new Queue("notifications", { connection }));
 ```
 
 ## Configuration
 
 ### API Key
 
-Get your API key from [QueueDash](https://queuedash.com):
+Get your API key from [Queuedash](https://queuedash.com):
 
-1. Navigate to your environment settings
+1. Navigate to your project
 2. Click "API Keys"
 3. Generate a new API key
 
@@ -85,34 +91,37 @@ Get your API key from [QueueDash](https://queuedash.com):
 QUEUEDASH_API_KEY=sk_live_...
 ```
 
-### Advanced Options
+### Options
 
 ```typescript
-interface QueueDashClientOptions {
-  // Required: Your API key from QueueDash
-  apiKey: string;
+const qd = new Queuedash({
+  // Required: Your API key from Queuedash
+  apiKey: string,
+
+  // Optional: Custom API URL (default: https://api.queuedash.com)
+  baseUrl?: string,
 
-  // Optional: Batch size for syncing jobs (defaults to 50)
-  batchSize?: number;
+  // Optional: Batch size for syncing jobs (default: 50)
+  batchSize?: number,
 
-  // Optional: Flush interval in milliseconds (defaults to 100)
-  flushInterval?: number;
+  // Optional: Flush interval in milliseconds (default: 100)
+  flushInterval?: number,
 
-  // Optional: Max retry attempts with exponential backoff (defaults to 5)
-  maxRetries?: number;
+  // Optional: Max retry attempts with exponential backoff (default: 5)
+  maxRetries?: number,
 
-  // Optional: Request timeout in milliseconds (defaults to 30000)
-  requestTimeout?: number;
+  // Optional: Request timeout in milliseconds (default: 30000)
+  requestTimeout?: number,
 
-  // Optional: Max jobs to queue in memory (defaults to 10000)
-  maxQueueSize?: number;
+  // Optional: Max jobs to queue in memory (default: 10000)
+  maxQueueSize?: number,
 
   // Optional: Error handler called on critical failures
-  onError?: (error: Error) => void;
-}
+  onError?: (error: Error) => void,
+});
 ```
 
-### Reliability & Robustness
+## Reliability & Robustness
 
 The SDK is production-ready with multiple layers of protection:
 
@@ -137,7 +146,7 @@ The SDK is production-ready with multiple layers of protection:
 **Graceful Shutdown**
 
 - SIGTERM/SIGINT handlers flush pending jobs before exit
-- Warns if jobs remain unsynced on crash
+- Call `await qd.stop()` to manually stop
 - No jobs lost during normal shutdown
 
 **Request Safety**
@@ -148,16 +157,13 @@ The SDK is production-ready with multiple layers of protection:
 
 ## Features
 
+- **Auto-detection**: Works with BullMQ, Bull, and Bee-Queue automatically
 - **Real-time sync**: Jobs are synced as events happen
 - **Smart batching**: Events are automatically batched for performance
 - **Auto-retry**: Failed syncs are automatically retried
 - **Zero config**: Works out of the box with sensible defaults
 - **TypeScript**: Full TypeScript support
 
-## How It Works
-
-The SDK automatically syncs your queue jobs to QueueDash's SaaS platform at `api.queuedash.com`. Just provide your API key and you're done - no additional configuration needed!
-
 ## License
 
 MIT

package/dist/client.d.ts

@@ -1,5 +1,9 @@
-import { JobData, QueueDashClientOptions } from "./types";
-export declare class QueueDashClient {
+import { JobData, QueuedashOptions } from "./types";
+type BullMQQueueEvents = {
+    on: (event: string, handler: (...args: any[]) => void) => any;
+    close: () => Promise<void>;
+};
+export declare class Queuedash {
     private apiKey;
     private apiUrl;
     private batchSize;
@@ -16,9 +20,44 @@ export declare class QueueDashClient {
     private circuitBreakerOpen;
     private circuitBreakerResetTimer?;
     private syncingJobIds;
-    constructor(options: QueueDashClientOptions);
+    private managedQueueEvents;
+    private attachedQueues;
+    constructor(options: QueuedashOptions);
     /**
-     * Queue a job for syncing
+     * Attach a queue or worker for monitoring.
+     * Auto-detects the queue library (BullMQ, Bull, Bee-Queue).
+     *
+     * @example
+     * ```ts
+     * const qd = new Queuedash({ apiKey: 'qd_...' });
+     *
+     * // BullMQ - we create QueueEvents internally
+     * qd.attach(myBullMQQueue);
+     *
+     * // Bull
+     * qd.attach(myBullQueue);
+     *
+     * // Bee-Queue
+     * qd.attach(myBeeQueue);
+     * ```
+     */
+    attach(resource: unknown, options?: {
+        events?: BullMQQueueEvents;
+    }): this;
+    private detectType;
+    private attachBullMQ;
+    private attachBullMQWorker;
+    private attachBull;
+    private attachBee;
+    private extractBullMQJobData;
+    private extractBullJobData;
+    private extractBeeJobData;
+    /**
+     * Delete a job (soft delete in Queuedash)
+     */
+    deleteJob(jobId: string, queueName: string): Promise<void>;
+    /**
+     * Queue a job for syncing (internal use)
      */
     syncJob(job: JobData): void;
     /**
@@ -26,12 +65,13 @@ export declare class QueueDashClient {
      */
     flush(): Promise<void>;
     private openCircuitBreaker;
-    private logger;
+    private log;
     /**
-     * Stop the client and flush remaining jobs
+     * Stop the client, close managed resources, and flush remaining jobs
      */
     stop(): Promise<void>;
     private startFlushTimer;
     private setupShutdownHandlers;
 }
+export {};
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,sBAAsB,EAAgB,MAAM,SAAS,CAAC;AAExE,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAyB;IAEzC,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,UAAU,CAAC,CAAiB;IACpC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,sBAAsB,CAAK;IACnC,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,wBAAwB,CAAC,CAAiB;IAClD,OAAO,CAAC,aAAa,CAAqB;gBAE9B,OAAO,EAAE,sBAAsB;IA0B3C;;OAEG;IACI,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IA8BlC;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAyGnC,OAAO,CAAC,kBAAkB;IAoB1B,OAAO,CAAC,MAAM;IASd;;OAEG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAUlC,OAAO,CAAC,eAAe;IAavB,OAAO,CAAC,qBAAqB;CAkB9B"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,gBAAgB,EAAgB,MAAM,SAAS,CAAC;AAelE,KAAK,iBAAiB,GAAG;IACvB,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,KAAK,GAAG,CAAC;IAC9D,KAAK,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5B,CAAC;AAcF,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,OAAO,CAAC,CAAyB;IAEzC,OAAO,CAAC,QAAQ,CAAiB;IACjC,OAAO,CAAC,UAAU,CAAC,CAAiB;IACpC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAK;IACvB,OAAO,CAAC,sBAAsB,CAAK;IACnC,OAAO,CAAC,kBAAkB,CAAS;IACnC,OAAO,CAAC,wBAAwB,CAAC,CAAiB;IAClD,OAAO,CAAC,aAAa,CAAqB;IAG1C,OAAO,CAAC,kBAAkB,CAA2B;IACrD,OAAO,CAAC,cAAc,CAAqB;gBAE/B,OAAO,EAAE,gBAAgB;IAsBrC;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,iBAAiB,CAAA;KAAE,GAAG,IAAI;IAyBzE,OAAO,CAAC,UAAU;YAqCJ,YAAY;IAqE1B,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,UAAU;IAiClB,OAAO,CAAC,SAAS;IA+BjB,OAAO,CAAC,oBAAoB;IAmB5B,OAAO,CAAC,kBAAkB;IAmB1B,OAAO,CAAC,iBAAiB;IAiBzB;;OAEG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAqChE;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAyB3B;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAgG5B,OAAO,CAAC,kBAAkB;IAmB1B,OAAO,CAAC,GAAG;IAQX;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAoB3B,OAAO,CAAC,eAAe;IAYvB,OAAO,CAAC,qBAAqB;CAiB9B"}