release: v0.15.0

[splindsay-92]

Context

• Provide name of JIRA ticket that this PR is related to (if applicable).
  • e.g. CHA-101 - this will automatically link the PR to the JIRA ticket.
• Provide names of any related DRs (if applicable).
• Provide links to any related PRs (including documentation)

Description

• Describe the changes introduced in this PR
• Provide relevant context or considerations for reviewers.
  • Such as why the changes are necessary,
    or how they affect the system.

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).
• Updated the website documentation (if applicable).
• 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.

[coderabbitai]

Walkthrough

Updates documentation and package metadata for release 0.15.0: adds a new CHANGELOG entry for 0.15.0, expands UPGRADING.md with detailed breaking-change and migration notes, and bumps package.json version from 0.14.1 to 0.15.0.

Changes

Cohort / File(s)	Summary
Changelog CHANGELOG.md	Added a new 0.15.0 entry containing Breaking Changes, Fixes, and Improvements. The entry documents API/typing changes, event/type restructures, and other release notes; no code or public API implementations changed.
Upgrade guide UPGRADING.md	Added comprehensive 0.14.x → 0.15.0 migration notes: accessor changes (methods → properties, e.g., current() → current), removal of message convenience helpers, presence/event filtering changes, message serials now strings, reaction event/type reshaping (summary vs raw), several type renames (QueryOptions→HistoryParams, MessageOptions→MessagesOptions, etc.), stricter JSON-serializable typings for presence/metadata, ChatClient.clientId made optional, MessageVersion fields become non-nullable, and notes about internal/public surface removals.
Package metadata package.json	Bumped package version from 0.14.1 to 0.15.0. No other changes to scripts, dependencies, or exports.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Pre-merge checks and finishing touches

✅ 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 "release: v0.15.0" directly and concisely summarizes the primary purpose of the pull request, which is to release version 0.15.0 of the SDK. The changeset contains version bumps in package.json, a new 0.15.0 changelog entry, and an upgrading guide for the 0.15.0 release, all of which align with the release objective stated in the PR description. The title is specific, follows conventional release PR naming patterns, and contains no vague terminology, noise, or misleading information.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch release/v0.15.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

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

[github-actions]

Coverage Report

Status	Category	Percentage	Covered / Total
🟢	Lines	95.46% (🎯 95%)	3871 / 4055
🟢	Statements	95.46% (🎯 95%)	3871 / 4055
🟢	Functions	98.29% (🎯 98%)	288 / 293
🟢	Branches	97.32% (🎯 97%)	945 / 971

File Coverage

No changed files found.

Generated in workflow #3040 for commit 0b487e5 by the Vitest Coverage Report Action

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

UPGRADING.md (1)

5-355: Apply markdown heading formatting for subsection titles.

The 0.14.x to 0.15.0 upgrade guide content is comprehensive and well-structured with clear before/after examples. However, static analysis has flagged 38 markdown formatting violations (MD036) where emphasis is used instead of proper heading syntax.

Throughout this section, subsection titles use **bold** formatting instead of proper markdown headings. Convert these to use #### (level 4 headings) for consistency with markdown best practices.

Examples to fix:

• Line 9: **Expected Impact: High** → #### Expected Impact
• Line 13: **Before** → #### Before
• Line 20: **After** → #### After
• Line 29: **Expected Impact: Medium** → #### Expected Impact
• And similarly for lines 33, 49, 69, 73, 85, 107, 111, 118, 127, 131, 139, 151, 155, 164, 175, 181, 191, 203, 213, 225, 234, 245, 251, 257, 265, 274, 287, 293, 307, 316, 327, 331, 337, 347.

Apply this pattern throughout the section:

- **Expected Impact: High**
+ #### Expected Impact
+ 
+ High

- **Before**
+ #### Before

- **After**
+ #### After

This ensures markdown linting passes and improves semantic structure for documentation tools and accessibility.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 5993ccd and b5e0fb4.

⛔ Files ignored due to path filters (2)

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

📒 Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• UPGRADING.md (1 hunks)
• package.json (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

UPGRADING.md

9-9: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

13-13: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

20-20: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

29-29: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

33-33: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

49-49: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

69-69: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

73-73: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

85-85: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

107-107: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

111-111: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

118-118: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

127-127: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

131-131: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

139-139: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

151-151: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

155-155: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

164-164: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

175-175: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

181-181: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

191-191: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

203-203: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

213-213: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

225-225: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

234-234: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

245-245: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

251-251: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

257-257: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

265-265: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

274-274: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

287-287: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

293-293: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

307-307: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

316-316: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

327-327: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

331-331: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

337-337: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

347-347: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)

• GitHub Check: test-typescript
• GitHub Check: test node 24
• GitHub Check: lint
• GitHub Check: test node 18
• GitHub Check: test node 22
• GitHub Check: test node 20
• GitHub Check: demo-app
• GitHub Check: check-error-codes
• GitHub Check: build
• GitHub Check: audit
• GitHub Check: format-check
• GitHub Check: build
• GitHub Check: check-all-package-lock-updated

🔇 Additional comments (2)

package.json (1)

3-3: Version bump is correctly applied.

The package version has been properly updated from 0.14.1 to 0.15.0, matching the release documentation in CHANGELOG.md and UPGRADING.md.

CHANGELOG.md (1)

5-46: Well-documented release entry with clear categorization.

The 0.15.0 changelog entry comprehensively documents breaking changes, fixes, and improvements with proper PR references. The structure aligns with previous entries and provides clear guidance by referencing UPGRADING.md.

Note: The release date is currently set to "TBD" on line 5. Ensure this is updated to the actual release date before merging.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

UPGRADING.md (1)

5-332: Address markdown formatting: use heading levels instead of bold for section labels.

Static analysis flagged 31+ instances (MD036) where bold text (**text**) is used for section headers like **Expected Impact: Low**, **Before**, and **After**. While this matches the existing style in older sections (0.13.x to 0.14.x), markdown best practices prefer heading levels (e.g., ####) for improved structure and consistency.

Consider refactoring these to use proper heading levels:

 ### Typing and Occupancy Current Changed to Properties
 
-**Expected Impact: Low**
+#### Expected Impact: Low

 The `current()` methods have been changed to properties for consistency with other parts of the API (e.g., room status).
 
-**Before**
+#### Before

This applies consistently to all **Expected Impact: X**, **Before**, and **After** instances throughout the new 0.15.0 section.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between b5e0fb4 and c8f02e5.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• UPGRADING.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• CHANGELOG.md

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

UPGRADING.md

9-9: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

13-13: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

20-20: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

29-29: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

33-33: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

49-49: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

69-69: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

73-73: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

85-85: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

108-108: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

112-112: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

119-119: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

128-128: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

132-132: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

141-141: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

152-152: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

158-158: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

168-168: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

180-180: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

190-190: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

202-202: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

211-211: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

222-222: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

228-228: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

234-234: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

242-242: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

251-251: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

264-264: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

270-270: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

284-284: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

293-293: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

304-304: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

308-308: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

314-314: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

324-324: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (13)

• GitHub Check: test node 24
• GitHub Check: test node 18
• GitHub Check: test node 22
• GitHub Check: build
• GitHub Check: test node 20
• GitHub Check: demo-app
• GitHub Check: check-error-codes
• GitHub Check: audit
• GitHub Check: lint
• GitHub Check: test-typescript
• GitHub Check: format-check
• GitHub Check: check-all-package-lock-updated
• GitHub Check: build

[coderabbitai]

Actionable comments posted: 2

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between c8f02e5 and 857cea4.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• UPGRADING.md (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Build and test

CHANGELOG.md

[error] 24-24: cspell: Unknown word 'serializability'.

🪛 markdownlint-cli2 (0.18.1)

CHANGELOG.md

9-9: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

13-13: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

20-20: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

29-29: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

33-33: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

🔇 Additional comments (1)

UPGRADING.md (1)

88-103: ✓ Presence event documentation now correctly uses enum and proper property name.

The examples have been corrected to consistently use PresenceEventType enum values and the correct event.type property throughout. The before/after code patterns properly guide users on how to migrate from event filter parameters to explicit switch/case statements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

UPGRADING.md (1)

9-9: Address markdown formatting violations in "Before" and "After" sections.

The static analysis tool (markdownlint-cli2) flags 34 instances where bold text is used instead of proper markdown headings (MD036 violations). This pattern appears throughout the file in example blocks using **Before** and **After**. For consistency with markdown standards and better document structure, convert these to proper heading syntax.

Example fix:

-**Before**
+### Before

-```ts
+```ts

Alternatively, if you prefer to keep bold for visual brevity, you can suppress this linting rule in the file's frontmatter or project config.

Also applies to: 13-13, 20-20, 29-29, 33-33, 49-49, 69-69, 73-73, 85-85, 108-108, 112-112, 119-119, 128-128, 132-132, 141-141, 152-152, 158-158, 168-168, 180-180, 190-190, 202-202, 211-211, 222-222, 228-228, 234-234, 242-242, 251-251, 264-264, 270-270, 284-284, 293-293, 304-304, 308-308, 314-314, 324-324

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e8ae52d and 0b487e5.

⛔ Files ignored due to path filters (2)

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

📒 Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• UPGRADING.md (1 hunks)
• package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• package.json

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

UPGRADING.md

9-9: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

13-13: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

20-20: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

29-29: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

33-33: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

49-49: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

69-69: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

73-73: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

85-85: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

108-108: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

112-112: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

119-119: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

128-128: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

132-132: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

141-141: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

152-152: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

158-158: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

168-168: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

180-180: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

190-190: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

202-202: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

211-211: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

222-222: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

228-228: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

234-234: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

242-242: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

251-251: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

264-264: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

270-270: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

284-284: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

293-293: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

304-304: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

308-308: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

314-314: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

324-324: Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: test node 22
• GitHub Check: test node 20
• GitHub Check: test node 18

🔇 Additional comments (1)

CHANGELOG.md (1)

5-42: CHANGELOG.md 0.15.0 entry looks good; address minor duplication concern.

The new 0.15.0 section is well-structured. However, line 26 describes "Message.version.serial and Message.version.timestamp are now non-nullable" as a 0.15.0 breaking change, but the 0.14.1 Fixes section (line 47) already documents the same change. Clarify whether this is intentional (e.g., enforced stricter in 0.15.0) or if one entry should reference the other to avoid reader confusion.