@formisch/svelte 0.9.0 → 0.10.0

package/dist/methods/index.svelte.js

@@ -14,26 +14,31 @@ function focus(form, config) {
 }
 
 //#endregion
-//#region src/getAllErrors/getAllErrors.ts
-/**
-* Retrieves all error messages from all fields in the form by walking through
-* the entire field store tree. This is useful for displaying a summary of all
-* validation errors across the form.
-*
-* @param form The form store to retrieve errors from.
-*
-* @returns A non-empty array of error messages, or null if no errors exist.
-*/
+//#region src/getDeepErrorEntries/getDeepErrorEntries.ts
 /* @__NO_SIDE_EFFECTS__ */
-function getAllErrors(form) {
-	let allErrors = null;
-	walkFieldStore(form[INTERNAL], (internalFieldStore) => {
-		if (internalFieldStore.kind === "array") internalFieldStore.items.value;
+function getDeepErrorEntries(form, config) {
+	const entries = [];
+	walkFieldStore(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL], (internalFieldStore) => {
 		const errors = internalFieldStore.errors.value;
-		if (errors) if (allErrors) allErrors.push(...errors);
-		else allErrors = [...errors];
+		if (errors) entries.push({
+			path: internalFieldStore.path,
+			errors
+		});
 	});
-	return allErrors;
+	return entries;
+}
+
+//#endregion
+//#region src/getDeepErrors/getDeepErrors.ts
+/* @__NO_SIDE_EFFECTS__ */
+function getDeepErrors(form, config) {
+	let deepErrors = null;
+	walkFieldStore(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL], (internalFieldStore) => {
+		const errors = internalFieldStore.errors.value;
+		if (errors) if (deepErrors) deepErrors.push(...errors);
+		else deepErrors = [...errors];
+	});
+	return deepErrors;
 }
 
 //#endregion
@@ -47,9 +52,8 @@ function getDirtyInput(form, config) {
 //#region src/getDirtyPaths/getDirtyPaths.ts
 /* @__NO_SIDE_EFFECTS__ */
 function getDirtyPaths(form, config) {
-	config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL];
 	const paths = [];
-	config?.path && [...config.path];
+	config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL];
 	return paths;
 }
 
@@ -112,26 +116,51 @@ function insert(form, config) {
 		internalArrayStore.items.value = newItems;
 		for (let index = items.length; index > insertIndex; index--) {
 			if (!internalArrayStore.children[index]) {
-				const path = JSON.parse(internalArrayStore.name);
 				internalArrayStore.children[index] = {};
-				path.push(index);
-				initializeFieldStore(internalArrayStore.children[index], internalArrayStore.schema.item, void 0, path);
+				initializeFieldStore(internalArrayStore.children[index], internalArrayStore.schema.item, void 0, [...internalArrayStore.path, index]);
 			}
 			copyItemState(internalArrayStore.children[index - 1], internalArrayStore.children[index]);
 		}
 		if (!internalArrayStore.children[insertIndex]) {
-			const path = JSON.parse(internalArrayStore.name);
 			internalArrayStore.children[insertIndex] = {};
-			path.push(insertIndex);
-			initializeFieldStore(internalArrayStore.children[insertIndex], internalArrayStore.schema.item, config.initialInput, path);
+			initializeFieldStore(internalArrayStore.children[insertIndex], internalArrayStore.schema.item, config.initialInput, [...internalArrayStore.path, insertIndex]);
 		} else resetItemState(internalArrayStore.children[insertIndex], config.initialInput);
 		internalArrayStore.input.value = true;
 		internalArrayStore.isTouched.value = true;
+		internalArrayStore.isEdited.value = true;
 		internalArrayStore.isDirty.value = true;
 		validateIfRequired(internalFormStore, internalArrayStore, "input");
 	});
 }
 
+//#endregion
+//#region src/isDirty/isDirty.ts
+/* @__NO_SIDE_EFFECTS__ */
+function isDirty(form, config) {
+	return getFieldBool(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL], "isDirty");
+}
+
+//#endregion
+//#region src/isEdited/isEdited.ts
+/* @__NO_SIDE_EFFECTS__ */
+function isEdited(form, config) {
+	return getFieldBool(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL], "isEdited");
+}
+
+//#endregion
+//#region src/isTouched/isTouched.ts
+/* @__NO_SIDE_EFFECTS__ */
+function isTouched(form, config) {
+	return getFieldBool(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL], "isTouched");
+}
+
+//#endregion
+//#region src/isValid/isValid.ts
+/* @__NO_SIDE_EFFECTS__ */
+function isValid(form, config) {
+	return !getFieldBool(config?.path ? getFieldStore(form[INTERNAL], config.path) : form[INTERNAL], "errors");
+}
+
 //#endregion
 //#region src/move/move.ts
 /**
@@ -156,6 +185,7 @@ function move(form, config) {
 		else for (let index = config.from; index > config.to; index--) copyItemState(internalArrayStore.children[index - 1], internalArrayStore.children[index]);
 		copyItemState(tempInternalFieldStore, internalArrayStore.children[config.to]);
 		internalArrayStore.isTouched.value = true;
+		internalArrayStore.isEdited.value = true;
 		internalArrayStore.isDirty.value = internalArrayStore.startItems.value.join() !== newItems.join();
 		validateIfRequired(internalFormStore, internalArrayStore, "input");
 	});
@@ -225,6 +255,7 @@ function remove(form, config) {
 		internalArrayStore.items.value = newItems;
 		for (let index = config.at; index < items.length - 1; index++) copyItemState(internalArrayStore.children[index + 1], internalArrayStore.children[index]);
 		internalArrayStore.isTouched.value = true;
+		internalArrayStore.isEdited.value = true;
 		internalArrayStore.isDirty.value = internalArrayStore.startItems.value.join() !== newItems.join();
 		validateIfRequired(internalFormStore, internalArrayStore, "input");
 	});
@@ -248,6 +279,7 @@ function replace(form, config) {
 		internalArrayStore.items.value = newItems;
 		resetItemState(internalArrayStore.children[config.at], config.initialInput);
 		internalArrayStore.isTouched.value = true;
+		internalArrayStore.isEdited.value = true;
 		internalArrayStore.isDirty.value = true;
 		validateIfRequired(internalFormStore, internalArrayStore, "input");
 	});
@@ -265,6 +297,7 @@ function reset(form, config) {
 				internalFieldStore$1.elements = internalFieldStore$1.initialElements;
 				if (!config?.keepErrors) internalFieldStore$1.errors.value = null;
 				if (!config?.keepTouched) internalFieldStore$1.isTouched.value = false;
+				if (!config?.keepEdited) internalFieldStore$1.isEdited.value = false;
 				internalFieldStore$1.startInput.value = internalFieldStore$1.initialInput.value;
 				if (!config?.keepInput) internalFieldStore$1.input.value = internalFieldStore$1.initialInput.value;
 				if (internalFieldStore$1.kind === "array") {
@@ -335,6 +368,7 @@ function swap(form, config) {
 		internalArrayStore.items.value = newItems;
 		swapItemState(internalArrayStore.children[config.at], internalArrayStore.children[config.and]);
 		internalArrayStore.isTouched.value = true;
+		internalArrayStore.isEdited.value = true;
 		internalArrayStore.isDirty.value = internalArrayStore.startItems.value.join() !== newItems.join();
 		validateIfRequired(internalFormStore, internalArrayStore, "input");
 	});
@@ -357,4 +391,4 @@ function validate(form, config) {
 }
 
 //#endregion
-export { focus, getAllErrors, getDirtyInput, getDirtyPaths, getErrors, getInput, handleSubmit, insert, move, pickDirty, remove, replace, reset, setErrors, setInput, submit, swap, validate };
+export { focus, getDeepErrorEntries, getDeepErrors, getDirtyInput, getDirtyPaths, getErrors, getInput, handleSubmit, insert, isDirty, isEdited, isTouched, isValid, move, pickDirty, remove, replace, reset, setErrors, setInput, submit, swap, validate };

package/dist/runes/createForm/createForm.svelte.js

@@ -10,6 +10,7 @@ export function createForm(config) {
         }
     });
     const isTouched = $derived(getFieldBool(internalFormStore, 'isTouched'));
+    const isEdited = $derived(getFieldBool(internalFormStore, 'isEdited'));
     const isDirty = $derived(getFieldBool(internalFormStore, 'isDirty'));
     const isValid = $derived(!getFieldBool(internalFormStore, 'errors'));
     return {
@@ -26,6 +27,9 @@ export function createForm(config) {
         get isTouched() {
             return isTouched;
         },
+        get isEdited() {
+            return isEdited;
+        },
         get isDirty() {
             return isDirty;
         },

package/dist/runes/useField/useField.svelte.js

@@ -8,6 +8,7 @@ export function useField(form, config) {
     const internalFieldStore = $derived(getFieldStore(internalFormStore, path));
     const input = $derived(getFieldInput(internalFieldStore));
     const isTouched = $derived(getFieldBool(internalFieldStore, 'isTouched'));
+    const isEdited = $derived(getFieldBool(internalFieldStore, 'isEdited'));
     const isDirty = $derived(getFieldBool(internalFieldStore, 'isDirty'));
     const isValid = $derived(!getFieldBool(internalFieldStore, 'errors'));
     return {
@@ -23,6 +24,9 @@ export function useField(form, config) {
         get isTouched() {
             return isTouched;
         },
+        get isEdited() {
+            return isEdited;
+        },
         get isDirty() {
             return isDirty;
         },

package/dist/runes/useFieldArray/useFieldArray.svelte.js

@@ -5,6 +5,7 @@ export function useFieldArray(form, config) {
     const path = $derived(unwrap(config).path);
     const internalFieldStore = $derived(getFieldStore(unwrap(form)[INTERNAL], path));
     const isTouched = $derived(getFieldBool(internalFieldStore, 'isTouched'));
+    const isEdited = $derived(getFieldBool(internalFieldStore, 'isEdited'));
     const isDirty = $derived(getFieldBool(internalFieldStore, 'isDirty'));
     const isValid = $derived(!getFieldBool(internalFieldStore, 'errors'));
     return {
@@ -20,6 +21,9 @@ export function useFieldArray(form, config) {
         get isTouched() {
             return isTouched;
         },
+        get isEdited() {
+            return isEdited;
+        },
         get isDirty() {
             return isDirty;
         },

package/dist/types/field.d.ts

@@ -54,6 +54,10 @@ export interface FieldStore<TSchema extends FormSchema = FormSchema, TFieldPath
      * Whether the field has been touched.
      */
     readonly isTouched: boolean;
+    /**
+     * Whether the field value has been edited.
+     */
+    readonly isEdited: boolean;
     /**
      * Whether the field input differs from its initial value.
      */
@@ -91,6 +95,10 @@ export interface FieldArrayStore<TSchema extends FormSchema = FormSchema, TField
      * Whether the field array has been touched.
      */
     readonly isTouched: boolean;
+    /**
+     * Whether the field array value has been edited.
+     */
+    readonly isEdited: boolean;
     /**
      * Whether the field array input differs from its initial value.
      */

package/dist/types/form.d.ts

@@ -19,6 +19,10 @@ export interface FormStore<TSchema extends FormSchema = FormSchema> extends Base
      * Whether any field in the form has been touched.
      */
     readonly isTouched: boolean;
+    /**
+     * Whether any field in the form has been edited.
+     */
+    readonly isEdited: boolean;
     /**
      * Whether any field in the form differs from its initial value.
      */
@@ -31,7 +35,7 @@ export interface FormStore<TSchema extends FormSchema = FormSchema> extends Base
      * The current error messages of the form.
      *
      * Hint: This property only contains validation errors at the root level
-     * of the form. To get all errors from all fields, use `getAllErrors`.
+     * of the form. To get all errors from all fields, use `getDeepErrors`.
      */
     readonly errors: [string, ...string[]] | null;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formisch/svelte",
   "description": "The lightweight, schema-first, and fully type-safe form library for Svelte",
-  "version": "0.9.0",
+  "version": "0.10.0",
   "license": "MIT",
   "author": "Fabian Hiller",
   "homepage": "https://formisch.dev",