fastify-rabbitmq 0.0.1-alpha.2 → 1.0.0

package/README.md

@@ -1,140 +1,89 @@
-# Fastify RabbitMq
+# Fastify RabbitMQ
 
 A Fastify RabbitMQ Plugin Developed in Pure TypeScript.
-It uses the [node-amqp-connection-manager](https://github.com/jwalton/node-amqp-connection-manager) plugin as a wrapper.
+It uses the [rabbitmq-client](https://github.com/jwalton/node-amqp-connection-manager) plugin as a wrapper.
 
-This comes right from the README on ```node-amqp-connection-manager```:
-
-> Features
-> * Automatically reconnect when your amqplib broker dies in a fire.
-> * Round-robin connections between multiple brokers in a cluster.
-> * If messages are sent while the broker is unavailable, queues messages in memory until we reconnect.
-> * Supports both promises and callbacks (using promise-breaker)
-> * Very un-opinionated library—a thin wrapper around amqplib.
-
-## Notice
-
-This NPM package is still going **active development** so things will break. Review the issues list for on going development work and if you want to help out, submit a PR.
-
-Help Wanted:
-* Documentation
-* GitHub Workflows
-* Unit Testing using Jest
+The build exports this to valid ESM and CJS for ease of cross-compatibility.
 
 ## Table of Contents
 
-1. [Notice](#notice)
-2. [Install](#install)
+1. [Install](#install)
 2. [Basic Usage](#basic-usage)
 3. [Full Documentation](#full-documentation)
-   1. [Options](#options)
+   1) [Options](#options)
 4. [Acknowledgements](#acknowledgements)
 5. [License](#license)
 
 ## Install
-```
-npm i fastify-rabbitmq amqplib
-npm i --save-dev @types/amqplib
+
+```markdown
+npm i fastify-rabbitmq
 ```
 
 ## Basic Usage
+
 Register this as a plugin.
 Make sure it is loaded before any ***routes*** are loaded.
 
 ### Quick Setup on the Server Side
 
 ```typescript
-export default fp<any>(async (fastify: FastifyInstance, options: FastifyPluginOptions) => {
-  
-   fastify.register(fastifyRabbit, {
-      urLs: ['amqp://localhost']
+export default fp<FastifyRabbitMQOptions>((fastify, options, done) => {
+
+   void fastify.register(fastifyRabbit, {
+      connection: `amqp://guest:guest@localhost`
    })
 
-   fastify.ready().then(async () => {
-      fastify.log.debug('[rabbitmq] Started RabbitMQ')
-      fastify.rabbitmq.channel = fastify.rabbitmq.createChannel({
-         json: true,
-         setup: function (channel: ConfirmChannel) {
-            return Promise.all([
-               channel.assertQueue('server', {durable: true}),
-               channel.prefetch(1),
-               channel.consume('server', async (message) => {
-                  fastify.log.debug(JSON.stringify(data))
-                  fastify.rabbitmq.channel?.ack(message);
-               })
-            ]);
-         },
-      })
+   void fastify.ready().then(async () => {
+
+     const snowAssignAssetTag = fastify.rabbitmq.createConsumer({
+       queue: 'foo',
+       queueOptions: {durable: true}
+     }, async (msg: any) => {
+        console.log(msg) // ==> bar
+     })
+      
    })
-   
+  
 });
 ```
 
-Within server instance can also call the same queue as long as it has access to the ``fastify.rabbitmq`` decorator.
-Traditionally, a separate app is running and is the client sending messages to the client.
-
-### Quick Setup on the Client Side
-
-First set up your plugin to register the plugin.
-
-```typescript
-import {ConfirmChannel} from "amqplib";
-import {
-   FastifyInstance,
-   FastifyPluginOptions,
-} from 'fastify';
-import fp from "fastify-plugin";
-import fastifyRabbit from "fastify-rabbitmq"
-
-export default fp<any>(async (fastify: FastifyInstance, options: FastifyPluginOptions) => {
-
-  fastify.register(fastifyRabbit, {
-    urLs: ['amqp://localhost']
-  })
+Within any "endpoint" function, or if you have access to ```fastify.rabbitmq``` you can then call:
 
-  fastify.ready().then(async () => {
-
-    fastify.rabbitmq.channel = fastify.rabbitmq.createChannel({
-      json: true,
-      setup: function (channel: ConfirmChannel) {
-        return channel.assertQueue('client', { durable: true });
-      }
-    });
-
-  })
+```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
 })
 ```
 
-Now in your routes or anywhere the fastify.rabbitmq can be accessed:
+Sending the string ```bar``` to the queue called ```foo```.
 
-```typescript
-fastify.get('/rabbitmq', {}, async (request, reply) => {
-   try {
-      fastify.rabbitmq.channel?.sendToQueue('server', { foo: 'bar'})
-      return reply.code(200).send({ result: true});
-   } catch (error) {
-      return reply.send(404);
-   }
-});
-```
+### Quick Setup on the Client Side
 
 ## Full Documentation
 
 ### Options
 
 ```typescript
-export interface FastifyRabbitMQOptions extends AmqpConnectionManagerOptions {
-   logLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error'
+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
-   urLs: ConnectionUrl | ConnectionUrl[] | undefined | null
 }
 ```
+
 #### FastifyRabbitMQOptions
 
-##### `logLevel`
+##### `connection`
 
-Set the log level for Fastify RabbitMQ plugin. This is usefull for development work. The default value is ```silent```
+Connection String or object pointing to the RabbitMQ Broker Services.
+This can be an object of ```ConnectionOptions``` from the ```rabbitmq-client``` plugin options.
 
 ##### `namespace`
 
@@ -142,36 +91,12 @@ If you need more than one "connection" to a different set and/or array of Rabbit
 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.
 
-##### `urLs`
-
-This needs to be an array of the RabbitMQ host:
-
-```typescript
-fastify.register(fastifyRabbit, {
-  urLs: ['amqp://localhost']
-})
-```
-
-This is not needed
-if you use AmqpConnectionManagerOptions [findServers](https://github.com/jwalton/node-amqp-connection-manager#connecturls-options)
-which overrides the urls value if it's set.
-If you need
-to pass in credentials to the RabbitMQ or vHost for the connection review the [connection options](#amqpconnectionmanageroptions).
-
-Please review the options [here](https://github.com/jwalton/node-amqp-connection-manager/blob/master/src/AmqpConnectionManager.ts#L26C13-L26C34).
-(Note:
-This URL might bring you to the wrong line
-if the file has been changed on the ```node-amqp-connection-manager``` package.)
-
-#### ```AmqpConnectionManagerOptions```
-
-See [Connection Options](https://github.com/jwalton/node-amqp-connection-manager#connecturls-options) for 'node-amqp-connection-manager' for detailed options that can be passed in.
 
 ## Acknowledgements
 
-- [node-amqp-connection-manager](https://github.com/jwalton/node-amqp-connection-manager)
+- [rabbitmq-client](https://www.npmjs.com/package/rabbitmq-client)
 - [fastify](https://fastify.dev/)
-- ...and of course my Wife and Baby Girl.
+- ... and my Wife and Baby Girl.
 
 ## License
 

package/dist/cjs/decorate.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/errors.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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'),
+    /** 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'),
+    /** 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')
+};

package/dist/cjs/index.js

@@ -0,0 +1,75 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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);
+const decorateFastifyInstance = (fastify, options, connection) => {
+    const { namespace = '' } = options;
+    if (typeof namespace !== 'undefined') {
+        fastify.log.debug('[fastify-rabbitmq] Namespace: %s', namespace);
+    }
+    if (typeof namespace !== 'undefined' && namespace !== '') {
+        if (typeof fastify.rabbitmq === 'undefined') {
+            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: ${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') {
+        fastify.log.trace('[fastify-rabbitmq] Decorate Fastify');
+        fastify.decorate('rabbitmq', connection);
+    }
+};
+/**
+ * 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)
+ *
+ */
+const fastifyRabbit = (0, fastify_plugin_1.default)(async (fastify, opts, done) => {
+    await (0, validation_js_1.validateOpts)(opts);
+    const { connection } = opts;
+    const c = new rabbitmq_client_1.Connection(connection);
+    decorateFastifyInstance(fastify, opts, c);
+    done();
+});
+exports.default = fastifyRabbit;

package/dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/dist/cjs/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/validation.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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.');
+    }
+    // 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"
+        }
+    }
+};
+exports.validateOpts = validateOpts;

package/dist/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/dist/esm/decorate.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=decorate.js.map

package/dist/esm/decorate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decorate.js","sourceRoot":"","sources":["../../src/decorate.ts"],"names":[],"mappings":""}

package/dist/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/dist/esm/errors.js

@@ -0,0 +1,10 @@
+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'),
+    /** 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'),
+    /** 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')
+};
+//# sourceMappingURL=errors.js.map

package/dist/esm/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,gBAAgB,CAAA;AAExC,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,oEAAoE;IACpE,kCAAkC,EAAE,WAAW,CAC7C,oCAAoC,EACpC,qBAAqB,CACtB;IACD,6DAA6D;IAC7D,kCAAkC,EAAE,WAAW,CAC7C,oCAAoC,EACpC,iBAAiB,CAClB;IACD,mEAAmE;IACnE,2BAA2B,EAAE,WAAW,CACtC,6BAA6B,EAC7B,iBAAiB,CAClB;CACF,CAAA"}

package/dist/esm/index.d.ts

@@ -0,0 +1,22 @@
+import { FastifyRabbitMQOptions } from './decorate.js';
+export * from './types.js';
+/**
+ * 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;

package/dist/esm/index.js

@@ -0,0 +1,57 @@
+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';
+const decorateFastifyInstance = (fastify, options, connection) => {
+    const { namespace = '' } = options;
+    if (typeof namespace !== 'undefined') {
+        fastify.log.debug('[fastify-rabbitmq] Namespace: %s', namespace);
+    }
+    if (typeof namespace !== 'undefined' && namespace !== '') {
+        if (typeof fastify.rabbitmq === 'undefined') {
+            fastify.decorate('rabbitmq', Object.create(null));
+        }
+        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.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') {
+        fastify.log.trace('[fastify-rabbitmq] Decorate Fastify');
+        fastify.decorate('rabbitmq', connection);
+    }
+};
+/**
+ * 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)
+ *
+ */
+const fastifyRabbit = fp(async (fastify, opts, done) => {
+    await validateOpts(opts);
+    const { connection } = opts;
+    const c = new RabbitMQConnection(connection);
+    decorateFastifyInstance(fastify, opts, c);
+    done();
+});
+export default fastifyRabbit;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAC/B,OAAO,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAElE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,cAAc,YAAY,CAAA;AAE1B,MAAM,uBAAuB,GAAG,CAAC,OAAwB,EAAE,OAA+B,EAAE,UAAe,EAAQ,EAAE;IACnH,MAAM,EACJ,SAAS,GAAG,EAAE,EACf,GAAG,OAAO,CAAA;IAEX,IAAI,OAAO,SAAS,KAAK,WAAW,EAAE;QACpC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,kCAAkC,EAAE,SAAS,CAAC,CAAA;KACjE;IACD,IAAI,OAAO,SAAS,KAAK,WAAW,IAAI,SAAS,KAAK,EAAE,EAAE;QACxD,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;YAC3C,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAA;SAClD;QAED,IAAI,OAAO,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,WAAW,EAAE;YACtD,MAAM,IAAI,MAAM,CAAC,kCAAkC,CAAC,sCAAsC,SAAS,EAAE,CAAC,CAAA;SACvG;QAED,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,uDAAuD,EAAE,SAAS,CAAC,CAAA;QACrF,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,UAAU,CAAA;KACzC;SAAM;QACL,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;YAC3C,MAAM,IAAI,MAAM,CAAC,kCAAkC,CAAC,qBAAqB,CAAC,CAAA;SAC3E;KACF;IAED,IAAI,OAAO,OAAO,CAAC,QAAQ,KAAK,WAAW,EAAE;QAC3C,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,qCAAqC,CAAC,CAAA;QACxD,OAAO,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAA;KACzC;AACH,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,aAAa,GAAG,EAAE,CAAyB,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE;IAC7E,MAAM,YAAY,CAAC,IAAI,CAAC,CAAA;IAExB,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;IAE3B,MAAM,CAAC,GAAG,IAAI,kBAAkB,CAAC,UAAU,CAAC,CAAA;IAE5C,uBAAuB,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAEzC,IAAI,EAAE,CAAA;AACR,CAAC,CAAC,CAAA;AAEF,eAAe,aAAa,CAAA"}

package/dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "module"
+}

package/dist/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/dist/esm/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}

package/dist/esm/validation.d.ts

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

package/dist/esm/validation.js

@@ -0,0 +1,14 @@
+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.');
+    }
+    // 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"
+        }
+    }
+};
+//# sourceMappingURL=validation.js.map

package/dist/esm/validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation.js","sourceRoot":"","sources":["../../src/validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAEpC,MAAM,CAAC,MAAM,YAAY,GAAG,KAAK,EAAE,OAA+B,EAAiB,EAAE;IACnF,YAAY;IACZ,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,WAAW,EAAE;QAC7C,MAAM,IAAI,MAAM,CAAC,kCAAkC,CAAC,4CAA4C,CAAC,CAAA;KAClG;IAED,YAAY;IACZ,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,WAAW,EAAE;QAC7C,IAAI,OAAO,OAAO,CAAC,UAAU,KAAK,QAAQ,EAAE;YAC1C,gFAAgF;SACjF;KACF;AACH,CAAC,CAAA"}

package/dist/types/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/dist/types/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/dist/types/index.d.ts

@@ -0,0 +1,22 @@
+import { FastifyRabbitMQOptions } from './decorate.js';
+export * from './types.js';
+/**
+ * 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;

package/dist/types/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/dist/types/validation.d.ts

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

package/package.json

@@ -1,25 +1,44 @@
 {
   "name": "fastify-rabbitmq",
-  "version": "0.0.1-alpha.2",
-  "description": "A Fastify RabbitMQ Plugin Developed in Pure TypeScript using the AMQPLIB",
-  "type": "module",
-  "types": "dist/index.d.ts",
-  "main": "dist/index.js",
+  "version": "1.0.0",
+  "description": "A Fastify RabbitMQ Plugin Developed in Pure TypeScript.",
+  "module": "./dist/esm/index.js",
+  "main": "./dist/cjs/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/cjs/index.js"
+    }
+  },
+  "files": [
+    "dist/**/*"
+  ],
   "scripts": {
-    "build": "tsc",
+    "clean": "rm -rf dist coverage",
+    "build": "tsc && tsc -p tsconfig.cjs.json && tsc -p tsconfig.types.json && ./bin/build-types.sh",
     "build:watch": "tsc -w",
-    "lint": "ts-standard",
-    "lint:fix": "ts-standard --fix",
+    "lint": "ts-standard --parser @typescript-eslint/parser | snazzy",
+    "lint:fix": "ts-standard --fix --parser @typescript-eslint/parser | snazzy",
+    "pack": "npm run clean && npm run test:ci && npm run build && npm pack",
+    "prepublishOnly": "npm run clean && npm run build",
     "test": "jest",
-    "update": "npx npm-check-updates -u && npm install"
+    "test:ci": "jest --ci",
+    "test:coverage": "jest --coverage",
+    "typedoc": "typedoc",
+    "typedoc:watch": "typedoc -watch",
+    "semantic-release": "semantic-release",
+    "semantic-release:dryRun": "semantic-release --dry-run",
+    "update": "npx npm-check-updates -u && npm install && npm run test"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Bugs5382/fastify-rabbitmq.git"
+    "url": "https://github.com/Bugs5382/fastify-rabbitmq"
   },
   "keywords": [
-    "amqp-connection-manager",
-    "amqplib",
+    "rabbitmq-client",
     "typescript",
     "rabbitmq",
     "fastify",
@@ -32,22 +51,35 @@
   },
   "homepage": "https://github.com/Bugs5382/fastify-rabbitmq#readme",
   "dependencies": {
-    "amqp-connection-manager": "^4.1.14",
-    "fastify-plugin": "^4.5.1"
+    "@fastify/error": "^3.4.1",
+    "@types/amqplib": "^0.10.4",
+    "fastify-plugin": "^4.5.1",
+    "promise-tools": "^2.1.0",
+    "rabbitmq-client": "^4.4.0",
+    "randomstring": "^1.3.0"
   },
   "devDependencies": {
-    "@types/amqplib": "^0.10.1",
-    "@types/jest": "^29.5.3",
-    "@types/node": "^20.4.10",
-    "fastify": "^4.21.0",
-    "jest": "^29.6.2",
-    "npm-check-updates": "^16.11.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/release-notes-generator": "^12.1.0",
+    "@types/jest": "^29.5.8",
+    "@types/node": "^20.9.0",
+    "@types/randomstring": "^1.1.11",
+    "@typescript-eslint/parser": "^6.11.0",
+    "fastify": "^4.24.3",
+    "jest": "^29.7.0",
+    "jest-ts-webcompat-resolver": "^1.0.0",
+    "npm-check-updates": "^16.14.6",
     "pre-commit": "^1.2.2",
+    "semantic-release": "^22.0.7",
+    "snazzy": "^9.0.0",
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.1",
     "ts-standard": "^12.0.2",
-    "tsd": "^0.28.1",
-    "typescript": "^5.1.6"
+    "tsd": "^0.29.0",
+    "typedoc": "^0.25.3",
+    "typescript": "^5.2.2"
   },
   "pre-commit": []
 }

package/dist/index.d.ts

@@ -1,27 +0,0 @@
-import { Channel, ConfirmChannel } from 'amqplib';
-import { ChannelWrapper } from 'amqp-connection-manager';
-import type { AmqpConnectionManager, AmqpConnectionManagerOptions, ConnectionUrl } from 'amqp-connection-manager';
-import { FastifyInstance } from 'fastify';
-import FastifyRabbitMQOptions = fastifyRabbitMQ.FastifyRabbitMQOptions;
-import FastifyRabbitMQObject = fastifyRabbitMQ.FastifyRabbitMQObject;
-declare module 'fastify' {
-    interface FastifyInstance {
-        rabbitmq: FastifyRabbitMQObject & fastifyRabbitMQ.FastifyRabbitMQNestedObject;
-    }
-}
-declare namespace fastifyRabbitMQ {
-    interface FastifyRabbitMQObject extends AmqpConnectionManager {
-        channel?: ChannelWrapper;
-    }
-    interface FastifyRabbitMQNestedObject {
-        [namespace: string]: FastifyRabbitMQObject;
-    }
-    interface FastifyRabbitMQOptions extends AmqpConnectionManagerOptions {
-        logLevel?: 'trace' | 'debug' | 'info' | 'warn' | 'error';
-        namespace?: string;
-        urLs: ConnectionUrl | ConnectionUrl[] | undefined | null;
-    }
-}
-declare const fastifyRabbit: (fastify: FastifyInstance, options: FastifyRabbitMQOptions) => Promise<void>;
-export { Channel, ConfirmChannel };
-export default fastifyRabbit;

package/dist/index.js

@@ -1,67 +0,0 @@
-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());
-    });
-};
-import amqp from 'amqp-connection-manager';
-import fp from 'fastify-plugin';
-/**
- * decorateFastifyInstance
- * @since 0.0.1
- * @param fastify
- * @param options
- * @param connection
- */
-const decorateFastifyInstance = (fastify, options, connection) => {
-    const { logLevel = 'silent', namespace = '' } = options;
-    // override log level
-    const logger = fastify.log.child({}, { level: logLevel });
-    if (namespace !== '') {
-        logger.debug('[fastify-rabbitmq] Namespace: %s', namespace);
-    }
-    if (namespace !== '') {
-        if (typeof fastify.rabbitmq === 'undefined') {
-            fastify.decorate('rabbitmq', connection);
-        }
-        if (fastify.rabbitmq[namespace] != null) {
-            throw Error('[fastify-rabbitmq] Connection name already registered: ' + namespace);
-        }
-        logger.trace('[fastify-rabbitmq] Decorate Fastify with Namespace: %', namespace);
-        fastify.rabbitmq[namespace] = connection;
-    }
-    else {
-        if (typeof fastify.rabbitmq !== 'undefined') {
-            throw Error('[fastify-rabbitmq] Already registered');
-        }
-    }
-    if (typeof fastify.rabbitmq === 'undefined') {
-        logger.trace('[fastify-rabbitmq] Decorate Fastify');
-        fastify.decorate('rabbitmq', connection);
-    }
-};
-const fastifyRabbit = fp((fastify, options) => __awaiter(void 0, void 0, void 0, function* () {
-    const { logLevel = 'silent', urLs, heartbeatIntervalInSeconds, reconnectTimeInSeconds, findServers, connectionOptions } = options;
-    // override log level
-    const logger = fastify.log.child({}, { level: logLevel });
-    const connection = amqp.connect(urLs, {
-        heartbeatIntervalInSeconds,
-        reconnectTimeInSeconds,
-        findServers,
-        connectionOptions
-    });
-    connection.on('connect', function () {
-        logger.debug('[fastify-rabbitmq] Connection to RabbitMQ Successful');
-    });
-    connection.on('disconnect', function () {
-        logger.debug('[fastify-rabbitmq] Connection to RabbitMQ Disconnected');
-    });
-    /**
-     * Decorate Fastify
-     */
-    decorateFastifyInstance(fastify, options, connection);
-}));
-export default fastifyRabbit;