@homebound/form-state 2.7.1 → 2.8.0

package/dist/useFormStates.d.ts

@@ -23,19 +23,19 @@ declare type UseFormStatesOpts<T, I> = {
      */
     addRules?: (state: ObjectState<T>) => void;
     /**
-     * Given an input to `getObjectState`, returns the identity value that we'll cache that value's form state on.
+     * Given an input to `getFormState`, returns the identity value that we'll cache that value's form state on.
      *
      * Does not need to be stable/useMemo'd.
      */
     getId: (v: I) => string;
     /**
-     * Maps an input to `getObjectState` to the actual form shape `T`.
+     * Maps an input to `getFormState` to the actual form shape `T`.
      *
      * Does not need to be stable/useMemo'd.
      */
     map?: (input: Exclude<I, null | undefined>) => T;
 };
 export declare function useFormStates<T, I>(opts: UseFormStatesOpts<T, I>): {
-    getObjectState: (input: I) => ObjectState<T>;
+    getFormState: (input: I) => ObjectState<T>;
 };
 export {};

package/dist/useFormStates.js

@@ -33,7 +33,7 @@ function useFormStates(opts) {
             }
         }
     }
-    const getObjectState = react_1.useCallback((input) => {
+    const getFormState = react_1.useCallback((input) => {
         const existing = objectStateCache[getId(input)];
         let form = existing === null || existing === void 0 ? void 0 : existing[0];
         // If it didn't exist, then add to the cache.
@@ -56,7 +56,7 @@ function useFormStates(opts) {
     // Allow the user to not stable-ize getId, map, addRules, and autoSave
     // eslint-disable-next-line react-hooks/exhaustive-deps
     [objectStateCache, config]);
-    return { getObjectState };
+    return { getFormState };
 }
 exports.useFormStates = useFormStates;
 // If the user's autoSave hook makes some last-minute `.set` calls to sneak

package/dist/useFormStates.test.js

@@ -14,12 +14,12 @@ describe("useFormStates", () => {
         }
         function TestComponent() {
             const config = { id: { type: "value" }, firstName: { type: "value" } };
-            const { getObjectState } = useFormStates_1.useFormStates({
+            const { getFormState } = useFormStates_1.useFormStates({
                 config,
                 autoSave,
                 getId: (o) => o.id,
             });
-            return (jsx_runtime_1.jsx("div", { children: jsx_runtime_1.jsx(ChildComponent, { os: getObjectState({ id: "a:1", firstName: "Brandon" }) }, void 0) }, void 0));
+            return (jsx_runtime_1.jsx("div", { children: jsx_runtime_1.jsx(ChildComponent, { os: getFormState({ id: "a:1", firstName: "Brandon" }) }, void 0) }, void 0));
         }
         const r = await rtl_utils_1.render(jsx_runtime_1.jsx(TestComponent, {}, void 0));
         // And the child component has defined state
@@ -28,13 +28,13 @@ describe("useFormStates", () => {
     it("can update existing object state from cache with new values", async () => {
         const autoSave = jest.fn();
         const config = { id: { type: "value" }, firstName: { type: "value" } };
-        // Given a component using `getObjectState` for lazily creating ObjectStates
+        // Given a component using `getFormState` for lazily creating ObjectStates
         function TestComponent() {
             const [apiData, setApiData] = react_1.useState({ id: "a:1", firstName: "Brandon" });
-            const { getObjectState } = useFormStates_1.useFormStates({ config, autoSave, getId: (o) => o.id });
+            const { getFormState } = useFormStates_1.useFormStates({ config, autoSave, getId: (o) => o.id });
             // Memoize an original for comparing the update against.
-            const originalState = react_1.useMemo(() => getObjectState(apiData), []);
-            const state = getObjectState(apiData);
+            const originalState = react_1.useMemo(() => getFormState(apiData), []);
+            const state = getFormState(apiData);
             return (jsx_runtime_1.jsxs("div", { children: [jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "firstName" }, { children: state.firstName.value }), void 0),
                     jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "statesEqual" }, { children: JSON.stringify(state === originalState) }), void 0),
                     jsx_runtime_1.jsx("button", { "data-testid": "updateApiData", onClick: () => setApiData((prevState) => ({ ...prevState, firstName: "Bob" })) }, void 0)] }, void 0));
@@ -57,13 +57,13 @@ describe("useFormStates", () => {
             firstName: { type: "value" },
             lastName: { type: "value" },
         };
-        // Given a component using `getObjectState` for lazily creating ObjectStates
+        // Given a component using `getFormState` for lazily creating ObjectStates
         function TestComponent() {
             const [apiData, setApiData] = react_1.useState({ id: "a:1", firstName: "Tony", lastName: "Stark" });
             const [apiData2, setApiData2] = react_1.useState({ id: "a:2", firstName: "Steve", lastName: "Rogers" });
-            const { getObjectState } = useFormStates_1.useFormStates({ config, autoSave, getId: (o) => o.id });
-            const state = getObjectState(apiData);
-            const state2 = getObjectState(apiData2);
+            const { getFormState } = useFormStates_1.useFormStates({ config, autoSave, getId: (o) => o.id });
+            const state = getFormState(apiData);
+            const state2 = getFormState(apiData2);
             async function autoSave(form) {
                 autoSaveStub(form.changedValue);
                 // Pretend to make an API call and update the local state
@@ -117,10 +117,10 @@ describe("useFormStates", () => {
         };
         function TestComponent() {
             const [config, setConfig] = react_1.useState(originalConfig);
-            const { getObjectState } = useFormStates_1.useFormStates({ config, autoSave, getId: (o) => o.id });
+            const { getFormState } = useFormStates_1.useFormStates({ config, autoSave, getId: (o) => o.id });
             // Memoize an original for comparing the update against.
-            const originalState = react_1.useMemo(() => getObjectState(apiData), []);
-            const state = getObjectState(apiData);
+            const originalState = react_1.useMemo(() => getFormState(apiData), []);
+            const state = getFormState(apiData);
             return (jsx_runtime_1.jsxs("div", { children: [jsx_runtime_1.jsx("div", Object.assign({ "data-testid": "statesEqual" }, { children: JSON.stringify(state === originalState) }), void 0),
                     jsx_runtime_1.jsx("button", { "data-testid": "updateConfig", onClick: () => setConfig(updatedConfig) }, void 0)] }, void 0));
         }
@@ -138,13 +138,13 @@ describe("useFormStates", () => {
         const addRules = jest.fn();
         function TestComponent() {
             const config = { id: { type: "value" }, firstName: { type: "value" } };
-            const { getObjectState } = useFormStates_1.useFormStates({
+            const { getFormState } = useFormStates_1.useFormStates({
                 config,
                 addRules,
                 getId: (o) => o.id,
             });
-            return (jsx_runtime_1.jsxs("div", { children: [jsx_runtime_1.jsx(ChildComponent, { os: getObjectState({ id: "a:1", firstName: "Brandon" }) }, void 0),
-                    jsx_runtime_1.jsx(ChildComponent, { os: getObjectState({ id: "a:1", firstName: "Brandon" }) }, void 0)] }, void 0));
+            return (jsx_runtime_1.jsxs("div", { children: [jsx_runtime_1.jsx(ChildComponent, { os: getFormState({ id: "a:1", firstName: "Brandon" }) }, void 0),
+                    jsx_runtime_1.jsx(ChildComponent, { os: getFormState({ id: "a:1", firstName: "Brandon" }) }, void 0)] }, void 0));
         }
         // When we render
         const r = await rtl_utils_1.render(jsx_runtime_1.jsx(TestComponent, {}, void 0));

package/package.json

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