treat invalidation as navigation

.changeset/lucky-ladybugs-jog.md

@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+[breaking] treat invalidation as a form of navigation

packages/kit/src/runtime/client/client.js

@@ -144,11 +144,24 @@ export function create_client({ target, base, trailing_slash }) {
 		if (!invalidating) {
 			const url = new URL(location.href);
 
+			/** @type {import('types').Navigation} */
+			const navigation = { from: url, to: url, type: 'invalidation' };
+
+			let cancelled = false;
+			const cancellable = { ...navigation, cancel: () => (cancelled = true) };
+
+			callbacks.before_navigate.forEach((cb) => cb(cancellable));
+
 			invalidating = Promise.resolve().then(async () => {
-				await update(url, []);
+				if (!cancelled) {
+					stores.navigating.set(navigation);
+					await update(url, []);
+					callbacks.after_navigate.forEach((cb) => cb(navigation));
+				}
 
 				invalidating = null;
 				force_invalidation = false;
+				stores.navigating.set(null);
 			});
 		}
 

packages/kit/types/ambient.d.ts

@@ -160,8 +160,8 @@ declare module '$app/navigation' {
 	export function prefetchRoutes(routes?: string[]): Promise<void>;
 
 	/**
-	 * A navigation interceptor that triggers before we navigate to a new URL, whether by clicking a link, calling `goto(...)`, or using the browser back/forward controls.
-	 * Calling `cancel()` will prevent the navigation from completing.
+	 * A navigation interceptor that triggers before we navigate to a new URL — whether by clicking a link, calling `goto(...)`, or using the browser back/forward controls — or `invalidate(...)` data.
+	 * Calling `cancel()` will prevent the navigation/invalidation from completing.
 	 *
 	 * When navigating to an external URL, `navigation.to` will be `null`.
 	 *
@@ -172,7 +172,7 @@ declare module '$app/navigation' {
 	): void;
 
 	/**
-	 * A lifecycle function that runs the supplied `callback` when the current component mounts, and also whenever we navigate to a new URL.
+	 * A lifecycle function that runs the supplied `callback` when the current component mounts, and also whenever we navigate to a new URL or`invalidate(...)` data.
 	 *
 	 * `afterNavigate` must be called during a component initialization. It remains active as long as the component is mounted.
 	 */
@@ -218,7 +218,7 @@ declare module '$app/stores' {
 	export const page: Readable<Page>;
 	/**
 	 * A readable store.
-	 * When navigating starts, its value is a `Navigation` object with `from`, `to`, `type` and (if `type === 'popstate'`) `delta` properties.
+	 * When navigating (or invalidating) starts, its value is a `Navigation` object with `from`, `to`, `type` and (if `type === 'popstate'`) `delta` properties.
 	 * When navigating finishes, its value reverts to `null`.
 	 */
 	export const navigating: Readable<Navigation | null>;

packages/kit/types/index.d.ts

@@ -219,7 +219,7 @@ export interface LoadEvent<
 	depends: (...deps: string[]) => void;
 }
 
-export type NavigationType = 'load' | 'unload' | 'link' | 'goto' | 'popstate';
+export type NavigationType = 'load' | 'unload' | 'link' | 'goto' | 'popstate' | 'invalidation';
 
 export interface Navigation {
 	from: URL | null;