@stacksjs/bun-queue 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,79 @@
+# Changelog
+
+### 🧹 Chores
+
+- wip ([12d8d97](https://github.com/stacksjs/bun-queue/commit/12d8d97)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([631b555](https://github.com/stacksjs/bun-queue/commit/631b555)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- **deps**: update all non-major dependencies (#734) ([c74e4b5](https://github.com/stacksjs/bun-queue/commit/c74e4b5)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#734](https://github.com/stacksjs/bun-queue/issues/734), [#734](https://github.com/stacksjs/bun-queue/issues/734))
+- **deps**: update dependency vue-tsc to 3.2.4 (#659) ([5b6a430](https://github.com/stacksjs/bun-queue/commit/5b6a430)) _(by Chris <chrisbreuer93@gmail.com>)_ ([#659](https://github.com/stacksjs/bun-queue/issues/659), [#659](https://github.com/stacksjs/bun-queue/issues/659))
+- **deps**: update dependency vue-router to 5.0.2 (#658) ([eb046d9](https://github.com/stacksjs/bun-queue/commit/eb046d9)) _(by Chris <chrisbreuer93@gmail.com>)_ ([#658](https://github.com/stacksjs/bun-queue/issues/658), [#658](https://github.com/stacksjs/bun-queue/issues/658))
+- **deps**: update dependency @vitejs/plugin-vue to 6.0.4 (#657) ([b3ec970](https://github.com/stacksjs/bun-queue/commit/b3ec970)) _(by Chris <chrisbreuer93@gmail.com>)_ ([#657](https://github.com/stacksjs/bun-queue/issues/657), [#657](https://github.com/stacksjs/bun-queue/issues/657))
+- **deps**: update dependency vue-router to v5 (#160) ([671e779](https://github.com/stacksjs/bun-queue/commit/671e779)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#160](https://github.com/stacksjs/bun-queue/issues/160), [#160](https://github.com/stacksjs/bun-queue/issues/160))
+- release v0.0.1 ([f0a90ad](https://github.com/stacksjs/bun-queue/commit/f0a90ad)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([16f09fc](https://github.com/stacksjs/bun-queue/commit/16f09fc)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([5a9714f](https://github.com/stacksjs/bun-queue/commit/5a9714f)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([b7e5704](https://github.com/stacksjs/bun-queue/commit/b7e5704)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([4ea8161](https://github.com/stacksjs/bun-queue/commit/4ea8161)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([43f06ad](https://github.com/stacksjs/bun-queue/commit/43f06ad)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([aa39ed1](https://github.com/stacksjs/bun-queue/commit/aa39ed1)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([c7ee95d](https://github.com/stacksjs/bun-queue/commit/c7ee95d)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- **deps**: update all non-major dependencies (#52) ([c067652](https://github.com/stacksjs/bun-queue/commit/c067652)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#52](https://github.com/stacksjs/bun-queue/issues/52), [#52](https://github.com/stacksjs/bun-queue/issues/52))
+- **deps**: update actions/cache action to v5 (#54) ([a8c90e6](https://github.com/stacksjs/bun-queue/commit/a8c90e6)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#54](https://github.com/stacksjs/bun-queue/issues/54), [#54](https://github.com/stacksjs/bun-queue/issues/54))
+- wip ([576934b](https://github.com/stacksjs/bun-queue/commit/576934b)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([78ca4d2](https://github.com/stacksjs/bun-queue/commit/78ca4d2)) _(by Chris <chrisbreuer93@gmail.com>)_
+- **deps**: update dependency better-dx to ^0.2.4 (#48) ([ef71ef0](https://github.com/stacksjs/bun-queue/commit/ef71ef0)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#48](https://github.com/stacksjs/bun-queue/issues/48), [#48](https://github.com/stacksjs/bun-queue/issues/48))
+- **deps**: update all non-major dependencies (#45) ([20827e5](https://github.com/stacksjs/bun-queue/commit/20827e5)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#45](https://github.com/stacksjs/bun-queue/issues/45), [#45](https://github.com/stacksjs/bun-queue/issues/45))
+- **deps**: update actions/checkout action to v6 (#47) ([3e33ee7](https://github.com/stacksjs/bun-queue/commit/3e33ee7)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#47](https://github.com/stacksjs/bun-queue/issues/47), [#47](https://github.com/stacksjs/bun-queue/issues/47))
+- **deps**: update dependency @unocss/reset to ^66.5.7 (#43) ([f1cb263](https://github.com/stacksjs/bun-queue/commit/f1cb263)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#43](https://github.com/stacksjs/bun-queue/issues/43), [#43](https://github.com/stacksjs/bun-queue/issues/43))
+- **deps**: update all non-major dependencies (#39) ([4cb63d4](https://github.com/stacksjs/bun-queue/commit/4cb63d4)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#39](https://github.com/stacksjs/bun-queue/issues/39), [#39](https://github.com/stacksjs/bun-queue/issues/39))
+- wip ([43e4085](https://github.com/stacksjs/bun-queue/commit/43e4085)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([e705718](https://github.com/stacksjs/bun-queue/commit/e705718)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([5149131](https://github.com/stacksjs/bun-queue/commit/5149131)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- wip ([9bb6946](https://github.com/stacksjs/bun-queue/commit/9bb6946)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+- **deps**: update dependency vite to v7 (#11) ([c59e0a5](https://github.com/stacksjs/bun-queue/commit/c59e0a5)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#11](https://github.com/stacksjs/bun-queue/issues/11), [#11](https://github.com/stacksjs/bun-queue/issues/11))
+- **deps**: update actions/checkout action to v5 (#13) ([8ba17bf](https://github.com/stacksjs/bun-queue/commit/8ba17bf)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#13](https://github.com/stacksjs/bun-queue/issues/13), [#13](https://github.com/stacksjs/bun-queue/issues/13))
+- **deps**: update all non-major dependencies (#7) ([227bd13](https://github.com/stacksjs/bun-queue/commit/227bd13)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#7](https://github.com/stacksjs/bun-queue/issues/7), [#7](https://github.com/stacksjs/bun-queue/issues/7))
+- wip ([72b5318](https://github.com/stacksjs/bun-queue/commit/72b5318)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([0076af6](https://github.com/stacksjs/bun-queue/commit/0076af6)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([29b76eb](https://github.com/stacksjs/bun-queue/commit/29b76eb)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([d540271](https://github.com/stacksjs/bun-queue/commit/d540271)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([065aeb8](https://github.com/stacksjs/bun-queue/commit/065aeb8)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([5b41099](https://github.com/stacksjs/bun-queue/commit/5b41099)) _(by Chris <chrisbreuer93@gmail.com>)_
+- update tools ([ae152b7](https://github.com/stacksjs/bun-queue/commit/ae152b7)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
+- update tools ([520c4f3](https://github.com/stacksjs/bun-queue/commit/520c4f3)) _(by Adelino Ngomacha <adelinob335@gmail.com>)_
+- **deps**: update all non-major dependencies (#3) ([e6c1351](https://github.com/stacksjs/bun-queue/commit/e6c1351)) _(by [renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot]))_ ([#3](https://github.com/stacksjs/bun-queue/issues/3), [#3](https://github.com/stacksjs/bun-queue/issues/3))
+- wip ([cc596ba](https://github.com/stacksjs/bun-queue/commit/cc596ba)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([8eb1ef1](https://github.com/stacksjs/bun-queue/commit/8eb1ef1)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([78f4766](https://github.com/stacksjs/bun-queue/commit/78f4766)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([5789ce9](https://github.com/stacksjs/bun-queue/commit/5789ce9)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([b83f35c](https://github.com/stacksjs/bun-queue/commit/b83f35c)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([fc5b287](https://github.com/stacksjs/bun-queue/commit/fc5b287)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([4fbdf26](https://github.com/stacksjs/bun-queue/commit/4fbdf26)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([64cf43d](https://github.com/stacksjs/bun-queue/commit/64cf43d)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([18c680e](https://github.com/stacksjs/bun-queue/commit/18c680e)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([71fddf7](https://github.com/stacksjs/bun-queue/commit/71fddf7)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([ab2cb74](https://github.com/stacksjs/bun-queue/commit/ab2cb74)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([82554ed](https://github.com/stacksjs/bun-queue/commit/82554ed)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([a948214](https://github.com/stacksjs/bun-queue/commit/a948214)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([090bbb9](https://github.com/stacksjs/bun-queue/commit/090bbb9)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([660c1a5](https://github.com/stacksjs/bun-queue/commit/660c1a5)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([1b4e662](https://github.com/stacksjs/bun-queue/commit/1b4e662)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([f995e02](https://github.com/stacksjs/bun-queue/commit/f995e02)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([eb19ddf](https://github.com/stacksjs/bun-queue/commit/eb19ddf)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([527b0b8](https://github.com/stacksjs/bun-queue/commit/527b0b8)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([850509a](https://github.com/stacksjs/bun-queue/commit/850509a)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([bef9330](https://github.com/stacksjs/bun-queue/commit/bef9330)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([fe8763d](https://github.com/stacksjs/bun-queue/commit/fe8763d)) _(by Chris <chrisbreuer93@gmail.com>)_
+- wip ([797f589](https://github.com/stacksjs/bun-queue/commit/797f589)) _(by Chris <chrisbreuer93@gmail.com>)_
+- initial commit ([0667d7d](https://github.com/stacksjs/bun-queue/commit/0667d7d)) _(by Chris <chrisbreuer93@gmail.com>)_
+
+### 📄 Miscellaneous
+
+- Update release.yml ([f84baf9](https://github.com/stacksjs/bun-queue/commit/f84baf9)) _(by glennmichael123 <gtorregosa@gmail.com>)_
+
+### Contributors
+
+- _Adelino Ngomacha <adelinob335@gmail.com>_
+- _Chris <chrisbreuer93@gmail.com>_
+- _[renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>](https://github.com/renovate[bot])_
+- _glennmichael123 <gtorregosa@gmail.com>_

package/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright (c) 2024 Open Web Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,231 @@
+<p align="center"><img src=".github/art/cover.jpg" alt="Social Card of this repo"></p>
+
+[![npm version][npm-version-src]][npm-version-href]
+[![GitHub Actions][github-actions-src]][github-actions-href]
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+<!-- [![npm downloads][npm-downloads-src]][npm-downloads-href] -->
+<!-- [![Codecov][codecov-src]][codecov-href] -->
+
+# bun-queue
+
+A Redis-backed job queue built for Bun, inspired by Laravel's Queue system and BullMQ.
+
+## Features
+
+- Fast and efficient Redis-backed queue system
+- Support for delayed jobs, retries, and prioritization
+- Rate limiting capabilities
+- Job event tracking
+- Reliable job processing with concurrency control
+- Typesafe API
+
+## Installation
+
+```bash
+bun add bun-queue
+```
+
+## Basic Usage
+
+```typescript
+import { Queue } from 'bun-queue'
+
+// Create a queue
+const emailQueue = new Queue('emails')
+
+// Add a job to the queue
+const job = await emailQueue.add({
+  to: 'user@example.com',
+  subject: 'Welcome',
+  body: 'Welcome to our platform!'
+})
+
+console.log(`Job ${job.id} added to the queue`)
+
+// Process jobs
+emailQueue.process(5, async (job) => {
+  const { to, subject, body } = job.data
+
+  // Update progress
+  await job.updateProgress(10)
+
+  // Simulate sending email
+  console.log(`Sending email to ${to} with subject: ${subject}`)
+  await new Promise(resolve => setTimeout(resolve, 1000))
+
+  await job.updateProgress(100)
+
+  return { sent: true, timestamp: Date.now() }
+})
+```
+
+## Job Options
+
+```typescript
+// Add a job with options
+await queue.add(
+  { task: 'process-pdf', url: 'https://example.com/document.pdf' },
+  {
+    delay: 5000, // delay for 5 seconds
+    attempts: 3, // retry up to 3 times
+    backoff: {
+      type: 'exponential', // 'fixed' or 'exponential'
+      delay: 1000, // milliseconds
+    },
+    priority: 10, // higher number = higher priority
+    removeOnComplete: true, // remove job when completed
+    lifo: false, // process in FIFO order (default)
+    jobId: 'custom-id', // provide custom job ID
+  }
+)
+```
+
+## Delayed Jobs
+
+```typescript
+// Add a job that will be processed after 30 seconds
+await queue.add(
+  { task: 'send-reminder' },
+  { delay: 30000 }
+)
+```
+
+## Job Management
+
+```typescript
+// Get a job by ID
+const job = await queue.getJob('job-id')
+
+// Get jobs by status
+const waitingJobs = await queue.getJobs('waiting')
+const activeJobs = await queue.getJobs('active')
+const completedJobs = await queue.getJobs('completed')
+const failedJobs = await queue.getJobs('failed')
+
+// Get job counts
+const counts = await queue.getJobCounts()
+console.log(counts) // { waiting: 5, active: 2, completed: 10, failed: 1, delayed: 3, paused: 0 }
+
+// Pause a queue
+await queue.pause()
+
+// Resume a queue
+await queue.resume()
+
+// Retry a failed job
+const failedJob = await queue.getJob('failed-job-id')
+await failedJob.retry()
+
+// Remove a job
+await job.remove()
+
+// Clear all jobs
+await queue.empty()
+```
+
+## Rate Limiting
+
+```typescript
+import { Queue, RateLimiter } from 'bun-queue'
+
+const queue = new Queue('api-calls')
+
+// Create a rate limiter (100 jobs per minute)
+const limiter = new RateLimiter(queue, {
+  max: 100,
+  duration: 60000
+})
+
+// Check if rate limited before adding job
+const { limited, remaining, resetIn } = await limiter.check()
+
+if (!limited) {
+  await queue.add({ url: 'https://api.example.com/endpoint' })
+  console.log(`Job added. ${remaining} requests remaining.`)
+}
+else {
+  console.log(`Rate limited. Try again in ${resetIn}ms.`)
+}
+```
+
+## Configuration
+
+```typescript
+import { Queue } from 'bun-queue'
+
+// Configure queue with options
+const queue = new Queue('tasks', {
+  redis: {
+    url: 'redis://username:password@localhost:6379'
+    // Or provide your own client
+    // client: myRedisClient
+  },
+  prefix: 'myapp', // prefix for Redis keys (default: 'queue')
+  defaultJobOptions: {
+    attempts: 5,
+    backoff: {
+      type: 'exponential',
+      delay: 5000
+    }
+  }
+})
+```
+
+## Environment Variables
+
+The library reads these environment variables (in order of precedence):
+
+- `REDIS_URL`: Redis connection string
+- Default is `redis://localhost:6379` if not set
+
+## Testing
+
+```bash
+bun test
+```
+
+## Changelog
+
+Please see our [releases](https://github.com/stackjs/bun-queue/releases) page for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
+
+## Community
+
+For help, discussion about best practices, or any other conversation that would benefit from being searchable:
+
+[Discussions on GitHub](https://github.com/stacksjs/bun-queue/discussions)
+
+For casual chit-chat with others using this package:
+
+[Join the Stacks Discord Server](https://discord.gg/stacksjs)
+
+## Postcardware
+
+"Software that is free, but hopes for a postcard." We love receiving postcards from around the world showing where Stacks is being used! We showcase them on our website too.
+
+Our address: Stacks.js, 12665 Village Ln #2306, Playa Vista, CA 90094, United States 🌎
+
+## Sponsors
+
+We would like to extend our thanks to the following sponsors for funding Stacks development. If you are interested in becoming a sponsor, please reach out to us.
+
+- [JetBrains](https://www.jetbrains.com/)
+- [The Solana Foundation](https://solana.com/)
+
+## License
+
+The MIT License (MIT). Please see [LICENSE](LICENSE.md) for more information.
+
+Made with 💙
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/bun-queue?style=flat-square
+[npm-version-href]: https://npmjs.com/package/bun-queue
+[github-actions-src]: https://img.shields.io/github/actions/workflow/status/stacksjs/bun-queue/ci.yml?style=flat-square&branch=main
+[github-actions-href]: https://github.com/stacksjs/bun-queue/actions?query=workflow%3Aci
+
+<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/stacksjs/bun-queue/main?style=flat-square
+[codecov-href]: https://codecov.io/gh/stacksjs/bun-queue -->

package/dist/batch.d.ts

@@ -0,0 +1,18 @@
+import type { RedisClient } from 'bun';
+import type { Batch, BatchOptions, Job } from './types';
+import type { Queue } from './queue';
+export declare class BatchProcessor<T = any> {
+  readonly private queue: Queue<T>;
+  readonly private redisClient: RedisClient;
+  readonly private keyPrefix: string;
+  readonly private logger: any;
+  constructor(queue: Queue<T>);
+  createBatch(jobs: T[], options?: BatchOptions): Promise<Batch<T>>;
+  processBatch<R = any>(batchId: string, handler: (jobs: Job<T>[]) => Promise<R[]>): Promise<R[]>;
+  getBatchJobs(batchId: string): Promise<Job<T>[]>;
+  getBatch(batchId: string): Promise<Batch<T> | null>;
+  setBatchProgress(batchId: string, progress: number): Promise<void>;
+  removeBatch(batchId: string): Promise<void>;
+  private getBatchKey(batchId: string): string;
+  private getBatchJobsKey(batchId: string): string;
+}