@ecopages/browser-router 0.2.0-alpha.3 → 0.2.0-alpha.30

package/src/types.js

@@ -1,4 +1,5 @@
-import { DEFAULT_OPTIONS } from "./client/types";
+import { DEFAULT_DOCUMENT_ELEMENT_ATTRIBUTES_TO_SYNC, DEFAULT_OPTIONS } from "./client/types";
 export {
+  DEFAULT_DOCUMENT_ELEMENT_ATTRIBUTES_TO_SYNC,
   DEFAULT_OPTIONS
 };

package/src/client/eco-router.ts

@@ -1,310 +0,0 @@
-/**
- * Client-side router for Ecopages with morphdom-based DOM diffing.
- * @module eco-router
- */
-
-import type { EcoRouterOptions, EcoNavigationEvent, EcoBeforeSwapEvent, EcoAfterSwapEvent } from './types.ts';
-import { DEFAULT_OPTIONS } from './types.ts';
-import { DomSwapper, ScrollManager, ViewTransitionManager, PrefetchManager } from './services/index.ts';
-
-/**
- * Intercepts same-origin link clicks and performs client-side navigation
- * using morphdom for efficient DOM diffing. Supports View Transitions API.
- */
-export class EcoRouter {
-	private options: Required<EcoRouterOptions>;
-	private abortController: AbortController | null = null;
-
-	private domSwapper: DomSwapper;
-	private scrollManager: ScrollManager;
-	private viewTransitionManager: ViewTransitionManager;
-	private prefetchManager: PrefetchManager | null = null;
-
-	constructor(options: EcoRouterOptions = {}) {
-		this.options = { ...DEFAULT_OPTIONS, ...options };
-
-		this.domSwapper = new DomSwapper(this.options.persistAttribute);
-		this.scrollManager = new ScrollManager(this.options.scrollBehavior, this.options.smoothScroll);
-		this.viewTransitionManager = new ViewTransitionManager(this.options.viewTransitions);
-
-		if (this.options.prefetch !== false) {
-			this.prefetchManager = new PrefetchManager({
-				...this.options.prefetch,
-				linkSelector: this.options.linkSelector,
-			});
-		}
-
-		this.handleClick = this.handleClick.bind(this);
-		this.handlePopState = this.handlePopState.bind(this);
-	}
-
-	/**
-	 * Starts the router and begins intercepting navigation.
-	 *
-	 * Attaches click handlers for links and popstate handlers for browser
-	 * back/forward buttons. Also starts the prefetch manager if configured.
-	 */
-	public start(): void {
-		document.addEventListener('click', this.handleClick);
-		window.addEventListener('popstate', this.handlePopState);
-		this.prefetchManager?.start();
-
-		const windowWithHmr = window as typeof window & {
-			__ecopages_reload_current_page__?: (options: { clearCache: boolean }) => Promise<void>;
-		};
-
-		windowWithHmr.__ecopages_reload_current_page__ = async (options: { clearCache: boolean }) => {
-			const currentUrl = window.location.pathname + window.location.search;
-
-			if (options.clearCache) {
-				this.prefetchManager?.invalidate(currentUrl);
-			}
-
-			await this.performNavigation(new URL(currentUrl, window.location.origin), 'replace');
-		};
-
-		// Cache the initial page for instant back-navigation
-		const initialHtml = document.documentElement.outerHTML;
-		this.prefetchManager?.cacheVisitedPage(window.location.href, initialHtml);
-	}
-
-	/**
-	 * Stops the router and cleans up all event listeners.
-	 * After calling this, navigation will fall back to full page reloads.
-	 */
-	public stop(): void {
-		document.removeEventListener('click', this.handleClick);
-		window.removeEventListener('popstate', this.handlePopState);
-		this.prefetchManager?.stop();
-
-		const windowWithHmr = window as typeof window & {
-			__ecopages_reload_current_page__?: (options: { clearCache: boolean }) => Promise<void>;
-		};
-
-		windowWithHmr.__ecopages_reload_current_page__ = undefined;
-	}
-
-	/**
-	 * Programmatic navigation.
-	 * Falls back to full page reload for cross-origin URLs.
-	 * @param href - The URL to navigate to
-	 * @param options - Navigation options
-	 * @param options.replace - If true, replaces the current history entry instead of pushing
-	 */
-	public async navigate(href: string, options: { replace?: boolean } = {}): Promise<void> {
-		const url = new URL(href, window.location.origin);
-
-		if (!this.isSameOrigin(url)) {
-			window.location.href = href;
-			return;
-		}
-
-		await this.performNavigation(url, options.replace ? 'replace' : 'forward');
-	}
-
-	/**
-	 * Manually prefetch a URL.
-	 * @param href - The URL to prefetch
-	 */
-	public async prefetch(href: string): Promise<void> {
-		if (!this.prefetchManager) {
-			console.warn('[ecopages] Prefetching is disabled. Enable it in router options.');
-			return;
-		}
-		return this.prefetchManager.prefetch(href);
-	}
-
-	/**
-	 * Intercepts link clicks for client-side navigation.
-	 *
-	 * Filters out clicks with modifier keys (opens new tab), non-left clicks,
-	 * external links, download links, and links with the reload attribute.
-	 *
-	 * Uses `event.composedPath()` to correctly detect clicks on anchors inside
-	 * Shadow DOM boundaries (Web Components).
-	 */
-	private handleClick(event: MouseEvent): void {
-		const link = event
-			.composedPath()
-			.find(
-				(el) => el instanceof HTMLAnchorElement && el.matches(this.options.linkSelector),
-			) as HTMLAnchorElement | null;
-
-		if (!link) return;
-
-		if (event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) return;
-		if (event.button !== 0) return;
-
-		const target = link.getAttribute('target');
-		if (target && target !== '_self') return;
-
-		if (link.hasAttribute(this.options.reloadAttribute)) return;
-		if (link.hasAttribute('download')) return;
-
-		const href = link.getAttribute('href');
-		if (!href) return;
-
-		if (href.startsWith('#')) return;
-		if (href.startsWith('javascript:')) return;
-
-		const url = new URL(href, window.location.origin);
-
-		if (!this.isSameOrigin(url)) return;
-
-		event.preventDefault();
-		this.performNavigation(url, 'forward');
-	}
-
-	/**
-	 * Handles browser back/forward navigation.
-	 * Triggered by the History API's popstate event.
-	 */
-	private handlePopState(_event: PopStateEvent): void {
-		const url = new URL(window.location.href);
-		this.performNavigation(url, 'back');
-	}
-
-	/**
-	 * Checks if a URL shares the same origin as the current page.
-	 * Cross-origin navigation always falls back to full page reload.
-	 */
-	private isSameOrigin(url: URL): boolean {
-		return url.origin === window.location.origin;
-	}
-
-	/**
-	 * Executes the core navigation flow.
-	 *
-	 * Orchestrates fetching, DOM swapping, and lifecycle events:
-	 *
-	 * 1. **Fetch** - Retrieves HTML (from cache or network)
-	 * 2. **eco:before-swap** - Allows listeners to force a full reload
-	 * 3. **History update** - Updates URL before DOM swap so Web Components
-	 *    see the correct URL in their `connectedCallback`
-	 * 4. **Stylesheet preload** - Prevents FOUC by loading styles first
-	 * 5. **DOM swap** - Morphs head/body, optionally with View Transition
-	 * 6. **Lifecycle events** - Dispatches `eco:after-swap` and `eco:page-load`
-	 *
-	 * Falls back to full page reload on network errors.
-	 *
-	 * @param url - The target URL to navigate to
-	 * @param direction - Navigation direction ('forward', 'back', or 'replace')
-	 */
-	private async performNavigation(url: URL, direction: EcoNavigationEvent['direction']): Promise<void> {
-		const previousUrl = new URL(window.location.href);
-
-		this.abortController?.abort();
-		this.abortController = new AbortController();
-
-		try {
-			const html = await this.fetchPage(url, this.abortController.signal);
-			const newDocument = this.domSwapper.parseHTML(html, url);
-
-			let shouldReload = false;
-			const beforeSwapEvent: EcoBeforeSwapEvent = {
-				url,
-				direction,
-				newDocument,
-				reload: () => {
-					shouldReload = true;
-				},
-			};
-
-			document.dispatchEvent(new CustomEvent('eco:before-swap', { detail: beforeSwapEvent }));
-
-			if (shouldReload) {
-				window.location.href = url.href;
-				return;
-			}
-
-			if (this.options.updateHistory && direction === 'forward') {
-				window.history.pushState({}, '', url.href);
-			} else if (direction === 'replace') {
-				window.history.replaceState({}, '', url.href);
-			}
-
-			const useViewTransitions = this.options.viewTransitions;
-			await this.domSwapper.preloadStylesheets(newDocument);
-
-			if (useViewTransitions) {
-				await this.viewTransitionManager.transition(() => {
-					this.domSwapper.morphHead(newDocument);
-					this.domSwapper.morphBody(newDocument);
-					this.scrollManager.handleScroll(url, previousUrl);
-				});
-			} else {
-				this.domSwapper.morphHead(newDocument);
-				this.domSwapper.replaceBody(newDocument);
-				this.scrollManager.handleScroll(url, previousUrl);
-			}
-
-			const afterSwapEvent: EcoAfterSwapEvent = {
-				url,
-				direction,
-			};
-
-			document.dispatchEvent(new CustomEvent('eco:after-swap', { detail: afterSwapEvent }));
-
-			this.prefetchManager?.observeNewLinks();
-
-			// Cache the visited page for instant revisits (stale-while-revalidate)
-			this.prefetchManager?.cacheVisitedPage(url.href, html);
-
-			requestAnimationFrame(() => {
-				document.dispatchEvent(
-					new CustomEvent('eco:page-load', {
-						detail: { url, direction } as EcoNavigationEvent,
-					}),
-				);
-			});
-		} catch (error) {
-			if (error instanceof Error && error.name === 'AbortError') {
-				return;
-			}
-
-			console.error('[ecopages] Navigation failed:', error);
-			window.location.href = url.href;
-		}
-	}
-
-	/**
-	 * Fetches the HTML content of a page.
-	 * @param url - The URL to fetch
-	 * @param signal - AbortSignal for cancelling the request
-	 * @throws Error if the response is not ok
-	 */
-	private async fetchPage(url: URL, signal: AbortSignal): Promise<string> {
-		if (this.prefetchManager) {
-			const cachedHtml = this.prefetchManager.getCachedHtml(url.href);
-			if (cachedHtml) {
-				return cachedHtml;
-			}
-		}
-
-		const response = await fetch(url.href, {
-			signal,
-			headers: {
-				Accept: 'text/html',
-			},
-		});
-
-		if (!response.ok) {
-			throw new Error(`Failed to fetch page: ${response.status}`);
-		}
-
-		return response.text();
-	}
-}
-
-/**
- * Creates and starts a router instance.
- * @param options - Configuration options for the router
- * @returns A started EcoRouter instance
- */
-export function createRouter(options?: EcoRouterOptions): EcoRouter {
-	const router = new EcoRouter(options);
-	router.start();
-	return router;
-}
-
-export type { EcoRouterOptions, EcoNavigationEvent, EcoBeforeSwapEvent, EcoAfterSwapEvent } from './types';