nuxt-processor 0.0.7 → 0.0.9

package/README.md

@@ -5,10 +5,9 @@
 [![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)
 
-## 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" />
+## Scalable processing for Nuxt
 
+<img width="512" height="250" alt="image" src="https://github.com/user-attachments/assets/d238fb33-8373-46ec-b132-85170ab67c80" />
 
 Note: This package is under very active development! Please consider creating issues if you run into anything!
 
@@ -34,7 +33,7 @@ Note: This package is under very active development! Please consider creating is
 ## Install
 
 ```bash
-npm i -D nuxt-processor
+npx nuxi@latest module add nuxt-processor
 ```
 
 Add the module in `nuxt.config.ts` and set your Redis connection.
@@ -65,7 +64,11 @@ Create `server/queues/hello.ts`:
 ```ts
 import { defineQueue } from '#processor'
 
-export default defineQueue({
+type HelloName = 'hello'
+type HelloData = { message: string, ts: number }
+type HelloResult = { echoed: string, processedAt: number }
+
+export default defineQueue<HelloData, HelloResult, HelloName>({
   name: 'hello',
   options: {},
 })
@@ -77,14 +80,15 @@ Create `server/workers/hello.ts`:
 
 ```ts
 import { defineWorker } from '#processor'
-import type { Job } from '#bullmq'
 
-export default defineWorker({
+type HelloName = 'hello'
+type HelloData = { message: string, ts: number }
+type HelloResult = { echoed: string, processedAt: number }
+
+export default defineWorker<HelloName, HelloData, HelloResult>({
   name: 'hello',
-  async processor(job: Job) {
-    // do work
-    console.log('processed', job.name, job.data)
-    return job.data
+  async processor(job) {
+    return { echoed: job.data.message, processedAt: job.data.ts }
   },
   options: {},
 })

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.DGLbEfyc.cjs');
+const _package = require('./shared/nuxt-processor.gTQ3Cgq_.cjs');
 
 const ensureNuxtProject = async (args) => {
   const dir = pathe.resolve(args.dir);

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.4D52SGZK.mjs';
+import { v as version, d as description, n as name } from './shared/nuxt-processor.DyQoQGHF.mjs';
 
 const ensureNuxtProject = async (args) => {
   const dir = resolve(args.dir);

package/dist/module.cjs

@@ -1,7 +1,7 @@
 'use strict';
 
 const kit = require('@nuxt/kit');
-const _package = require('./shared/nuxt-processor.DGLbEfyc.cjs');
+const _package = require('./shared/nuxt-processor.gTQ3Cgq_.cjs');
 const node_path = require('node:path');
 const fg = require('fast-glob');
 
@@ -47,6 +47,19 @@ const module$1 = kit.defineNuxtModule({
   },
   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 nitroPlugin = `
+    import { $workers } from '#processor-utils'
+
+    export default defineNitroPlugin(() => {
+      $workers().setConnection(${JSON.stringify(_options.redis)})
+    })
+    `;
+    const tpl = kit.addTemplate({
+      filename: "0.processor-nuxt-plugin.ts",
+      write: true,
+      getContents: () => nitroPlugin
+    });
+    kit.addServerPlugin(tpl.dst);
     function generateWorkersEntryContent(workerFiles) {
       const redisInline = JSON.stringify(_options.redis ?? {});
       const toImportArray = workerFiles.map((id) => `() => import(${JSON.stringify(id)})`).join(",\n    ");

package/dist/module.json

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

package/dist/module.mjs

@@ -1,5 +1,5 @@
-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.4D52SGZK.mjs';
+import { useNuxt, createResolver, defineNuxtModule, addTemplate, addServerPlugin, addTypeTemplate } from '@nuxt/kit';
+import { c as configKey, a as compatibility, v as version, n as name } from './shared/nuxt-processor.DyQoQGHF.mjs';
 import { relative } from 'node:path';
 import fg from 'fast-glob';
 
@@ -40,6 +40,19 @@ const module = defineNuxtModule({
   },
   async setup(_options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
+    const nitroPlugin = `
+    import { $workers } from '#processor-utils'
+
+    export default defineNitroPlugin(() => {
+      $workers().setConnection(${JSON.stringify(_options.redis)})
+    })
+    `;
+    const tpl = addTemplate({
+      filename: "0.processor-nuxt-plugin.ts",
+      write: true,
+      getContents: () => nitroPlugin
+    });
+    addServerPlugin(tpl.dst);
     function generateWorkersEntryContent(workerFiles) {
       const redisInline = JSON.stringify(_options.redis ?? {});
       const toImportArray = workerFiles.map((id) => `() => import(${JSON.stringify(id)})`).join(",\n    ");

package/dist/runtime/server/handlers/defineQueue.d.ts

@@ -1,9 +1,9 @@
 import type { Queue, QueueOptions, JobsOptions } from '../utils/workers.js';
-type DefineQueueArgs = {
-    name: Queue['name'];
+type DefineQueueArgs<DefaultNameType extends string = string> = {
+    name: DefaultNameType;
     options?: Omit<QueueOptions, 'connection'> & {
         defaultJobOptions?: JobsOptions;
     };
 };
-export declare function defineQueue({ name, options }: DefineQueueArgs): Queue;
+export declare function defineQueue<DataTypeOrJob = any, DefaultResultType = any, DefaultNameType extends string = string>({ name, options }: DefineQueueArgs<DefaultNameType>): Queue<DataTypeOrJob, DefaultResultType, DefaultNameType>;
 export default defineQueue;

package/dist/runtime/server/handlers/defineWorker.d.ts

@@ -1,8 +1,8 @@
 import type { Worker, WorkerOptions, Processor } from 'bullmq';
-type DefineWorkerArgs = {
-    name: Worker['name'];
-    processor: Processor;
+type DefineWorkerArgs<NameType extends string = string, DataType = any, ResultType = any> = {
+    name: NameType;
+    processor: Processor<DataType, ResultType, NameType>;
     options?: Omit<WorkerOptions, 'connection'>;
 };
-export declare function defineWorker(args: DefineWorkerArgs): Worker;
+export declare function defineWorker<NameType extends string = string, DataType = any, ResultType = any>(args: DefineWorkerArgs<NameType, DataType, ResultType>): Worker<DataType, ResultType, NameType>;
 export default defineWorker;

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

@@ -13,12 +13,12 @@ export declare function $workers(): {
     } & {
         url?: string;
     })) => void;
-    createQueue: (name: string, options?: Omit<QueueOptions, "connection"> & {
+    createQueue: <DataTypeOrJob = any, DefaultResultType = any, DefaultNameType extends string = string>(name: DefaultNameType, options?: Omit<QueueOptions, "connection"> & {
         defaultJobOptions?: JobsOptions;
-    }) => Queue<any, any, string, any, any, string>;
-    createWorker: (name: string, processor: Processor, options?: Omit<WorkerOptions, "connection">) => Worker<any, any, string>;
+    }) => Queue<DataTypeOrJob, DefaultResultType, DefaultNameType>;
+    createWorker: <DataType = any, ResultType = any, NameType extends string = string>(name: NameType, processor: Processor<DataType, ResultType, NameType>, options?: Omit<WorkerOptions, "connection">) => Worker<DataType, ResultType, NameType>;
     stopAll: () => Promise<void>;
-    readonly queues: Queue<any, any, string, any, any, string>[];
-    readonly workers: Worker<any, any, string>[];
+    readonly queues: Queue<any, any, any, any, any, any>[];
+    readonly workers: Worker<any, any, any>[];
 };
 export type { Queue, Worker, Processor, QueueOptions, WorkerOptions, JobsOptions, Job };

package/dist/shared/{nuxt-processor.4D52SGZK.mjs → nuxt-processor.DyQoQGHF.mjs}

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

package/dist/shared/{nuxt-processor.DGLbEfyc.cjs → nuxt-processor.gTQ3Cgq_.cjs}

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-processor",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Nuxt Processor",
   "repository": "https://github.com/aidanhibbard/nuxt-processor",
   "license": "MIT",