@homebound/form-state 2.26.0 → 2.26.2

package/dist/config.d.ts

@@ -38,7 +38,7 @@ export type ValueFieldConfig<V> = {
     computed?: boolean;
     /** Marks a field as being initially read-only, i.e. `field.readOnly = true/false` can change this default. */
     readOnly?: boolean;
-    /** Marks an array field to be order agnostic when determining changed/dirty states */
+    /** Marks an array field to be order agnostic when determining changed/dirty states, defaults true. */
     strictOrder?: false;
 };
 /** Field configuration for list values, i.e. `U` is `Book` in a form with `books: Book[]`. */
@@ -60,7 +60,7 @@ export type ListFieldConfig<U> = {
      * default behavior.
      */
     update?: "exhaustive" | "incremental";
-    /** Set to not consider the order of the list when evaluating changed/dirty states. */
+    /** Set to not consider the order of the list when evaluating changed/dirty states, defaults true. */
     strictOrder?: false;
 };
 export type ObjectFieldConfig<U> = {

package/dist/fields/listField.js

@@ -50,8 +50,10 @@ function newListFieldState(parentCopy, parentInstance, parentState, key, rules,
         key: key,
         // Our fundamental state of wrapped Us
         get value() {
-            return _tick.value > 0 && _childTick.value > 0 ? parentInstance[key] : (0, utils_1.fail)();
+            var _a;
+            return _tick.value > 0 && _childTick.value > 0 ? ((_a = parentInstance[key]) !== null && _a !== void 0 ? _a : []) : (0, utils_1.fail)();
         },
+        _kind: "list",
         _focused: false,
         _readOnly: false,
         _loading: false,

package/dist/fields/objectField.js

@@ -196,6 +196,7 @@ function newObjectState(config, parentState, parentInstance, parentListState, in
                 return null;
             }
             getFields(this).forEach((f) => {
+                var _a;
                 if (f._computed)
                     return;
                 // References only include the id key below
@@ -205,8 +206,10 @@ function newObjectState(config, parentState, parentInstance, parentListState, in
                     // If the caller used useFormState.ifUndefined to provide some default values, then those keys may not
                     // look dirty, but if we're new we should include them anyway.
                     (this.isNewEntity && f._kind === "value" && f.value !== undefined) ||
-                    // And unless they're empty sub-objects
-                    (this.isNewEntity && f._kind === "object" && Object.entries(f.changedValue).length > 0)) {
+                    // ...or they're non-empty sub-objects
+                    (this.isNewEntity && f._kind === "object" && Object.entries(f.changedValue).length > 0) ||
+                    // ...or they're non-empty sub-lists
+                    (this.isNewEntity && f._kind === "list" && ((_a = f.value) === null || _a === void 0 ? void 0 : _a.length) > 0)) {
                     result[f.key] = f.changedValue;
                 }
             });

package/dist/formState.test.js

@@ -1069,6 +1069,23 @@ describe("formState", () => {
         // because this might trigger creating a throw-away entity
         expect(formState.changedValue).toEqual({ firstName: "f" });
     });
+    it("changedValue includes initialized-and-unchanged list fields", () => {
+        // Given a new author that is initialized with a new book
+        const formState = (0, objectField_1.createObjectState)(authorWithBooksConfig, {
+            books: [{ title: "t1" }],
+        });
+        // Then changedValue realizes that even though `books` is not changed, it should be included
+        expect(formState.books.dirty).toBe(false);
+        expect(formState.changedValue).toEqual({ books: [{ title: "t1" }] });
+    });
+    it("changedValue skips initialized-and-unchanged list fields that are empty", () => {
+        // Given a new author that is initialized with no books
+        const formState = (0, objectField_1.createObjectState)(authorWithBooksConfig, {
+            books: [],
+        });
+        // Then changedValue doesn't include the books
+        expect(formState.changedValue).toEqual({});
+    });
     it("changedValue includes new entity nested fields", () => {
         // Given a new author with an address FK
         const formState = (0, objectField_1.createObjectState)(authorWithAddressFkConfig, {

package/dist/useFormState.test.js

@@ -336,6 +336,23 @@ describe("useFormState", () => {
         // Then we auto save again
         expect(autoSave).toBeCalledTimes(2);
     });
+    it("returns empty lists even when inputs are undefined", async () => {
+        const autoSave = jest.fn();
+        // Given a component
+        function TestComponent() {
+            // And there is no initial data (i.e. we're creating the author)
+            const form = (0, useFormState_1.useFormState)({
+                config: authorWithBooksConfig,
+                init: { input: undefined, map: (d) => d },
+                autoSave,
+            });
+            return ((0, jsx_runtime_1.jsxs)("div", { children: [(0, jsx_runtime_1.jsx)("div", { "data-testid": "len", children: form.books.value.length }), (0, jsx_runtime_1.jsx)("div", { "data-testid": "dirty", children: String(form.books.dirty) })] }));
+        }
+        // Then we can still read it as empty
+        const r = await (0, rtl_utils_1.render)((0, jsx_runtime_1.jsx)(TestComponent, {}));
+        expect(r.len).toHaveTextContent("0");
+        expect(r.dirty).toHaveTextContent("false");
+    });
     it("does not infinite loop when calling set inside of auto-save", async () => {
         // Given a component
         let autoSaves = 0;

package/package.json

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