Restrict Form.encType (#37)

* Restrict encType This PR prevents users from adding another encType like `application/x-www-form-urlencoded`. This makes prevents breaking changes in the future. * Add Changeset Co-authored-by: Gal Schlezinger <[email protected]> Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
vercel-labs · Nov 15, 2022 · 8840f7f · 8840f7f · vercel · Nov 15, 2022
1 parent de8d0f6
commit 8840f7f
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 3 deletions.
diff --git a/.changeset/neat-snakes-bow.md b/.changeset/neat-snakes-bow.md
@@ -0,0 +1,7 @@
+---
+"@next-fetch/core-plugin": patch
+"@next-fetch/react-query": patch
+"@next-fetch/swr": patch
+---
+
+Restrict FormProps to explicitly prevent users from using unsupported encTypes.
diff --git a/packages/@next-fetch/core-plugin/src/form.ts b/packages/@next-fetch/core-plugin/src/form.ts
@@ -15,7 +15,9 @@ export function useForm<Input, Config>(
   hook: HookWithFormSubmission<Input, Config>,
   config?: Config
 ): {
-  formProps: HTMLProps<HTMLFormElement>;
+  formProps: HTMLProps<HTMLFormElement> & {
+    encType?: "application/x-www-form-urlencoded";
+  };
 } {
   const { trigger, meta } = hook;
 

diff --git a/packages/@next-fetch/react-query/src/form.ts b/packages/@next-fetch/react-query/src/form.ts
@@ -22,7 +22,9 @@ export function useForm<Data, Error, Input, Context>(
   hook: HookWithFormSubmission<Data, Error, Input, Context>,
   config?: UseMutationOptions<Data, Error, Input, Context>
 ): {
-  formProps: HTMLProps<HTMLFormElement>;
+  formProps: HTMLProps<HTMLFormElement> & {
+    encType?: "application/x-www-form-urlencoded";
+  };
 } {
   return useForm_({ meta: hook.meta, trigger: hook.mutate }, config);
 }
@@ -40,6 +42,7 @@ export function Form<Data, Error, Input, Context>({
   React.PropsWithChildren<{
     mutation: HookWithFormSubmission<Data, Error, Input, Context>;
     mutationConfig?: UseMutationOptions<Data, Error, Input, Context>;
+    encType?: "application/x-www-form-urlencoded";
   }>) {
   const { formProps } = useForm(mutation, mutationConfig);
   return createElement("form", { ...formProps, ...props }, props.children);

diff --git a/packages/@next-fetch/swr/src/form.ts b/packages/@next-fetch/swr/src/form.ts
@@ -22,7 +22,9 @@ export function useForm<Data, Error>(
   hook: HookWithFormSubmission<Data, Error>,
   config?: SWRMutationConfiguration<Data, Error>
 ): {
-  formProps: HTMLProps<HTMLFormElement>;
+  formProps: HTMLProps<HTMLFormElement> & {
+    encType?: "application/x-www-form-urlencoded";
+  };
 } {
   return useForm_(hook, config);
 }
@@ -40,6 +42,7 @@ export function Form<Data, Error>({
   React.PropsWithChildren<{
     mutation: HookWithFormSubmission<Data, Error>;
     mutationConfig?: SWRMutationConfiguration<Data, Error>;
+    encType?: "application/x-www-form-urlencoded";
   }>) {
   const { formProps } = useForm(mutation, mutationConfig);
   return createElement("form", { ...formProps, ...props }, props.children);