nuxt-bee-queue 1.0.0

package/README.md

@@ -0,0 +1,84 @@
+<!--
+Get your module up and running quickly.
+
+Find and replace all on all files (CMD+SHIFT+F):
+- Name: My Module
+- Package name: my-module
+- Description: My new Nuxt module
+-->
+
+# My Module
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+
+My new Nuxt module for doing amazing things.
+
+- [✨ &nbsp;Release Notes](/CHANGELOG.md)
+<!-- - [🏀 Online playground](https://stackblitz.com/github/your-org/my-module?file=playground%2Fapp.vue) -->
+<!-- - [📖 &nbsp;Documentation](https://example.com) -->
+
+## Features
+
+<!-- Highlight some of the features your module provide here -->
+- ⛰ &nbsp;Foo
+- 🚠 &nbsp;Bar
+- 🌲 &nbsp;Baz
+
+## Quick Setup
+
+Install the module to your Nuxt application with one command:
+
+```bash
+npx nuxi module add my-module
+```
+
+That's it! You can now use My Module in your Nuxt app ✨
+
+
+## Contribution
+
+<details>
+  <summary>Local development</summary>
+  
+  ```bash
+  # Install dependencies
+  npm install
+  
+  # Generate type stubs
+  npm run dev:prepare
+  
+  # Develop with the playground
+  npm run dev
+  
+  # Build the playground
+  npm run dev:build
+  
+  # Run ESLint
+  npm run lint
+  
+  # Run Vitest
+  npm run test
+  npm run test:watch
+  
+  # Release new version
+  npm run release
+  ```
+
+</details>
+
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/my-module/latest.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-version-href]: https://npmjs.com/package/my-module
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[npm-downloads-href]: https://npm.chart.dev/my-module
+
+[license-src]: https://img.shields.io/npm/l/my-module.svg?style=flat&colorA=020420&colorB=00DC82
+[license-href]: https://npmjs.com/package/my-module
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -0,0 +1,9 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+interface ModuleOptions {
+    redis?: string;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -0,0 +1,9 @@
+{
+  "name": "nuxt-bee-queue",
+  "configKey": "nuxtBeeQueue",
+  "version": "1.0.0",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}

package/dist/module.mjs

@@ -0,0 +1,175 @@
+import { useNuxt, createResolver, defineNuxtModule, addServerTemplate, addTemplate, addServerImports } from '@nuxt/kit';
+import { parse, relative } from 'node:path';
+import fs from 'node:fs';
+import fg from 'fast-glob';
+
+const scanFolder = async (path) => {
+  const nuxt = useNuxt();
+  const { resolve } = createResolver(import.meta.url);
+  const resolvedPath = resolve(nuxt.options.rootDir, path);
+  const files = [];
+  const updatedFiles = await fg("**/*.{ts,js,mjs}", {
+    cwd: resolvedPath,
+    absolute: true,
+    onlyFiles: true
+  });
+  files.push(...new Set(updatedFiles));
+  return files;
+};
+
+const module$1 = defineNuxtModule({
+  meta: {
+    name: "nuxt-bee-queue",
+    configKey: "nuxtBeeQueue"
+  },
+  // Default configuration options of the Nuxt module
+  defaults: {
+    redis: "redis://localhost:6379"
+  },
+  async setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url);
+    const jobsDir = resolver.resolve(nuxt.options.serverDir, "job");
+    addServerTemplate({
+      filename: "#queue/bee-queue-jobs.mjs",
+      // Virtual filename
+      getContents: () => {
+        const imports = [];
+        const mapEntries = [];
+        if (fs.existsSync(jobsDir)) {
+          const jobFiles = fs.readdirSync(jobsDir).filter((f) => f.endsWith(".ts") || f.endsWith(".mjs"));
+          jobFiles.forEach((file, index) => {
+            const name = parse(file).name;
+            const importName = `job_${index}`;
+            const absolutePath = resolver.resolve(jobsDir, file);
+            imports.push(`import ${importName} from '${absolutePath}'`);
+            mapEntries.push(`'${name}': ${importName}`);
+          });
+        }
+        return `
+          ${imports.join("\n")}
+          import { createClient } from 'redis';
+
+          export const jobRegistry = {
+            ${mapEntries.join(",\n")}
+          }
+
+          let client = globalThis.redis;
+
+          if (!client) {
+            client = createClient({
+              url: "${options.redis}"
+            });
+
+            client.instanceId = Math.floor(Math.random() * 10000);
+
+            // In Redis v4+, you must explicitly connect
+            if (!client.isOpen) {
+              client.connect().catch(console.error);
+            }
+
+            // Save to global for hot-reloading
+            if (process.env.NODE_ENV !== 'production') {
+              globalThis.redis = client;
+            }
+          }
+
+          export const redis = client;
+        `;
+      }
+    });
+    nuxt.hook("nitro:prepare:types", ({ references }) => {
+      references.push({
+        path: resolver.resolve(nuxt.options.buildDir, "types/bee-queue-jobs.d.ts")
+      });
+    });
+    addTemplate({
+      filename: "types/bee-queue-jobs.d.ts",
+      getContents: () => `
+            declare module '#queue/bee-queue-jobs.mjs' {
+                export const jobRegistry: Record<string, any>;
+                export const redis: RedisClientType;
+            }
+        `
+    });
+    addTemplate({
+      filename: "types/bee-queue-types.d.ts",
+      getContents: () => {
+        const names = [];
+        const jobMappings = [];
+        if (fs.existsSync(jobsDir)) {
+          const jobFiles = fs.readdirSync(jobsDir).filter((f) => f.endsWith(".ts") || f.endsWith(".mjs"));
+          jobFiles.forEach((file, _index) => {
+            const name = parse(file).name;
+            names.push(`"${name}"`);
+            jobMappings.push(`    '${name}': typeof import('~/server/job/${name}').default`);
+          });
+        }
+        return `
+            import type {  RedisClientType } from 'redis'
+            export type JobsNamesType = ${!names.length ? '""' : names.join("|")}
+
+            export interface QueueJobs{
+              ${jobMappings.join("\n")}
+            }
+        `;
+      }
+    });
+    addServerImports({
+      name: "defineJob",
+      as: "defineJob",
+      from: resolver.resolve("./runtime/server/utils/defineJob")
+    });
+    addServerImports([{
+      name: "useQueue",
+      from: resolver.resolve("./runtime/server/utils/useQueue")
+    }]);
+    function createWorkersRollupPlugin() {
+      const VIRTUAL_ID = "\0nuxt-bee-queue-entry";
+      let virtualCode = "";
+      let entryRefId = null;
+      return {
+        name: "nuxt-bee-queue-emit",
+        async buildStart() {
+          const workerFiles = await scanFolder(jobsDir);
+          if (workerFiles.length === 0) {
+            virtualCode = "";
+            return;
+          }
+          virtualCode = fs.readFileSync(resolver.resolve("./template/worker.js"), "utf8");
+          for (const id of workerFiles) {
+            this.addWatchFile(id);
+          }
+          entryRefId = this.emitFile({ type: "chunk", id: VIRTUAL_ID, fileName: "workers/_entry.mjs" });
+        },
+        resolveId(id) {
+          if (id === VIRTUAL_ID) return VIRTUAL_ID;
+        },
+        load(id) {
+          if (id === VIRTUAL_ID) return virtualCode ?? "export {}\n";
+        },
+        generateBundle() {
+          if (!virtualCode || !entryRefId) return;
+          const entryFile = this.getFileName(entryRefId);
+          const fromDir = "workers";
+          const rel = "./" + relative(fromDir, entryFile).split("\\").join("/");
+          const wrapper = fs.readFileSync(resolver.resolve("./template/main.js"), "utf8").replace("{{$rel}}", rel);
+          this.emitFile({ type: "asset", fileName: "workers/index.mjs", source: wrapper });
+        }
+      };
+    }
+    nuxt.hooks.hook("nitro:config", (nitroConfig) => {
+      nitroConfig.rollupConfig = nitroConfig.rollupConfig ?? {};
+      const plugin = createWorkersRollupPlugin();
+      const current = nitroConfig.rollupConfig.plugins;
+      if (Array.isArray(current)) {
+        nitroConfig.rollupConfig.plugins = [...current, plugin];
+      } else if (current) {
+        nitroConfig.rollupConfig.plugins = [current, plugin];
+      } else {
+        nitroConfig.rollupConfig.plugins = [plugin];
+      }
+    });
+  }
+});
+
+export { module$1 as default };

package/dist/runtime/plugin.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nuxt/app").Plugin<Record<string, unknown>> & import("nuxt/app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/plugin.js

@@ -0,0 +1,4 @@
+import { defineNuxtPlugin } from "#app";
+export default defineNuxtPlugin((_nuxtApp) => {
+  console.log("Plugin injected by my-module!");
+});

package/dist/runtime/server/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json",
+}

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

@@ -0,0 +1,7 @@
+import type { Job, DoneCallback, QueueSettings } from 'bee-queue';
+export interface JobHandler<T, D> {
+    concurrency?: number;
+    process: (job: Job<T>, done: DoneCallback<D>) => Promise<unknown> | unknown;
+    setting?: QueueSettings;
+}
+export declare function defineJob<TPayload, TResult>(handler: ((job: Job<TPayload>) => TResult) | JobHandler<TPayload, TResult>): JobHandler<TPayload, TResult>;

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

@@ -0,0 +1,6 @@
+export function defineJob(handler) {
+  if (typeof handler === "function") {
+    return { process: handler };
+  }
+  return handler;
+}

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

@@ -0,0 +1,7 @@
+import type { Job, QueueSettings } from 'bee-queue';
+import BeeQueue from 'bee-queue';
+import type { QueueJobs } from '#build/types/bee-queue-types';
+type ExtractTFromProcess<TProcess> = TProcess extends (job: Job<infer T>, ...args: any[]) => any ? T : never;
+type CustomQueueSettings = Omit<QueueSettings, 'redis' | 'isWorker'>;
+export declare function useQueue<T extends keyof QueueJobs>(name: T, setting?: CustomQueueSettings): BeeQueue<ExtractTFromProcess<QueueJobs[T]["process"]>>;
+export {};

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

@@ -0,0 +1,13 @@
+import BeeQueue from "bee-queue";
+import { redis } from "#queue/bee-queue-jobs.mjs";
+const _queues = {};
+export function useQueue(name, setting) {
+  if (!_queues[name]) {
+    _queues[name] = new BeeQueue(name, {
+      redis,
+      isWorker: false,
+      ...setting
+    });
+  }
+  return _queues[name];
+}

package/dist/types.d.mts

@@ -0,0 +1,3 @@
+export { default } from './module.mjs'
+
+export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "nuxt-bee-queue",
+  "version": "1.0.0",
+  "description": "Nuxt 3/4/5 adapter for bee-queue ",
+  "repository": "https://github.com/nexthis/nuxt-bee-queue",
+  "author": {
+    "name": "Paweł Romanowski",
+    "url": "https://pawel-romanowski.pl/"
+  },
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
+    }
+  },
+  "main": "./dist/module.mjs",
+  "typesVersions": {
+    "*": {
+      ".": [
+        "./dist/types.d.mts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "prepack": "nuxt-module-build build",
+    "dev": "npm run dev:prepare && nuxi dev playground",
+    "dev:build": "nuxi build playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
+    "release": "npm run lint && npm run test && npm run prepack && changelogen --release && npm publish && git push --follow-tags",
+    "lint": "eslint .",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "test:types": "vue-tsc --noEmit && cd playground && vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@nuxt/kit": "^4.2.2",
+    "bee-queue": "^2.0.0",
+    "fast-glob": "^3.3.3",
+    "redis": "^5.10.0"
+  },
+  "devDependencies": {
+    "@nuxt/devtools": "^3.1.1",
+    "@nuxt/eslint-config": "^1.12.1",
+    "@nuxt/module-builder": "^1.0.2",
+    "@nuxt/schema": "^4.2.2",
+    "@nuxt/test-utils": "^3.21.0",
+    "@types/node": "latest",
+    "changelogen": "^0.6.2",
+    "eslint": "^9.39.2",
+    "nuxt": "^4.2.2",
+    "typescript": "~5.9.3",
+    "vitest": "^4.0.16",
+    "vue-tsc": "^3.2.1"
+  }
+}