Skip to content

docs: consolidate v10 breaking changes into ai-docs - #1919

Merged
isekovanic merged 4 commits into
release-v10from
claude/sdk-v10-breaking-changes-f64baf
Oct 19, 2026
Merged

isekovanic merged 4 commits into
release-v10from
claude/sdk-v10-breaking-changes-f64baf

Conversation

@oliverlaz

Copy link
Copy Markdown
Member

Summary

Consolidates every breaking change in the stream-chat public API between v9 (master @ 24b7623) and v10 (release-v10 @ 53505e7) into a single file, ai-docs/v10-breaking-changes.md, to serve as the source of truth for the migration guides and docs updates. The nine root v9-to-v10-migration-guide-*.md files, react-thread-paginator-migration.md and docs/breaking-changes-v14-v15.md are superseded and removed; references in CLAUDE.md and docs/*.md now point to the new file.

Also adds ai-docs/v10-followups.md, a record-only list of bugs, dead code, simplifications and doc mismatches found during the audit, with a "Fix before 10.0.0 ships" section at the top. Nothing in src/ is changed by this PR.

How the list was produced

  • Mechanical diff of the exported API surface (exports, class members, signatures) built from both dist/types.
  • Deep type-compatibility check: both builds loaded into one TS program, every shared export checked for assignability in both directions to catch nested shape changes.
  • The v9 docs-snippet tests type-checked against v10 (603 errors, grouped into 70 distinct changes).
  • Behaviour changes mined from the test/unit diff, and how stream-chat-react and stream-chat-react-native actually migrated.
  • Claims from the existing guides and the 94 commits, each re-verified against source (the old guides had a number of errors, now corrected).
  • Every changed src/ file and every changed export is accounted for (machine-checked), then reviewed by independent accuracy and completeness passes with runtime probes.

Notes for reviewers

  • rc-to-rc changes are excluded; only v9 to v10 counts.
  • Section 23 lists open questions that need the live API to confirm.
  • The file is large (mostly the 384-row type rename table).

Add ai-docs/v10-breaking-changes.md, a single verified list of every
breaking change in the stream-chat public API from v9 (master @ 24b7623)
to v10 (release-v10 @ 53505e7), to serve as the source for migration
guides and docs updates. Built from a mechanical export-surface diff, a
deep type-compatibility check, the docs-snippet compile check, the unit
test diff, the downstream React and React Native migrations, the existing
guides and commit history, all reconciled against source and reviewed.

Add ai-docs/v10-followups.md with dead code, bugs, simplifications and
doc mismatches found during the audit (record only, nothing fixed).

Remove the superseded root migration guides and repoint references.

@isekovanic isekovanic left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the followups and breaking changes make sense, a bunch of the followups are really really narrow edge cases but I guess it makes sense to fix them.

I'll take care of all of them today in a separate pr

Comment thread ai-docs/v10-followups.md Outdated
Comment thread ai-docs/v10-followups.md Outdated
Comment thread ai-docs/v10-followups.md Outdated
oliverlaz and others added 2 commits October 19, 2026 13:55
Cover the gaps a real stream-chat-react v14 to v15 migration hit:
channel name/image reads moving under custom, update() replacing all
custom data, disconnectUser disposing app-held channel instances, and
options.limit mapping to paginatorOptions.pageSize.

Document the page-size mapping on ChannelPaginatorRequestOptions and
add type tests pinning the queryChannelsAndHydrate overloads.
@isekovanic
isekovanic merged commit 07aa5f5 into release-v10 Oct 19, 2026
4 checks passed
@isekovanic
isekovanic deleted the claude/sdk-v10-breaking-changes-f64baf branch October 19, 2026 12:51
@stream-ci-bot

Copy link
Copy Markdown

🎉 This PR is included in version 10.0.0-rc.23 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants