@formisch/preact 0.2.0 → 0.3.1

package/README.md

@@ -2,6 +2,8 @@
 
 Formisch is a schema-based, headless form library for Preact. It manages form state and validation. It is type-safe, fast by default and its bundle size is small due to its modular design. Try it out in our [playground](https://stackblitz.com/edit/formisch-playground-preact)!
 
+Formisch is also available for [Qwik][formisch-qwik], [SolidJS][formisch-solid], [Svelte][formisch-svelte] and [Vue][formisch-vue].
+
 ## Highlights
 
 - Small bundle size starting at 2.5 kB
@@ -55,6 +57,16 @@ export default function LoginPage() {
 
 In addition, Formisch offers several functions (we call them "methods") that can be used to read and manipulate the form state. These include `focus`, `getErrors`, `getAllErrors`, `getInput`, `insert`, `move`, `remove`, `replace`, `reset`, `setErrors`, `setInput`, `submit`, `swap` and `validate`. These methods allow you to control the form programmatically.
 
+## 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.
+
+## Partners
+
+Thanks to our partners who support the development! [Join them](https://github.com/sponsors/fabian-hiller) and contribute to the sustainability of open source software!
+
+![Partners of Formisch](https://github.com/fabian-hiller/formisch/blob/main/partners.webp?raw=true)
+
 ## Feedback
 
 Find a bug or have an idea how to improve the library? Please fill out an [issue](https://github.com/fabian-hiller/formisch/issues/new). Together we can make forms even better!
@@ -62,3 +74,8 @@ Find a bug or have an idea how to improve the library? Please fill out an [issue
 ## License
 
 This project is available free of charge and licensed under the [MIT license](https://github.com/fabian-hiller/formisch/blob/main/LICENSE.md).
+
+[formisch-qwik]: https://github.com/fabian-hiller/formisch/tree/main/frameworks/qwik
+[formisch-solid]: https://github.com/fabian-hiller/formisch/tree/main/frameworks/solid
+[formisch-svelte]: https://github.com/fabian-hiller/formisch/tree/main/frameworks/svelte
+[formisch-vue]: https://github.com/fabian-hiller/formisch/tree/main/frameworks/vue

package/dist/index.d.ts

@@ -93,7 +93,7 @@ interface InternalFormStore<TSchema extends Schema = Schema> extends InternalObj
 interface BaseFormStore<TSchema extends Schema = Schema> {
   [INTERNAL]: InternalFormStore<TSchema>;
 }
-type SubmitHandler<TSchema extends Schema> = (output: v.InferOutput<TSchema>, event: SubmitEvent) => MaybePromise<void>;
+type SubmitHandler<TSchema extends Schema> = (output: v.InferOutput<TSchema>, event: SubmitEvent) => MaybePromise<unknown>;
 //#endregion
 //#region src/types/path.d.ts
 /**
@@ -123,16 +123,16 @@ type MergeUnion<T> = { [K in KeyOf<T>]: T extends Record<K, infer V> ? V : never
 /**
 * Lazily evaluate only the first valid path segment based on the given value.
 */
-type LazyPath<TValue, TPathToCheck extends Path, TValidPath extends Path = readonly []> = TPathToCheck extends readonly [] ? TValidPath : TPathToCheck extends readonly [infer TFirstKey extends KeyOf<TValue>, ...infer TPathRest extends Path] ? LazyPath<MergeUnion<TValue>[TFirstKey], TPathRest, readonly [...TValidPath, TFirstKey]> : IsNever<KeyOf<TValue>> extends false ? readonly [...TValidPath, KeyOf<TValue>] : TValidPath;
+type LazyPath<TValue, TPathToCheck extends Path, TValidPath extends Path = readonly []> = TPathToCheck extends readonly [] ? TValidPath : TPathToCheck extends readonly [infer TFirstKey extends KeyOf<TValue>, ...infer TPathRest extends Path] ? LazyPath<Required<MergeUnion<TValue>[TFirstKey]>, TPathRest, readonly [...TValidPath, TFirstKey]> : IsNever<KeyOf<TValue>> extends false ? readonly [...TValidPath, KeyOf<TValue>] : TValidPath;
 /**
 * Returns the path if valid, otherwise the first possible valid path based on
 * the given value.
 */
-type ValidPath<TValue, TPath extends RequiredPath> = TPath extends LazyPath<TValue, TPath> ? TPath : LazyPath<TValue, TPath>;
+type ValidPath<TValue, TPath extends RequiredPath> = TPath extends LazyPath<Required<TValue>, TPath> ? TPath : LazyPath<Required<TValue>, TPath>;
 /**
 * Extracts the value type at the given path.
 */
-type PathValue<TValue, TPath extends Path> = TPath extends readonly [infer TKey, ...infer TRest extends Path] ? TKey extends KeyOf<TValue> ? PathValue<MergeUnion<TValue>[TKey], TRest> : unknown : TValue;
+type PathValue<TValue, TPath extends Path> = TPath extends readonly [infer TKey, ...infer TRest extends Path] ? TKey extends KeyOf<Required<TValue>> ? PathValue<MergeUnion<Required<TValue>>[TKey], TRest> : unknown : TValue;
 /**
 * Checks if a value is an array or contains one.
 */
@@ -140,16 +140,16 @@ type IsOrHasArray<TValue> = IsAny<TValue> extends true ? false : TValue extends
 /**
 * Extracts the exact keys of a tuple, array or object that contain arrays.
 */
-type KeyOfArrayPath<TValue> = IsAny<TValue> extends true ? never : TValue extends readonly (infer TItem)[] ? number extends TValue["length"] ? IsOrHasArray<TItem> extends true ? number : never : { [TKey in keyof TValue]: TKey extends `${infer TIndex extends number}` ? IsOrHasArray<TValue[TKey]> extends true ? TIndex : never : never }[number] : TValue extends Record<string, unknown> ? { [TKey in keyof TValue]: IsOrHasArray<TValue[TKey]> extends true ? TKey : never }[keyof TValue] & PathKey : never;
+type KeyOfArrayPath<TValue> = IsAny<TValue> extends true ? never : TValue extends readonly (infer TItem)[] ? number extends TValue["length"] ? IsOrHasArray<TItem> extends true ? number : never : { [TKey in keyof TValue]: TKey extends `${infer TIndex extends number}` ? IsOrHasArray<NonNullable<TValue[TKey]>> extends true ? TIndex : never : never }[number] : TValue extends Record<string, unknown> ? { [TKey in keyof TValue]: IsOrHasArray<NonNullable<TValue[TKey]>> extends true ? TKey : never }[keyof TValue] & PathKey : never;
 /**
 * Lazily evaluate only the first valid array path segment based on the given value.
 */
-type LazyArrayPath<TValue, TPathToCheck extends Path, TValidPath extends Path = readonly []> = TPathToCheck extends readonly [] ? TValue extends readonly unknown[] ? TValidPath : readonly [...TValidPath, KeyOfArrayPath<TValue>] : TPathToCheck extends readonly [infer TFirstKey extends KeyOfArrayPath<TValue>, ...infer TPathRest extends Path] ? LazyArrayPath<MergeUnion<TValue>[TFirstKey], TPathRest, readonly [...TValidPath, TFirstKey]> : IsNever<KeyOfArrayPath<TValue>> extends false ? readonly [...TValidPath, KeyOfArrayPath<TValue>] : never;
+type LazyArrayPath<TValue, TPathToCheck extends Path, TValidPath extends Path = readonly []> = TPathToCheck extends readonly [] ? TValue extends readonly unknown[] ? TValidPath : readonly [...TValidPath, KeyOfArrayPath<TValue>] : TPathToCheck extends readonly [infer TFirstKey extends KeyOfArrayPath<TValue>, ...infer TPathRest extends Path] ? LazyArrayPath<Required<MergeUnion<TValue>[TFirstKey]>, TPathRest, readonly [...TValidPath, TFirstKey]> : IsNever<KeyOfArrayPath<TValue>> extends false ? readonly [...TValidPath, KeyOfArrayPath<TValue>] : never;
 /**
 * Returns the path if valid, otherwise the first possible valid array path based on
 * the given value.
 */
-type ValidArrayPath<TValue, TPath extends RequiredPath> = TPath extends LazyArrayPath<TValue, TPath> ? TPath : LazyArrayPath<TValue, TPath>;
+type ValidArrayPath<TValue, TPath extends RequiredPath> = TPath extends LazyArrayPath<Required<TValue>, TPath> ? TPath : LazyArrayPath<Required<TValue>, TPath>;
 //#endregion
 //#region src/array/copyItemState/copyItemState.d.ts
 /**
@@ -372,7 +372,7 @@ declare function FieldArray<TSchema extends Schema, TFieldArrayPath extends Requ
 }: FieldArrayProps<TSchema, TFieldArrayPath>): JSX.Element;
 //#endregion
 //#region src/components/Form/Form.d.ts
-type FormProps<TSchema extends Schema = Schema> = Omit<JSX.FormHTMLAttributes<HTMLFormElement>, "onSubmit"> & {
+type FormProps<TSchema extends Schema = Schema> = Omit<JSX.FormHTMLAttributes<HTMLFormElement>, "onSubmit" | "novalidate" | "noValidate"> & {
   of: FormStore<TSchema>;
   onSubmit: SubmitHandler<TSchema>;
 };

package/dist/index.js

@@ -37,7 +37,7 @@ function initializeFieldStore(internalFieldStore, schema, initialInput, path) {
 				} else for (let index = 0; index < schema.items; index++) {
 					internalFieldStore.children[index] = {};
 					path.push(index);
-					initializeFieldStore(internalFieldStore.children[index], schema.items[index], initialInput && initialInput[index], path);
+					initializeFieldStore(internalFieldStore.children[index], schema.items[index], initialInput?.[index], path);
 					path.pop();
 				}
 				const initialItems = internalFieldStore.children.map(createId);
@@ -55,7 +55,7 @@ function initializeFieldStore(internalFieldStore, schema, initialInput, path) {
 				for (const key in schema.entries) {
 					internalFieldStore.children[key] = {};
 					path.push(key);
-					initializeFieldStore(internalFieldStore.children[key], schema.entries[key], initialInput && initialInput[key], path);
+					initializeFieldStore(internalFieldStore.children[key], schema.entries[key], initialInput?.[key], path);
 					path.pop();
 				}
 			}
@@ -275,25 +275,27 @@ function setFieldBool(internalFieldStore, type, bool) {
 function setFieldInput(internalFieldStore, input) {
 	batch(() => {
 		if (internalFieldStore.kind === "array") {
+			const arrayInput = input ?? [];
 			const items = untrack(() => internalFieldStore.items.value);
-			if (input.length < items.length) internalFieldStore.items.value = items.slice(0, input.length);
-			else if (input.length > items.length) {
-				if (input.length > internalFieldStore.children.length) {
+			if (arrayInput.length < items.length) internalFieldStore.items.value = items.slice(0, arrayInput.length);
+			else if (arrayInput.length > items.length) {
+				if (arrayInput.length > internalFieldStore.children.length) {
 					const path = JSON.parse(internalFieldStore.name);
-					for (let index = internalFieldStore.children.length; index < input.length; index++) {
+					for (let index = internalFieldStore.children.length; index < arrayInput.length; index++) {
 						internalFieldStore.children[index] = {};
 						path.push(index);
-						initializeFieldStore(internalFieldStore.children[index], internalFieldStore.schema.item, input[index], path);
+						initializeFieldStore(internalFieldStore.children[index], internalFieldStore.schema.item, arrayInput[index], path);
 						path.pop();
 					}
 				}
-				internalFieldStore.items.value = [...items, ...input.slice(items.length).map(createId)];
+				internalFieldStore.items.value = [...items, ...arrayInput.slice(items.length).map(createId)];
 			}
-			for (let index = 0; index < items.length; index++) setFieldInput(internalFieldStore.children[index], input[index]);
+			for (let index = 0; index < items.length; index++) setFieldInput(internalFieldStore.children[index], arrayInput[index]);
 			internalFieldStore.isDirty.value = untrack(() => internalFieldStore.startItems.value).length !== items.length;
-		} else if (internalFieldStore.kind === "object") for (const key in internalFieldStore.children) setFieldInput(internalFieldStore.children[key], input[key]);
+		} else if (internalFieldStore.kind === "object") for (const key in internalFieldStore.children) setFieldInput(internalFieldStore.children[key], input?.[key]);
 		else {
 			internalFieldStore.input.value = input;
+			internalFieldStore.isTouched.value = true;
 			const startInput = untrack(() => internalFieldStore.startInput.value);
 			internalFieldStore.isDirty.value = startInput !== input && (startInput !== void 0 || input !== "" && !Number.isNaN(input));
 		}
@@ -302,17 +304,18 @@ function setFieldInput(internalFieldStore, input) {
 function setInitialFieldInput(internalFieldStore, initialInput) {
 	batch(() => {
 		if (internalFieldStore.kind === "array") {
-			if (initialInput.length > internalFieldStore.children.length) {
+			const initialArrayInput = initialInput ?? [];
+			if (initialArrayInput.length > internalFieldStore.children.length) {
 				const path = JSON.parse(internalFieldStore.name);
-				for (let index = internalFieldStore.children.length; index < initialInput.length; index++) {
+				for (let index = internalFieldStore.children.length; index < initialArrayInput.length; index++) {
 					internalFieldStore.children[index] = {};
 					path.push(index);
-					initializeFieldStore(internalFieldStore.children[index], internalFieldStore.schema.item, initialInput[index], path);
+					initializeFieldStore(internalFieldStore.children[index], internalFieldStore.schema.item, initialArrayInput[index], path);
 					path.pop();
 				}
 			}
-			internalFieldStore.initialItems.value = initialInput.map(createId);
-			for (let index = 0; index < internalFieldStore.children.length; index++) setInitialFieldInput(internalFieldStore.children[index], initialInput?.[index]);
+			internalFieldStore.initialItems.value = initialArrayInput.map(createId);
+			for (let index = 0; index < internalFieldStore.children.length; index++) setInitialFieldInput(internalFieldStore.children[index], initialArrayInput[index]);
 		} else if (internalFieldStore.kind === "object") for (const key in internalFieldStore.children) setInitialFieldInput(internalFieldStore.children[key], initialInput?.[key]);
 		else internalFieldStore.initialInput.value = initialInput;
 	});
@@ -519,7 +522,6 @@ function setInput(form, config) {
 	batch(() => {
 		const internalFormStore = form[INTERNAL];
 		const internalFieldStore = config.path ? getFieldStore(internalFormStore, config.path) : internalFormStore;
-		setFieldBool(internalFieldStore, "isTouched", true);
 		setFieldInput(internalFieldStore, config.input);
 		validateIfRequired(internalFormStore, internalFieldStore, "input");
 	});
@@ -622,7 +624,7 @@ function useFieldArray(form, config) {
 //#region src/hooks/useForm/useForm.ts
 function useForm(config) {
 	const form = useMemo(() => {
-		const internalFormStore = createFormStore(config, async (input) => v.safeParseAsync(config.schema, input));
+		const internalFormStore = createFormStore(config, (input) => v.safeParseAsync(config.schema, input));
 		return {
 			[INTERNAL]: internalFormStore,
 			isSubmitting: internalFormStore.isSubmitting,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@formisch/preact",
   "description": "The modular and type-safe form library for Preact",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "license": "MIT",
   "author": "Fabian Hiller",
   "homepage": "https://formisch.dev",
@@ -32,17 +32,8 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsdown",
-    "lint": "eslint \"src/**/*.ts*\" && tsc --noEmit",
-    "lint.fix": "eslint \"src/**/*.ts*\" --fix",
-    "format": "prettier --write ./src",
-    "format.check": "prettier --check ./src"
-  },
   "devDependencies": {
     "@eslint/js": "^9.31.0",
-    "@formisch/core": "workspace:*",
-    "@formisch/methods": "workspace:*",
     "@preact/preset-vite": "^2.9.3",
     "@preact/signals": "^2.2.1",
     "eslint": "^9.31.0",
@@ -51,7 +42,9 @@
     "tsdown": "^0.12.9",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.37.0",
-    "vite": "^6.0.4"
+    "vite": "^6.0.4",
+    "@formisch/core": "0.3.1",
+    "@formisch/methods": "0.2.0"
   },
   "peerDependencies": {
     "@preact/signals": "^2.0.0",
@@ -63,5 +56,12 @@
     "typescript": {
       "optional": true
     }
+  },
+  "scripts": {
+    "build": "tsdown",
+    "lint": "eslint \"src/**/*.ts*\" && tsc --noEmit",
+    "lint.fix": "eslint \"src/**/*.ts*\" --fix",
+    "format": "prettier --write ./src",
+    "format.check": "prettier --check ./src"
   }
-}
+}