navgo 6.0.7 → 6.0.9

package/changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v6.0.8
+
+- breaking: make search-schema transitions atomic by publishing `router.route` before global `router.search_params`, with sync guard across both writes
+  - note: `router.route.subscribe(...)` now fires before `router.search_params` updates on search-schema transitions
+
 ## v6.0.7
 
 - add `nav.status` as the formal HTTP-like status for completed navigations

package/index.js

@@ -12,7 +12,7 @@ import {
 	scroll_to_hash,
 	validate_search,
 } from './utils.js'
-import { tick } from 'svelte'
+import * as svelte from 'svelte'
 import { writable } from 'svelte/store'
 export { v }
 import { parse } from 'regexparam'
@@ -28,7 +28,7 @@ export default class Navgo {
 		preload_on_hover: true,
 		before_navigate: undefined,
 		after_navigate: undefined,
-		tick,
+		tick: svelte.tick,
 		scroll_to_top: true,
 		aria_current: false,
 		attach_to_window: true,
@@ -288,7 +288,12 @@ export default class Navgo {
 			ℹ('[🧭 navigate]', 'cancelled by before_route_leave during unload')
 			ev.preventDefault()
 			ev.returnValue = ''
+			return
 		}
+
+		try {
+			history.scrollRestoration = 'auto'
+		} catch {}
 	}
 
 	//
@@ -588,10 +593,13 @@ export default class Navgo {
 	#set_search_store(values) {
 		const next = values || {}
 		this.#search_syncing = true
-		this.search_params.set(next)
-		this.#search_syncing = false
-		this.#current.search_params = next
-		if (this.#current.url) this.route.set(this.#current)
+		try {
+			this.#current.search_params = next
+			if (this.#current.url) this.route.set(this.#current)
+			this.search_params.set(next)
+		} finally {
+			this.#search_syncing = false
+		}
 	}
 
 	/* Apply resolved search config to current route. */
@@ -1131,6 +1139,8 @@ export default class Navgo {
 
 			// allow frameworks to flush DOM before scrolling
 			try {
+				await svelte.settled?.()
+				await this.#opts.tick?.()
 				await this.#opts.tick?.()
 			} catch (e) {
 				ℹ('[🧭 hooks]', 'tick threw', { err: e })
@@ -1379,7 +1389,6 @@ export default class Navgo {
 		if (initial) this.route.set({ ...this.#target(initial), search_params: {} })
 
 		const group_ids = new Map()
-
 		function compile_routes(entries, stack = []) {
 			const out = []
 			for (const e of entries || []) {
@@ -1437,9 +1446,8 @@ export default class Navgo {
 	//
 	// Lifecycle hooks
 	//
-	init() {
-		history.scrollRestoration = 'manual'
-		ℹ('[🧭 init]', 'attach listeners; scrollRestoration=manual')
+	async init() {
+		ℹ('[🧭 init]', 'attach listeners')
 
 		addEventListener('popstate', this.#on_popstate)
 		addEventListener('click', this.#click)
@@ -1472,7 +1480,11 @@ export default class Navgo {
 
 		ℹ('[🧭 init]', 'initial goto')
 		if (this.#opts.attach_to_window) window.navgo = this
-		return this.goto()
+		await this.goto()
+		try {
+			history.scrollRestoration = 'manual'
+			ℹ('[🧭 init]', 'scrollRestoration=manual')
+		} catch {}
 	}
 	destroy() {
 		removeEventListener('popstate', this.#on_popstate)
@@ -1497,17 +1509,27 @@ export default class Navgo {
 		const hash = location.hash
 		const t = ctx?.type || ctx?.event?.type
 		requestAnimationFrame(() => {
-			// 0) Initial (first) navigation: prefer restoring session scroll
+			// 0) Initial (first) navigation: prefer restoring session scroll,
+			// otherwise preserve whatever the browser already did for the SSR document.
 			const is_initial = ctx && 'from' in ctx ? ctx.from == null : !t
 			if (is_initial) {
 				try {
 					const k = `__navgo_scroll:${location.href}`
 					const { x, y } = JSON.parse(sessionStorage.getItem(k))
 					sessionStorage.removeItem(k)
+					try {
+						history.scrollRestoration = 'manual'
+					} catch {}
 					scrollTo(x, y)
 					ℹ('[🧭 scroll]', 'restore session', { x, y })
 					return
 				} catch {}
+				if (hash && scroll_to_hash(hash)) {
+					ℹ('[🧭 scroll]', 'initial hash')
+					return
+				}
+				ℹ('[🧭 scroll]', 'initial preserve')
+				return
 			}
 			// 1) On back/forward, restore saved position if available
 			if (t === 'popstate') {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "navgo",
-	"version": "6.0.7",
+	"version": "6.0.9",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/mustafa0x/navgo.git"