@homebound/form-state 2.26.4 → 2.26.5

package/README.md

@@ -23,6 +23,10 @@ It also keeps track of low-level form UX details like:
   - Supports collections of children, i.e. a `author: { books: [...} }` will include only changed books if necessary
   - Child collections can be either exhaustive (if any child changes, submit them all) or incremental (only include changed children), to match the backend endpoint's semantics
 
+# Basic Usage
+
+See our in-repo [sample app](https://github.com/homebound-team/form-state/blob/main/src/FormStateApp.tsx).
+
 # Main Features
 
 There are two main reasons why form-state exists:
@@ -90,19 +94,7 @@ Admittedly (and hopefully, b/c it makes the code simpler), the differences betwe
 
 These are usually simple/mechanistic changes, but nonetheless just some boilerplate that form-state provides conventions for.
 
-# Basic Usage
-
-See the [sample](https://github.com/homebound-team/form-state/blob/main/src/FormStateApp.tsx).
-
-# Todo
-
-- Add conditional readonly logic, like `{ type: "field", readOnlyIf: i => i.isInternal.value }`
-
-- Add `omitFromValue` so we can have two fields, `book.author.id` / `book.author.name`, where `book.author.name` is used for showing the author name, but `book.author.id` is the only field that is submitted to the server on mutation (maybe pair this with `Ref` based mutations)
-
-- Undo/redo would in theory be neat and easy to do on top of the existing infra
-
-# Features
+# Other Features
 
 ## Incremental changedValue/dirty Management
 
@@ -211,6 +203,14 @@ const form = useFormState({
 });
 ```
 
+# Todo
+
+- Add conditional readonly logic, like `{ type: "field", readOnlyIf: i => i.isInternal.value }`
+
+- Add `omitFromValue` so we can have two fields, `book.author.id` / `book.author.name`, where `book.author.name` is used for showing the author name, but `book.author.id` is the only field that is submitted to the server on mutation (maybe pair this with `Ref` based mutations)
+
+- Undo/redo would in theory be neat and easy to do on top of the existing infra
+
 # Internal Implementation Notes
 
 form-state keeps the "actual data" (basically a POJO of your form data) separate from the "mobx proxies that track reactivity" (the `ObjectState` interface with `.get` / `.set` / `.errors` other methods).

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export { f } from "./configBuilders";
 export { type FragmentField } from "./fields/fragmentField";
 export { type ListFieldState } from "./fields/listField";
-export { createObjectState, type Fragment, type ObjectState, type fragment } from "./fields/objectField";
+export { createObjectState, type Fragment, type ObjectState, fragment } from "./fields/objectField";
 export { type FieldState, type ValueAdapter } from "./fields/valueField";
 export { required, type Rule } from "./rules";
 export { useFormState } from "./useFormState";

package/dist/index.js

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

package/package.json

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