Fixed flash messages being displayed early.

Author: ciscoheat

CHANGELOG.md

@@ -5,15 +5,16 @@ Headlines: Added, Changed, Deprecated, Removed, Fixed, Security
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [1.0.0-rc.4]
 
 ### Changed
 
-- It's not possible to send arbitrary data to `superForm` anymore, a `SuperValidated` structure is required, which is retured from `superValidate`, so in most cases this is not a problem.
+- It's not possible to send arbitrary data to `superForm` anymore, a `SuperValidated` structure is required, which is returned from `superValidate` on the server and `superValidateSync`, so in most cases this is not a problem.
 - Reverted that `message/setMessage` and `setError` will throw an error if status is lower than 400. Using a range error type check instead.
 
 ### Fixed
 
+- Fixed flash messages being displayed early. This update also means that at least [sveltekit-flash-message](https://github.com/ciscoheat/sveltekit-flash-message) 1.0.0-rc.3 is required to work together with Superforms.
 - Form data was reset to its previous state when `error` was thrown.
 - Form-level errors can be added with `setError`, using an empty string as path.
 

package.json

@@ -103,11 +103,11 @@
     "prettier": "^2.8.8",
     "prettier-plugin-svelte": "^2.10.1",
     "publint": "^0.1.12",
-    "sass": "^1.62.1",
+    "sass": "^1.63.2",
     "slugify": "^1.6.6",
     "svelte": "^3.59.1",
     "svelte-check": "^3.4.3",
-    "sveltekit-flash-message": "1.0.0-rc.2",
+    "sveltekit-flash-message": "1.0.0-rc.3",
     "sveltekit-rate-limiter": "^0.1.8",
     "throttle-debounce": "^5.0.0",
     "tslib": "^2.5.3",

pnpm-lock.yaml

@@ -535,16 +535,13 @@ export function formEnhance<T extends AnyZodObject, M>(
             }
           }
 
-          // Set flash message, which should be set in all cases, even
-          // if we have redirected (which is the point of the flash message!)
+          // Trigger flash message event if there was an error
           if (options.flashMessage) {
             if (result.type == 'error' && options.flashMessage.onError) {
               await options.flashMessage.onError({
                 result,
                 message: options.flashMessage.module.getFlash(page)
               });
-            } else if (result.type != 'error') {
-              await options.flashMessage.module.updateFlash(page);
             }
           }
         }

src/lib/client/formEnhance.ts

@@ -130,7 +130,7 @@ export type FormOptions<T extends ZodValidation<AnyZodObject>, M> = Partial<{
       updateFlash(
         page: Readable<Page>,
         update?: () => Promise<void>
-      ): Promise<void>;
+      ): Promise<boolean>;
     };
     onError?: (event: {
       result: {
@@ -782,7 +782,7 @@ export function superForm<
 
         if (pageUpdate.form && typeof pageUpdate.form === 'object') {
           // Check if it is an error result, sent here from formEnhance
-          if(pageUpdate.form.type == 'error') return
+          if (pageUpdate.form.type == 'error') return;
 
           const forms = Context_findValidationForms(pageUpdate.form);
           if (!forms.length) error('$page.form (ActionData)');