@mittwald/flow-react-components 0.2.0-alpha.981 → 0.2.0-alpha.982

package/AGENTS.md

@@ -149,9 +149,17 @@ Remote generation details:
   `pnpm nx build:remote-components components` and **commit** the results
   (view.ts, `src/views/*`, `remote-*/src/auto-generated/**`).
 - Props of these components are consumed by mStudio extension developers — no
-  breaking changes; deprecate instead. Why this matters:
+  breaking changes; deprecate instead (see
+  [Deprecating an API](#deprecating-an-api)). Why this matters:
   [docs/remote-ui.md](../../docs/remote-ui.md).
 
+## Deprecating an API
+
+Never break a shipped API — keep the old path working and warn at runtime with
+`useWarnDeprecation` (from `DeprecationWarningProvider`). This covers every kind
+of deprecated entry point: a prop, a whole component, a hook, or an integration
+export (`nextjs`, `password-tools`).
+
 ```tsx
 const warnDeprecation = useWarnDeprecation();
 if ("action" in props) {
@@ -159,6 +167,17 @@ if ("action" in props) {
 }
 ```
 
+- Warn a deprecated **prop** only when it is actually passed; warn a deprecated
+  **component** unconditionally at the top of its render.
+- `useWarnDeprecation` is a hook — it must run inside a render or another hook.
+  A class constructor works only when it is itself a `Model.useNew`-style
+  render-time hook (e.g. `List`), not when it is constructed conditionally (e.g.
+  `new ItemView(…)`); warn one level up in that case.
+- Messages are deduplicated per string; follow the shape
+  `The '<name>' <prop|component|function> is deprecated and will be removed in a future release. Use '<replacement>' instead.`
+- A type-only deprecation (e.g. a deprecated type alias) has no runtime path —
+  nothing to warn.
+
 ## Styling
 
 - One `<Name>.module.scss` per component. Scoped class names are generated from

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.2.0-alpha.982](https://github.com/mittwald/flow/compare/0.2.0-alpha.981...0.2.0-alpha.982) (2026-07-30)
+
+### Features
+
+* **components:** warn on all remaining deprecated APIs via useWarnDeprecation ([#2757](https://github.com/mittwald/flow/issues/2757)) ([8a945e6](https://github.com/mittwald/flow/commit/8a945e652cf919abe8a6b5577f5bda24a62cdcc9))
+
 # [0.2.0-alpha.981](https://github.com/mittwald/flow/compare/0.2.0-alpha.980...0.2.0-alpha.981) (2026-07-30)
 
 **Note:** Version bump only for package @mittwald/flow-react-components

package/PATTERNS.md

@@ -345,11 +345,13 @@ and consistency enforced by tooling, not maintained by hand.
   `@flr-generate` props.
   - ✓ generated props are serializable, least-privilege, backward-compatible.
   - ✗ host-only/non-serializable → ignore remotely or stay host-only.
-- **Deprecation warning hook (`useWarnDeprecation`)** — warn on legacy prop
-  usage, keep supporting it.
+- **Deprecation warning hook (`useWarnDeprecation`)** — warn on any deprecated
+  runtime path (prop, whole component, or hook/alias), keep supporting it.
   `src/components/CartesianChart/CartesianChart.tsx:59`
-  - ✓ a shipped remote prop/API must keep working while guiding to its
-    replacement.
+  - ✓ any shipped API (remote prop, non-remote component, integration export)
+    must keep working while guiding to its replacement.
+  - ✗ a deprecation with no runtime entry point (a type-only alias) — nothing to
+    warn; or a spot with no render/hook context (warn one level up instead).
   - ✗ unshipped/internal API → change directly.
 - **Controlled remote adapter** `[undocumented]` — shared hooks bridge
   serialized value/callbacks. `src/lib/remote/useControlledHostValueProps.ts:23`