@rangojs/router 0.0.0-experimental.3 → 0.0.0-experimental.30
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/AGENTS.md +5 -0
- package/README.md +883 -4
- package/dist/bin/rango.js +1601 -0
- package/dist/vite/index.js +4655 -747
- package/package.json +78 -50
- package/skills/cache-guide/SKILL.md +262 -0
- package/skills/caching/SKILL.md +54 -25
- package/skills/composability/SKILL.md +172 -0
- package/skills/debug-manifest/SKILL.md +12 -8
- package/skills/document-cache/SKILL.md +23 -21
- package/skills/fonts/SKILL.md +167 -0
- package/skills/hooks/SKILL.md +390 -63
- package/skills/host-router/SKILL.md +218 -0
- package/skills/intercept/SKILL.md +133 -10
- package/skills/layout/SKILL.md +102 -5
- package/skills/links/SKILL.md +239 -0
- package/skills/loader/SKILL.md +366 -29
- package/skills/middleware/SKILL.md +173 -36
- package/skills/mime-routes/SKILL.md +128 -0
- package/skills/parallel/SKILL.md +80 -3
- package/skills/prerender/SKILL.md +643 -0
- package/skills/rango/SKILL.md +86 -16
- package/skills/response-routes/SKILL.md +411 -0
- package/skills/route/SKILL.md +227 -14
- package/skills/router-setup/SKILL.md +225 -32
- package/skills/tailwind/SKILL.md +129 -0
- package/skills/theme/SKILL.md +12 -11
- package/skills/typesafety/SKILL.md +401 -75
- package/skills/use-cache/SKILL.md +324 -0
- package/src/__internal.ts +10 -4
- package/src/bin/rango.ts +321 -0
- package/src/browser/action-coordinator.ts +97 -0
- package/src/browser/action-response-classifier.ts +99 -0
- package/src/browser/event-controller.ts +87 -64
- package/src/browser/history-state.ts +80 -0
- package/src/browser/intercept-utils.ts +52 -0
- package/src/browser/link-interceptor.ts +20 -4
- package/src/browser/logging.ts +55 -0
- package/src/browser/merge-segment-loaders.ts +20 -12
- package/src/browser/navigation-bridge.ts +201 -553
- package/src/browser/navigation-client.ts +124 -71
- package/src/browser/navigation-store.ts +33 -50
- package/src/browser/navigation-transaction.ts +295 -0
- package/src/browser/network-error-handler.ts +61 -0
- package/src/browser/partial-update.ts +267 -317
- package/src/browser/prefetch/cache.ts +146 -0
- package/src/browser/prefetch/fetch.ts +135 -0
- package/src/browser/prefetch/observer.ts +65 -0
- package/src/browser/prefetch/policy.ts +42 -0
- package/src/browser/prefetch/queue.ts +88 -0
- package/src/browser/rango-state.ts +112 -0
- package/src/browser/react/Link.tsx +173 -73
- package/src/browser/react/NavigationProvider.tsx +138 -27
- package/src/browser/react/context.ts +6 -0
- package/src/browser/react/filter-segment-order.ts +11 -0
- package/src/browser/react/index.ts +12 -12
- package/src/browser/react/location-state-shared.ts +95 -53
- package/src/browser/react/location-state.ts +60 -15
- package/src/browser/react/mount-context.ts +37 -0
- package/src/browser/react/nonce-context.ts +23 -0
- package/src/browser/react/shallow-equal.ts +27 -0
- package/src/browser/react/use-action.ts +29 -51
- package/src/browser/react/use-client-cache.ts +5 -3
- package/src/browser/react/use-handle.ts +49 -65
- package/src/browser/react/use-href.tsx +20 -188
- package/src/browser/react/use-link-status.ts +6 -5
- package/src/browser/react/use-mount.ts +31 -0
- package/src/browser/react/use-navigation.ts +27 -78
- package/src/browser/react/use-params.ts +65 -0
- package/src/browser/react/use-pathname.ts +47 -0
- package/src/browser/react/use-router.ts +63 -0
- package/src/browser/react/use-search-params.ts +56 -0
- package/src/browser/react/use-segments.ts +80 -97
- package/src/browser/response-adapter.ts +73 -0
- package/src/browser/rsc-router.tsx +111 -26
- package/src/browser/scroll-restoration.ts +92 -16
- package/src/browser/segment-reconciler.ts +216 -0
- package/src/browser/segment-structure-assert.ts +83 -0
- package/src/browser/server-action-bridge.ts +504 -584
- package/src/browser/shallow.ts +6 -1
- package/src/browser/types.ts +92 -57
- package/src/browser/validate-redirect-origin.ts +29 -0
- package/src/build/generate-manifest.ts +438 -0
- package/src/build/generate-route-types.ts +36 -0
- package/src/build/index.ts +35 -0
- package/src/build/route-trie.ts +265 -0
- package/src/build/route-types/ast-helpers.ts +25 -0
- package/src/build/route-types/ast-route-extraction.ts +98 -0
- package/src/build/route-types/codegen.ts +102 -0
- package/src/build/route-types/include-resolution.ts +411 -0
- package/src/build/route-types/param-extraction.ts +48 -0
- package/src/build/route-types/per-module-writer.ts +128 -0
- package/src/build/route-types/router-processing.ts +469 -0
- package/src/build/route-types/scan-filter.ts +78 -0
- package/src/build/runtime-discovery.ts +231 -0
- package/src/cache/background-task.ts +34 -0
- package/src/cache/cache-key-utils.ts +44 -0
- package/src/cache/cache-policy.ts +125 -0
- package/src/cache/cache-runtime.ts +338 -0
- package/src/cache/cache-scope.ts +120 -303
- package/src/cache/cf/cf-cache-store.ts +119 -7
- package/src/cache/cf/index.ts +8 -2
- package/src/cache/document-cache.ts +101 -72
- package/src/cache/handle-capture.ts +81 -0
- package/src/cache/handle-snapshot.ts +41 -0
- package/src/cache/index.ts +0 -15
- package/src/cache/memory-segment-store.ts +191 -13
- package/src/cache/profile-registry.ts +73 -0
- package/src/cache/read-through-swr.ts +134 -0
- package/src/cache/segment-codec.ts +256 -0
- package/src/cache/taint.ts +98 -0
- package/src/cache/types.ts +72 -122
- package/src/client.rsc.tsx +10 -15
- package/src/client.tsx +114 -135
- package/src/component-utils.ts +4 -4
- package/src/components/DefaultDocument.tsx +5 -1
- package/src/context-var.ts +86 -0
- package/src/debug.ts +17 -7
- package/src/errors.ts +108 -2
- package/src/handle.ts +34 -19
- package/src/handles/MetaTags.tsx +73 -20
- package/src/handles/meta.ts +30 -13
- package/src/host/cookie-handler.ts +165 -0
- package/src/host/errors.ts +97 -0
- package/src/host/index.ts +53 -0
- package/src/host/pattern-matcher.ts +214 -0
- package/src/host/router.ts +352 -0
- package/src/host/testing.ts +79 -0
- package/src/host/types.ts +146 -0
- package/src/host/utils.ts +25 -0
- package/src/href-client.ts +135 -49
- package/src/index.rsc.ts +182 -17
- package/src/index.ts +238 -24
- package/src/internal-debug.ts +11 -0
- package/src/loader.rsc.ts +27 -142
- package/src/loader.ts +27 -10
- package/src/network-error-thrower.tsx +3 -1
- package/src/outlet-provider.tsx +45 -0
- package/src/prerender/param-hash.ts +37 -0
- package/src/prerender/store.ts +185 -0
- package/src/prerender.ts +463 -0
- package/src/reverse.ts +330 -0
- package/src/root-error-boundary.tsx +41 -29
- package/src/route-content-wrapper.tsx +9 -11
- package/src/route-definition/dsl-helpers.ts +934 -0
- package/src/route-definition/helper-factories.ts +200 -0
- package/src/route-definition/helpers-types.ts +430 -0
- package/src/route-definition/index.ts +52 -0
- package/src/route-definition/redirect.ts +93 -0
- package/src/route-definition.ts +1 -1388
- package/src/route-map-builder.ts +241 -112
- package/src/route-name.ts +53 -0
- package/src/route-types.ts +70 -9
- package/src/router/content-negotiation.ts +116 -0
- package/src/router/debug-manifest.ts +72 -0
- package/src/router/error-handling.ts +9 -9
- package/src/router/find-match.ts +158 -0
- package/src/router/handler-context.ts +371 -81
- package/src/router/intercept-resolution.ts +395 -0
- package/src/router/lazy-includes.ts +234 -0
- package/src/router/loader-resolution.ts +215 -122
- package/src/router/logging.ts +248 -0
- package/src/router/manifest.ts +155 -32
- package/src/router/match-api.ts +620 -0
- package/src/router/match-context.ts +5 -3
- package/src/router/match-handlers.ts +440 -0
- package/src/router/match-middleware/background-revalidation.ts +80 -93
- package/src/router/match-middleware/cache-lookup.ts +382 -9
- package/src/router/match-middleware/cache-store.ts +51 -22
- package/src/router/match-middleware/intercept-resolution.ts +55 -17
- package/src/router/match-middleware/segment-resolution.ts +24 -6
- package/src/router/match-pipelines.ts +10 -45
- package/src/router/match-result.ts +34 -29
- package/src/router/metrics.ts +235 -15
- package/src/router/middleware-cookies.ts +55 -0
- package/src/router/middleware-types.ts +222 -0
- package/src/router/middleware.ts +324 -367
- package/src/router/pattern-matching.ts +321 -30
- package/src/router/prerender-match.ts +400 -0
- package/src/router/preview-match.ts +170 -0
- package/src/router/revalidation.ts +137 -38
- package/src/router/router-context.ts +36 -21
- package/src/router/router-interfaces.ts +452 -0
- package/src/router/router-options.ts +592 -0
- package/src/router/router-registry.ts +24 -0
- package/src/router/segment-resolution/fresh.ts +570 -0
- package/src/router/segment-resolution/helpers.ts +263 -0
- package/src/router/segment-resolution/loader-cache.ts +198 -0
- package/src/router/segment-resolution/revalidation.ts +1241 -0
- package/src/router/segment-resolution/static-store.ts +67 -0
- package/src/router/segment-resolution.ts +21 -0
- package/src/router/segment-wrappers.ts +289 -0
- package/src/router/telemetry-otel.ts +299 -0
- package/src/router/telemetry.ts +300 -0
- package/src/router/timeout.ts +148 -0
- package/src/router/trie-matching.ts +239 -0
- package/src/router/types.ts +77 -3
- package/src/router.ts +688 -3656
- package/src/rsc/handler-context.ts +45 -0
- package/src/rsc/handler.ts +786 -760
- package/src/rsc/helpers.ts +140 -6
- package/src/rsc/index.ts +5 -25
- package/src/rsc/loader-fetch.ts +209 -0
- package/src/rsc/manifest-init.ts +86 -0
- package/src/rsc/nonce.ts +14 -0
- package/src/rsc/origin-guard.ts +141 -0
- package/src/rsc/progressive-enhancement.ts +379 -0
- package/src/rsc/response-error.ts +37 -0
- package/src/rsc/response-route-handler.ts +347 -0
- package/src/rsc/rsc-rendering.ts +235 -0
- package/src/rsc/runtime-warnings.ts +42 -0
- package/src/rsc/server-action.ts +348 -0
- package/src/rsc/ssr-setup.ts +128 -0
- package/src/rsc/types.ts +40 -14
- package/src/search-params.ts +230 -0
- package/src/segment-system.tsx +57 -61
- package/src/server/context.ts +202 -51
- package/src/server/cookie-store.ts +190 -0
- package/src/server/fetchable-loader-store.ts +37 -0
- package/src/server/handle-store.ts +94 -15
- package/src/server/loader-registry.ts +15 -56
- package/src/server/request-context.ts +422 -70
- package/src/server.ts +36 -120
- package/src/ssr/index.tsx +157 -26
- package/src/static-handler.ts +114 -0
- package/src/theme/ThemeProvider.tsx +21 -15
- package/src/theme/ThemeScript.tsx +5 -5
- package/src/theme/constants.ts +5 -2
- package/src/theme/index.ts +4 -14
- package/src/theme/theme-context.ts +4 -30
- package/src/theme/theme-script.ts +21 -18
- package/src/types/boundaries.ts +158 -0
- package/src/types/cache-types.ts +198 -0
- package/src/types/error-types.ts +192 -0
- package/src/types/global-namespace.ts +100 -0
- package/src/types/handler-context.ts +687 -0
- package/src/types/index.ts +88 -0
- package/src/types/loader-types.ts +183 -0
- package/src/types/route-config.ts +170 -0
- package/src/types/route-entry.ts +102 -0
- package/src/types/segments.ts +148 -0
- package/src/types.ts +1 -1577
- package/src/urls/include-helper.ts +197 -0
- package/src/urls/index.ts +53 -0
- package/src/urls/path-helper-types.ts +339 -0
- package/src/urls/path-helper.ts +329 -0
- package/src/urls/pattern-types.ts +95 -0
- package/src/urls/response-types.ts +106 -0
- package/src/urls/type-extraction.ts +372 -0
- package/src/urls/urls-function.ts +98 -0
- package/src/urls.ts +1 -726
- package/src/use-loader.tsx +85 -77
- package/src/vite/discovery/bundle-postprocess.ts +184 -0
- package/src/vite/discovery/discover-routers.ts +344 -0
- package/src/vite/discovery/prerender-collection.ts +385 -0
- package/src/vite/discovery/route-types-writer.ts +258 -0
- package/src/vite/discovery/self-gen-tracking.ts +47 -0
- package/src/vite/discovery/state.ts +110 -0
- package/src/vite/discovery/virtual-module-codegen.ts +203 -0
- package/src/vite/index.ts +11 -782
- package/src/vite/plugin-types.ts +131 -0
- package/src/vite/plugins/cjs-to-esm.ts +93 -0
- package/src/vite/plugins/client-ref-dedup.ts +115 -0
- package/src/vite/plugins/client-ref-hashing.ts +105 -0
- package/src/vite/{expose-action-id.ts → plugins/expose-action-id.ts} +72 -51
- package/src/vite/plugins/expose-id-utils.ts +287 -0
- package/src/vite/plugins/expose-ids/export-analysis.ts +296 -0
- package/src/vite/plugins/expose-ids/handler-transform.ts +179 -0
- package/src/vite/plugins/expose-ids/loader-transform.ts +74 -0
- package/src/vite/plugins/expose-ids/router-transform.ts +110 -0
- package/src/vite/plugins/expose-ids/types.ts +45 -0
- package/src/vite/plugins/expose-internal-ids.ts +569 -0
- package/src/vite/plugins/refresh-cmd.ts +65 -0
- package/src/vite/plugins/use-cache-transform.ts +323 -0
- package/src/vite/plugins/version-injector.ts +83 -0
- package/src/vite/plugins/version-plugin.ts +254 -0
- package/src/vite/{virtual-entries.ts → plugins/virtual-entries.ts} +29 -15
- package/src/vite/plugins/virtual-stub-plugin.ts +29 -0
- package/src/vite/rango.ts +510 -0
- package/src/vite/router-discovery.ts +785 -0
- package/src/vite/utils/ast-handler-extract.ts +517 -0
- package/src/vite/utils/banner.ts +36 -0
- package/src/vite/utils/bundle-analysis.ts +137 -0
- package/src/vite/utils/manifest-utils.ts +70 -0
- package/src/vite/{package-resolution.ts → utils/package-resolution.ts} +25 -29
- package/src/vite/utils/prerender-utils.ts +189 -0
- package/src/vite/utils/shared-utils.ts +169 -0
- package/CLAUDE.md +0 -3
- package/src/browser/lru-cache.ts +0 -69
- package/src/browser/request-controller.ts +0 -164
- package/src/cache/memory-store.ts +0 -253
- package/src/href-context.ts +0 -33
- package/src/href.ts +0 -255
- package/src/vite/expose-handle-id.ts +0 -209
- package/src/vite/expose-loader-id.ts +0 -357
- package/src/vite/expose-location-state-id.ts +0 -177
- /package/src/vite/{version.d.ts → plugins/version.d.ts} +0 -0
package/src/loader.rsc.ts
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
* Only used in react-server context via export conditions.
|
|
6
6
|
*
|
|
7
7
|
* For non-fetchable loaders: returns a loader definition with fn included
|
|
8
|
-
* For fetchable loaders: stores fn in registry and returns a serializable loader
|
|
8
|
+
* For fetchable loaders: stores fn in registry and returns a serializable loader
|
|
9
9
|
*
|
|
10
|
-
* The $$id is injected by the Vite
|
|
10
|
+
* The $$id is injected by the Vite exposeInternalIds plugin as a hidden parameter.
|
|
11
11
|
* Users don't need to pass any name - IDs are auto-generated from file path.
|
|
12
12
|
*/
|
|
13
13
|
|
|
@@ -17,91 +17,58 @@ import type {
|
|
|
17
17
|
LoaderFn,
|
|
18
18
|
} from "./types.js";
|
|
19
19
|
import type { MiddlewareFn } from "./router/middleware.js";
|
|
20
|
-
import {
|
|
20
|
+
import {
|
|
21
|
+
registerFetchableLoader,
|
|
22
|
+
getFetchableLoader,
|
|
23
|
+
} from "./server/fetchable-loader-store.js";
|
|
21
24
|
|
|
22
|
-
|
|
23
|
-
// Maps loader $$id to its function and middleware
|
|
24
|
-
//
|
|
25
|
-
// WHY TWO REGISTRIES?
|
|
26
|
-
// This registry (fetchableLoaderRegistry) is populated immediately when createLoader() runs.
|
|
27
|
-
// The other registry in loader-registry.ts (loaderRegistry) is a cache used by the RSC handler
|
|
28
|
-
// for GET-based fetching. The RSC handler calls getFetchableLoader() from here to populate
|
|
29
|
-
// its cache. This separation allows:
|
|
30
|
-
// 1. Server actions to look up loaders directly without going through lazy loading
|
|
31
|
-
// 2. The RSC handler to use lazy loading for production builds
|
|
32
|
-
// 3. Both to share the same source of truth (this registry)
|
|
33
|
-
const fetchableLoaderRegistry = new Map<
|
|
34
|
-
string,
|
|
35
|
-
{ fn: LoaderFn<any, any, any>; middleware: MiddlewareFn[] }
|
|
36
|
-
>();
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* Register a fetchable loader's function internally
|
|
40
|
-
* Called during module initialization with the $$id
|
|
41
|
-
*/
|
|
42
|
-
function registerFetchableLoader(
|
|
43
|
-
id: string,
|
|
44
|
-
fn: LoaderFn<any, any, any>,
|
|
45
|
-
middleware: MiddlewareFn[]
|
|
46
|
-
): void {
|
|
47
|
-
fetchableLoaderRegistry.set(id, { fn, middleware });
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* Get a fetchable loader's function from the internal registry by $$id
|
|
52
|
-
*
|
|
53
|
-
* This is used internally by:
|
|
54
|
-
* - Server actions (loaderAction) to execute loader functions
|
|
55
|
-
* - loader-registry.ts to populate the main registry for GET-based fetching
|
|
56
|
-
*
|
|
57
|
-
* Loaders are registered here when createLoader() is called with fetchable: true.
|
|
58
|
-
* The $$id is injected by the Vite exposeLoaderId plugin.
|
|
59
|
-
*
|
|
60
|
-
* @param id - The loader's $$id (auto-generated from file path + export name)
|
|
61
|
-
* @returns The loader function and middleware, or undefined if not found
|
|
62
|
-
*
|
|
63
|
-
* @internal This is primarily for internal use by the router infrastructure
|
|
64
|
-
*/
|
|
65
|
-
export function getFetchableLoader(
|
|
66
|
-
id: string
|
|
67
|
-
): { fn: LoaderFn<any, any, any>; middleware: MiddlewareFn[] } | undefined {
|
|
68
|
-
return fetchableLoaderRegistry.get(id);
|
|
69
|
-
}
|
|
25
|
+
export { getFetchableLoader };
|
|
70
26
|
|
|
71
27
|
// Overload 1: With function only (not fetchable)
|
|
72
28
|
export function createLoader<T>(
|
|
73
|
-
fn: LoaderFn<T, Record<string, string | undefined>, any
|
|
29
|
+
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
74
30
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
|
|
75
31
|
|
|
76
32
|
// Overload 2: Fetchable with `true` (no middleware)
|
|
77
33
|
export function createLoader<T>(
|
|
78
34
|
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
79
|
-
fetchable: true
|
|
35
|
+
fetchable: true,
|
|
80
36
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
|
|
81
37
|
|
|
82
38
|
// Overload 3: Fetchable with middleware options
|
|
83
39
|
export function createLoader<T>(
|
|
84
40
|
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
85
|
-
options: FetchableLoaderOptions
|
|
41
|
+
options: FetchableLoaderOptions,
|
|
86
42
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
|
|
87
43
|
|
|
88
44
|
// Implementation - the $$id parameter is injected by Vite plugin, not user-provided
|
|
89
45
|
export function createLoader<T>(
|
|
90
46
|
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
91
47
|
fetchable?: true | FetchableLoaderOptions,
|
|
92
|
-
// Hidden parameter injected by Vite
|
|
93
|
-
__injectedId?: string
|
|
48
|
+
// Hidden parameter injected by Vite exposeInternalIds plugin
|
|
49
|
+
__injectedId?: string,
|
|
94
50
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>> {
|
|
95
51
|
// The $$id will be set on the returned object by Vite plugin
|
|
96
52
|
// For fetchable loaders, __injectedId is also passed as a parameter
|
|
97
53
|
const loaderId = __injectedId || "";
|
|
98
54
|
|
|
99
|
-
|
|
55
|
+
if (!loaderId && process.env.NODE_ENV === "development") {
|
|
56
|
+
throw new Error(
|
|
57
|
+
"[rsc-router] Loader is missing $$id. " +
|
|
58
|
+
"Make sure the exposeInternalIds Vite plugin is enabled and " +
|
|
59
|
+
"the loader is exported with: export const MyLoader = createLoader(...)",
|
|
60
|
+
);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
// If not fetchable, store fn in registry (for SSR ctx.use() resolution)
|
|
64
|
+
// but mark fetchable=false so the _rsc_loader endpoint rejects it.
|
|
100
65
|
if (fetchable === undefined) {
|
|
66
|
+
if (fn && loaderId) {
|
|
67
|
+
registerFetchableLoader(loaderId, fn, [], false);
|
|
68
|
+
}
|
|
101
69
|
return {
|
|
102
70
|
__brand: "loader",
|
|
103
71
|
$$id: loaderId,
|
|
104
|
-
fn: fn as LoaderFn<Awaited<T>, Record<string, string | undefined>, any>,
|
|
105
72
|
};
|
|
106
73
|
}
|
|
107
74
|
|
|
@@ -110,95 +77,13 @@ export function createLoader<T>(
|
|
|
110
77
|
fetchable === true ? [] : fetchable?.middleware || [];
|
|
111
78
|
|
|
112
79
|
// Register the function in the internal registry by $$id (server-side only)
|
|
113
|
-
// The
|
|
80
|
+
// The loader fetch handler looks it up by $$id when load() is called from the client.
|
|
114
81
|
if (fn && loaderId) {
|
|
115
|
-
registerFetchableLoader(loaderId, fn, middleware);
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
// Create server action for form-based fetching
|
|
119
|
-
// This action is serializable and can be passed to client components
|
|
120
|
-
// The loaderId is captured in closure (it's a primitive string)
|
|
121
|
-
//
|
|
122
|
-
// IMPORTANT: The signature must be (prevState, formData) for useActionState compatibility.
|
|
123
|
-
// When used with useActionState, React passes the previous state as the first argument.
|
|
124
|
-
// The prevState is ignored here since loaders are stateless data fetchers.
|
|
125
|
-
async function loaderAction(
|
|
126
|
-
_prevState: Awaited<T> | null,
|
|
127
|
-
formData: FormData
|
|
128
|
-
): Promise<Awaited<T>> {
|
|
129
|
-
"use server";
|
|
130
|
-
|
|
131
|
-
// Look up the loader from registry by $$id
|
|
132
|
-
const registered = fetchableLoaderRegistry.get(loaderId);
|
|
133
|
-
if (!registered) {
|
|
134
|
-
throw new Error(`Loader "${loaderId}" not found in registry`);
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
// Get request context (env, request, url, variables) from the RSC handler
|
|
138
|
-
// This is set by runWithRequestContext in rsc/index.ts when executing actions
|
|
139
|
-
const requestCtx = getRequestContext();
|
|
140
|
-
|
|
141
|
-
// Convert FormData to params object
|
|
142
|
-
const params: Record<string, string> = {};
|
|
143
|
-
formData.forEach((value, key) => {
|
|
144
|
-
if (typeof value === "string") {
|
|
145
|
-
params[key] = value;
|
|
146
|
-
}
|
|
147
|
-
});
|
|
148
|
-
|
|
149
|
-
// Use real request/url from context, or fall back to synthetic for edge cases
|
|
150
|
-
const actionUrl = requestCtx?.url ?? new URL("http://localhost/");
|
|
151
|
-
const actionRequest = requestCtx?.request ?? new Request(actionUrl, { method: "POST" });
|
|
152
|
-
const env = requestCtx?.env ?? {};
|
|
153
|
-
|
|
154
|
-
// Merge variables from request context (app-level middleware) with loader-specific variables
|
|
155
|
-
// requestCtx.var is the shared variables object from the handler
|
|
156
|
-
const variables: Record<string, any> = { ...requestCtx?.var };
|
|
157
|
-
|
|
158
|
-
// Execute middleware for auth checks, headers, cookies
|
|
159
|
-
// Headers/cookies set on ctx.res will be merged into the final response
|
|
160
|
-
if (registered.middleware.length > 0 && requestCtx?.res) {
|
|
161
|
-
const { executeServerActionMiddleware } = await import(
|
|
162
|
-
"./router/middleware.js"
|
|
163
|
-
);
|
|
164
|
-
await executeServerActionMiddleware(
|
|
165
|
-
registered.middleware,
|
|
166
|
-
actionRequest,
|
|
167
|
-
env,
|
|
168
|
-
params,
|
|
169
|
-
variables,
|
|
170
|
-
requestCtx.res
|
|
171
|
-
);
|
|
172
|
-
}
|
|
173
|
-
|
|
174
|
-
// Build context using createHandlerContext for consistency with route handlers
|
|
175
|
-
// Variables are now accessed from request context via getRequestContext()
|
|
176
|
-
const { createHandlerContext } = await import("./router/handler-context.js");
|
|
177
|
-
const baseCtx = createHandlerContext(
|
|
178
|
-
params,
|
|
179
|
-
actionRequest,
|
|
180
|
-
actionUrl.searchParams,
|
|
181
|
-
actionUrl.pathname,
|
|
182
|
-
actionUrl,
|
|
183
|
-
env
|
|
184
|
-
);
|
|
185
|
-
|
|
186
|
-
// Extend with server action specific properties
|
|
187
|
-
const ctx: any = {
|
|
188
|
-
...baseCtx,
|
|
189
|
-
method: "POST",
|
|
190
|
-
formData,
|
|
191
|
-
};
|
|
192
|
-
|
|
193
|
-
// Execute and return result
|
|
194
|
-
return registered.fn(ctx);
|
|
82
|
+
registerFetchableLoader(loaderId, fn, middleware, true);
|
|
195
83
|
}
|
|
196
84
|
|
|
197
|
-
// Return a loader object with action for form-based fetching
|
|
198
|
-
// The exposeLoaderId plugin will set $$id on this object
|
|
199
85
|
return {
|
|
200
86
|
__brand: "loader",
|
|
201
87
|
$$id: loaderId,
|
|
202
|
-
action: loaderAction,
|
|
203
88
|
};
|
|
204
89
|
}
|
package/src/loader.ts
CHANGED
|
@@ -2,10 +2,15 @@
|
|
|
2
2
|
* rsc-router/loader (client version)
|
|
3
3
|
*
|
|
4
4
|
* Client-only stub for createLoader. Returns a minimal loader definition
|
|
5
|
-
* that can be passed to hooks like useLoader.
|
|
6
|
-
* is not included
|
|
5
|
+
* ({ __brand, $$id }) that can be passed to hooks like useLoader.
|
|
6
|
+
* The actual loader function is not included -- it only exists on the server.
|
|
7
7
|
*
|
|
8
|
-
*
|
|
8
|
+
* For export-only loader files, the Vite plugin replaces the entire file with
|
|
9
|
+
* object literals (bypassing this function). Those stubs only contain
|
|
10
|
+
* { __brand, $$id }.
|
|
11
|
+
* This function only runs when loaders are in mixed files (not export-only).
|
|
12
|
+
*
|
|
13
|
+
* The $$id is injected by the Vite exposeInternalIds plugin.
|
|
9
14
|
*/
|
|
10
15
|
|
|
11
16
|
import type {
|
|
@@ -16,32 +21,44 @@ import type {
|
|
|
16
21
|
|
|
17
22
|
// Overload 1: With function only (not fetchable)
|
|
18
23
|
export function createLoader<T>(
|
|
19
|
-
fn: LoaderFn<T, Record<string, string | undefined>, any
|
|
24
|
+
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
20
25
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
|
|
21
26
|
|
|
22
27
|
// Overload 2: Fetchable with `true` (no middleware)
|
|
23
28
|
export function createLoader<T>(
|
|
24
29
|
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
25
|
-
fetchable: true
|
|
30
|
+
fetchable: true,
|
|
26
31
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
|
|
27
32
|
|
|
28
33
|
// Overload 3: Fetchable with middleware options
|
|
29
34
|
export function createLoader<T>(
|
|
30
35
|
fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
31
|
-
options: FetchableLoaderOptions
|
|
36
|
+
options: FetchableLoaderOptions,
|
|
32
37
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>>;
|
|
33
38
|
|
|
34
39
|
// Implementation - client stub that just returns the loader definition
|
|
35
40
|
// The $$id parameter is injected by Vite plugin, not user-provided
|
|
41
|
+
//
|
|
42
|
+
// NOTE: For export-only loader files, the Vite plugin replaces the entire
|
|
43
|
+
// file with object literals (bypassing this function). This function only
|
|
44
|
+
// runs when loaders are in mixed files (not export-only).
|
|
36
45
|
export function createLoader<T>(
|
|
37
46
|
_fn: LoaderFn<T, Record<string, string | undefined>, any>,
|
|
38
47
|
_fetchable?: true | FetchableLoaderOptions,
|
|
39
|
-
__injectedId?: string
|
|
48
|
+
__injectedId?: string,
|
|
40
49
|
): LoaderDefinition<Awaited<T>, Record<string, string | undefined>> {
|
|
41
|
-
|
|
42
|
-
|
|
50
|
+
const loaderId = __injectedId || "";
|
|
51
|
+
|
|
52
|
+
if (!loaderId && process.env.NODE_ENV === "development") {
|
|
53
|
+
throw new Error(
|
|
54
|
+
"[rsc-router] Loader is missing $$id. " +
|
|
55
|
+
"Make sure the exposeInternalIds Vite plugin is enabled and " +
|
|
56
|
+
"the loader is exported with: export const MyLoader = createLoader(...)",
|
|
57
|
+
);
|
|
58
|
+
}
|
|
59
|
+
|
|
43
60
|
return {
|
|
44
61
|
__brand: "loader",
|
|
45
|
-
$$id:
|
|
62
|
+
$$id: loaderId,
|
|
46
63
|
};
|
|
47
64
|
}
|
|
@@ -16,6 +16,8 @@ interface NetworkErrorThrowerProps {
|
|
|
16
16
|
* 1. Errors must be thrown during React's render phase to be caught by error boundaries
|
|
17
17
|
* 2. The error occurs in async code (fetch), so we need to propagate it to React's render
|
|
18
18
|
*/
|
|
19
|
-
export function NetworkErrorThrower({
|
|
19
|
+
export function NetworkErrorThrower({
|
|
20
|
+
error,
|
|
21
|
+
}: NetworkErrorThrowerProps): ReactNode {
|
|
20
22
|
throw error;
|
|
21
23
|
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
"use client";
|
|
2
|
+
|
|
3
|
+
import { useContext, useMemo, type ReactNode } from "react";
|
|
4
|
+
import { OutletContext, type OutletContextValue } from "./outlet-context.js";
|
|
5
|
+
import type { ResolvedSegment } from "./types.js";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Provider for outlet content - used internally by renderSegments
|
|
9
|
+
*
|
|
10
|
+
* Stores a reference to parent context so useLoader can walk up the chain
|
|
11
|
+
* to find loader data from parent layouts. If this segment defines a loading
|
|
12
|
+
* component, Outlet will wrap content with Suspense using that as fallback.
|
|
13
|
+
*/
|
|
14
|
+
export function OutletProvider({
|
|
15
|
+
content,
|
|
16
|
+
parallel,
|
|
17
|
+
segment,
|
|
18
|
+
loaderData,
|
|
19
|
+
children,
|
|
20
|
+
}: {
|
|
21
|
+
content: ReactNode;
|
|
22
|
+
parallel?: ResolvedSegment[];
|
|
23
|
+
segment?: ResolvedSegment;
|
|
24
|
+
loaderData?: Record<string, any>;
|
|
25
|
+
children: ReactNode;
|
|
26
|
+
}): ReactNode {
|
|
27
|
+
// Get parent context to enable walking up the chain for loader lookups
|
|
28
|
+
const parentContext = useContext(OutletContext);
|
|
29
|
+
|
|
30
|
+
const value = useMemo(
|
|
31
|
+
() => ({
|
|
32
|
+
content,
|
|
33
|
+
parallel,
|
|
34
|
+
segment,
|
|
35
|
+
loaderData,
|
|
36
|
+
parent: parentContext,
|
|
37
|
+
loading: segment?.loading,
|
|
38
|
+
}),
|
|
39
|
+
[content, parallel, segment, loaderData, parentContext],
|
|
40
|
+
);
|
|
41
|
+
|
|
42
|
+
return (
|
|
43
|
+
<OutletContext.Provider value={value}>{children}</OutletContext.Provider>
|
|
44
|
+
);
|
|
45
|
+
}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Deterministic param hashing for prerender storage keys.
|
|
3
|
+
*
|
|
4
|
+
* Used at build time (child process) to generate filenames and at
|
|
5
|
+
* runtime (worker) to look up pre-rendered data. Both environments
|
|
6
|
+
* must produce identical hashes for the same params.
|
|
7
|
+
*
|
|
8
|
+
* Uses a simple DJB2-based hash that works in all JS environments
|
|
9
|
+
* (Node.js, Cloudflare Workers, browsers) without crypto imports.
|
|
10
|
+
*/
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Compute a deterministic hash string from route params.
|
|
14
|
+
* For static routes (no params), returns "_".
|
|
15
|
+
*/
|
|
16
|
+
export function hashParams(params: Record<string, string>): string {
|
|
17
|
+
const entries = Object.entries(params);
|
|
18
|
+
if (entries.length === 0) return "_";
|
|
19
|
+
|
|
20
|
+
const sorted = entries.sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0));
|
|
21
|
+
const str = sorted
|
|
22
|
+
.map(([k, v]) => `${encodeURIComponent(k)}=${encodeURIComponent(v)}`)
|
|
23
|
+
.join("&");
|
|
24
|
+
return djb2Hex(str);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* DJB2 hash returning an 8-char hex string.
|
|
29
|
+
* Deterministic across all JS runtimes.
|
|
30
|
+
*/
|
|
31
|
+
function djb2Hex(str: string): string {
|
|
32
|
+
let hash = 5381;
|
|
33
|
+
for (let i = 0; i < str.length; i++) {
|
|
34
|
+
hash = ((hash << 5) + hash + str.charCodeAt(i)) >>> 0;
|
|
35
|
+
}
|
|
36
|
+
return hash.toString(16).padStart(8, "0");
|
|
37
|
+
}
|
|
@@ -0,0 +1,185 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Prerender Store
|
|
3
|
+
*
|
|
4
|
+
* Reads pre-rendered segment data from the worker bundle at build time.
|
|
5
|
+
* The manifest module is lazily loaded via globalThis.__loadPrerenderManifestModule,
|
|
6
|
+
* a function injected into the RSC entry that returns the manifest module
|
|
7
|
+
* containing a key-to-specifier map and a `loadPrerenderAsset` function
|
|
8
|
+
* that anchors import() resolution relative to the manifest file.
|
|
9
|
+
*/
|
|
10
|
+
|
|
11
|
+
import type {
|
|
12
|
+
SerializedSegmentData,
|
|
13
|
+
SegmentHandleData,
|
|
14
|
+
} from "../cache/types.js";
|
|
15
|
+
|
|
16
|
+
export interface PrerenderEntry {
|
|
17
|
+
segments: SerializedSegmentData[];
|
|
18
|
+
handles: Record<string, SegmentHandleData>;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export interface PrerenderStore {
|
|
22
|
+
get(
|
|
23
|
+
routeName: string,
|
|
24
|
+
paramHash: string,
|
|
25
|
+
meta?: { pathname: string; isPassthroughRoute?: boolean },
|
|
26
|
+
): PrerenderEntry | null | Promise<PrerenderEntry | null>;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
export interface StaticEntry {
|
|
30
|
+
encoded: string;
|
|
31
|
+
handles: Record<string, unknown[]>;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
export interface StaticStore {
|
|
35
|
+
get(handlerId: string): Promise<StaticEntry | null>;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
interface PrerenderManifestModule {
|
|
39
|
+
default: Record<string, string>;
|
|
40
|
+
loadPrerenderAsset: (
|
|
41
|
+
specifier: string,
|
|
42
|
+
) => Promise<{ default: PrerenderEntry }>;
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
declare global {
|
|
46
|
+
// Injected by closeBundle post-processing: lazy loader for the prerender
|
|
47
|
+
// manifest module. The module exports a key→specifier map and a
|
|
48
|
+
// loadPrerenderAsset function that anchors import() relative to the manifest.
|
|
49
|
+
// eslint-disable-next-line no-var
|
|
50
|
+
var __loadPrerenderManifestModule:
|
|
51
|
+
| (() => Promise<PrerenderManifestModule>)
|
|
52
|
+
| undefined;
|
|
53
|
+
// Injected by closeBundle post-processing: map of handlerId -> () => import("./assets/__st-*.js")
|
|
54
|
+
// Asset default export is either a string (no handles) or { encoded, handles } object.
|
|
55
|
+
// eslint-disable-next-line no-var
|
|
56
|
+
var __STATIC_MANIFEST:
|
|
57
|
+
| Record<string, () => Promise<{ default: string | StaticEntry }>>
|
|
58
|
+
| undefined;
|
|
59
|
+
// Injected by virtual module in dev mode for on-demand prerender
|
|
60
|
+
// eslint-disable-next-line no-var
|
|
61
|
+
var __PRERENDER_DEV_URL: string | undefined;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* Create a dev-mode prerender store that fetches on-demand from the
|
|
66
|
+
* Vite dev server's /__rsc_prerender endpoint (runs in Node.js where
|
|
67
|
+
* node:fs works, unlike workerd).
|
|
68
|
+
*/
|
|
69
|
+
export function createDevPrerenderStore(devUrl: string): PrerenderStore {
|
|
70
|
+
return {
|
|
71
|
+
async get(routeName, paramHash, meta) {
|
|
72
|
+
if (!meta?.pathname) return null;
|
|
73
|
+
const isIntercept = paramHash.endsWith("/i");
|
|
74
|
+
let url = `${devUrl}/__rsc_prerender?pathname=${encodeURIComponent(meta.pathname)}&routeName=${encodeURIComponent(routeName)}`;
|
|
75
|
+
if (isIntercept) url += "&intercept=1";
|
|
76
|
+
if (meta.isPassthroughRoute) url += "&passthrough=1";
|
|
77
|
+
try {
|
|
78
|
+
const res = await fetch(url);
|
|
79
|
+
if (!res.ok) return null;
|
|
80
|
+
return res.json();
|
|
81
|
+
} catch {
|
|
82
|
+
return null;
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
};
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
/**
|
|
89
|
+
* Create a prerender store.
|
|
90
|
+
* Dev mode: on-demand fetch from Vite dev server (node:fs works there).
|
|
91
|
+
* Production: backed by globalThis.__loadPrerenderManifestModule which lazily
|
|
92
|
+
* loads the manifest module on first access.
|
|
93
|
+
* Returns null if no prerender data is available.
|
|
94
|
+
*/
|
|
95
|
+
export function createPrerenderStore(): PrerenderStore | null {
|
|
96
|
+
if (globalThis.__PRERENDER_DEV_URL) {
|
|
97
|
+
return createDevPrerenderStore(globalThis.__PRERENDER_DEV_URL);
|
|
98
|
+
}
|
|
99
|
+
if (!globalThis.__loadPrerenderManifestModule) return null;
|
|
100
|
+
|
|
101
|
+
const cache = new Map<string, Promise<PrerenderEntry | null>>();
|
|
102
|
+
let manifestModulePromise: Promise<PrerenderManifestModule | null> | null =
|
|
103
|
+
null;
|
|
104
|
+
|
|
105
|
+
function loadManifestModule(): Promise<PrerenderManifestModule | null> {
|
|
106
|
+
if (!manifestModulePromise) {
|
|
107
|
+
manifestModulePromise = globalThis.__loadPrerenderManifestModule!().catch(
|
|
108
|
+
() => null,
|
|
109
|
+
);
|
|
110
|
+
}
|
|
111
|
+
return manifestModulePromise;
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
return {
|
|
115
|
+
get(routeName: string, paramHash: string): Promise<PrerenderEntry | null> {
|
|
116
|
+
const key = `${routeName}/${paramHash}`;
|
|
117
|
+
const cached = cache.get(key);
|
|
118
|
+
if (cached) return cached;
|
|
119
|
+
|
|
120
|
+
const promise = loadManifestModule().then((mod) => {
|
|
121
|
+
if (!mod) return null;
|
|
122
|
+
const specifier = mod.default[key];
|
|
123
|
+
if (!specifier) return null;
|
|
124
|
+
return mod
|
|
125
|
+
.loadPrerenderAsset(specifier)
|
|
126
|
+
.then((asset) => asset.default)
|
|
127
|
+
.catch(() => null);
|
|
128
|
+
});
|
|
129
|
+
cache.set(key, promise);
|
|
130
|
+
return promise;
|
|
131
|
+
},
|
|
132
|
+
};
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* Load the prerender manifest index for test introspection.
|
|
137
|
+
* Returns the key→specifier map or null if unavailable.
|
|
138
|
+
*/
|
|
139
|
+
export async function loadPrerenderManifestIndex(): Promise<Record<
|
|
140
|
+
string,
|
|
141
|
+
string
|
|
142
|
+
> | null> {
|
|
143
|
+
if (!globalThis.__loadPrerenderManifestModule) return null;
|
|
144
|
+
try {
|
|
145
|
+
const mod = await globalThis.__loadPrerenderManifestModule();
|
|
146
|
+
return mod.default;
|
|
147
|
+
} catch {
|
|
148
|
+
return null;
|
|
149
|
+
}
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
/**
|
|
153
|
+
* Create a static segment store.
|
|
154
|
+
* Production only: backed by globalThis.__STATIC_MANIFEST injected at build time.
|
|
155
|
+
* Returns null if no static data is available (dev mode or no Static handlers).
|
|
156
|
+
*/
|
|
157
|
+
export function createStaticStore(): StaticStore | null {
|
|
158
|
+
const manifest = globalThis.__STATIC_MANIFEST;
|
|
159
|
+
if (!manifest || Object.keys(manifest).length === 0) return null;
|
|
160
|
+
|
|
161
|
+
const cache = new Map<string, Promise<StaticEntry | null>>();
|
|
162
|
+
|
|
163
|
+
return {
|
|
164
|
+
get(handlerId: string): Promise<StaticEntry | null> {
|
|
165
|
+
const cached = cache.get(handlerId);
|
|
166
|
+
if (cached) return cached;
|
|
167
|
+
|
|
168
|
+
const importFn = manifest[handlerId];
|
|
169
|
+
if (!importFn) return Promise.resolve(null);
|
|
170
|
+
|
|
171
|
+
const promise = importFn()
|
|
172
|
+
.then((mod) => {
|
|
173
|
+
const val = mod.default;
|
|
174
|
+
// Normalize: string-only (no handles) or { encoded, handles }
|
|
175
|
+
if (typeof val === "string") {
|
|
176
|
+
return { encoded: val, handles: {} } as StaticEntry;
|
|
177
|
+
}
|
|
178
|
+
return val as StaticEntry;
|
|
179
|
+
})
|
|
180
|
+
.catch(() => null);
|
|
181
|
+
cache.set(handlerId, promise);
|
|
182
|
+
return promise;
|
|
183
|
+
},
|
|
184
|
+
};
|
|
185
|
+
}
|