@mittwald/flow-react-components 1.2.0-next.1 → 1.2.0-next.2

package/MIGRATION.md

@@ -774,9 +774,41 @@ prop. At runtime the old prop still works: `Action` maps it to `onAction` and
 logs a deprecation warning, and an explicit `onAction` wins. The fallback will
 be removed in a future major version.
 
-A codemod renames the prop on `Action`.
+#### The type changed too
 
-**Apply:** Rename the `action` prop on `Action` to `onAction`.
+`onAction` is typed `ActionFn`, which is `(...args: unknown[]) => unknown`. A
+function that declares a parameter of any narrower type is not assignable to it,
+because the parameter would receive `unknown`:
+
+```
+Type '(options?: CloseOptions | undefined) => void' is not assignable to type 'ActionFn'.
+  Types of parameters 'options' and 'args' are incompatible.
+    Type 'unknown' is not assignable to type 'CloseOptions | undefined'.
+```
+
+Wrap the call instead of passing the reference:
+
+```diff
+- <Action onAction={controller.close}>
++ <Action onAction={() => controller.close()}>
+```
+
+Only function **references** are affected. An inline arrow
+(`onAction={() => …}`), a zero-parameter function, and anything already
+accepting `unknown` are all fine.
+
+A codemod renames the prop. It deliberately does not wrap: whether the
+referenced function declares a parameter cannot be decided from the source —
+that needs type information — and wrapping everything would silently drop the
+arguments `Action` passes to handlers that do accept them.
+
+**Apply:** Rename the `action` prop on `Action` to `onAction`. Not only a
+rename: the new prop is typed `ActionFn` (`(...args: unknown[]) => unknown`), so
+a function _reference_ that declares a parameter no longer type-checks and needs
+wrapping — `onAction={() => controller.close()}` rather than
+`onAction={controller.close}`. Check every site where you passed a reference
+rather than an inline arrow; the codemod renames the prop but cannot decide this
+one from the source.
 
 ```shell
 npx @mittwald/flow-codemods@latest action-prop-to-on-action src