@adonisjs/queue 0.1.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+# The MIT License
+
+Copyright (c) 2025 Romain Lanz, AdonisJS Core Team, contributors
+
+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,38 @@
+# @adonisjs/queue
+
+<br />
+
+[![gh-workflow-image]][gh-workflow-url] [![npm-image]][npm-url] ![][typescript-image] [![license-image]][license-url]
+
+## Introduction
+
+Queue system for AdonisJS applications, powered by [@boringnode/queue](https://github.com/boringnode/queue). Process background jobs with support for multiple drivers (Redis, Database), job retries, scheduling, and more.
+
+## Official Documentation
+
+The documentation is available on the [AdonisJS website](https://docs.adonisjs.com/guides/digging-deeper/queues)
+
+## Contributing
+
+One of the primary goals of AdonisJS is to have a vibrant community of users and contributors who believes in the principles of the framework.
+
+We encourage you to read the [contribution guide](https://github.com/adonisjs/.github/blob/main/docs/CONTRIBUTING.md) before contributing to the framework.
+
+## Code of Conduct
+
+In order to ensure that the AdonisJS community is welcoming to all, please review and abide by the [Code of Conduct](https://github.com/adonisjs/.github/blob/main/docs/CODE_OF_CONDUCT.md).
+
+## License
+
+AdonisJS Queue is open-sourced software licensed under the [MIT license](LICENSE.md).
+
+[gh-workflow-image]: https://img.shields.io/github/actions/workflow/status/adonisjs/queue/checks.yml?style=for-the-badge
+[gh-workflow-url]: https://github.com/adonisjs/queue/actions/workflows/checks.yml "Github action"
+
+[npm-image]: https://img.shields.io/npm/v/@adonisjs/queue/latest.svg?style=for-the-badge&logo=npm
+[npm-url]: https://www.npmjs.com/package/@adonisjs/queue/v/latest "npm"
+
+[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
+
+[license-url]: LICENSE.md
+[license-image]: https://img.shields.io/github/license/adonisjs/queue?style=for-the-badge

package/build/bin/test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/bin/test.js

@@ -0,0 +1,30 @@
+import { assert } from '@japa/assert';
+import { fileSystem } from '@japa/file-system';
+import { processCLIArgs, configure, run } from '@japa/runner';
+/*
+|--------------------------------------------------------------------------
+| Configure tests
+|--------------------------------------------------------------------------
+|
+| The configure method accepts the configuration to configure the Japa
+| tests runner.
+|
+| The first method call "processCLIArgs" process the command line arguments
+| and turns them into a config object. Using this method is not mandatory.
+|
+| Please consult japa.dev/runner-config for the config docs.
+*/
+processCLIArgs(process.argv.slice(2));
+configure({
+    files: ['tests/**/*.spec.ts'],
+    plugins: [assert(), fileSystem({ autoClean: true })],
+});
+/*
+|--------------------------------------------------------------------------
+| Run tests
+|--------------------------------------------------------------------------
+|
+| The following "run" method is required to execute all the tests.
+|
+*/
+await run();

package/build/commands/commands.json

@@ -0,0 +1 @@
+{"commands":[{"commandName":"make:job","description":"Create a new job class","help":"","namespace":"make","aliases":[],"flags":[],"args":[{"name":"name","argumentName":"name","required":true,"description":"Name of the job","type":"string"}],"options":{"allowUnknownFlags":true},"filePath":"make_job.js"},{"commandName":"queue:scheduler:clear","description":"Remove all scheduled jobs","help":"","namespace":"queue","aliases":[],"flags":[],"args":[],"options":{"startApp":true},"filePath":"queue_scheduler_clear.js"},{"commandName":"queue:scheduler:list","description":"List all scheduled jobs","help":"","namespace":"queue","aliases":[],"flags":[{"name":"status","flagName":"status","required":false,"type":"string","description":"Filter by status (active, paused)","alias":"s"}],"args":[],"options":{"startApp":true},"filePath":"queue_scheduler_list.js"},{"commandName":"queue:scheduler:remove","description":"Remove a scheduled job by ID","help":"","namespace":"queue","aliases":[],"flags":[],"args":[{"name":"id","argumentName":"id","required":true,"description":"ID of the schedule to remove","type":"string"}],"options":{"startApp":true},"filePath":"queue_scheduler_remove.js"},{"commandName":"queue:work","description":"Start processing jobs from the queue","help":"","namespace":"queue","aliases":[],"flags":[{"name":"queue","flagName":"queue","required":false,"type":"string","description":"Comma-separated list of queues to process","alias":"q"}],"args":[],"options":{"startApp":true,"staysAlive":true},"filePath":"queue_work.js"}],"version":1}

package/build/commands/main.d.ts

@@ -0,0 +1,4 @@
+import { CommandMetaData, Command } from '@adonisjs/ace/types';
+
+export function getMetaData(): Promise<CommandMetaData[]>
+export function getCommand(metaData: CommandMetaData): Promise<Command | null>

package/build/commands/main.js

@@ -0,0 +1,36 @@
+import { readFile } from 'node:fs/promises'
+
+/**
+ * In-memory cache of commands after they have been loaded
+ */
+let commandsMetaData
+
+/**
+ * Reads the commands from the "./commands.json" file. Since, the commands.json
+ * file is generated automatically, we do not have to validate its contents
+ */
+export async function getMetaData() {
+  if (commandsMetaData) {
+    return commandsMetaData
+  }
+
+  const commandsIndex = await readFile(new URL('./commands.json', import.meta.url), 'utf-8')
+  commandsMetaData = JSON.parse(commandsIndex).commands
+
+  return commandsMetaData
+}
+
+/**
+ * Imports the command by lookingup its path from the commands
+ * metadata
+ */
+export async function getCommand(metaData) {
+  const commands = await getMetaData()
+  const command = commands.find(({ commandName }) => metaData.commandName === commandName)
+  if (!command) {
+    return null
+  }
+
+  const { default: commandConstructor } = await import(new URL(command.filePath, import.meta.url).href)
+  return commandConstructor
+}

package/build/commands/make_job.d.ts

@@ -0,0 +1,9 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+export default class MakeJob extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    name: string;
+    run(): Promise<void>;
+}

package/build/commands/make_job.js

@@ -0,0 +1,33 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { args, BaseCommand } from '@adonisjs/core/ace';
+import { stubsRoot } from '../stubs/main.js';
+export default class MakeJob extends BaseCommand {
+    static commandName = 'make:job';
+    static description = 'Create a new job class';
+    static options = {
+        allowUnknownFlags: true,
+    };
+    async run() {
+        const codemods = await this.createCodemods();
+        await codemods.makeUsingStub(stubsRoot, 'make/job/main.stub', {
+            flags: this.parsed.flags,
+            entity: this.app.generators.createEntity(this.name),
+        });
+    }
+}
+__decorate([
+    args.string({ description: 'Name of the job' })
+], MakeJob.prototype, "name", void 0);

package/build/commands/queue_scheduler_clear.d.ts

@@ -0,0 +1,8 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+export default class QueueSchedulerClear extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    run(): Promise<void>;
+}

package/build/commands/queue_scheduler_clear.js

@@ -0,0 +1,34 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { BaseCommand } from '@adonisjs/core/ace';
+export default class QueueSchedulerClear extends BaseCommand {
+    static commandName = 'queue:scheduler:clear';
+    static description = 'Remove all scheduled jobs';
+    static options = {
+        startApp: true,
+    };
+    async run() {
+        const { Schedule } = await import('@boringnode/queue');
+        const schedules = await Schedule.list();
+        if (schedules.length === 0) {
+            this.logger.info('No schedules to clear');
+            return;
+        }
+        if (this.app.inProduction) {
+            const confirmed = await this.prompt.confirm(`Are you sure you want to remove all ${schedules.length} schedules?`);
+            if (!confirmed) {
+                return;
+            }
+        }
+        for (const schedule of schedules) {
+            await schedule.delete();
+        }
+        this.logger.success(`Removed ${schedules.length} schedules successfully`);
+    }
+}

package/build/commands/queue_scheduler_list.d.ts

@@ -0,0 +1,9 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+export default class QueueSchedulerList extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    status?: string;
+    run(): Promise<void>;
+}

package/build/commands/queue_scheduler_list.js

@@ -0,0 +1,54 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { BaseCommand, flags } from '@adonisjs/core/ace';
+export default class QueueSchedulerList extends BaseCommand {
+    static commandName = 'queue:scheduler:list';
+    static description = 'List all scheduled jobs';
+    static options = {
+        startApp: true,
+    };
+    async run() {
+        const { Schedule } = await import('@boringnode/queue');
+        const options = {};
+        if (this.status === 'active' || this.status === 'paused') {
+            options.status = this.status;
+        }
+        const schedules = await Schedule.list(options);
+        if (schedules.length === 0) {
+            this.logger.info('No schedules found');
+            return;
+        }
+        const table = this.ui.table();
+        table.head(['ID', 'Job', 'Schedule', 'Status', 'Run Count', 'Next Run', 'Last Run']);
+        for (const schedule of schedules) {
+            const scheduleExpr = schedule.cronExpression ?? `every ${schedule.everyMs}ms`;
+            const nextRun = schedule.nextRunAt?.toISOString() ?? 'N/A';
+            const lastRun = schedule.lastRunAt?.toISOString() ?? 'Never';
+            table.row([
+                schedule.id,
+                schedule.jobName,
+                scheduleExpr,
+                schedule.status,
+                String(schedule.runCount),
+                nextRun,
+                lastRun,
+            ]);
+        }
+        table.render();
+    }
+}
+__decorate([
+    flags.string({ description: 'Filter by status (active, paused)', alias: 's' })
+], QueueSchedulerList.prototype, "status", void 0);

package/build/commands/queue_scheduler_remove.d.ts

@@ -0,0 +1,9 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+export default class QueueSchedulerRemove extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    id: string;
+    run(): Promise<void>;
+}

package/build/commands/queue_scheduler_remove.js

@@ -0,0 +1,42 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { args, BaseCommand } from '@adonisjs/core/ace';
+export default class QueueSchedulerRemove extends BaseCommand {
+    static commandName = 'queue:scheduler:remove';
+    static description = 'Remove a scheduled job by ID';
+    static options = {
+        startApp: true,
+    };
+    async run() {
+        const { Schedule } = await import('@boringnode/queue');
+        const schedule = await Schedule.find(this.id);
+        if (!schedule) {
+            this.logger.error(`Schedule "${this.id}" not found`);
+            this.exitCode = 1;
+            return;
+        }
+        if (this.app.inProduction) {
+            const confirmed = await this.prompt.confirm(`Are you sure you want to remove schedule "${this.id}"?`);
+            if (!confirmed) {
+                return;
+            }
+        }
+        await schedule.delete();
+        this.logger.success(`Schedule "${this.id}" removed successfully`);
+    }
+}
+__decorate([
+    args.string({ description: 'ID of the schedule to remove' })
+], QueueSchedulerRemove.prototype, "id", void 0);

package/build/commands/queue_work.d.ts

@@ -0,0 +1,9 @@
+import { BaseCommand } from '@adonisjs/core/ace';
+import type { CommandOptions } from '@adonisjs/core/types/ace';
+export default class QueueWork extends BaseCommand {
+    static commandName: string;
+    static description: string;
+    static options: CommandOptions;
+    queue?: string;
+    run(): Promise<void>;
+}

package/build/commands/queue_work.js

@@ -0,0 +1,41 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import { flags, BaseCommand } from '@adonisjs/core/ace';
+export default class QueueWork extends BaseCommand {
+    static commandName = 'queue:work';
+    static description = 'Start processing jobs from the queue';
+    static options = {
+        startApp: true,
+        staysAlive: true,
+    };
+    async run() {
+        const { Worker } = await import('@boringnode/queue');
+        const config = this.app.config.get('queue');
+        /**
+         * Commit the router to ensure all routes are registered.
+         * This is required when jobs dispatch HTTP requests or
+         * use URL generation.
+         */
+        const router = await this.app.container.make('router');
+        router.commit();
+        const queues = this.queue ? this.queue.split(',').map((q) => q.trim()) : ['default'];
+        this.logger.info(`Starting worker for queues: ${queues.join(', ')}`);
+        const worker = new Worker(config);
+        await worker.start(queues);
+    }
+}
+__decorate([
+    flags.string({ description: 'Comma-separated list of queues to process', alias: 'q' })
+], QueueWork.prototype, "queue", void 0);

package/build/configure.d.ts

@@ -0,0 +1,5 @@
+import type Configure from '@adonisjs/core/commands/configure';
+/**
+ * Configures the package
+ */
+export declare function configure(command: Configure): Promise<void>;

package/build/configure.js

@@ -0,0 +1,66 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { stubsRoot } from './stubs/main.js';
+const DRIVERS = ['redis', 'database'];
+const DRIVERS_INFO = {
+    redis: {},
+    database: {},
+};
+/**
+ * Configures the package
+ */
+export async function configure(command) {
+    const driver = await command.prompt.choice('Select the queue driver you plan to use', ['redis', 'database'], { hint: 'You can always change it later' });
+    const codemods = await command.createCodemods();
+    /**
+     * Register provider and command
+     */
+    await codemods.updateRcFile((rcFile) => {
+        rcFile.addProvider('@adonisjs/queue/queue_provider').addCommand('@adonisjs/queue/commands');
+    });
+    /**
+     * Define environment variables
+     */
+    await codemods.defineEnvVariables({ QUEUE_DRIVER: driver });
+    /**
+     * Define environment validations
+     */
+    await codemods.defineEnvValidations({
+        variables: {
+            QUEUE_DRIVER: `Env.schema.enum(['redis', 'database', 'sync'] as const)`,
+        },
+        leadingComment: 'Variables for configuring @adonisjs/queue',
+    });
+    const { envVars, envValidations } = DRIVERS_INFO[driver];
+    if (envVars) {
+        await codemods.defineEnvVariables(envVars);
+    }
+    if (envValidations) {
+        await codemods.defineEnvValidations({ variables: envValidations });
+    }
+    /**
+     * Publish config file
+     */
+    await codemods.makeUsingStub(stubsRoot, 'config/queue.stub', { driver });
+    /**
+     * Create migration for database driver
+     */
+    if (driver === 'database') {
+        const shouldPublishMigration = await command.prompt.confirm('Do you want to publish the migration for the queue tables?', { hint: 'Tables are auto-created by default, but you can manage them manually' });
+        if (shouldPublishMigration) {
+            await codemods.makeUsingStub(stubsRoot, 'migration.stub', {
+                entity: command.app.generators.createEntity('queue'),
+                migration: {
+                    folder: 'database/migrations',
+                    fileName: `${new Date().getTime()}_create_queue_tables.ts`,
+                },
+            });
+        }
+    }
+}

package/build/index.d.ts

@@ -0,0 +1,5 @@
+export * from '@boringnode/queue';
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';
+export { drivers } from './src/drivers.js';
+export { stubsRoot } from './stubs/main.js';

package/build/index.js

@@ -0,0 +1,15 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+// Re-export everything from @boringnode/queue
+export * from '@boringnode/queue';
+// AdonisJS specific exports
+export { configure } from './configure.js';
+export { defineConfig } from './src/define_config.js';
+export { drivers } from './src/drivers.js';
+export { stubsRoot } from './stubs/main.js';

package/build/providers/queue_provider.d.ts

@@ -0,0 +1,8 @@
+import '../src/types/extended.js';
+import type { ApplicationService } from '@adonisjs/core/types';
+export default class QueueProvider {
+    protected app: ApplicationService;
+    constructor(app: ApplicationService);
+    register(): void;
+    shutdown(): Promise<void>;
+}

package/build/providers/queue_provider.js

@@ -0,0 +1,53 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import '../src/types/extended.js';
+export default class QueueProvider {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    register() {
+        this.app.container.singleton('queue.manager', async () => {
+            const { QueueManager } = await import('@boringnode/queue');
+            const config = this.app.config.get('queue');
+            /**
+             * Resolve adapter factories from config providers
+             */
+            const resolvedAdapters = {};
+            for (const [name, adapterConfig] of Object.entries(config.adapters)) {
+                if (typeof adapterConfig === 'function') {
+                    resolvedAdapters[name] = adapterConfig;
+                }
+                else {
+                    resolvedAdapters[name] = await adapterConfig.resolver(this.app);
+                }
+            }
+            /**
+             * Inject jobFactory if not already defined.
+             * This enables automatic dependency injection for job classes.
+             */
+            const jobFactory = config.jobFactory ??
+                (async (JobClass, payload, context) => {
+                    return this.app.container.make(JobClass, [payload, context]);
+                });
+            const logger = await this.app.container.make('logger');
+            await QueueManager.init({
+                ...config,
+                adapters: resolvedAdapters,
+                jobFactory,
+                logger: config.logger ?? logger,
+            });
+            return QueueManager;
+        });
+    }
+    async shutdown() {
+        const queueManager = await this.app.container.make('queue.manager');
+        await queueManager.destroy();
+    }
+}

package/build/services/queue.d.ts

@@ -0,0 +1,3 @@
+import type { QueueManager } from '@boringnode/queue';
+declare let queue: typeof QueueManager;
+export { queue as default };

package/build/services/queue.js

@@ -0,0 +1,14 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import app from '@adonisjs/core/services/app';
+let queue;
+await app.booted(async () => {
+    queue = await app.container.make('queue.manager');
+});
+export { queue as default };

package/build/src/define_config.d.ts

@@ -0,0 +1,5 @@
+import type { QueueManagerConfig } from '@boringnode/queue/types';
+/**
+ * Define queue configuration with type-safety.
+ */
+export declare function defineConfig(config: QueueManagerConfig): QueueManagerConfig;

package/build/src/define_config.js

@@ -0,0 +1,14 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/**
+ * Define queue configuration with type-safety.
+ */
+export function defineConfig(config) {
+    return config;
+}

package/build/src/drivers.d.ts

@@ -0,0 +1,33 @@
+import type { ConfigProvider } from '@adonisjs/core/types';
+import type { RedisConnections } from '@adonisjs/redis/types';
+import type { Adapter } from '@boringnode/queue/types';
+type AdapterFactory = () => Adapter;
+/**
+ * Queue drivers that integrate with AdonisJS services.
+ *
+ * These drivers use `configProvider.create()` to lazily resolve
+ * connections from the AdonisJS container.
+ */
+export declare const drivers: {
+    /**
+     * Redis driver using @adonisjs/redis connection.
+     * Requires @adonisjs/redis to be installed and configured.
+     */
+    redis: (config?: {
+        connectionName?: keyof RedisConnections;
+    }) => ConfigProvider<AdapterFactory>;
+    /**
+     * Database driver using @adonisjs/lucid connection.
+     * Requires @adonisjs/lucid to be installed and configured.
+     */
+    database: (config?: {
+        connectionName?: string;
+        tableName?: string;
+    }) => ConfigProvider<AdapterFactory>;
+    /**
+     * Sync driver for testing (executes jobs immediately).
+     * No external dependencies required.
+     */
+    sync: () => ConfigProvider<AdapterFactory>;
+};
+export {};

package/build/src/drivers.js

@@ -0,0 +1,42 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+/// <reference types="@adonisjs/redis/redis_provider" />
+/// <reference types="@adonisjs/lucid/database_provider" />
+import { configProvider } from '@adonisjs/core';
+/**
+ * Queue drivers that integrate with AdonisJS services.
+ *
+ * These drivers use `configProvider.create()` to lazily resolve
+ * connections from the AdonisJS container.
+ */
+export const drivers = {
+    redis(config) {
+        return configProvider.create(async (app) => {
+            const redis = await app.container.make('redis');
+            const { redis: redisAdapter } = await import('@boringnode/queue/drivers/redis_adapter');
+            const connection = redis.connection(config?.connectionName);
+            return redisAdapter(connection.ioConnection);
+        });
+    },
+    database(config) {
+        return configProvider.create(async (app) => {
+            const db = await app.container.make('lucid.db');
+            const { knex } = await import('@boringnode/queue/drivers/knex_adapter');
+            const connectionName = config?.connectionName || db.primaryConnectionName;
+            const connection = db.connection(connectionName);
+            return knex(connection.getWriteClient(), config?.tableName);
+        });
+    },
+    sync() {
+        return configProvider.create(async () => {
+            const { sync } = await import('@boringnode/queue/drivers/sync_adapter');
+            return sync();
+        });
+    },
+};

package/build/src/types/extended.d.ts

@@ -0,0 +1,6 @@
+import type { QueueManager } from '@boringnode/queue';
+declare module '@adonisjs/core/types' {
+    interface ContainerBindings {
+        'queue.manager': typeof QueueManager;
+    }
+}

package/build/src/types/extended.js

@@ -0,0 +1,9 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export {};

package/build/src/types/main.d.ts

@@ -0,0 +1 @@
+export * from '@boringnode/queue/types';

package/build/src/types/main.js

@@ -0,0 +1,9 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+export * from '@boringnode/queue/types';

package/build/stubs/config/queue.stub

@@ -0,0 +1,29 @@
+{{{
+  exports({ to: app.configPath('queue.ts') })
+}}}
+import env from '#start/env'
+import { defineConfig, drivers } from '@adonisjs/queue'
+
+export default defineConfig({
+  default: env.get('QUEUE_DRIVER', '{{driver}}'),
+
+  adapters: {
+{{#if driver === 'redis'}}
+    redis: drivers.redis({
+      connectionName: 'main',
+    }),
+{{#elif driver === 'database'}}
+    database: drivers.database({
+      connectionName: 'primary',
+    }),
+{{/if}}
+    sync: drivers.sync(),
+  },
+
+  worker: {
+    concurrency: 5,
+    idleDelay: '2s',
+  },
+
+  locations: ['./app/jobs/**/*.ts'],
+})

package/build/stubs/main.d.ts

@@ -0,0 +1 @@
+export declare const stubsRoot: string;

package/build/stubs/main.js

@@ -0,0 +1,10 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+import { getDirname } from '@poppinss/utils';
+export const stubsRoot = getDirname(import.meta.url);

package/build/stubs/make/job/main.stub

@@ -0,0 +1,29 @@
+{{#var jobName = string(entity.name).pascalCase().toString()}}
+{{#var jobFileName = string(entity.name).snakeCase().toString()}}
+{{{
+  exports({
+    to: app.makePath('app/jobs', entity.path, jobFileName + '.ts')
+  })
+}}}
+import { Job } from '@adonisjs/queue'
+import type { JobOption } from '@adonisjs/queue/types'
+
+interface {{ jobName }}Payload {
+  // Define your payload type here
+}
+
+export default class {{ jobName }} extends Job<{{ jobName }}Payload> {
+  static options: JobOption = {
+    queue: 'default',
+    maxRetries: 3,
+  }
+
+  async execute() {
+    // Your job logic here
+    console.log('Processing {{ jobName }}', this.payload)
+  }
+
+  async failed(error: Error) {
+    console.error('{{ jobName }} failed:', error.message)
+  }
+}

package/build/stubs/migration.stub

@@ -0,0 +1,53 @@
+{{{
+  exports({
+    to: app.makePath(migration.folder, entity.path, migration.fileName)
+  })
+}}}
+import { BaseSchema } from '@adonisjs/lucid/schema'
+
+export default class extends BaseSchema {
+  async up() {
+    /**
+     * Jobs table - stores pending, active, and delayed jobs
+     */
+    this.schema.createTable('queue_jobs', (table) => {
+      table.string('id', 255).notNullable()
+      table.string('queue', 255).notNullable()
+      table.enum('status', ['pending', 'active', 'delayed']).notNullable()
+      table.text('data').notNullable()
+      table.bigint('score').unsigned().nullable()
+      table.string('worker_id', 255).nullable()
+      table.bigint('acquired_at').unsigned().nullable()
+      table.bigint('execute_at').unsigned().nullable()
+      table.primary(['id', 'queue'])
+      table.index(['queue', 'status', 'score'])
+      table.index(['queue', 'status', 'execute_at'])
+    })
+
+    /**
+     * Schedules table - stores recurring job schedules
+     */
+    this.schema.createTable('queue_schedules', (table) => {
+      table.string('id', 255).primary()
+      table.string('status', 50).notNullable().defaultTo('active')
+      table.string('job_name', 255).notNullable()
+      table.text('payload').notNullable()
+      table.string('cron_expression', 255).nullable()
+      table.bigint('every_ms').unsigned().nullable()
+      table.string('timezone', 100).notNullable().defaultTo('UTC')
+      table.timestamp('from_date').nullable()
+      table.timestamp('to_date').nullable()
+      table.integer('run_limit').unsigned().nullable()
+      table.integer('run_count').unsigned().notNullable().defaultTo(0)
+      table.timestamp('next_run_at').nullable()
+      table.timestamp('last_run_at').nullable()
+      table.timestamp('created_at').notNullable()
+      table.index(['status', 'next_run_at'])
+    })
+  }
+
+  async down() {
+    this.schema.dropTable('queue_jobs')
+    this.schema.dropTable('queue_schedules')
+  }
+}

package/build/tests/configure.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tests/configure.spec.js

@@ -0,0 +1,144 @@
+/*
+ * @adonisjs/queue
+ *
+ * (c) AdonisJS
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+var __rewriteRelativeImportExtension = (this && this.__rewriteRelativeImportExtension) || function (path, preserveJsx) {
+    if (typeof path === "string" && /^\.\.?\//.test(path)) {
+        return path.replace(/\.(tsx)$|((?:\.d)?)((?:\.[^./]+?)?)\.([cm]?)ts$/i, function (m, tsx, d, ext, cm) {
+            return tsx ? preserveJsx ? ".jsx" : ".js" : d && (!ext || !cm) ? m : (d + ext + "." + cm.toLowerCase() + "js");
+        });
+    }
+    return path;
+};
+import { test } from '@japa/runner';
+import { fileURLToPath } from 'node:url';
+import { IgnitorFactory } from '@adonisjs/core/factories';
+import Configure from '@adonisjs/core/commands/configure';
+const BASE_URL = new URL('./tmp/', import.meta.url);
+test.group('Configure', (group) => {
+    group.tap((t) => t.timeout(10_000));
+    group.each.setup(async ({ context }) => {
+        context.fs.baseUrl = BASE_URL;
+        context.fs.basePath = fileURLToPath(BASE_URL);
+        await context.fs.create('.env', '');
+        await context.fs.createJson('tsconfig.json', {});
+        await context.fs.create('start/env.ts', `export default Env.create(new URL('./'), {})`);
+        await context.fs.create('adonisrc.ts', `export default defineConfig({})`);
+    });
+    test('should register provider and command', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('web');
+        await app.init().then(() => app.boot());
+        const ace = await app.container.make('ace');
+        ace.prompt.trap('Select the queue driver you plan to use').chooseOption(0);
+        ace.ui.switchMode('raw');
+        const command = await ace.create(Configure, ['../../index.js']);
+        await command.exec();
+        await assert.fileExists('adonisrc.ts');
+        await assert.fileContains('adonisrc.ts', '@adonisjs/queue/queue_provider');
+        await assert.fileContains('adonisrc.ts', '@adonisjs/queue/commands');
+    });
+    test('should create configuration file', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('web');
+        await app.init().then(() => app.boot());
+        const ace = await app.container.make('ace');
+        ace.prompt.trap('Select the queue driver you plan to use').chooseOption(0);
+        ace.ui.switchMode('raw');
+        const command = await ace.create(Configure, ['../../index.js']);
+        await command.exec();
+        await assert.fileExists('config/queue.ts');
+        await assert.fileContains('config/queue.ts', 'defineConfig');
+    });
+    test('should add environment variables', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('web');
+        await app.init().then(() => app.boot());
+        const ace = await app.container.make('ace');
+        ace.prompt.trap('Select the queue driver you plan to use').chooseOption(0);
+        ace.ui.switchMode('raw');
+        const command = await ace.create(Configure, ['../../index.js']);
+        await command.exec();
+        await assert.fileContains('.env', 'QUEUE_DRIVER');
+        await assert.fileContains('start/env.ts', 'QUEUE_DRIVER');
+    });
+    test('should create redis config when redis driver selected', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('web');
+        await app.init().then(() => app.boot());
+        const ace = await app.container.make('ace');
+        ace.prompt.trap('Select the queue driver you plan to use').chooseOption(0); // redis
+        ace.ui.switchMode('raw');
+        const command = await ace.create(Configure, ['../../index.js']);
+        await command.exec();
+        await assert.fileContains('config/queue.ts', 'drivers.redis');
+        await assert.fileContains('.env', 'QUEUE_DRIVER=redis');
+    });
+    test('should create database config when database driver selected', async ({ assert }) => {
+        const ignitor = new IgnitorFactory()
+            .withCoreProviders()
+            .withCoreConfig()
+            .create(BASE_URL, {
+            importer: (filePath) => {
+                if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                    return import(__rewriteRelativeImportExtension(new URL(filePath, BASE_URL).href));
+                }
+                return import(__rewriteRelativeImportExtension(filePath));
+            },
+        });
+        const app = ignitor.createApp('web');
+        await app.init().then(() => app.boot());
+        const ace = await app.container.make('ace');
+        ace.prompt.trap('Select the queue driver you plan to use').chooseOption(1); // database
+        ace.prompt.trap('Do you want to publish the migration for the queue tables?').reject();
+        ace.ui.switchMode('raw');
+        const command = await ace.create(Configure, ['../../index.js']);
+        await command.exec();
+        await assert.fileContains('config/queue.ts', 'drivers.database');
+        await assert.fileContains('.env', 'QUEUE_DRIVER=database');
+    });
+});

package/package.json

@@ -0,0 +1,124 @@
+{
+  "name": "@adonisjs/queue",
+  "description": "Queue system for AdonisJS powered by @boringnode/queue",
+  "version": "0.1.1",
+  "engines": {
+    "node": ">=20.11.1"
+  },
+  "main": "build/index.js",
+  "type": "module",
+  "files": [
+    "build"
+  ],
+  "exports": {
+    ".": "./build/index.js",
+    "./queue_provider": "./build/providers/queue_provider.js",
+    "./commands/*": "./build/commands/*.js",
+    "./commands": "./build/commands/main.js",
+    "./services/main": "./build/services/queue.js",
+    "./types": "./build/src/types/main.js"
+  },
+  "scripts": {
+    "build": "npm run compile",
+    "clean": "del-cli build",
+    "compile": "npm run clean && tsc",
+    "copy:templates": "copyfiles \"stubs/**/*.stub\" build",
+    "index:commands": "adonis-kit index build/commands",
+    "format": "prettier --write .",
+    "lint": "eslint .",
+    "postcompile": "npm run copy:templates && npm run index:commands",
+    "prepublishOnly": "npm run build",
+    "quick:test": "node --enable-source-maps --import=@poppinss/ts-exec bin/test.ts",
+    "test": "c8 npm run quick:test",
+    "release": "release-it",
+    "typecheck": "tsc --noEmit",
+    "version": "npm run build"
+  },
+  "dependencies": {
+    "@boringnode/queue": "^0.1.0",
+    "@poppinss/utils": "^6.10.1"
+  },
+  "devDependencies": {
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.17.2",
+    "@adonisjs/eslint-config": "^2.0.0",
+    "@adonisjs/lucid": "^21.7.0",
+    "@adonisjs/prettier-config": "^1.4.4",
+    "@adonisjs/redis": "^9.2.0",
+    "@adonisjs/tsconfig": "^1.4.0",
+    "@japa/assert": "^4.0.1",
+    "@japa/file-system": "^2.3.2",
+    "@japa/runner": "^4.2.0",
+    "@poppinss/ts-exec": "^1.4.1",
+    "@release-it/conventional-changelog": "^10.0.4",
+    "@types/node": "^20.17.22",
+    "c8": "^10.1.3",
+    "copyfiles": "^2.4.1",
+    "del-cli": "^6.0.0",
+    "eslint": "^9.23.0",
+    "prettier": "^3.5.3",
+    "release-it": "^19.2.2",
+    "typescript": "^5.8.2"
+  },
+  "peerDependencies": {
+    "@adonisjs/assembler": "^7.0.0 || ^8.0.0",
+    "@adonisjs/core": "^6.2.0 || ^7.0.0",
+    "@adonisjs/lucid": "^20.0.0 || ^21.0.0 || ^22.0.0",
+    "@adonisjs/redis": "^8.0.0 || ^9.0.0 || ^10.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@adonisjs/lucid": {
+      "optional": true
+    },
+    "@adonisjs/redis": {
+      "optional": true
+    }
+  },
+  "author": "Romain Lanz <romain.lanz@pm.me>",
+  "license": "MIT",
+  "keywords": [
+    "queue",
+    "jobs",
+    "background-jobs",
+    "adonisjs",
+    "adonis"
+  ],
+  "prettier": "@adonisjs/prettier-config",
+  "publishConfig": {
+    "access": "public",
+    "tag": "latest"
+  },
+  "release-it": {
+    "git": {
+      "requireCleanWorkingDir": true,
+      "requireUpstream": true,
+      "commitMessage": "chore(release): ${version}",
+      "tagAnnotation": "v${version}",
+      "push": true,
+      "tagName": "v${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": true,
+      "skipChecks": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  }
+}