@rangojs/router 0.0.0-experimental.77 → 0.0.0-experimental.77ed8945
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/README.md +120 -25
- package/dist/bin/rango.js +147 -57
- package/dist/vite/index.js +2103 -861
- package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
- package/package.json +13 -8
- package/skills/api-client/SKILL.md +211 -0
- package/skills/breadcrumbs/SKILL.md +3 -1
- package/skills/bundle-analysis/SKILL.md +159 -0
- package/skills/cache-guide/SKILL.md +220 -30
- package/skills/caching/SKILL.md +116 -8
- package/skills/composability/SKILL.md +27 -2
- package/skills/css/SKILL.md +76 -0
- package/skills/document-cache/SKILL.md +78 -55
- package/skills/handler-use/SKILL.md +3 -1
- package/skills/hooks/SKILL.md +229 -20
- package/skills/host-router/SKILL.md +66 -20
- package/skills/i18n/SKILL.md +276 -0
- package/skills/intercept/SKILL.md +26 -4
- package/skills/layout/SKILL.md +6 -7
- package/skills/links/SKILL.md +247 -17
- package/skills/loader/SKILL.md +219 -9
- package/skills/middleware/SKILL.md +47 -12
- package/skills/migrate-nextjs/SKILL.md +562 -0
- package/skills/migrate-react-router/SKILL.md +769 -0
- package/skills/mime-routes/SKILL.md +27 -0
- package/skills/observability/SKILL.md +137 -0
- package/skills/parallel/SKILL.md +12 -6
- package/skills/prerender/SKILL.md +14 -33
- package/skills/rango/SKILL.md +238 -22
- package/skills/react-compiler/SKILL.md +168 -0
- package/skills/response-routes/SKILL.md +122 -47
- package/skills/route/SKILL.md +33 -4
- package/skills/router-setup/SKILL.md +3 -3
- package/skills/server-actions/SKILL.md +751 -0
- package/skills/streams-and-websockets/SKILL.md +283 -0
- package/skills/tailwind/SKILL.md +27 -3
- package/skills/typesafety/SKILL.md +319 -27
- package/skills/use-cache/SKILL.md +34 -5
- package/skills/view-transitions/SKILL.md +294 -0
- package/src/__augment-tests__/augment.ts +81 -0
- package/src/__augment-tests__/augmented.check.ts +116 -0
- package/src/browser/action-coordinator.ts +53 -36
- package/src/browser/app-shell.ts +39 -0
- package/src/browser/event-controller.ts +86 -70
- package/src/browser/history-state.ts +21 -0
- package/src/browser/index.ts +3 -3
- package/src/browser/navigation-bridge.ts +29 -9
- package/src/browser/navigation-client.ts +99 -77
- package/src/browser/navigation-store.ts +7 -8
- package/src/browser/navigation-transaction.ts +10 -28
- package/src/browser/partial-update.ts +60 -40
- package/src/browser/prefetch/cache.ts +196 -49
- package/src/browser/prefetch/fetch.ts +203 -59
- package/src/browser/prefetch/queue.ts +36 -5
- package/src/browser/rango-state.ts +37 -13
- package/src/browser/react/Link.tsx +18 -13
- package/src/browser/react/NavigationProvider.tsx +75 -31
- package/src/browser/react/filter-segment-order.ts +51 -7
- package/src/browser/react/index.ts +3 -0
- package/src/browser/react/location-state-shared.ts +175 -4
- package/src/browser/react/location-state.ts +39 -13
- package/src/browser/react/use-handle.ts +17 -9
- package/src/browser/react/use-navigation.ts +22 -2
- package/src/browser/react/use-params.ts +20 -8
- package/src/browser/react/use-reverse.ts +106 -0
- package/src/browser/react/use-router.ts +23 -2
- package/src/browser/react/use-segments.ts +11 -8
- package/src/browser/response-adapter.ts +52 -1
- package/src/browser/rsc-router.tsx +71 -22
- package/src/browser/scroll-restoration.ts +22 -14
- package/src/browser/segment-reconciler.ts +10 -14
- package/src/browser/segment-structure-assert.ts +2 -2
- package/src/browser/server-action-bridge.ts +44 -30
- package/src/browser/types.ts +12 -2
- package/src/build/collect-fallback-refs.ts +107 -0
- package/src/build/generate-manifest.ts +60 -35
- package/src/build/generate-route-types.ts +2 -0
- package/src/build/index.ts +8 -1
- package/src/build/prefix-tree-utils.ts +123 -0
- package/src/build/route-trie.ts +45 -1
- package/src/build/route-types/codegen.ts +4 -4
- package/src/build/route-types/include-resolution.ts +1 -1
- package/src/build/route-types/per-module-writer.ts +7 -4
- package/src/build/route-types/router-processing.ts +55 -14
- package/src/build/route-types/scan-filter.ts +1 -1
- package/src/build/route-types/source-scan.ts +118 -0
- package/src/build/runtime-discovery.ts +9 -20
- package/src/cache/cache-runtime.ts +17 -5
- package/src/cache/cache-scope.ts +51 -49
- package/src/cache/cf/cf-cache-store.ts +502 -32
- package/src/cache/cf/index.ts +3 -0
- package/src/cache/handle-snapshot.ts +103 -0
- package/src/cache/index.ts +3 -0
- package/src/cache/memory-segment-store.ts +3 -2
- package/src/cache/types.ts +10 -6
- package/src/client.rsc.tsx +3 -0
- package/src/client.tsx +96 -205
- package/src/context-var.ts +5 -5
- package/src/decode-loader-results.ts +36 -0
- package/src/errors.ts +30 -4
- package/src/handle.ts +4 -6
- package/src/host/index.ts +2 -2
- package/src/host/router.ts +129 -57
- package/src/host/types.ts +31 -2
- package/src/host/utils.ts +1 -1
- package/src/href-client.ts +140 -21
- package/src/index.rsc.ts +10 -6
- package/src/index.ts +17 -8
- package/src/loader-store.ts +500 -0
- package/src/loader.rsc.ts +2 -5
- package/src/loader.ts +3 -10
- package/src/missing-id-error.ts +68 -0
- package/src/outlet-context.ts +1 -1
- package/src/prerender/store.ts +9 -7
- package/src/prerender.ts +4 -4
- package/src/response-utils.ts +37 -0
- package/src/reverse.ts +65 -39
- package/src/route-content-wrapper.tsx +6 -28
- package/src/route-definition/dsl-helpers.ts +253 -265
- package/src/route-definition/helper-factories.ts +29 -139
- package/src/route-definition/helpers-types.ts +43 -15
- package/src/route-definition/resolve-handler-use.ts +6 -0
- package/src/route-definition/use-item-types.ts +32 -0
- package/src/route-types.ts +26 -41
- package/src/router/content-negotiation.ts +15 -2
- package/src/router/error-handling.ts +1 -1
- package/src/router/find-match.ts +54 -6
- package/src/router/handler-context.ts +21 -41
- package/src/router/intercept-resolution.ts +4 -18
- package/src/router/lazy-includes.ts +41 -22
- package/src/router/loader-resolution.ts +82 -36
- package/src/router/manifest.ts +41 -19
- package/src/router/match-api.ts +4 -3
- package/src/router/match-handlers.ts +1 -0
- package/src/router/match-middleware/cache-lookup.ts +57 -95
- package/src/router/match-middleware/cache-store.ts +3 -2
- package/src/router/match-result.ts +53 -32
- package/src/router/metrics.ts +1 -1
- package/src/router/middleware-types.ts +15 -26
- package/src/router/middleware.ts +99 -84
- package/src/router/pattern-matching.ts +116 -19
- package/src/router/prerender-match.ts +40 -15
- package/src/router/preview-match.ts +3 -1
- package/src/router/request-classification.ts +40 -37
- package/src/router/revalidation.ts +58 -2
- package/src/router/router-interfaces.ts +51 -35
- package/src/router/router-options.ts +25 -1
- package/src/router/router-registry.ts +2 -5
- package/src/router/segment-resolution/fresh.ts +27 -6
- package/src/router/segment-resolution/revalidation.ts +147 -106
- package/src/router/segment-resolution/static-store.ts +19 -5
- package/src/router/segment-resolution/view-transition-default.ts +36 -0
- package/src/router/substitute-pattern-params.ts +56 -0
- package/src/router/trie-matching.ts +40 -16
- package/src/router/types.ts +8 -0
- package/src/router/url-params.ts +49 -0
- package/src/router.ts +37 -25
- package/src/rsc/handler-context.ts +2 -2
- package/src/rsc/handler.ts +58 -77
- package/src/rsc/helpers.ts +72 -43
- package/src/rsc/index.ts +1 -1
- package/src/rsc/manifest-init.ts +28 -41
- package/src/rsc/origin-guard.ts +30 -10
- package/src/rsc/progressive-enhancement.ts +4 -0
- package/src/rsc/response-error.ts +79 -12
- package/src/rsc/response-route-handler.ts +76 -61
- package/src/rsc/rsc-rendering.ts +45 -51
- package/src/rsc/runtime-warnings.ts +9 -10
- package/src/rsc/server-action.ts +33 -39
- package/src/rsc/ssr-setup.ts +16 -0
- package/src/rsc/types.ts +8 -2
- package/src/search-params.ts +4 -4
- package/src/segment-content-promise.ts +67 -0
- package/src/segment-loader-promise.ts +122 -0
- package/src/segment-system.tsx +132 -116
- package/src/serialize.ts +243 -0
- package/src/server/context.ts +175 -53
- package/src/server/cookie-store.ts +28 -4
- package/src/server/request-context.ts +57 -51
- package/src/ssr/index.tsx +5 -1
- package/src/static-handler.ts +1 -1
- package/src/types/global-namespace.ts +39 -26
- package/src/types/handler-context.ts +68 -50
- package/src/types/index.ts +1 -0
- package/src/types/loader-types.ts +11 -9
- package/src/types/request-scope.ts +126 -0
- package/src/types/route-entry.ts +11 -0
- package/src/types/segments.ts +35 -2
- package/src/urls/include-helper.ts +34 -67
- package/src/urls/index.ts +1 -5
- package/src/urls/path-helper-types.ts +17 -3
- package/src/urls/path-helper.ts +17 -52
- package/src/urls/pattern-types.ts +36 -19
- package/src/urls/response-types.ts +22 -29
- package/src/urls/type-extraction.ts +58 -139
- package/src/urls/urls-function.ts +1 -5
- package/src/use-loader.tsx +413 -42
- package/src/vite/debug.ts +185 -0
- package/src/vite/discovery/bundle-postprocess.ts +6 -6
- package/src/vite/discovery/discover-routers.ts +106 -75
- package/src/vite/discovery/discovery-errors.ts +194 -0
- package/src/vite/discovery/gate-state.ts +171 -0
- package/src/vite/discovery/prerender-collection.ts +72 -31
- package/src/vite/discovery/route-types-writer.ts +40 -84
- package/src/vite/discovery/self-gen-tracking.ts +27 -1
- package/src/vite/discovery/state.ts +33 -0
- package/src/vite/discovery/virtual-module-codegen.ts +13 -23
- package/src/vite/index.ts +2 -0
- package/src/vite/plugin-types.ts +67 -0
- package/src/vite/plugins/cjs-to-esm.ts +8 -7
- package/src/vite/plugins/client-ref-dedup.ts +16 -0
- package/src/vite/plugins/client-ref-hashing.ts +28 -5
- package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
- package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
- package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
- package/src/vite/plugins/expose-action-id.ts +54 -30
- package/src/vite/plugins/expose-id-utils.ts +12 -8
- package/src/vite/plugins/expose-ids/export-analysis.ts +100 -20
- package/src/vite/plugins/expose-ids/handler-transform.ts +8 -61
- package/src/vite/plugins/expose-ids/loader-transform.ts +3 -5
- package/src/vite/plugins/expose-ids/router-transform.ts +20 -3
- package/src/vite/plugins/expose-internal-ids.ts +496 -486
- package/src/vite/plugins/performance-tracks.ts +29 -25
- package/src/vite/plugins/use-cache-transform.ts +65 -50
- package/src/vite/plugins/version-injector.ts +39 -23
- package/src/vite/plugins/version-plugin.ts +59 -2
- package/src/vite/plugins/virtual-entries.ts +2 -2
- package/src/vite/rango.ts +116 -29
- package/src/vite/router-discovery.ts +753 -104
- package/src/vite/utils/ast-handler-extract.ts +15 -15
- package/src/vite/utils/banner.ts +1 -1
- package/src/vite/utils/bundle-analysis.ts +4 -2
- package/src/vite/utils/client-chunks.ts +190 -0
- package/src/vite/utils/forward-user-plugins.ts +193 -0
- package/src/vite/utils/manifest-utils.ts +8 -59
- package/src/vite/utils/package-resolution.ts +41 -1
- package/src/vite/utils/prerender-utils.ts +5 -4
- package/src/vite/utils/shared-utils.ts +107 -26
- package/src/browser/action-response-classifier.ts +0 -99
|
@@ -28,6 +28,7 @@ import { NonceContext } from "./nonce-context.js";
|
|
|
28
28
|
import type { ResolvedThemeConfig, Theme } from "../../theme/types.js";
|
|
29
29
|
import { cancelAllPrefetches } from "../prefetch/queue.js";
|
|
30
30
|
import { handleNavigationEnd } from "../scroll-restoration.js";
|
|
31
|
+
import { createAppShellRef, type AppShellRef } from "../app-shell.js";
|
|
31
32
|
|
|
32
33
|
/**
|
|
33
34
|
* Process handles from an async generator, updating the event controller
|
|
@@ -46,10 +47,22 @@ async function processHandles(
|
|
|
46
47
|
store: NavigationStore;
|
|
47
48
|
matched?: string[];
|
|
48
49
|
isPartial?: boolean;
|
|
50
|
+
/** Server's `resolvedIds`: every segment re-resolved this request,
|
|
51
|
+
* including null-component ones excluded from `diff`/`segments`.
|
|
52
|
+
* Drives cleanup of stale handle buckets when a re-resolved segment
|
|
53
|
+
* pushed nothing. */
|
|
54
|
+
resolvedIds?: string[];
|
|
49
55
|
historyKey: string;
|
|
50
56
|
},
|
|
51
57
|
): Promise<void> {
|
|
52
|
-
const {
|
|
58
|
+
const {
|
|
59
|
+
eventController,
|
|
60
|
+
store,
|
|
61
|
+
matched,
|
|
62
|
+
isPartial,
|
|
63
|
+
resolvedIds,
|
|
64
|
+
historyKey,
|
|
65
|
+
} = opts;
|
|
53
66
|
|
|
54
67
|
let yieldCount = 0;
|
|
55
68
|
for await (const handleData of handlesGenerator) {
|
|
@@ -64,7 +77,7 @@ async function processHandles(
|
|
|
64
77
|
}
|
|
65
78
|
|
|
66
79
|
yieldCount++;
|
|
67
|
-
eventController.setHandleData(handleData, matched, isPartial);
|
|
80
|
+
eventController.setHandleData(handleData, matched, isPartial, resolvedIds);
|
|
68
81
|
}
|
|
69
82
|
|
|
70
83
|
// Check again before final updates
|
|
@@ -72,12 +85,11 @@ async function processHandles(
|
|
|
72
85
|
return;
|
|
73
86
|
}
|
|
74
87
|
|
|
75
|
-
// For partial updates where the generator yielded nothing (
|
|
76
|
-
//
|
|
77
|
-
//
|
|
78
|
-
// route might not push any breadcrumbs, but we still need to remove the old ones.
|
|
88
|
+
// For partial updates where the generator yielded nothing (every
|
|
89
|
+
// re-resolved handler pushed nothing), still call setHandleData so the
|
|
90
|
+
// cleanup pass can clear out stale buckets for those segments.
|
|
79
91
|
if (yieldCount === 0 && matched) {
|
|
80
|
-
eventController.setHandleData({}, matched, true);
|
|
92
|
+
eventController.setHandleData({}, matched, true, resolvedIds);
|
|
81
93
|
}
|
|
82
94
|
|
|
83
95
|
// After handles processing completes, update the cache's handleData.
|
|
@@ -133,15 +145,25 @@ export interface NavigationProviderProps {
|
|
|
133
145
|
warmupEnabled?: boolean;
|
|
134
146
|
|
|
135
147
|
/**
|
|
136
|
-
* App version from server payload
|
|
137
|
-
*
|
|
148
|
+
* App version from server payload.
|
|
149
|
+
* Used only as a fallback when `appShellRef` is not supplied.
|
|
138
150
|
*/
|
|
139
151
|
version?: string;
|
|
140
152
|
|
|
141
153
|
/**
|
|
142
154
|
* URL prefix for all routes (from createRouter({ basename })).
|
|
155
|
+
* Used only as a fallback when `appShellRef` is not supplied.
|
|
143
156
|
*/
|
|
144
157
|
basename?: string;
|
|
158
|
+
|
|
159
|
+
/**
|
|
160
|
+
* App-shell ref. When provided, the context's `basename` and `version` are
|
|
161
|
+
* read through it (live getters) so they don't close over a stale snapshot or
|
|
162
|
+
* invalidate the memoized context value. The shell is set once at init and is
|
|
163
|
+
* not swapped within a session — a cross-app navigation is a full document
|
|
164
|
+
* load (X-RSC-Reload), so the target app establishes its own shell on load.
|
|
165
|
+
*/
|
|
166
|
+
appShellRef?: AppShellRef;
|
|
145
167
|
}
|
|
146
168
|
|
|
147
169
|
/**
|
|
@@ -175,6 +197,7 @@ export function NavigationProvider({
|
|
|
175
197
|
warmupEnabled,
|
|
176
198
|
version,
|
|
177
199
|
basename,
|
|
200
|
+
appShellRef,
|
|
178
201
|
}: NavigationProviderProps): ReactNode {
|
|
179
202
|
// Track current payload for rendering (this triggers re-renders)
|
|
180
203
|
const [payload, setPayload] = useState(initialPayload);
|
|
@@ -196,18 +219,35 @@ export function NavigationProvider({
|
|
|
196
219
|
await bridge.refresh();
|
|
197
220
|
}, []);
|
|
198
221
|
|
|
199
|
-
//
|
|
200
|
-
|
|
201
|
-
|
|
222
|
+
// basename/version are always read through a shell ref so the context value
|
|
223
|
+
// has a single shape. Both are set once: a supplied appShellRef is seeded
|
|
224
|
+
// from the init payload (a cross-app navigation reloads, so it is not swapped
|
|
225
|
+
// in-session), and the standalone fallback wraps the mount-time props.
|
|
226
|
+
const fallbackShellRef = useRef<AppShellRef | null>(null);
|
|
227
|
+
if (!fallbackShellRef.current) {
|
|
228
|
+
fallbackShellRef.current = createAppShellRef({ basename, version });
|
|
229
|
+
}
|
|
230
|
+
const shellRef = appShellRef ?? fallbackShellRef.current;
|
|
231
|
+
|
|
232
|
+
const contextValue = useMemo<NavigationStoreContextValue>(() => {
|
|
233
|
+
const value = {
|
|
202
234
|
store,
|
|
203
235
|
eventController,
|
|
204
236
|
navigate,
|
|
205
237
|
refresh,
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
238
|
+
} as NavigationStoreContextValue;
|
|
239
|
+
Object.defineProperty(value, "basename", {
|
|
240
|
+
configurable: true,
|
|
241
|
+
enumerable: true,
|
|
242
|
+
get: () => shellRef.get().basename,
|
|
243
|
+
});
|
|
244
|
+
Object.defineProperty(value, "version", {
|
|
245
|
+
configurable: true,
|
|
246
|
+
enumerable: true,
|
|
247
|
+
get: () => shellRef.get().version,
|
|
248
|
+
});
|
|
249
|
+
return value;
|
|
250
|
+
}, []);
|
|
211
251
|
|
|
212
252
|
// Connection warmup: keep TLS alive after idle periods.
|
|
213
253
|
// After 60s of no user interaction, marks connection as "cold".
|
|
@@ -345,8 +385,12 @@ export function NavigationProvider({
|
|
|
345
385
|
metadata: update.metadata,
|
|
346
386
|
});
|
|
347
387
|
|
|
348
|
-
// Update route params
|
|
349
|
-
|
|
388
|
+
// Update route params. Only reset when the server actually sends a params
|
|
389
|
+
// map — an absent `params` field means "no change" (e.g., legacy action
|
|
390
|
+
// responses that omitted params). Explicit `{}` still clears correctly.
|
|
391
|
+
if (update.metadata.params !== undefined) {
|
|
392
|
+
eventController.setParams(update.metadata.params);
|
|
393
|
+
}
|
|
350
394
|
|
|
351
395
|
// Update handle data progressively as it streams in
|
|
352
396
|
if (update.metadata.handles) {
|
|
@@ -359,24 +403,20 @@ export function NavigationProvider({
|
|
|
359
403
|
store,
|
|
360
404
|
matched: update.metadata.matched,
|
|
361
405
|
isPartial: update.metadata.isPartial,
|
|
406
|
+
resolvedIds: update.metadata.resolvedIds,
|
|
362
407
|
historyKey,
|
|
363
408
|
}).catch((err) =>
|
|
364
409
|
console.error("[NavigationProvider] Error consuming handles:", err),
|
|
365
410
|
);
|
|
366
|
-
} else if (update.metadata.cachedHandleData) {
|
|
367
|
-
// For back/forward navigation from cache, restore the cached handleData
|
|
368
|
-
// This restores breadcrumbs to the exact state they were when the page was cached
|
|
369
|
-
eventController.setHandleData(
|
|
370
|
-
update.metadata.cachedHandleData,
|
|
371
|
-
update.metadata.matched,
|
|
372
|
-
false, // full replace - restore entire cached state
|
|
373
|
-
);
|
|
374
411
|
} else if (update.metadata.matched) {
|
|
375
|
-
//
|
|
412
|
+
// cachedHandleData present -> full restore (back/forward); absent ->
|
|
413
|
+
// partial cleanup of segments no longer matched.
|
|
414
|
+
const cached = update.metadata.cachedHandleData;
|
|
376
415
|
eventController.setHandleData(
|
|
377
|
-
{},
|
|
416
|
+
cached ?? {},
|
|
378
417
|
update.metadata.matched,
|
|
379
|
-
|
|
418
|
+
cached === undefined,
|
|
419
|
+
cached === undefined ? update.metadata.resolvedIds : undefined,
|
|
380
420
|
);
|
|
381
421
|
}
|
|
382
422
|
});
|
|
@@ -398,7 +438,11 @@ export function NavigationProvider({
|
|
|
398
438
|
// Build the content tree
|
|
399
439
|
let content = <RootErrorBoundary>{root}</RootErrorBoundary>;
|
|
400
440
|
|
|
401
|
-
// Wrap with ThemeProvider when theme is enabled
|
|
441
|
+
// Wrap with ThemeProvider when theme is enabled. The ThemeProvider is
|
|
442
|
+
// document-lifetime: its config comes from the initial load and persists for
|
|
443
|
+
// the session. It sits above the segment tree and is not remounted in-session;
|
|
444
|
+
// a cross-app navigation is a full document load (X-RSC-Reload), so the target
|
|
445
|
+
// app's theme config takes effect on its own load.
|
|
402
446
|
if (themeConfig) {
|
|
403
447
|
content = (
|
|
404
448
|
<ThemeProvider config={themeConfig} initialTheme={initialTheme}>
|
|
@@ -1,11 +1,55 @@
|
|
|
1
1
|
/**
|
|
2
|
-
*
|
|
3
|
-
*
|
|
2
|
+
* Build the handle-collection segment order from a raw `matched` list.
|
|
3
|
+
*
|
|
4
|
+
* Two responsibilities:
|
|
5
|
+
*
|
|
6
|
+
* 1. Drop loader sub-ids ("D" followed by a digit, e.g. "M0L0D1.user") —
|
|
7
|
+
* loaders never push handles.
|
|
8
|
+
*
|
|
9
|
+
* 2. Place each parallel slot id (contains ".@") immediately after its
|
|
10
|
+
* parent layout/route id. Raw segment-resolution emission order does NOT
|
|
11
|
+
* guarantee this: route-mounted parallels are resolved/pushed BEFORE the
|
|
12
|
+
* route handler's segment is appended (see fresh.ts:resolveSegment for
|
|
13
|
+
* routes, and revalidation.ts ~915-919), so matched can read
|
|
14
|
+
* `[..., R0.@panel, R0]`. collectHandleData consumes segmentOrder verbatim
|
|
15
|
+
* with later-wins semantics, so without normalization the route handler's
|
|
16
|
+
* Meta would override the slot's more-specific Meta — backwards.
|
|
17
|
+
*
|
|
18
|
+
* Slot-id format is `<parentShortCode>.@<slotName>`; `parentShortCode` never
|
|
19
|
+
* contains ".@", so splitting at the first ".@" reliably yields the parent.
|
|
4
20
|
*/
|
|
5
21
|
export function filterSegmentOrder(matched: string[]): string[] {
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
22
|
+
const slotsByParent = new Map<string, string[]>();
|
|
23
|
+
const nonSlots: string[] = [];
|
|
24
|
+
const nonSlotSet = new Set<string>();
|
|
25
|
+
|
|
26
|
+
for (const id of matched) {
|
|
27
|
+
if (/D\d+\./.test(id)) continue;
|
|
28
|
+
const slotIdx = id.indexOf(".@");
|
|
29
|
+
if (slotIdx >= 0) {
|
|
30
|
+
const parent = id.slice(0, slotIdx);
|
|
31
|
+
const list = slotsByParent.get(parent);
|
|
32
|
+
if (list) {
|
|
33
|
+
list.push(id);
|
|
34
|
+
} else {
|
|
35
|
+
slotsByParent.set(parent, [id]);
|
|
36
|
+
}
|
|
37
|
+
} else {
|
|
38
|
+
nonSlots.push(id);
|
|
39
|
+
nonSlotSet.add(id);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
const result: string[] = [];
|
|
44
|
+
for (const id of nonSlots) {
|
|
45
|
+
result.push(id);
|
|
46
|
+
const slots = slotsByParent.get(id);
|
|
47
|
+
if (slots) result.push(...slots);
|
|
48
|
+
}
|
|
49
|
+
// Defensive: any slot whose parent is missing from the filtered list still
|
|
50
|
+
// gets included rather than silently dropped. Shouldn't happen in practice.
|
|
51
|
+
for (const [parent, slots] of slotsByParent) {
|
|
52
|
+
if (!nonSlotSet.has(parent)) result.push(...slots);
|
|
53
|
+
}
|
|
54
|
+
return result;
|
|
11
55
|
}
|
|
@@ -20,6 +20,9 @@ export { useSegments, type SegmentsState } from "./use-segments.js";
|
|
|
20
20
|
// Handle data hook
|
|
21
21
|
export { useHandle } from "./use-handle.js";
|
|
22
22
|
|
|
23
|
+
// Mount-aware reverse hook
|
|
24
|
+
export { useReverse } from "./use-reverse.js";
|
|
25
|
+
|
|
23
26
|
// Client cache controls hook
|
|
24
27
|
export {
|
|
25
28
|
useClientCache,
|
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
* No "use client" directive so it can be imported from RSC
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
|
+
import type { ReactElement } from "react";
|
|
7
|
+
|
|
6
8
|
/**
|
|
7
9
|
* Internal entry representing a state value with its unique key.
|
|
8
10
|
* When __rsc_ls_lazy is true, __rsc_ls_value holds a getter function
|
|
@@ -22,6 +24,88 @@ export interface LocationStateOptions {
|
|
|
22
24
|
flash?: boolean;
|
|
23
25
|
}
|
|
24
26
|
|
|
27
|
+
type LocationStateUnsafeFn = (...args: never[]) => unknown;
|
|
28
|
+
|
|
29
|
+
// Broadest constructor signature (`abstract` covers both abstract and concrete
|
|
30
|
+
// classes). A class passed as state has a `new` signature, not a call signature,
|
|
31
|
+
// so it slips past LocationStateUnsafeFn; at runtime the lazy-getter path
|
|
32
|
+
// (`typeof value === "function"`) then mistakes it for a getter and throws.
|
|
33
|
+
type LocationStateUnsafeCtor = abstract new (...args: never[]) => unknown;
|
|
34
|
+
|
|
35
|
+
// `unknown` cannot be verified serializable, so it is rejected (callers must
|
|
36
|
+
// supply a concrete type). `any` deliberately defeats type checking and is NOT
|
|
37
|
+
// guardable — it is assignable to the branded error too, so the check always
|
|
38
|
+
// passes; it remains an explicit escape hatch.
|
|
39
|
+
type IsAny<T> = 0 extends 1 & T ? true : false;
|
|
40
|
+
type IsUnknown<T> =
|
|
41
|
+
IsAny<T> extends true ? false : unknown extends T ? true : false;
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* Branded error surfaced when a value that cannot live in location state is
|
|
45
|
+
* used. Location state is written into `history.state`, which uses the
|
|
46
|
+
* structured clone algorithm; React elements, functions, and symbols throw a
|
|
47
|
+
* `DataCloneError` at runtime. Carries a human-readable reason so the compile
|
|
48
|
+
* error explains the fix.
|
|
49
|
+
*/
|
|
50
|
+
export type LocationStateUnsafe<Reason extends string> = {
|
|
51
|
+
readonly __rango_location_state_unsafe: Reason;
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Maps `T` to itself when it is safe to store in location state, or to a branded
|
|
56
|
+
* {@link LocationStateUnsafe} error for the disallowed parts: `unknown`, React
|
|
57
|
+
* elements (RSC/JSX content), functions, class constructors, and symbols.
|
|
58
|
+
* Recurses through arrays, `Map`, `Set`, and plain objects; structured-clone
|
|
59
|
+
* built-ins (`Date`, `RegExp`, typed arrays, `Blob`, `File`, `FormData`) pass
|
|
60
|
+
* through. Consumed by {@link ValidateLocationState}, which is intersected into a
|
|
61
|
+
* definition's value parameter so posting RSC content is a COMPILE error, not a
|
|
62
|
+
* runtime `DataCloneError`. (`any` is unguardable and remains an escape hatch.)
|
|
63
|
+
*/
|
|
64
|
+
export type LocationStateSafe<T> =
|
|
65
|
+
IsUnknown<T> extends true
|
|
66
|
+
? LocationStateUnsafe<"location state needs an explicit, concrete type; `unknown` cannot be verified as serializable">
|
|
67
|
+
: T extends LocationStateUnsafeFn
|
|
68
|
+
? LocationStateUnsafe<"functions cannot be stored in location state">
|
|
69
|
+
: T extends LocationStateUnsafeCtor
|
|
70
|
+
? LocationStateUnsafe<"class constructors cannot be stored in location state">
|
|
71
|
+
: T extends symbol
|
|
72
|
+
? LocationStateUnsafe<"symbols cannot be stored in location state">
|
|
73
|
+
: T extends ReactElement
|
|
74
|
+
? LocationStateUnsafe<"React/RSC content cannot be stored in location state; store plain data and render it on arrival">
|
|
75
|
+
: T extends string | number | boolean | bigint | null | undefined
|
|
76
|
+
? T
|
|
77
|
+
: T extends
|
|
78
|
+
| Date
|
|
79
|
+
| RegExp
|
|
80
|
+
| ArrayBuffer
|
|
81
|
+
| ArrayBufferView
|
|
82
|
+
| Blob
|
|
83
|
+
| File
|
|
84
|
+
| FormData
|
|
85
|
+
? T
|
|
86
|
+
: T extends ReadonlyMap<infer K, infer V>
|
|
87
|
+
? ReadonlyMap<LocationStateSafe<K>, LocationStateSafe<V>>
|
|
88
|
+
: T extends ReadonlySet<infer V>
|
|
89
|
+
? ReadonlySet<LocationStateSafe<V>>
|
|
90
|
+
: T extends readonly unknown[]
|
|
91
|
+
? { [K in keyof T]: LocationStateSafe<T[K]> }
|
|
92
|
+
: T extends object
|
|
93
|
+
? { [K in keyof T]: LocationStateSafe<T[K]> }
|
|
94
|
+
: T;
|
|
95
|
+
|
|
96
|
+
/**
|
|
97
|
+
* `unknown` (a no-op) when `T` is safe to store in location state, otherwise a
|
|
98
|
+
* branded {@link LocationStateUnsafe} object. Intersected into the value
|
|
99
|
+
* parameter of a definition's call and `write()` so POSTING RSC content (or any
|
|
100
|
+
* non-serializable value) is a compile error whose text carries the reason —
|
|
101
|
+
* without a `TState extends ...` self-constraint, which TypeScript rejects as
|
|
102
|
+
* circular (TS2313). For safe `T`, `value & unknown` collapses back to `value`,
|
|
103
|
+
* so valid usage is unchanged.
|
|
104
|
+
*/
|
|
105
|
+
export type ValidateLocationState<T> = [T] extends [LocationStateSafe<T>]
|
|
106
|
+
? unknown
|
|
107
|
+
: LocationStateUnsafe<"location state must be serializable: React/RSC content, functions, and symbols cannot be stored — pass plain data and render it on arrival">;
|
|
108
|
+
|
|
25
109
|
/**
|
|
26
110
|
* Type-safe location state definition
|
|
27
111
|
*
|
|
@@ -34,8 +118,43 @@ export interface LocationStateDefinition<TArgs extends unknown[], TState> {
|
|
|
34
118
|
__rsc_ls_key: string;
|
|
35
119
|
/** Whether this state auto-clears after first read */
|
|
36
120
|
readonly __rsc_ls_flash: boolean;
|
|
37
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* Read the current value from history.state.
|
|
123
|
+
*
|
|
124
|
+
* Returns undefined during SSR (no `window`). To stay hydration-safe, do
|
|
125
|
+
* NOT call read() inline during the initial render — the server returns
|
|
126
|
+
* undefined while the client may have a value preserved in history.state
|
|
127
|
+
* (e.g. after a hard reload of an entry that earlier called write()),
|
|
128
|
+
* which causes a hydration mismatch. Call read() inside an event handler
|
|
129
|
+
* or a useEffect post-mount instead, or use useLocationState() if you
|
|
130
|
+
* want React to manage subscription/hydration for you.
|
|
131
|
+
*/
|
|
38
132
|
read(): TState | undefined;
|
|
133
|
+
/**
|
|
134
|
+
* Statically write the value into the current history entry under this
|
|
135
|
+
* definition's key, preserving any other keys already on history.state
|
|
136
|
+
* (e.g. router bookkeeping, other LocationState slots).
|
|
137
|
+
*
|
|
138
|
+
* This is the non-reactive counterpart to read(): it does not dispatch any
|
|
139
|
+
* event, so components reading via useLocationState() will NOT re-render
|
|
140
|
+
* until the next navigation/popstate. Use it when you only need the value
|
|
141
|
+
* to be there on the next read() or on the next mount (including after
|
|
142
|
+
* back/forward and hard refresh of the same entry).
|
|
143
|
+
*
|
|
144
|
+
* Client-only: throws when called on the server (no history available).
|
|
145
|
+
*/
|
|
146
|
+
write(value: TState & ValidateLocationState<TState>): void;
|
|
147
|
+
/**
|
|
148
|
+
* Statically remove this definition's slot from the current history entry,
|
|
149
|
+
* leaving any other keys on history.state untouched. Idempotent: removing
|
|
150
|
+
* a slot that isn't present is a no-op.
|
|
151
|
+
*
|
|
152
|
+
* Same non-reactive semantics as write(): no event is dispatched, so
|
|
153
|
+
* useLocationState() readers will NOT re-render until the next navigation.
|
|
154
|
+
*
|
|
155
|
+
* Client-only: throws when called on the server (no history available).
|
|
156
|
+
*/
|
|
157
|
+
delete(): void;
|
|
39
158
|
}
|
|
40
159
|
|
|
41
160
|
/**
|
|
@@ -70,18 +189,30 @@ export interface LocationStateDefinition<TArgs extends unknown[], TState> {
|
|
|
70
189
|
*
|
|
71
190
|
* // Read without hook (snapshot, client-side only)
|
|
72
191
|
* const snap = ProductState.read();
|
|
192
|
+
*
|
|
193
|
+
* // Static write to current history entry (non-reactive, client-side only).
|
|
194
|
+
* // Survives back/forward and hard refresh; useLocationState() readers will
|
|
195
|
+
* // NOT see the new value until the next navigation. Pair with .read() or a
|
|
196
|
+
* // fresh mount.
|
|
197
|
+
* ProductState.write({ name: "Widget", price: 9.99 });
|
|
198
|
+
*
|
|
199
|
+
* // Manually clear the slot (non-reactive, client-side only).
|
|
200
|
+
* ProductState.delete();
|
|
73
201
|
* ```
|
|
74
202
|
*/
|
|
75
203
|
export function createLocationState<TState>(
|
|
76
204
|
options?: LocationStateOptions,
|
|
77
|
-
): LocationStateDefinition<
|
|
205
|
+
): LocationStateDefinition<
|
|
206
|
+
[(TState | (() => TState)) & ValidateLocationState<TState>],
|
|
207
|
+
TState
|
|
208
|
+
> {
|
|
78
209
|
const flash = options?.flash ?? false;
|
|
79
210
|
let _key: string | undefined;
|
|
80
211
|
|
|
81
212
|
function getKey(): string {
|
|
82
213
|
if (!_key && process.env.NODE_ENV === "development") {
|
|
83
214
|
throw new Error(
|
|
84
|
-
"[
|
|
215
|
+
"[rango] createLocationState key not set. " +
|
|
85
216
|
"Make sure the exposeInternalIds Vite plugin is enabled and " +
|
|
86
217
|
"the state is exported with: export const MyState = createLocationState(...)",
|
|
87
218
|
);
|
|
@@ -128,7 +259,47 @@ export function createLocationState<TState>(
|
|
|
128
259
|
enumerable: true,
|
|
129
260
|
});
|
|
130
261
|
|
|
131
|
-
|
|
262
|
+
Object.defineProperty(fn, "write", {
|
|
263
|
+
value: (value: TState): void => {
|
|
264
|
+
if (typeof window === "undefined") {
|
|
265
|
+
throw new Error(
|
|
266
|
+
"[rango] LocationState.write() is client-only. " +
|
|
267
|
+
"It mutates window.history.state and cannot run on the server.",
|
|
268
|
+
);
|
|
269
|
+
}
|
|
270
|
+
const key = getKey();
|
|
271
|
+
const current = window.history.state ?? {};
|
|
272
|
+
window.history.replaceState(
|
|
273
|
+
{ ...current, [key]: value },
|
|
274
|
+
"",
|
|
275
|
+
window.location.href,
|
|
276
|
+
);
|
|
277
|
+
},
|
|
278
|
+
enumerable: true,
|
|
279
|
+
});
|
|
280
|
+
|
|
281
|
+
Object.defineProperty(fn, "delete", {
|
|
282
|
+
value: (): void => {
|
|
283
|
+
if (typeof window === "undefined") {
|
|
284
|
+
throw new Error(
|
|
285
|
+
"[rango] LocationState.delete() is client-only. " +
|
|
286
|
+
"It mutates window.history.state and cannot run on the server.",
|
|
287
|
+
);
|
|
288
|
+
}
|
|
289
|
+
const key = getKey();
|
|
290
|
+
const current = window.history.state;
|
|
291
|
+
if (current == null || !(key in current)) return;
|
|
292
|
+
const next = { ...current };
|
|
293
|
+
delete next[key];
|
|
294
|
+
window.history.replaceState(next, "", window.location.href);
|
|
295
|
+
},
|
|
296
|
+
enumerable: true,
|
|
297
|
+
});
|
|
298
|
+
|
|
299
|
+
return fn as unknown as LocationStateDefinition<
|
|
300
|
+
[(TState | (() => TState)) & ValidateLocationState<TState>],
|
|
301
|
+
TState
|
|
302
|
+
>;
|
|
132
303
|
}
|
|
133
304
|
|
|
134
305
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use client";
|
|
2
2
|
|
|
3
|
-
import { useState, useEffect } from "react";
|
|
3
|
+
import { useState, useEffect, useRef } from "react";
|
|
4
4
|
import type { LocationStateDefinition } from "./location-state-shared.js";
|
|
5
5
|
|
|
6
6
|
// Re-export shared utilities and types
|
|
@@ -13,6 +13,24 @@ export {
|
|
|
13
13
|
type LocationStateOptions,
|
|
14
14
|
} from "./location-state-shared.js";
|
|
15
15
|
|
|
16
|
+
function readLocationStateValue<TState>(
|
|
17
|
+
key: string | undefined,
|
|
18
|
+
): TState | undefined {
|
|
19
|
+
if (typeof window === "undefined") return undefined;
|
|
20
|
+
if (key) {
|
|
21
|
+
return window.history.state?.[key] as TState | undefined;
|
|
22
|
+
}
|
|
23
|
+
// Plain state: stored under history.state.state
|
|
24
|
+
return window.history.state?.state as TState | undefined;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
function hasHydrated(): boolean {
|
|
28
|
+
return (
|
|
29
|
+
typeof document !== "undefined" &&
|
|
30
|
+
document.documentElement.hasAttribute("data-hydrated")
|
|
31
|
+
);
|
|
32
|
+
}
|
|
33
|
+
|
|
16
34
|
/**
|
|
17
35
|
* Hook to read location state from history.state
|
|
18
36
|
*
|
|
@@ -48,30 +66,33 @@ export function useLocationState<TArgs extends unknown[], TState>(
|
|
|
48
66
|
const key = definition?.__rsc_ls_key;
|
|
49
67
|
const isFlash = definition?.__rsc_ls_flash ?? false;
|
|
50
68
|
|
|
69
|
+
// Track whether the initial render returned undefined because the page
|
|
70
|
+
// hadn't hydrated yet. If so, the mount effect catches up by reading
|
|
71
|
+
// history.state once. If not, we already have the right value and must
|
|
72
|
+
// not re-read on mount — under StrictMode, the flash-cleanup effect runs
|
|
73
|
+
// before the second setup pass, so a re-read would clobber the captured
|
|
74
|
+
// value with the now-cleared `undefined`.
|
|
75
|
+
const initialReadDeferredRef = useRef(false);
|
|
76
|
+
|
|
51
77
|
const [state, setState] = useState<TState | undefined>(() => {
|
|
52
|
-
if (
|
|
53
|
-
|
|
54
|
-
return
|
|
78
|
+
if (!hasHydrated()) {
|
|
79
|
+
initialReadDeferredRef.current = true;
|
|
80
|
+
return undefined;
|
|
55
81
|
}
|
|
56
|
-
|
|
57
|
-
return window.history.state?.state as TState | undefined;
|
|
82
|
+
return readLocationStateValue<TState>(key);
|
|
58
83
|
});
|
|
59
84
|
|
|
60
85
|
// Subscribe to popstate and programmatic state changes
|
|
61
86
|
useEffect(() => {
|
|
62
87
|
const handlePopstate = () => {
|
|
63
|
-
|
|
64
|
-
setState(window.history.state?.[key] as TState | undefined);
|
|
65
|
-
} else {
|
|
66
|
-
setState(window.history.state?.state as TState | undefined);
|
|
67
|
-
}
|
|
88
|
+
setState(readLocationStateValue<TState>(key));
|
|
68
89
|
};
|
|
69
90
|
|
|
70
91
|
// Handle programmatic state changes (same-page navigation with
|
|
71
92
|
// ctx.setLocationState where components don't remount)
|
|
72
93
|
const handleLocationState = () => {
|
|
73
94
|
if (key) {
|
|
74
|
-
const val =
|
|
95
|
+
const val = readLocationStateValue<TState>(key);
|
|
75
96
|
if (isFlash) {
|
|
76
97
|
// For flash state, only update if there's a new value
|
|
77
98
|
if (val !== undefined) {
|
|
@@ -81,10 +102,15 @@ export function useLocationState<TArgs extends unknown[], TState>(
|
|
|
81
102
|
setState(val);
|
|
82
103
|
}
|
|
83
104
|
} else {
|
|
84
|
-
setState(
|
|
105
|
+
setState(readLocationStateValue<TState>(key));
|
|
85
106
|
}
|
|
86
107
|
};
|
|
87
108
|
|
|
109
|
+
if (initialReadDeferredRef.current) {
|
|
110
|
+
initialReadDeferredRef.current = false;
|
|
111
|
+
setState(readLocationStateValue<TState>(key));
|
|
112
|
+
}
|
|
113
|
+
|
|
88
114
|
window.addEventListener("popstate", handlePopstate);
|
|
89
115
|
window.addEventListener("__rsc_locationstate", handleLocationState);
|
|
90
116
|
return () => {
|
|
@@ -32,27 +32,35 @@ import { shallowEqual } from "./shallow-equal.js";
|
|
|
32
32
|
* const lastCrumb = useHandle(Breadcrumbs, (data) => data.at(-1));
|
|
33
33
|
* ```
|
|
34
34
|
*/
|
|
35
|
-
export function useHandle<T, A>(handle: Handle<T, A>): A
|
|
35
|
+
export function useHandle<T, A>(handle: Handle<T, A>): Rango.FlightSerialize<A>;
|
|
36
36
|
export function useHandle<T, A, S>(
|
|
37
37
|
handle: Handle<T, A>,
|
|
38
|
-
selector: (data: A) => S,
|
|
38
|
+
selector: (data: Rango.FlightSerialize<A>) => S,
|
|
39
39
|
): S;
|
|
40
40
|
export function useHandle<T, A, S>(
|
|
41
41
|
handle: Handle<T, A>,
|
|
42
|
-
selector?: (data: A) => S,
|
|
43
|
-
): A | S {
|
|
42
|
+
selector?: (data: Rango.FlightSerialize<A>) => S,
|
|
43
|
+
): Rango.FlightSerialize<A> | S {
|
|
44
44
|
const ctx = useContext(NavigationStoreContext);
|
|
45
45
|
|
|
46
46
|
// Initial state from context event controller, or empty fallback without provider.
|
|
47
|
-
const [value, setValue] = useState<A | S>(() => {
|
|
47
|
+
const [value, setValue] = useState<Rango.FlightSerialize<A> | S>(() => {
|
|
48
48
|
if (!ctx) {
|
|
49
|
-
const collected = collectHandleData(
|
|
49
|
+
const collected = collectHandleData(
|
|
50
|
+
handle,
|
|
51
|
+
{},
|
|
52
|
+
[],
|
|
53
|
+
) as Rango.FlightSerialize<A>;
|
|
50
54
|
return selector ? selector(collected) : collected;
|
|
51
55
|
}
|
|
52
56
|
|
|
53
57
|
// On client, use event controller state
|
|
54
58
|
const state = ctx.eventController.getHandleState();
|
|
55
|
-
const collected = collectHandleData(
|
|
59
|
+
const collected = collectHandleData(
|
|
60
|
+
handle,
|
|
61
|
+
state.data,
|
|
62
|
+
state.segmentOrder,
|
|
63
|
+
) as Rango.FlightSerialize<A>;
|
|
56
64
|
return selector ? selector(collected) : collected;
|
|
57
65
|
});
|
|
58
66
|
const [optimisticValue, setOptimisticValue] = useOptimistic(value);
|
|
@@ -76,7 +84,7 @@ export function useHandle<T, A, S>(
|
|
|
76
84
|
handle,
|
|
77
85
|
currentHandleState.data,
|
|
78
86
|
currentHandleState.segmentOrder,
|
|
79
|
-
)
|
|
87
|
+
) as Rango.FlightSerialize<A>;
|
|
80
88
|
const currentValue = selectorRef.current
|
|
81
89
|
? selectorRef.current(currentCollected)
|
|
82
90
|
: currentCollected;
|
|
@@ -93,7 +101,7 @@ export function useHandle<T, A, S>(
|
|
|
93
101
|
handle,
|
|
94
102
|
state.data,
|
|
95
103
|
state.segmentOrder,
|
|
96
|
-
)
|
|
104
|
+
) as Rango.FlightSerialize<A>;
|
|
97
105
|
const nextValue = selectorRef.current
|
|
98
106
|
? selectorRef.current(collected)
|
|
99
107
|
: collected;
|