worker-que 1.0.0

package/SSL.md

@@ -0,0 +1,516 @@
+# SSL/TLS Configuration Guide
+
+This guide explains how to configure SSL/TLS connections to PostgreSQL with client certificates.
+
+## Table of Contents
+
+- [Basic SSL Connection](#basic-ssl-connection)
+- [SSL with Client Certificates](#ssl-with-client-certificates)
+- [Certificate File Formats](#certificate-file-formats)
+- [Environment Variables](#environment-variables)
+- [Common SSL Modes](#common-ssl-modes)
+- [Troubleshooting](#troubleshooting)
+
+## Basic SSL Connection
+
+### Simple SSL (sslmode=require)
+
+```typescript
+import { Client } from 'que-ts';
+
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true, // Verify server certificate
+  }
+});
+```
+
+### SSL without Certificate Verification (Development Only)
+
+⚠️ **WARNING:** Only use this in development environments!
+
+```typescript
+const client = new Client({
+  host: 'localhost',
+  port: 5432,
+  database: 'test_db',
+  user: 'test_user',
+  password: 'test_password',
+  ssl: {
+    rejectUnauthorized: false, // Skip certificate verification
+  }
+});
+```
+
+## SSL with Client Certificates
+
+### Using Certificate Files
+
+```typescript
+import { Client } from 'que-ts';
+import * as fs from 'fs';
+import * as path from 'path';
+
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    // Verify the server's certificate
+    rejectUnauthorized: true,
+    
+    // Client certificate (.crt or .pem)
+    cert: fs.readFileSync(path.join(__dirname, 'certs/client-cert.pem')),
+    
+    // Client private key (.key)
+    key: fs.readFileSync(path.join(__dirname, 'certs/client-key.pem')),
+    
+    // CA certificate to verify server
+    ca: fs.readFileSync(path.join(__dirname, 'certs/ca-cert.pem')),
+  }
+});
+```
+
+### Using Certificate Paths (Alternative)
+
+You can also pass file paths directly if using string buffers:
+
+```typescript
+import * as fs from 'fs';
+
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    cert: fs.readFileSync('/path/to/client-cert.pem'),
+    key: fs.readFileSync('/path/to/client-key.pem'),
+    ca: fs.readFileSync('/path/to/ca-cert.pem'),
+  }
+});
+```
+
+### Encrypted Private Key
+
+If your private key is password-protected:
+
+```typescript
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    cert: fs.readFileSync('./certs/client-cert.pem'),
+    key: fs.readFileSync('./certs/client-key-encrypted.pem'),
+    ca: fs.readFileSync('./certs/ca-cert.pem'),
+    passphrase: 'your-private-key-passphrase', // Passphrase for the key
+  }
+});
+```
+
+### Multiple CA Certificates
+
+If you need to trust multiple certificate authorities:
+
+```typescript
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    cert: fs.readFileSync('./certs/client-cert.pem'),
+    key: fs.readFileSync('./certs/client-key.pem'),
+    ca: [
+      fs.readFileSync('./certs/ca-cert-1.pem'),
+      fs.readFileSync('./certs/ca-cert-2.pem'),
+    ],
+  }
+});
+```
+
+## Certificate File Formats
+
+### Supported Formats
+
+- **PEM** (`.pem`, `.crt`, `.cer`, `.key`) - Most common, text-based format
+- **DER** (`.der`) - Binary format (less common)
+
+### PEM File Structure
+
+A PEM file looks like this:
+
+```
+-----BEGIN CERTIFICATE-----
+MIIDXTCCAkWgAwIBAgIJAKZ...
+...
+-----END CERTIFICATE-----
+```
+
+### Typical Certificate Files
+
+| File | Description | Example Name |
+|------|-------------|--------------|
+| CA Certificate | Certificate Authority (verifies server) | `ca-cert.pem`, `root.crt` |
+| Client Certificate | Your client certificate | `client-cert.pem`, `postgresql.crt` |
+| Client Key | Your private key | `client-key.pem`, `postgresql.key` |
+
+### Obtaining Certificates
+
+**From PostgreSQL Server:**
+```bash
+# Server certificates are usually in:
+/var/lib/postgresql/data/
+# Or
+/etc/postgresql/<version>/main/
+```
+
+**Generate Self-Signed Certificates (Development):**
+```bash
+# Generate CA key and certificate
+openssl req -new -x509 -days 365 -nodes -text \
+  -out ca-cert.pem -keyout ca-key.pem
+
+# Generate server key and certificate request
+openssl req -new -nodes -text -out server.csr -keyout server-key.pem
+
+# Sign server certificate with CA
+openssl x509 -req -in server.csr -text -days 365 \
+  -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial \
+  -out server-cert.pem
+
+# Generate client key and certificate request
+openssl req -new -nodes -text -out client.csr -keyout client-key.pem
+
+# Sign client certificate with CA
+openssl x509 -req -in client.csr -text -days 365 \
+  -CA ca-cert.pem -CAkey ca-key.pem -CAcreateserial \
+  -out client-cert.pem
+```
+
+## Environment Variables
+
+### Recommended Production Setup
+
+Create a `.env` file:
+
+```bash
+# Database connection
+DB_HOST=your-database-host.com
+DB_PORT=5432
+DB_NAME=your_database
+DB_USER=your_user
+DB_PASSWORD=your_password
+
+# SSL Configuration
+DB_SSL_ENABLED=true
+DB_SSL_REJECT_UNAUTHORIZED=true
+DB_SSL_CERT=/path/to/certs/client-cert.pem
+DB_SSL_KEY=/path/to/certs/client-key.pem
+DB_SSL_CA=/path/to/certs/ca-cert.pem
+DB_SSL_PASSPHRASE=your-key-passphrase  # Optional
+```
+
+### Using Environment Variables in Code
+
+```typescript
+import { Client } from 'que-ts';
+import * as fs from 'fs';
+import * as dotenv from 'dotenv';
+
+dotenv.config();
+
+function createClient() {
+  const sslConfig = process.env.DB_SSL_ENABLED === 'true' ? {
+    rejectUnauthorized: process.env.DB_SSL_REJECT_UNAUTHORIZED !== 'false',
+    cert: process.env.DB_SSL_CERT ? fs.readFileSync(process.env.DB_SSL_CERT) : undefined,
+    key: process.env.DB_SSL_KEY ? fs.readFileSync(process.env.DB_SSL_KEY) : undefined,
+    ca: process.env.DB_SSL_CA ? fs.readFileSync(process.env.DB_SSL_CA) : undefined,
+    passphrase: process.env.DB_SSL_PASSPHRASE,
+  } : false;
+
+  return new Client({
+    host: process.env.DB_HOST,
+    port: parseInt(process.env.DB_PORT || '5432'),
+    database: process.env.DB_NAME,
+    user: process.env.DB_USER,
+    password: process.env.DB_PASSWORD,
+    ssl: sslConfig,
+  });
+}
+
+const client = createClient();
+```
+
+## Common SSL Modes
+
+PostgreSQL supports different SSL modes. Here's how to configure them:
+
+| SSL Mode | Description | Configuration |
+|----------|-------------|---------------|
+| `disable` | No SSL | `ssl: false` |
+| `prefer` | Try SSL, fallback to non-SSL | Not directly supported (use `require`) |
+| `require` | SSL required, no cert verification | `ssl: { rejectUnauthorized: false }` |
+| `verify-ca` | SSL with CA verification | `ssl: { rejectUnauthorized: true, ca: ... }` |
+| `verify-full` | SSL with full verification | `ssl: { rejectUnauthorized: true, ca: ..., checkServerIdentity: ... }` |
+
+### Example: verify-ca Mode
+
+```typescript
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    ca: fs.readFileSync('./certs/ca-cert.pem'),
+  }
+});
+```
+
+### Example: verify-full Mode
+
+```typescript
+const client = new Client({
+  host: 'your-database-host.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    ca: fs.readFileSync('./certs/ca-cert.pem'),
+    // Optional: custom server identity check
+    checkServerIdentity: (hostname, cert) => {
+      // Custom validation logic
+      if (hostname !== 'expected-hostname.com') {
+        throw new Error('Hostname mismatch');
+      }
+    },
+  }
+});
+```
+
+## Cloud Provider Examples
+
+### AWS RDS
+
+```typescript
+import { Client } from 'que-ts';
+import * as https from 'https';
+
+// Download RDS CA bundle from:
+// https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem
+
+const client = new Client({
+  host: 'your-instance.region.rds.amazonaws.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    ca: fs.readFileSync('./rds-ca-bundle.pem'),
+  }
+});
+```
+
+### Google Cloud SQL
+
+```typescript
+const client = new Client({
+  host: '/cloudsql/project:region:instance', // Unix socket
+  // Or use IP with SSL:
+  // host: 'your-instance-ip',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    ca: fs.readFileSync('./server-ca.pem'),
+    cert: fs.readFileSync('./client-cert.pem'),
+    key: fs.readFileSync('./client-key.pem'),
+  }
+});
+```
+
+### Azure Database for PostgreSQL
+
+```typescript
+const client = new Client({
+  host: 'your-server.postgres.database.azure.com',
+  port: 5432,
+  database: 'your_database',
+  user: 'your_user@your-server',
+  password: 'your_password',
+  ssl: {
+    rejectUnauthorized: true,
+    // Azure root certificate
+    ca: fs.readFileSync('./BaltimoreCyberTrustRoot.crt.pem'),
+  }
+});
+```
+
+### Heroku Postgres
+
+```typescript
+const client = new Client({
+  connectionString: process.env.DATABASE_URL,
+  ssl: {
+    rejectUnauthorized: false, // Heroku uses self-signed certificates
+  }
+});
+```
+
+## Troubleshooting
+
+### Error: "self signed certificate"
+
+```
+Error: self signed certificate
+```
+
+**Solution:** Set `rejectUnauthorized: false` (development only) or add the CA certificate:
+
+```typescript
+ssl: {
+  rejectUnauthorized: true,
+  ca: fs.readFileSync('./ca-cert.pem'),
+}
+```
+
+### Error: "unable to verify the first certificate"
+
+```
+Error: unable to verify the first certificate
+```
+
+**Solution:** Add the complete certificate chain:
+
+```typescript
+ssl: {
+  rejectUnauthorized: true,
+  ca: [
+    fs.readFileSync('./root-ca.pem'),
+    fs.readFileSync('./intermediate-ca.pem'),
+  ],
+}
+```
+
+### Error: "certificate has expired"
+
+```
+Error: certificate has expired
+```
+
+**Solution:** Renew your certificates. For development, generate new self-signed certificates.
+
+### Error: "ENOENT: no such file or directory"
+
+```
+Error: ENOENT: no such file or directory, open './certs/client-cert.pem'
+```
+
+**Solution:** Check that certificate file paths are correct:
+
+```typescript
+import * as path from 'path';
+
+// Use absolute path
+const certPath = path.join(__dirname, 'certs', 'client-cert.pem');
+console.log('Certificate path:', certPath);
+const cert = fs.readFileSync(certPath);
+```
+
+### Error: "sslmode value 'require' invalid"
+
+If using a connection string, SSL configuration must be in the config object:
+
+```typescript
+// ✗ Wrong - sslmode in connection string doesn't configure node-postgres properly
+const client = new Client({
+  connectionString: 'postgresql://user:pass@host/db?sslmode=require'
+});
+
+// ✓ Correct - use ssl config object
+const client = new Client({
+  connectionString: 'postgresql://user:pass@host/db',
+  ssl: {
+    rejectUnauthorized: true,
+  }
+});
+```
+
+### Testing SSL Connection
+
+```typescript
+import { Client } from 'que-ts';
+
+async function testSSLConnection() {
+  const client = new Client({
+    host: 'your-host.com',
+    port: 5432,
+    database: 'your_database',
+    user: 'your_user',
+    password: 'your_password',
+    ssl: {
+      rejectUnauthorized: true,
+      cert: fs.readFileSync('./client-cert.pem'),
+      key: fs.readFileSync('./client-key.pem'),
+      ca: fs.readFileSync('./ca-cert.pem'),
+    }
+  });
+
+  try {
+    const job = await client.enqueue('TestJob', []);
+    console.log('✓ SSL connection successful! Job ID:', job.id);
+    await client.close();
+  } catch (error) {
+    console.error('✗ SSL connection failed:', error.message);
+    if (error.code) {
+      console.error('Error code:', error.code);
+    }
+  }
+}
+
+testSSLConnection();
+```
+
+## Security Best Practices
+
+1. **Always use `rejectUnauthorized: true` in production**
+2. **Never commit certificates or private keys to version control**
+3. **Use environment variables for sensitive data**
+4. **Rotate certificates regularly**
+5. **Use strong passphrases for encrypted keys**
+6. **Restrict file permissions on certificate files:**
+   ```bash
+   chmod 600 client-key.pem
+   chmod 644 client-cert.pem
+   chmod 644 ca-cert.pem
+   ```
+7. **Store certificates securely** (e.g., AWS Secrets Manager, HashiCorp Vault)
+
+## Additional Resources
+
+- [PostgreSQL SSL Documentation](https://www.postgresql.org/docs/current/ssl-tcp.html)
+- [Node.js TLS Documentation](https://nodejs.org/api/tls.html)
+- [node-postgres SSL Guide](https://node-postgres.com/features/ssl)

package/dist/client.d.ts

@@ -0,0 +1,11 @@
+import { PoolClient } from "pg";
+import { Job, EnqueueOptions, ClientConfig, JSONArray } from "./types";
+export declare class Client {
+    private pool;
+    constructor(config?: ClientConfig);
+    enqueue(jobClass: string, args?: JSONArray, options?: EnqueueOptions): Promise<Job>;
+    enqueueInTx(client: PoolClient, jobClass: string, args?: JSONArray, options?: EnqueueOptions): Promise<Job>;
+    lockJob(queue?: string): Promise<Job | null>;
+    close(): Promise<void>;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,UAAU,EAAE,MAAM,IAAI,CAAC;AACtC,OAAO,EAAE,GAAG,EAAE,cAAc,EAAE,YAAY,EAAU,SAAS,EAAE,MAAM,SAAS,CAAC;AAK/E,qBAAa,MAAM;IACjB,OAAO,CAAC,IAAI,CAAO;gBAEP,MAAM,GAAE,YAAiB;IAe/B,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,SAAc,EACpB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,GAAG,CAAC;IAiBT,WAAW,CACf,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,MAAM,EAChB,IAAI,GAAE,SAAc,EACpB,OAAO,GAAE,cAAmB,GAC3B,OAAO,CAAC,GAAG,CAAC;IAiBT,OAAO,CAAC,KAAK,GAAE,MAAW,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAWhD,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;CAK7B"}

package/dist/client.js

@@ -0,0 +1,64 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const pg_1 = require("pg");
+const job_1 = require("./job");
+const sql_1 = require("./sql");
+const utils_1 = require("./utils");
+class Client {
+    constructor(config = {}) {
+        this.pool = new pg_1.Pool({
+            connectionString: config.connectionString,
+            host: config.host,
+            port: config.port,
+            database: config.database,
+            user: config.user,
+            password: config.password,
+            ssl: config.ssl,
+            max: config.maxConnections || 10,
+            idleTimeoutMillis: 5000, // Close idle connections after 5 seconds
+            connectionTimeoutMillis: 5000, // Timeout connection attempts after 5 seconds
+        });
+    }
+    async enqueue(jobClass, args = [], options = {}) {
+        const { priority = 100, runAt = new Date(), queue = "" } = options;
+        const argsJson = (0, utils_1.formatJobArgs)(args);
+        const result = await this.pool.query(sql_1.SQL_QUERIES.ENQUEUE_JOB, [
+            jobClass,
+            argsJson,
+            priority,
+            runAt,
+            queue,
+        ]);
+        const row = result.rows[0];
+        return new job_1.JobInstance(row, this.pool);
+    }
+    async enqueueInTx(client, jobClass, args = [], options = {}) {
+        const { priority = 100, runAt = new Date(), queue = "" } = options;
+        const argsJson = (0, utils_1.formatJobArgs)(args);
+        const result = await client.query(sql_1.SQL_QUERIES.ENQUEUE_JOB, [
+            jobClass,
+            argsJson,
+            priority,
+            runAt,
+            queue,
+        ]);
+        const row = result.rows[0];
+        return new job_1.JobInstance(row, this.pool);
+    }
+    async lockJob(queue = "") {
+        const result = await this.pool.query(sql_1.SQL_QUERIES.LOCK_JOB, [queue]);
+        if (result.rows.length === 0) {
+            return null;
+        }
+        const row = result.rows[0];
+        return new job_1.JobInstance(row, this.pool);
+    }
+    async close() {
+        await this.pool.end();
+        // Small delay to ensure all connections are fully closed
+        await new Promise((resolve) => setTimeout(resolve, 50));
+    }
+}
+exports.Client = Client;
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";;;AAAA,2BAAsC;AAEtC,+BAAoC;AACpC,+BAAoC;AACpC,mCAAwC;AAExC,MAAa,MAAM;IAGjB,YAAY,SAAuB,EAAE;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,SAAI,CAAC;YACnB,gBAAgB,EAAE,MAAM,CAAC,gBAAgB;YACzC,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,GAAG,EAAE,MAAM,CAAC,cAAc,IAAI,EAAE;YAChC,iBAAiB,EAAE,IAAI,EAAE,yCAAyC;YAClE,uBAAuB,EAAE,IAAI,EAAE,8CAA8C;SAC9E,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,OAAO,CACX,QAAgB,EAChB,OAAkB,EAAE,EACpB,UAA0B,EAAE;QAE5B,MAAM,EAAE,QAAQ,GAAG,GAAG,EAAE,KAAK,GAAG,IAAI,IAAI,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;QAEnE,MAAM,QAAQ,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;QAErC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAW,CAAC,WAAW,EAAE;YAC5D,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,KAAK;YACL,KAAK;SACN,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;QACrC,OAAO,IAAI,iBAAW,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,WAAW,CACf,MAAkB,EAClB,QAAgB,EAChB,OAAkB,EAAE,EACpB,UAA0B,EAAE;QAE5B,MAAM,EAAE,QAAQ,GAAG,GAAG,EAAE,KAAK,GAAG,IAAI,IAAI,EAAE,EAAE,KAAK,GAAG,EAAE,EAAE,GAAG,OAAO,CAAC;QAEnE,MAAM,QAAQ,GAAG,IAAA,qBAAa,EAAC,IAAI,CAAC,CAAC;QAErC,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,iBAAW,CAAC,WAAW,EAAE;YACzD,QAAQ;YACR,QAAQ;YACR,QAAQ;YACR,KAAK;YACL,KAAK;SACN,CAAC,CAAC;QAEH,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;QACrC,OAAO,IAAI,iBAAW,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,QAAgB,EAAE;QAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAW,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;QAEpE,IAAI,MAAM,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAW,CAAC;QACrC,OAAO,IAAI,iBAAW,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;QACtB,yDAAyD;QACzD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC1D,CAAC;CACF;AA7ED,wBA6EC"}

package/dist/dashboard/index.d.ts

@@ -0,0 +1,34 @@
+import { Router, Request, Response, NextFunction } from 'express';
+import { Pool } from 'pg';
+import { DashboardService, DashboardOptions } from './service';
+export interface DashboardMiddlewareOptions extends DashboardOptions {
+    /**
+     * Optional authentication middleware
+     * Return true to allow access, false to deny
+     */
+    auth?: (req: Request, res: Response, next: NextFunction) => boolean | Promise<boolean>;
+}
+/**
+ * Creates an Express router with the Que dashboard
+ *
+ * @example
+ * ```typescript
+ * import express from 'express';
+ * import { Pool } from 'pg';
+ * import { createDashboard } from 'que-ts/dashboard';
+ *
+ * const app = express();
+ * const pool = new Pool({ ... });
+ *
+ * app.use('/admin/queue', createDashboard(pool, {
+ *   title: 'My App Queue',
+ *   auth: (req, res, next) => {
+ *     // Add your authentication logic
+ *     return req.isAuthenticated();
+ *   }
+ * }));
+ * ```
+ */
+export declare function createDashboard(pool: Pool, options?: DashboardMiddlewareOptions): Router;
+export { DashboardService, DashboardOptions };
+//# sourceMappingURL=index.d.ts.map

package/dist/dashboard/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/dashboard/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAG/D,MAAM,WAAW,0BAA2B,SAAQ,gBAAgB;IAClE;;;OAGG;IACH,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,KAAK,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CACxF;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,IAAI,EACV,OAAO,GAAE,0BAA+B,GACvC,MAAM,CAqJR;AAED,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,CAAC"}