Added namespace for status messages.

Fixes #261.

Author: ciscoheat

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- By declaring `namespace Superforms` with a `type Message` in `app.d.ts`, the [status messages](https://superforms.rocks/concepts/messages) will always be set to that type. ([#261](https://github.com/ciscoheat/sveltekit-superforms/issues/261))
 - Added `FormResult<T>`, which can be used in [onResult](https://superforms.rocks/concepts/events#onresult) to make the ActionResult strongly typed.
 
 ## [1.8.0]

src/app.d.ts

@@ -9,6 +9,9 @@ declare global {
     }
     // interface Platform {}
   }
+  namespace Superforms {
+    type Message = string;
+  }
 }
 
 export {};

src/lib/client/index.ts

@@ -192,10 +192,10 @@ const defaultFormOptions = {
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-type SuperFormSnapshot<T extends AnyZodObject, M = any> = SuperValidated<
-  T,
-  M
-> & { tainted: TaintedFields<T> | undefined };
+type SuperFormSnapshot<
+  T extends AnyZodObject,
+  M = Superforms.Message extends never ? any : Superforms.Message
+> = SuperValidated<T, M> & { tainted: TaintedFields<T> | undefined };
 
 export type TaintOption<T extends AnyZodObject = AnyZodObject> =
   | boolean
@@ -204,7 +204,10 @@ export type TaintOption<T extends AnyZodObject = AnyZodObject> =
   | { fields: FormPathLeaves<z.infer<T>> | FormPathLeaves<z.infer<T>>[] };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type SuperForm<T extends ZodValidation<AnyZodObject>, M = any> = {
+export type SuperForm<
+  T extends ZodValidation<AnyZodObject>,
+  M = Superforms.Message extends never ? any : Superforms.Message
+> = {
   form: {
     subscribe: Readable<z.infer<UnwrapEffects<T>>>['subscribe'];
     set(
@@ -286,7 +289,7 @@ function multipleFormIdError(id: string | undefined) {
 export function superForm<
   T extends ZodValidation<AnyZodObject> = ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   form: SuperValidated<T, M>,
   options: FormOptions<UnwrapEffects<T>, M> = {}

src/lib/index.ts

@@ -159,7 +159,7 @@ export type InputConstraints<T extends AnyZodObject> = SuperStruct<
 export type SuperValidated<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 > = {
   valid: boolean;
   posted: boolean;

src/lib/superValidate.ts

@@ -514,7 +514,7 @@ export type SuperValidateOptions<T extends AnyZodObject = AnyZodObject> =
 export async function superValidate<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   schema: T,
   options?: SuperValidateOptions<UnwrapEffects<T>>
@@ -523,7 +523,7 @@ export async function superValidate<
 export async function superValidate<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   data:
     | RequestEvent
@@ -546,7 +546,7 @@ export async function superValidate<
 export async function superValidate<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   data: unknown,
   schema?: T | SuperValidateOptions<UnwrapEffects<T>>,
@@ -623,7 +623,7 @@ export async function superValidate<
 export function superValidateSync<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   schema: T,
   options?: SuperValidateOptions<UnwrapEffects<T>>
@@ -632,7 +632,7 @@ export function superValidateSync<
 export function superValidateSync<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   data:
     | FormData
@@ -653,7 +653,7 @@ export function superValidateSync<
 export function superValidateSync<
   T extends ZodValidation<AnyZodObject>,
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  M = any
+  M = Superforms.Message extends never ? any : Superforms.Message
 >(
   data: unknown,
   schema?: T | SuperValidateOptions<UnwrapEffects<T>>,