README file needs more information (but shallow) about the project.

Need to learn from articles like:

• https://blog.cwrichardkim.com/how-to-get-hundreds-of-stars-on-your-github-project-345b065e20a2
• https://medium.freecodecamp.org/what-i-learned-from-an-old-github-project-that-won-3-000-stars-in-a-week-628349a5ee14

Also, check these good examples (technical):

• https://github.com/Olical/EventEmitter
• https://github.com/chrisdavies/eev

As a contributor and developer, I need to have a clear understanding of why, how and what is the Channel Class

Produce a document that we can export and use in the documentation site explaining the reason and how it is expected to work as well o what it accomplishes.

It would be nice to have illustrations if possible (visual is always better and clear).

Need to have a API configuration validation service so we can manage it in one place only

Code cove is currently failing on dev because CircleCI cannot send the report to Codecove.
The reason was the update of the coverage cli to NYC and not well configured to generate lcov report.

Will allow emitter information management

As an Entity, I should be able to cancel a message.

After the message being sent, it would be good to have a cancellation of that broadcast if it didn't have already started or sent.

In some cases, we need this mechanism so we remove from the queue a specific message allowing the system to be freed and preventing extra actions and communication to make the message action to roll-back.

As a contributor and developer, I need to have a clear understanding of why, how and what is the Queue Class

Produce a document that we can export and use in the documentation site explaining the reason and how it is expected to work as well o what it accomplishes.

It would be nice to have illustrations if possible (visual is always better and clear).

As a contributor and developer, I need to have a clear understanding of why, how and what is the Bus Class

Produce a document that we can export and use in the documentation site explaining the reason and how it is expected to work as well o what it accomplishes.

It would be nice to have illustrations if possible (visual is always better and clear).

As a contributor and developer, I need to have a clear understanding of why, how and what is the Values Class

Produce a document that we can export and use in the documentation site explaining the reason and how it is expected to work as well o what it accomplishes.

It would be nice to have illustrations if possible (visual is always better and clear).

Tests are currently failing in CircleCI dues to the update of mocha libs and its correction on when the test termination should occur.

We need to find a better approach for testing but for now, we need to add an extra flag so it behaves as before.

As a developer, I need a class to integrate my code and map functionality

• It will allow the developer to use the concept of a public and private bus (leave open the fact that we might need more than one bus as public and private.
• It could be good to have a class that we could extend
• We should only have an external method that will install the API based on a configuration object (need definition)

Update dev dependencies to remove vulnerabilities

Explanation

A message class will implement all the required functionality to deal with message-related information.
This will serve as an interface between the client and the API

Current Need

• Set/Get message content
• Get tracking information (if active)
• Set/Get envelope header (entity, channel, return address, etc...)

Future

• Encryption / Decryption so we can securely send messages (for now they can be set externally)

Need to prevent the registration of any provided listener that is invalid. Preventing it from hitting the cache and consuming resources.

Observation

We can currently add a "bad" listener and still get a queued id. if it still in the queue when we call listenerInfo the channel will get the id instead of null.

Consideration

While it is wrong to accept an invalid listener, we are also queuing it for future processing. This is consuming resources (memory and processing) with no need.

Expected result

If a listener is invalid we should immediately throw an error and if listenerInfo is called then we will reply null as expected

Example:

• An API listener is set to reply a message every time it senses a signal
• As it sends a signal back, it will also sense it, so we have a loop generation or replying to its own replies

Possible solution:

• Add a sender hash (API object based) to the message
• Mark with a hash the listener (API object based)
• If the listener to be called have the same hash of the message sender, then it will be skipped

As an Entity, I should be able to set a timeout to a message that I am sending so I can guarantee that the system will not broadcast it after a specified time frame.

Add

• codacy code coverage report to package.json
• circleci command into yaml file

Will allow control over a collection of frequencies

As a contributor and developer, I need to have a clear understanding of why, how and what is the API Class

Produce a document that we can export and use in the documentation site explaining the reason and how it is expected to work as well o what it accomplishes.

It would be nice to have illustrations if possible (visual is always better and clear).

Need to have a channel validation service so we manage it in one place only

Create a class to manage frequency information