@cosmicdrift/kumiko-renderer 0.379.0 → 0.381.0

package/dist/app/extension-sections.d.ts

@@ -44,6 +44,10 @@ export type ExtensionSectionProps = {
      *  `snapshot.errors` on the field instead of a collective message.
      *  Undefined outside entityEdit sections. */
     readonly validate?: () => boolean;
+    /** Marks the current host form values as saved after the section wrote
+     *  them itself, so a following navigation does not ask to discard.
+     *  Undefined outside entityEdit sections and the entityEdit footer slot. */
+    readonly markSaved?: () => void;
     /** Whether the host form has unsaved changes. Only set in the entityEdit
      *  footer slot (`screen.slots.footer`); undefined in all other mounts. */
     readonly hasUnsavedChanges?: boolean;

package/dist/components/render-edit.js

@@ -165,7 +165,7 @@ function isFieldsStepFilled(section, parse) {
 // mounts it with the host entity name + id. Hook lives in its own
 // component so we don't call `use*` inside vm.sections.map (rules-of-
 // hooks would punish reordering sections between renders).
-function ExtensionSectionMount({ section, entityName: hostEntityName, entityId, initialValues, values, patch, validate, hideTitle, actions, stepKey, onReportStepComplete, }) {
+function ExtensionSectionMount({ section, entityName: hostEntityName, entityId, initialValues, values, patch, validate, markSaved, hideTitle, actions, stepKey, onReportStepComplete, }) {
     const { Banner, FillContainer, Section, Text } = usePrimitives();
     const name = extensionSectionName(section.component);
     const Component = useExtensionSectionComponent(name);
@@ -184,7 +184,7 @@ function ExtensionSectionMount({ section, entityName: hostEntityName, entityId,
         // uses for its own hideTitle branch).
         return hideTitle === true ? (FillContainer !== undefined ? (_jsx(FillContainer, { testId: testId, children: placeholder })) : (placeholder)) : (_jsx(Section, { title: section.title, testId: testId, children: placeholder }, section.title));
     }
-    const mounted = (_jsx(Component, { entityName: section.entityName ?? hostEntityName, entityId: entityId, initialValues: initialValues, values: values, patch: patch, validate: validate, ...(onReportStepComplete !== undefined && { reportStepComplete }) }));
+    const mounted = (_jsx(Component, { entityName: section.entityName ?? hostEntityName, entityId: entityId, initialValues: initialValues, values: values, patch: patch, validate: validate, markSaved: markSaved, ...(onReportStepComplete !== undefined && { reportStepComplete }) }));
     // Same reasoning as the placeholder branch above: tabs mode's outer Card
     // is the only frame this content gets, no nested Section divider.
     return hideTitle === true ? (FillContainer !== undefined ? (_jsx(FillContainer, { testId: testId, children: mounted })) : (mounted)) : (_jsx(Section, { ...(actions !== undefined && { actions }), title: section.title, testId: testId, children: mounted }));
@@ -195,7 +195,7 @@ function ExtensionSectionMount({ section, entityName: hostEntityName, entityId,
 // component for both slots — header passes no hasUnsavedChanges/wizardStep,
 // footer does. Own component for rules-of-hooks (useExtensionSectionComponent
 // must not run conditionally inside RenderEdit's render body).
-function EditSlotMount({ slot, slotName, screenId, entityName, entityId, values, hasUnsavedChanges, wizardStep, }) {
+function EditSlotMount({ slot, slotName, screenId, entityName, entityId, values, markSaved, hasUnsavedChanges, wizardStep, }) {
     const name = extensionSectionName(slot);
     const Component = useExtensionSectionComponent(name);
     useEffect(() => {
@@ -206,7 +206,7 @@ function EditSlotMount({ slot, slotName, screenId, entityName, entityId, values,
     }, [name, Component, screenId, slotName]);
     if (Component === undefined)
         return null;
-    return (_jsx(Component, { entityName: entityName, entityId: entityId, values: values, ...(hasUnsavedChanges !== undefined && { hasUnsavedChanges }), ...(wizardStep !== undefined && { wizardStep }) }));
+    return (_jsx(Component, { entityName: entityName, entityId: entityId, values: values, ...(markSaved !== undefined && { markSaved }), ...(hasUnsavedChanges !== undefined && { hasUnsavedChanges }), ...(wizardStep !== undefined && { wizardStep }) }));
 }
 function formSectionDomId(sectionIndex) {
     return `form-section-${sectionIndex}`;
@@ -442,6 +442,11 @@ export function RenderEdit(props) {
     const scopeFieldNamesRef = useRef(scopeFieldNames);
     scopeFieldNamesRef.current = scopeFieldNames;
     const scopedValidate = useCallback(() => controller.validate(scopeFieldNamesRef.current), [controller]);
+    const markSaved = useCallback(() => {
+        controller.rebase();
+        extensionDirtyRef.current = false;
+        setExtensionDirty(false);
+    }, [controller]);
     // `saveDraft` (defined below) is a fresh closure every render, over that
     // render's `draftKey`/`draftId` — the ref lets the debounce timer below
     // always call the CURRENT one even though the timer was scheduled by an
@@ -1226,7 +1231,7 @@ export function RenderEdit(props) {
                 ? 1
                 : 0;
     const isSettingsList = screen.layout.variant === "settings-list" && hideSectionTitles !== true;
-    const formActions = (_jsxs(_Fragment, { children: [showWizardBack && (_jsx(Button, { type: "button", variant: "secondary", icon: "chevron-left", onClick: handleWizardBack, testId: "render-edit-wizard-back", [FOOTER_ACTION_ROLE_PROP]: "back", children: translate("kumiko.actions.back") })), footerSlot !== undefined && (_jsx(EditSlotMount, { slot: footerSlot, slotName: "footer", screenId: screen.id, entityName: vm.entityName, entityId: resolveExtensionEntityId(entityIdProp, vm.id), values: snapshot.values, hasUnsavedChanges: hasUnsavedInput, wizardStep: isWizard ? { index: currentStep, isLast: isLastWizardStep } : undefined, ...(screen.slots?.footerPrimary === true && { [STICKY_PRIMARY_ACTION_PROP]: true }) })), isWizard && !isLastWizardStep && showsSubmit && !isCreateMode && (_jsx(Button, { type: "button", variant: "ghost", disabled: isSubmitting || disabled, onClick: () => void handleSubmit({ saveNow: true }), testId: "render-edit-wizard-save-close", [STICKY_PRIMARY_ACTION_PROP]: true, children: translate("kumiko.wizard.save-and-close") })), showWizardNext && (_jsx(Button, { type: "submit", variant: "primary", iconEnd: "chevron-right", testId: "render-edit-wizard-next", [FOOTER_ACTION_ROLE_PROP]: "primary",
+    const formActions = (_jsxs(_Fragment, { children: [showWizardBack && (_jsx(Button, { type: "button", variant: "secondary", icon: "chevron-left", onClick: handleWizardBack, testId: "render-edit-wizard-back", [FOOTER_ACTION_ROLE_PROP]: "back", children: translate("kumiko.actions.back") })), footerSlot !== undefined && (_jsx(EditSlotMount, { slot: footerSlot, slotName: "footer", screenId: screen.id, entityName: vm.entityName, entityId: resolveExtensionEntityId(entityIdProp, vm.id), values: snapshot.values, markSaved: markSaved, hasUnsavedChanges: hasUnsavedInput, wizardStep: isWizard ? { index: currentStep, isLast: isLastWizardStep } : undefined, ...(screen.slots?.footerPrimary === true && { [STICKY_PRIMARY_ACTION_PROP]: true }) })), isWizard && !isLastWizardStep && showsSubmit && !isCreateMode && (_jsx(Button, { type: "button", variant: "ghost", disabled: isSubmitting || disabled, onClick: () => void handleSubmit({ saveNow: true }), testId: "render-edit-wizard-save-close", [STICKY_PRIMARY_ACTION_PROP]: true, children: translate("kumiko.wizard.save-and-close") })), showWizardNext && (_jsx(Button, { type: "submit", variant: "primary", iconEnd: "chevron-right", testId: "render-edit-wizard-next", [FOOTER_ACTION_ROLE_PROP]: "primary",
                 [NARROW_LABEL_PROP]: translate("kumiko.actions.next"), children: nextStepTitle !== undefined
                     ? translate("kumiko.wizard.next-with-title", { title: nextStepTitle })
                     : translate("kumiko.actions.next") })), showSubmit &&
@@ -1403,7 +1408,7 @@ export function RenderEdit(props) {
                                 const mount = (_jsx(ExtensionSectionMount, { section: section, entityName: vm.entityName, entityId: resolveExtensionEntityId(entityIdProp, vm.id), initialValues: extensionInitialValues, values: snapshot.values, 
                                     // @cast-boundary form-values: ExtensionSectionProps is not generic
                                     // over TValues; controller is mount-lifetime-stable, see onControlsReady above.
-                                    patch: patchAndScheduleDraftSave, validate: scopedValidate, hideTitle: hideSectionTitles, ...(isWizard &&
+                                    patch: patchAndScheduleDraftSave, validate: scopedValidate, markSaved: markSaved, hideTitle: hideSectionTitles, ...(isWizard &&
                                         !isCreateMode && {
                                         stepKey: wizardStepKey(section, sectionIndex),
                                         onReportStepComplete: reportExtensionStepComplete,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-renderer",
-  "version": "0.379.0",
+  "version": "0.381.0",
   "description": "React renderer for Kumiko screens. The root export holds the platform-agnostic logic (primitives contract, hooks, KumikoScreen, navigation and SSE abstractions); ./headless the DOM-free UI logic, ./live the HTTP dispatcher, ./web the browser bindings (HTML primitives, history navigation, EventSource live events, createKumikoApp).",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",
@@ -48,8 +48,8 @@
     }
   },
   "dependencies": {
-    "@cosmicdrift/kumiko-framework": "0.379.0",
-    "@cosmicdrift/kumiko-types": "0.379.0",
+    "@cosmicdrift/kumiko-framework": "0.381.0",
+    "@cosmicdrift/kumiko-types": "0.381.0",
     "@radix-ui/react-dialog": "^1.1.15",
     "@radix-ui/react-dropdown-menu": "^2.1.16",
     "@radix-ui/react-label": "^2.1.8",
@@ -92,8 +92,8 @@
     }
   },
   "devDependencies": {
-    "@cosmicdrift/kumiko-locale-de": "0.379.0",
-    "@cosmicdrift/kumiko-testing": "0.379.0",
+    "@cosmicdrift/kumiko-locale-de": "0.381.0",
+    "@cosmicdrift/kumiko-testing": "0.381.0",
     "@tailwindcss/cli": "^4.3.0",
     "@testing-library/react": "^16.3.2",
     "@testing-library/user-event": "^14.6.1",

package/src/changes.json

@@ -1,4 +1,11 @@
 [
+  {
+    "version": "0.381.0",
+    "type": "improvement",
+    "title": "ExtensionSectionProps.markSaved marks host form values as saved",
+    "detail": "ExtensionSectionProps gains an optional markSaved callback, set in entityEdit sections and the entityEdit footer slot. An extension section that writes the host entity's values through its own command calls it after the write succeeds; the host form then counts as clean and a following navigation passes the leave guard without the discard dialog. Additive API.",
+    "migration": "None. Additive API."
+  },
   {
     "version": "0.379.0",
     "type": "fix",