@yuneta/gobj-ui 7.26.38 → 7.26.39

package/README.md

@@ -3394,6 +3394,26 @@ the middle, and **a toolbar left with a single group is centred**. An unknown
 name is reported, not silently dropped: a typo would otherwise remove the save
 button with no trace of why.
 
+### `C_YUI_FORM` — what closing it asks about
+
+`changes` says the form is not what is stored: the reader changed it, or the
+record lacks a field that has a default, and the form shows the default. The
+save lights with it. **`edited`** (7.26.39+) says the READER changed it --
+typed, cleared, pasted -- since it was loaded, saved or undone, and it is the
+only thing a close asks about: the form answers `EV_WINDOW_TO_CLOSE` with
+`abort_close` and the warning *"all changes will be lost"* when `edited` is
+true. A record that lacks a defaulted field opens changed and closes without
+a question; until 7.26.39 it asked on every close, about nothing the reader
+would lose.
+
+```js
+const kw = {abort_close: false};
+gobj_send_event(form, "EV_WINDOW_TO_CLOSE", kw, gobj);
+if(kw.abort_close) {
+    // the reader changed it: ask kw.warning before closing
+}
+```
+
 ### `C_YUI_FORM` — which field is editable, and the one `writable` does not govern
 
 A form opened to LOOK at a record has no editable field: that is a property of

package/dist/gobj-ui.cjs.js

@@ -9483,6 +9483,7 @@ var attrs_table$17 = [
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_STRING, "form_id", 0, "", "Form identifier"),
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_BOOLEAN, "initialized", 0, false, "Indicates if it is initialized"),
 	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_BOOLEAN, "changes", 0, false, "Indicates if changes have been made"),
+	(0, _yuneta_gobj_js.SDATA)(_yuneta_gobj_js.data_type_t.DTP_BOOLEAN, "edited", 0, false, "The reader changed the form (typed, cleared, pasted) since it was loaded, saved or undone: what closing it would lose. A field the record lacks, filled with its default, is a change of the form (`changes`) and not of the reader"),
 	(0, _yuneta_gobj_js.SDATA_END)()
 ];
 var PRIVATE_DATA$17 = {
@@ -9576,6 +9577,7 @@ function set_changed_stated(gobj, changed) {
 		});
 	} else {
 		(0, _yuneta_gobj_js.gobj_write_bool_attr)(gobj, "changes", false);
+		(0, _yuneta_gobj_js.gobj_write_bool_attr)(gobj, "edited", false);
 		enable($button_save, false, OFF_COLOR);
 		enable($button_undo, false, OFF_COLOR);
 		if (gobj.priv.rearm_timer) clearTimeout(gobj.priv.rearm_timer);
@@ -9599,6 +9601,16 @@ function set_changed_stated(gobj, changed) {
 	}
 }
 /************************************************************
+*  A change the READER made -- typed, cleared, pasted: what
+*  closing the form would lose (ac_window_to_close). Clearing
+*  and pasting wrote their values and marked nothing, so a form
+*  cleared or pasted into kept its save off.
+************************************************************/
+function set_edited_by_reader(gobj) {
+	set_changed_stated(gobj, true);
+	(0, _yuneta_gobj_js.gobj_write_bool_attr)(gobj, "edited", true);
+}
+/************************************************************
 *
 ************************************************************/
 async function readClipboard$1(gobj) {
@@ -11980,10 +11992,16 @@ function form_value_2_treedb_value(gobj, field_desc, value) {
 *      Actions
 ***************************/
 /************************************************************
-*  From Window parent, is going to close
+*  From Window parent, is going to close.
+*
+*  It asks only for what the READER changed (`edited`). A record
+*  that lacks a field opens CHANGED -- the default fills it, and
+*  the save lights to store it -- but the reader did nothing, and
+*  the question asked of every such record, on every close, was
+*  about nothing they would lose.
 ************************************************************/
 function ac_window_to_close(gobj, event, kw, src) {
-	if ((0, _yuneta_gobj_js.gobj_read_bool_attr)(gobj, "changes")) {
+	if ((0, _yuneta_gobj_js.gobj_read_bool_attr)(gobj, "edited")) {
 		kw.abort_close = true;
 		kw.warning = "all changes will be lost";
 	}
@@ -11999,6 +12017,7 @@ function ac_load_record(gobj, event, kw, src) {
 	let modified = set_form_values(gobj, (0, _yuneta_gobj_js.gobj_read_attr)(gobj, "template"), $form, kw);
 	apply_form_mode(gobj, $form);
 	set_changed_stated(gobj, modified);
+	(0, _yuneta_gobj_js.gobj_write_bool_attr)(gobj, "edited", false);
 	(0, _yuneta_gobj_js.gobj_write_bool_attr)(gobj, "initialized", true);
 	return 0;
 }
@@ -12042,6 +12061,7 @@ function ac_clear_record(gobj, event, kw, src) {
 	let $form = (0, _yuneta_gobj_js.gobj_read_attr)(gobj, "$container").querySelector("form");
 	clear_validation(gobj, $form);
 	clear_data(gobj, $form);
+	set_edited_by_reader(gobj);
 	return 0;
 }
 /************************************************************
@@ -12120,7 +12140,7 @@ function ac_add_table_row(gobj, event, kw, src) {
 *  Internal event
 ************************************************************/
 function ac_record_changed(gobj, event, kw, src) {
-	if ((0, _yuneta_gobj_js.gobj_read_bool_attr)(gobj, "initialized")) set_changed_stated(gobj, true);
+	if ((0, _yuneta_gobj_js.gobj_read_bool_attr)(gobj, "initialized")) set_edited_by_reader(gobj);
 	return 0;
 }
 /************************************************************
@@ -12143,6 +12163,7 @@ function ac_paste_record(gobj, event, kw, src) {
 	if ((0, _yuneta_gobj_js.is_object)(record)) {
 		(0, _yuneta_gobj_js.gobj_write_bool_attr)(gobj, "initialized", true);
 		set_form_values(gobj, (0, _yuneta_gobj_js.gobj_read_attr)(gobj, "template"), $form, record);
+		set_edited_by_reader(gobj);
 	}
 	return 0;
 }

package/dist/gobj-ui.es.js

@@ -9478,6 +9478,7 @@ var attrs_table$17 = [
 	SDATA(data_type_t.DTP_STRING, "form_id", 0, "", "Form identifier"),
 	SDATA(data_type_t.DTP_BOOLEAN, "initialized", 0, false, "Indicates if it is initialized"),
 	SDATA(data_type_t.DTP_BOOLEAN, "changes", 0, false, "Indicates if changes have been made"),
+	SDATA(data_type_t.DTP_BOOLEAN, "edited", 0, false, "The reader changed the form (typed, cleared, pasted) since it was loaded, saved or undone: what closing it would lose. A field the record lacks, filled with its default, is a change of the form (`changes`) and not of the reader"),
 	SDATA_END()
 ];
 var PRIVATE_DATA$17 = {
@@ -9571,6 +9572,7 @@ function set_changed_stated(gobj, changed) {
 		});
 	} else {
 		gobj_write_bool_attr(gobj, "changes", false);
+		gobj_write_bool_attr(gobj, "edited", false);
 		enable($button_save, false, OFF_COLOR);
 		enable($button_undo, false, OFF_COLOR);
 		if (gobj.priv.rearm_timer) clearTimeout(gobj.priv.rearm_timer);
@@ -9594,6 +9596,16 @@ function set_changed_stated(gobj, changed) {
 	}
 }
 /************************************************************
+*  A change the READER made -- typed, cleared, pasted: what
+*  closing the form would lose (ac_window_to_close). Clearing
+*  and pasting wrote their values and marked nothing, so a form
+*  cleared or pasted into kept its save off.
+************************************************************/
+function set_edited_by_reader(gobj) {
+	set_changed_stated(gobj, true);
+	gobj_write_bool_attr(gobj, "edited", true);
+}
+/************************************************************
 *
 ************************************************************/
 async function readClipboard$1(gobj) {
@@ -11975,10 +11987,16 @@ function form_value_2_treedb_value(gobj, field_desc, value) {
 *      Actions
 ***************************/
 /************************************************************
-*  From Window parent, is going to close
+*  From Window parent, is going to close.
+*
+*  It asks only for what the READER changed (`edited`). A record
+*  that lacks a field opens CHANGED -- the default fills it, and
+*  the save lights to store it -- but the reader did nothing, and
+*  the question asked of every such record, on every close, was
+*  about nothing they would lose.
 ************************************************************/
 function ac_window_to_close(gobj, event, kw, src) {
-	if (gobj_read_bool_attr(gobj, "changes")) {
+	if (gobj_read_bool_attr(gobj, "edited")) {
 		kw.abort_close = true;
 		kw.warning = "all changes will be lost";
 	}
@@ -11994,6 +12012,7 @@ function ac_load_record(gobj, event, kw, src) {
 	let modified = set_form_values(gobj, gobj_read_attr(gobj, "template"), $form, kw);
 	apply_form_mode(gobj, $form);
 	set_changed_stated(gobj, modified);
+	gobj_write_bool_attr(gobj, "edited", false);
 	gobj_write_bool_attr(gobj, "initialized", true);
 	return 0;
 }
@@ -12037,6 +12056,7 @@ function ac_clear_record(gobj, event, kw, src) {
 	let $form = gobj_read_attr(gobj, "$container").querySelector("form");
 	clear_validation(gobj, $form);
 	clear_data(gobj, $form);
+	set_edited_by_reader(gobj);
 	return 0;
 }
 /************************************************************
@@ -12115,7 +12135,7 @@ function ac_add_table_row(gobj, event, kw, src) {
 *  Internal event
 ************************************************************/
 function ac_record_changed(gobj, event, kw, src) {
-	if (gobj_read_bool_attr(gobj, "initialized")) set_changed_stated(gobj, true);
+	if (gobj_read_bool_attr(gobj, "initialized")) set_edited_by_reader(gobj);
 	return 0;
 }
 /************************************************************
@@ -12138,6 +12158,7 @@ function ac_paste_record(gobj, event, kw, src) {
 	if (is_object(record)) {
 		gobj_write_bool_attr(gobj, "initialized", true);
 		set_form_values(gobj, gobj_read_attr(gobj, "template"), $form, record);
+		set_edited_by_reader(gobj);
 	}
 	return 0;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@yuneta/gobj-ui",
-  "version": "7.26.38",
+  "version": "7.26.39",
   "type": "module",
   "main": "dist/gobj-ui.cjs.js",
   "module": "dist/gobj-ui.es.js",

package/src/c_yui_form.js

@@ -167,6 +167,7 @@ SDATA(data_type_t.DTP_POINTER,  "$container",       0,  null,   "Container eleme
 SDATA(data_type_t.DTP_STRING,   "form_id",          0,  "",     "Form identifier"),
 SDATA(data_type_t.DTP_BOOLEAN,  "initialized",      0,  false,  "Indicates if it is initialized"),
 SDATA(data_type_t.DTP_BOOLEAN,  "changes",          0,  false,  "Indicates if changes have been made"),
+SDATA(data_type_t.DTP_BOOLEAN,  "edited",           0,  false,  "The reader changed the form (typed, cleared, pasted) since it was loaded, saved or undone: what closing it would lose. A field the record lacks, filled with its default, is a change of the form (`changes`) and not of the reader"),
 SDATA_END()
 ];
 
@@ -349,6 +350,7 @@ function set_changed_stated(gobj, changed)
          *  Data not changed, disable buttons to save/undo
          */
         gobj_write_bool_attr(gobj, "changes", false);
+        gobj_write_bool_attr(gobj, "edited", false);
 
         enable($button_save, false, OFF_COLOR);
         enable($button_undo, false, OFF_COLOR);
@@ -390,6 +392,18 @@ function set_changed_stated(gobj, changed)
     }
 }
 
+/************************************************************
+ *  A change the READER made -- typed, cleared, pasted: what
+ *  closing the form would lose (ac_window_to_close). Clearing
+ *  and pasting wrote their values and marked nothing, so a form
+ *  cleared or pasted into kept its save off.
+ ************************************************************/
+function set_edited_by_reader(gobj)
+{
+    set_changed_stated(gobj, true);
+    gobj_write_bool_attr(gobj, "edited", true);
+}
+
 /************************************************************
  *
  ************************************************************/
@@ -3606,11 +3620,17 @@ function form_value_2_treedb_value(gobj, field_desc, value)
 
 
 /************************************************************
- *  From Window parent, is going to close
+ *  From Window parent, is going to close.
+ *
+ *  It asks only for what the READER changed (`edited`). A record
+ *  that lacks a field opens CHANGED -- the default fills it, and
+ *  the save lights to store it -- but the reader did nothing, and
+ *  the question asked of every such record, on every close, was
+ *  about nothing they would lose.
  ************************************************************/
 function ac_window_to_close(gobj, event, kw, src)
 {
-    if(gobj_read_bool_attr(gobj, "changes")) {
+    if(gobj_read_bool_attr(gobj, "edited")) {
         kw.abort_close = true; // Don't close the window until fields repaired
         /*  An i18n KEY, not a sentence: the dialog renders its message with
          *  `i18n: message`. The English sentence that was here was a key
@@ -3634,6 +3654,7 @@ function ac_load_record(gobj, event, kw, src)
     let modified = set_form_values(gobj, gobj_read_attr(gobj, "template"), $form, kw);
     apply_form_mode(gobj, $form);
     set_changed_stated(gobj, modified);
+    gobj_write_bool_attr(gobj, "edited", false);
     gobj_write_bool_attr(gobj, "initialized", true);
 
     return 0;
@@ -3707,6 +3728,7 @@ function ac_clear_record(gobj, event, kw, src)
     let $form = $container.querySelector('form');
     clear_validation(gobj, $form);
     clear_data(gobj, $form);
+    set_edited_by_reader(gobj);
     return 0;
 }
 
@@ -3820,7 +3842,7 @@ function ac_add_table_row(gobj, event, kw, src)
 function ac_record_changed(gobj, event, kw, src)
 {
     if(gobj_read_bool_attr(gobj, "initialized")) {
-        set_changed_stated(gobj, true);
+        set_edited_by_reader(gobj);
     }
     return 0;
 }
@@ -3854,6 +3876,7 @@ function ac_paste_record(gobj, event, kw, src)
     if(is_object(record)) {
         gobj_write_bool_attr(gobj, "initialized", true);
         set_form_values(gobj, gobj_read_attr(gobj, "template"), $form, record);
+        set_edited_by_reader(gobj);
     }
     return 0;
 }

package/src/form_close_asks_for_edits.wiring.test.js

@@ -0,0 +1,197 @@
+/***********************************************************************
+ *          form_close_asks_for_edits.wiring.test.js
+ *
+ *      Closing a C_YUI_FORM asks "all changes will be lost" only for what
+ *      the READER changed. A field the record lacks is filled with its
+ *      default when the record is loaded: the form then differs from what
+ *      is stored, and its save lights (`changes`) -- but the reader did
+ *      nothing, and the close asked all the same. In estadodelaire that
+ *      was every device whose alarm colours a save had wiped (16 of 19),
+ *      on every close of its settings. What the reader does -- types,
+ *      clears, pastes -- is `edited`, and that is what the close asks
+ *      about.
+ *
+ *          Copyright (c) 2026, ArtGins.
+ *          All Rights Reserved.
+ ***********************************************************************/
+import {describe, test, expect, beforeAll, beforeEach} from "vitest";
+import {install_dom_double} from "../test/dom_double.js";
+
+install_dom_double();
+
+if(typeof globalThis.ResizeObserver === "undefined") {
+    globalThis.ResizeObserver = class {
+        observe() {}
+        unobserve() {}
+        disconnect() {}
+    };
+}
+
+const {
+    SDATA_END, gclass_create,
+    gobj_start_up, gobj_create_yuno, gobj_create_pure_child,
+    gobj_start, gobj_send_event, gobj_read_attr,
+    set_log_callback,
+} = await import("@yuneta/gobj-js");
+const {register_c_yui_form} = await import("./c_yui_form.js");
+
+const logged = [];
+let yuno = null;
+
+/*  The settings template of an estadodelaire device type, cut down: a
+ *  field with a default beside a sub-form of three.  */
+const TEMPLATE = {
+    template_version: {
+        type: "integer",
+        default: 7,
+        flag: ["hidden", "persistent"]
+    },
+    alarm_colors: {
+        type: "object",
+        flag: ["writable", "persistent", "template"],
+        template: {
+            active_not_validated: {
+                type: "string",
+                default: "red",
+                flag: ["writable", "persistent", "color"]
+            },
+            active_validated: {
+                type: "string",
+                default: "#e5a50a",
+                flag: ["writable", "persistent", "color"]
+            },
+            not_active_not_validated: {
+                type: "string",
+                default: "Fuchsia",
+                flag: ["writable", "persistent", "color"]
+            }
+        }
+    }
+};
+
+const COMPLETE = {
+    template_version: 7,
+    alarm_colors: {
+        active_not_validated: "#ff0000",
+        active_validated: "#e5a50a",
+        not_active_not_validated: "#ff00ff"
+    }
+};
+
+beforeAll(async () => {
+    const i18next = (await import("i18next")).default;
+    await i18next.init({lng: "en", resources: {}});
+    gobj_start_up(null, null, null, null, null, null, null);
+    set_log_callback((level, msg) => {
+        logged.push({level: String(level), msg: String(msg)});
+    });
+    gclass_create("C_TEST_CLOSE_HOST", [], [["ST_IDLE", []]], {}, 0, [SDATA_END()], {}, 0, 0, 0, 0);
+    gclass_create(
+        "C_TEST_CLOSE_APP",
+        [["EV_SAVE_RECORD", 0]],
+        [["ST_IDLE", [
+            ["EV_SAVE_RECORD", () => 0, null],
+        ]]],
+        {}, 0, [SDATA_END()], {}, 0, 0, 0, 0
+    );
+    register_c_yui_form();
+    yuno = gobj_create_yuno("form_close_yuno", "C_TEST_CLOSE_HOST", {});
+    gobj_start(yuno);
+});
+
+beforeEach(() => {
+    logged.length = 0;
+});
+
+let seq = 0;
+
+function build(record)
+{
+    const app = gobj_create_pure_child(`capp${++seq}`, "C_TEST_CLOSE_APP", {}, yuno);
+    gobj_start(app);
+    const form = gobj_create_pure_child(`cform${seq}`, "C_YUI_FORM", {
+        template: TEMPLATE,
+        record: record,
+        editable: true,
+    }, app);
+    gobj_start(form);
+    return form;
+}
+
+/*  What a window or a sheet asks the form before it closes.  */
+function close_asks(form)
+{
+    const kw = {abort_close: false};
+    gobj_send_event(form, "EV_WINDOW_TO_CLOSE", kw, form);
+    return kw.abort_close ? (kw.warning || "(no warning)") : "";
+}
+
+function errors()
+{
+    return logged.filter(l => /error/i.test(l.level) || /ERROR/.test(l.msg));
+}
+
+describe("the close of a form asks for what the reader changed", () => {
+    test("a record that lacks a defaulted field opens changed, and closes without asking", () => {
+        const form = build({template_version: 7, alarm_colors: null});
+        expect(gobj_read_attr(form, "changes")).toBe(true);
+        expect(gobj_read_attr(form, "edited")).toBe(false);
+        expect(close_asks(form)).toBe("");
+        expect(errors()).toEqual([]);
+    });
+
+    test("a change of the reader makes it ask", () => {
+        const form = build(COMPLETE);
+        expect(gobj_read_attr(form, "changes")).toBe(false);
+        expect(close_asks(form)).toBe("");
+
+        gobj_send_event(form, "EV_RECORD_CHANGED", {}, form);
+        expect(gobj_read_attr(form, "changes")).toBe(true);
+        expect(gobj_read_attr(form, "edited")).toBe(true);
+        expect(close_asks(form)).toBe("all changes will be lost");
+        expect(errors()).toEqual([]);
+    });
+
+    test("an undo, a save or a record loaded end what the close would lose", () => {
+        const form = build(COMPLETE);
+
+        gobj_send_event(form, "EV_RECORD_CHANGED", {}, form);
+        gobj_send_event(form, "EV_UNDO_RECORD", {}, form);
+        expect(gobj_read_attr(form, "edited")).toBe(false);
+        expect(close_asks(form)).toBe("");
+
+        gobj_send_event(form, "EV_RECORD_CHANGED", {}, form);
+        gobj_send_event(form, "EV_SAVE_RECORD", {}, form);
+        expect(gobj_read_attr(form, "edited")).toBe(false);
+        expect(close_asks(form)).toBe("");
+
+        gobj_send_event(form, "EV_RECORD_CHANGED", {}, form);
+        gobj_send_event(form, "EV_LOAD_RECORD", {template_version: 7, alarm_colors: null}, form);
+        expect(gobj_read_attr(form, "changes")).toBe(true);     // the defaults again
+        expect(gobj_read_attr(form, "edited")).toBe(false);
+        expect(close_asks(form)).toBe("");
+        expect(errors()).toEqual([]);
+    });
+
+    test("clearing and pasting are changes of the reader", () => {
+        const cleared = build(COMPLETE);
+        gobj_send_event(cleared, "EV_CLEAR_RECORD", {}, cleared);
+        expect(gobj_read_attr(cleared, "changes")).toBe(true);
+        expect(gobj_read_attr(cleared, "edited")).toBe(true);
+        expect(close_asks(cleared)).toBe("all changes will be lost");
+
+        const pasted = build(COMPLETE);
+        gobj_send_event(pasted, "EV_PASTE_RECORD", {record: {
+            template_version: 7,
+            alarm_colors: {
+                active_not_validated: "#00ff00",
+                active_validated: "#e5a50a",
+                not_active_not_validated: "#ff00ff"
+            }
+        }}, pasted);
+        expect(gobj_read_attr(pasted, "changes")).toBe(true);
+        expect(gobj_read_attr(pasted, "edited")).toBe(true);
+        expect(close_asks(pasted)).toBe("all changes will be lost");
+        expect(errors()).toEqual([]);
+    });
+});