@homebound/form-state 2.1.1 → 2.1.2

package/dist/formState.js

@@ -163,7 +163,7 @@ function newObjectState(config, parentState, instance, key, onBlur) {
         // Accepts new values in bulk, i.e. when setting the form initial state from the backend.
         set(value) {
             if (this.readOnly) {
-                throw new Error("Currently readOnly");
+                throw new Error(`${key || "formState"} is currently readOnly`);
             }
             getFields(this).forEach((field) => {
                 if (field.key in value && (!field.dirty || !field._focused)) {
@@ -296,9 +296,9 @@ function newValueFieldState(parentInstance, parentState, key, rules, isIdKey, is
             this.touched = true;
             onBlur();
         },
-        set(value) {
-            if (this.readOnly) {
-                throw new Error("Currently readOnly");
+        set(value, opts = {}) {
+            if (this.readOnly && !opts.resetting) {
+                throw new Error(`${key} is currently readOnly`);
             }
             // If the user has deleted/emptied a value that was originally set, keep it as `null`
             // so that our partial update to the backend correctly unsets it.
@@ -311,11 +311,8 @@ function newValueFieldState(parentInstance, parentState, key, rules, isIdKey, is
             _tick.value++;
         },
         reset() {
-            // We check !this.readOnly b/c set will blow up, but maybe we should pass
-            // an internal override to allow it anyway? Currently this is failing when
-            // using a `isReadOnlyKey` has made an entity read-only.
-            if (!computed && !this.readOnly) {
-                this.set(this.originalValue);
+            if (!computed) {
+                this.set(this.originalValue, { resetting: true });
             }
             this.touched = false;
         },
@@ -436,9 +433,9 @@ function newListFieldState(parentInstance, parentState, key, rules, listConfig,
             this.touched = true;
             onBlur();
         },
-        set(values) {
-            if (this.readOnly) {
-                throw new Error("Currently readOnly");
+        set(values, opts = {}) {
+            if (this.readOnly && !opts.resetting) {
+                throw new Error(`${key} is currently readOnly`);
             }
             // We should be passed values that are non-proxies.
             parentInstance[key] = values.map((value) => {
@@ -475,7 +472,7 @@ function newListFieldState(parentInstance, parentState, key, rules, listConfig,
         },
         reset() {
             if (originalCopy) {
-                this.set(originalCopy);
+                this.set(originalCopy, { resetting: true });
                 this.rows.forEach((r) => r.reset());
             }
         },

package/dist/formState.test.js

@@ -409,6 +409,43 @@ describe("formState", () => {
         expect(a1.dirty).toBeFalsy();
         expect(a1.touched).toBeFalsy();
     });
+    it("resets values even if read only", () => {
+        // Given a form state
+        const a1 = createAuthorInputState({
+            firstName: "a1",
+            lastName: "aL1",
+            books: [
+                { title: "b1", classification: formStateDomain_1.dd100 },
+                { title: "b2", classification: formStateDomain_1.dd100 },
+            ],
+        });
+        // And some values have been changed
+        expect(a1.dirty).toBeFalsy();
+        a1.firstName.set("a2");
+        a1.firstName.touched = true;
+        a1.lastName.set("aL2");
+        a1.books.rows[0].set({ title: "b2" });
+        a1.books.rows[1].set({ title: "bb2" });
+        a1.books.add({ title: "b3" });
+        expect(a1.books.touched).toEqual(true);
+        expect(a1.dirty).toBeTruthy();
+        // And the "readOnly=true" operation has "beat" the reset operation
+        a1.readOnly = true;
+        // When we reset
+        a1.reset();
+        // Then it still works
+        expect(a1.firstName.value).toBe("a1");
+        expect(a1.firstName.touched).toBeFalsy();
+        expect(a1.lastName.value).toBe("aL1");
+        expect(a1.books.rows.length).toBe(2);
+        expect(a1.books.touched).toBe(false);
+        expect(a1.books.rows[0].title.value).toBe("b1");
+        expect(a1.books.rows[0].title.dirty).toBe(false);
+        expect(a1.books.rows[0].title.touched).toBe(false);
+        expect(a1.books.rows[1].title.value).toBe("b2");
+        expect(a1.dirty).toBeFalsy();
+        expect(a1.touched).toBeFalsy();
+    });
     it("saves values into _originalState", () => {
         const a1 = createAuthorInputState({
             firstName: "a1",
@@ -496,7 +533,7 @@ describe("formState", () => {
         a1.readOnly = true;
         fields.forEach((f) => expect(f.readOnly).toBeTruthy());
         fields.forEach((f) => {
-            expect(() => f.set(null)).toThrow("Currently readOnly");
+            expect(() => f.set(null)).toThrow("is currently readOnly");
         });
     });
     it("maintain field readOnly state when form is readOnly", () => {

package/package.json

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