chore: remove deprecated future APIs (#1285)

Author: edmundhung

.changeset/clean-future-exports.md

@@ -0,0 +1,13 @@
+---
+'@conform-to/dom': minor
+'@conform-to/react': minor
+'@conform-to/valibot': minor
+'@conform-to/zod': minor
+---
+
+chore: remove deprecated Future APIs from the `/future` exports
+
+- The `stripEmptyValues` option from `parseSubmission()`, deprecated in [v1.18.0](https://github.com/edmundhung/conform/releases/tag/v1.18.0), is now removed.
+- The `value` option from `report()`, deprecated in [v1.20.0](https://github.com/edmundhung/conform/releases/tag/v1.20.0), is now removed. Use `targetValue` instead.
+- The `invalid` property from field and form metadata, deprecated in [v1.9.1](https://github.com/edmundhung/conform/releases/tag/v1.9.1), is now removed. Use `!valid` instead.
+- The `getZodConstraint()` and `getValibotConstraint()` exports, deprecated in [v1.16.0](https://github.com/edmundhung/conform/releases/tag/v1.16.0), are now removed. Use `getConstraints()` instead.

docs/api/react/future/report.md

@@ -29,10 +29,6 @@ Set to `null` to indicate validation passed with no errors. If you need schema i
 
 The target form value to apply. Use this to update the form or reset it to a specific value when combined with `reset: true`. Pass `null` to apply an empty value.
 
-### `options.value?: Record<string, unknown> | null` (deprecated)
-
-Deprecated alias for `targetValue`. It will be removed in the next minor release. When both options are provided, `targetValue` takes precedence.
-
 ### `options.keepFiles?: boolean`
 
 Controls whether file objects are preserved in the submission payload:

docs/api/react/future/useField.md

@@ -76,12 +76,6 @@ Whether this field has been touched (through `intent.validate()` or the `shouldV
 
 Whether this field currently has no validation errors.
 
-### `invalid: boolean`
-
-> **⚠️ Deprecated:** Use `valid` instead. This property will be removed in version 1.11.0.
-
-Whether this field currently has validation errors. This is equivalent to `!valid`.
-
 ### `errors: ErrorShape | undefined`
 
 Validation error for this field.

docs/api/react/future/useFormMetadata.md

@@ -48,12 +48,6 @@ Whether any field in the form has been touched (through `intent.validate()` or t
 
 Whether the form currently has no validation errors.
 
-### `invalid: boolean`
-
-> **⚠️ Deprecated:** Use `valid` instead. This property will be removed in version 1.11.0.
-
-Whether the form currently has any validation errors. This is equivalent to `!valid`.
-
 ### `errors: ErrorShape | undefined`
 
 Form-level validation error, if any exists.

examples/headless-ui/src/App.tsx

@@ -241,7 +241,7 @@ export default function App() {
 								// name={fields.project.name}
 								// defaultValue={fields.project.defaultValue}
 								// required={fields.project.required}
-								// invalid={fields.project.invalid}
+								// invalid={!fields.project.valid}
 								className="mt-1 block w-full rounded-md border border-gray-300 px-3 py-2 shadow-sm data-focus:border-indigo-500 data-focus:ring-1 data-focus:ring-indigo-500 data-focus:outline-none sm:text-sm"
 							/>
 							<Description
@@ -266,7 +266,7 @@ export default function App() {
 								// name={fields.notes.name}
 								// defaultValue={fields.notes.defaultValue}
 								// required={fields.notes.required}
-								// invalid={fields.notes.invalid}
+								// invalid={!fields.notes.valid}
 								rows={3}
 								className="mt-1 block w-full rounded-md border border-gray-300 px-3 py-2 shadow-sm data-focus:border-indigo-500 data-focus:ring-1 data-focus:ring-indigo-500 data-focus:outline-none sm:text-sm"
 							/>
@@ -292,7 +292,7 @@ export default function App() {
 								// name={fields.priority.name}
 								// defaultValue={fields.priority.defaultValue}
 								// required={fields.priority.required}
-								// invalid={fields.priority.invalid}
+								// invalid={!fields.priority.valid}
 								className="mt-1 block w-full rounded-md border border-gray-300 bg-white px-3 py-2 shadow-sm data-focus:border-indigo-500 data-focus:ring-1 data-focus:ring-indigo-500 data-focus:outline-none sm:text-sm"
 							>
 								<option value="low">Low</option>

examples/headless-ui/src/forms.ts

@@ -21,7 +21,7 @@ const forms = configureForms({
 					name: metadata.name,
 					defaultValue: metadata.defaultValue,
 					required: metadata.required,
-					invalid: metadata.invalid,
+					invalid: !metadata.valid,
 				} satisfies Partial<InputProps>;
 			},
 			get textareaProps() {
@@ -30,7 +30,7 @@ const forms = configureForms({
 					name: metadata.name,
 					defaultValue: metadata.defaultValue,
 					required: metadata.required,
-					invalid: metadata.invalid,
+					invalid: !metadata.valid,
 				} satisfies Partial<TextareaProps>;
 			},
 			get selectProps() {
@@ -39,7 +39,7 @@ const forms = configureForms({
 					name: metadata.name,
 					defaultValue: metadata.defaultValue,
 					required: metadata.required,
-					invalid: metadata.invalid,
+					invalid: !metadata.valid,
 				} satisfies Partial<SelectProps>;
 			},
 			get listBoxProps() {

packages/conform-dom/formdata.ts

@@ -365,33 +365,6 @@ export function getPathValue(
 	return pointer;
 }
 
-/**
- * Check if a form value is considered empty and should be stripped from the submission.
- * A value is empty if:
- * - It's an empty string ""
- * - It's an empty File (size 0 and name "")
- * - It's an array where all items are empty
- */
-function isEmptyValue(
-	value: FormDataEntryValue | FormDataEntryValue[] | undefined,
-): boolean {
-	if (value === '' || value === undefined) {
-		return true;
-	}
-
-	if (isGlobalInstance(value, 'File')) {
-		// Empty File has size 0 and empty name
-		return value.size === 0 && value.name === '';
-	}
-
-	if (Array.isArray(value)) {
-		// If all items are empty, consider it empty
-		return value.every((item) => isEmptyValue(item));
-	}
-
-	return false;
-}
-
 /**
  * Parse `FormData` or `URLSearchParams` into a submission object.
  * This function structures the form values based on the naming convention.
@@ -436,15 +409,6 @@ export function parseSubmission(
 		 * Return `true` to skip the entry.
 		 */
 		skipEntry?: ((name: string) => boolean) | undefined;
-		/**
-		 * Whether to strip empty values (empty strings, empty files, arrays with all empty values)
-		 * from the submission payload. Defaults to `false`.
-		 *
-		 * @deprecated This option will be removed in a future minor release.
-		 * If you are using a schema library like Zod or Valibot, our integration
-		 * already strips empty values for you. There is no need to use this option.
-		 */
-		stripEmptyValues?: boolean | undefined;
 	},
 ): Submission {
 	const intentName = options?.intentName ?? DEFAULT_INTENT_NAME;
@@ -455,7 +419,6 @@ export function parseSubmission(
 	};
 
 	const segmentsByName = new Map<string, Array<string | number> | null>();
-	const stripEmptyValues = options?.stripEmptyValues ?? false;
 	let intentValue: string | null | undefined = undefined;
 
 	for (const [name, entryValue] of formData) {
@@ -499,10 +462,6 @@ export function parseSubmission(
 			submission.payload,
 			segments,
 			(current: unknown) => {
-				if (stripEmptyValues && isEmptyValue(entryValue)) {
-					return current;
-				}
-
 				if (Array.isArray(current)) {
 					current.push(entryValue);
 					return current;
@@ -566,8 +525,6 @@ export function report(
 		keepFiles?: false;
 		error?: null;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -578,8 +535,6 @@ export function report(
 		keepFiles: true;
 		error?: null;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -590,8 +545,6 @@ export function report<ErrorShape>(
 		keepFiles?: false;
 		error: CustomError<ErrorShape> | null;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -605,8 +558,6 @@ export function report<ErrorShape>(
 		keepFiles: true;
 		error: CustomError<ErrorShape> | null;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -617,8 +568,6 @@ export function report(
 		keepFiles?: false;
 		error: StandardSchemaError;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -632,8 +581,6 @@ export function report(
 		keepFiles: true;
 		error: StandardSchemaError;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -644,8 +591,6 @@ export function report<ErrorShape>(
 		keepFiles?: boolean;
 		error?: CustomError<ErrorShape> | null;
 		targetValue?: Record<string, FormValue> | null;
-		/** @deprecated Use `targetValue` instead. This will be removed in the next minor release. */
-		value?: Record<string, FormValue> | null;
 		hideFields?: string[];
 		reset?: boolean;
 	},
@@ -668,10 +613,6 @@ export function report<ErrorShape>(
 		 * to a specific value when combined with `reset: true`.
 		 */
 		targetValue?: Record<string, FormValue> | null;
-		/**
-		 * @deprecated Use `targetValue` instead. This will be removed in the next minor release.
-		 */
-		value?: Record<string, FormValue> | null;
 		/**
 		 * Array of field names to hide from the result by setting them to `undefined`.
 		 * Primarily used for sensitive data like passwords that should not be sent back to the client.
@@ -693,15 +634,13 @@ export function report<ErrorShape>(
 		error = normalizeFormError(options.error);
 	}
 
-	const targetValueOption =
-		'targetValue' in options ? options.targetValue : options.value;
 	const targetValue =
-		typeof targetValueOption === 'undefined' ||
-		(submission.payload === targetValueOption && !options.reset)
+		typeof options.targetValue === 'undefined' ||
+		(submission.payload === options.targetValue && !options.reset)
 			? undefined
-			: targetValueOption && !options.keepFiles
-				? stripFiles(targetValueOption)
-				: (targetValueOption ?? {});
+			: options.targetValue && !options.keepFiles
+				? stripFiles(options.targetValue)
+				: (options.targetValue ?? {});
 
 	if (options.hideFields) {
 		for (const name of options.hideFields) {