fastify-rabbitmq 2.0.0 → 2.1.0

package/lib/cjs/errors.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errors = void 0;
-var error_1 = __importDefault(require("@fastify/error"));
+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'),

package/lib/cjs/index.js

@@ -13,54 +13,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.decorateFastifyInstance = void 0;
-var fastify_plugin_1 = __importDefault(require("fastify-plugin"));
-var rabbitmq_client_1 = require("rabbitmq-client");
-var errors_js_1 = require("./errors.js");
-var validation_js_1 = require("./validation.js");
+const fastify_plugin_1 = __importDefault(require("fastify-plugin"));
+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);
-var decorateFastifyInstance = function (fastify, options, connection) {
-    var _a = options.namespace, namespace = _a === void 0 ? '' : _a;
+const decorateFastifyInstance = (fastify, options, connection) => {
+    const { namespace = '' } = options;
     if (typeof namespace !== 'undefined' && namespace !== '') {
         fastify.log.debug('[fastify-rabbitmq] Namespace Attempt: %s', namespace);
     }
@@ -69,7 +33,7 @@ var decorateFastifyInstance = function (fastify, options, connection) {
             fastify.decorate('rabbitmq', Object.create(null));
         }
         if (typeof fastify.rabbitmq[namespace] !== 'undefined') {
-            throw new errors_js_1.errors.FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS("Already registered with namespace: ".concat(namespace));
+            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.rabbitmq[namespace] = connection;
@@ -103,18 +67,10 @@ exports.decorateFastifyInstance = decorateFastifyInstance;
  * @see [https://cody-greene.github.io/node-rabbitmq-client/latest/index.html](https://cody-greene.github.io/node-rabbitmq-client/latest/index.html)
  *
  */
-var fastifyRabbit = (0, fastify_plugin_1.default)(function (fastify, opts) { return __awaiter(void 0, void 0, void 0, function () {
-    var connection, c;
-    return __generator(this, function (_a) {
-        switch (_a.label) {
-            case 0: return [4 /*yield*/, (0, validation_js_1.validateOpts)(opts)];
-            case 1:
-                _a.sent();
-                connection = opts.connection;
-                c = new rabbitmq_client_1.Connection(connection);
-                decorateFastifyInstance(fastify, opts, c);
-                return [2 /*return*/];
-        }
-    });
-}); });
+const fastifyRabbit = (0, fastify_plugin_1.default)(async (fastify, opts) => {
+    await (0, validation_js_1.validateOpts)(opts);
+    const { connection } = opts;
+    const c = new rabbitmq_client_1.Connection(connection);
+    decorateFastifyInstance(fastify, opts, c);
+});
 exports.default = fastifyRabbit;

package/lib/cjs/validation.js

@@ -1,56 +1,17 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOpts = void 0;
-var errors_js_1 = require("./errors.js");
-var validateOpts = function (options) { return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-        // Mandatory
-        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') {
-                // we need to do some sort of check here to make sure RabbitMQOptions is "valid"
-            }
+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.');
+    }
+    // Mandatory
+    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"
         }
-        return [2 /*return*/];
-    });
-}); };
+    }
+};
 exports.validateOpts = validateOpts;

package/lib/esm/decorate.d.ts

@@ -0,0 +1,13 @@
+import { ConnectionOptions } from 'rabbitmq-client';
+export interface FastifyRabbitMQOptions {
+    /**
+     * @since 1.0.0
+     * @description 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.
+     */
+    namespace?: string;
+}

package/lib/esm/errors.d.ts

@@ -0,0 +1,14 @@
+export declare const errors: {
+    /** Error if there is an invalid option used during registration. */
+    FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS: import("@fastify/error").FastifyErrorConstructor<{
+        code: "FASTIFY_RABBIT_MQ_ERR_INVALID_OPTS";
+    }, [any?, any?, any?]>;
+    /** Error if there is an setup error of the plugin itself. */
+    FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS: import("@fastify/error").FastifyErrorConstructor<{
+        code: "FASTIFY_RABBIT_MQ_ERR_SETUP_ERRORS";
+    }, [any?, any?, any?]>;
+    /** If an invalid usage error was done, this error would pop up. */
+    FASTIFY_RABBIT_MQ_ERR_USAGE: import("@fastify/error").FastifyErrorConstructor<{
+        code: "FASTIFY_RABBIT_MQ_ERR_USAGE";
+    }, [any?, any?, any?]>;
+};

package/lib/esm/index.d.ts

@@ -0,0 +1,26 @@
+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
+ * @since 1.0.0
+ * @example
+ * This is the basics on how to use this plugin:
+ * ```js
+ * app.register(fastifyRabbit, {
+ *  connection: 'amqp://guest:guest@localhost'
+ * })
+ * ```
+ * This will allow you to read from your Fastify "object" and
+ * use this plugin at the "rabbitmq" level. From there you can execute and maintain
+ * the RabbitMQ Connection using the 'rabbitmq-client' package, which is wrapping around
+ * this plugin to execute functions it provides.
+ *
+ * @see [https://cody-greene.github.io/node-rabbitmq-client/latest/index.html](https://cody-greene.github.io/node-rabbitmq-client/latest/index.html)
+ *
+ */
+declare const fastifyRabbit: import("fastify").FastifyPluginCallback<FastifyRabbitMQOptions, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
+export default fastifyRabbit;
+export { decorateFastifyInstance, FastifyRabbitMQOptions, ConnectionOptions };

package/lib/esm/types.d.ts

@@ -0,0 +1,12 @@
+import { Connection as RabbitMQConnection } from 'rabbitmq-client';
+declare module 'fastify' {
+    interface FastifyInstance {
+        /** Main Decorator for Fastify **/
+        rabbitmq: RabbitMQConnection & fastifyRabbitMQ.FastifyRabbitMQNO;
+    }
+}
+export declare namespace fastifyRabbitMQ {
+    interface FastifyRabbitMQNO {
+        [namespace: string]: RabbitMQConnection;
+    }
+}

package/lib/esm/validation.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fastify-rabbitmq",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "A Fastify RabbitMQ Plugin Developed in Pure TypeScript.",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
@@ -20,12 +20,12 @@
     "node": ">=20.0.0"
   },
   "scripts": {
-    "clean": "rm -rf lib coverage",
-    "build": "tsc -p tsconfig.esm.json && tsc -p tsconfig.cjs.json && tsc -p tsconfig.types.json && ./bin/build-types.sh",
-    "build:watch": "tsc -p tsconfig.esm.json -w",
+    "clean": "rm -rf lib docs coverage",
+    "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 | snazzy",
-    "lint:fix": "npmPkgJsonLint . && ts-standard --fix | snazzy",
+    "lint": "npmPkgJsonLint . && ts-standard -p src/tsconfig.esm.json | snazzy",
+    "lint:fix": "npmPkgJsonLint . && ts-standard -p src/tsconfig.esm.json --fix | snazzy",
     "pack": "npm pack",
     "prepublishOnly": "npm run clean && npm run build && npm run pack",
     "test": "vitest run",
@@ -57,31 +57,31 @@
   },
   "homepage": "https://github.com/Bugs5382/fastify-rabbitmq#readme",
   "dependencies": {
-    "@fastify/error": "^3.4.1",
+    "@fastify/error": "^4.0.0",
     "fastify-plugin": "^4.5.1",
-    "rabbitmq-client": "^4.5.1"
+    "rabbitmq-client": "^4.6.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "@the-rabbit-hole/semantic-release-config": "^1.5.0",
-    "@types/node": "^20.11.24",
-    "@types/randomstring": "^1.1.12",
-    "@typescript-eslint/parser": "^7.1.0",
-    "@vitest/coverage-v8": "^1.3.1",
-    "@vitest/ui": "^1.3.1",
-    "fastify": "^4.26.1",
-    "npm-check-updates": "^16.14.15",
-    "npm-package-json-lint": "^7.1.0",
+    "@types/node": "^20.14.8",
+    "@types/randomstring": "^1.3.0",
+    "@typescript-eslint/parser": "^7.14.1",
+    "@vitest/coverage-v8": "^1.6.0",
+    "@vitest/ui": "^1.6.0",
+    "fastify": "^4.28.0",
+    "npm-check-updates": "^16.14.20",
+    "npm-package-json-lint": "^8.0.0",
     "pre-commit": "^1.2.2",
     "semantic-release": "^23.0.2",
     "snazzy": "^9.0.0",
     "ts-node": "^10.9.2",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.30.7",
-    "typedoc": "^0.25.9",
-    "typescript": "^5.3.3",
-    "vitest": "^1.3.1"
+    "tsd": "^0.31.1",
+    "typedoc": "^0.26.2",
+    "typescript": "^5.5.2",
+    "vitest": "^1.6.0"
   },
   "precommit": [
     "test",