@sigil-dev/grimoire 0.9.24 → 0.9.26
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.
- package/package.json +3 -3
- package/src/client/router.ts +46 -3
- package/src/dev/hmr-client.ts +229 -202
- package/src/rendering/index.ts +40 -16
- package/src/routing/router.ts +15 -8
- package/src/routing/scanner.ts +14 -3
- package/src/server/index.ts +1171 -1154
- package/src/server/prerender.ts +15 -3
- package/src/server/public-assets.ts +133 -0
- package/test/env.test.ts +3 -3
- package/test/prerender.test.ts +29 -4
- package/test/public-assets.test.ts +108 -0
- package/test/route-group-layouts.test.ts +36 -0
package/package.json
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
"module": "index.ts",
|
|
12
12
|
"type": "module",
|
|
13
13
|
"private": false,
|
|
14
|
-
"version": "0.9.
|
|
14
|
+
"version": "0.9.26",
|
|
15
15
|
"exports": {
|
|
16
16
|
".": "./index.ts",
|
|
17
17
|
"./server": "./server.ts",
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
"test": "bun test"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@sigil-dev/compiler": "0.9.
|
|
39
|
-
"@sigil-dev/runtime": "0.9.
|
|
38
|
+
"@sigil-dev/compiler": "0.9.26",
|
|
39
|
+
"@sigil-dev/runtime": "0.9.26",
|
|
40
40
|
"vite": "^8.0.16"
|
|
41
41
|
},
|
|
42
42
|
"peerDependencies": {
|
package/src/client/router.ts
CHANGED
|
@@ -115,9 +115,14 @@ export async function hmrRerender(): Promise<void> {
|
|
|
115
115
|
});
|
|
116
116
|
popHydrationNodes();
|
|
117
117
|
const preserved = capturePreservedScroll();
|
|
118
|
+
// swapping the root can shrink the document for a moment, and the browser
|
|
119
|
+
// clamps scrollY to the shorter height; put the page back where it was
|
|
120
|
+
const y = window.scrollY;
|
|
118
121
|
document.getElementById("grimoire-root")?.replaceChildren(rootNode);
|
|
119
122
|
flush();
|
|
120
123
|
restorePreservedScroll(preserved);
|
|
124
|
+
window.scrollTo(0, y);
|
|
125
|
+
requestAnimationFrame(() => window.scrollTo(0, y));
|
|
121
126
|
}
|
|
122
127
|
|
|
123
128
|
/**
|
|
@@ -267,7 +272,9 @@ function prefetchKey(url: URL): string {
|
|
|
267
272
|
* `dataFileFor` in server/prerender.ts.
|
|
268
273
|
*/
|
|
269
274
|
function navigateTarget(path: string): string {
|
|
270
|
-
if (
|
|
275
|
+
if (
|
|
276
|
+
(globalThis as { __grimoire_static__?: unknown }).__grimoire_static__ !== 1
|
|
277
|
+
) {
|
|
271
278
|
return path;
|
|
272
279
|
}
|
|
273
280
|
const { pathname } = new URL(path, location.origin);
|
|
@@ -332,6 +339,33 @@ function takePrefetched(path: string): Promise<Response> | null {
|
|
|
332
339
|
return hit.res;
|
|
333
340
|
}
|
|
334
341
|
|
|
342
|
+
/**
|
|
343
|
+
* The server points `<link rel="stylesheet">` at `/style.<hash>.css`, but a
|
|
344
|
+
* link the router renders after a navigation is built from the component's own
|
|
345
|
+
* `/style.css`. Point it at the hashed URL too, so it hits the cached copy
|
|
346
|
+
* instead of revalidating the plain one.
|
|
347
|
+
*/
|
|
348
|
+
function setupStylesheetHashes(): void {
|
|
349
|
+
const map = (globalThis as { __grimoire_css__?: Record<string, string> })
|
|
350
|
+
.__grimoire_css__;
|
|
351
|
+
if (!map || typeof MutationObserver === "undefined") return;
|
|
352
|
+
const fix = (el: Element) => {
|
|
353
|
+
if (!(el instanceof HTMLLinkElement) || el.rel !== "stylesheet") return;
|
|
354
|
+
const hashed = map[el.getAttribute("href") ?? ""];
|
|
355
|
+
if (hashed) el.setAttribute("href", hashed);
|
|
356
|
+
};
|
|
357
|
+
new MutationObserver((records) => {
|
|
358
|
+
for (const r of records) {
|
|
359
|
+
for (const node of r.addedNodes) {
|
|
360
|
+
if (node.nodeType !== 1) continue;
|
|
361
|
+
fix(node as Element);
|
|
362
|
+
for (const l of (node as Element).querySelectorAll?.("link") ?? [])
|
|
363
|
+
fix(l);
|
|
364
|
+
}
|
|
365
|
+
}
|
|
366
|
+
}).observe(document.documentElement, { childList: true, subtree: true });
|
|
367
|
+
}
|
|
368
|
+
|
|
335
369
|
function setupPreload(): void {
|
|
336
370
|
// Hover is a desktop signal; a short delay ignores cursors passing over.
|
|
337
371
|
document.addEventListener("mouseover", (e) => {
|
|
@@ -525,6 +559,9 @@ export async function navigate(
|
|
|
525
559
|
}
|
|
526
560
|
onNavigateCb?.(seen);
|
|
527
561
|
saveScrollPosition();
|
|
562
|
+
// read before the loading placeholder below collapses the page and the
|
|
563
|
+
// browser clamps scrollY; a same-path refetch restores this value
|
|
564
|
+
const startY = window.scrollY;
|
|
528
565
|
|
|
529
566
|
// load the loading immediately
|
|
530
567
|
const destPattern = findPattern(url.pathname);
|
|
@@ -661,8 +698,13 @@ export async function navigate(
|
|
|
661
698
|
return;
|
|
662
699
|
}
|
|
663
700
|
// fresh navigation starts at the top; a same-path replace
|
|
664
|
-
// (invalidate/refetch) keeps the
|
|
665
|
-
if (!isRefetch)
|
|
701
|
+
// (invalidate/refetch) keeps the scroll it started with
|
|
702
|
+
if (!isRefetch) {
|
|
703
|
+
scrollToTop();
|
|
704
|
+
return;
|
|
705
|
+
}
|
|
706
|
+
window.scrollTo(0, startY);
|
|
707
|
+
requestAnimationFrame(() => window.scrollTo(0, startY));
|
|
666
708
|
};
|
|
667
709
|
|
|
668
710
|
// View transitions: animate the swap when the browser supports it and the
|
|
@@ -799,6 +841,7 @@ export function initRouter(
|
|
|
799
841
|
navigate(location.pathname + location.search, { history: "none" });
|
|
800
842
|
});
|
|
801
843
|
setupPreload();
|
|
844
|
+
setupStylesheetHashes();
|
|
802
845
|
}
|
|
803
846
|
|
|
804
847
|
/**
|
package/src/dev/hmr-client.ts
CHANGED
|
@@ -1,202 +1,229 @@
|
|
|
1
|
-
export const HMR_CLIENT_SOURCE = `
|
|
2
|
-
(function() {
|
|
3
|
-
let version = 0;
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
);
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
.
|
|
161
|
-
.
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
1
|
+
export const HMR_CLIENT_SOURCE = `
|
|
2
|
+
(function() {
|
|
3
|
+
let version = 0;
|
|
4
|
+
|
|
5
|
+
// The router turns off the browser's scroll restoration, so a full reload
|
|
6
|
+
// would land at the top. Stash the offset and put it back after the reload.
|
|
7
|
+
const SCROLL_KEY = '__sigil_hmr_scroll__';
|
|
8
|
+
|
|
9
|
+
function reload() {
|
|
10
|
+
try {
|
|
11
|
+
sessionStorage.setItem(SCROLL_KEY, JSON.stringify({
|
|
12
|
+
path: location.pathname + location.search,
|
|
13
|
+
y: window.scrollY,
|
|
14
|
+
}));
|
|
15
|
+
} catch {}
|
|
16
|
+
location.reload();
|
|
17
|
+
}
|
|
18
|
+
|
|
19
|
+
(function restoreScroll() {
|
|
20
|
+
let saved = null;
|
|
21
|
+
try {
|
|
22
|
+
saved = JSON.parse(sessionStorage.getItem(SCROLL_KEY) || 'null');
|
|
23
|
+
sessionStorage.removeItem(SCROLL_KEY);
|
|
24
|
+
} catch {}
|
|
25
|
+
if (!saved || saved.path !== location.pathname + location.search) return;
|
|
26
|
+
const apply = () => window.scrollTo(0, saved.y);
|
|
27
|
+
apply();
|
|
28
|
+
requestAnimationFrame(apply);
|
|
29
|
+
window.addEventListener('load', apply, { once: true });
|
|
30
|
+
})();
|
|
31
|
+
|
|
32
|
+
const moduleUrl = (entry) =>
|
|
33
|
+
'/__grimoire__/m/' + entry.modUrl + '?v=' + entry.version;
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* Apply one server batch. Route and layout modules are re-imported at
|
|
37
|
+
* their new versions; the module the browser fetches carries version
|
|
38
|
+
* stamps on its own imports, so an edited component two levels down comes
|
|
39
|
+
* back fresh instead of out of the module cache.
|
|
40
|
+
*/
|
|
41
|
+
async function applyBatch(payloads) {
|
|
42
|
+
const css = [];
|
|
43
|
+
const routes = [];
|
|
44
|
+
const layouts = [];
|
|
45
|
+
let invalidate = false;
|
|
46
|
+
|
|
47
|
+
for (const p of payloads) {
|
|
48
|
+
if (p.kind === 'reload') { reload(); return; }
|
|
49
|
+
if (p.kind === 'css') css.push(p);
|
|
50
|
+
if (p.kind === 'routes') routes.push(...p.entries);
|
|
51
|
+
if (p.kind === 'layouts') layouts.push(...p.entries);
|
|
52
|
+
if (p.kind === 'invalidate') invalidate = true;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
for (const p of css) applyCss(p.hash, p.text);
|
|
56
|
+
|
|
57
|
+
const hmr = window.__grimoire_hmr__;
|
|
58
|
+
if (!hmr) { reload(); return; }
|
|
59
|
+
|
|
60
|
+
const current = window.__grimoire_current_pattern__;
|
|
61
|
+
captureSignals();
|
|
62
|
+
try {
|
|
63
|
+
// layouts wrap every page: always needed, so import eagerly
|
|
64
|
+
for (const entry of layouts) {
|
|
65
|
+
const mod = await import(moduleUrl(entry));
|
|
66
|
+
if (!mod.default) throw new Error('layout ' + entry.path + ' has no default export');
|
|
67
|
+
hmr.setLayout(entry.path, mod.default);
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
let touchesCurrent = layouts.length > 0;
|
|
71
|
+
for (const entry of routes) {
|
|
72
|
+
if (entry.pattern === current) {
|
|
73
|
+
const mod = await import(moduleUrl(entry));
|
|
74
|
+
if (!mod.default) throw new Error('route ' + entry.pattern + ' has no default export');
|
|
75
|
+
hmr.setRoute(entry.pattern, mod.default);
|
|
76
|
+
touchesCurrent = true;
|
|
77
|
+
} else {
|
|
78
|
+
// not on screen — re-register lazily so the next
|
|
79
|
+
// navigation picks up the new version
|
|
80
|
+
const url = moduleUrl(entry);
|
|
81
|
+
hmr.setRoute(entry.pattern, { __lazy: () => import(url) });
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// a changed load()/action means the rendered data is stale too:
|
|
86
|
+
// refetch instead of re-rendering against the old payload
|
|
87
|
+
if (invalidate) await refetchCurrent();
|
|
88
|
+
else if (touchesCurrent) await hmr.rerender();
|
|
89
|
+
} catch (e) {
|
|
90
|
+
console.error('[sigil hmr] swap failed, reloading:', e);
|
|
91
|
+
reload();
|
|
92
|
+
} finally {
|
|
93
|
+
clearCapture();
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
async function refetchCurrent() {
|
|
98
|
+
if (window.__grimoire_navigate__) {
|
|
99
|
+
await window.__grimoire_navigate__(location.pathname, true);
|
|
100
|
+
} else {
|
|
101
|
+
reload();
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
function applyCss(hash, text) {
|
|
106
|
+
let el = document.getElementById('sigil-' + hash);
|
|
107
|
+
if (!el) {
|
|
108
|
+
el = document.createElement('style');
|
|
109
|
+
el.id = 'sigil-' + hash;
|
|
110
|
+
document.head.appendChild(el);
|
|
111
|
+
}
|
|
112
|
+
el.textContent = text;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
const __hmrRegistry__ = new Map(); // key -> signal getter fn
|
|
116
|
+
|
|
117
|
+
window.__hmrAdopt__ = function(key, initial) {
|
|
118
|
+
if (!window.__hmrCapture__) return initial;
|
|
119
|
+
if (!window.__hmrCapture__.has(key)) return initial;
|
|
120
|
+
const stored = window.__hmrCapture__.get(key);
|
|
121
|
+
// shape guard — only adopt if same type and array-ness
|
|
122
|
+
if (typeof stored !== typeof initial) return initial;
|
|
123
|
+
if (Array.isArray(stored) !== Array.isArray(initial)) return initial;
|
|
124
|
+
return stored;
|
|
125
|
+
};
|
|
126
|
+
|
|
127
|
+
window.__hmrRegister__ = function(key, signal) {
|
|
128
|
+
__hmrRegistry__.set(key, signal);
|
|
129
|
+
};
|
|
130
|
+
|
|
131
|
+
function captureSignals() {
|
|
132
|
+
window.__hmrCapture__ = new Map();
|
|
133
|
+
for (const [key, signal] of __hmrRegistry__) {
|
|
134
|
+
try { window.__hmrCapture__.set(key, signal()); } catch {}
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function clearCapture() {
|
|
139
|
+
window.__hmrCapture__ = null;
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
function connect() {
|
|
143
|
+
const ws = new WebSocket(
|
|
144
|
+
(location.protocol === 'https:' ? 'wss' : 'ws') +
|
|
145
|
+
'://' + location.host + '/__grimoire__/hmr'
|
|
146
|
+
);
|
|
147
|
+
|
|
148
|
+
ws.onopen = () => {
|
|
149
|
+
console.log('[sigil hmr] connected');
|
|
150
|
+
document.getElementById('__grimoire_overlay__')?.remove();
|
|
151
|
+
};
|
|
152
|
+
|
|
153
|
+
ws.onmessage = async (ev) => {
|
|
154
|
+
const msg = JSON.parse(ev.data);
|
|
155
|
+
if (msg.type === 'error') { showOverlay(msg.message, msg.loc); return; }
|
|
156
|
+
if (msg.v !== undefined && msg.v <= version) return;
|
|
157
|
+
if (msg.v !== undefined) version = msg.v;
|
|
158
|
+
|
|
159
|
+
if (msg.type === 'batch') {
|
|
160
|
+
document.getElementById('__grimoire_overlay__')?.remove();
|
|
161
|
+
await applyBatch(msg.payloads);
|
|
162
|
+
}
|
|
163
|
+
};
|
|
164
|
+
|
|
165
|
+
ws.onclose = () => {
|
|
166
|
+
console.log('[sigil hmr] disconnected, reconnecting...');
|
|
167
|
+
const retry = setInterval(async () => {
|
|
168
|
+
try {
|
|
169
|
+
await fetch('/', { method: 'HEAD' });
|
|
170
|
+
clearInterval(retry);
|
|
171
|
+
reload();
|
|
172
|
+
} catch {}
|
|
173
|
+
}, 300);
|
|
174
|
+
};
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
function stripAnsi(str) {
|
|
178
|
+
return str.replace(/\u001b[[0-9;]*m/g, '');
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
function unescapeHtml(str) {
|
|
182
|
+
let result = str;
|
|
183
|
+
// run twice to handle double-escaped entities
|
|
184
|
+
for (let i = 0; i < 2; i++) {
|
|
185
|
+
result = result
|
|
186
|
+
.replace(/&/g, '&')
|
|
187
|
+
.replace(/</g, '<')
|
|
188
|
+
.replace(/>/g, '>')
|
|
189
|
+
.replace(/"/g, '"')
|
|
190
|
+
.replace(/'/g, "'");
|
|
191
|
+
}
|
|
192
|
+
return result;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
function showOverlay(message, loc) {
|
|
196
|
+
document.getElementById('__grimoire_overlay__')?.remove();
|
|
197
|
+
const clean = unescapeHtml(stripAnsi(message));
|
|
198
|
+
const d = document.createElement('div');
|
|
199
|
+
d.id = '__grimoire_overlay__';
|
|
200
|
+
d.style.cssText = [
|
|
201
|
+
'position:fixed;inset:0;z-index:99999',
|
|
202
|
+
'background:rgba(15,15,20,.94)',
|
|
203
|
+
'color:#ff8a8a',
|
|
204
|
+
'font:13px/1.6 monospace',
|
|
205
|
+
'padding:40px',
|
|
206
|
+
'overflow:auto',
|
|
207
|
+
'white-space:pre-wrap',
|
|
208
|
+
].join(';');
|
|
209
|
+
|
|
210
|
+
d.textContent = '[sigil] compile error\\n\\n' + clean;
|
|
211
|
+
|
|
212
|
+
if (loc) {
|
|
213
|
+
const link = document.createElement('a');
|
|
214
|
+
link.href = '/__grimoire__/open?file=' + encodeURIComponent(loc.file) +
|
|
215
|
+
'&line=' + loc.line + '&col=' + loc.col;
|
|
216
|
+
link.style.cssText = 'color:#88aaff;text-decoration:underline;cursor:pointer;display:block;margin:8px 0 16px';
|
|
217
|
+
link.textContent = loc.file + ':' + loc.line + ':' + loc.col;
|
|
218
|
+
link.onclick = (e) => { e.preventDefault(); fetch(link.href); };
|
|
219
|
+
d.appendChild(link);
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
d.title = 'Click anywhere to dismiss';
|
|
223
|
+
d.onclick = (ev) => { if (ev.target === d) d.remove(); };
|
|
224
|
+
document.body.appendChild(d);
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
connect();
|
|
228
|
+
})();
|
|
229
|
+
`;
|