@form-engine-ts/react 2.0.0 → 2.1.1

package/README.md

@@ -53,10 +53,19 @@ batch-translation action.
 
 ## Headless builder and renderer lifecycle
 
-`useFormBuilder({ schema, onChange, policy, idFactory })` exposes controlled field, option, page, and locale actions.
-`BuilderPolicy` can enforce allowed field types, 20-field/10-option style limits, text length, and required locales.
-Rejected add operations return typed errors without changing the schema. `<FormBuilder>` uses the same hook and accepts
-`policy` and `idFactory` props.
+`useFormBuilder({ schema, onChange, policy, idFactory, factories })` exposes controlled field, option, page, condition,
+source-text, and localized-text actions. Core's `FormPolicy` enforces allowed field types, field/option limits, text and
+schema-byte limits, and required locales identically in browser and server code. Every mutation returns a typed
+`BuilderActionResult`; invalid, empty, or duplicate generated IDs leave the schema unchanged. `BuilderFactories` injects
+initial field, option, and page shapes. `<FormBuilder>` delegates its UI mutations to this hook and accepts the same
+options. Its completion-message editors cover both source and locale text. `translationOptions` and
+`onTranslationReport` expose automatic-translation policy and reporting.
+
+Visual-builder field creation uses `defaultFieldType` when it is allowed, otherwise the first allowed policy type, then
+`text` when unrestricted. The add button is disabled when no type is allowed or `maxFields` is reached.
+`onActionError` receives typed failures from visual headless actions, and `createManualTranslationMetadata` can attach
+per-locale/property metadata to manual edits. Automatic translation defaults to `overwrite: "missing-only"`; explicitly
+pass `{ overwrite: "all" }` to replace existing translations.
 
 `FormRenderer` can also be used without an explicit provider:
 
@@ -69,14 +78,16 @@ Rejected add operations return typed errors without changing the schema. `<FormB
   onDraftSave={saveDraft}
   slots={{
     renderHeader: ({ title }) => <MyHeader>{title}</MyHeader>,
+    renderPageHeader: ({ page }) => <MyPageHeader page={page} />,
     renderField: (props) => <MyField {...props} />,
     renderSubmitButton: ({ isSubmitting, onSubmit }) => (
       <MyButton disabled={isSubmitting} onClick={onSubmit}>Save</MyButton>
-    )
+    ),
+    renderSubmitError: ({ error, onRetry }) => <MyError error={error} onRetry={onRetry} />
   }}
 />
 ```
 
 Validation runs before `beforeSubmit`. A `"cancel"` result does not call `onSubmit` and preserves values and drafts.
-Header, field, navigation, submit, validation-summary, and completion slots can replace the default UI. The localized
-`completionMessage` is displayed after a successful submission.
+Header, page-header, field, navigation, submit, validation-summary, completion, and submit-error slots can replace the
+default UI. The localized `completionMessage` is displayed after a successful submission.