[ECO-4899] feat: add public API for Chat SDK

[ttypic]

Notable TypeScript-to-Kotlin decisions:

• Functions that return Promises become suspend functions.
• I decided to leave listeners as they are and not use Flow in the public interface. These listeners will be invoked synchronously with the events they are listening to. This approach makes it easy to provide extension functions for an idiomatic Flow interface on one hand, and on the other hand, it gives maximum flexibility for SDK users to utilize other reactive libraries like Reactor or RxJava.
• The presence data type is Any for now.

Summary by CodeRabbit

• New Features

  • Introduced a comprehensive chat client interface for managing chat functionality.
  • Added support for connection management and occupancy metrics.
  • Implemented presence management, typing indicators, and reaction handling.
  • Enhanced message handling with structured query and sending capabilities.
  • Defined structured logging options for better error tracking.

• Bug Fixes

  • Improved error handling mechanisms across various chat functionalities.

• Documentation

  • Updated documentation for new interfaces and classes to enhance developer understanding.

• Chores

  • Adjusted configuration settings to allow shorter function names in the codebase.

[coderabbitai[bot]]

Walkthrough

The changes introduce a comprehensive chat functionality within the Ably chat system. New interfaces, data classes, and enumerations provide structured management of chat rooms, messages, presence, reactions, typing, and connection states. Enhanced logging and configuration options, alongside error handling mechanisms, improve the robustness of the chat application. A minor adjustment to the code quality tool configuration is also included, allowing for shorter function names.

Changes

Files	Change Summary
ChatClient.kt, Connection.kt, ConnectionStatus.kt, EmitsDiscontinuities.kt, ErrorCodes.kt, EventTypes.kt, Headers.kt, LogLevel.kt, Message.kt, Metadata.kt, Occupancy.kt, Presence.kt, Reaction.kt, Room.kt, RoomOptions.kt, RoomReactions.kt, RoomStatus.kt, Typing.kt	New interfaces and data classes added to manage chat functionalities, including chat client interactions, connection states, message handling, presence updates, typing events, reactions, and room management. Error codes and logging levels defined for improved debugging.
detekt.yml	Configuration change to reduce the minimum function name length from 3 to 2 characters, along with a minor formatting adjustment.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ChatClient
    participant Room
    participant Messages
    participant Presence
    participant Typing

    User->>ChatClient: Connect to chat
    ChatClient->>Room: Join room
    Room->>User: Room joined notification
    User->>Messages: Send message
    Messages->>Room: Relay message
    Room->>User: Message received confirmation
    User->>Presence: Update presence status
    Presence->>Room: Notify presence change
    User->>Typing: Start typing
    Typing->>Room: Notify typing event
    Room->>User: Typing indicator shown

🐇 In a world of chat, so bright and bold,
New features sprout, like carrots of gold.
With messages flying, and typing in sight,
Presence and reactions, all feel just right!
Let's hop and celebrate, with friends by our side,
In this chat-filled garden, we'll take great pride! 🌼

---

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.