ActionResult can now handled by customRequest.

Closes #471

Author: ciscoheat

CHANGELOG.md

@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - New validation library: [class-validator](https://github.com/typestack/class-validator)!
 - Exported `SuperFormData` and `SuperFormErrors` types for superForm.
 - Exported `ZodObjectType`, `ZodObjectTypes` and `ZodValidation` types for the Zod adapter.
+- [customRequest](https://superforms.rocks/concepts/events#customrequest) can now handle an `ActionResult` as well, for better error handling.
 
 ### Fixed
 

src/lib/client/superForm.ts

@@ -107,10 +107,12 @@ export type FormOptions<
 			validators: (validators: Exclude<ValidatorsOption<T>, 'clear'>) => void;
 			/**
 			 * Use a custom fetch or XMLHttpRequest implementation for this form submission. It must return an ActionResult in the response body.
-			 * If the request is using a XMLHttprequest, the promise must be resolved when the request is complete.
+			 * If the request is using a XMLHttpRequest, the promise must be resolved when the request has been completed, not before.
 			 */
 			customRequest: (
-				validators: (input: Parameters<SubmitFunction>[0]) => Promise<Response | XMLHttpRequest>
+				validators: (
+					input: Parameters<SubmitFunction>[0]
+				) => Promise<Response | XMLHttpRequest | ActionResult>
 			) => void;
 		}
 	) => MaybePromise<unknown | void>;
@@ -1599,7 +1601,9 @@ export function superForm<
 
 		let currentRequest: AbortController | null;
 		let customRequest:
-			| ((input: Parameters<SubmitFunction>[0]) => Promise<Response | XMLHttpRequest>)
+			| ((
+					input: Parameters<SubmitFunction>[0]
+			  ) => Promise<Response | XMLHttpRequest | ActionResult>)
 			| undefined = undefined;
 
 		const enhanced = kitEnhance(FormElement, async (submitParams) => {
@@ -1979,10 +1983,16 @@ export function superForm<
 			if (customRequest) {
 				if (!cancelled) _submitCancel();
 				const response = await customRequest(submitParams);
-				const result: ActionResult =
-					response instanceof Response
-						? deserialize(await response.text())
-						: deserialize(response.responseText);
+
+				let result: ActionResult;
+
+				if (response instanceof Response) {
+					result = deserialize(await response.text());
+				} else if (response instanceof XMLHttpRequest) {
+					result = deserialize(response.responseText);
+				} else {
+					result = response;
+				}
 
 				if (result.type === 'error') result.status = response.status;
 				validationResponse({ result });