@homebound/form-state 2.5.2 → 2.6.0

package/dist/formState.js

@@ -431,10 +431,22 @@ function newListFieldState(parentInstance, parentState, key, rules, listConfig,
         },
         get changedValue() {
             const result = [];
-            const pushAll = listConfig.update !== "incremental";
+            const hasOpKey = Object.keys(listConfig.config).includes("op");
+            const hasLegacyOpKey = Object.keys(listConfig.config).some((key) => key === "delete" || key === "remove");
+            const incremental = listConfig.update === "incremental" ||
+                // Implicitly enable incremental mode if we see an op key
+                (listConfig.update === undefined && (hasOpKey || hasLegacyOpKey));
+            const exhaustive = !incremental;
             this.rows.forEach((r) => {
-                if (pushAll || r.dirty) {
-                    result.push(r.changedValue);
+                var _a;
+                var _b;
+                if (exhaustive || r.dirty || r.isNewEntity) {
+                    const changed = r.changedValue;
+                    // Ensure we have an `op: include` key, following https://joist-orm.io/docs/features/partial-update-apis
+                    if (incremental && hasOpKey) {
+                        (_a = (_b = changed).op) !== null && _a !== void 0 ? _a : (_b.op = "include");
+                    }
+                    result.push(changed);
                 }
             });
             return result;

package/dist/formState.test.js

@@ -979,6 +979,81 @@ describe("formState", () => {
             books: [{ id: "b:1", title: "t1b" }],
         });
     });
+    it("uses the op key as a hint to use incremental list behavior", () => {
+        // Given an author
+        const formState = formState_1.createObjectState({
+            id: { type: "value" },
+            // And the books collection is not explicitly marked as incremental
+            books: {
+                type: "list",
+                config: {
+                    id: { type: "value" },
+                    title: { type: "value", rules: [formState_1.required] },
+                    // But it does have an op key
+                    op: { type: "value" },
+                },
+            },
+        }, {
+            id: "a:1",
+            firstName: "f",
+            books: [
+                // And the books start out as included
+                { id: "b:1", title: "t1", op: "include" },
+                { id: "b:2", title: "t2", op: "include" },
+            ],
+        });
+        // And initially nothing is changed
+        expect(formState.changedValue).toEqual({ id: "a:1" });
+        // When we delete the 1st book
+        formState.books.rows[0].op.value = "delete";
+        // Then only the 1st book is included
+        expect(formState.changedValue).toEqual({
+            id: "a:1",
+            books: [{ id: "b:1", op: "delete" }],
+        });
+    });
+    it("defaults the incremental op key to included when not set", () => {
+        // Given an author
+        const formState = formState_1.createObjectState({
+            id: { type: "value" },
+            // And the books collection is not explicitly marked as incremental
+            books: {
+                type: "list",
+                config: {
+                    id: { type: "value" },
+                    title: { type: "value", rules: [formState_1.required] },
+                    // But it does have an op key
+                    op: { type: "value" },
+                },
+            },
+        }, {
+            id: "a:1",
+            firstName: "f",
+            books: [
+                // And no op keys are initially set
+                { id: "b:1", title: "t1" },
+                { id: "b:2", title: "t2" },
+            ],
+        });
+        // And initially nothing is changed
+        expect(formState.changedValue).toEqual({ id: "a:1" });
+        // When we delete the 1st book
+        formState.books.rows[0].op.value = "delete";
+        // And add a 3rd book
+        formState.books.add({ title: "t3" });
+        // Then the 3rd book doesn't have an explicit op yet
+        expect(formState.books.rows[2].op.value).toBeUndefined();
+        // But when we create changedValue
+        expect(formState.changedValue).toEqual({
+            id: "a:1",
+            books: [
+                // Then the deleted book is included
+                { id: "b:1", op: "delete" },
+                // And the 3rd book is included w/the `op: include` flag added
+                { title: "t3", op: "include" },
+            ],
+        });
+    });
     it("can observe value changes", () => {
         const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f" });
         let ticks = 0;

package/dist/formStateDomain.d.ts

@@ -26,6 +26,7 @@ export interface BookInput {
     classification?: DeweyDecimalClassification;
     delete?: boolean | null | undefined;
     isPublished?: boolean;
+    op?: "include" | "delete" | "remove";
 }
 export interface DeweyDecimalClassification {
     number: string;

package/package.json

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