Release 2.10.0

[VeskeR]

Will wait for #2049 before merging this PR

Summary by CodeRabbit

• Documentation
  • Updated the changelog with details for version 2.10.0, highlighting new client options and deprecations, and referencing platform customization guidance.
• Chores
  • Bumped the package version to 2.10.0.
  • Updated the reported version in the React Hooks package to 2.10.0.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This update increments the package version to 2.10.0, updates the changelog with new features and deprecations, and synchronizes the version constant in the React hooks source file. No functional code changes are introduced beyond these versioning and documentation updates.

Changes

File(s)	Change Summary
CHANGELOG.md	Added release notes for 2.10.0, documenting new Channels.all, new ClientOptions.endpoint, and deprecations of old client options.
package.json	Updated package version from 2.9.0 to 2.10.0.
src/platform/react-hooks/src/AblyReactHooks.ts	Updated exported version constant from '2.9.0' to '2.10.0'.

Suggested reviewers

• umair-ably

Poem

The version hops from nine to ten,
A changelog penned by careful paws again.
New endpoints bloom, old hosts retire,
React hooks echo the version’s choir.
With every bump, the code feels bright—
A rabbit’s leap into the night! 🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: '@es-joy/jsdoccomment@0.37.1',
npm warn EBADENGINE required: { node: '^14 || ^16 || ^17 || ^18 || ^19 || ^20' },
npm warn EBADENGINE current: { node: 'v24.2.0', npm: '11.3.0' }
npm warn EBADENGINE }
npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE package: 'eslint-plugin-jsdoc@40.3.0',
npm warn EBADENGINE required: { node: '^14 || ^16 || ^17 || ^18 || ^19' },
npm warn EBADENGINE current: { node: 'v24.2.0', npm: '11.3.0' }
npm warn EBADENGINE }
npm error Exit handler never called!
npm error This is an error with npm itself. Please report this error at:
npm error https://github.com/npm/cli/issues
npm error A complete log of this run can be found in: /.npm/_logs/2025-06-25T08_34_28_701Z-debug-0.log

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 85cd0c5 and 1172a5a.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• package.json (1 hunks)
• src/platform/react-hooks/src/AblyReactHooks.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate Unit Tests

• Create PR with Unit Tests
• Post Copyable Unit Tests in Comment
• Commit Unit Tests in branch release/2.10.0

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai auto-generate unit tests to generate unit tests for this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/platform/react-hooks/src/AblyReactHooks.ts (1)

15-15: Prefer deriving the version from package.json to prevent drift

Hard-coding the version string here means every release requires a manual edit and risks divergence from package.json. Consider importing the version at build time instead.

Example (ES2022 / TS ≥5.0):

-import { /* existing imports */ } from 'ably';
+import * as Ably from 'ably';
+// eslint-disable-next-line @typescript-eslint/consistent-type-imports
+import pkg from '../../../../package.json' assert { type: 'json' };

-export const version = '2.10.0';
+export const version: string = pkg.version;

If your bundler can’t handle JSON asserts, alternative solutions include a small build-time plugin that replaces a __SDK_VERSION__ placeholder.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f2b7e6 and 85cd0c5.

⛔ Files ignored due to path filters (1)

• package-lock.json is excluded by !**/package-lock.json

📒 Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• package.json (1 hunks)
• src/platform/react-hooks/src/AblyReactHooks.ts (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (7)

• GitHub Check: test-node (16.x)
• GitHub Check: test-node (20.x)
• GitHub Check: test-browser (firefox)
• GitHub Check: test-browser (webkit)
• GitHub Check: test-node (18.x)
• GitHub Check: test-browser (chromium)
• GitHub Check: test-npm-package

🔇 Additional comments (2)

package.json (1)

4-4: Ensure no lingering 2.9.0 references in the codebase

The version bump looks correct. To avoid surprises, please double-check that no other hard-coded '2.9.0' strings remain (e.g. in headers injected by build tools, test snapshots, docs).

#!/usr/bin/env bash
# List any occurrences of the old version that might have been missed.
rg --line-number --fixed-strings '2.9.0' || true

CHANGELOG.md (1)

5-9: Changelog entry looks good

The new 2.10.0 section is clear and follows the established format. 👍

[ttypic]

LGTM