[PUB-1667] Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values #2689

VeskeR · 2025-06-27T06:33:32Z

Description

PUB-1667
ably-js support for this added in ably/ably-js#2052

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

…cts as LiveMap values ably-js support for this added in [1] [1] ably/ably-js#2052

coderabbitai · 2025-06-27T06:34:03Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

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

mschristensen

Looks good, minor comments. Also should not be merged until the ably-js client support has been released

mschristensen · 2025-07-03T13:39:21Z

src/pages/docs/liveobjects/index.mdx

@@ -57,7 +57,7 @@ LiveObjects provides specialized object types to model your application state. T

 #### LiveMap <a id="map"/>

-[LiveMap](/docs/liveobjects/map) is a key/value data structure that synchronizes its state across users in realtime. It enables you to store primitive values, such as numbers, strings, booleans and buffers, as well as other objects, enabling [composable data structures](#composability).
+[LiveMap](/docs/liveobjects/map) is a key/value data structure that synchronizes its state across users in realtime. It enables you to store primitive values, such as numbers, strings, booleans and buffers; JSON-serializable objects or arrays; and other LiveObjects types, enabling [composable data structures](#composability).


nit: I would drop the semicolons and stick consistently with commas

Suggested change

[LiveMap](/docs/liveobjects/map) is a key/value data structure that synchronizes its state across users in realtime. It enables you to store primitive values, such as numbers, strings, booleans and buffers; JSON-serializable objects or arrays; and other LiveObjects types, enabling [composable data structures](#composability).

[LiveMap](/docs/liveobjects/map) is a key/value data structure that synchronizes its state across users in realtime. It enables you to store primitive values, such as numbers, strings, booleans, buffers, JSON-serializable objects or arrays and other LiveObjects types, enabling [composable data structures](#composability).

Applies to other files too

mschristensen · 2025-07-03T13:40:55Z

src/pages/docs/liveobjects/rest-api-usage.mdx

-{ "data": { "objectId": "counter:JbZYiHnw0ORAyzzLSQahVik31iBDL_ehJNpTEF3qwg8@1745828651669" }}
+{ "data": { "number": 42 } }
+{ "data": { "string": "LiveObjects is awesome" } }
+{ "data": { "string": "{\"hello\":\"world\"}", "encoding": "json" } }


Shall we include an array example?

Update LiveObjects docs to reflect support for JSON-serializable obje…

850b8d7

…cts as LiveMap values ably-js support for this added in [1] [1] ably/ably-js#2052

VeskeR requested review from mschristensen and m-hulbert June 27, 2025 06:33

VeskeR mentioned this pull request Jun 27, 2025

[PUB-1667] Add support for encoding/decoding JSON objects for LiveMap values ably/ably-js#2052

Open

VeskeR changed the title ~~Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values~~ [PUB-1667] Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values Jun 27, 2025

m-hulbert approved these changes Jun 27, 2025

View reviewed changes

mschristensen approved these changes Jul 3, 2025

View reviewed changes

m-hulbert added the Do not merge When the PR is in progress do not merge label Jul 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[PUB-1667] Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values #2689

[PUB-1667] Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values #2689

Uh oh!

VeskeR commented Jun 27, 2025 •

edited by jira bot

Loading

Uh oh!

coderabbitai bot commented Jun 27, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

mschristensen left a comment

Uh oh!

mschristensen Jul 3, 2025

Uh oh!

mschristensen Jul 3, 2025

Uh oh!

Uh oh!

	[LiveMap](/docs/liveobjects/map) is a key/value data structure that synchronizes its state across users in realtime. It enables you to store primitive values, such as numbers, strings, booleans and buffers; JSON-serializable objects or arrays; and other LiveObjects types, enabling [composable data structures](#composability).
	[LiveMap](/docs/liveobjects/map) is a key/value data structure that synchronizes its state across users in realtime. It enables you to store primitive values, such as numbers, strings, booleans, buffers, JSON-serializable objects or arrays and other LiveObjects types, enabling [composable data structures](#composability).

[PUB-1667] Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values #2689

Are you sure you want to change the base?

[PUB-1667] Update LiveObjects docs to reflect support for JSON-serializable objects as LiveMap values #2689

Uh oh!

Conversation

VeskeR commented Jun 27, 2025 • edited by jira bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai bot commented Jun 27, 2025

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

mschristensen left a comment

Choose a reason for hiding this comment

Uh oh!

mschristensen Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

mschristensen Jul 3, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VeskeR commented Jun 27, 2025 •

edited by jira bot

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)