Deprecate backwards incompatible chat fields

[1egoman]

More info on why this is being done: livekit/components-js#1252

Summary by CodeRabbit

• Deprecations
  • Several chat message fields are now marked as deprecated, including message attachments and edit timestamp fields.
  • Users are encouraged to migrate to the Data Streams API and Text Streams API for improved functionality.

[changeset-bot]

🦋 Changeset detected

Latest commit: 9f819c4

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
livekit-client	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds deprecation notices to chat message fields in the livekit-client library and introduces a new attachedFiles field, guiding users toward the Data Streams and Text Streams APIs for future implementations.

Changes

Cohort / File(s)	Summary
Changeset Entry .changeset/pretty-swans-kneel.md	New changeset for patch release documenting deprecation of backwards incompatible chat message fields.
Type Definitions src/room/types.ts	Added deprecation notices for attachments, editTimestamp, and attachedFiles fields, directing users to Data Streams and Text Streams APIs. New attachedFiles?: Array<File> field added to ChatMessage interface.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Old chat fields fade to grey,
Data Streams light the way,
Attachments dance through new API streams,
Breaking changes, forward dreams! 🌟

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Deprecate backwards incompatible chat fields' directly and clearly summarizes the main change: adding deprecation comments for chat-related fields in the codebase.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch deprecate-backwards-incompatible-chat-fields

---

🧹 Recent nitpick comments

.changeset/pretty-swans-kneel.md (1)

5-5: Minor: Hyphenate compound adjective.

"Backwards incompatible" should be hyphenated as "backwards-incompatible" when used as a compound modifier before a noun.

📝 Suggested fix

-Deprecate backwards incompatible chat message fields
+Deprecate backwards-incompatible chat message fields

📜 Recent review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 014346e and 9f819c4.

📒 Files selected for processing (2)

• .changeset/pretty-swans-kneel.md
• src/room/types.ts

🧰 Additional context used

🪛 LanguageTool

.changeset/pretty-swans-kneel.md

[grammar] ~5-~5: Use a hyphen to join words.
Context: ...-client': patch --- Deprecate backwards incompatible chat message fields

(QB_NEW_EN_HYPHEN)

🔇 Additional comments (2)

src/room/types.ts (2)

22-23: LGTM!

Deprecation comment correctly added with appropriate documentation link to the Data Streams API.

---

119-122: Deprecations and new field look good.

The deprecation comments are properly formatted with @deprecated JSDoc tags and include helpful links to the recommended APIs.

Note that attachedFiles is being introduced as a new field that is already deprecated. This is a valid pattern for backwards compatibility, allowing existing consumers to use the field while clearly signaling they should migrate to the Data Streams API.

_{✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.}

---

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

size-limit report 📦

Path	Size
dist/livekit-client.esm.mjs	86.52 KB (0%)
dist/livekit-client.umd.js	96.82 KB (0%)

[1egoman]

Closing in favor of livekit/components-js#1283