@homebound/form-state 2.2.3 → 2.2.7

package/README.md

@@ -4,6 +4,6 @@ Push release.
 
 # Todo
 
-* Add conditional readonly logic, like `{ type: "field", readOnlyIf: i => i.isInternal.value }`
+- Add conditional readonly logic, like `{ type: "field", readOnlyIf: i => i.isInternal.value }`
 
-* Add `omitFromValue` so we can have two fields, `book.author.id` / `book.author.name`, where `book.author.name` is used for showing the author name, but `book.author.id` is the only field that is submitted to the server on mutation (maybe pair this with `Ref` based mutations) 
+- Add `omitFromValue` so we can have two fields, `book.author.id` / `book.author.name`, where `book.author.name` is used for showing the author name, but `book.author.id` is the only field that is submitted to the server on mutation (maybe pair this with `Ref` based mutations)

package/dist/formState.js

@@ -329,7 +329,7 @@ function newValueFieldState(parentInstance, parentState, key, rules, isIdKey, is
             if (this.readOnly && !opts.resetting && !opts.refreshing) {
                 throw new Error(`${key} is currently readOnly`);
             }
-            if (opts.refreshing && this.dirty) {
+            if (opts.refreshing && this.dirty && value !== this.value) {
                 // Ignore refreshed values if we're already dirty
                 return;
             }
@@ -411,9 +411,18 @@ function newListFieldState(parentInstance, parentState, key, rules, listConfig,
         },
         // private
         hasNewItems() {
-            const currentList = this.value;
-            const a = (currentList || []).every((e) => (originalCopy || []).includes(e));
-            const b = (originalCopy || []).every((e) => (currentList || []).includes(e));
+            const [current, original] = [this.value || [], originalCopy || []];
+            // Instead of relying on just object identities, we look up each child's state
+            // in rowMap, because we already dedup/check object identity (i.e. look for id fields)
+            // when create object states.
+            const a = current.every((e) => {
+                const state = rowMap.get(e);
+                return original.some((e) => rowMap.get(e) === state);
+            });
+            const b = original.every((e) => {
+                const state = rowMap.get(e);
+                return current.some((e) => rowMap.get(e) === state);
+            });
             const isSame = a && b;
             return !isSame;
         },
@@ -490,21 +499,26 @@ function newListFieldState(parentInstance, parentState, key, rules, listConfig,
                         }
                     }
                     // If we didn't have an existing child, just make a new object state
-                    childState = createObjectState(config, value);
+                    childState = createObjectState(config, value, { onBlur });
                     rowMap.set(value, childState);
                 }
                 // Return the already-observable'd value so that our `parent.value[key] = values` doesn't re-proxy things
                 return childState.value;
             });
+            // Reset originalCopy so that our dirty checks have the right # of rows.
+            if (opts.refreshing) {
+                originalCopy = [...(parentInstance[key] || [])];
+            }
             _tick.value++;
         },
         add(value, spliceIndex) {
             // This is called by the user, so value should be a non-proxy value we should keep
-            const childState = createObjectState(config, value);
+            const childState = createObjectState(config, value, { onBlur });
             rowMap.set(value, childState);
             this.ensureSet();
             this.value.splice(typeof spliceIndex === "number" ? spliceIndex : this.value.length, 0, childState.value);
             _tick.value++;
+            onBlur();
         },
         remove(indexOrValue) {
             this.ensureSet();
@@ -518,6 +532,7 @@ function newListFieldState(parentInstance, parentState, key, rules, listConfig,
                 }
             }
             _tick.value++;
+            onBlur();
         },
         reset() {
             if (originalCopy) {

package/dist/formState.test.js

@@ -321,6 +321,16 @@ describe("formState", () => {
         a1.books.remove(0);
         expect(a1.dirty).toBeFalsy();
     });
+    it("it calls onBlur when adding or removing to a list", () => {
+        const onBlur = jest.fn();
+        const a1 = createAuthorInputState({ books: [] }, onBlur);
+        expect(a1.books.dirty).toBeFalsy();
+        a1.books.add({ title: "t2" });
+        expect(a1.books.dirty).toBeTruthy();
+        a1.books.remove(0);
+        expect(a1.dirty).toBeFalsy();
+        expect(onBlur).toBeCalledTimes(2);
+    });
     it("knows list of primitives are dirty", () => {
         const a1 = formState_1.createObjectState({ favoriteColors: { type: "value" } }, {});
         expect(a1.favoriteColors.dirty).toBeFalsy();
@@ -1187,6 +1197,18 @@ describe("formState", () => {
                     { id: "b:3", title: "b3" },
                 ],
             };
+            // Eventually our local values are saved
+            const data3 = {
+                id: "a:1",
+                firstName: "local",
+                lastName: "l2",
+                address: { id: "address:1", street: "local", city: "c2" },
+                books: [
+                    { id: "b:1", title: "local" },
+                    { id: "b:2", title: "b2" },
+                    { id: "b:3", title: "b3" },
+                ],
+            };
             // And we start out with data1
             const [data, setData] = react_1.useState(data1);
             const form = formState_1.useFormState({ config, init: { input: data, map: (d) => d } });
@@ -1195,9 +1217,6 @@ describe("formState", () => {
                 form.address.street.value = "local";
                 form.books.rows[0].title.value = "local";
             }
-            function refreshData() {
-                setData(data2);
-            }
             return (jsx_runtime_1.jsx(mobx_react_1.Observer, { children: () => (jsx_runtime_1.jsxs("div", { children: [jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "firstName" }, { children: form.firstName.value }), void 0),
                         jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "lastName" }, { children: form.lastName.value }), void 0),
                         jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "street" }, { children: form.address.street.value }), void 0),
@@ -1206,7 +1225,8 @@ describe("formState", () => {
                         jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "title2" }, { children: form.books.rows[1].title.value }), void 0),
                         jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "booksLength" }, { children: form.books.rows.length }), void 0),
                         jsx_runtime_1.jsx("button", { "data-testid": "makeLocalChanges", onClick: makeLocalChanges }, void 0),
-                        jsx_runtime_1.jsx("button", { "data-testid": "refreshData", onClick: refreshData }, void 0),
+                        jsx_runtime_1.jsx("button", { "data-testid": "refreshData", onClick: () => setData(data2) }, void 0),
+                        jsx_runtime_1.jsx("button", { "data-testid": "saveData", onClick: () => setData(data3) }, void 0),
                         jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "changedValue" }, { children: JSON.stringify(form.changedValue) }), void 0)] }, void 0)) }, void 0));
         }
         // And we start out with the initial query data
@@ -1243,6 +1263,12 @@ describe("formState", () => {
             books: [{ id: "b:1", title: "local" }, { id: "b:2" }, { id: "b:3" }],
             firstName: "local",
         });
+        // And then when our mutation results come back
+        rtl_utils_1.click(r.saveData);
+        // Then changedValue doesn't show our local changes anymore
+        expect(JSON.parse(r.changedValue().textContent)).toEqual({
+            id: "a:1",
+        });
     });
     it("useFormState can accept new data while read only", async () => {
         // Given a component
@@ -1322,6 +1348,41 @@ describe("formState", () => {
         expect(r.firstName().textContent).toEqual("f2");
         expect(r.fullName().textContent).toEqual("f2 l2");
     });
+    it("can trigger auto save for fields in list that were initially undefined", async () => {
+        const autoSave = jest.fn();
+        // Given a component
+        function TestComponent() {
+            // When the data is initially undefined
+            const [data, setData] = react_1.useState();
+            const data2 = { books: [{ title: "Title 1" }] };
+            const form = formState_1.useFormState({
+                config: authorWithBooksConfig,
+                init: { input: data, map: (d) => d, ifUndefined: { books: [] } },
+                autoSave,
+            });
+            return (jsx_runtime_1.jsx(mobx_react_1.Observer, { children: () => (jsx_runtime_1.jsxs("div", { children: [jsx_runtime_1.jsx("button", { "data-testid": "refreshData", onClick: () => setData(data2) }, void 0),
+                        jsx_runtime_1.jsx("button", { "data-testid": "add", onClick: () => form.books.add({ title: "New Book" }) }, void 0),
+                        jsx_runtime_1.jsx("button", { "data-testid": "blurBookOne", onClick: () => form.books.rows[0].title.blur() }, void 0),
+                        jsx_runtime_1.jsx("button", { "data-testid": "blurBookTwo", onClick: () => form.books.rows[1].title.blur() }, void 0)] }, void 0)) }, void 0));
+        }
+        // Given a formState with `onBlur` set
+        const r = await rtl_utils_1.render(jsx_runtime_1.jsx(TestComponent, {}, void 0));
+        // When the data/child is now available
+        rtl_utils_1.click(r.refreshData);
+        // And the field is blurred
+        rtl_utils_1.click(r.blurBookOne);
+        // Then we don't auto-save because nothing has changed
+        expect(autoSave).toBeCalledTimes(0);
+        // And when adding a new book
+        rtl_utils_1.click(r.add);
+        // We autoSave the new row right away (because we don't have any validation rules
+        // that say the new row can't be empty)
+        expect(autoSave).toBeCalledTimes(1);
+        // And the new book is blurred
+        rtl_utils_1.click(r.blurBookTwo);
+        // Then we auto save again
+        expect(autoSave).toBeCalledTimes(2);
+    });
 });
 class ObservableObject {
     constructor() {
@@ -1354,8 +1415,8 @@ const authorWithBooksConfig = {
         },
     },
 };
-function createAuthorInputState(input) {
-    return formState_1.createObjectState(authorWithBooksConfig, input);
+function createAuthorInputState(input, onBlur) {
+    return formState_1.createObjectState(authorWithBooksConfig, input, { onBlur });
 }
 const authorWithAddressConfig = {
     id: { type: "value" },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@homebound/form-state",
-  "version": "2.2.3",
+  "version": "2.2.7",
   "author": "Homebound",
   "license": "MIT",
   "main": "dist/index.js",