@chipmobilesdk/rn-i18n 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,57 +1,168 @@
-# Changelog
-
-All notable changes to `@chipmobilesdk/rn-i18n` are documented here. This project
-follows [Semantic Versioning](https://semver.org/).
-
-## 0.1.2 — 2026-11-01
-
-### Fixed
-
-- **A throwing locale listener no longer breaks a locale switch.** Listeners
-  were notified without isolation, so one that threw skipped every listener
-  after it (React subscribers included) and made `setLocale` reject after the
-  switch but before the choice was persisted: the app showed one locale and
-  stored another. Each listener is now isolated and reported with
-  `console.warn`, and a listener unsubscribed by an earlier one during the
-  same change is no longer called. No code change is required.
-
-## 0.1.0 — 2026-06-13
-
-Initial release of the reusable mobile i18n and locale library.
-
-### Added
-
-- `createI18n(config)` with eager configuration validation: duplicate locales,
-  unknown/duplicate/cyclic fallback chains, missing fallback resources, and
-  missing storage adapter are rejected before any localized content is served.
-- Translation lookup with namespaced nested keys, ordered fallback-chain
-  resolution, `{{name}}` interpolation, package-owned pluralization, and a
-  deterministic missing-key policy (one console warning per failed lookup path).
-- Runtime locale switching without restart, persisted through an app-injected
-  `LocaleStorageAdapter`, with recovery from unsupported persisted values.
-- Device-locale initialization via an injectable provider (default backed by
-  Hermes `Intl`), with exact-match and single-language-match selection.
-- Locale-aware formatting: `formatNumber`, `formatDate`, `formatCurrency` (via
-  Hermes `Intl`), and package-owned `formatUnit`/`convertUnit` across length,
-  mass, volume, and temperature dimensions.
-- Declared runtime-only translation entries that resolve through the same
-  pipeline and are protected during synchronization.
-- React bindings: `I18nProvider`, `useTranslation`, `useLocale`.
-- Node-only extraction/synchronization CLI (`@chipmobilesdk/rn-i18n/tooling`):
-  regex-pattern source scanning, locale JSON create/add/preserve/remove,
-  ambiguous-usage and conflict reporting, malformed-file isolation, typed key
-  contract generation, and deterministic output.
-
-### Adoption notes
-
-- App-owned translations live in the consuming app (commonly
-  `src/i18n/locales/<locale>.json`), never inside this package.
-- Host frameworks (`react`, `react-native`) are peer dependencies; this package
-  has zero runtime dependencies.
-- No native modules, permissions, network calls, analytics, or tracking are
-  introduced; the locale preference stays on-device via the injected adapter.
-
-### Compatibility
-
-React `19.x`, React Native `0.85+` (Hermes), TypeScript `5.8+`, Node `>=22.11.0`
-for tooling. Android and iOS, with no native code.
+# @chipmobilesdk/rn-i18n
+
+## 0.2.0
+
+### Minor Changes
+
+- One diagnostic stream: install a sink with `installSdkSink` from
+  `@chipmobilesdk/rn-core` and it receives what every package observes (events,
+  failures, warnings) as `SdkDiagnostic`s, redacted. Listeners are notified through
+  rn-core, so a listener that throws no longer stops the others nor fails the call that
+  notified, and its error is reported rather than swallowed. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-ads: a banner's auto-refresh is a new cycle, so its `loaded` and `impression`
+    events are no longer deduplicated away; the dedupe memory is bounded. A throwing
+    status, consent or placement listener is reported as an `internal_error` event.
+  - rn-i18n: new `onDiagnostic` config receives every diagnostic (`I18nDiagnostic`,
+    with a stable `code`); without it, warnings go to `console.warn` in development
+    builds only. The warn-once memory is bounded.
+  - rn-chart: now depends on rn-core for its diagnostics.
+  - rn-payment: status, entitlement and pending listeners report a throw to the logger
+    instead of swallowing it.
+
+- The package's errors extend `SdkError` from the new `@chipmobilesdk/rn-core`
+  dependency: `isSdkError` recognises them alongside every other package's, and each
+  carries `pkg`, `code` and `retryable`. Names and codes are unchanged. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-ai and rn-camera: `retryable` is the new name of `recoverable`, which stays as a
+    deprecated alias.
+  - rn-auth: `retryable` is true for `network-unavailable`. `redact` also removes URLs,
+    e-mail addresses and UUIDs.
+  - rn-ads: `redact` also removes JWTs and e-mail addresses, and reduces an `AdsError`
+    to its code.
+  - rn-ai: an error message quoted from the gateway is pattern-redacted.
+  - rn-camera: `redact` also removes JWTs, e-mail addresses and UUIDs.
+  - rn-theme: `ThemeConfigError` has `code: 'invalid_config'` and `ThemeContrastError`
+    `code: 'contrast'` (new `ThemeErrorCode` type).
+  - rn-i18n: `I18nConfigError` has `code: 'invalid_config'` and `UnitConversionError`
+    `code: 'unit_conversion'` (new `I18nErrorCode` type).
+
+- Hooks read through `useSyncExternalStore` (rn-core's `useExternalStore`) and
+  re-render only when what they return changes. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-auth: `useProfile` and `useAccessTier` no longer re-render for a status change,
+    and the provider's context no longer changes on every transition. New
+    `useAuthSelector`. `auth.getState()` returns the same frozen object until the state
+    changes, instead of a copy per call.
+  - rn-payment: `useEntitlement` re-renders only when its own entitlement changes; the
+    engine keeps unchanged entitlement objects across syncs and does not notify for a
+    sync that changed nothing.
+  - rn-ads: `usePlacementState` and `useAdsStatus` read tear-free; `useAdsEvents` keeps
+    one subscription when given an inline listener.
+  - rn-i18n: `useTranslation` returns the same `t` until the locale changes, and
+    `useLocale`'s `setLocale` is stable.
+  - rn-ai: new `useAiBehaviorState`, with `client.subscribe` and a stable
+    `client.getBehaviorState()`.
+
+- Every package's own copy is an rn-core message catalog that an app can translate. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-i18n: new `runtimeEntriesFromCatalog(catalog)` registers any SDK catalog in one
+    line, converting `{name}` variables to `{{name}}`.
+  - rn-ai: new `messageKeyForError(error)` gives the copy for every error code, and
+    `aiMessageSet`. The input placeholder default is neutral ("Type a message…"), and
+    two keys were added for errors that had none (`ai.error.signIn`, `ai.error.generic`).
+  - rn-auth: new `authMessages`, the catalog split into user and developer copy.
+  - rn-payment: new `paymentMessages`.
+  - rn-chart: summaries, announcements, adjustable-action labels, built-in state text
+    and legend hints come from `chartStrings`; pass `strings` to translate them. The
+    `accessibility.summaryFormatter` prop, declared before, now replaces the summary.
+
+- Formatters come from rn-core's cache instead of being built per call. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-notification: resolving a time zone builds one `Intl.DateTimeFormat` per zone
+    instead of one per occurrence; expanding 32 series of 32 occurrences went from
+    about 230 ms to under 30 ms on Node. Zone validity is memoized.
+  - rn-i18n: number, currency and date formatters are cached. A bad option (an unknown
+    currency such as `usd1`) goes through the invalid-format policy instead of
+    throwing out of a render, and a locale's `defaultCurrency` must be a three-letter
+    ISO 4217 code at startup.
+
+- One app-lifecycle source, and a startup that needs no extra frame. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-core: `appLifecycle()`, a shared, reference-counted `AppState` subscription that
+    reports changes only (`active`, `inactive`, `background`), with `onForeground` for a
+    return from the background and `createManualLifecycle` in `./testing`.
+  - rn-camera, rn-ads and rn-notification hear the lifecycle through it instead of
+    subscribing to `AppState` each, so an app holds one native listener. The camera
+    controller's core layer no longer imports `react-native`.
+  - rn-payment: `syncOnForeground(engine)` and `<PaymentProvider syncOnForeground>` call
+    `handleForeground()` on each return from the background. Off by default; calling
+    `handleForeground()` yourself works as before.
+  - rn-i18n: `i18n.initSync()` resolves the locale before the first render when the
+    storage adapter has the new optional `getItemSync`, and returns false otherwise.
+    `localeStorageFromKeyValue(port)` builds such an adapter from rn-core's
+    `KeyValuePort` (MMKV).
+
+### Patch Changes
+
+- Updated dependencies ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17), [#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17), [#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17)):
+  - @chipmobilesdk/rn-core@0.1.0
+
+## 0.1.3
+
+### Patch Changes
+
+- Packaging only; no code change. The package no longer declares `engines.node`: a
+  React Native package does not run on Node, so the field only produced install
+  warnings in apps on another Node version. rn-i18n's command-line tooling does run
+  on Node; its README's compatibility table states the version it needs. ([#14](https://github.com/operationd8979/chip-mobile-sdk/pull/14))
+
+## 0.1.2 — 2026-11-01
+
+### Fixed
+
+- **A throwing locale listener no longer breaks a locale switch.** Listeners
+  were notified without isolation, so one that threw skipped every listener
+  after it (React subscribers included) and made `setLocale` reject after the
+  switch but before the choice was persisted: the app showed one locale and
+  stored another. Each listener is now isolated and reported with
+  `console.warn`, and a listener unsubscribed by an earlier one during the
+  same change is no longer called. No code change is required.
+
+## 0.1.1 — 2026-08-01
+
+### Changed
+
+- The package now ships its agent skill (`skills/`), which consuming apps
+  copy in with `scripts/sync-sdk-skills.mjs`. No code change.
+
+## 0.1.0 — 2026-06-13
+
+Initial release of the reusable mobile i18n and locale library.
+
+### Added
+
+- `createI18n(config)` with eager configuration validation: duplicate locales,
+  unknown/duplicate/cyclic fallback chains, missing fallback resources, and
+  missing storage adapter are rejected before any localized content is served.
+- Translation lookup with namespaced nested keys, ordered fallback-chain
+  resolution, `{{name}}` interpolation, package-owned pluralization, and a
+  deterministic missing-key policy (one console warning per failed lookup path).
+- Runtime locale switching without restart, persisted through an app-injected
+  `LocaleStorageAdapter`, with recovery from unsupported persisted values.
+- Device-locale initialization via an injectable provider (default backed by
+  Hermes `Intl`), with exact-match and single-language-match selection.
+- Locale-aware formatting: `formatNumber`, `formatDate`, `formatCurrency` (via
+  Hermes `Intl`), and package-owned `formatUnit`/`convertUnit` across length,
+  mass, volume, and temperature dimensions.
+- Declared runtime-only translation entries that resolve through the same
+  pipeline and are protected during synchronization.
+- React bindings: `I18nProvider`, `useTranslation`, `useLocale`.
+- Node-only extraction/synchronization CLI (`@chipmobilesdk/rn-i18n/tooling`):
+  regex-pattern source scanning, locale JSON create/add/preserve/remove,
+  ambiguous-usage and conflict reporting, malformed-file isolation, typed key
+  contract generation, and deterministic output.
+
+### Adoption notes
+
+- App-owned translations live in the consuming app (commonly
+  `src/i18n/locales/<locale>.json`), never inside this package.
+- Host frameworks (`react`, `react-native`) are peer dependencies; this package
+  has zero runtime dependencies.
+- No native modules, permissions, network calls, analytics, or tracking are
+  introduced; the locale preference stays on-device via the injected adapter.
+
+### Compatibility
+
+React `19.x`, React Native `0.85+` (Hermes), TypeScript `5.8+`, Node `>=22.11.0`
+for tooling. Android and iOS, with no native code.