@mittwald/flow-react-components 1.6.0-next.0 → 1.6.0-next.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +8 -5
- package/dist/assets/component-index.json +1 -1
- package/dist/assets/doc-properties.json +1 -1
- package/package.json +10 -10
package/AGENTS.md
CHANGED
|
@@ -217,16 +217,19 @@ Remote generation details:
|
|
|
217
217
|
`pnpm nx build:remote-components components` and **commit** the results
|
|
218
218
|
(view.ts, `src/views/*`, `remote-*/src/auto-generated/**`).
|
|
219
219
|
- Props of these components are consumed by mStudio extension developers — no
|
|
220
|
-
breaking changes; deprecate instead (see
|
|
220
|
+
breaking changes on a `stable` component; deprecate instead (see
|
|
221
221
|
[Deprecating an API](#deprecating-an-api)). Why this matters:
|
|
222
222
|
[docs/remote-ui.md](https://github.com/mittwald/flow/blob/main/docs/remote-ui.md).
|
|
223
223
|
|
|
224
224
|
## Deprecating an API
|
|
225
225
|
|
|
226
|
-
Never break a shipped API
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
226
|
+
Never break a shipped API of a `stable` component — a `beta` one is exempt (see
|
|
227
|
+
the root
|
|
228
|
+
[Hard rules](https://github.com/mittwald/flow/blob/main/AGENTS.md#hard-rules)).
|
|
229
|
+
Keep the old path working and warn at runtime with `useWarnDeprecation` (from
|
|
230
|
+
`DeprecationWarningProvider`). This covers every kind of deprecated entry point:
|
|
231
|
+
a prop, a whole component, a hook, or an integration export (`nextjs`,
|
|
232
|
+
`mittwald-password-tools-js`).
|
|
230
233
|
|
|
231
234
|
```tsx
|
|
232
235
|
const warnDeprecation = useWarnDeprecation();
|