nuxt-processor 0.0.4 → 0.0.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Aidan Hibbard
+
+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

@@ -5,9 +5,10 @@
 [![License][license-src]][license-href]
 [![Known Vulnerabilities](https://snyk.io/test/github/aidanhibbard/nuxt-processor/badge.svg)](https://snyk.io/test/github/aidanhibbard/nuxt-processor)
 
-Background job processing for Nuxt using BullMQ with a dedicated workers process.
+## Real background job processing for Nuxt
+
+<img width="752" height="402" alt="image" src="https://github.com/user-attachments/assets/9190d8e1-8a46-4b49-be5a-20f0a49fc8fe" />
 
-<img width="763" height="321" alt="image" src="https://github.com/user-attachments/assets/f49d79a9-f99a-4612-b3bc-cad724475bf4" />
 
 Note: This package is under very active development! Please consider creating issues if you run into anything!
 
@@ -18,7 +19,7 @@ Note: This package is under very active development! Please consider creating is
 
 - **Dedicated processing**: Workers run in a separate Node process – no coupling to your web server.
 - **Scalability**: Run multiple worker processes and instances across machines.
-- **Simple DX**: Define queues/workers in `server/queues` and `server/workers` using first-class helpers.
+- **Simple DX**: Define queues/workers using first-class helpers.
 
 ## Sections
 
@@ -44,9 +45,14 @@ export default defineNuxtConfig({
   modules: ['nuxt-processor'],
   processor: {
     redis: {
-      host: process.env.NUXT_REDIS_HOST ?? '127.0.0.1', // defaults '127.0.0.1'
-      port: Number(process.env.NUXT_REDIS_PORT ?? 6379), // defaults 6379
-      password: process.env.NUXT_REDIS_PASSWORD ?? '', // defaults ''
+      // Prefer a single URL if available (takes precedence over other fields)
+      // e.g. redis://user:pass@host:6379/0
+      url: process.env.NUXT_REDIS_URL,
+      host: process.env.NUXT_REDIS_HOST ?? '127.0.0.1',
+      port: Number(process.env.NUXT_REDIS_PORT ?? 6379),
+      password: process.env.NUXT_REDIS_PASSWORD ?? '',
+      username: process.env.NUXT_REDIS_USERNAME,
+      db: Number(process.env.NUXT_REDIS_DB ?? 0),
     },
   },
 })
@@ -54,19 +60,20 @@ export default defineNuxtConfig({
 
 ## Define a queue and enqueue from your app
 
-Create `server/queues/index.ts`:
+Create `server/queues/hello.ts`:
 
 ```ts
 import { defineQueue } from '#processor'
 
 export default defineQueue({
   name: 'hello',
+  options: {},
 })
 ```
 
 ## Define a worker
 
-Create `server/workers/index.ts`:
+Create `server/workers/hello.ts`:
 
 ```ts
 import { defineWorker } from '#processor'

package/dist/cli.cjs

@@ -8,7 +8,7 @@ const pathe = require('pathe');
 const consola = require('consola');
 const citty = require('citty');
 const kit = require('@nuxt/kit');
-const _package = require('./shared/nuxt-processor.BqsFQtIQ.cjs');
+const _package = require('./shared/nuxt-processor.BYUls4Ut.cjs');
 
 const ensureNuxtProject = async (args) => {
   const dir = pathe.resolve(args.dir);
@@ -64,7 +64,7 @@ const main = citty.createMain({
                   const updated = {
                     ...pkg,
                     scripts: {
-                      ...pkg.scripts || {},
+                      ...pkg.scripts ?? {},
                       "processor:dev": "nuxt-processor dev"
                     }
                   };

package/dist/cli.mjs

@@ -6,7 +6,7 @@ import { resolve } from 'pathe';
 import { consola } from 'consola';
 import { createMain, defineCommand } from 'citty';
 import { loadNuxtConfig } from '@nuxt/kit';
-import { v as version, d as description, n as name } from './shared/nuxt-processor.BDPWtq8T.mjs';
+import { v as version, d as description, n as name } from './shared/nuxt-processor.BhHJSy2L.mjs';
 
 const ensureNuxtProject = async (args) => {
   const dir = resolve(args.dir);
@@ -62,7 +62,7 @@ const main = createMain({
                   const updated = {
                     ...pkg,
                     scripts: {
-                      ...pkg.scripts || {},
+                      ...pkg.scripts ?? {},
                       "processor:dev": "nuxt-processor dev"
                     }
                   };

package/dist/module.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
 const kit = require('@nuxt/kit');
-const _package = require('./shared/nuxt-processor.BqsFQtIQ.cjs');
+const _package = require('./shared/nuxt-processor.BYUls4Ut.cjs');
 const node_path = require('node:path');
 const fg = require('fast-glob');
 
@@ -36,13 +36,17 @@ const module$1 = kit.defineNuxtModule({
     redis: {
       host: process.env.NUXT_REDIS_HOST ?? "127.0.0.1",
       port: Number(process.env.NUXT_REDIS_PORT ?? 6379),
-      password: process.env.NUXT_REDIS_PASSWORD ?? ""
+      password: process.env.NUXT_REDIS_PASSWORD ?? "",
+      username: process.env.NUXT_REDIS_USERNAME ?? void 0,
+      // needs Redis >= 6
+      db: Number(process.env.NUXT_REDIS_DB ?? 0),
+      // Defaults to 0 on ioredis
+      url: process.env.NUXT_REDIS_URL ?? void 0
     },
     workers: "server/workers"
   },
-  async setup(_options, _nuxt) {
+  async setup(_options, nuxt) {
     const { resolve } = kit.createResolver((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (_documentCurrentScript && _documentCurrentScript.tagName.toUpperCase() === 'SCRIPT' && _documentCurrentScript.src || new URL('module.cjs', document.baseURI).href)));
-    const buildDir = _nuxt.options.buildDir;
     function generateWorkersEntryContent(workerFiles) {
       const redisInline = JSON.stringify(_options.redis ?? {});
       const toImportArray = workerFiles.map((id) => `() => import(${JSON.stringify(id)})`).join(",\n    ");
@@ -135,16 +139,15 @@ if (isMain) {
 export default { createWorkersApp }
 `;
     }
-    _nuxt.options.alias = _nuxt.options.alias ?? {};
-    _nuxt.options.alias["nuxt-processor"] = resolve("./runtime/server/handlers");
-    _nuxt.options.alias["#processor"] = resolve("./runtime/server/handlers");
-    _nuxt.options.alias["#processor-utils"] = resolve("./runtime/server/utils/workers");
-    if (!_nuxt.options.alias["#bullmq"]) {
-      _nuxt.options.alias["#bullmq"] = "bullmq";
+    nuxt.options.alias = nuxt.options.alias ?? {};
+    nuxt.options.alias["nuxt-processor"] = resolve("./runtime/server/handlers");
+    nuxt.options.alias["#processor"] = resolve("./runtime/server/handlers");
+    nuxt.options.alias["#processor-utils"] = resolve("./runtime/server/utils/workers");
+    if (!nuxt.options.alias["#bullmq"]) {
+      nuxt.options.alias["#bullmq"] = "bullmq";
     }
-    const typesDtsPath = kit.addTemplate({
+    kit.addTypeTemplate({
       filename: "types/nuxt-processor.d.ts",
-      write: true,
       getContents: () => `
 declare module 'nuxt-processor' {
   export { defineQueue } from '${resolve("./runtime/server/handlers/defineQueue")}'
@@ -164,10 +167,6 @@ declare module '#bullmq' {
   export * from 'bullmq'
 }
 `
-    }).dst;
-    _nuxt.hooks.hook("prepare:types", (opts) => {
-      if (!opts.tsConfig.include) opts.tsConfig.include = [];
-      opts.tsConfig.include.push(resolve(buildDir, typesDtsPath));
     });
     function createWorkersRollupPlugin() {
       const VIRTUAL_ID = "\0nuxt-processor-entry";
@@ -191,7 +190,7 @@ declare module '#bullmq' {
           if (id === VIRTUAL_ID) return VIRTUAL_ID;
         },
         load(id) {
-          if (id === VIRTUAL_ID) return virtualCode || "export {}\n";
+          if (id === VIRTUAL_ID) return virtualCode ?? "export {}\n";
         },
         generateBundle() {
           if (!virtualCode || !entryRefId) return;
@@ -211,7 +210,7 @@ process.on('beforeExit', () => shutdown('beforeExit'))
         }
       };
     }
-    _nuxt.hooks.hook("nitro:config", (nitroConfig) => {
+    nuxt.hooks.hook("nitro:config", (nitroConfig) => {
       nitroConfig.rollupConfig = nitroConfig.rollupConfig ?? {};
       const plugin = createWorkersRollupPlugin();
       const current = nitroConfig.rollupConfig.plugins;

package/dist/module.d.cts

@@ -1,8 +1,11 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { RedisOptions } from 'bullmq';
 
+type ModuleRedisOptions = RedisOptions & {
+    url?: string;
+};
 interface ModuleOptions {
-    redis: RedisOptions;
+    redis: ModuleRedisOptions;
     /**
      * The folder containing the worker files
      * Scans for {ts,js,mjs}

package/dist/module.d.mts

@@ -1,8 +1,11 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { RedisOptions } from 'bullmq';
 
+type ModuleRedisOptions = RedisOptions & {
+    url?: string;
+};
 interface ModuleOptions {
-    redis: RedisOptions;
+    redis: ModuleRedisOptions;
     /**
      * The folder containing the worker files
      * Scans for {ts,js,mjs}

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-processor",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "compatibility": {
     "nuxt": "^4.0.0 || ^3.0.0"
   },

package/dist/module.mjs

@@ -1,5 +1,5 @@
-import { useNuxt, createResolver, defineNuxtModule, addTemplate } from '@nuxt/kit';
-import { c as configKey, a as compatibility, v as version, n as name } from './shared/nuxt-processor.BDPWtq8T.mjs';
+import { useNuxt, createResolver, defineNuxtModule, addTypeTemplate } from '@nuxt/kit';
+import { c as configKey, a as compatibility, v as version, n as name } from './shared/nuxt-processor.BhHJSy2L.mjs';
 import { relative } from 'node:path';
 import fg from 'fast-glob';
 
@@ -29,13 +29,17 @@ const module = defineNuxtModule({
     redis: {
       host: process.env.NUXT_REDIS_HOST ?? "127.0.0.1",
       port: Number(process.env.NUXT_REDIS_PORT ?? 6379),
-      password: process.env.NUXT_REDIS_PASSWORD ?? ""
+      password: process.env.NUXT_REDIS_PASSWORD ?? "",
+      username: process.env.NUXT_REDIS_USERNAME ?? void 0,
+      // needs Redis >= 6
+      db: Number(process.env.NUXT_REDIS_DB ?? 0),
+      // Defaults to 0 on ioredis
+      url: process.env.NUXT_REDIS_URL ?? void 0
     },
     workers: "server/workers"
   },
-  async setup(_options, _nuxt) {
+  async setup(_options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
-    const buildDir = _nuxt.options.buildDir;
     function generateWorkersEntryContent(workerFiles) {
       const redisInline = JSON.stringify(_options.redis ?? {});
       const toImportArray = workerFiles.map((id) => `() => import(${JSON.stringify(id)})`).join(",\n    ");
@@ -128,16 +132,15 @@ if (isMain) {
 export default { createWorkersApp }
 `;
     }
-    _nuxt.options.alias = _nuxt.options.alias ?? {};
-    _nuxt.options.alias["nuxt-processor"] = resolve("./runtime/server/handlers");
-    _nuxt.options.alias["#processor"] = resolve("./runtime/server/handlers");
-    _nuxt.options.alias["#processor-utils"] = resolve("./runtime/server/utils/workers");
-    if (!_nuxt.options.alias["#bullmq"]) {
-      _nuxt.options.alias["#bullmq"] = "bullmq";
+    nuxt.options.alias = nuxt.options.alias ?? {};
+    nuxt.options.alias["nuxt-processor"] = resolve("./runtime/server/handlers");
+    nuxt.options.alias["#processor"] = resolve("./runtime/server/handlers");
+    nuxt.options.alias["#processor-utils"] = resolve("./runtime/server/utils/workers");
+    if (!nuxt.options.alias["#bullmq"]) {
+      nuxt.options.alias["#bullmq"] = "bullmq";
     }
-    const typesDtsPath = addTemplate({
+    addTypeTemplate({
       filename: "types/nuxt-processor.d.ts",
-      write: true,
       getContents: () => `
 declare module 'nuxt-processor' {
   export { defineQueue } from '${resolve("./runtime/server/handlers/defineQueue")}'
@@ -157,10 +160,6 @@ declare module '#bullmq' {
   export * from 'bullmq'
 }
 `
-    }).dst;
-    _nuxt.hooks.hook("prepare:types", (opts) => {
-      if (!opts.tsConfig.include) opts.tsConfig.include = [];
-      opts.tsConfig.include.push(resolve(buildDir, typesDtsPath));
     });
     function createWorkersRollupPlugin() {
       const VIRTUAL_ID = "\0nuxt-processor-entry";
@@ -184,7 +183,7 @@ declare module '#bullmq' {
           if (id === VIRTUAL_ID) return VIRTUAL_ID;
         },
         load(id) {
-          if (id === VIRTUAL_ID) return virtualCode || "export {}\n";
+          if (id === VIRTUAL_ID) return virtualCode ?? "export {}\n";
         },
         generateBundle() {
           if (!virtualCode || !entryRefId) return;
@@ -204,7 +203,7 @@ process.on('beforeExit', () => shutdown('beforeExit'))
         }
       };
     }
-    _nuxt.hooks.hook("nitro:config", (nitroConfig) => {
+    nuxt.hooks.hook("nitro:config", (nitroConfig) => {
       nitroConfig.rollupConfig = nitroConfig.rollupConfig ?? {};
       const plugin = createWorkersRollupPlugin();
       const current = nitroConfig.rollupConfig.plugins;

package/dist/runtime/server/utils/workers.d.ts

@@ -1,7 +1,18 @@
 import type { Job, JobsOptions, QueueOptions, WorkerOptions, Processor } from 'bullmq';
 import { Queue, Worker } from 'bullmq';
 export declare function $workers(): {
-    setConnection: (connection: QueueOptions["connection"]) => void;
+    setConnection: (connection: string | import("bullmq").ConnectionOptions | (import("ioredis").CommonRedisOptions & import("ioredis").SentinelConnectionOptions & Partial<{
+        port: number;
+        host?: string | undefined | undefined;
+        family?: number | undefined | undefined;
+    } & {
+        path: string;
+    }> & {
+        disconnectTimeout?: number;
+        tls?: import("tls").ConnectionOptions;
+    } & {
+        url?: string;
+    })) => void;
     createQueue: (name: string, options?: Omit<QueueOptions, "connection"> & {
         defaultJobOptions?: JobsOptions;
     }) => Queue<any, any, string, any, any, string>;

package/dist/runtime/server/utils/workers.js

@@ -1,4 +1,5 @@
 import { Queue, Worker } from "bullmq";
+import IORedis from "ioredis";
 const registry = {
   connection: void 0,
   queues: [],
@@ -6,7 +7,14 @@ const registry = {
 };
 export function $workers() {
   function setConnection(connection) {
-    registry.connection = connection;
+    if (connection && typeof connection === "object" && "url" in connection && connection.url) {
+      const { url, ...rest } = connection;
+      registry.connection = new IORedis(url, rest);
+    } else if (typeof connection === "string") {
+      registry.connection = new IORedis(connection);
+    } else {
+      registry.connection = connection;
+    }
   }
   function createQueue(name, options) {
     const queue = new Queue(name, {

package/dist/shared/{nuxt-processor.BqsFQtIQ.cjs → nuxt-processor.BYUls4Ut.cjs}

@@ -1,7 +1,7 @@
 'use strict';
 
 const name = "nuxt-processor";
-const version = "0.0.4";
+const version = "0.0.6";
 const description = "Nuxt Processor";
 const configKey = "processor";
 const compatibility = {

package/dist/shared/{nuxt-processor.BDPWtq8T.mjs → nuxt-processor.BhHJSy2L.mjs}

@@ -1,5 +1,5 @@
 const name = "nuxt-processor";
-const version = "0.0.4";
+const version = "0.0.6";
 const description = "Nuxt Processor";
 const configKey = "processor";
 const compatibility = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-processor",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "Nuxt Processor",
   "repository": "https://github.com/aidanhibbard/nuxt-processor",
   "license": "MIT",
@@ -38,6 +38,7 @@
     "release": "npm run lint && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
     "lint": "eslint .",
     "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
     "test:watch": "vitest watch",
     "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit",
     "vp:dev": "vitepress dev docs",
@@ -46,9 +47,9 @@
   },
   "dependencies": {
     "@nuxt/kit": "^4.0.3",
+    "bullmq": "^5.58.2",
     "citty": "^0.1.6",
     "consola": "^3.2.3",
-    "bullmq": "^5.58.2",
     "fast-glob": "^3.3.3",
     "ioredis": "^5.7.0",
     "pathe": "^1.1.2"
@@ -61,6 +62,7 @@
     "@nuxt/schema": "^4.0.3",
     "@nuxt/test-utils": "^3.19.2",
     "@types/node": "latest",
+    "@vitest/coverage-v8": "^3.2.4",
     "changelogen": "^0.6.2",
     "eslint": "^9.34.0",
     "happy-dom": "^18.0.1",