remove preflight method in favor of option, simplify factory

Author: sillvva

packages/kit/src/exports/public.d.ts

@@ -2039,8 +2039,6 @@ export type RemoteForm<Input extends RemoteFormInput | void, Output> = {
 		action: string;
 		[attachment: symbol]: (node: HTMLFormElement) => void;
 	};
-	/** Preflight checks */
-	preflight(schema: StandardSchemaV1<Input, any>): RemoteForm<Input, Output>;
 	/** Validate the form contents programmatically */
 	validate(options?: {
 		/** Set this to `true` to also show validation issues of fields that haven't been touched yet. */

packages/kit/src/runtime/app/server/remote/form.js

@@ -276,11 +276,6 @@ export function form(validate_or_fn, maybe_fn) {
 			get: () => 0
 		});
 
-		Object.defineProperty(instance, 'preflight', {
-			// preflight is a noop on the server
-			value: () => instance
-		});
-
 		Object.defineProperty(instance, 'validate', {
 			value: () => {
 				throw new Error('Cannot call validate() on the server');

packages/kit/src/runtime/client/remote-functions/form.svelte.js

@@ -55,14 +55,14 @@ export function form(id) {
 
 	/** @param {RemoteFormFactoryOptions<T>} options */
 	function create_instance(options) {
-		const { key, resetAfterSuccess = true } = options;
+		const { key, preflight, initialData, resetAfterSuccess = true } = options;
 		const action_id = id + (key !== undefined ? `/${JSON.stringify(key)}` : '');
 		const action = '?/remote=' + encodeURIComponent(action_id);
 
 		/**
 		 * @type {Record<string, string | string[] | File | File[]>}
 		 */
-		let input = $state({});
+		let input = $state(initialData ?? {});
 
 		/** @type {InternalRemoteFormIssue[]} */
 		let raw_issues = $state.raw([]);
@@ -76,7 +76,7 @@ export function form(id) {
 		let pending_count = $state(0);
 
 		/** @type {StandardSchemaV1 | undefined} */
-		let preflight_schema = undefined;
+		let preflight_schema = preflight;
 
 		/** @type {HTMLFormElement | null} */
 		let element = null;
@@ -511,13 +511,6 @@ export function form(id) {
 			pending: {
 				get: () => pending_count
 			},
-			preflight: {
-				/** @type {RemoteForm<T, U>['preflight']} */
-				value: (schema) => {
-					preflight_schema = schema;
-					return instance;
-				}
-			},
 			validate: {
 				/** @type {RemoteForm<any, any>['validate']} */
 				value: async ({ includeUntouched = false, preflightOnly = false, submitter } = {}) => {
@@ -593,22 +586,7 @@ export function form(id) {
 		/** @type {RemoteFormFactoryOptions<T> | undefined } */
 		const options = arg && typeof arg === 'object' ? arg : undefined;
 		const key = options ? options.key : /** @type {ExtractId<T> | undefined} */ (arg);
-
-		let entry = instances.get(key);
-		if (!entry) {
-			const instance = create_instance(options ?? { key });
-
-			if (options?.preflight) {
-				instance.preflight(options.preflight);
-			}
-			// seed optional initial input data
-			if (options?.initialData) {
-				instance.fields.set(options.initialData);
-			}
-
-			entry = { count: 0, instance };
-			instances.set(key, entry);
-		}
+		const entry = instances.get(key) ?? { count: 0, instance: create_instance(options ?? { key }) };
 
 		try {
 			$effect.pre(() => {

packages/kit/test/apps/basics/src/routes/remote/form/imperative/+page.svelte

@@ -2,17 +2,18 @@
 	import { set_message } from '../form.remote.js';
 	import * as v from 'valibot';
 
-	const message_form = set_message();
-
 	const schema = v.object({
 		message: v.picklist(
 			['hello', 'goodbye', 'unexpected error', 'expected error', 'redirect'],
 			'message is invalid'
 		)
 	});
+	const message_form = set_message({
+		preflight: schema
+	});
 </script>
 
-<form {...message_form.preflight(schema)}>
+<form {...message_form}>
 	<label>
 		<span>Message</span>
 		<input {...message_form.fields.message.as('text')} />

packages/kit/test/apps/basics/src/routes/remote/form/preflight-only/+page.svelte

@@ -4,13 +4,14 @@
 
 	const data = get();
 
-	const set_form = set();
-
 	const schema = v.object({
 		a: v.pipe(v.string(), v.maxLength(7, 'a is too long')),
 		b: v.string(),
 		c: v.string()
 	});
+	const set_form = set({
+		preflight: schema
+	});
 </script>
 
 <!-- TODO use await here once async lands -->
@@ -23,7 +24,7 @@
 <hr />
 
 <form
-	{...set_form.preflight(schema)}
+	{...set_form}
 	oninput={() => set_form.validate({ preflightOnly: true })}
 	onchange={() => set_form.validate()}
 >

packages/kit/test/apps/basics/src/routes/remote/form/preflight/+page.svelte

@@ -4,12 +4,16 @@
 
 	const number = get_number();
 
-	const number_form = set_number();
-	const enhanced = set_number('enhanced');
-
 	const schema = v.object({
 		number: v.pipe(v.number(), v.maxValue(20, 'too big'))
 	});
+	const number_form = set_number({
+		preflight: schema
+	});
+	const enhanced = set_number({
+		key: 'enhanced',
+		preflight: schema
+	});
 </script>
 
 <p>number.current: {number.current}</p>
@@ -21,7 +25,7 @@
 
 <hr />
 
-<form data-default {...number_form.preflight(schema)}>
+<form data-default {...number_form}>
 	{#each number_form.fields.number.issues() as issue}
 		<p>{issue.message}</p>
 	{/each}
@@ -38,7 +42,7 @@
 
 <form
 	data-enhanced
-	{...enhanced.preflight(schema).enhance(async ({ submit }) => {
+	{...enhanced.enhance(async ({ submit }) => {
 		await submit();
 	})}
 >

packages/kit/test/apps/basics/src/routes/remote/form/validate/+page.svelte

@@ -2,17 +2,19 @@
 	import { issue_path_form, my_form } from './form.remote.js';
 	import * as v from 'valibot';
 
-	const my_form_form = my_form();
 	const schema = v.object({
 		foo: v.picklist(['a', 'b', 'c']),
 		bar: v.picklist(['d', 'e']),
 		button: v.optional(v.literal('submitter'))
 	});
+	const my_form_form = my_form({
+		preflight: schema
+	});
 	let submitter;
 	$inspect(my_form_form.fields.allIssues());
 </script>
 
-<form id="my-form" {...my_form_form.preflight(schema)} oninput={() => my_form_form.validate()}>
+<form id="my-form" {...my_form_form} oninput={() => my_form_form.validate()}>
 	{#each my_form_form.fields.foo.issues() as issue}
 		<p>{issue.message}</p>
 	{/each}

packages/kit/types/index.d.ts

@@ -2013,8 +2013,6 @@ declare module '@sveltejs/kit' {
 			action: string;
 			[attachment: symbol]: (node: HTMLFormElement) => void;
 		};
-		/** Preflight checks */
-		preflight(schema: StandardSchemaV1<Input, any>): RemoteForm<Input, Output>;
 		/** Validate the form contents programmatically */
 		validate(options?: {
 			/** Set this to `true` to also show validation issues of fields that haven't been touched yet. */