@chipmobilesdk/rn-camera 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,93 +1,207 @@
-# Changelog — @chipmobilesdk/rn-camera
-
-All notable changes to this package are documented here. The package follows semantic versioning.
-
-## [0.2.0] — 2026-11-01
-
-Lifecycle and capture-path fixes. **No code change is required**; two behaviours
-change (see Changed), and a store that should manage VisionCamera captures needs a
-`FileSystemBridge` with `move()`.
-
-### Fixed
-
-- **`useCameraController` survives a StrictMode remount.** The cleanup disposed the
-  only controller and the remount kept it, so the screen showed `idle` forever and
-  backgrounding no longer released the camera. A disposed controller is now replaced,
-  and constructing one has no side effects (it subscribes on first use), so a
-  controller React builds and discards no longer leaks listeners.
-- **`CameraPreview` subscribes to the controller.** It read `controller.state` once
-  per render, so the feed could stay unmounted after the session became active unless
-  the parent re-rendered. `useCameraState` now uses `useSyncExternalStore`.
-- **A failed capture no longer leaves `capturing: true` published**, and `capturing:
-  true` is now published at all — the single-flight slot was taken after the first
-  emit. A raw native or engine error is turned into `CameraError('captureFailed')`
-  (or `storageFailure` when saving fails), with no file path in the message.
-- **Foregrounding restarts only a session that backgrounding interrupted.** It used
-  to start any idle or stopped session while a preview was mounted — including one
-  the user had stopped, one never started, and one whose permission had been revoked.
-  A foreground that arrives while the release is still running now waits for it
-  instead of being dropped.
-- **Use after dispose is defined.** `start`, `resume`, `capture`, and the permission
-  and capability reads reject with `CameraError('notReady')`; `stop`, `pause` and
-  `cleanup` are safe no-ops.
-- **VisionCamera captures can be cleaned up.** They were saved in VisionCamera's own
-  temporary directory, outside the store, so `cleanup()` refused them and the 24-hour
-  sweep never saw them. The controller now moves each package-temporary capture into
-  the store (`ArtifactStore.adopt`), and the sweep spares captures adopted by the
-  running process. With no store, or a bridge without `move()`, the logger reports
-  `unmanaged:no-store` / `unmanaged:store-cannot-adopt` once.
-- **No more "Camera is not active" error on every session start.** The feed sent
-  `torchMode="off"` on mount; VisionCamera applies it before the camera is active
-  and leaves the native rejection unhandled. The prop is now left unset until the
-  torch is first turned on.
-- **One throwing state listener no longer breaks a transition** or starves the other
-  listeners; it is logged as `listener-threw`.
-
-### Changed
-
-- **`effectiveQuality` and `effectiveMaxDimension` report what was applied.** The
-  VisionCamera adapter echoed the request hints. Quality is fixed on the photo output
-  (0.9) and nothing resizes, so it now reports `0.9` and an unavailable max dimension.
-- **Unmounting a preview over an idle controller leaves it `idle`**, rather than
-  driving it through `stopping` to `stopped` and calling the engine's `stop()`.
-
-### Added
-
-- `ArtifactStore.adopt?(uri)` and `FileSystemBridge.move?(from, to)`, both optional.
-  `createMemoryFileSystem()` implements `move`.
-
-### Docs
-
-- The README no longer claims quality and max-dimension hints are applied, or a
-  single active session per process.
-
-## 0.1.0 — 2026-07-26
-
-Initial release. New package, no existing consumers, **no migration required**.
-
-### Added
-
-- **Permission handling** as a seven-state contract (`undetermined`, `requesting`, `granted`, `denied`, `deniedPermanently`, `unavailable`, `unsupported`). Reading status never prompts; requesting never re-prompts after a permanent denial; revocations made in system settings are pushed to subscribers without an app restart.
-- **`CameraPreview`** surface with `cover`/`contain` resize modes, an overlay slot via `children`, and pass-through of consumer accessibility properties. Ships no styled UI and takes no theme dependency.
-- **Still capture** returning a file reference plus metadata. Undeterminable fields (`fileSize`, `orientation`) are explicitly marked unavailable rather than guessed or omitted. Quality and max-dimension hints are normalized and reported back as effective values.
-- **Session lifecycle** — start, pause, resume, stop — that releases the camera on background, unmount, and stop, restarts on foreground when a surface is still mounted, and reports a single active session per controller.
-- **Artifact ownership and cleanup**: an optional `destination` on the capture request switches the result to app-owned and writes there directly; everything else lands in the package cache directory. `cleanup()` is idempotent and refuses anything the package does not own. Orphans are swept at initialization under a 24-hour time-to-live.
-- **Capability reporting** for camera positions, flash, torch, orientation, and camera-less devices, with capture-time flash modes and a continuous torch that is forced off on pause, stop, and background.
-- **Coordinate mapping** — pure, bidirectional, accounting for scale, letterbox or crop, orientation, and front-camera mirroring, accurate within 2 device-independent pixels on a round trip.
-- **Typed error taxonomy** of 11 codes, each carrying a `recoverable` flag, plus a `redact()` helper.
-- **Test adapter** (`createTestCamera`) implementing the same published ports as the production adapters, so consuming apps can drive every permission, capability, and capture path with no hardware and no permission prompts.
-- **Opt-in diagnostics logger**, defaulting to no logging.
-
-### Guarantees
-
-- No network egress of any kind.
-- No location read, no location permission requested.
-- Nothing written to the device photo library or gallery.
-- No capture history or index retained.
-- No on-device inference, no frame processor, no AI-derived labels.
-
-### Notes
-
-- `react-native-vision-camera` (>= 5.1.1) is a **peer dependency**; the consuming app installs and links it. This package authors no native source.
-- Android `minSdkVersion` remains **24** — VisionCamera 5.1.1 declares 23 and resolves the root project value first.
-- The local frame-processing extension point is documented in the README but deliberately not exported. It is designed to arrive as an additive minor release.
+# @chipmobilesdk/rn-camera
+
+## 0.3.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).
+
+- Native peers load through `lazyPeer` from `@chipmobilesdk/rn-core`, on first use,
+  and a missing one is each package's own typed error. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-auth: creating `auth` no longer loads react-native-app-auth or
+    react-native-keychain; each loads on first use. New entrypoints
+    `@chipmobilesdk/rn-auth/app-auth` and `/keychain`. The default platform comes from
+    rn-core.
+  - rn-camera: a preview whose VisionCamera feed cannot load fails the session with
+    `cameraUnavailable` (new `controller.reportSurfaceUnavailable()`), instead of
+    showing black with no error. A missing VisionCamera module is `cameraUnavailable`.
+  - rn-notification: `createMmkvStore` reports a fallback to memory as
+    `STATE_STORE_DEGRADED` (to the SDK sinks and a new `onDegraded` option) and
+    exposes `durable`.
+  - rn-payment: an iOS app validates its catalog against the iOS product ids; the
+    default platform used to be Android everywhere. A missing react-native-iap is
+    `PAYMENT_UNAVAILABLE`.
+  - rn-theme: `buildThemes` runs without React Native (new `hairlineWidth` option) and
+    importing the package no longer loads Unistyles; `applyThemeMode` loads it on
+    first use.
+  - rn-ads, rn-local-db: the same loading, with the same error codes as before.
+
+- Port conformance suites: one list of checks that a package's fake and its real adapter
+  both pass, so a test written against the fake proves something about the device. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+
+  - rn-core: `@chipmobilesdk/rn-core/testing` adds `runChecks`, `expectConformance`,
+    `ensure` and `createFaultRegistry` (deterministic fault injection by named point).
+  - rn-camera: a `./testing` entrypoint with `runPermissionPortConformance`,
+    `runCameraEngineConformance` and the test adapter, which stays on the main
+    entrypoint too until the next major. `createTestCamera(...).prompts()` counts system
+    prompts.
+  - rn-payment: `runProviderPortConformance` in `./testing`, passed by the fake store and
+    the Play adapter.
+  - rn-ads: `runAdsEngineConformance` in `./testing`, passed by the fake engine and the
+    AdMob adapter.
+  - rn-auth: a `./testing` entrypoint with `createMemorySecureStore`,
+    `runSecureTokenStoreConformance` and `runOidcAuthClientConformance`, passed by the
+    in-memory doubles and the keychain and app-auth adapters.
+
+- 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
+
+- `createCameraController` accepts an explicit `undefined` for `store` and `logger`, so
+  apps compiling with `exactOptionalPropertyTypes` type-check against the package.
+  `VisionCameraFeed` leaves `torchMode` unset until the app first touches the torch,
+  instead of passing `undefined`. No other change. ([#17](https://github.com/operationd8979/chip-mobile-sdk/pull/17))
+- 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.2.1
+
+### 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.2.0] — 2026-11-01
+
+Lifecycle and capture-path fixes. **No code change is required**; two behaviours
+change (see Changed), and a store that should manage VisionCamera captures needs a
+`FileSystemBridge` with `move()`.
+
+### Fixed
+
+- **`useCameraController` survives a StrictMode remount.** The cleanup disposed the
+  only controller and the remount kept it, so the screen showed `idle` forever and
+  backgrounding no longer released the camera. A disposed controller is now replaced,
+  and constructing one has no side effects (it subscribes on first use), so a
+  controller React builds and discards no longer leaks listeners.
+- **`CameraPreview` subscribes to the controller.** It read `controller.state` once
+  per render, so the feed could stay unmounted after the session became active unless
+  the parent re-rendered. `useCameraState` now uses `useSyncExternalStore`.
+- **A failed capture no longer leaves `capturing: true` published**, and `capturing:
+  true` is now published at all — the single-flight slot was taken after the first
+  emit. A raw native or engine error is turned into `CameraError('captureFailed')`
+  (or `storageFailure` when saving fails), with no file path in the message.
+- **Foregrounding restarts only a session that backgrounding interrupted.** It used
+  to start any idle or stopped session while a preview was mounted — including one
+  the user had stopped, one never started, and one whose permission had been revoked.
+  A foreground that arrives while the release is still running now waits for it
+  instead of being dropped.
+- **Use after dispose is defined.** `start`, `resume`, `capture`, and the permission
+  and capability reads reject with `CameraError('notReady')`; `stop`, `pause` and
+  `cleanup` are safe no-ops.
+- **VisionCamera captures can be cleaned up.** They were saved in VisionCamera's own
+  temporary directory, outside the store, so `cleanup()` refused them and the 24-hour
+  sweep never saw them. The controller now moves each package-temporary capture into
+  the store (`ArtifactStore.adopt`), and the sweep spares captures adopted by the
+  running process. With no store, or a bridge without `move()`, the logger reports
+  `unmanaged:no-store` / `unmanaged:store-cannot-adopt` once.
+- **No more "Camera is not active" error on every session start.** The feed sent
+  `torchMode="off"` on mount; VisionCamera applies it before the camera is active
+  and leaves the native rejection unhandled. The prop is now left unset until the
+  torch is first turned on.
+- **One throwing state listener no longer breaks a transition** or starves the other
+  listeners; it is logged as `listener-threw`.
+
+### Changed
+
+- **`effectiveQuality` and `effectiveMaxDimension` report what was applied.** The
+  VisionCamera adapter echoed the request hints. Quality is fixed on the photo output
+  (0.9) and nothing resizes, so it now reports `0.9` and an unavailable max dimension.
+- **Unmounting a preview over an idle controller leaves it `idle`**, rather than
+  driving it through `stopping` to `stopped` and calling the engine's `stop()`.
+
+### Added
+
+- `ArtifactStore.adopt?(uri)` and `FileSystemBridge.move?(from, to)`, both optional.
+  `createMemoryFileSystem()` implements `move`.
+
+### Docs
+
+- The README no longer claims quality and max-dimension hints are applied, or a
+  single active session per process.
+
+## 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-07-26
+
+Initial release. New package, no existing consumers, **no migration required**.
+
+### Added
+
+- **Permission handling** as a seven-state contract (`undetermined`, `requesting`, `granted`, `denied`, `deniedPermanently`, `unavailable`, `unsupported`). Reading status never prompts; requesting never re-prompts after a permanent denial; revocations made in system settings are pushed to subscribers without an app restart.
+- **`CameraPreview`** surface with `cover`/`contain` resize modes, an overlay slot via `children`, and pass-through of consumer accessibility properties. Ships no styled UI and takes no theme dependency.
+- **Still capture** returning a file reference plus metadata. Undeterminable fields (`fileSize`, `orientation`) are explicitly marked unavailable rather than guessed or omitted. Quality and max-dimension hints are normalized and reported back as effective values.
+- **Session lifecycle** — start, pause, resume, stop — that releases the camera on background, unmount, and stop, restarts on foreground when a surface is still mounted, and reports a single active session per controller.
+- **Artifact ownership and cleanup**: an optional `destination` on the capture request switches the result to app-owned and writes there directly; everything else lands in the package cache directory. `cleanup()` is idempotent and refuses anything the package does not own. Orphans are swept at initialization under a 24-hour time-to-live.
+- **Capability reporting** for camera positions, flash, torch, orientation, and camera-less devices, with capture-time flash modes and a continuous torch that is forced off on pause, stop, and background.
+- **Coordinate mapping** — pure, bidirectional, accounting for scale, letterbox or crop, orientation, and front-camera mirroring, accurate within 2 device-independent pixels on a round trip.
+- **Typed error taxonomy** of 11 codes, each carrying a `recoverable` flag, plus a `redact()` helper.
+- **Test adapter** (`createTestCamera`) implementing the same published ports as the production adapters, so consuming apps can drive every permission, capability, and capture path with no hardware and no permission prompts.
+- **Opt-in diagnostics logger**, defaulting to no logging.
+
+### Guarantees
+
+- No network egress of any kind.
+- No location read, no location permission requested.
+- Nothing written to the device photo library or gallery.
+- No capture history or index retained.
+- No on-device inference, no frame processor, no AI-derived labels.
+
+### Notes
+
+- `react-native-vision-camera` (>= 5.1.1) is a **peer dependency**; the consuming app installs and links it. This package authors no native source.
+- Android `minSdkVersion` remains **24** — VisionCamera 5.1.1 declares 23 and resolves the root project value first.
+- The local frame-processing extension point is documented in the README but deliberately not exported. It is designed to arrive as an additive minor release.