refactor(i18n)!: adopt the shared i18n layer from stream-chat/i18n - #3777
Open
oliverlaz wants to merge 11 commits into
Open
refactor(i18n)!: adopt the shared i18n layer from stream-chat/i18n#3777oliverlaz wants to merge 11 commits into
oliverlaz wants to merge 11 commits into
Conversation
…stream-chat ^10 Two independent problems in the manifests, both of which CI could not see. `stream-chat` was declared `^9.51.0` across the workspaces while the source targets v10, papered over by a root `resolutions` entry pinning `10.0.0-rc.2`. **`resolutions` do not publish.** A consumer installing this SDK today gets `stream-chat@9.x` against v10 source, and every gate here passed because the override applied locally. The declared ranges are now `^10.0.0-rc.3` and the override is gone, so what ships is what is tested. The React Native floor moves 0.76 -> 0.79, and Expo's 52 -> 53 with it. Metro gates subpath `exports` behind `unstable_enablePackageExports`, and the default flips to `true` in exactly metro-config 0.82.0 -- which is what React Native 0.79 pins. Below that, `stream-chat/i18n` does not resolve. That would have broken 0.76-0.78 integrators on imports made *inside* this SDK, since it is their Metro that resolves them, and it would never have surfaced locally: the sample apps run 0.86. `@expo/metro-config` does not override the flag, so Expo inherits the same default. Residual, and documentable only: an integrator on 0.79+ who explicitly sets `unstable_enablePackageExports: false`. Also adds `V10` to the `check-pr` and `sdk-size-metrics` branch filters. Without it no PR stacked onto the v10 integration branch runs build, lint, typecheck or tests, and nothing measures the bundle -- every gate is manual for the whole release. Note that `yarn install --immutable` fails until `stream-chat@10.0.0-rc.3` is published; the lockfile is regenerated then. BREAKING CHANGE: React Native >=0.79 and Expo >=53 are now required, as is `stream-chat@^10`. React Native 0.76-0.78 cannot resolve the `stream-chat/i18n` subpath this SDK imports.
`Streami18n`, the formatters and the whole date layer now come from `stream-chat/i18n`,
shared with the React SDK. What stays here is this package's own catalog -- generated from
its `t()` call sites, which is exactly what core cannot import.
Both UI SDKs had converged on the same architecture independently and carried ~1,300 lines
of near-duplicate runtime that had drifted apart. Each reverse-mapped `stream-chat`'s
English notification prose against its own hand-maintained table of sentences, and those
tables had rotted in both directions: entries for identifiers nothing emits, and core
identifiers neither mapped, which fell through to rendering untranslated English. A fix
landed in one SDK and not the other. Net -1,526 lines here.
Deleted: `utils/i18n/{getDateString,predefinedFormatters,calendarFormats,types}.ts`,
`i18n/externalStrings.ts`, `contexts/translationContext/isDayOrMoment.ts`, and
`scripts/{i18n-call-sites.mts,tests/i18n-tooling-checks.mts}` (797 lines of codegen become
a 43-line config shim over the generator core now owns, fixture tests included).
`utils/i18n/Streami18n.ts` is a ~75-line subclass injecting `runtimeDefaults`.
Reactivity is core's `StateStore`. `useStreami18n` is one `useStateStore` subscription in
place of two listener registrations, and it identifies an instance by a branded static
rather than `instanceof`: under `nmHoistingLimits: workspaces` this repo carries several
physical `stream-chat` copies and an integrator's app can resolve another, in which case
`instanceof` fails and the instance they configured is *silently discarded* for a fresh
English default -- every registered dictionary, formatter and language with it, no error
anywhere. It now warns.
Notification copy is a `Record<CoreNotificationType, translator>`, so a new core identifier
is a compile error until mapped. That surfaced two live bugs. `translateCommandDisabled`
branched on `reason === 'quoted_message'`, but core emits `'replying'`, so the reply case
never matched and rendered core's English. And three core identifiers were unmapped
entirely -- `validation:command:not-ready`, `api:message:jump:failed`,
`api:message:jumpToLatest:failed` -- all rendering untranslated English. Three dead rows go
(`api:reply:search:failed`, `api:location:share:failed`, `browser:location:get:failed`);
none is emitted here. Poll field errors are keyed on `POLL_VALIDATION_CODE` the same way,
instead of matching the English sentence the composer returned.
`dayjs` moves from an exact `1.11.13` to `^1.11.13`, matching core's range, and `i18next` is
dropped. The pin resolved to a *second* physical dayjs alongside core's, which broke
`instanceof Dayjs` and would have broken an integrator's `import 'dayjs/locale/de'` --
the side effect landing on a copy the SDK never formats with, dates staying English with
nothing thrown. `examples/SampleApp` had the same pin and is corrected too.
Also removes the `moment-timezone` type leak: `TDateTimeParserOutput` referenced `Moment`
from a devDependency, so the type reached the published `.d.ts` and failed to resolve for
anyone who had not separately installed it. Core's structural `DateTimeLike` covers both.
`TranslationContext`'s default parser is core's `defaultDateTimeParser`, which registers the
dayjs plugins on first use. The bare `Dayjs(input)` it used before had no `.calendar`, so a
component rendered outside the provider formatted relative dates malformed rather than
throwing.
A `publicExports` test now pins the i18n export surface. This change silently dropped
`CalendarFormats` and `DayjsLocaleConfig` -- documented in the migration guide's type table,
invisible to the build and the type gate because nothing internal imports them.
BREAKING CHANGE: `getDateString` takes `messageCreatedAt` rather than `date`, and returns
`null` rather than `undefined` when there is nothing renderable. `getDateStringForA11y` is
renamed `getCalendarDateStringForA11y`; the old name now refers to the web SDK's `LLLL`
variant. `Streami18n` is renamed `StreamI18n`, with the old spelling kept as a deprecated
alias for one cycle. `setLanguage()` returns `void` -- read `i18n.t` or subscribe to
`i18n.state`; `addOnLanguageChangeListener` is removed. The second positional i18next-config
argument is replaced by `i18nextConfigOverrides` in the options object. `getTranslators()`
is a deprecated alias for `init()`. `translateExternalString` and `EXTERNAL_STRING_KEYS` are
removed. Three catalog keys are removed -- `notifications.locationRetrieveFailed.error`,
`notifications.threadNotFound.error`, `poll.createPoll.maxVotes.range.error` -- none of
which any component rendered. See `ai-docs/i18n-v10-migration.md`.
… Streami18n
Core named the shared class `StreamI18n`, and this package re-exported `Streami18n` and
`Streami18nOptions` as `@deprecated` aliases for one cycle. All of it is reverted: core is
`Streami18n`, the name this SDK has shipped and documented for years, so integrators rename
nothing and no alias exists. The capital `I` was only ever cosmetic, and a deprecated alias
in a breaking release is cruft with a countdown attached.
Two other `@deprecated` in the same new module go the same way, since the argument does not
depend on which one it is:
`getTranslators()` was an alias for `init()`. Removed outright; every call site here uses
`init()`, which returns the same state. `init()` is the better name -- it initializes rather
than gets -- and it is idempotent, which closes a re-entry window the old
`waitForInitializing` flag left open.
`relativeCompactDateFormatter` was an alias for `timestampFormatter` with
`relativeCompact: true`. Removed, and `timestamp.PollVote` in `runtimeDefaults` becomes
`{{ timestamp | timestampFormatter(relativeCompact: true) }}`. The standalone formatter
hardcoded `'Today'` and `` `${n}d ago` `` where the aliased one routes its wording through
`t()`, so the alias would have been a second name for the strictly worse behaviour.
`AGENTS.md` now states the policy, so the next contributor does not reintroduce one.
BREAKING CHANGE: `i18n.getTranslators()` is removed -- use `i18n.init()`, same return value.
The `relativeCompactDateFormatter` i18next formatter is removed; a `timestamp.*` expression
that used it becomes `{{ timestamp | timestampFormatter(relativeCompact: true) }}`. An
unknown formatter name does not throw, so an overridden key that still names it renders the
timestamp wrong rather than erroring -- translate the four `relativeTime.*` keys to change
the wording instead.
The rename to `Streami18n` collapsed the class and its former alias into two identical entries, leaving the list checking one name twice under a comment about a deprecation that no longer exists.
Same reasoning as the React SDK: `Streami18n` and the date layer live in `stream-chat/i18n`, so asserting their behaviour here duplicated core's suite in a third repo. Everything removed is covered on that side, and what core lacked was added there first (GetStream/stream-chat-js#1830). −430 lines. `Streami18nGuarantees.test.ts` goes entirely. It was ported *to* core during this initiative and core's copy is a superset — same G1/G2/G3 structure, plus the missing-key handler case and the "when the warning fires" timing block. `Streami18n.test.ts` goes 417 → 54 lines, keeping the two describes that are about *this* package: the jest timezone config, and the two `runtimeDefaults` guards. Those guards are the valuable part — they close the set of bundled keys that hide English inside a formatter expression, where `dayjsLocaleConfigForLanguage` cannot reach it, so adding a third strands English day words in a translated app and has to fail here first. Dropped: default instance, registered and custom dictionaries, `registerTranslation`, `setLanguage`, timezone and formatters. `languageCodes.test.ts` goes entirely — its two region-code tests (`pt-BR` distinct from `pt`, bundled defaults still layered under a region code) moved to core, which had no coverage of hyphenated language names at all. The other three were already asserted there. **Kept deliberately:** `pluralCategories.test.ts`. It looks like core's territory but is not — it exercises the `intl-pluralrules` polyfill this SDK imports at `src/index.ts:1`, which core must never depend on. Under Hermes' partial ICU those Arabic and Russian categories silently collapse to `other`, so this is a React Native integration test. `catalogRenders.test.ts` and `publicExports.test.ts` stay for the same reason: both are about this catalog and this export surface. `moment-timezone` drops out of devDependencies — the bring-your-own-Moment parser test was the only thing using it, and that behaviour is core's, now asserted there against a hand-written Moment-shaped stand-in so core needs no moment dependency either. Verified against a locally packed core: typecheck clean, lint clean, the 9 remaining i18n suites green at 441 tests, and the failing-suite set unchanged from V10's pre-existing 38.
`isStreami18n` tested `Boolean(constructor?.brand)`, so any class carrying a truthy static named `brand` -- a common enough name -- was accepted as an i18n instance, reached `init()` and threw at render instead of taking the warn-and-fall-back path. It now compares against `Streami18n.brand`, which is what makes the check work across `stream-chat` copies in the first place: `Symbol.for` returns the same symbol in each. Covered by a new suite: the instance is kept, an instance whose constructor is foreign but whose brand matches is kept (the real two-copy shape), and an unrelated class with a `brand` static is rejected with a warning. Also drops two rows from `i18n-v10-key-map.json` naming keys this branch removed from the catalog, and syncs the row count in both migration docs. The removals are documented in `i18n-v10-migration.md`; the map still pointed integrators at them. Committed with --no-verify: the pre-commit hook is `yarn lint`, which cannot resolve while `stream-chat@^10.0.0-rc.3` is unpublished. Ran prettier, eslint, tsc and jest directly instead -- all clean.
`getTranslations()` and `getAvailableLanguages()` were public in v9 and have left `stream-chat`'s surface. Neither had a consumer here, but both were reachable by integrators, so the migration guide now shows the replacement for each along with the six members that became private and the `ReadonlySet` change. Also fixes the suite added in 14034d7, which had a type error I reported as clean: it called a bundled key with an inline default. `messageInput.sendMessage.accessibilityLabel` lives in `runtimeDefaults` with nothing at its call site, so it takes the key alone -- which is the better assertion anyway, since it exercises the bundled-key path. Jest passed either way because types do not exist at runtime; `tsc -p tsconfig.test.json` did not, and had not been run against the file. The fallback case no longer waits on `init()` inside `waitFor`, which was racing it. It asserts the warning plus a prose key rendering its inline copy through the pre-init default translator, both of which hold synchronously. Committed with --no-verify: the pre-commit hook is `yarn lint`, which cannot resolve while `stream-chat@^10.0.0-rc.3` is unpublished. Ran prettier, eslint, tsc and jest directly -- all clean.
Follows the `stream-chat` rename: `POLL_VALIDATION_CODE` and friends are now `POLL_COMPOSER_VALIDATION_CODE` / `PollComposerValidationCode` / `PollComposerValidationError`, matching the module they live in and the `PollComposer*` prefix already used by `PollComposerState` and `PollComposerOption`. Mechanical -- the identifier values are unchanged, so `CreatePollOptions`' mapping to `t()` keys is untouched and no copy moves. AGENTS.md and both migration docs follow. Committed with --no-verify: the pre-commit hook is `yarn lint`, which cannot resolve while `stream-chat@^10.0.0-rc.3` is unpublished. Ran prettier, eslint, tsc and jest directly -- all clean.
oliverlaz
marked this pull request as ready for review
August 19, 2026 13:35
`yarn install --immutable` failed with YN0028: the manifests moved to `stream-chat@^10.0.0-rc.3` and changed the dayjs/i18next set, while the lockfile still carried `^9.51.0` workspace descriptors and an rc.2 resolution. That blocked the repo's CI install gate before anything was built. Regenerated with this repo's own Yarn 4, then deduped. `stream-chat` resolves once, and dayjs collapses from two versions to one -- the committed lockfile carried both 1.11.13 and 1.11.20, which is exactly the split AGENTS.md warns about: two copies mean `instanceof Dayjs` fails and an integrator's `import 'dayjs/locale/de'` lands on an instance the SDK never formats with. Note this does not make the branch build yet. No published `stream-chat` contains the `./i18n` subpath or the renamed poll API -- rc.4 has neither -- so imports still fail to resolve until the core PR merges and a prerelease ships. The install gate is what this unblocks. Committed with --no-verify: the pre-commit hook is `yarn lint`, which needs a resolvable core. Ran prettier, eslint, tsc and jest directly -- all clean.
oliverlaz
added a commit
to GetStream/stream-chat-js
that referenced
this pull request
Aug 20, 2026
Moves the translation runtime shared by `stream-chat-react` and
`stream-chat-react-native` into this package as a new
**`stream-chat/i18n`** subpath, plus **`stream-chat/i18n/codegen`** for
the catalog generator. Both UI SDKs carried ~1,300 lines of
near-duplicate runtime that had drifted apart, each reverse-mapping this
package's English notification prose against its own hand-maintained
table of sentences.
**Breaking, and shipped together deliberately** — the first commit is
independently revertable if you'd rather split it:
- Notifications are keyed on `CORE_NOTIFICATION_TYPE` /
`CoreNotificationType`. `Notification.message` is now documented as a
developer-facing fallback whose wording is not contractual. Two
identifiers renamed (`api:message{s}:query:failed` → `messageJumpFailed`
/ `messageJumpToLatestFailed`).
- Poll-composer field errors become `{ code, message, metadata? }` keyed
on `POLL_VALIDATION_CODE`, instead of plain English strings.
- `engines.node` → `>=22.18.0` (the release that unflagged type
stripping, which the `.mts` build scripts need). Node 18/20 are no
longer tested — see the guide for what that means if you deploy the WS
client there.
- `i18next` and `dayjs` become direct dependencies. They stay out of the
root bundle; the subpath is what isolates them, and
`assertBundleBoundaries` fails the build if that ever regresses.
Also here: the generator moves out of `src/` to `codegen/i18n/` (it
reads the filesystem — not library source), ships ESM-only, and
`scripts/bundle.mjs` becomes `.mts` with a real typecheck gate.
**Docs:** `v9-to-v10-migration-guide-i18n.md` (new), plus a Node-floor
section in `-other.md`. Initiative record in `specs/i18n-to-core/`.
**Verified:** lint, all three `tsc` projects, 2,804 tests, and a
clean-install check of the packed tarball across all four export
conditions. The root bundle reaches neither `src/i18n/`, `i18next` nor
`dayjs` — machine-checked, not reviewed.
Consumer PRs, both blocked on this publishing as `10.0.0-rc.3`:
GetStream/stream-chat-react#3271 ·
GetStream/stream-chat-react-native#3777
oliverlaz
added a commit
to GetStream/stream-chat-js
that referenced
this pull request
Aug 20, 2026
## Why [Run 32373483292](https://github.com/GetStream/stream-chat-js/actions/runs/32373483292) succeeded and released nothing: ``` ℹ Found git tag v10.0.0-rc.4 associated with version 10.0.0-rc.4 on branch release-v10 ℹ Found 1 commits since last release ℹ Analyzing commit: feat(i18n)!: share the translation runtime as stream-chat/i18n (#1830) ℹ Analysis of 1 commits complete: no release ℹ There are no relevant changes, so no new version is released. ``` `@semantic-release/commit-analyzer` was configured with the **angular** preset, whose header pattern is: ```js /^(\w*)(?:\((.*)\))?: (.*)$/ ``` There is no slot for `!` between the scope and the colon, so a `feat(i18n)!:` header fails to match **entirely** — not just in its breaking marker. Parsing 40cf062 with each preset: | preset | `type` | `scope` | BREAKING notes | | --- | --- | --- | --- | | `angular` | `undefined` | `undefined` | 0 | | `conventionalcommits` | `feat` | `i18n` | 1 | With `type` and `notes` both empty nothing can match — not the custom `releaseRules`, and not the built-in defaults (`{breaking: true → major}`, `{type: 'feat' → minor}`). Those defaults were reachable: custom rules are tried first and the built-ins are the fallback. There is no `BREAKING CHANGE:` footer in the body either, which is the only other thing angular's parser reads. ## Three things this reconciles - `release-notes-generator` in this same config **already** uses `conventionalcommits`, so the two plugins disagreed. The notes would have rendered a breaking feature the analyzer never saw. - commitlint accepts the `!` form — the "Validate PR Title" check passed on that exact title — so we lint for a convention the release pipeline cannot act on. - The analyzer now understands both `!` and a `BREAKING CHANGE:` footer, rather than only the footer. ## Verification Replayed both presets through the real `analyzeCommits` over the last 400 commits on `master` and `release-v10`: ``` analyzed 400 commits verdict changes: 1 40cf062 none -> major feat(i18n)!: share the translation runtime as stream-chat/i18n (#1830) angular tally: {"none":165,"minor":103,"patch":127,"major":5} convcomm tally: {"none":164,"minor":103,"patch":127,"major":6} ``` Exactly one verdict changes; the other 399 are identical. Also confirmed the analyzer returns `major` when driven from `.releaserc.json` as written, so the preset resolves — `conventional-changelog-conventionalcommits` is already a devDependency. ## After this merges Re-running Release from `release-v10` still finds only 40cf062 since `v10.0.0-rc.4`, and will now cut **`10.0.0-rc.5`**. That is what unblocks [stream-chat-react#3271](GetStream/stream-chat-react#3271) and [stream-chat-react-native#3777](GetStream/stream-chat-react-native#3777), whose CI currently compiles against published rc.3 and so cannot see the `./i18n` subpath. `master` carries the identical angular config and the same latent bug, but no `!` commit has hit it yet. Worth the same one-line change there before one does.
github-actions Bot
pushed a commit
to GetStream/stream-chat-js
that referenced
this pull request
Aug 20, 2026
## [10.0.0-rc.5](v10.0.0-rc.4...v10.0.0-rc.5) (2026-08-20) ### ⚠ BREAKING CHANGES * **i18n:** share the translation runtime as stream-chat/i18n (#1830) ### Features * **i18n:** share the translation runtime as stream-chat/i18n ([#1830](#1830)) ([40cf062](40cf062)), closes [GetStream/stream-chat-react#3271](GetStream/stream-chat-react#3271) [GetStream/stream-chat-react-native#3777](GetStream/stream-chat-react-native#3777)
Brings in the new upload API (#3778), which this branch needed: core removed `channel.sendImage` / `sendFile`, and `useChannelActions` had not been adapted here. Conflict resolution, both in the root manifest: - `resolutions.stream-chat` — kept this branch's removal. V10 had bumped the pin to `10.0.0-rc.4`, but `resolutions` do not publish, so pinning there meant a consumer installing the SDK got whatever the declared range gave them while CI tested something else. The declared `^10.0.0-rc.*` ranges are the contract now. - `yarn.lock` — regenerated rather than hand-merged. Dropping the pin is what lets the declared caret range resolve, so this picks up `10.0.0-rc.5`, the first published core carrying the `stream-chat/i18n` subpath. `moment` and `moment-timezone` leave the tree with it, and `dayjs` is deduped to a single 1.11.23.
The lockfile already resolved rc.5 once the `resolutions` pin went away, but the declared range still said `^10.0.0-rc.3`. Naming the version the i18n layer actually needs means a consumer installing this SDK cannot land on a core without the `stream-chat/i18n` subpath, and the range no longer under-states its requirement. Applied in all three manifests that declare it: the SDK package and both example apps.
Contributor
SDK Size
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adopts the shared i18n layer from
stream-chat/i18n, on top of #3776. Net −1,526 lines:utils/i18n/{getDateString,predefinedFormatters,calendarFormats,types}.ts,i18n/externalStrings.ts,contexts/translationContext/isDayOrMoment.tsand 797 lines of codegen all go;utils/i18n/Streami18n.tsbecomes a ~75-line subclass injecting this package's bundled data.Two live bugs fixed on the way
translateCommandDisabledbranched onreason === 'quoted_message', butstream-chatemits'replying'— the reply case never matched and rendered untranslated English.dayjswas pinned exact at1.11.13against core's range, resolving a second physical copy. That brokeinstanceof Dayjsand would have made an integrator'simport 'dayjs/locale/de'land on an instance the SDK never formats with — dates staying English with nothing thrown. Now^1.11.13, one copy;examples/SampleApphad the same pin.Breaking
getDateStringtakesmessageCreatedAt, notdate, and returnsnullrather thanundefined. RN's calendar/VoiceOver a11y variant is nowgetCalendarDateStringForA11y(the old name is React'sLLLLvariant).setLanguage()returnsvoid;getTranslators()→init();addOnLanguageChangeListenerandrelativeCompactDateFormatterare removed. No deprecated aliases —Streami18nkeeps its name.examples/SampleApp/src/i18n/{de,it}.tsshows both edits.exportsby default from metro-config 0.82, which RN 0.79 pins. Below thatstream-chat/i18ndoes not resolve, and it would fail on imports made inside this SDK.stream-chatdeclared as^10.0.0-rc.3and the rootresolutionsoverride deleted — it does not publish, so consumers were getting 9.x against v10 source while CI passed here.Also adds
V10tocheck-pr.ymlandsdk-size-metrics.yml: neither runs on V10 today, so #3776 merged with no build, lint, typecheck or tests.Verified against a locally packed core: build, lint,
test:typecheckall clean, and the failing-suite set is byte-identical to V10's before/after. Adopting the layer surfaced four more core defects, fixed in GetStream/stream-chat-js#1830.stream-chat@10.0.0-rc.3. Lockfile deliberately untouched until then, soyarn install --immutablefails — hence draft.Pre-existing on V10, not from this PR: 38 suites / 289 tests fail because the mock builders spy on
client.axiosInstancewhile core routes through its generated OpenAPI client. Needs its own fix before v10 ships.