chat-core: decrease timeout of the stopTyping timer

[splindsay-92]

Context

• After going through the new examples of chat in the Ably Docs, I noticed the timeout time for typing indicators seems really long for a default. It would probably confuse devs (I had to check as I thought it was set to 5 seconds) that they need to manually call stop().

Description

• Decreased the default timeout to 5 seconds, which I think is much more reasonable.

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.
• Browser tests created (if applicable).
• In repo demo app updated (if applicable).

Testing Instructions (Optional)

• Explain how to test the changes in this PR.
• Provide specific steps or commands to execute.

Summary by CodeRabbit

• New Features

  • Reduced default timeout for typing events from 10 seconds to 5 seconds.
  • Introduced new components: ChatClientProvider and ChatRoomProvider for managing chat contexts.
  • Added multiple new hooks for enhanced chat functionalities, including useChatClient, useMessages, and usePresence.

• Documentation

  • Updated README with new hooks and components, including usage examples for better developer guidance.

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	92.55% (🎯 92%)	2696 / 2913
🟢	Statements	92.55% (🎯 92%)	2696 / 2913
🟢	Functions	92.57% (🎯 92%)	212 / 229
🟢	Branches	93.91% (🎯 93%)	756 / 805

File Coverage

File	Stmts	% Branch	% Funcs	% Lines	Uncovered Lines
Changed Files
src/core/room-options.ts	100%	100%	100%	100%

Generated in workflow #1630 for commit 84ebd38 by the Vitest Coverage Report Action

[AndyTWF]

Can we update the PR description to say 5 seconds, please?

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve two primary updates. First, the default timeout for typing events in the RoomOptionsDefaults constant has been reduced from 10 seconds to 5 seconds, with corresponding documentation updates. Second, the src/react/README.md file has been enhanced to include new components and hooks related to the Ably Chat SDK, specifically detailing the ChatClientProvider, ChatRoomProvider, and various hooks for managing chat functionalities.

Changes

File	Change Summary
src/core/room-options.ts	Updated timeoutMs from 10000 to 5000 in TypingOptions and modified documentation.
src/react/README.md	Enhanced documentation with new components (ChatClientProvider, ChatRoomProvider) and hooks (useChatClient, useChatConnection, useRoom, useMessages, useOccupancy, useRoomReactions, useTyping, usePresence, usePresenceListener).

Poem

In the chat rooms where bunnies play,
A timeout shorter brightens the day.
With new hooks and providers to share,
Communication flows with joy in the air!
Hop along, dear friends, let’s chat and cheer,
For every message brings us near! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.