@homebound/form-state 2.10.0 → 2.10.1

package/dist/fields/valueField.js

@@ -0,0 +1,149 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.newValueFieldState = void 0;
+const is_plain_object_1 = require("is-plain-object");
+const mobx_1 = require("mobx");
+const rules_1 = require("../rules");
+const utils_1 = require("../utils");
+function newValueFieldState(parentInstance, parentState, key, rules, isIdKey, isDeleteKey, isReadOnlyKey, computed, readOnly, maybeAutoSave) {
+    // keep a copy here for reference equality
+    const value = parentInstance[key];
+    let _originalValue = value === null ? undefined : is_plain_object_1.isPlainObject(value) ? mobx_1.toJS(value) : value;
+    // Because we read/write the value directly back into parentInstance[key],
+    // which itself is not a proxy, we use this as our "value changed" trigger.
+    const _tick = mobx_1.observable({ value: 1 });
+    const _originalValueTick = mobx_1.observable({ value: 1 });
+    const field = {
+        key,
+        touched: false,
+        /** Current readOnly value. */
+        _readOnly: readOnly || false,
+        _focused: false,
+        _isIdKey: isIdKey,
+        _isDeleteKey: isDeleteKey,
+        _isReadOnlyKey: isReadOnlyKey,
+        rules,
+        get value() {
+            const value = _tick.value > 0 ? parentInstance[key] : utils_1.fail();
+            // Re-create the `keepNull` logic on sets but for our initial read where our
+            // originalValue is null (empty) but we want to expose it as undefined for
+            // consistency of "empty-ness" to our UI components.
+            return value === null && utils_1.isEmpty(_originalValue) ? undefined : value;
+        },
+        set value(v) {
+            this.set(v);
+        },
+        get dirty() {
+            return !utils_1.areEqual(this.originalValue, this.value);
+        },
+        /** Returns whether this field is readOnly, although if our parent is readOnly then it trumps. */
+        get readOnly() {
+            return parentState().readOnly || this._readOnly;
+        },
+        /** Sets the field readOnly, but `v` will still be or-d with the parent's readOnly state. */
+        set readOnly(v) {
+            this._readOnly = v;
+        },
+        // For primitive fields, the changed value is just the value.
+        get changedValue() {
+            return this.value;
+        },
+        get valid() {
+            const opts = { value: this.value, key: key, originalValue: this.originalValue, object: parentState() };
+            return this.rules.every((r) => r(opts) === undefined);
+        },
+        get errors() {
+            const opts = { value: this.value, key: key, originalValue: this.originalValue, object: parentState() };
+            return this.rules.map((r) => r(opts)).filter(utils_1.isNotUndefined);
+        },
+        get required() {
+            return this.rules.some((rule) => rule === rules_1.required);
+        },
+        get isNewEntity() {
+            return parentState().isNewEntity;
+        },
+        focus() {
+            this._focused = true;
+        },
+        blur() {
+            this.maybeAutoSave();
+            this._focused = false;
+        },
+        maybeAutoSave() {
+            // Now that the user is done editing the field (note maybe w/o blurring, i.e. if they hit enter), we sneak in some trim logic
+            this.maybeTrim();
+            // touched is readonly, but we're allowed to change it
+            this.touched = true;
+            maybeAutoSave();
+        },
+        set(value, opts = {}) {
+            if (this.readOnly && !opts.resetting && !opts.refreshing) {
+                throw new Error(`${key} is currently readOnly`);
+            }
+            if (opts.refreshing && this.dirty && this.value !== value) {
+                // Ignore incoming values if we have changes (this.dirty) unless our latest change (this.value)
+                // matches the incoming value (value), b/c if it does we should accept it and reset originalValue
+                // so that we're not longer dirty.
+                return;
+            }
+            else if (computed && (opts.resetting || opts.refreshing)) {
+                // Computeds can't be either reset or refreshed
+                return;
+            }
+            // 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.
+            const keepNull = !utils_1.isEmpty(this.originalValue) && utils_1.isEmpty(value);
+            // If a list of primitives was originally undefined, coerce `[]` to `undefined`
+            const coerceEmptyList = value && value instanceof Array && value.length === 0 && utils_1.isEmpty(this.originalValue);
+            const newValue = keepNull ? null : utils_1.isEmpty(value) || coerceEmptyList ? undefined : value;
+            // Set the value on our parent object
+            const changed = !utils_1.areEqual(newValue, this.value);
+            parentInstance[key] = newValue;
+            _tick.value++;
+            if (opts.refreshing) {
+                this.originalValue = newValue;
+            }
+            // 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 && opts.autoSave !== false) {
+                this.maybeAutoSave();
+            }
+        },
+        reset() {
+            if (!computed) {
+                this.set(this.originalValue, { resetting: true });
+            }
+            this.touched = false;
+        },
+        save() {
+            if (is_plain_object_1.isPlainObject(this.originalValue)) {
+                this.originalValue = mobx_1.toJS(this.value);
+            }
+            else {
+                this.originalValue = this.value;
+            }
+            this.touched = false;
+        },
+        get originalValue() {
+            // A dummy check to for reactivity around our non-proxy value
+            return _originalValueTick.value > -1 ? _originalValue : _originalValue;
+        },
+        set originalValue(v) {
+            _originalValue = v;
+            _originalValueTick.value++;
+        },
+        maybeTrim() {
+            if (typeof this.value === "string") {
+                let newValue = this.value.trim();
+                if (newValue === "") {
+                    newValue = undefined;
+                }
+                if (newValue !== this.value) {
+                    this.set(newValue);
+                }
+            }
+        },
+    };
+    return field;
+}
+exports.newValueFieldState = newValueFieldState;

package/dist/formState.test.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const mobx_1 = require("mobx");
+const objectField_1 = require("./fields/objectField");
 const formStateDomain_1 = require("./formStateDomain");
-const formState_1 = require("./formState");
+const rules_1 = require("./rules");
 describe("formState", () => {
     it("mobx lists maintain observable identity", () => {
         // given a parent observable
@@ -14,11 +15,11 @@ describe("formState", () => {
         expect(a.list[0] === c1).toEqual(true);
     });
     it("can create a simple object", () => {
-        const a = formState_1.createObjectState({ title: { type: "value", rules: [formState_1.required] } }, {});
+        const a = objectField_1.createObjectState({ title: { type: "value", rules: [rules_1.required] } }, {});
         expect(a.valid).toBeFalsy();
     });
     it("can validate a simple input", () => {
-        const a = formState_1.createObjectState({ title: { type: "value", rules: [formState_1.required] } }, { title: "b1" });
+        const a = objectField_1.createObjectState({ title: { type: "value", rules: [rules_1.required] } }, { title: "b1" });
         let numErrors = 0;
         mobx_1.autorun(() => {
             numErrors = a.title.errors.length;
@@ -32,15 +33,15 @@ describe("formState", () => {
         expect(a.errors).toEqual(["title: Required"]);
     });
     it("can tell what is required", () => {
-        const a = formState_1.createObjectState({
-            title: { type: "value", rules: [formState_1.required] },
+        const a = objectField_1.createObjectState({
+            title: { type: "value", rules: [rules_1.required] },
             isPublished: { type: "value" },
         }, {});
         expect(a.title.required).toBeTruthy();
         expect(a.isPublished.required).toBeFalsy();
     });
     it("trims whitespace within the required rule", () => {
-        const a = formState_1.createObjectState({ title: { type: "value", rules: [formState_1.required] } }, { title: "initial valid title" });
+        const a = objectField_1.createObjectState({ title: { type: "value", rules: [rules_1.required] } }, { title: "initial valid title" });
         let numErrors = 0;
         mobx_1.autorun(() => {
             numErrors = a.title.errors.length;
@@ -55,16 +56,16 @@ describe("formState", () => {
         expect(a.errors).toEqual(["title: Required"]);
     });
     it("can set values", () => {
-        const a = formState_1.createObjectState({ title: { type: "value" } }, { title: "b1" });
+        const a = objectField_1.createObjectState({ title: { type: "value" } }, { title: "b1" });
         expect(a.title.value).toEqual("b1");
     });
     it("can read values", () => {
-        const a = formState_1.createObjectState({ title: { type: "value" } }, { title: "b1" });
+        const a = objectField_1.createObjectState({ title: { type: "value" } }, { title: "b1" });
         expect(a.value.title).toEqual("b1");
         expect(a.title.value).toEqual("b1");
     });
     it("can set dates", () => {
-        const a = formState_1.createObjectState({
+        const a = objectField_1.createObjectState({
             birthday: {
                 type: "value",
                 rules: [({ value }) => ((value === null || value === void 0 ? void 0 : value.getTime()) === formStateDomain_1.jan2.getTime() ? "cannot be born on jan2" : undefined)],
@@ -149,7 +150,7 @@ describe("formState", () => {
         };
         // And we initially have ids in the input
         const a1 = { id: "1", firstName: "a1", books: [{ id: "2", title: "t1" }] };
-        const state = formState_1.createObjectState(config, a1);
+        const state = objectField_1.createObjectState(config, a1);
         // And we edit a few things
         state.firstName.set("a2");
         state.books.add({ title: "t2" });
@@ -286,7 +287,7 @@ describe("formState", () => {
         expect(numErrors).toEqual(0);
     });
     it("can validate across fields", () => {
-        const a = formState_1.createObjectState({
+        const a = objectField_1.createObjectState({
             firstName: { type: "value", rules: [] },
             lastName: { type: "value" },
         }, {});
@@ -303,7 +304,7 @@ describe("formState", () => {
     it("passes sanitized values to validation rules", () => {
         // Given a field with a validation rule
         const rule = jest.fn().mockReturnValue("Required");
-        const a = formState_1.createObjectState({ firstName: { type: "value", rules: [rule] } }, {});
+        const a = objectField_1.createObjectState({ firstName: { type: "value", rules: [rule] } }, {});
         expect(rule).toHaveBeenCalledTimes(0);
         // When the field is set to empty string
         a.firstName.value = "";
@@ -320,7 +321,7 @@ describe("formState", () => {
     it("passes trimmed values to validation rules on maybeAutoSave", () => {
         // Given we have a required rule
         const rule = jest.fn().mockReturnValue("Required");
-        const a = formState_1.createObjectState({ firstName: { type: "value", rules: [rule] } }, {});
+        const a = objectField_1.createObjectState({ firstName: { type: "value", rules: [rule] } }, {});
         expect(rule).toHaveBeenCalledTimes(0);
         // When the user initially sets an empty string value
         a.firstName.focus();
@@ -347,8 +348,8 @@ describe("formState", () => {
         });
     });
     it("simple value changes trigger observers", () => {
-        const a = formState_1.createObjectState({
-            title: { type: "value", rules: [formState_1.required] },
+        const a = objectField_1.createObjectState({
+            title: { type: "value", rules: [rules_1.required] },
         }, { title: "t2" });
         let lastTitle = undefined;
         let ticks = 0;
@@ -465,7 +466,7 @@ describe("formState", () => {
         expect(maybeAutoSave).toBeCalledTimes(0);
     });
     it("knows list of primitives are dirty", () => {
-        const a1 = formState_1.createObjectState({ favoriteColors: { type: "value" } }, {});
+        const a1 = objectField_1.createObjectState({ favoriteColors: { type: "value" } }, {});
         expect(a1.favoriteColors.dirty).toBeFalsy();
         a1.favoriteColors.set([formStateDomain_1.Color.Blue]);
         expect(a1.dirty).toBeTruthy();
@@ -476,7 +477,7 @@ describe("formState", () => {
         expect(a1.dirty).toBeFalsy();
     });
     it("knows list of primitives are dirty with initialized as empty list", () => {
-        const a1 = formState_1.createObjectState({ favoriteColors: { type: "value" } }, { favoriteColors: [] });
+        const a1 = objectField_1.createObjectState({ favoriteColors: { type: "value" } }, { favoriteColors: [] });
         expect(a1.favoriteColors.dirty).toBeFalsy();
         a1.favoriteColors.set([formStateDomain_1.Color.Blue]);
         expect(a1.dirty).toBeTruthy();
@@ -656,7 +657,7 @@ describe("formState", () => {
         expect(a1.value.firstName).toBeNull();
     });
     it("can map properties to other types", () => {
-        const a1 = formState_1.createObjectState({
+        const a1 = objectField_1.createObjectState({
             person: { type: "value" },
         }, { person: { firstName: "a1", lastName: "b1" } });
         a1.person.set({ firstName: "a2", lastName: "b2" });
@@ -682,7 +683,7 @@ describe("formState", () => {
     });
     it("maintain field readOnly state when form is readOnly", () => {
         // Given a formState
-        const formState = formState_1.createObjectState({ title: { type: "value", rules: [formState_1.required], readOnly: true } }, {});
+        const formState = objectField_1.createObjectState({ title: { type: "value", rules: [rules_1.required], readOnly: true } }, {});
         // Then expect form
         expect(formState.title.readOnly).toBeTruthy();
     });
@@ -723,15 +724,15 @@ describe("formState", () => {
         expect(a1.firstName.readOnly).toBeTruthy();
     });
     it("canSave returns dirty and touches", () => {
-        const a1 = formState_1.createObjectState({
-            firstName: { type: "value", rules: [formState_1.required] },
+        const a1 = objectField_1.createObjectState({
+            firstName: { type: "value", rules: [rules_1.required] },
         }, {});
         expect(a1.firstName.touched).toBeFalsy();
         expect(a1.canSave()).toBeFalsy();
         expect(a1.firstName.touched).toBeTruthy();
     });
     it("uses toJSON if available for dirty checks", () => {
-        const a1 = formState_1.createObjectState({
+        const a1 = objectField_1.createObjectState({
             birthday: { type: "value" },
         }, { birthday: new formStateDomain_1.DateOnly(formStateDomain_1.jan1) });
         a1.birthday.set(new formStateDomain_1.DateOnly(formStateDomain_1.jan1));
@@ -746,10 +747,10 @@ describe("formState", () => {
         expect(a.valid).toBeTruthy();
     });
     it("can validate a list input", () => {
-        const a = formState_1.createObjectState({
+        const a = objectField_1.createObjectState({
             books: {
                 type: "list",
-                config: { title: { type: "value", rules: [formState_1.required] } },
+                config: { title: { type: "value", rules: [rules_1.required] } },
                 rules: [({ value }) => (value.find((b) => b.title.value === "t1") ? "Cannot have t1" : undefined)],
             },
         }, {});
@@ -763,11 +764,11 @@ describe("formState", () => {
         expect(lastErrors).toEqual("");
     });
     it("can ignore a deleted list entry", () => {
-        const a = formState_1.createObjectState({
+        const a = objectField_1.createObjectState({
             books: {
                 type: "list",
                 config: {
-                    title: { type: "value", rules: [formState_1.required] },
+                    title: { type: "value", rules: [rules_1.required] },
                     delete: { type: "value", isDeleteKey: true },
                 },
             },
@@ -782,11 +783,11 @@ describe("formState", () => {
         expect(a.books.valid).toBeTruthy();
     });
     it("can treat a list entry as read-only", () => {
-        const a = formState_1.createObjectState({
+        const a = objectField_1.createObjectState({
             books: {
                 type: "list",
                 config: {
-                    title: { type: "value", rules: [formState_1.required] },
+                    title: { type: "value", rules: [rules_1.required] },
                     isPublished: { type: "value", isReadOnlyKey: true },
                 },
             },
@@ -850,7 +851,7 @@ describe("formState", () => {
         expect(config).toBeDefined();
     });
     it("can reset observable objects with computeds", () => {
-        const formState = formState_1.createObjectState({
+        const formState = objectField_1.createObjectState({
             firstName: { type: "value" },
             lastName: { type: "value" },
             fullName: { type: "value", computed: true },
@@ -863,7 +864,7 @@ describe("formState", () => {
         expect(formState.firstName.value).toEqual("first");
     });
     it("can set computeds that have setters", () => {
-        const formState = formState_1.createObjectState({
+        const formState = objectField_1.createObjectState({
             firstName: { type: "value" },
             lastName: { type: "value" },
             fullName: { type: "value", computed: true },
@@ -876,7 +877,7 @@ describe("formState", () => {
         expect(formState.firstName.value).toEqual("first");
     });
     it("can mark fields as read only", () => {
-        const formState = formState_1.createObjectState({
+        const formState = objectField_1.createObjectState({
             firstName: { type: "value" },
             lastName: { type: "value" },
             fullName: { type: "value", readOnly: true },
@@ -889,7 +890,7 @@ describe("formState", () => {
         expect(formState.firstName.value).toEqual("first");
     });
     it("lets rules validate against other fields", () => {
-        const formState = formState_1.createObjectState({
+        const formState = objectField_1.createObjectState({
             firstName: { type: "value", rules: [] },
             lastName: {
                 type: "value",
@@ -908,7 +909,7 @@ describe("formState", () => {
     });
     it("can return only changed primitive fields", () => {
         // Given an author
-        const formState = formState_1.createObjectState(authorWithBooksConfig, {
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, {
             id: "a:1",
             firstName: "f",
             lastName: "l",
@@ -926,7 +927,7 @@ describe("formState", () => {
     });
     it("can return only changed object fields", () => {
         // Given an author with an address object
-        const formState = formState_1.createObjectState(authorWithAddressConfig, {
+        const formState = objectField_1.createObjectState(authorWithAddressConfig, {
             id: "a:1",
             firstName: "f",
             address: { city: "c1", street: "s1" },
@@ -943,7 +944,7 @@ describe("formState", () => {
     });
     it("changedValue skips empty nested fields", () => {
         // Given a new author with an address object
-        const formState = formState_1.createObjectState(authorWithAddressConfig, {
+        const formState = objectField_1.createObjectState(authorWithAddressConfig, {
             firstName: "f",
             // And nothing is in the address
             address: {},
@@ -954,7 +955,7 @@ describe("formState", () => {
     });
     it("changedValue skips effectively empty nested fields", () => {
         // Given a new author with an address object
-        const formState = formState_1.createObjectState(authorWithAddressConfig, {
+        const formState = objectField_1.createObjectState(authorWithAddressConfig, {
             firstName: "f",
             // And only undefined keys are in the address
             address: { city: undefined },
@@ -965,7 +966,7 @@ describe("formState", () => {
     });
     it("can return only changed list fields", () => {
         // Given an author with some books
-        const formState = formState_1.createObjectState(authorWithBooksConfig, {
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, {
             id: "a:1",
             firstName: "f",
             books: [
@@ -986,7 +987,7 @@ describe("formState", () => {
     });
     it("can return only changed but incremental list fields", () => {
         // Given an author
-        const formState = formState_1.createObjectState({
+        const formState = objectField_1.createObjectState({
             id: { type: "value" },
             // And the books collection is marked as incremental (i.e. line items)
             books: {
@@ -994,7 +995,7 @@ describe("formState", () => {
                 update: "incremental",
                 config: {
                     id: { type: "value" },
-                    title: { type: "value", rules: [formState_1.required] },
+                    title: { type: "value", rules: [rules_1.required] },
                 },
             },
         }, {
@@ -1017,14 +1018,14 @@ describe("formState", () => {
     });
     it("uses the op key as a hint to use incremental list behavior", () => {
         // Given an author
-        const formState = formState_1.createObjectState({
+        const formState = objectField_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] },
+                    title: { type: "value", rules: [rules_1.required] },
                     // But it does have an op key
                     op: { type: "value" },
                 },
@@ -1050,14 +1051,14 @@ describe("formState", () => {
     });
     it("defaults the incremental op key to included when not set", () => {
         // Given an author
-        const formState = formState_1.createObjectState({
+        const formState = objectField_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] },
+                    title: { type: "value", rules: [rules_1.required] },
                     // But it does have an op key
                     op: { type: "value" },
                 },
@@ -1091,7 +1092,7 @@ describe("formState", () => {
         });
     });
     it("can observe value changes", () => {
-        const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f" });
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, { firstName: "f" });
         let ticks = 0;
         mobx_1.reaction(() => formState.value, () => ticks++, { equals: () => false });
         expect(ticks).toEqual(0);
@@ -1101,7 +1102,7 @@ describe("formState", () => {
         expect(ticks).toEqual(1);
     });
     it("does not override a focused, changed field", () => {
-        const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
         // Given first name is focused
         formState.firstName.focus();
         // And they have wip edits
@@ -1116,7 +1117,7 @@ describe("formState", () => {
         expect(formState.firstName.value).toEqual("fff");
     });
     it("does update a focused, unchanged field", () => {
-        const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
         // Given first name is focused, but has not changed
         formState.firstName.focus();
         // When a mutation result sets both firstName and lastName
@@ -1125,7 +1126,7 @@ describe("formState", () => {
         expect(formState.firstName.value).toEqual("f2");
     });
     it("trims string values on blur", () => {
-        const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
         // Given the user is typing with spaces
         formState.firstName.focus();
         formState.firstName.set("f ");
@@ -1137,7 +1138,7 @@ describe("formState", () => {
         expect(formState.firstName.value).toEqual("f");
     });
     it("trims string values on maybeAutoSave", () => {
-        const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
         // Given the user is typing with spaces
         formState.firstName.focus();
         formState.firstName.set("f ");
@@ -1151,7 +1152,7 @@ describe("formState", () => {
         expect(formState.firstName.touched).toEqual(true);
     });
     it("trims empty values to undefined on blur", () => {
-        const formState = formState_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, { firstName: "f", lastName: "l" });
         // Given the user is typing with only spaces
         formState.firstName.focus();
         formState.firstName.set(" ");
@@ -1169,7 +1170,7 @@ describe("formState", () => {
     });
     it("can work with both required inputs and optional fields", () => {
         // And we drop it in a form.
-        const form = formState_1.createObjectState({
+        const form = objectField_1.createObjectState({
             id: { type: "value" },
             firstName: { type: "value" },
         }, { id: "a:1" });
@@ -1190,7 +1191,7 @@ describe("formState", () => {
     });
     it("can have child object states passed in as field states", () => {
         // Given an author
-        const a = formState_1.createObjectState({
+        const a = objectField_1.createObjectState({
             id: { type: "value" },
             // And address is modeled as a value object
             address: { type: "value" },
@@ -1207,7 +1208,7 @@ describe("formState", () => {
     });
     it("provides isNewEntity", () => {
         // Given an author without an id
-        const formState = formState_1.createObjectState(authorWithAddressConfig, {
+        const formState = objectField_1.createObjectState(authorWithAddressConfig, {
             firstName: "f",
             address: { city: "c1", street: "s1" },
         });
@@ -1222,7 +1223,7 @@ describe("formState", () => {
     });
     it("isNewEntity is false if there is no id field", () => {
         // Given an author without an id field defined
-        const formState = formState_1.createObjectState({
+        const formState = objectField_1.createObjectState({
             firstName: { type: "value" },
             address: { type: "object", config: { street: { type: "value" } } },
         }, {});
@@ -1232,7 +1233,7 @@ describe("formState", () => {
     });
     it("provides isNewEntity for lists", () => {
         // Given an author & books without an id
-        const formState = formState_1.createObjectState(authorWithBooksConfig, {
+        const formState = objectField_1.createObjectState(authorWithBooksConfig, {
             books: [{ title: "t1" }, { title: "t2" }],
         });
         // Then both books know they are new
@@ -1300,13 +1301,13 @@ const authorWithBooksConfig = {
         type: "list",
         config: {
             id: { type: "value" },
-            title: { type: "value", rules: [formState_1.required] },
+            title: { type: "value", rules: [rules_1.required] },
             classification: { type: "value" },
         },
     },
 };
 function createAuthorInputState(input, maybeAutoSave) {
-    return formState_1.createObjectState(authorWithBooksConfig, input, { maybeAutoSave });
+    return objectField_1.createObjectState(authorWithBooksConfig, input, { maybeAutoSave });
 }
 const authorWithAddressConfig = {
     id: { type: "value" },
@@ -1315,7 +1316,7 @@ const authorWithAddressConfig = {
     address: {
         type: "object",
         config: {
-            street: { type: "value", rules: [formState_1.required] },
+            street: { type: "value", rules: [rules_1.required] },
             city: { type: "value" },
         },
     },
@@ -1328,7 +1329,7 @@ const authorWithAddressAndBooksConfig = {
         type: "object",
         config: {
             id: { type: "value" },
-            street: { type: "value", rules: [formState_1.required] },
+            street: { type: "value", rules: [rules_1.required] },
             city: { type: "value" },
         },
     },
@@ -1336,11 +1337,11 @@ const authorWithAddressAndBooksConfig = {
         type: "list",
         config: {
             id: { type: "value" },
-            title: { type: "value", rules: [formState_1.required] },
+            title: { type: "value", rules: [rules_1.required] },
             classification: { type: "value" },
         },
     },
 };
 function createAuthorWithAddressInputState(input) {
-    return formState_1.createObjectState(authorWithAddressConfig, input);
+    return objectField_1.createObjectState(authorWithAddressConfig, input);
 }

package/dist/index.d.ts

@@ -1,3 +1,7 @@
-export { createObjectState, FieldState, ListFieldState, ObjectConfig, ObjectState, required, Rule, } from "./formState";
+export { ObjectConfig } from "./config";
+export { ListFieldState } from "./fields/listField";
+export { createObjectState, ObjectState } from "./fields/objectField";
+export { FieldState } from "./fields/valueField";
+export { required, Rule } from "./rules";
 export { useFormState } from "./useFormState";
 export { useFormStates } from "./useFormStates";

package/dist/index.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.useFormStates = exports.useFormState = exports.required = exports.createObjectState = void 0;
-var formState_1 = require("./formState");
-Object.defineProperty(exports, "createObjectState", { enumerable: true, get: function () { return formState_1.createObjectState; } });
-Object.defineProperty(exports, "required", { enumerable: true, get: function () { return formState_1.required; } });
+var objectField_1 = require("./fields/objectField");
+Object.defineProperty(exports, "createObjectState", { enumerable: true, get: function () { return objectField_1.createObjectState; } });
+var rules_1 = require("./rules");
+Object.defineProperty(exports, "required", { enumerable: true, get: function () { return rules_1.required; } });
 var useFormState_1 = require("./useFormState");
 Object.defineProperty(exports, "useFormState", { enumerable: true, get: function () { return useFormState_1.useFormState; } });
 var useFormStates_1 = require("./useFormStates");

package/dist/rules.d.ts

@@ -0,0 +1,14 @@
+import { ObjectState } from "./fields/objectField";
+declare type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
+/** A validation rule, given the value and name, return the error string if valid, or undefined if valid. */
+export declare type Rule<T, V> = (opts: {
+    value: V;
+    key: string;
+    originalValue: V;
+    object: IfAny<T, any, ObjectState<T>>;
+}) => string | undefined;
+/** A rule that validates `value` is not `undefined`, `null`, or empty string. */
+export declare const required: <V>({ value: v }: {
+    value: V;
+}) => string | undefined;
+export {};