@formisch/solid 0.9.5 → 0.10.0

package/README.md

@@ -59,7 +59,13 @@ In addition, Formisch offers several functions (we call them "methods") that can
 
 ## Comparison
 
-What makes Formisch unique is its framework-agnostic core, which is fully native to the framework you are using. It works by inserting framework-specific reactivity blocks when the core package is built. The result is a small bundle size and native performance for any UI update. This feature, along with a few others, distinguishes Formisch from other form libraries. My vision for Formisch is to create a framework-agnostic platform similar to [Vite](https://vite.dev/), but for forms.
+What makes Formisch unique is its framework-agnostic core, which is fully native to the framework you are using. It works by inserting framework-specific reactivity blocks when the core package is built, giving you native performance for any UI update. A modular methods API keeps bundles starting at just ~2.5 kB by only including the methods you import, and end-to-end type safety covers deeply nested paths and field arrays with TypeScript inference that stays fast even as forms grow.
+
+For a side-by-side look at how Formisch compares to Felte and TanStack Form, see the [comparison guide](https://formisch.dev/solid/guides/comparison/).
+
+## Vision
+
+My vision for Formisch is to create a framework-agnostic platform similar to [Vite](https://vite.dev/), but for forms — a shared core that lets the same mental model and codebase work natively across every modern UI framework.
 
 ## Partners
 

package/dist/dev.js

@@ -64,7 +64,7 @@ function initializeFieldStore(internalFieldStore, schema, initialInput, path, nu
       if (internalFieldStore.kind === "object") {
         internalFieldStore.children ??= {};
         for (const key in schema.entries) {
-          internalFieldStore.children[key] = {};
+          internalFieldStore.children[key] ??= {};
           path.push(key);
           initializeFieldStore(internalFieldStore.children[key], schema.entries[key], initialInput?.[key], path);
           path.pop();
@@ -75,6 +75,7 @@ function initializeFieldStore(internalFieldStore, schema, initialInput, path, nu
         internalFieldStore.input = /* @__PURE__ */ createSignal(objectInput);
       }
     } else {
+      if (internalFieldStore.kind && internalFieldStore.kind !== "value") throw new Error(`Store initialized as "${internalFieldStore.kind}" cannot be reinitialized as "value"`);
       internalFieldStore.kind = "value";
       if (internalFieldStore.kind === "value") {
         internalFieldStore.initialInput = /* @__PURE__ */ createSignal(initialInput);
@@ -192,6 +193,43 @@ function swapItemState(firstInternalFieldStore, secondInternalFieldStore) {
   });
 }
 // @__NO_SIDE_EFFECTS__
+function getFieldBool(internalFieldStore, type) {
+  if (internalFieldStore[type].value) return true;
+  if (internalFieldStore.kind === "array") {
+    for (let index = 0; index < internalFieldStore.items.value.length; index++) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[index], type)) return true;
+    return false;
+  }
+  if (internalFieldStore.kind == "object") {
+    for (const key in internalFieldStore.children) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[key], type)) return true;
+    return false;
+  }
+  return false;
+}
+// @__NO_SIDE_EFFECTS__
+function getDirtyFieldInput(internalFieldStore, dirtyOnly = true) {
+  if (dirtyOnly && !/* @__PURE__ */ getFieldBool(internalFieldStore, "isDirty")) return;
+  if (internalFieldStore.kind === "array") {
+    if (internalFieldStore.input.value) {
+      const value = [];
+      for (let index = 0; index < internalFieldStore.items.value.length; index++) value[index] = /* @__PURE__ */ getDirtyFieldInput(internalFieldStore.children[index], false);
+      return value;
+    }
+    return internalFieldStore.input.value;
+  }
+  if (internalFieldStore.kind === "object") {
+    if (internalFieldStore.input.value) {
+      const value = {};
+      for (const key in internalFieldStore.children) {
+        const child = internalFieldStore.children[key];
+        if (!dirtyOnly || /* @__PURE__ */ getFieldBool(child, "isDirty")) value[key] = /* @__PURE__ */ getDirtyFieldInput(child, dirtyOnly);
+      }
+      return value;
+    }
+    return internalFieldStore.input.value;
+  }
+  return internalFieldStore.input.value;
+}
+// @__NO_SIDE_EFFECTS__
 function getFieldInput(internalFieldStore) {
   if (internalFieldStore.kind === "array") {
     if (internalFieldStore.input.value) {
@@ -230,19 +268,6 @@ function getElementInput(element, internalFieldStore) {
   return element.value;
 }
 // @__NO_SIDE_EFFECTS__
-function getFieldBool(internalFieldStore, type) {
-  if (internalFieldStore[type].value) return true;
-  if (internalFieldStore.kind === "array") {
-    for (let index = 0; index < internalFieldStore.items.value.length; index++) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[index], type)) return true;
-    return false;
-  }
-  if (internalFieldStore.kind == "object") {
-    for (const key in internalFieldStore.children) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[key], type)) return true;
-    return false;
-  }
-  return false;
-}
-// @__NO_SIDE_EFFECTS__
 function getFieldStore(internalFormStore, path) {
   let internalFieldStore = internalFormStore;
   for (const key of path) internalFieldStore = internalFieldStore.children[key];
@@ -402,6 +427,17 @@ function getAllErrors(form) {
   return allErrors;
 }
 // @__NO_SIDE_EFFECTS__
+function getDirtyInput(form, config) {
+  return getDirtyFieldInput(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL]);
+}
+// @__NO_SIDE_EFFECTS__
+function getDirtyPaths(form, config) {
+  config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL];
+  const paths = [];
+  config?.path && [...config.path];
+  return paths;
+}
+// @__NO_SIDE_EFFECTS__
 function getErrors(form, config) {
   return (config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL]).errors.value;
 }
@@ -480,6 +516,24 @@ function move(form, config) {
     validateIfRequired(internalFormStore, internalArrayStore, "input");
   });
 }
+// @__NO_SIDE_EFFECTS__
+function pickDirty(form, config) {
+  if (!getFieldBool(form[INTERNAL], "isDirty")) return;
+  const result = /* @__PURE__ */ pickFieldValue(form[INTERNAL], config.from);
+  return Object.keys(result).length ? result : void 0;
+}
+// @__NO_SIDE_EFFECTS__
+function pickFieldValue(internalFieldStore, value) {
+  if (internalFieldStore.kind === "object" && internalFieldStore.input.value && value && typeof value === "object" && !Array.isArray(value)) {
+    const result = {};
+    for (const key in internalFieldStore.children) {
+      const child = internalFieldStore.children[key];
+      if (getFieldBool(child, "isDirty") && key in value) result[key] = /* @__PURE__ */ pickFieldValue(child, value[key]);
+    }
+    return result;
+  }
+  return value;
+}
 function remove(form, config) {
   const internalFormStore = form[INTERNAL];
   const internalArrayStore = getFieldStore(internalFormStore, config.path);
@@ -513,7 +567,7 @@ function reset(form, config) {
     untrack(() => {
       const internalFormStore = form[INTERNAL];
       const internalFieldStore = config?.path ? getFieldStore(internalFormStore, config.path) : internalFormStore;
-      if (config?.initialInput) setInitialFieldInput(internalFieldStore, config.initialInput);
+      if (config && "initialInput" in config) setInitialFieldInput(internalFieldStore, config.initialInput);
       walkFieldStore(internalFieldStore, (internalFieldStore$1) => {
         internalFieldStore$1.elements = internalFieldStore$1.initialElements;
         if (!config?.keepErrors) internalFieldStore$1.errors.value = null;
@@ -789,4 +843,4 @@ function Form(props) {
   })();
 }
 
-export { Field, FieldArray, Form, createForm, focus, getAllErrors, getErrors, getInput, handleSubmit, insert, move, remove, replace, reset, setErrors, setInput, submit, swap, useField, useFieldArray, validate };
+export { Field, FieldArray, Form, createForm, focus, getAllErrors, getDirtyInput, getDirtyPaths, getErrors, getInput, handleSubmit, insert, move, pickDirty, remove, replace, reset, setErrors, setInput, submit, swap, useField, useFieldArray, validate };

package/dist/dev.jsx

@@ -62,7 +62,7 @@ function initializeFieldStore(internalFieldStore, schema, initialInput, path, nu
       if (internalFieldStore.kind === "object") {
         internalFieldStore.children ??= {};
         for (const key in schema.entries) {
-          internalFieldStore.children[key] = {};
+          internalFieldStore.children[key] ??= {};
           path.push(key);
           initializeFieldStore(internalFieldStore.children[key], schema.entries[key], initialInput?.[key], path);
           path.pop();
@@ -73,6 +73,7 @@ function initializeFieldStore(internalFieldStore, schema, initialInput, path, nu
         internalFieldStore.input = /* @__PURE__ */ createSignal(objectInput);
       }
     } else {
+      if (internalFieldStore.kind && internalFieldStore.kind !== "value") throw new Error(`Store initialized as "${internalFieldStore.kind}" cannot be reinitialized as "value"`);
       internalFieldStore.kind = "value";
       if (internalFieldStore.kind === "value") {
         internalFieldStore.initialInput = /* @__PURE__ */ createSignal(initialInput);
@@ -190,6 +191,43 @@ function swapItemState(firstInternalFieldStore, secondInternalFieldStore) {
   });
 }
 // @__NO_SIDE_EFFECTS__
+function getFieldBool(internalFieldStore, type) {
+  if (internalFieldStore[type].value) return true;
+  if (internalFieldStore.kind === "array") {
+    for (let index = 0; index < internalFieldStore.items.value.length; index++) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[index], type)) return true;
+    return false;
+  }
+  if (internalFieldStore.kind == "object") {
+    for (const key in internalFieldStore.children) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[key], type)) return true;
+    return false;
+  }
+  return false;
+}
+// @__NO_SIDE_EFFECTS__
+function getDirtyFieldInput(internalFieldStore, dirtyOnly = true) {
+  if (dirtyOnly && !/* @__PURE__ */ getFieldBool(internalFieldStore, "isDirty")) return;
+  if (internalFieldStore.kind === "array") {
+    if (internalFieldStore.input.value) {
+      const value = [];
+      for (let index = 0; index < internalFieldStore.items.value.length; index++) value[index] = /* @__PURE__ */ getDirtyFieldInput(internalFieldStore.children[index], false);
+      return value;
+    }
+    return internalFieldStore.input.value;
+  }
+  if (internalFieldStore.kind === "object") {
+    if (internalFieldStore.input.value) {
+      const value = {};
+      for (const key in internalFieldStore.children) {
+        const child = internalFieldStore.children[key];
+        if (!dirtyOnly || /* @__PURE__ */ getFieldBool(child, "isDirty")) value[key] = /* @__PURE__ */ getDirtyFieldInput(child, dirtyOnly);
+      }
+      return value;
+    }
+    return internalFieldStore.input.value;
+  }
+  return internalFieldStore.input.value;
+}
+// @__NO_SIDE_EFFECTS__
 function getFieldInput(internalFieldStore) {
   if (internalFieldStore.kind === "array") {
     if (internalFieldStore.input.value) {
@@ -228,19 +266,6 @@ function getElementInput(element, internalFieldStore) {
   return element.value;
 }
 // @__NO_SIDE_EFFECTS__
-function getFieldBool(internalFieldStore, type) {
-  if (internalFieldStore[type].value) return true;
-  if (internalFieldStore.kind === "array") {
-    for (let index = 0; index < internalFieldStore.items.value.length; index++) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[index], type)) return true;
-    return false;
-  }
-  if (internalFieldStore.kind == "object") {
-    for (const key in internalFieldStore.children) if (/* @__PURE__ */ getFieldBool(internalFieldStore.children[key], type)) return true;
-    return false;
-  }
-  return false;
-}
-// @__NO_SIDE_EFFECTS__
 function getFieldStore(internalFormStore, path) {
   let internalFieldStore = internalFormStore;
   for (const key of path) internalFieldStore = internalFieldStore.children[key];
@@ -400,6 +425,17 @@ function getAllErrors(form) {
   return allErrors;
 }
 // @__NO_SIDE_EFFECTS__
+function getDirtyInput(form, config) {
+  return getDirtyFieldInput(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL]);
+}
+// @__NO_SIDE_EFFECTS__
+function getDirtyPaths(form, config) {
+  config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL];
+  const paths = [];
+  config?.path && [...config.path];
+  return paths;
+}
+// @__NO_SIDE_EFFECTS__
 function getErrors(form, config) {
   return (config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL]).errors.value;
 }
@@ -478,6 +514,24 @@ function move(form, config) {
     validateIfRequired(internalFormStore, internalArrayStore, "input");
   });
 }
+// @__NO_SIDE_EFFECTS__
+function pickDirty(form, config) {
+  if (!getFieldBool(form[INTERNAL], "isDirty")) return;
+  const result = /* @__PURE__ */ pickFieldValue(form[INTERNAL], config.from);
+  return Object.keys(result).length ? result : void 0;
+}
+// @__NO_SIDE_EFFECTS__
+function pickFieldValue(internalFieldStore, value) {
+  if (internalFieldStore.kind === "object" && internalFieldStore.input.value && value && typeof value === "object" && !Array.isArray(value)) {
+    const result = {};
+    for (const key in internalFieldStore.children) {
+      const child = internalFieldStore.children[key];
+      if (getFieldBool(child, "isDirty") && key in value) result[key] = /* @__PURE__ */ pickFieldValue(child, value[key]);
+    }
+    return result;
+  }
+  return value;
+}
 function remove(form, config) {
   const internalFormStore = form[INTERNAL];
   const internalArrayStore = getFieldStore(internalFormStore, config.path);
@@ -511,7 +565,7 @@ function reset(form, config) {
     untrack(() => {
       const internalFormStore = form[INTERNAL];
       const internalFieldStore = config?.path ? getFieldStore(internalFormStore, config.path) : internalFormStore;
-      if (config?.initialInput) setInitialFieldInput(internalFieldStore, config.initialInput);
+      if (config && "initialInput" in config) setInitialFieldInput(internalFieldStore, config.initialInput);
       walkFieldStore(internalFieldStore, (internalFieldStore$1) => {
         internalFieldStore$1.elements = internalFieldStore$1.initialElements;
         if (!config?.keepErrors) internalFieldStore$1.errors.value = null;
@@ -806,11 +860,14 @@ export {
   createForm,
   focus,
   getAllErrors,
+  getDirtyInput,
+  getDirtyPaths,
   getErrors,
   getInput,
   handleSubmit,
   insert,
   move,
+  pickDirty,
   remove,
   replace,
   reset,