@rangojs/router 0.0.0-experimental.8678bb02 → 0.0.0-experimental.88

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. package/README.md +126 -38
  2. package/dist/bin/rango.js +130 -47
  3. package/dist/vite/index.js +867 -385
  4. package/dist/vite/index.js.bak +5448 -0
  5. package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  6. package/package.json +5 -5
  7. package/skills/breadcrumbs/SKILL.md +3 -1
  8. package/skills/handler-use/SKILL.md +362 -0
  9. package/skills/hooks/SKILL.md +28 -20
  10. package/skills/intercept/SKILL.md +20 -0
  11. package/skills/layout/SKILL.md +22 -0
  12. package/skills/links/SKILL.md +91 -17
  13. package/skills/loader/SKILL.md +35 -2
  14. package/skills/middleware/SKILL.md +34 -3
  15. package/skills/migrate-nextjs/SKILL.md +560 -0
  16. package/skills/migrate-react-router/SKILL.md +765 -0
  17. package/skills/parallel/SKILL.md +59 -0
  18. package/skills/prerender/SKILL.md +110 -68
  19. package/skills/rango/SKILL.md +24 -22
  20. package/skills/response-routes/SKILL.md +8 -0
  21. package/skills/route/SKILL.md +24 -0
  22. package/skills/router-setup/SKILL.md +35 -0
  23. package/skills/streams-and-websockets/SKILL.md +283 -0
  24. package/skills/typesafety/SKILL.md +3 -1
  25. package/src/__internal.ts +1 -1
  26. package/src/browser/app-shell.ts +52 -0
  27. package/src/browser/app-version.ts +14 -0
  28. package/src/browser/navigation-bridge.ts +87 -6
  29. package/src/browser/navigation-client.ts +128 -77
  30. package/src/browser/navigation-store.ts +68 -9
  31. package/src/browser/partial-update.ts +60 -7
  32. package/src/browser/prefetch/cache.ts +129 -21
  33. package/src/browser/prefetch/fetch.ts +156 -18
  34. package/src/browser/prefetch/queue.ts +36 -5
  35. package/src/browser/rango-state.ts +53 -13
  36. package/src/browser/react/Link.tsx +72 -8
  37. package/src/browser/react/NavigationProvider.tsx +57 -11
  38. package/src/browser/react/context.ts +7 -2
  39. package/src/browser/react/use-handle.ts +9 -58
  40. package/src/browser/react/use-navigation.ts +22 -2
  41. package/src/browser/react/use-params.ts +11 -1
  42. package/src/browser/react/use-router.ts +29 -9
  43. package/src/browser/rsc-router.tsx +60 -9
  44. package/src/browser/scroll-restoration.ts +10 -8
  45. package/src/browser/segment-reconciler.ts +36 -14
  46. package/src/browser/server-action-bridge.ts +8 -18
  47. package/src/browser/types.ts +33 -5
  48. package/src/build/generate-manifest.ts +6 -6
  49. package/src/build/generate-route-types.ts +3 -0
  50. package/src/build/route-trie.ts +50 -24
  51. package/src/build/route-types/include-resolution.ts +8 -1
  52. package/src/build/route-types/router-processing.ts +211 -72
  53. package/src/build/route-types/scan-filter.ts +8 -1
  54. package/src/cache/cf/cf-cache-store.ts +5 -7
  55. package/src/client.tsx +84 -230
  56. package/src/deps/browser.ts +0 -1
  57. package/src/handle.ts +40 -0
  58. package/src/index.rsc.ts +6 -1
  59. package/src/index.ts +49 -6
  60. package/src/outlet-context.ts +1 -1
  61. package/src/prerender/store.ts +5 -4
  62. package/src/prerender.ts +138 -77
  63. package/src/response-utils.ts +28 -0
  64. package/src/reverse.ts +27 -2
  65. package/src/route-definition/dsl-helpers.ts +210 -35
  66. package/src/route-definition/helpers-types.ts +61 -14
  67. package/src/route-definition/index.ts +3 -0
  68. package/src/route-definition/redirect.ts +9 -1
  69. package/src/route-definition/resolve-handler-use.ts +155 -0
  70. package/src/route-types.ts +18 -0
  71. package/src/router/content-negotiation.ts +100 -1
  72. package/src/router/handler-context.ts +70 -17
  73. package/src/router/intercept-resolution.ts +9 -4
  74. package/src/router/lazy-includes.ts +6 -6
  75. package/src/router/loader-resolution.ts +153 -21
  76. package/src/router/manifest.ts +22 -13
  77. package/src/router/match-api.ts +127 -192
  78. package/src/router/match-middleware/cache-lookup.ts +28 -8
  79. package/src/router/match-middleware/segment-resolution.ts +53 -0
  80. package/src/router/match-result.ts +82 -4
  81. package/src/router/middleware-types.ts +2 -28
  82. package/src/router/middleware.ts +32 -7
  83. package/src/router/navigation-snapshot.ts +182 -0
  84. package/src/router/pattern-matching.ts +60 -9
  85. package/src/router/prerender-match.ts +110 -10
  86. package/src/router/preview-match.ts +30 -102
  87. package/src/router/request-classification.ts +310 -0
  88. package/src/router/route-snapshot.ts +245 -0
  89. package/src/router/router-interfaces.ts +36 -4
  90. package/src/router/router-options.ts +37 -11
  91. package/src/router/segment-resolution/fresh.ts +70 -5
  92. package/src/router/segment-resolution/revalidation.ts +87 -9
  93. package/src/router/trie-matching.ts +10 -4
  94. package/src/router/url-params.ts +49 -0
  95. package/src/router.ts +54 -7
  96. package/src/rsc/handler.ts +478 -399
  97. package/src/rsc/helpers.ts +69 -41
  98. package/src/rsc/loader-fetch.ts +18 -3
  99. package/src/rsc/manifest-init.ts +5 -1
  100. package/src/rsc/progressive-enhancement.ts +14 -3
  101. package/src/rsc/response-route-handler.ts +14 -1
  102. package/src/rsc/rsc-rendering.ts +15 -2
  103. package/src/rsc/server-action.ts +10 -2
  104. package/src/rsc/ssr-setup.ts +2 -2
  105. package/src/rsc/types.ts +6 -4
  106. package/src/segment-content-promise.ts +67 -0
  107. package/src/segment-loader-promise.ts +122 -0
  108. package/src/segment-system.tsx +11 -61
  109. package/src/server/context.ts +65 -5
  110. package/src/server/handle-store.ts +19 -0
  111. package/src/server/loader-registry.ts +9 -8
  112. package/src/server/request-context.ts +142 -55
  113. package/src/ssr/index.tsx +3 -0
  114. package/src/static-handler.ts +18 -6
  115. package/src/types/cache-types.ts +4 -4
  116. package/src/types/handler-context.ts +17 -43
  117. package/src/types/loader-types.ts +37 -11
  118. package/src/types/request-scope.ts +126 -0
  119. package/src/types/route-entry.ts +12 -1
  120. package/src/types/segments.ts +1 -1
  121. package/src/urls/include-helper.ts +24 -14
  122. package/src/urls/path-helper-types.ts +39 -6
  123. package/src/urls/path-helper.ts +47 -12
  124. package/src/urls/pattern-types.ts +12 -0
  125. package/src/urls/response-types.ts +18 -16
  126. package/src/use-loader.tsx +77 -5
  127. package/src/vite/discovery/bundle-postprocess.ts +30 -33
  128. package/src/vite/discovery/discover-routers.ts +5 -1
  129. package/src/vite/discovery/prerender-collection.ts +128 -74
  130. package/src/vite/discovery/state.ts +13 -4
  131. package/src/vite/index.ts +4 -0
  132. package/src/vite/plugin-types.ts +60 -5
  133. package/src/vite/plugins/cloudflare-protocol-loader-hook.d.mts +23 -0
  134. package/src/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
  135. package/src/vite/plugins/cloudflare-protocol-stub.ts +214 -0
  136. package/src/vite/plugins/expose-id-utils.ts +12 -0
  137. package/src/vite/plugins/expose-ids/handler-transform.ts +30 -0
  138. package/src/vite/plugins/expose-internal-ids.ts +257 -40
  139. package/src/vite/plugins/performance-tracks.ts +64 -206
  140. package/src/vite/plugins/refresh-cmd.ts +88 -26
  141. package/src/vite/rango.ts +50 -20
  142. package/src/vite/router-discovery.ts +237 -37
  143. package/src/vite/utils/banner.ts +1 -1
  144. package/src/vite/utils/package-resolution.ts +41 -1
  145. package/src/vite/utils/prerender-utils.ts +37 -5
  146. package/src/vite/utils/shared-utils.ts +3 -2
  147. package/src/browser/debug-channel.ts +0 -93
@@ -1,8 +1,13 @@
1
1
  import type { Plugin } from "vite";
2
2
 
3
3
  /**
4
- * Vite plugin that triggers a full browser reload when Ctrl+R is pressed
5
- * in the terminal running the dev server.
4
+ * Vite plugin that triggers a full browser reload from terminal input.
5
+ *
6
+ * This plugin is intentionally passive:
7
+ * - it never enables raw mode on stdin
8
+ * - it never restores terminal state
9
+ * - it reacts to Ctrl+R when that raw byte reaches the process
10
+ * - it also supports safe line-based fallbacks like "e" + Enter
6
11
  *
7
12
  * Usage:
8
13
  * ```ts
@@ -20,35 +25,95 @@ export function poke(): Plugin {
20
25
 
21
26
  configureServer(server) {
22
27
  const stdin = process.stdin;
28
+ const debug = process.env.RANGO_POKE_DEBUG === "1";
29
+
30
+ const triggerReload = (source: string) => {
31
+ server.hot.send({ type: "full-reload", path: "*" });
32
+ server.config.logger.info(` browser reload (${source})`, {
33
+ timestamp: true,
34
+ });
35
+ };
36
+
37
+ const toBuffer = (chunk: string | Buffer): Buffer => {
38
+ return typeof chunk === "string" ? Buffer.from(chunk, "utf8") : chunk;
39
+ };
40
+
41
+ const formatChunk = (chunk: string | Buffer): string => {
42
+ const data = toBuffer(chunk);
43
+ const hex = Array.from(data)
44
+ .map((byte) => `0x${byte.toString(16).padStart(2, "0")}`)
45
+ .join(" ");
46
+ const ascii = Array.from(data)
47
+ .map((byte) => {
48
+ if (byte >= 0x20 && byte <= 0x7e) return String.fromCharCode(byte);
49
+ if (byte === 0x0a) return "\\n";
50
+ if (byte === 0x0d) return "\\r";
51
+ if (byte === 0x09) return "\\t";
52
+ return ".";
53
+ })
54
+ .join("");
55
+ return `len=${data.length} hex=[${hex}] ascii="${ascii}"`;
56
+ };
57
+
58
+ const readCtrlR = (chunk: string | Buffer): boolean => {
59
+ const data =
60
+ typeof chunk === "string" ? Buffer.from(chunk, "utf8") : chunk;
61
+ return data.length === 1 && data[0] === 0x12;
62
+ };
63
+
64
+ const readSubmittedCommands = (chunk: string | Buffer): string[] => {
65
+ const text = toBuffer(chunk)
66
+ .toString("utf8")
67
+ .replace(/\r\n/g, "\n")
68
+ .replace(/\r/g, "\n");
69
+
70
+ if (!text.includes("\n")) return [];
71
+
72
+ const lines = text.split("\n");
73
+ lines.pop();
74
+ return lines;
75
+ };
76
+
77
+ if (debug) {
78
+ server.config.logger.info(
79
+ ` poke debug enabled (isTTY=${stdin.isTTY ? "yes" : "no"}, isRaw=${stdin.isTTY ? (stdin.isRaw ? "yes" : "no") : "n/a"})`,
80
+ { timestamp: true },
81
+ );
82
+ }
23
83
 
24
- // Raw mode delivers individual keystrokes as immediate single-byte
25
- // events instead of waiting for Enter (cooked/line-buffered mode).
26
- // Without it, Ctrl+R (0x12) is never delivered as a discrete byte.
27
- // When stdin is a pipe (CI, spawned process) setRawMode is unavailable
28
- // but data already arrives unbuffered, so the isTTY guard suffices.
29
- const previousRawMode = stdin.isTTY ? stdin.isRaw : null;
30
84
  if (stdin.isTTY) {
31
- stdin.setRawMode(true);
85
+ server.config.logger.info(
86
+ " poke ready: press e + enter to reload browser (ctrl+r also works when available)",
87
+ { timestamp: true },
88
+ );
32
89
  }
33
90
 
34
- const onData = (data: Buffer) => {
35
- if (data.length !== 1) return;
91
+ const onData = (data: string | Buffer) => {
92
+ if (debug) {
93
+ server.config.logger.info(` poke stdin ${formatChunk(data)}`, {
94
+ timestamp: true,
95
+ });
96
+ }
36
97
 
37
- // Ctrl+C (0x03) defensive fallback. This plugin enables raw mode
38
- // before Vite's internal stdin handler is registered (user plugins
39
- // run first), so there is a brief window where Ctrl+C would be
40
- // swallowed. Re-emit SIGINT so the process exits as expected.
41
- if (data[0] === 0x03) {
42
- process.emit("SIGINT", "SIGINT");
98
+ // Only react to the exact Ctrl+R byte when some host terminal or
99
+ // wrapper already delivers it to this process. We intentionally do
100
+ // not enable raw mode here because that can steal Vite shortcuts
101
+ // like "r" / "q" and interfere with terminal-level controls.
102
+ if (readCtrlR(data)) {
103
+ triggerReload("ctrl+r");
43
104
  return;
44
105
  }
45
106
 
46
- // Ctrl+R = 0x12 in raw mode
47
- if (data[0] === 0x12) {
48
- server.hot.send({ type: "full-reload", path: "*" });
49
- server.config.logger.info(" browser reload (ctrl+r)", {
50
- timestamp: true,
51
- });
107
+ for (const command of readSubmittedCommands(data)) {
108
+ if (command === "e") {
109
+ triggerReload("e+enter");
110
+ return;
111
+ }
112
+
113
+ if (command === "\u001br") {
114
+ triggerReload("option+r+enter");
115
+ return;
116
+ }
52
117
  }
53
118
  };
54
119
 
@@ -56,9 +121,6 @@ export function poke(): Plugin {
56
121
 
57
122
  server.httpServer?.on("close", () => {
58
123
  stdin.off("data", onData);
59
- if (stdin.isTTY && previousRawMode !== null) {
60
- stdin.setRawMode(previousRawMode);
61
- }
62
124
  });
63
125
  },
64
126
  };
package/src/vite/rango.ts CHANGED
@@ -12,6 +12,8 @@ import { VIRTUAL_IDS } from "./plugins/virtual-entries.js";
12
12
  import {
13
13
  getExcludeDeps,
14
14
  getPackageAliases,
15
+ getPublishedPackageName,
16
+ getVendorAliases,
15
17
  } from "./utils/package-resolution.js";
16
18
  import { findRouterFiles } from "../build/generate-route-types.js";
17
19
  import { createVersionPlugin } from "./plugins/version-plugin.js";
@@ -55,14 +57,36 @@ import { performanceTracksPlugin } from "./plugins/performance-tracks.js";
55
57
  export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
56
58
  const resolvedOptions: RangoOptions = options ?? { preset: "node" };
57
59
  const preset = resolvedOptions.preset ?? "node";
58
- console.log("[perf-tracks] rango() called, preset:", preset);
59
60
  const showBanner = resolvedOptions.banner ?? true;
60
61
 
61
62
  const plugins: PluginOption[] = [];
62
63
 
63
- // Get package resolution info (workspace vs npm install)
64
- const rangoAliases = getPackageAliases();
65
- const excludeDeps = getExcludeDeps();
64
+ // Get package resolution info (workspace vs npm install).
65
+ // Vendor aliases redirect the bare plugin-rsc vendor specs (which plugin-rsc
66
+ // itself injects into optimizeDeps.include) to absolute paths resolved from
67
+ // this package — so strict-pnpm consumers don't hit "Failed to resolve
68
+ // dependency" warnings when those deps aren't hoisted to their app root.
69
+ const rangoAliases = { ...getPackageAliases(), ...getVendorAliases() };
70
+ const excludeDeps = [
71
+ ...getExcludeDeps(),
72
+ // plugin-rsc itself injects these into the client env's
73
+ // optimizeDeps.include, which overrides exclude for the dep's own
74
+ // pre-bundle entry. What exclude still controls is how *other*
75
+ // pre-bundled deps treat imports of these specs (external vs inlined)
76
+ // via esbuildCjsExternalPlugin. The cjs-to-esm transform in
77
+ // plugins/cjs-to-esm.ts is the fallback for strict-pnpm consumers,
78
+ // where client.browser's bare include fails to resolve and Vite ends up
79
+ // serving the raw CJS file at dev-serve time.
80
+ "@vitejs/plugin-rsc/browser",
81
+ "@vitejs/plugin-rsc/vendor/react-server-dom/client.browser",
82
+ ];
83
+
84
+ // Vite supports a nested `A > B` syntax in optimizeDeps.include that resolves
85
+ // B from A's location. We anchor transitive deps (rsc-html-stream,
86
+ // @vitejs/plugin-rsc/vendor/*) to @rangojs/router so pnpm consumers — where
87
+ // these aren't visible at the app root — can still pre-bundle them.
88
+ const pkg = getPublishedPackageName();
89
+ const nested = (spec: string) => `${pkg} > ${spec}`;
66
90
 
67
91
  // Mutable ref for router path (node preset only).
68
92
  // Set immediately when user-specified, or populated by the auto-discover
@@ -118,7 +142,7 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
118
142
  // Pre-bundle rsc-html-stream to prevent discovery during first request
119
143
  // Exclude rsc-router modules to ensure same Context instance
120
144
  optimizeDeps: {
121
- include: ["rsc-html-stream/client"],
145
+ include: [nested("rsc-html-stream/client")],
122
146
  exclude: excludeDeps,
123
147
  esbuildOptions: sharedEsbuildOptions,
124
148
  },
@@ -143,8 +167,10 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
143
167
  "react-dom/static.edge",
144
168
  "react/jsx-runtime",
145
169
  "react/jsx-dev-runtime",
146
- "rsc-html-stream/server",
147
- "@vitejs/plugin-rsc/vendor/react-server-dom/client.edge",
170
+ nested("rsc-html-stream/server"),
171
+ nested(
172
+ "@vitejs/plugin-rsc/vendor/react-server-dom/client.edge",
173
+ ),
148
174
  ],
149
175
  exclude: excludeDeps,
150
176
  esbuildOptions: sharedEsbuildOptions,
@@ -159,7 +185,9 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
159
185
  "react",
160
186
  "react/jsx-runtime",
161
187
  "react/jsx-dev-runtime",
162
- "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge",
188
+ nested(
189
+ "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge",
190
+ ),
163
191
  ],
164
192
  exclude: excludeDeps,
165
193
  esbuildOptions: sharedEsbuildOptions,
@@ -184,6 +212,9 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
184
212
 
185
213
  plugins.push(createVirtualEntriesPlugin(finalEntries));
186
214
 
215
+ // Dev-only: RSDW client patch for React Performance Tracks
216
+ plugins.push(performanceTracksPlugin());
217
+
187
218
  // Add RSC plugin with cloudflare-specific options
188
219
  // Note: loadModuleDevProxy should NOT be used with childEnvironments
189
220
  // since SSR runs in workerd alongside RSC
@@ -269,7 +300,7 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
269
300
  "react-dom",
270
301
  "react/jsx-runtime",
271
302
  "react/jsx-dev-runtime",
272
- "rsc-html-stream/client",
303
+ nested("rsc-html-stream/client"),
273
304
  ],
274
305
  exclude: excludeDeps,
275
306
  esbuildOptions: sharedEsbuildOptions,
@@ -286,7 +317,9 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
286
317
  "react-dom/static.edge",
287
318
  "react/jsx-runtime",
288
319
  "react/jsx-dev-runtime",
289
- "@vitejs/plugin-rsc/vendor/react-server-dom/client.edge",
320
+ nested(
321
+ "@vitejs/plugin-rsc/vendor/react-server-dom/client.edge",
322
+ ),
290
323
  ],
291
324
  exclude: excludeDeps,
292
325
  esbuildOptions: sharedEsbuildOptions,
@@ -299,7 +332,9 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
299
332
  "react",
300
333
  "react/jsx-runtime",
301
334
  "react/jsx-dev-runtime",
302
- "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge",
335
+ nested(
336
+ "@vitejs/plugin-rsc/vendor/react-server-dom/server.edge",
337
+ ),
303
338
  ],
304
339
  esbuildOptions: sharedEsbuildOptions,
305
340
  },
@@ -336,14 +371,8 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
336
371
  // Add virtual entries plugin (RSC entry generated lazily from routerRef)
337
372
  plugins.push(createVirtualEntriesPlugin(finalEntries, routerRef));
338
373
 
339
- // Dev-only: React Performance Tracks (debugChannel transport via HMR WS)
340
- // Must be before rsc() so middleware runs before RSC handler.
341
- const perfPlugin = performanceTracksPlugin();
342
- console.log(
343
- "[perf-tracks] rango: plugin created, has configureServer:",
344
- !!perfPlugin.configureServer,
345
- );
346
- plugins.push(perfPlugin);
374
+ // Dev-only: RSDW client patch for React Performance Tracks
375
+ plugins.push(performanceTracksPlugin());
347
376
 
348
377
  plugins.push(
349
378
  rsc({
@@ -448,7 +477,8 @@ export async function rango(options?: RangoOptions): Promise<PluginOption[]> {
448
477
  createRouterDiscoveryPlugin(discoveryEntryPath, {
449
478
  routerPathRef: discoveryRouterRef,
450
479
  enableBuildPrerender: prerenderEnabled,
451
- staticRouteTypesGeneration: resolvedOptions.staticRouteTypesGeneration,
480
+ buildEnv: options?.buildEnv,
481
+ preset,
452
482
  }),
453
483
  );
454
484