@homebound/form-state 2.2.13 → 2.3.0

package/dist/formState.d.ts

@@ -25,7 +25,7 @@
  */
 export declare type ObjectState<T, P = any> = FieldStates<T> & FieldState<P, T> & {
     /** Sets the state of fields in `state`. */
-    set(state: Partial<T>): void;
+    set(state: Partial<T>, opts?: SetOpts): void;
     /** Returns whether the object can be saved, i.e. is valid, but also as a side-effect marks touched. */
     canSave(): boolean;
 };
@@ -74,12 +74,17 @@ export interface FieldState<T, V> {
     focus(): void;
     /** Blur essentially touches the field. */
     blur(): void;
-    set(value: V): void;
+    set(value: V, opts?: SetOpts): void;
     /** Reverts back to the original value and resets dirty/touched. */
     reset(): void;
     /** Accepts the current changed value (if any) as the original and resets dirty/touched. */
     save(): void;
 }
+/** Public options for our `set` command. */
+export interface SetOpts {
+    /** Whether this `set` should trigger an auto-save; defaults to true. */
+    autoSave?: boolean;
+}
 /** Form state for list of children, i.e. `U` is a `Book` in a form with a `books: Book[]`. */
 export interface ListFieldState<T, U> extends Omit<FieldState<T, U[]>, "originalValue"> {
     readonly rows: ReadonlyArray<ObjectState<U>>;

package/dist/formState.js

@@ -298,7 +298,7 @@ function newValueFieldState(parentInstance, parentState, key, rules, isIdKey, is
             }
             // If we're being set programmatically, i.e. we don't currently have focus,
             // call blur to trigger any auto-saves.
-            if (!this._focused && !opts.refreshing && !opts.resetting && this.dirty && changed) {
+            if (!this._focused && !opts.refreshing && !opts.resetting && this.dirty && changed && opts.autoSave !== false) {
                 this.blur();
             }
         },

package/dist/formState.test.js

@@ -353,6 +353,15 @@ describe("formState", () => {
         // Then we called onBlur again
         expect(onBlur).toBeCalledTimes(2);
     });
+    it("can skip onBlur when programmatically setting a value", () => {
+        const onBlur = jest.fn();
+        // Given an author listening for blur
+        const a1 = createAuthorInputState({ books: [{}] }, onBlur);
+        // When we programmatically set a field that isn't focused
+        a1.set({ firstName: "first" }, { autoSave: false });
+        // Then we don't call onBlur
+        expect(onBlur).toBeCalledTimes(0);
+    });
     it("defers calling onBlur when setting a bound value", () => {
         const onBlur = jest.fn();
         // Given an author listening for blur

package/package.json

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