feature: Added Public Ably Message Parsers

[splindsay-92]

Context

• CHA-337
• Users may wish to make use of ably's integration offerings, such as webhooks/AWS lambdas, where messages/reactions etc. sent to the room can be filtered and sent to an integration. It would be useful to have some functions set up that users can pass an encoded inbound message-like object and decode them straight into a chat type like a message or reaction.

Description

• Added two functions that take an encoded ably message, such as those sent via integration rules, and try to convert them into chat types.

  • Added fromEncodedChatMessage function that will try and convert the message into a chat message.
  • Added fromEncodedReaction function that will try and convert the message into a reaction.

• Added getEntityTypeFromEncoded function that will also take an encoded message, and attempt to resolve the chat entity type, currently either a chat message or reaction. This can then be used to inform the user which of the two fromEncoded function you need to use.

• Added two functions that take an ably inbound message, and try to convert them into chat types.

  • Added fromAblyMessageToReaction function that will take an ably inboundMessage and try to convert it to a reaction
  • Added fromAblyMessageToChatMessage function that will take an ably inboundMessage and try to convert it to a chat message.

• Added getEntityTypeFromAblyMessage function that will take inboundMessage, and attempt to resolve the chat entity type, currently either a chat message or reaction. This can then be used to inform the user which of the two fromAblyMessage functions you need to use.

• Moved message and reaction parsing to internal folders for reuse outside their previous classes. Added testing for message and reaction parsing since it wasn't covered comprehensively.

Checklist

• QA'd by the author.
• Unit tests created (if applicable).
• Integration tests created (if applicable).
• Follow coding style guidelines found here.
• TypeDoc updated (if applicable).
• (Optional) Update documentation for new features.

[splindsay-92]

Considering these aren't specifically for use in the chat SDK, should their use be documented elsewhere?

[paddybyers]

Considering these aren't specifically for use in the chat SDK, should their use be documented elsewhere?

They should always be documented somewhere in the repo that they're implemented, and possibly also in the central Ably docs. But I think something should be added here.

[splindsay-92]

Considering these aren't specifically for use in the chat SDK, should their use be documented elsewhere?

They should always be documented somewhere in the repo that they're implemented, and possibly also in the central Ably docs. But I think something should be added here.

They will have typedocs, but I wasn't sure whether to include example usage in the README too, following ably-js which seems this is isn't the case for functions like fromEncoded. I could only see these documented in the library migration readme, but this didn't document their usage.

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	92.21% (🎯 91%)	1932 / 2095
🟢	Statements	92.21% (🎯 91%)	1932 / 2095
🟢	Functions	96.39% (🎯 92%)	187 / 194
🟢	Branches	92.86% (🎯 92%)	521 / 561

File Coverage

File	Stmts	% Branch	% Funcs	% Lines	Uncovered Lines
Changed Files
src/core/helpers.ts	96.15%	94.11%	100%	96.15%	99-100
src/core/message-parser.ts	100%	100%	100%	100%
src/core/messages.ts	93.47%	92.3%	100%	93.47%	338-340, 370-374, 387-391, 499-500
src/core/reaction-parser.ts	100%	100%	100%	100%
src/core/room-reactions.ts	98.19%	96.29%	100%	98.19%	176-177

Generated in workflow #1148