@opens/rabbitmq 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,100 @@
+# OpensMQ
+
+This library is a lightweight wrapper around RabbitMQ that simplifies publishing and subscribing to messages using `amqp-connection-manager` and `amqplib`. This library provides an easy-to-use API for event-driven applications.
+
+## Getting Started
+
+### Initialization
+
+To start using `PubSubMQ`, create an instance and initialize the connection to RabbitMQ. This must be done first:
+
+```typescript
+import { pubsub } from './rabbitmq';
+
+pubsub.start({
+  hostname: 'localhost',
+  port: 5672,
+  username: 'guest',
+  password: 'guest',
+  protocol: 'amqp',
+});
+```
+
+### Publishing Messages
+
+You can publish messages to a specific exchange with a routing key:
+
+```typescript
+await pubsub.publish('my-exchange', 'my-routing-key', { message: 'Hello, World!' });
+```
+
+### Subscribing to Messages
+
+To subscribe to a queue and process messages:
+
+```typescript
+pubsub.subscribe({
+  name: 'my-queue',
+  exchange: 'my-exchange',
+  bindingKey: 'my-routing-key',
+  durable: true,
+  prefetch: 1,
+  up: async () => console.log('Consumer is up'),
+  down: async () => console.log('Consumer is down'),
+});
+```
+
+### Handling Message Acknowledgments
+
+The library automatically acknowledges messages if processed successfully. If an error occurs, the message is rejected (`nack`).
+
+## Advanced Configuration
+
+### Setting TTL (Time-To-Live)
+
+To set a TTL for messages in the queue:
+
+```typescript
+pubsub.subscribe({
+  name: 'expiring-queue',
+  exchange: 'my-exchange',
+  bindingKey: 'expiring-key',
+  ttl: 30000, // Messages expire after 30 seconds
+  consumer: async (data) => {
+    console.log('Processing expiring message:', data);
+  },
+  up: async () => console.log('Consumer is up'),
+  down: async () => console.log('Consumer is down'),
+});
+```
+
+### Exclusive Queues
+
+For a queue that only allows a single connection:
+
+```typescript
+pubsub.subscribe({
+  name: 'exclusive-queue',
+  exchange: 'my-exchange',
+  bindingKey: 'exclusive-key',
+  exclusive: true,
+  consumer: async (data) => {
+    console.log('Processing exclusive message:', data);
+  },
+  up: async () => console.log('Consumer is up'),
+  down: async () => console.log('Consumer is down'),
+});
+```
+
+## Error Handling
+
+Errors in the consumer function cause messages to be rejected (`nack`). Ensure error handling is implemented inside your consumer to prevent message loss.
+
+## Contributing
+
+Feel free to contribute by submitting issues or pull requests.
+
+## License
+
+This project is licensed under the MIT License.
+

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import { connect, ChannelWrapper } from 'amqp-connection-manager';
+import { MessageFields, MessageProperties } from 'amqplib';
+
+type ConsumerFunc = (data: any, metadata: {
+    fields: MessageFields;
+    properties: MessageProperties;
+}) => Promise<void>;
+interface SubscribeParams {
+    ttl?: number;
+    name: string;
+    exchange: string;
+    durable?: boolean;
+    prefetch?: number;
+    queueArguments?: Record<string, any>;
+    exclusive?: boolean;
+    bindingKey: string;
+    consumer?: ConsumerFunc;
+    up?: ConsumerFunc;
+    down?: ConsumerFunc;
+}
+declare class PubSubMQ {
+    private startConnection;
+    private connection;
+    private publisherChannel;
+    constructor(startConnection: typeof connect);
+    start(params: {
+        hostname: string;
+        password: string;
+        protocol: string;
+        username: string;
+        port: number;
+    }): void;
+    publish(exchange: string, routingKey: string, payload: any, options?: Object): Promise<boolean>;
+    subscribe(params: SubscribeParams): ChannelWrapper;
+}
+
+declare const pubsub: PubSubMQ;
+
+export { pubsub };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opens/rabbitmq",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "A wrapper around common message brokers",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -9,7 +9,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsup",
+    "build": "tsup --dts",
     "dev": "tsup --watch",
     "test": "vitest run",
     "test:watch": "vitest"