Release 2.8.0

[VeskeR]

Summary by CodeRabbit

• Documentation
  • Updated the changelog to document new methods for device management and channel subscriptions in version 2.8.0.
• Chores
  • Bumped the library version to 2.8.0 across relevant files.

[coderabbitai]

Walkthrough

This update marks the release of version 2.8.0 of the ably-js library. The changelog documents the addition of new device() methods to both the RestClient and RealtimeClient classes, enabling access to a LocalDevice object for push notifications. Additionally, a new channelSubscriptions() method is introduced on the LocalDevice class, allowing retrieval of channel subscriptions scoped to the local device. The package version is incremented in both package.json and the React hooks source file, with no other changes to code or dependencies.

Changes

File(s)	Summary of Changes
CHANGELOG.md	Added 2.8.0 release notes: new device() methods on RestClient/RealtimeClient, and channelSubscriptions() on LocalDevice.
package.json	Updated version from 2.7.0 to 2.8.0.
src/platform/react-hooks/src/AblyReactHooks.ts	Updated exported version constant from '2.7.0' to '2.8.0'.

Sequence Diagram(s)

sequenceDiagram
    participant Client as RestClient/RealtimeClient
    participant Device as LocalDevice
    participant Ably as Ably Service

    Client->>Client: device()
    Client->>Device: Returns LocalDevice instance
    Device->>Ably: channelSubscriptions()
    Ably-->>Device: Returns channel subscriptions for local device

Loading

Suggested reviewers

• lawrence-forooghian
• ttypic

Poem

A hop and a skip, a version anew,
Two-eight-oh is here, with features for you!
Devices now handy, subscriptions in tow,
The changelog grows longer, the numbers do grow.
With carrots for bytes and code in my hat,
This rabbit says, “Cheers!”—now give it a pat! 🥕

---

📜 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 154c1f8 and 8242d64.

⛔ 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 (6)

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

🔇 Additional comments (4)

package.json (1)

4-4: Approve version bump.
The package version has been correctly updated to 2.8.0 to reflect the new release.

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

15-15: Approve version constant update.
The exported version constant has been updated from '2.7.0' to '2.8.0' to stay in sync with the package.json bump.

CHANGELOG.md (2)

5-6: Approve new release heading.
The changelog entry for version 2.8.0 with the correct date (2025-05-01) has been added as expected.

---

7-8: Approve changelog entries for new methods.
The bullet points accurately document the addition of device() methods on RestClient and RealtimeClient, and LocalDevice.channelSubscriptions(), with correct PR references.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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.
  • 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.

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 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.