fastify-rabbitmq 3.0.0 → 3.1.0

package/README.md

@@ -26,46 +26,46 @@ npm install fastify-rabbitmq
 ## Basic Usage
 
 Register this as a plugin.
-Make sure it is loaded before any ***routes*** are loaded.
+Make sure it is loaded before any **_routes_** are loaded.
 
 ### Quick Setup on the Server Side
 
 ```typescript
 export default fp<FastifyRabbitMQOptions>((fastify, options, done) => {
-
-   void fastify.register(fastifyRabbit, {
-      connection: `amqp://guest:guest@localhost`
-   })
-
-   void fastify.ready().then(async () => {
-
-     const consumer = fastify.rabbitmq.createConsumer({
-       queue: 'foo',
-       queueOptions: {durable: true}
-     }, async (msg: any) => {
-        console.log(msg) // ==> bar
-     })
-      
-   })
-  
+  void fastify.register(fastifyRabbit, {
+    connection: `amqp://guest:guest@localhost`,
+  });
+
+  void fastify.ready().then(async () => {
+    const consumer = fastify.rabbitmq.createConsumer(
+      {
+        queue: "foo",
+        queueOptions: { durable: true },
+      },
+      async (msg: any) => {
+        console.log(msg); // ==> bar
+      },
+    );
+  });
 });
 ```
+
 ### Quick Setup on the Client Side
 
-Within any "endpoint" function, or if you have access to ```fastify.rabbitmq``` you can then call:
+Within any "endpoint" function, or if you have access to `fastify.rabbitmq` you can then call:
 
 ```js
-fastify.get('/rabbitmq', async (request, reply) => {
-   let pub = request.rabbitmq.createPublisher({
-      confirm: true,
-      maxAttempts: 1
-   })
-
-   await pub.send('foo', "bar") // ==> sent to foo queue
-})
+fastify.get("/rabbitmq", async (request, reply) => {
+  let pub = request.rabbitmq.createPublisher({
+    confirm: true,
+    maxAttempts: 1,
+  });
+
+  await pub.send("foo", "bar"); // ==> sent to foo queue
+});
 ```
 
-Sending the string ```bar``` to the queue called ```foo```.
+Sending the string `bar` to the queue called `foo`.
 
 ## Full Documentation
 
@@ -73,10 +73,10 @@ Sending the string ```bar``` to the queue called ```foo```.
 
 ```typescript
 export interface FastifyRabbitMQOptions {
-   /** Connection String or object pointing to the RabbitMQ Broker Services */
-   connection: string | ConnectionOptions
-   /** To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time. */
-   namespace?: string
+  /** Connection String or object pointing to the RabbitMQ Broker Services */
+  connection: string | ConnectionOptions;
+  /** To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time. */
+  namespace?: string;
 }
 ```
 
@@ -85,14 +85,13 @@ export interface FastifyRabbitMQOptions {
 ##### `connection`
 
 Connection String or object pointing to the RabbitMQ Broker Services.
-This can be an object of ```ConnectionOptions``` from the ```rabbitmq-client``` plugin options.
+This can be an object of `ConnectionOptions` from the `node-rabbitmq-client` plugin options.
 
 ##### `namespace`
 
 If you need more than one "connection" to a different set and/or array of RabbitMQ servers,
 either on network or cloud, each registration of the plugin needs it to be in its own namespace.
-If not provided, your application will fail to load.
-
+If the name space is duplicated, it will fail to load.
 
 ## Acknowledgements
 

package/lib/cjs/errors.js

@@ -7,9 +7,9 @@ exports.errors = void 0;
 const error_1 = __importDefault(require("@fastify/error"));
 exports.errors = {
     /** Error if there is an invalid option used during registration. */
-    FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS: (0, error_1.default)('FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS', 'Invalid options: %s'),
+    FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS: (0, error_1.default)("FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS", "Invalid options: %s"),
     /** Error if there is an setup error of the plugin itself. */
-    FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS: (0, error_1.default)('FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS', 'Setup error: %s'),
+    FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS: (0, error_1.default)("FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS", "Setup error: %s"),
     /** If an invalid usage error was done, this error would pop up. */
-    FASTIFY_RABBIT_MQ_ERR_USAGE: (0, error_1.default)('FASTIFY_RABBIT_MQ_ERR_USAGE', 'Usage error: %s')
+    FASTIFY_RABBIT_MQ_ERR_USAGE: (0, error_1.default)("FASTIFY_RABBIT_MQ_ERR_USAGE", "Usage error: %s"),
 };

package/lib/cjs/index.js

@@ -23,29 +23,30 @@ const rabbitmq_client_1 = require("rabbitmq-client");
 const errors_js_1 = require("./errors.js");
 const validation_js_1 = require("./validation.js");
 __exportStar(require("./types.js"), exports);
+/* eslint-disable  @typescript-eslint/no-explicit-any */
 const decorateFastifyInstance = (fastify, options, connection) => {
-    const { namespace = '' } = options;
-    if (typeof namespace !== 'undefined' && namespace !== '') {
-        fastify.log.debug('[fastify-rabbitmq] Namespace Attempt: %s', namespace);
+    const { namespace = "" } = options;
+    if (typeof namespace !== "undefined" && namespace !== "") {
+        fastify.log.debug("[fastify-rabbitmq] Namespace Attempt: %s", namespace);
     }
-    if (typeof namespace !== 'undefined' && namespace !== '') {
-        if (typeof fastify.rabbitmq === 'undefined') {
-            fastify.decorate('rabbitmq', Object.create(null));
+    if (typeof namespace !== "undefined" && namespace !== "") {
+        if (typeof fastify.rabbitmq === "undefined") {
+            fastify.decorate("rabbitmq", Object.create(null));
         }
-        if (typeof fastify.rabbitmq[namespace] !== 'undefined') {
+        if (typeof fastify.rabbitmq[namespace] !== "undefined") {
             throw new errors_js_1.errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS(`Already registered with namespace: ${namespace}`);
         }
-        fastify.log.trace('[fastify-rabbitmq] Decorate Fastify with Namespace: %', namespace);
+        fastify.log.trace("[fastify-rabbitmq] Decorate Fastify with Namespace: %", namespace);
         fastify.rabbitmq[namespace] = connection;
     }
     else {
-        if (typeof fastify.rabbitmq !== 'undefined') {
-            throw new errors_js_1.errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS('Already registered.');
+        if (typeof fastify.rabbitmq !== "undefined") {
+            throw new errors_js_1.errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS("Already registered.");
         }
     }
-    if (typeof fastify.rabbitmq === 'undefined') {
-        fastify.log.trace('[fastify-rabbitmq] Decorate Fastify');
-        fastify.decorate('rabbitmq', connection);
+    if (typeof fastify.rabbitmq === "undefined") {
+        fastify.log.trace("[fastify-rabbitmq] Decorate Fastify");
+        fastify.decorate("rabbitmq", connection);
     }
 };
 exports.decorateFastifyInstance = decorateFastifyInstance;

package/lib/cjs/validation.js

@@ -4,12 +4,12 @@ exports.validateOpts = void 0;
 const errors_js_1 = require("./errors.js");
 const validateOpts = async (options) => {
     // Mandatory
-    if (typeof options.connection === 'undefined') {
-        throw new errors_js_1.errors.FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS('connection or findServers must be defined.');
+    if (typeof options.connection === "undefined") {
+        throw new errors_js_1.errors.FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS("connection or findServers must be defined.");
     }
     // Mandatory
-    if (typeof options.connection !== 'undefined') {
-        if (typeof options.connection !== 'object') {
+    if (typeof options.connection !== "undefined") {
+        if (typeof options.connection !== "object") {
             // we need to do some sort of check here to make sure RabbitMQOptions is "valid"
         }
     }

package/lib/esm/decorate.d.ts

@@ -1,13 +1,13 @@
-import { ConnectionOptions } from 'rabbitmq-client';
+import { ConnectionOptions } from "rabbitmq-client";
 export interface FastifyRabbitMQOptions {
     /**
      * @since 1.0.0
-     * @description Connection String or object pointing to the RabbitMQ Broker Services
+     * @remarks Connection String or object pointing to the RabbitMQ Broker Services
      */
     connection: string | ConnectionOptions;
     /**
      * @since 1.0.0
-     * @description To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time.
+     * @remarks To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time.
      */
     namespace?: string;
 }

package/lib/esm/errors.js

@@ -1,9 +1,9 @@
-import createError from '@fastify/error';
+import createError from "@fastify/error";
 export const errors = {
     /** Error if there is an invalid option used during registration. */
-    FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS: createError('FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS', 'Invalid options: %s'),
+    FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS: createError("FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS", "Invalid options: %s"),
     /** Error if there is an setup error of the plugin itself. */
-    FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS: createError('FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS', 'Setup error: %s'),
+    FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS: createError("FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS", "Setup error: %s"),
     /** If an invalid usage error was done, this error would pop up. */
-    FASTIFY_RABBIT_MQ_ERR_USAGE: createError('FASTIFY_RABBIT_MQ_ERR_USAGE', 'Usage error: %s')
+    FASTIFY_RABBIT_MQ_ERR_USAGE: createError("FASTIFY_RABBIT_MQ_ERR_USAGE", "Usage error: %s"),
 };

package/lib/esm/index.d.ts

@@ -1,7 +1,7 @@
-import { FastifyInstance } from 'fastify';
-import { ConnectionOptions } from 'rabbitmq-client';
-import { FastifyRabbitMQOptions } from './decorate.js';
-export * from './types.js';
+import { FastifyInstance } from "fastify";
+import { ConnectionOptions } from "rabbitmq-client";
+import { FastifyRabbitMQOptions } from "./decorate.js";
+export * from "./types.js";
 declare const decorateFastifyInstance: (fastify: FastifyInstance, options: FastifyRabbitMQOptions, connection: any) => void;
 /**
  * Main Function

package/lib/esm/index.js

@@ -1,31 +1,32 @@
-import fp from 'fastify-plugin';
-import { Connection as RabbitMQConnection } from 'rabbitmq-client';
-import { errors } from './errors.js';
-import { validateOpts } from './validation.js';
-export * from './types.js';
+import fp from "fastify-plugin";
+import { Connection as RabbitMQConnection, } from "rabbitmq-client";
+import { errors } from "./errors.js";
+import { validateOpts } from "./validation.js";
+export * from "./types.js";
+/* eslint-disable  @typescript-eslint/no-explicit-any */
 const decorateFastifyInstance = (fastify, options, connection) => {
-    const { namespace = '' } = options;
-    if (typeof namespace !== 'undefined' && namespace !== '') {
-        fastify.log.debug('[fastify-rabbitmq] Namespace Attempt: %s', namespace);
+    const { namespace = "" } = options;
+    if (typeof namespace !== "undefined" && namespace !== "") {
+        fastify.log.debug("[fastify-rabbitmq] Namespace Attempt: %s", namespace);
     }
-    if (typeof namespace !== 'undefined' && namespace !== '') {
-        if (typeof fastify.rabbitmq === 'undefined') {
-            fastify.decorate('rabbitmq', Object.create(null));
+    if (typeof namespace !== "undefined" && namespace !== "") {
+        if (typeof fastify.rabbitmq === "undefined") {
+            fastify.decorate("rabbitmq", Object.create(null));
         }
-        if (typeof fastify.rabbitmq[namespace] !== 'undefined') {
+        if (typeof fastify.rabbitmq[namespace] !== "undefined") {
             throw new errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS(`Already registered with namespace: ${namespace}`);
         }
-        fastify.log.trace('[fastify-rabbitmq] Decorate Fastify with Namespace: %', namespace);
+        fastify.log.trace("[fastify-rabbitmq] Decorate Fastify with Namespace: %", namespace);
         fastify.rabbitmq[namespace] = connection;
     }
     else {
-        if (typeof fastify.rabbitmq !== 'undefined') {
-            throw new errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS('Already registered.');
+        if (typeof fastify.rabbitmq !== "undefined") {
+            throw new errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS("Already registered.");
         }
     }
-    if (typeof fastify.rabbitmq === 'undefined') {
-        fastify.log.trace('[fastify-rabbitmq] Decorate Fastify');
-        fastify.decorate('rabbitmq', connection);
+    if (typeof fastify.rabbitmq === "undefined") {
+        fastify.log.trace("[fastify-rabbitmq] Decorate Fastify");
+        fastify.decorate("rabbitmq", connection);
     }
 };
 /**

package/lib/esm/types.d.ts

@@ -1,5 +1,5 @@
-import { Connection as RabbitMQConnection } from 'rabbitmq-client';
-declare module 'fastify' {
+import { Connection as RabbitMQConnection } from "rabbitmq-client";
+declare module "fastify" {
     interface FastifyInstance {
         /** Main Decorator for Fastify **/
         rabbitmq: RabbitMQConnection & fastifyRabbitMQ.FastifyRabbitMQNO;

package/lib/esm/validation.d.ts

@@ -1,2 +1,2 @@
-import { FastifyRabbitMQOptions } from './decorate.js';
+import { FastifyRabbitMQOptions } from "./decorate.js";
 export declare const validateOpts: (options: FastifyRabbitMQOptions) => Promise<void>;

package/lib/esm/validation.js

@@ -1,12 +1,12 @@
-import { errors } from './errors.js';
+import { errors } from "./errors.js";
 export const validateOpts = async (options) => {
     // Mandatory
-    if (typeof options.connection === 'undefined') {
-        throw new errors.FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS('connection or findServers must be defined.');
+    if (typeof options.connection === "undefined") {
+        throw new errors.FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS("connection or findServers must be defined.");
     }
     // Mandatory
-    if (typeof options.connection !== 'undefined') {
-        if (typeof options.connection !== 'object') {
+    if (typeof options.connection !== "undefined") {
+        if (typeof options.connection !== "object") {
             // we need to do some sort of check here to make sure RabbitMQOptions is "valid"
         }
     }

package/lib/types/decorate.d.ts

@@ -1,13 +1,13 @@
-import { ConnectionOptions } from 'rabbitmq-client';
+import { ConnectionOptions } from "rabbitmq-client";
 export interface FastifyRabbitMQOptions {
     /**
      * @since 1.0.0
-     * @description Connection String or object pointing to the RabbitMQ Broker Services
+     * @remarks Connection String or object pointing to the RabbitMQ Broker Services
      */
     connection: string | ConnectionOptions;
     /**
      * @since 1.0.0
-     * @description To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time.
+     * @remarks To set the custom nNamespace within this plugin instance. Used to register this plugin more than one time.
      */
     namespace?: string;
 }

package/lib/types/index.d.ts

@@ -1,7 +1,7 @@
-import { FastifyInstance } from 'fastify';
-import { ConnectionOptions } from 'rabbitmq-client';
-import { FastifyRabbitMQOptions } from './decorate.js';
-export * from './types.js';
+import { FastifyInstance } from "fastify";
+import { ConnectionOptions } from "rabbitmq-client";
+import { FastifyRabbitMQOptions } from "./decorate.js";
+export * from "./types.js";
 declare const decorateFastifyInstance: (fastify: FastifyInstance, options: FastifyRabbitMQOptions, connection: any) => void;
 /**
  * Main Function

package/lib/types/types.d.ts

@@ -1,5 +1,5 @@
-import { Connection as RabbitMQConnection } from 'rabbitmq-client';
-declare module 'fastify' {
+import { Connection as RabbitMQConnection } from "rabbitmq-client";
+declare module "fastify" {
     interface FastifyInstance {
         /** Main Decorator for Fastify **/
         rabbitmq: RabbitMQConnection & fastifyRabbitMQ.FastifyRabbitMQNO;

package/lib/types/validation.d.ts

@@ -1,2 +1,2 @@
-import { FastifyRabbitMQOptions } from './decorate.js';
+import { FastifyRabbitMQOptions } from "./decorate.js";
 export declare const validateOpts: (options: FastifyRabbitMQOptions) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-rabbitmq",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "description": "A Fastify RabbitMQ Plugin Developed in Pure TypeScript.",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -14,18 +14,22 @@
     }
   },
   "files": [
-    "lib/"
+    "lib/",
+    "README.md",
+    "LICENSE"
   ],
   "engines": {
     "node": ">=20.11.0"
   },
   "scripts": {
-    "clean": "rm -rf lib docs coverage",
+    "clean": "rm -rf coverage docs lib temp",
     "build": "tsc -p src/tsconfig.esm.json && tsc -p src/tsconfig.cjs.json && tsc -p src/tsconfig.types.json && ./bin/build-types.sh",
     "build:watch": "tsc -p src/tsconfig.esm.json -w",
-    "npmPkgJsonLint": "npmPkgJsonLint .",
-    "lint": "npmPkgJsonLint . && ts-standard -p src/tsconfig.esm.json | snazzy",
-    "lint:fix": "npmPkgJsonLint . && ts-standard -p src/tsconfig.esm.json --fix | snazzy",
+    "build:watch:cjs": "tsc -p src/tsconfig.cjs.json -w",
+    "npm:lint": "npmPkgJsonLint .",
+    "format": "prettier --write 'README.md' 'src/**/*.ts' '__tests__/**/*.ts'",
+    "lint": "npm run npm:lint && eslint | snazzy",
+    "lint:fix": "npm run npm:lint && eslint --fix | snazzy",
     "pack": "npm pack",
     "prepublishOnly": "npm run clean && npm run build && npm run pack",
     "test": "vitest run",
@@ -34,8 +38,6 @@
     "test:coverage": "vitest --coverage",
     "typedoc": "typedoc",
     "typedoc:watch": "typedoc -watch",
-    "semantic-release": "semantic-release",
-    "semantic-release:dry-run": "semantic-release --dry-run",
     "update": "npx npm-check-updates -u --enginesNode && npm run update:post-update",
     "update:post-update": "npm install && npm run test"
   },
@@ -59,29 +61,32 @@
   "dependencies": {
     "@fastify/error": "^4.0.0",
     "fastify-plugin": "^5.0.1",
-    "rabbitmq-client": "^5.0.0"
+    "rabbitmq-client": "^5.0.1"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "@the-rabbit-hole/semantic-release-config": "^1.5.0",
-    "@types/node": "^22.8.5",
-    "@types/randomstring": "^1.3.0",
-    "@typescript-eslint/parser": "^8.12.2",
-    "@vitest/coverage-v8": "^2.1.4",
-    "@vitest/ui": "^2.1.4",
-    "fastify": "^5.0.0",
-    "npm-check-updates": "^17.1.9",
+    "@eslint/js": "^9.15.0",
+    "@shipgirl/typedoc-plugin-versions": "^0.2.8",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.9.0",
+    "@types/tcp-port-used": "^1.0.4",
+    "@typescript-eslint/eslint-plugin": "^8.14.0",
+    "@typescript-eslint/parser": "^8.14.0",
+    "@vitest/coverage-v8": "^2.1.5",
+    "@vitest/ui": "^2.1.5",
+    "eslint": "^9.14.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
+    "fastify": "^5.1.0",
+    "npm-check-updates": "^17.1.11",
     "npm-package-json-lint": "^8.0.0",
     "pre-commit": "^1.2.2",
-    "semantic-release": "^24.2.0",
     "snazzy": "^9.0.0",
     "ts-node": "^10.9.2",
-    "ts-standard": "^12.0.2",
     "tsd": "^0.31.2",
-    "typedoc": "^0.26.10",
+    "typedoc": "^0.26.11",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.4"
+    "typescript-eslint": "^8.14.0",
+    "vitest": "^2.1.5"
   },
   "precommit": [
     "test",