@rangojs/router 0.0.0-experimental.88a3b2f7 → 0.0.0-experimental.8bd1b239

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 (52) hide show
  1. package/dist/vite/index.js +307 -128
  2. package/package.json +3 -3
  3. package/skills/handler-use/SKILL.md +362 -0
  4. package/skills/intercept/SKILL.md +20 -0
  5. package/skills/layout/SKILL.md +22 -0
  6. package/skills/middleware/SKILL.md +32 -3
  7. package/skills/migrate-nextjs/SKILL.md +560 -0
  8. package/skills/migrate-react-router/SKILL.md +764 -0
  9. package/skills/parallel/SKILL.md +59 -0
  10. package/skills/rango/SKILL.md +24 -22
  11. package/skills/route/SKILL.md +24 -0
  12. package/src/browser/navigation-bridge.ts +21 -2
  13. package/src/browser/navigation-client.ts +34 -6
  14. package/src/browser/partial-update.ts +14 -2
  15. package/src/browser/prefetch/cache.ts +16 -6
  16. package/src/browser/prefetch/fetch.ts +60 -4
  17. package/src/browser/react/Link.tsx +25 -2
  18. package/src/browser/react/use-navigation.ts +11 -10
  19. package/src/browser/segment-reconciler.ts +36 -14
  20. package/src/build/route-trie.ts +50 -24
  21. package/src/client.tsx +84 -230
  22. package/src/index.ts +41 -9
  23. package/src/reverse.ts +4 -1
  24. package/src/route-definition/dsl-helpers.ts +164 -21
  25. package/src/route-definition/helpers-types.ts +61 -14
  26. package/src/router/handler-context.ts +4 -1
  27. package/src/router/loader-resolution.ts +70 -46
  28. package/src/router/match-middleware/cache-lookup.ts +10 -5
  29. package/src/router/match-middleware/segment-resolution.ts +1 -1
  30. package/src/router/match-result.ts +82 -4
  31. package/src/router/segment-resolution/fresh.ts +52 -0
  32. package/src/router/segment-resolution/revalidation.ts +69 -1
  33. package/src/rsc/handler.ts +13 -5
  34. package/src/rsc/loader-fetch.ts +23 -3
  35. package/src/rsc/progressive-enhancement.ts +10 -2
  36. package/src/rsc/rsc-rendering.ts +5 -1
  37. package/src/rsc/server-action.ts +6 -0
  38. package/src/rsc/types.ts +1 -0
  39. package/src/segment-content-promise.ts +67 -0
  40. package/src/segment-loader-promise.ts +122 -0
  41. package/src/segment-system.tsx +11 -61
  42. package/src/server/handle-store.ts +19 -0
  43. package/src/server/request-context.ts +54 -14
  44. package/src/types/segments.ts +1 -1
  45. package/src/urls/path-helper-types.ts +34 -5
  46. package/src/use-loader.tsx +77 -5
  47. package/src/vite/discovery/prerender-collection.ts +124 -83
  48. package/src/vite/plugins/expose-id-utils.ts +12 -0
  49. package/src/vite/plugins/expose-ids/handler-transform.ts +30 -0
  50. package/src/vite/plugins/expose-internal-ids.ts +257 -40
  51. package/src/vite/router-discovery.ts +25 -3
  52. package/src/vite/utils/prerender-utils.ts +20 -6
@@ -19,6 +19,18 @@ export function hashId(filePath: string, exportName: string): string {
19
19
  return `${hash.slice(0, 8)}#${exportName}`;
20
20
  }
21
21
 
22
+ /**
23
+ * Build a stable ID for an export binding. Uses hashed IDs in production
24
+ * builds (short + opaque) and readable path#name IDs in dev.
25
+ */
26
+ export function makeStubId(
27
+ filePath: string,
28
+ exportName: string,
29
+ isBuild: boolean,
30
+ ): string {
31
+ return isBuild ? hashId(filePath, exportName) : `${filePath}#${exportName}`;
32
+ }
33
+
22
34
  /**
23
35
  * Generate an 8-char hex hash for an inline static handler call site.
24
36
  * Uses file path and line number (plus optional index for same-line collisions).
@@ -138,6 +138,36 @@ export function generateExprStubs(
138
138
  };
139
139
  }
140
140
 
141
+ /**
142
+ * Replace handler call expressions with lightweight stub objects on an
143
+ * existing MagicString. Unlike generateExprStubs (which creates its own
144
+ * MagicString and returns the full result), this integrates into the
145
+ * unified transform pipeline so all transforms share one sourcemap.
146
+ */
147
+ export function stubHandlerExprs(
148
+ cfg: HandlerTransformConfig,
149
+ bindings: CreateExportBinding[],
150
+ s: MagicString,
151
+ filePath: string,
152
+ isBuild: boolean,
153
+ ): boolean {
154
+ let hasChanges = false;
155
+ for (const binding of bindings) {
156
+ const exportName = binding.exportNames[0];
157
+ const handlerId = isBuild
158
+ ? hashId(filePath, exportName)
159
+ : `${filePath}#${exportName}`;
160
+
161
+ s.overwrite(
162
+ binding.callExprStart,
163
+ binding.callCloseParenPos + 1,
164
+ `{ __brand: "${cfg.brand}", $$id: "${handlerId}" }`,
165
+ );
166
+ hasChanges = true;
167
+ }
168
+ return hasChanges;
169
+ }
170
+
141
171
  /**
142
172
  * Inject $$id into export const handler calls in RSC environments.
143
173
  */
@@ -2,7 +2,12 @@ import type { Plugin, ResolvedConfig } from "vite";
2
2
  import { parseAst } from "vite";
3
3
  import MagicString from "magic-string";
4
4
  import path from "node:path";
5
- import { normalizePath, hashId, detectImports } from "./expose-id-utils.js";
5
+ import {
6
+ normalizePath,
7
+ hashId,
8
+ makeStubId,
9
+ detectImports,
10
+ } from "./expose-id-utils.js";
6
11
  import {
7
12
  transformInlineHandlers,
8
13
  type VirtualHandlerEntry,
@@ -23,6 +28,7 @@ import {
23
28
  getImportedFnNames,
24
29
  collectCreateExportBindings,
25
30
  buildUnsupportedShapeWarning,
31
+ isExportOnlyFile,
26
32
  } from "./expose-ids/export-analysis.js";
27
33
  import {
28
34
  hasCreateLoaderImport,
@@ -34,6 +40,7 @@ import {
34
40
  transformLocationState,
35
41
  generateWholeFileStubs,
36
42
  generateExprStubs,
43
+ stubHandlerExprs,
37
44
  transformHandlerIds,
38
45
  } from "./expose-ids/handler-transform.js";
39
46
 
@@ -385,7 +392,9 @@ ${lazyImports.join(",\n")}
385
392
  if (stubResult) return stubResult;
386
393
  }
387
394
 
388
- // --- PrerenderHandler: non-RSC stub replacement ---
395
+ // --- PrerenderHandler: non-RSC whole-file stub replacement ---
396
+ // When ALL exports are Prerender() calls, replace the entire file.
397
+ // Mixed-export files are handled in the unified pipeline below.
389
398
  if (hasPrerenderHandlerCode && !isRscEnv) {
390
399
  const fnNames = getFnNames(PRERENDER_CONFIG.fnName);
391
400
  const bindings = getBindings(code, fnNames);
@@ -397,16 +406,6 @@ ${lazyImports.join(",\n")}
397
406
  isBuild,
398
407
  );
399
408
  if (wholeFile) return wholeFile;
400
-
401
- const exprStubs = generateExprStubs(
402
- PRERENDER_CONFIG,
403
- bindings,
404
- code,
405
- filePath,
406
- id,
407
- isBuild,
408
- );
409
- if (exprStubs) return exprStubs;
410
409
  }
411
410
 
412
411
  // --- PrerenderHandler: RSC build module tracking ---
@@ -467,7 +466,8 @@ ${lazyImports.join(",\n")}
467
466
  }
468
467
  }
469
468
 
470
- // --- StaticHandler: non-RSC stub replacement ---
469
+ // --- StaticHandler: non-RSC whole-file stub replacement ---
470
+ // When ALL exports are Static() calls, replace the entire file.
471
471
  if (hasStaticHandlerCode && !isRscEnv) {
472
472
  const fnNames = getFnNames(STATIC_CONFIG.fnName);
473
473
  const bindings = getBindings(code, fnNames);
@@ -479,16 +479,212 @@ ${lazyImports.join(",\n")}
479
479
  isBuild,
480
480
  );
481
481
  if (wholeFile) return wholeFile;
482
+ }
482
483
 
483
- const exprStubs = generateExprStubs(
484
- STATIC_CONFIG,
485
- bindings,
486
- code,
487
- filePath,
488
- id,
489
- isBuild,
490
- );
491
- if (exprStubs) return exprStubs;
484
+ // --- Mixed-type whole-file stub replacement (non-RSC) ---
485
+ // When the individual whole-file checks above fail (each only checks
486
+ // one type), the file has mixed exports (e.g. createLoader + Prerender).
487
+ // Gather ALL stub-safe bindings and check if they cover every export.
488
+ // If yes, replace the entire file with stubs — this strips server-only
489
+ // imports (node:fs, DB clients, etc.) that would crash in the browser.
490
+ //
491
+ // Only applies when the file contains Prerender/Static (the handler
492
+ // types that bring server-only code). Files with only loaders, handles,
493
+ // or locationState are handled correctly by the unified pipeline below.
494
+ //
495
+ // Loader, Prerender, and Static exports become plain { __brand, $$id }
496
+ // stubs. createHandle and createLocationState need their create*()
497
+ // functions to execute (collect registration / __rsc_ls_key), so their
498
+ // call expressions are preserved with only a @rangojs/router import.
499
+ // This strips all server-only imports while keeping the correct
500
+ // client contract for every export type.
501
+ if (!isRscEnv && (hasPrerenderHandlerCode || hasStaticHandlerCode)) {
502
+ const prerenderFnNames = hasPrerenderHandlerCode
503
+ ? getFnNames(PRERENDER_CONFIG.fnName)
504
+ : [];
505
+ const staticFnNames = hasStaticHandlerCode
506
+ ? getFnNames(STATIC_CONFIG.fnName)
507
+ : [];
508
+ const loaderFnNames = hasLoaderCode ? getFnNames("createLoader") : [];
509
+ const handleFnNames = hasHandleCode ? getFnNames("createHandle") : [];
510
+ const lsFnNames = hasLocationStateCode
511
+ ? getFnNames("createLocationState")
512
+ : [];
513
+
514
+ // Collect ALL recognized bindings to check export coverage
515
+ const allBindings: CreateExportBinding[] = [];
516
+ for (const fnNames of [
517
+ prerenderFnNames,
518
+ staticFnNames,
519
+ loaderFnNames,
520
+ handleFnNames,
521
+ lsFnNames,
522
+ ]) {
523
+ if (fnNames.length > 0) {
524
+ allBindings.push(...getBindings(code, fnNames));
525
+ }
526
+ }
527
+
528
+ // Check if preserved createHandle/createLocationState calls
529
+ // reference non-exported locals (e.g. helper functions, constants).
530
+ // If so, the whole-file stub would strip those locals, breaking
531
+ // the call. Fall through to the unified pipeline instead.
532
+ let canStubWholeFile =
533
+ allBindings.length > 0 && isExportOnlyFile(code, allBindings);
534
+
535
+ if (
536
+ canStubWholeFile &&
537
+ (handleFnNames.length > 0 || lsFnNames.length > 0)
538
+ ) {
539
+ const exportedLocals = new Set(allBindings.map((b) => b.localName));
540
+ // Collect bindings that would be stripped by whole-file replacement:
541
+ // local declarations and imported bindings from non-@rangojs/router
542
+ // modules. This is a regex-based heuristic — it intentionally skips
543
+ // edge cases (class decls, destructured bindings, combined
544
+ // default+named imports) since those rarely appear in route files.
545
+ const strippedBindings: string[] = [];
546
+
547
+ // Skip React Fast Refresh temporaries (_c, _c2, ...) which are
548
+ // injected by @vitejs/plugin-react in the client environment and
549
+ // would falsely trigger the bailout.
550
+ const localDeclPattern =
551
+ /(?:^|;|\n)\s*(?:const|let|var|function)\s+(\w+)/g;
552
+ let declMatch: RegExpExecArray | null;
553
+ while ((declMatch = localDeclPattern.exec(code)) !== null) {
554
+ const name = declMatch[1];
555
+ if (!exportedLocals.has(name) && !/^_c\d*$/.test(name)) {
556
+ strippedBindings.push(name);
557
+ }
558
+ }
559
+
560
+ const importPattern =
561
+ /import\s*\{([^}]*)\}\s*from\s*["'](?!@rangojs\/router)[^"']*["']/g;
562
+ let importMatch: RegExpExecArray | null;
563
+ while ((importMatch = importPattern.exec(code)) !== null) {
564
+ for (const spec of importMatch[1].split(",")) {
565
+ const m = spec
566
+ .trim()
567
+ .match(/^[A-Za-z_$][\w$]*(?:\s+as\s+([A-Za-z_$][\w$]*))?$/);
568
+ if (m) strippedBindings.push(m[1] || m[0].trim().split(/\s/)[0]);
569
+ }
570
+ }
571
+ const defaultImportPattern =
572
+ /import\s+([A-Za-z_$][\w$]*)\s+from\s*["'](?!@rangojs\/router)[^"']*["']/g;
573
+ while ((importMatch = defaultImportPattern.exec(code)) !== null) {
574
+ strippedBindings.push(importMatch[1]);
575
+ }
576
+ const nsImportPattern =
577
+ /import\s+\*\s+as\s+([A-Za-z_$][\w$]*)\s+from\s*["'](?!@rangojs\/router)[^"']*["']/g;
578
+ while ((importMatch = nsImportPattern.exec(code)) !== null) {
579
+ strippedBindings.push(importMatch[1]);
580
+ }
581
+
582
+ if (strippedBindings.length > 0) {
583
+ const preservedBindings = allBindings.filter((b) => {
584
+ const fc = code.slice(b.callExprStart, b.callOpenParenPos + 1);
585
+ return (
586
+ handleFnNames.some((n) => fc.includes(n)) ||
587
+ lsFnNames.some((n) => fc.includes(n))
588
+ );
589
+ });
590
+ const strippedRe = new RegExp(
591
+ `\\b(?:${strippedBindings.join("|")})\\b`,
592
+ );
593
+ canStubWholeFile = !preservedBindings.some((b) => {
594
+ const expr = code.slice(b.callExprStart, b.callCloseParenPos + 1);
595
+ return strippedRe.test(expr);
596
+ });
597
+ }
598
+ }
599
+
600
+ if (canStubWholeFile) {
601
+ const lines: string[] = [];
602
+ const neededImports: string[] = [];
603
+ if (handleFnNames.length > 0) neededImports.push("createHandle");
604
+ if (lsFnNames.length > 0) neededImports.push("createLocationState");
605
+ if (neededImports.length > 0) {
606
+ lines.push(
607
+ `import { ${neededImports.join(", ")} } from "@rangojs/router";`,
608
+ );
609
+ }
610
+
611
+ for (const binding of allBindings) {
612
+ const fnCall = code.slice(
613
+ binding.callExprStart,
614
+ binding.callOpenParenPos + 1,
615
+ );
616
+ const isHandle = handleFnNames.some((n) => fnCall.includes(n));
617
+ const isLocationState = lsFnNames.some((n) => fnCall.includes(n));
618
+
619
+ // Aliases share the primary name's ID (matches server transforms).
620
+ const primaryName = binding.exportNames[0];
621
+ const stubId = makeStubId(filePath, primaryName, isBuild);
622
+
623
+ if (isHandle || isLocationState) {
624
+ // Rewrite alias to canonical name since the stub file only
625
+ // imports canonical names from @rangojs/router.
626
+ // Strip React Fast Refresh `_c = ` wrappers from args
627
+ // (e.g. `_c = (segments) => ...` → `(segments) => ...`)
628
+ const rawArgs = code
629
+ .slice(binding.callOpenParenPos + 1, binding.callCloseParenPos)
630
+ .replace(/\b_c\d*\s*=\s*/g, "");
631
+ const canonicalName = isHandle
632
+ ? "createHandle"
633
+ : "createLocationState";
634
+ const activeFnNames = isHandle ? handleFnNames : lsFnNames;
635
+
636
+ // Reconstruct the function name (handling aliases + generics)
637
+ let rawCallee = code.slice(
638
+ binding.callExprStart,
639
+ binding.callOpenParenPos,
640
+ );
641
+ for (const alias of activeFnNames) {
642
+ if (alias !== canonicalName && rawCallee.startsWith(alias)) {
643
+ rawCallee = canonicalName + rawCallee.slice(alias.length);
644
+ break;
645
+ }
646
+ }
647
+
648
+ if (isHandle) {
649
+ // createHandle checks __injectedId DURING the call, so $$id
650
+ // must be a parameter, not a post-call property assignment.
651
+ const idParam =
652
+ binding.argCount === 0
653
+ ? `undefined, "${stubId}"`
654
+ : `, "${stubId}"`;
655
+ lines.push(
656
+ `export const ${primaryName} = ${rawCallee}(${rawArgs}${idParam});`,
657
+ );
658
+ lines.push(`${primaryName}.$$id = "${stubId}";`);
659
+ } else {
660
+ lines.push(
661
+ `export const ${primaryName} = ${rawCallee}(${rawArgs});`,
662
+ );
663
+ lines.push(
664
+ `${primaryName}.__rsc_ls_key = "__rsc_ls_${stubId}";`,
665
+ );
666
+ }
667
+ for (const name of binding.exportNames.slice(1)) {
668
+ lines.push(`export const ${name} = ${primaryName};`);
669
+ }
670
+ } else {
671
+ let brand = "loader";
672
+ if (prerenderFnNames.some((n) => fnCall.includes(n))) {
673
+ brand = PRERENDER_CONFIG.brand;
674
+ } else if (staticFnNames.some((n) => fnCall.includes(n))) {
675
+ brand = STATIC_CONFIG.brand;
676
+ }
677
+ lines.push(
678
+ `export const ${primaryName} = { __brand: "${brand}", $$id: "${stubId}" };`,
679
+ );
680
+ for (const name of binding.exportNames.slice(1)) {
681
+ lines.push(`export const ${name} = ${primaryName};`);
682
+ }
683
+ }
684
+ }
685
+
686
+ return { code: lines.join("\n") + "\n", map: null };
687
+ }
492
688
  }
493
689
 
494
690
  // --- StaticHandler: RSC build module tracking ---
@@ -535,27 +731,48 @@ ${lazyImports.join(",\n")}
535
731
  isBuild,
536
732
  ) || changed;
537
733
  }
538
- if (hasPrerenderHandlerCode && isRscEnv) {
734
+ if (hasPrerenderHandlerCode) {
539
735
  const fnNames = getFnNames(PRERENDER_CONFIG.fnName);
540
- changed =
541
- transformHandlerIds(
542
- PRERENDER_CONFIG,
543
- getBindings(code, fnNames),
544
- s,
545
- filePath,
546
- isBuild,
547
- ) || changed;
736
+ const bindings = getBindings(code, fnNames);
737
+ if (isRscEnv) {
738
+ changed =
739
+ transformHandlerIds(
740
+ PRERENDER_CONFIG,
741
+ bindings,
742
+ s,
743
+ filePath,
744
+ isBuild,
745
+ ) || changed;
746
+ } else {
747
+ // Non-RSC mixed-export file: replace Prerender() calls with stubs
748
+ // on the shared MagicString so sourcemaps stay accurate.
749
+ changed =
750
+ stubHandlerExprs(
751
+ PRERENDER_CONFIG,
752
+ bindings,
753
+ s,
754
+ filePath,
755
+ isBuild,
756
+ ) || changed;
757
+ }
548
758
  }
549
- if (hasStaticHandlerCode && isRscEnv) {
759
+ if (hasStaticHandlerCode) {
550
760
  const fnNames = getFnNames(STATIC_CONFIG.fnName);
551
- changed =
552
- transformHandlerIds(
553
- STATIC_CONFIG,
554
- getBindings(code, fnNames),
555
- s,
556
- filePath,
557
- isBuild,
558
- ) || changed;
761
+ const bindings = getBindings(code, fnNames);
762
+ if (isRscEnv) {
763
+ changed =
764
+ transformHandlerIds(
765
+ STATIC_CONFIG,
766
+ bindings,
767
+ s,
768
+ filePath,
769
+ isBuild,
770
+ ) || changed;
771
+ } else {
772
+ changed =
773
+ stubHandlerExprs(STATIC_CONFIG, bindings, s, filePath, isBuild) ||
774
+ changed;
775
+ }
559
776
  }
560
777
 
561
778
  if (!changed) return;
@@ -480,9 +480,31 @@ export function createRouterDiscoveryPlugin(
480
480
  return;
481
481
  }
482
482
 
483
- // Prefer the main server's registry (Node.js preset: module runner available).
484
- // Fall back to a temp server for Cloudflare where the main RSC env uses workerd.
485
- let registry = mainRegistry;
483
+ // Import the user's entry module to force re-evaluation of any
484
+ // HMR-invalidated modules in the chain (entry router urls handlers).
485
+ // This ensures createRouter() re-runs with updated handler code before
486
+ // we read RouterRegistry. Without this, edits to prerender handler files
487
+ // produce stale content because the old router instance remains registered.
488
+ const rscEnv = (server.environments as any)?.rsc;
489
+ let registry: Map<string, any> | null = null;
490
+ if (rscEnv?.runner && s.resolvedEntryPath) {
491
+ try {
492
+ await rscEnv.runner.import(s.resolvedEntryPath);
493
+ const serverMod = await rscEnv.runner.import(
494
+ "@rangojs/router/server",
495
+ );
496
+ registry = serverMod.RouterRegistry ?? null;
497
+ } catch (err: any) {
498
+ console.warn(
499
+ `[rsc-router] Dev prerender module refresh failed: ${err.message}`,
500
+ );
501
+ res.statusCode = 500;
502
+ res.end(`Prerender handler error: ${err.message}`);
503
+ return;
504
+ }
505
+ } else {
506
+ registry = mainRegistry;
507
+ }
486
508
 
487
509
  if (!registry) {
488
510
  // No main registry: the RSC env has no module runner (Cloudflare dev).
@@ -41,14 +41,28 @@ export function substituteRouteParams(
41
41
  let result = pattern;
42
42
  let hadOmittedOptional = false;
43
43
 
44
- // First pass: substitute provided params
44
+ // First pass: substitute provided params.
45
+ // Empty string on an optional placeholder is treated as omitted (the trie
46
+ // matcher fills unmatched optionals with "" — letting the second pass
47
+ // strip them keeps slash cleanup consistent). Empty string on required
48
+ // `:key` or wildcard `*key` still substitutes, matching prior behaviour.
45
49
  for (const [key, value] of Object.entries(params)) {
46
50
  const escaped = escapeRegExp(key);
47
- result = result.replace(
48
- new RegExp(`:${escaped}(\\([^)]*\\))?\\??`),
49
- encode(value),
50
- );
51
- result = result.replace(`*${key}`, encode(value));
51
+ if (value === "") {
52
+ // Only replace required placeholders (negative lookahead for `?`);
53
+ // leave `:key?` for the second pass.
54
+ result = result.replace(
55
+ new RegExp(`:${escaped}(\\([^)]*\\))?(?!\\?)`),
56
+ "",
57
+ );
58
+ result = result.replace(`*${key}`, "");
59
+ } else {
60
+ result = result.replace(
61
+ new RegExp(`:${escaped}(\\([^)]*\\))?\\??`),
62
+ encode(value),
63
+ );
64
+ result = result.replace(`*${key}`, encode(value));
65
+ }
52
66
  }
53
67
 
54
68
  // Second pass: strip remaining optional param placeholders not in params