@ecopages/browser-router 0.2.0-alpha.2 → 0.2.0-alpha.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/CHANGELOG.md +8 -6
  2. package/README.md +60 -37
  3. package/package.json +4 -2
  4. package/src/client/document-element-sync.d.ts +24 -0
  5. package/src/client/document-element-sync.js +20 -0
  6. package/src/client/eco-router.d.ts +35 -1
  7. package/src/client/eco-router.js +337 -68
  8. package/src/client/services/dom-swapper.d.ts +101 -0
  9. package/src/client/services/dom-swapper.js +306 -39
  10. package/src/client/services/prefetch-manager.d.ts +7 -3
  11. package/src/client/services/prefetch-manager.js +26 -11
  12. package/src/client/services/view-transition-manager.d.ts +7 -1
  13. package/src/client/services/view-transition-manager.js +21 -5
  14. package/src/client/types.d.ts +12 -0
  15. package/src/client/types.js +4 -0
  16. package/src/index.d.ts +2 -1
  17. package/src/index.js +9 -2
  18. package/src/types.d.ts +1 -1
  19. package/src/types.js +2 -1
  20. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Initialization-should-create-router-instance-1.png +0 -0
  21. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Initialization-should-start-and-stop-without-errors-1.png +0 -0
  22. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Lifecycle-Events-should-dispatch-eco-before-swap--eco-after-swap--and-eco-page-load-events-1.png +0 -0
  23. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Lifecycle-Events-should-dispatch-eco-page-load-event-after-animation-frame-1.png +0 -0
  24. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Lifecycle-Events-should-provide-event-details-with-url-and-direction-1.png +0 -0
  25. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Custom-Link-Selector-should-work-with-data-attribute-selector-1.png +0 -0
  26. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Custom-Reload-Attribute-should-intercept-links-with-default-reload-attribute-when-custom-is-set-1.png +0 -0
  27. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Custom-link-selector-should-only-intercept-links-matching-custom-selector-1.png +0 -0
  28. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-External-Links--should-NOT-intercept--should-NOT-intercept-external-links-1.png +0 -0
  29. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Internal-Links-should-intercept-clicks-on-relative-path-links-1.png +0 -0
  30. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Internal-Links-should-intercept-clicks-on-same-origin-absolute-URLs-1.png +0 -0
  31. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Link-Attributes--should-NOT-intercept--should-NOT-intercept-links-with-download-attribute-1.png +0 -0
  32. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Link-Attributes--should-NOT-intercept--should-intercept-links-with-target---self--1.png +0 -0
  33. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Modifier-keys-should-NOT-intercept-alt-click-1.png +0 -0
  34. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Modifier-keys-should-NOT-intercept-ctrl-click-1.png +0 -0
  35. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Modifier-keys-should-NOT-intercept-meta-click--cmd-on-Mac--1.png +0 -0
  36. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Modifier-keys-should-NOT-intercept-middle-mouse-button-click-1.png +0 -0
  37. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Modifier-keys-should-NOT-intercept-right-mouse-button-click-1.png +0 -0
  38. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Modifier-keys-should-NOT-intercept-shift-click-1.png +0 -0
  39. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-external-links--different-origin--1.png +0 -0
  40. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-hash-only-links-1.png +0 -0
  41. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-javascript--links-1.png +0 -0
  42. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-with-custom-reload-attribute-1.png +0 -0
  43. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-with-data-eco-reload-attribute-1.png +0 -0
  44. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-with-download-attribute-1.png +0 -0
  45. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-with-empty-href-1.png +0 -0
  46. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-with-target---blank--1.png +0 -0
  47. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-with-target---parent--1.png +0 -0
  48. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-NOT-intercept-links-without-href-attribute-1.png +0 -0
  49. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-intercept-internal-links-with-absolute-same-origin-paths-1.png +0 -0
  50. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-intercept-internal-links-with-relative-paths-1.png +0 -0
  51. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-Should-intercept-nested-elements-inside-links-1.png +0 -0
  52. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Link-Interception-should-NOT-intercept-external-links-1.png +0 -0
  53. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Navigation-Abort-should-abort-previous-navigation-when-new-one-starts-1.png +0 -0
  54. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Programmatic-Navigation-should-navigate-and-update-history-with-pushState-1.png +0 -0
  55. package/src/client/__screenshots__/eco-router.test.browser.ts/EcoRouter-Programmatic-Navigation-should-use-replaceState-when-replace-option-is-true-1.png +0 -0
  56. package/src/client/__screenshots__/eco-router.test.ts/EcoRouter-Error-Handling-should-fall-back-to-full-page-navigation-on-fetch-error-1.png +0 -0
  57. package/src/client/__screenshots__/eco-router.test.ts/EcoRouter-Error-Handling-should-log-error-and-attempt-fallback-navigation-on-fetch-error-1.png +0 -0
  58. package/src/client/eco-router.ts +0 -290
  59. package/src/client/services/dom-swapper.ts +0 -325
  60. package/src/client/services/index.ts +0 -9
  61. package/src/client/services/prefetch-manager.ts +0 -451
  62. package/src/client/services/scroll-manager.ts +0 -48
  63. package/src/client/services/view-transition-manager.ts +0 -75
  64. package/src/client/types.ts +0 -109
  65. package/src/client/view-transition-utils.ts +0 -98
  66. package/src/index.ts +0 -19
  67. package/src/types.ts +0 -19
package/src/types.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  */
5
5
  import type { EcoNavigationEvent, EcoBeforeSwapEvent, EcoAfterSwapEvent } from './client/types';
6
6
  export type { EcoRouterOptions, EcoNavigationEvent, EcoBeforeSwapEvent, EcoAfterSwapEvent } from './client/types';
7
- export { DEFAULT_OPTIONS } from './client/types';
7
+ export { DEFAULT_DOCUMENT_ELEMENT_ATTRIBUTES_TO_SYNC, DEFAULT_OPTIONS } from './client/types';
8
8
  /**
9
9
  * Custom event map for navigation lifecycle
10
10
  */
package/src/types.js CHANGED
@@ -1,4 +1,5 @@
1
- import { DEFAULT_OPTIONS } from "./client/types";
1
+ import { DEFAULT_DOCUMENT_ELEMENT_ATTRIBUTES_TO_SYNC, DEFAULT_OPTIONS } from "./client/types";
2
2
  export {
3
+ DEFAULT_DOCUMENT_ELEMENT_ATTRIBUTES_TO_SYNC,
3
4
  DEFAULT_OPTIONS
4
5
  };
@@ -1,290 +0,0 @@
1
- /**
2
- * Client-side router for Ecopages with morphdom-based DOM diffing.
3
- * @module eco-router
4
- */
5
-
6
- import type { EcoRouterOptions, EcoNavigationEvent, EcoBeforeSwapEvent, EcoAfterSwapEvent } from './types.ts';
7
- import { DEFAULT_OPTIONS } from './types.ts';
8
- import { DomSwapper, ScrollManager, ViewTransitionManager, PrefetchManager } from './services/index.ts';
9
-
10
- /**
11
- * Intercepts same-origin link clicks and performs client-side navigation
12
- * using morphdom for efficient DOM diffing. Supports View Transitions API.
13
- */
14
- export class EcoRouter {
15
- private options: Required<EcoRouterOptions>;
16
- private abortController: AbortController | null = null;
17
-
18
- private domSwapper: DomSwapper;
19
- private scrollManager: ScrollManager;
20
- private viewTransitionManager: ViewTransitionManager;
21
- private prefetchManager: PrefetchManager | null = null;
22
-
23
- constructor(options: EcoRouterOptions = {}) {
24
- this.options = { ...DEFAULT_OPTIONS, ...options };
25
-
26
- this.domSwapper = new DomSwapper(this.options.persistAttribute);
27
- this.scrollManager = new ScrollManager(this.options.scrollBehavior, this.options.smoothScroll);
28
- this.viewTransitionManager = new ViewTransitionManager(this.options.viewTransitions);
29
-
30
- if (this.options.prefetch !== false) {
31
- this.prefetchManager = new PrefetchManager({
32
- ...this.options.prefetch,
33
- linkSelector: this.options.linkSelector,
34
- });
35
- }
36
-
37
- this.handleClick = this.handleClick.bind(this);
38
- this.handlePopState = this.handlePopState.bind(this);
39
- }
40
-
41
- /**
42
- * Starts the router and begins intercepting navigation.
43
- *
44
- * Attaches click handlers for links and popstate handlers for browser
45
- * back/forward buttons. Also starts the prefetch manager if configured.
46
- */
47
- public start(): void {
48
- document.addEventListener('click', this.handleClick);
49
- window.addEventListener('popstate', this.handlePopState);
50
- this.prefetchManager?.start();
51
-
52
- // Cache the initial page for instant back-navigation
53
- const initialHtml = document.documentElement.outerHTML;
54
- this.prefetchManager?.cacheVisitedPage(window.location.href, initialHtml);
55
- }
56
-
57
- /**
58
- * Stops the router and cleans up all event listeners.
59
- * After calling this, navigation will fall back to full page reloads.
60
- */
61
- public stop(): void {
62
- document.removeEventListener('click', this.handleClick);
63
- window.removeEventListener('popstate', this.handlePopState);
64
- this.prefetchManager?.stop();
65
- }
66
-
67
- /**
68
- * Programmatic navigation.
69
- * Falls back to full page reload for cross-origin URLs.
70
- * @param href - The URL to navigate to
71
- * @param options - Navigation options
72
- * @param options.replace - If true, replaces the current history entry instead of pushing
73
- */
74
- public async navigate(href: string, options: { replace?: boolean } = {}): Promise<void> {
75
- const url = new URL(href, window.location.origin);
76
-
77
- if (!this.isSameOrigin(url)) {
78
- window.location.href = href;
79
- return;
80
- }
81
-
82
- await this.performNavigation(url, options.replace ? 'replace' : 'forward');
83
- }
84
-
85
- /**
86
- * Manually prefetch a URL.
87
- * @param href - The URL to prefetch
88
- */
89
- public async prefetch(href: string): Promise<void> {
90
- if (!this.prefetchManager) {
91
- console.warn('[ecopages] Prefetching is disabled. Enable it in router options.');
92
- return;
93
- }
94
- return this.prefetchManager.prefetch(href);
95
- }
96
-
97
- /**
98
- * Intercepts link clicks for client-side navigation.
99
- *
100
- * Filters out clicks with modifier keys (opens new tab), non-left clicks,
101
- * external links, download links, and links with the reload attribute.
102
- *
103
- * Uses `event.composedPath()` to correctly detect clicks on anchors inside
104
- * Shadow DOM boundaries (Web Components).
105
- */
106
- private handleClick(event: MouseEvent): void {
107
- const link = event
108
- .composedPath()
109
- .find(
110
- (el) => el instanceof HTMLAnchorElement && el.matches(this.options.linkSelector),
111
- ) as HTMLAnchorElement | null;
112
-
113
- if (!link) return;
114
-
115
- if (event.metaKey || event.ctrlKey || event.shiftKey || event.altKey) return;
116
- if (event.button !== 0) return;
117
-
118
- const target = link.getAttribute('target');
119
- if (target && target !== '_self') return;
120
-
121
- if (link.hasAttribute(this.options.reloadAttribute)) return;
122
- if (link.hasAttribute('download')) return;
123
-
124
- const href = link.getAttribute('href');
125
- if (!href) return;
126
-
127
- if (href.startsWith('#')) return;
128
- if (href.startsWith('javascript:')) return;
129
-
130
- const url = new URL(href, window.location.origin);
131
-
132
- if (!this.isSameOrigin(url)) return;
133
-
134
- event.preventDefault();
135
- this.performNavigation(url, 'forward');
136
- }
137
-
138
- /**
139
- * Handles browser back/forward navigation.
140
- * Triggered by the History API's popstate event.
141
- */
142
- private handlePopState(_event: PopStateEvent): void {
143
- const url = new URL(window.location.href);
144
- this.performNavigation(url, 'back');
145
- }
146
-
147
- /**
148
- * Checks if a URL shares the same origin as the current page.
149
- * Cross-origin navigation always falls back to full page reload.
150
- */
151
- private isSameOrigin(url: URL): boolean {
152
- return url.origin === window.location.origin;
153
- }
154
-
155
- /**
156
- * Executes the core navigation flow.
157
- *
158
- * Orchestrates fetching, DOM swapping, and lifecycle events:
159
- *
160
- * 1. **Fetch** - Retrieves HTML (from cache or network)
161
- * 2. **eco:before-swap** - Allows listeners to force a full reload
162
- * 3. **History update** - Updates URL before DOM swap so Web Components
163
- * see the correct URL in their `connectedCallback`
164
- * 4. **Stylesheet preload** - Prevents FOUC by loading styles first
165
- * 5. **DOM swap** - Morphs head/body, optionally with View Transition
166
- * 6. **Lifecycle events** - Dispatches `eco:after-swap` and `eco:page-load`
167
- *
168
- * Falls back to full page reload on network errors.
169
- *
170
- * @param url - The target URL to navigate to
171
- * @param direction - Navigation direction ('forward', 'back', or 'replace')
172
- */
173
- private async performNavigation(url: URL, direction: EcoNavigationEvent['direction']): Promise<void> {
174
- const previousUrl = new URL(window.location.href);
175
-
176
- this.abortController?.abort();
177
- this.abortController = new AbortController();
178
-
179
- try {
180
- const html = await this.fetchPage(url, this.abortController.signal);
181
- const newDocument = this.domSwapper.parseHTML(html, url);
182
-
183
- let shouldReload = false;
184
- const beforeSwapEvent: EcoBeforeSwapEvent = {
185
- url,
186
- direction,
187
- newDocument,
188
- reload: () => {
189
- shouldReload = true;
190
- },
191
- };
192
-
193
- document.dispatchEvent(new CustomEvent('eco:before-swap', { detail: beforeSwapEvent }));
194
-
195
- if (shouldReload) {
196
- window.location.href = url.href;
197
- return;
198
- }
199
-
200
- if (this.options.updateHistory && direction === 'forward') {
201
- window.history.pushState({}, '', url.href);
202
- } else if (direction === 'replace') {
203
- window.history.replaceState({}, '', url.href);
204
- }
205
-
206
- const useViewTransitions = this.options.viewTransitions;
207
- await this.domSwapper.preloadStylesheets(newDocument);
208
-
209
- if (useViewTransitions) {
210
- await this.viewTransitionManager.transition(() => {
211
- this.domSwapper.morphHead(newDocument);
212
- this.domSwapper.morphBody(newDocument);
213
- this.scrollManager.handleScroll(url, previousUrl);
214
- });
215
- } else {
216
- this.domSwapper.morphHead(newDocument);
217
- this.domSwapper.replaceBody(newDocument);
218
- this.scrollManager.handleScroll(url, previousUrl);
219
- }
220
-
221
- const afterSwapEvent: EcoAfterSwapEvent = {
222
- url,
223
- direction,
224
- };
225
-
226
- document.dispatchEvent(new CustomEvent('eco:after-swap', { detail: afterSwapEvent }));
227
-
228
- this.prefetchManager?.observeNewLinks();
229
-
230
- // Cache the visited page for instant revisits (stale-while-revalidate)
231
- this.prefetchManager?.cacheVisitedPage(url.href, html);
232
-
233
- requestAnimationFrame(() => {
234
- document.dispatchEvent(
235
- new CustomEvent('eco:page-load', {
236
- detail: { url, direction } as EcoNavigationEvent,
237
- }),
238
- );
239
- });
240
- } catch (error) {
241
- if (error instanceof Error && error.name === 'AbortError') {
242
- return;
243
- }
244
-
245
- console.error('[ecopages] Navigation failed:', error);
246
- window.location.href = url.href;
247
- }
248
- }
249
-
250
- /**
251
- * Fetches the HTML content of a page.
252
- * @param url - The URL to fetch
253
- * @param signal - AbortSignal for cancelling the request
254
- * @throws Error if the response is not ok
255
- */
256
- private async fetchPage(url: URL, signal: AbortSignal): Promise<string> {
257
- if (this.prefetchManager) {
258
- const cachedHtml = this.prefetchManager.getCachedHtml(url.href);
259
- if (cachedHtml) {
260
- return cachedHtml;
261
- }
262
- }
263
-
264
- const response = await fetch(url.href, {
265
- signal,
266
- headers: {
267
- Accept: 'text/html',
268
- },
269
- });
270
-
271
- if (!response.ok) {
272
- throw new Error(`Failed to fetch page: ${response.status}`);
273
- }
274
-
275
- return response.text();
276
- }
277
- }
278
-
279
- /**
280
- * Creates and starts a router instance.
281
- * @param options - Configuration options for the router
282
- * @returns A started EcoRouter instance
283
- */
284
- export function createRouter(options?: EcoRouterOptions): EcoRouter {
285
- const router = new EcoRouter(options);
286
- router.start();
287
- return router;
288
- }
289
-
290
- export type { EcoRouterOptions, EcoNavigationEvent, EcoBeforeSwapEvent, EcoAfterSwapEvent } from './types';