redis-smq 8.0.0-rc.2 → 8.0.0-rc.20

package/CHANGELOG.md

@@ -1,5 +1,325 @@
 
 
+## [8.0.0-rc.20](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.19...v8.0.0-rc.20) (2024-03-24)
+
+
+### Bug Fixes
+
+* include missing enums when exporting esm/cjs modules ([2ee6802](https://github.com/weyoss/redis-smq/commit/2ee680205dbde78af46f4e4347cdf4fa80adfe3b))
+
+## [8.0.0-rc.19](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.18...v8.0.0-rc.19) (2024-03-24)
+
+
+### Documentation
+
+* fix incorrect generated anchor texts ([c4f523f](https://github.com/weyoss/redis-smq/commit/c4f523f9a17dbbb8510b35032cfecfc69905dd04))
+
+## [8.0.0-rc.18](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.17...v8.0.0-rc.18) (2024-03-24)
+
+
+### ⚠ BREAKING CHANGES
+
+* rebase on redis-smq-common@3.0.0-rc.14
+
+### Documentation
+
+* update documentation and API reference ([3baaee6](https://github.com/weyoss/redis-smq/commit/3baaee6649c7bde47ce4c22c12ca4dc367ab301d))
+
+
+### Codebase Refactoring
+
+* do not throw errors for async functions ([582f355](https://github.com/weyoss/redis-smq/commit/582f35539c01e9b98a05fbd65b2247cba623524c))
+* rebase on redis-smq-common@3.0.0-rc.14 ([2c5edbd](https://github.com/weyoss/redis-smq/commit/2c5edbd8debdf4599ddbb7ad42a37bc94fea14d1))
+
+## [8.0.0-rc.17](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.16...v8.0.0-rc.17) (2024-01-30)
+
+
+### Documentation
+
+* add missing error classes ([753331e](https://github.com/weyoss/redis-smq/commit/753331e5ce4fb239cb29b3ae4c3246ba185b4d94))
+* simplify and unify class/method naming and referencing ([0299b31](https://github.com/weyoss/redis-smq/commit/0299b314e843c28d52e2f767ace150e39652287c))
+
+
+### Codebase Refactoring
+
+* improve MessageHandler error handling ([957d257](https://github.com/weyoss/redis-smq/commit/957d257e66cce6faaf9dad5bf949cdd1198cfae8))
+
+## [8.0.0-rc.16](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.15...v8.0.0-rc.16) (2024-01-28)
+
+
+### Features
+
+* allow running/sandboxing message handlers using worker threads ([53095bd](https://github.com/weyoss/redis-smq/commit/53095bd2689ccb2f701365bafb4ef8e550da82b3))
+
+
+### Bug Fixes
+
+* export message handler errors ([26d2689](https://github.com/weyoss/redis-smq/commit/26d26890da139d88c46ce220e3dda3d9c8e03aee))
+
+
+### Documentation
+
+* **ConsumeMessageWorker:** update docs and clean up ([140322e](https://github.com/weyoss/redis-smq/commit/140322e3520ee3db905ea977a159064f339aa7d2))
+* fix broken links ([aad9010](https://github.com/weyoss/redis-smq/commit/aad9010e70ed332b154f4fbdcb8ac657a14fe6b9))
+* update messages and queues documentation ([7c3d06e](https://github.com/weyoss/redis-smq/commit/7c3d06ed3765ffc14dfece4f725241aa4535e1e7))
+
+
+### Codebase Refactoring
+
+* **ConsumeMessageWorker:** improve typings ([66c6ca9](https://github.com/weyoss/redis-smq/commit/66c6ca948677f76d496fe0b988bd195e1a7108a2))
+
+
+### Tests
+
+* allow running/sandboxing message handlers using worker threads ([79e6886](https://github.com/weyoss/redis-smq/commit/79e688674ed11ec34ce2f74d5f15c8eefa129767))
+
+## [8.0.0-rc.15](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.14...v8.0.0-rc.15) (2024-01-25)
+
+
+### Features
+
+* add Pub/Sub delivery model, refactor and clean up ([47affa1](https://github.com/weyoss/redis-smq/commit/47affa172eb2fc6943f660bea3feab3af1bc28ec))
+
+
+### Documentation
+
+* add a notification about the latest release, clean up ([904f196](https://github.com/weyoss/redis-smq/commit/904f196f1854059625b08af05fe5ceb1466d4a9f))
+* add Pub/Sub delivery model, refactor and clean up ([32db9dd](https://github.com/weyoss/redis-smq/commit/32db9dd2772bc16568e03e6e216a7d0fd0a599a7))
+* clean up ([c7d13a6](https://github.com/weyoss/redis-smq/commit/c7d13a639a1ed9f134ba3deb99d1e2a23223935a))
+
+
+### Misc
+
+* bump up redis-smq-common to v3.0.0-rc.8 ([d411849](https://github.com/weyoss/redis-smq/commit/d4118496263479036085ee09ceb5785ee497bb59))
+* bump up redis-smq-common to v3.0.0-rc9 ([d372e9d](https://github.com/weyoss/redis-smq/commit/d372e9d98593934e9e9fb63efcd56cbad99202af))
+
+## [8.0.0-rc.14](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.13...v8.0.0-rc.14) (2024-01-03)
+
+
+### Documentation
+
+* add new diagrams and update existing ones ([f5182b1](https://github.com/weyoss/redis-smq/commit/f5182b10b5179365edf68e7b6bf564ccc25281ab))
+* **event-listeners:** add a link to IRedisSMQConfig interface ([a7635c5](https://github.com/weyoss/redis-smq/commit/a7635c5d811ad775123547a5696c78b030981269))
+* scale down diagrams ([c3b37e4](https://github.com/weyoss/redis-smq/commit/c3b37e445a6d15fdcc8c7a73b713a1f7d5e7c94e))
+* update exchange diagrams ([9dc05d6](https://github.com/weyoss/redis-smq/commit/9dc05d6cd835d779b9d183e83f562c7991105c92))
+
+
+### Codebase Refactoring
+
+* **event-listeners:** clean up ([d9195e4](https://github.com/weyoss/redis-smq/commit/d9195e4e85e2e4519d238f5f3ecace37ae9bbb32))
+* **exchanges:** improve typings ([97665fe](https://github.com/weyoss/redis-smq/commit/97665fed4a579af444c46e01a6b05f9adb12e888))
+* **message:** handle various errors when deleting a message ([a4505ae](https://github.com/weyoss/redis-smq/commit/a4505ae7d95bda0185da28433c6737e395400e7b))
+
+
+### Tests
+
+* **message:** handle various errors when deleting a message ([ecf301b](https://github.com/weyoss/redis-smq/commit/ecf301b06aac1bf6d0fcb1ced962a32ac6a6ca68))
+
+## [8.0.0-rc.13](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.12...v8.0.0-rc.13) (2023-12-23)
+
+
+### ⚠ BREAKING CHANGES
+
+* **event-listeners:** unify consumer/producer event listeners
+
+### Documentation
+
+* **event-listeners:** update documentation ([71100d3](https://github.com/weyoss/redis-smq/commit/71100d3aa94a61fb8ece86e439f0b120b66a6cab))
+
+
+### Codebase Refactoring
+
+* **event-listeners:** unify consumer/producer event listeners ([9e1a181](https://github.com/weyoss/redis-smq/commit/9e1a1811dd841d4329f0ee14e979d2770a7a6358))
+
+
+### Tests
+
+* **event-listeners:** unify consumer/producer event listeners ([2d14a07](https://github.com/weyoss/redis-smq/commit/2d14a077feda98933fb6c038bea5a33ad8d5f610))
+
+## [8.0.0-rc.12](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.11...v8.0.0-rc.12) (2023-12-18)
+
+
+### Misc
+
+* update logo ([9bd373e](https://github.com/weyoss/redis-smq/commit/9bd373e693c57c8e18dddb5b0899c710e6de9492))
+
+## [8.0.0-rc.11](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.10...v8.0.0-rc.11) (2023-12-18)
+
+
+### Documentation
+
+* **IConsumableMessage:** clean up ([5b5ce3a](https://github.com/weyoss/redis-smq/commit/5b5ce3aedd3e378cc74a2715da2ae1e98f41124f))
+
+
+### Codebase Refactoring
+
+* **MessageEnvelope:** clean up ([72140f6](https://github.com/weyoss/redis-smq/commit/72140f61742dd4e3cbe36a6c421bf5f0b5a2f7ac))
+* rename _createRMessage to _createConsumableMessage ([7a138fd](https://github.com/weyoss/redis-smq/commit/7a138fdce633946d4f69a7c8aa4d78a019bc82df))
+
+
+### Tests
+
+* **ConsumableMessage:** increase code coverage ([3960c6e](https://github.com/weyoss/redis-smq/commit/3960c6ef72875fcdd0684eb1025afd0c0630c67c))
+
+## [8.0.0-rc.10](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.9...v8.0.0-rc.10) (2023-12-17)
+
+
+### ⚠ BREAKING CHANGES
+
+* add ProducibleMessage/ConsumableMessage/MessageEnvelope
+
+### Features
+
+* add ProducibleMessage/ConsumableMessage/MessageEnvelope ([4a3eec7](https://github.com/weyoss/redis-smq/commit/4a3eec79575b2845d2c35ec478b89e4a5acb863d))
+
+
+### Documentation
+
+* add ProducibleMessage/ConsumableMessage/MessageEnvelope ([55aa68e](https://github.com/weyoss/redis-smq/commit/55aa68e17021afadad32ee2c1b9dfef6924449f5))
+* **QueueMessages:** fix outdated class reference ([e6ae499](https://github.com/weyoss/redis-smq/commit/e6ae4991d4389e1d1602bd780f4e0d95e02e5606))
+* update examples ([bbccf7c](https://github.com/weyoss/redis-smq/commit/bbccf7cb5a2a5dfe2eacaeabb097129cbdcf6720))
+
+
+### Tests
+
+* add ProducibleMessage/ConsumableMessage/MessageEnvelope ([2961a22](https://github.com/weyoss/redis-smq/commit/2961a221190307c4a4a8857fed9ec12622bdd10d))
+
+
+### Misc
+
+* update health-check ([81edb25](https://github.com/weyoss/redis-smq/commit/81edb255d081824143f147ed8d0faefe0948224f))
+
+## [8.0.0-rc.9](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.8...v8.0.0-rc.9) (2023-12-11)
+
+
+### Documentation
+
+* update documentation ([85d6adb](https://github.com/weyoss/redis-smq/commit/85d6adb7e8db6cb4f427a34e8e510c11d2fc5bf0))
+
+
+### Codebase Refactoring
+
+* **MessageEnvelope:** improve setPriority/getPriority typings ([91c44f0](https://github.com/weyoss/redis-smq/commit/91c44f013d6ff757876a0e57dcec45869ab6a02a))
+
+
+### Tests
+
+* **MessageEnvelope:** improve setPriority/getPriority typings ([20fd6e5](https://github.com/weyoss/redis-smq/commit/20fd6e58e466ae425bba54d4d85adf4df888654b))
+
+## [8.0.0-rc.8](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.7...v8.0.0-rc.8) (2023-12-11)
+
+
+### ⚠ BREAKING CHANGES
+
+* **Message:** remove Message.MessagePriority, add EMessagePriority
+* **QueueMessages:** move message methods to Message,add MessageEnvelope
+
+### Features
+
+* **Message:** add getMessageStatus() method ([fda81fa](https://github.com/weyoss/redis-smq/commit/fda81fa7a3c4428799dfabef8581f0f3b39949e8))
+
+
+### Bug Fixes
+
+* **Message:** export missing error classes ([29e8817](https://github.com/weyoss/redis-smq/commit/29e8817fa805faed42ebd9a3fea469004552eec1))
+
+
+### Documentation
+
+* update documentation and examples ([8efb082](https://github.com/weyoss/redis-smq/commit/8efb08200ac1f2751c7e10e3492445badb2e4039))
+
+
+### Codebase Refactoring
+
+* **Message:** remove Message.MessagePriority, add EMessagePriority ([702a01d](https://github.com/weyoss/redis-smq/commit/702a01da987479a4f3b2127b9da0851d74046c10))
+* **QueueMessages:** move message methods to Message,add MessageEnvelope ([f71f0d0](https://github.com/weyoss/redis-smq/commit/f71f0d06240e16b1519ae175793ae28470684d4f))
+
+
+### Tests
+
+* **Message:** add getMessageStatus() method ([76e97c4](https://github.com/weyoss/redis-smq/commit/76e97c48fdc86c2709db39b17a0ba55432157270))
+* **Message:** remove Message.MessagePriority, add EMessagePriority ([88a1368](https://github.com/weyoss/redis-smq/commit/88a1368ff8e000f3f26141ec29fddc7f96a7103e))
+* **QueueMessages:** move message methods to Message,add MessageEnvelope ([932a88e](https://github.com/weyoss/redis-smq/commit/932a88eee5bfd0dc020c8516f76e2d351d486fe3))
+
+## [8.0.0-rc.7](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.6...v8.0.0-rc.7) (2023-12-09)
+
+
+### ⚠ BREAKING CHANGES
+
+* **QueueMessages:** remove redundant method deleteMessage()
+
+### Documentation
+
+* **QueueMessages:** remove redundant method deleteMessage() ([cdeb454](https://github.com/weyoss/redis-smq/commit/cdeb4543f859e108efdcaa61aeac15d3a325b0a5))
+
+
+### Codebase Refactoring
+
+* **QueueMessages:** remove redundant method deleteMessage() ([af21dff](https://github.com/weyoss/redis-smq/commit/af21dff9f6b959ed21aa4cbe812606c1efbf4046))
+
+
+### Tests
+
+* **QueueMessages:** remove redundant method deleteMessage() ([dfa3792](https://github.com/weyoss/redis-smq/commit/dfa37924a0a8e2fc726ce4a76baa535c79f0c917))
+
+## [8.0.0-rc.6](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.5...v8.0.0-rc.6) (2023-12-09)
+
+
+### ⚠ BREAKING CHANGES
+
+* **QueueMessages:** rename deleteMessagesById to deleteMessageById
+
+### Documentation
+
+* **QueueMessages:** rename deleteMessagesById to deleteMessageById ([81cfb72](https://github.com/weyoss/redis-smq/commit/81cfb72a012e99398435418f52c8a24018759234))
+
+
+### Codebase Refactoring
+
+* **QueueMessages:** rename deleteMessagesById to deleteMessageById ([b3baf71](https://github.com/weyoss/redis-smq/commit/b3baf711e6210034aac256362418dd8d87859557))
+
+## [8.0.0-rc.5](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.4...v8.0.0-rc.5) (2023-12-03)
+
+
+### Documentation
+
+* clean up ([2d7c004](https://github.com/weyoss/redis-smq/commit/2d7c004e690ca2f30a6de8d22feb5f4a3711eab9))
+
+
+### Codebase Refactoring
+
+* improve typings ([c86bb53](https://github.com/weyoss/redis-smq/commit/c86bb53969bbb919f115268cbf510c818af44066))
+
+## [8.0.0-rc.4](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.3...v8.0.0-rc.4) (2023-12-02)
+
+
+### Documentation
+
+* clean up outdated examples ([dd1c68b](https://github.com/weyoss/redis-smq/commit/dd1c68bdd7cf7de2dfa309dbe7efff76fed5c983))
+
+
+### Misc
+
+* move redis-smq-common from dev-deps to deps ([675880d](https://github.com/weyoss/redis-smq/commit/675880d3803cca9c89aa860486bae43dbe7e2f70))
+
+## [8.0.0-rc.3](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.2...v8.0.0-rc.3) (2023-12-02)
+
+
+### Bug Fixes
+
+* **scheduler:** handle unacked messages with retry delay correctly ([a97b145](https://github.com/weyoss/redis-smq/commit/a97b145f605d6b5c7d9f6f83c844c9d2447c5786))
+
+
+### Documentation
+
+* update Message reference ([1cff3e3](https://github.com/weyoss/redis-smq/commit/1cff3e3fe3634ffa2d502a4bbb589948ed8e56ea))
+* update TRedisSMQEvent reference ([5afa22e](https://github.com/weyoss/redis-smq/commit/5afa22ea1d2de00cb9c4708c55ec8fe1ef5a39b5))
+
+
+### Tests
+
+* **message:** add new test cases covering message status ([9eec7e9](https://github.com/weyoss/redis-smq/commit/9eec7e9e2a39244ab62b9f8db4d049d3363a534d))
+
 ## [8.0.0-rc.2](https://github.com/weyoss/redis-smq/compare/v8.0.0-rc.1...v8.0.0-rc.2) (2023-11-27)
 
 
@@ -104,8 +424,6 @@
 * drop support for redis server 2.8 and 3 ([9ef8ade](https://github.com/weyoss/redis-smq/commit/9ef8adec08bf90d1cc27b9bbabe591bca25a7d8e))
 * update minimal supported versions for nodejs and redis ([13b3197](https://github.com/weyoss/redis-smq/commit/13b31977937c65aa989de8d715022d1afb5f0839))
 
-# CHANGELOG
-
 ## 7.2.3 (2023-03-26)
 
 * test(consumer-heartbeat): update tests (4332153)

package/README.md

@@ -1,5 +1,9 @@
+> [!IMPORTANT]
+> Currently, RedisSMQ is going under heavy development. Pre-releases at any time may introduce new commits with breaking changes.
+> The master branch always reflects the most recent changes. To view the latest release reference see [RedisSMQ v7.2.3](https://github.com/weyoss/redis-smq/tree/v7.2.3)
+
 <div align="center" style="text-align: center">
-  <p><a href="https://github.com/weyoss/redis-smq"><img alt="RedisSMQ" src="./logo.png" /></a></p>
+  <p><a href="https://github.com/weyoss/redis-smq"><img alt="RedisSMQ" src="./logo.png?v=202312182134" /></a></p>
   <p>A simple high-performance Redis message queue for Node.js.</p>
 </div>
 
@@ -13,29 +17,29 @@
    <a href="https://npmjs.org/package/redis-smq" rel="nofollow"><img src="https://img.shields.io/npm/dm/redis-smq.svg" alt="NPM downloads" /></a>
 </p>
 
-RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing them asynchronously with consumers. Backed by Redis, it allows scaling up your application with ease of use.
+RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing them asynchronously with consumers. Backed by Redis, it allows scaling up your typical applications with ease of use.
 
 ## Features
 
 * [High-performance message processing](docs/performance.md).
-* Flexible Producer/Consumer model which offers [Multi-Queue Producers](docs/producing-messages.md) & [Multi-Queue Consumers](docs/consuming-messages.md), focuses on simplicity and without tons of features. This makes RedisSMQ an ideal message broker for microservices-based applications.
-* In case of failures, while delivering or processing a message, RedisSMQ can guaranty that the message is not lost and that it is redelivered [at-least-once](docs/api/classes/Message.md#setretrythreshold). When configured to do so, RedisSMQ can also ensure that the message is delivered [at-most-once](docs/api/classes/Message.md#setretrythreshold).
+* Flexible Producer/Consumer model which offers [Multi-Queue Producers](docs/producing-messages.md) & [Multi-Queue Consumers](docs/consuming-messages.md).
 * RedisSMQ offers different exchange types: [Direct Exchange](docs/message-exchanges.md#direct-exchange), [Topic Exchange](docs/message-exchanges.md#topic-exchange), and [FanOut Exchange](docs/message-exchanges.md#fanout-exchange) for publishing a message to one or multiple queues.
-* 3 queuing strategies that you may use depending on your needs and requirements: [FIFO queues, LIFO queues, and Reliable Priority Queues](docs/queues.md).
-* A message can be [set to expire](docs/api/classes/Message.md#setttl) if it has not been delivered within a given amount of time. [Consumption timeout](docs/api/classes/Message.md#setconsumetimeout) allows canceling a message consumption if a consumer did not acknowledge the message for a period of time.
-* [Queue Rate Limiting](docs/queue-rate-limiting.md) which allows to control the rate at which the messages are consumed from a given queue.
-* Builtin [message scheduler](docs/scheduling-messages.md) allowing to delay a message, to deliver a message for N times with an optional period between deliveries, or simply to schedule message delivery using CRON expressions.
-* [Multiplexing](/docs/multiplexing.md): A feature which allows message handlers to use a single redis connection to dequeue and consume messages.
-* An [HTTP interface](https://github.com/weyoss/redis-smq-monitor) is provided to interact with the MQ. RedisSMQ can be managed also from your [web browser](https://github.com/weyoss/redis-smq-monitor-client).
-* Depending on [your preferences](docs/configuration.md), RedisSMQ can use either [node-redis v3](https://github.com/redis/node-redis/tree/v3.1.2), [node-redis v4](https://github.com/redis/node-redis), or [ioredis](https://github.com/luin/ioredis).
-* RedisSMQ is [highly optimized](https://lgtm.com/projects/g/weyoss/redis-smq/context:javascript), implemented using pure callbacks, with small memory footprint and no memory leaks. See [Callback vs Promise vs Async/Await benchmarks](https://gist.github.com/weyoss/24f9ecbda175d943a48cb7ec38bde821).
+* Supports [Point-2-Point](docs/queue-delivery-models.md#point-2-point-delivery-model) and [Pub/Sub](docs/queue-delivery-models.md#pubsub-delivery-model) [delivery models](docs/queue-delivery-models.md).
+* Both [delivery models](docs/queue-delivery-models.md) are reliable. For cases of failure, while delivering/consuming messages, [at-least-once](docs/api/classes/ProducibleMessage.md#setretrythreshold) and [at-most-once](docs/api/classes/ProducibleMessage.md#setretrythreshold) modes may be configured.
+* [3 queuing strategies](docs/queues.md): [FIFO queues](docs/queues.md#fifo-first-in-first-out-queues), [LIFO queues](docs/queues.md#lifo-last-in-first-out-queues), and [Priority Queues](docs/queues.md#priority-queues).
+* [Message Handler Worker Threads](docs/message-handler-worker-threads.md) which allow sandboxing and running your message handler from a separate isolated thread and without affecting the performance of other message handlers from the same consumer.
+* Messages can be [set to expire](docs/api/classes/ProducibleMessage.md#setttl) when not delivered within a given amount of time or to have a [consumption timeout](docs/api/classes/ProducibleMessage.md#setconsumetimeout) while being in process.
+* Queues may be [rate Limited](docs/queue-rate-limiting.md) to control the rate at which the messages are consumed.
+* Has a builtin [scheduler](docs/scheduling-messages.md) allowing messages [to be delayed](docs/api/classes/ProducibleMessage.md#setscheduleddelay), [to be delivered for N times](docs/api/classes/ProducibleMessage.md#setscheduledrepeat) with an optional [period between deliveries](docs/api/classes/ProducibleMessage.md#setscheduledrepeatperiod), or simply [to be scheduled using CRON expressions](docs/api/classes/ProducibleMessage.md#setscheduledcron).
+* Provides [an HTTP API](https://github.com/weyoss/redis-smq-monitor) to interact with the message queue for external services.
+* RedisSMQ can be managed also from your [web browser](https://github.com/weyoss/redis-smq-monitor-client).
+* Either [node-redis](https://github.com/redis/node-redis) or [ioredis](https://github.com/luin/ioredis) can be used as a Redis client.
+* [Highly optimized](https://lgtm.com/projects/g/weyoss/redis-smq/context:javascript), implemented using pure callbacks, with small memory footprint and no memory leaks. See [Callback vs Promise vs Async/Await benchmarks](https://gist.github.com/weyoss/24f9ecbda175d943a48cb7ec38bde821).
 * [Both ESM & CJS modules are supported](docs/esm-cjs-modules.md).
 
 ## RedisSMQ Use Case: Multi-Queue Producers & Multi-Queue Consumers
 
-&nbsp;
-
-![RedisSMQ Overview](docs/redis-smq-overview.png)
+![RedisSMQ Multi-Queue Producers & Multi-Queue Consumers](docs/redis-smq-multi-queue-consumers-producers.png)
 
 ## What's new?
 
@@ -43,8 +47,6 @@ RedisSMQ is a Node.js library for queuing messages (aka jobs) and processing the
 
 ## Installation
 
-> Currently, RedisSMQ is going under heavy development. Pre-releases at any time may introduce new commits with breaking changes. To view the latest release reference see [RedisSMQ v7.2.3](https://github.com/weyoss/redis-smq/tree/v7.2.3)
-
 ```shell
 npm i redis-smq@rc
 ```
@@ -56,7 +58,7 @@ Considerations:
 
 ## Usage
 
-RedisSMQ provides 3 classes in order to work with the message queue: `Message`, `Producer`, and `Consumer`.
+RedisSMQ provides 3 classes in order to work with the message queue: `ProducibleMessage`, `Producer`, and `Consumer`.
 
 Producers and consumers exchange data using one or multiple queues that may be created using the [Queue Class](docs/api/classes/Queue.md).
 
@@ -65,40 +67,49 @@ A queue is responsible for holding messages which are produced by producers and
 ### Creating a queue
 
 ```javascript
-const { Queue, EQueueType } = require('redis-smq');
-
 const queue = new Queue();
-
-// Creating a LIFO queue
-queue.save('my_queue', EQueueType.LIFO_QUEUE, (err) => console.log(err));
+queue.save(
+  'my_queue',
+  EQueueType.LIFO_QUEUE,
+  EQueueDeliveryModel.POINT_TO_POINT,
+  (err) => {
+    if (err) console.error(err);
+  },
+);
 ```
 
-### Producing a message
+In the example above we are defining a [LIFO queue](docs/queues.md#lifo-last-in-first-out-queues) with a [POINT-2-POINT delivery model](docs/queue-delivery-models.md#point-2-point-delivery-model).
 
-```javascript
-const { Producer, Message } = require('redis-smq');
+See [Queues](docs/queues.md) for more details.
 
-const producer = new Producer();
-
-const message = new Message();
-message.setQueue('my_queue').setBody('Hello Word!')
+### Producing a message
 
-producer.produce(message, (err) => console.log(err));
+```javascript
+const msg = new ProducibleMessage();
+msg.setQueue('my_queue').setBody('Hello Word!');
+producer.produce(msg, (err, ids) => {
+  if (err) console.error(err);
+  else console.log(`Produced message IDs are: ${ids.join(', ')}`);
+});
 ```
 
+See [Producing Messages](docs/producing-messages.md) for more details.
+
 ### Consuming a message
 
 ```javascript
-const { Consumer } = require('redis-smq');
-
 const consumer = new Consumer();
-const messageHandler = (message, cb) => {
-  console.log(message.getBody());
+const messageHandler = (msg, cb) => {
+  console.log(msg.body);
   cb();
-}
-consumer.consume('my_queue', messageHandler, (err) => console.log(err));
+};
+consumer.consume('my_queue', messageHandler, (err) => {
+  if (err) console.error(err);
+});
 ```
 
+See [Consuming Messages](docs/consuming-messages.md) for more details.
+
 ## Documentation
 
 See [RedisSMQ Docs](docs/README.md) for more details.

package/dist/cjs/index.d.ts

@@ -0,0 +1,4 @@
+export * from './src/common/index.js';
+export * from './src/config/index.js';
+export * from './src/lib/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/index.js

@@ -0,0 +1,20 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./src/common/index.js"), exports);
+__exportStar(require("./src/config/index.js"), exports);
+__exportStar(require("./src/lib/index.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/package.json

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

package/dist/cjs/src/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/cjs/src/common/index.js

@@ -0,0 +1,18 @@
+"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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/index.js"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/src/common/redis-client/errors/redis-client-instance-lock.error.d.ts

@@ -0,0 +1,4 @@
+import { RedisSMQError } from 'redis-smq-common';
+export declare class RedisClientInstanceLockError extends RedisSMQError {
+}
+//# sourceMappingURL=redis-client-instance-lock.error.d.ts.map

package/dist/cjs/src/common/redis-client/errors/redis-client-instance-lock.error.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisClientInstanceLockError = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+class RedisClientInstanceLockError extends redis_smq_common_1.RedisSMQError {
+}
+exports.RedisClientInstanceLockError = RedisClientInstanceLockError;
+//# sourceMappingURL=redis-client-instance-lock.error.js.map

package/dist/cjs/src/common/redis-client/redis-client-factory.d.ts

@@ -0,0 +1,4 @@
+import { TUnaryFunction } from 'redis-smq-common';
+import { RedisClientInstance } from './redis-client-instance.js';
+export declare function RedisClientFactory(id: string, onError: TUnaryFunction<Error>): RedisClientInstance;
+//# sourceMappingURL=redis-client-factory.d.ts.map

package/dist/cjs/src/common/redis-client/redis-client-factory.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisClientFactory = void 0;
+const redis_client_instance_js_1 = require("./redis-client-instance.js");
+const instances = {};
+function RedisClientFactory(id, onError) {
+    if (!instances[id]) {
+        const instance = new redis_client_instance_js_1.RedisClientInstance();
+        instance.on('error', onError);
+        instances[id] = instance;
+    }
+    return instances[id];
+}
+exports.RedisClientFactory = RedisClientFactory;
+//# sourceMappingURL=redis-client-factory.js.map

package/dist/cjs/src/common/redis-client/redis-client-instance.d.ts

@@ -0,0 +1,10 @@
+import { EventEmitter, ICallback, IRedisClient, TRedisClientEvent } from 'redis-smq-common';
+export declare class RedisClientInstance extends EventEmitter<Pick<TRedisClientEvent, 'error'>> {
+    protected instance: IRedisClient | null;
+    protected locked: boolean;
+    init: (cb: ICallback<void>) => void;
+    getSetInstance: (cb: ICallback<IRedisClient>) => void;
+    shutdown: (cb: ICallback<void>) => void;
+    getInstance(): IRedisClient | Error;
+}
+//# sourceMappingURL=redis-client-instance.d.ts.map

package/dist/cjs/src/common/redis-client/redis-client-instance.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisClientInstance = void 0;
+const redis_smq_common_1 = require("redis-smq-common");
+const index_js_1 = require("../../config/index.js");
+const redis_client_instance_lock_error_js_1 = require("./errors/redis-client-instance-lock.error.js");
+class RedisClientInstance extends redis_smq_common_1.EventEmitter {
+    constructor() {
+        super(...arguments);
+        this.instance = null;
+        this.locked = false;
+        this.init = (cb) => {
+            this.getSetInstance((err) => cb(err));
+        };
+        this.getSetInstance = (cb) => {
+            if (!this.locked) {
+                if (!this.instance) {
+                    this.locked = true;
+                    (0, redis_smq_common_1.createRedisClient)(index_js_1.Configuration.getSetConfig().redis, (err, client) => {
+                        this.locked = false;
+                        if (err)
+                            cb(err);
+                        else if (!client)
+                            cb(new redis_smq_common_1.CallbackEmptyReplyError());
+                        else {
+                            this.instance = client;
+                            this.instance.on('error', (err) => this.emit('error', err));
+                            cb(null, this.instance);
+                        }
+                    });
+                }
+                else
+                    cb(null, this.instance);
+            }
+            else
+                cb(new redis_client_instance_lock_error_js_1.RedisClientInstanceLockError());
+        };
+        this.shutdown = (cb) => {
+            if (this.instance) {
+                this.instance.halt(() => {
+                    this.instance = null;
+                    cb();
+                });
+            }
+            else
+                cb();
+        };
+    }
+    getInstance() {
+        if (!this.instance)
+            return new redis_smq_common_1.PanicError(`Use first getSetInstance() to initialize the RedisClientInstance class`);
+        return this.instance;
+    }
+}
+exports.RedisClientInstance = RedisClientInstance;
+//# sourceMappingURL=redis-client-instance.js.map