@valentinkolb/ssr 0.10.1 → 0.11.0

package/README.md

@@ -184,16 +184,24 @@ NODE_ENV=development bun --watch --preload=./scripts/preload.ts src/server.ts
 update URL history after they have already updated client state.
 
 ```tsx
-import { createSignal } from "solid-js";
-import { Link, type LinkNavigateEvent } from "@valentinkolb/ssr/nav";
+import { createSignal, onCleanup, onMount } from "solid-js";
+import { Link, listenPopState, type LinkNavigateEvent } from "@valentinkolb/ssr/nav";
 
 export default function Tabs() {
   const [tab, setTab] = createSignal("alpha");
 
+  onMount(() => {
+    onCleanup(
+      listenPopState(({ url }) => {
+        setTab(url.searchParams.get("tab") ?? "alpha");
+      }),
+    );
+  });
+
   const openTab = (nav: LinkNavigateEvent) => {
     const next = nav.url.searchParams.get("tab") ?? "alpha";
     setTab(next);
-    nav.replaceWith(`/demo?tab=${next}`, { scroll: "preserve" });
+    nav.push(`/demo?tab=${next}`, { scroll: "preserve", state: { tab: next } });
   };
 
   return (
@@ -210,12 +218,28 @@ browser for same-origin, left-click navigation without modifier keys. Without
 history. With `onNavigate`, the island owns data loading and state updates, then
 calls `nav.push()`, `nav.replaceWith()`, or `nav.fallback()`.
 
+Use `listenPopState()` whenever `nav.push()` represents client state. Browser
+Back/Forward changes history but cannot infer how an island maps the URL back to
+signals or stores. The helper reports the current `URL`, native `PopStateEvent`,
+and history state without adding route matching or data loading.
+
+Navigation behavior:
+
+- reactive anchor props remain reactive after `Link` renders
+- same-document hash links retain native target scrolling unless `onNavigate`
+  or `scroll` explicitly takes ownership
+- relative URLs follow `document.baseURI`
+- cross-origin `navigate()` calls use full document navigation
+- replace navigation preserves existing `history.state` unless `state` is set
+- rejected async `onNavigate` callbacks log the error and fall back to a full
+  document navigation
+
 Available exports:
 
 - `Link`
 - `navigate()`, `navigateTo()`, `documentNavigate()`, `refreshCurrentPath()`
-- `captureScroll()`, `restoreScroll()`, `startViewTransition()`
-- `LinkNavigateEvent`, `LinkProps`, `EnhancedNavigateOptions`, `NavigationScrollMode`, `ScrollSnapshot`
+- `captureScroll()`, `restoreScroll()`, `listenPopState()`, `startViewTransition()`
+- `LinkNavigateEvent`, `LinkProps`, `EnhancedNavigateOptions`, `NavigationScrollMode`, `PopStateNavigationEvent`, `ScrollSnapshot`
 
 Use `data-scroll-preserve="stable-key"` on scroll containers that should keep
 their scroll position across enhanced navigation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valentinkolb/ssr",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "description": "Minimal SSR framework for SolidJS and Bun",
   "type": "module",
   "main": "src/index.ts",
@@ -13,7 +13,7 @@
     "./nav": "./src/nav.ts"
   },
   "scripts": {
-    "test": "bun test"
+    "test": "bunx tsc -p test/tsconfig.json && bun test test/unit && bun test --conditions=browser --preload ./test/browser/setup.ts test/browser"
   },
   "peerDependencies": {
     "solid-js": "^1.9.0",
@@ -36,6 +36,7 @@
     "seroval": "^1.5.5"
   },
   "devDependencies": {
+    "@happy-dom/global-registrator": "^20.10.6",
     "@types/bun": "^1.3.14",
     "elysia": "^1.4.29",
     "file-type": "^21.3.1",

package/src/nav.ts

@@ -4,7 +4,7 @@
  * This is not a router. Links remain real anchors and apps decide whether an
  * enhanced click can update client state before committing browser history.
  */
-import type { JSX } from "solid-js";
+import { mergeProps, splitProps, type JSX } from "solid-js";
 import { createDynamic } from "solid-js/web";
 
 type AnchorProps = JSX.AnchorHTMLAttributes<HTMLAnchorElement>;
@@ -24,9 +24,16 @@ export type EnhancedNavigateOptions = {
   replace?: boolean;
   scroll?: NavigationScrollMode;
   scrollSnapshot?: ScrollSnapshot;
+  state?: unknown;
   viewTransition?: boolean;
 };
 
+export type PopStateNavigationEvent = {
+  event: PopStateEvent;
+  url: URL;
+  state: unknown;
+};
+
 export type LinkNavigateEvent = {
   event: MouseEvent;
   href: string;
@@ -119,6 +126,24 @@ export const restoreScroll = (snapshot: ScrollSnapshot, options: { window?: bool
   window.scrollTo(snapshot.window.x, snapshot.window.y);
 };
 
+/**
+ * Subscribes to browser Back/Forward navigation.
+ *
+ * The application remains responsible for reconciling its island state with
+ * the URL. This helper intentionally does not perform route matching.
+ */
+export const listenPopState = (handler: (navigation: PopStateNavigationEvent) => void): (() => void) => {
+  const listener = (event: PopStateEvent) => {
+    handler({ event, url: new URL(window.location.href), state: event.state });
+  };
+
+  window.addEventListener("popstate", listener);
+  return () => window.removeEventListener("popstate", listener);
+};
+
+const resolveNavigationUrl = (href: string): URL =>
+  new URL(href, document.baseURI || window.location.href);
+
 /**
  * Updates browser history without a document reload.
  *
@@ -127,14 +152,22 @@ export const restoreScroll = (snapshot: ScrollSnapshot, options: { window?: bool
  * data, or re-render server pages.
  */
 export const navigate = (href: string, options: EnhancedNavigateOptions = {}): void => {
+  const url = resolveNavigationUrl(href);
+  if (url.origin !== window.location.origin) {
+    documentNavigate(url.href, { replace: options.replace });
+    return;
+  }
+
   const scroll = options.scroll ?? "top";
   const snapshot = scroll === "manual" ? null : (options.scrollSnapshot ?? captureScroll());
-  const url = new URL(href, window.location.href);
   const target = `${url.pathname}${url.search}${url.hash}`;
 
   const commit = () => {
-    if (options.replace) window.history.replaceState(null, "", target);
-    else window.history.pushState(null, "", target);
+    const hasExplicitState = Object.prototype.hasOwnProperty.call(options, "state");
+    const state = hasExplicitState ? options.state : options.replace ? window.history.state : null;
+
+    if (options.replace) window.history.replaceState(state, "", target);
+    else window.history.pushState(state, "", target);
 
     if (!snapshot) return;
     restoreRegionScroll(snapshot);
@@ -163,67 +196,113 @@ const shouldEnhanceClick = (event: MouseEvent, anchor: HTMLAnchorElement): boole
   if (anchor.target && anchor.target !== "_self") return false;
   if (anchor.hasAttribute("download")) return false;
 
-  const url = new URL(anchor.href, window.location.href);
+  const url = new URL(anchor.href);
   return url.origin === window.location.origin;
 };
 
+const isSameDocumentHash = (url: URL): boolean => {
+  const current = new URL(window.location.href);
+  return url.hash.length > 0 && url.pathname === current.pathname && url.search === current.search;
+};
+
 const callUserClick = (handler: LinkProps["onClick"], event: MouseEvent, anchor: HTMLAnchorElement): void => {
   if (!handler) return;
-  if (typeof handler === "function") {
-    handler(event as MouseEvent & { currentTarget: HTMLAnchorElement; target: Element });
+  const typedEvent = event as MouseEvent & { currentTarget: HTMLAnchorElement; target: Element };
+
+  if (Array.isArray(handler)) {
+    handler[0].call(anchor, handler[1], typedEvent);
     return;
   }
-  (handler as unknown as EventListenerObject).handleEvent(event);
+
+  if (typeof handler === "function") {
+    handler.call(anchor, typedEvent);
+  }
 };
 
 /**
  * SSR-safe anchor with opt-in progressive navigation.
  */
 export function Link(props: LinkProps) {
-  const anchorProps = () => {
-    const { href: _href, replace: _replace, scroll: _scroll, onNavigate: _onNavigate, onClick: _onClick, ...rest } = props;
-    return rest;
-  };
+  const [local, anchorProps] = splitProps(props, ["href", "replace", "scroll", "onNavigate", "onClick"]);
 
   const handleClick: JSX.EventHandler<HTMLAnchorElement, MouseEvent> = (event) => {
-    callUserClick(props.onClick, event, event.currentTarget);
+    callUserClick(local.onClick, event, event.currentTarget);
     if (!shouldEnhanceClick(event, event.currentTarget)) return;
 
-    const href = props.href;
-    const url = new URL(href, window.location.href);
-    const scroll = props.scroll ?? "top";
-    const replace = Boolean(props.replace);
+    const href = local.href;
+    const url = new URL(event.currentTarget.href);
+
+    // Preserve native target scrolling unless the application explicitly owns
+    // this hash navigation through onNavigate or a scroll option.
+    if (!local.onNavigate && local.scroll === undefined && isSameDocumentHash(url)) return;
+
+    const scroll = local.scroll ?? "top";
+    const replace = Boolean(local.replace);
     const scrollSnapshot = captureScroll();
 
     event.preventDefault();
 
-    if (!props.onNavigate) {
-      navigate(href, { replace, scroll, scrollSnapshot });
+    if (!local.onNavigate) {
+      navigate(url.href, { replace, scroll, scrollSnapshot });
       return;
     }
 
-    startViewTransition(() =>
-      props.onNavigate!({
-        event,
-        href,
-        url,
-        replace,
-        scroll,
-        push: (nextHref = href, options = {}) =>
-          navigate(nextHref, { replace: false, scroll, scrollSnapshot, viewTransition: false, ...options }),
-        replaceWith: (nextHref = href, options = {}) =>
-          navigate(nextHref, { replace: true, scroll, scrollSnapshot, viewTransition: false, ...options }),
-        fallback: (nextHref = href) => documentNavigate(nextHref, { replace }),
-        scrollSnapshot,
-        captureScroll,
-        restoreScroll,
-      }),
-    );
+    let navigationOutcome: "none" | "history" | "document" = "none";
+    const runNavigation = async () => {
+      try {
+        await local.onNavigate!({
+          event,
+          href,
+          url,
+          replace,
+          scroll,
+          push: (nextHref = url.href, options = {}) => {
+            navigate(nextHref, {
+              ...options,
+              replace: false,
+              scroll: options.scroll ?? scroll,
+              scrollSnapshot: options.scrollSnapshot ?? scrollSnapshot,
+              viewTransition: false,
+            });
+            navigationOutcome = "history";
+          },
+          replaceWith: (nextHref = url.href, options = {}) => {
+            navigate(nextHref, {
+              ...options,
+              replace: true,
+              scroll: options.scroll ?? scroll,
+              scrollSnapshot: options.scrollSnapshot ?? scrollSnapshot,
+              viewTransition: false,
+            });
+            navigationOutcome = "history";
+          },
+          fallback: (nextHref = url.href) => {
+            documentNavigate(resolveNavigationUrl(nextHref).href, { replace });
+            navigationOutcome = "document";
+          },
+          scrollSnapshot,
+          captureScroll,
+          restoreScroll,
+        });
+      } catch (error) {
+        console.error("[@valentinkolb/ssr/nav] onNavigate failed; falling back to document navigation.", error);
+        if (navigationOutcome === "document") return;
+        const historyCommitted = navigationOutcome === "history";
+        const fallbackHref = historyCommitted ? window.location.href : url.href;
+        documentNavigate(fallbackHref, { replace: historyCommitted || replace });
+      }
+    };
+
+    startViewTransition(runNavigation);
   };
 
-  return createDynamic(() => "a", {
-    ...anchorProps(),
-    href: props.href,
-    onClick: handleClick,
-  });
+  return createDynamic(
+    () => "a",
+    mergeProps(anchorProps, {
+      get href() {
+        return local.href;
+      },
+      onClick: handleClick,
+    }),
+  );
 }

package/src/transform.ts

@@ -122,6 +122,10 @@ const componentWrapperPlugin = (filename: string, rootDir: string, dev: boolean)
             path.skip();
           },
         });
+
+        // Client wrappers remove their original JSX usage. Refresh bindings so
+        // later presets can discard imports that became unused in this pass.
+        programPath.scope.crawl();
       },
     },
   };
@@ -138,19 +142,10 @@ export const transform = async (
   dev: boolean = false,
   rootDir: string = process.cwd(),
 ): Promise<string> => {
-  let code = source;
-
-  if (mode === "ssr") {
-    const result = await transformAsync(code, {
-      filename,
-      parserOpts: { plugins: ["jsx", "typescript"] },
-      plugins: [() => componentWrapperPlugin(filename, rootDir, dev)],
-    });
-    code = result?.code || code;
-  }
-
-  const result = await transformAsync(code, {
+  const result = await transformAsync(source, {
     filename,
+    parserOpts: mode === "ssr" ? { plugins: ["jsx", "typescript"] } : undefined,
+    plugins: mode === "ssr" ? [() => componentWrapperPlugin(filename, rootDir, dev)] : [],
     presets: [
       [tsPreset, {}],
       [solidPreset, { generate: mode, hydratable: false }],