@sonata-innovations/fiber-types 3.0.0 → 3.0.1
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 +2 -0
- package/CHANGELOG.md +8 -0
- package/README.md +4 -0
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -30,10 +30,12 @@ npx ajv-cli validate --spec=draft2020 \
|
|
|
30
30
|
- **Condition & validation types** — `FlowConditionConfig`, `ConditionRule`, `ConditionOperator` (19 operators), `FlowValidationConfig`, `ValidationRule` (17 validators)
|
|
31
31
|
- **Preset/template data** — `PresetData`, `TemplateData` (the serializable definitions FBT accepts)
|
|
32
32
|
- **Component manifest** — `COMPONENT_VARIANT_TYPES`, `ComponentType`, `ComponentOfType<K>`, `ComponentPropertiesByType`
|
|
33
|
+
- **Style families** — `FOCUSED_STYLES`, `styleFamily()`, `StyleFamily`. The four focused styles and the derivation from a `FlowStyleType` to `"form"` | `"focused"`
|
|
33
34
|
- **Utilities** — `generateUUID`, `regenerateComponentUUIDs`, `regenerateFlowUUIDs`, `normalizeConditionalOrder`, `getValidationConfig`, `getComponentDisplayLabel`
|
|
34
35
|
|
|
35
36
|
## Facts worth knowing before you generate a Flow
|
|
36
37
|
|
|
38
|
+
- **No `config.mode`.** Removed in 3.0.0. Presentation is `theme.style` (ten values, flat — four of them the `focused` family); behaviour is `navigation.autoAdvance` (default off) and `navigation.advanceOnEnter` (default on). Don't emit `mode`.
|
|
37
39
|
- **30 component types.** Display types (`header`, `text`, `divider`, `callout`, `table`) never appear in FlowData; `computed` does.
|
|
38
40
|
- **19 condition operators, 17 validators.** Exact lists are in the quick reference.
|
|
39
41
|
- **Validation `pattern` rules take `params.regex`**, not `params.pattern`. A `pattern` key is ignored and the rule silently always passes.
|
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,14 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to the Fiber schema types. Dates are release dates.
|
|
4
4
|
|
|
5
|
+
## 3.0.1 — 2026-08-20
|
|
6
|
+
|
|
7
|
+
### Fixed
|
|
8
|
+
|
|
9
|
+
- **`README.md` and `AGENTS.md` did not list the exports 3.0.0 added.** Both files enumerate the package's public surface, and neither mentioned `FOCUSED_STYLES`, `styleFamily()` or the `StyleFamily` type — nor that `FlowConfiguration.mode` and `FlowModeType` had been removed. A consumer reading the README of the version they installed would have seen an API that no longer matched the package. Both now cover the flat style vocabulary, the focused family, and the removal.
|
|
10
|
+
|
|
11
|
+
Documentation only; no code, type or schema change. `docs/features/style-families.md` shipped correct in 3.0.0 and is unchanged.
|
|
12
|
+
|
|
5
13
|
## 3.0.0 — 2026-08-20
|
|
6
14
|
|
|
7
15
|
### Removed — BREAKING
|
package/README.md
CHANGED
|
@@ -53,6 +53,7 @@ import type {
|
|
|
53
53
|
FlowValidationConfig, ValidationRule,
|
|
54
54
|
PresetData, TemplateData,
|
|
55
55
|
ComponentType, ComponentOfType, ComponentPropertiesByType,
|
|
56
|
+
FlowStyleType, StyleFamily,
|
|
56
57
|
} from "@sonata-innovations/fiber-types";
|
|
57
58
|
|
|
58
59
|
import {
|
|
@@ -63,6 +64,8 @@ import {
|
|
|
63
64
|
getValidationConfig,
|
|
64
65
|
getComponentDisplayLabel,
|
|
65
66
|
COMPONENT_VARIANT_TYPES,
|
|
67
|
+
FOCUSED_STYLES,
|
|
68
|
+
styleFamily,
|
|
66
69
|
} from "@sonata-innovations/fiber-types";
|
|
67
70
|
```
|
|
68
71
|
|
|
@@ -82,6 +85,7 @@ if (component.type === "inputText") {
|
|
|
82
85
|
|
|
83
86
|
## Gotchas
|
|
84
87
|
|
|
88
|
+
- **`theme.style` carries the presentation; there is no `config.mode`.** `FlowStyleType` is a flat vocabulary of ten. Four of them — `centered-minimal`, `stacked-cards`, `soft-float`, `bold-statement` — form the **focused** family, which adds a centered narrow column, animated entry and larger targets; the other six are the **form** family. `styleFamily(style)` and `FOCUSED_STYLES` expose that partition so a builder groups its style picker from one list instead of copying a constant. The family is derived and never appears in Flow JSON. `FlowConfiguration.mode` and `FlowModeType` were removed in 3.0.0 — see `docs/features/style-families.md`.
|
|
85
89
|
- **`ThemeConfig.fontFamily` is `string | FontFamilyConfig`.** A plain string is a CSS stack and means "the host page already loads this font"; `{ family, src }` carries the sources a renderer registers itself. Code that reads the knob as a `string` has to narrow — `isFontFamilyConfig` / `fontFamilyStack` are exported from `@sonata-innovations/fiber-fbre` for that.
|
|
86
90
|
- **30 component types.** Display types (`header`, `text`, `divider`, `callout`, `table`) never appear in FlowData; `computed` does.
|
|
87
91
|
- **`pattern` validation rules take `params.regex`**, not `params.pattern`. A `pattern` key is silently ignored and the rule always passes.
|