@rangojs/router 0.0.0-experimental.79 → 0.0.0-experimental.7c7e4327
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 +8 -4
- package/README.md +301 -797
- package/dist/bin/rango.js +603 -145
- package/dist/testing/vitest.js +82 -0
- package/dist/vite/index.js +3750 -1160
- package/dist/vite/plugins/cloudflare-protocol-loader-hook.mjs +76 -0
- package/package.json +96 -24
- package/skills/api-client/SKILL.md +211 -0
- package/skills/breadcrumbs/SKILL.md +85 -6
- package/skills/bundle-analysis/SKILL.md +159 -0
- package/skills/cache-guide/SKILL.md +228 -33
- package/skills/caching/SKILL.md +336 -19
- package/skills/catalog.json +271 -0
- package/skills/comparison/SKILL.md +50 -0
- package/skills/comparison/agents/openai.yaml +4 -0
- package/skills/comparison/references/framework-comparison.md +837 -0
- package/skills/composability/SKILL.md +110 -4
- package/skills/css/SKILL.md +76 -0
- package/skills/debug-manifest/SKILL.md +5 -3
- package/skills/defer-hydration/SKILL.md +235 -0
- package/skills/document-cache/SKILL.md +87 -56
- package/skills/fonts/SKILL.md +1 -1
- package/skills/handler-use/SKILL.md +12 -10
- package/skills/hooks/SKILL.md +73 -691
- package/skills/hooks/data.md +273 -0
- package/skills/hooks/handle-and-actions.md +103 -0
- package/skills/hooks/navigation.md +110 -0
- package/skills/hooks/outlets.md +41 -0
- package/skills/hooks/state.md +228 -0
- package/skills/hooks/urls.md +135 -0
- package/skills/host-router/SKILL.md +129 -27
- package/skills/i18n/SKILL.md +276 -0
- package/skills/intercept/SKILL.md +75 -19
- package/skills/layout/SKILL.md +40 -19
- package/skills/links/SKILL.md +247 -17
- package/skills/loader/SKILL.md +248 -10
- package/skills/middleware/SKILL.md +25 -13
- package/skills/migrate-nextjs/SKILL.md +205 -20
- package/skills/migrate-react-router/SKILL.md +59 -670
- package/skills/migrate-react-router/cloudflare-workers.md +129 -0
- package/skills/migrate-react-router/component-migration.md +196 -0
- package/skills/migrate-react-router/data-and-actions.md +225 -0
- package/skills/migrate-react-router/route-mapping.md +271 -0
- package/skills/mime-routes/SKILL.md +29 -2
- package/skills/observability/SKILL.md +202 -0
- package/skills/parallel/SKILL.md +40 -10
- package/skills/ppr/SKILL.md +616 -0
- package/skills/prerender/SKILL.md +72 -60
- package/skills/rango/SKILL.md +318 -26
- package/skills/react-compiler/SKILL.md +168 -0
- package/skills/response-routes/SKILL.md +138 -49
- package/skills/route/SKILL.md +117 -9
- package/skills/router-setup/SKILL.md +44 -9
- package/skills/scripts/SKILL.md +179 -0
- package/skills/server-actions/SKILL.md +776 -0
- package/skills/shell-manifest/SKILL.md +185 -0
- package/skills/streams-and-websockets/SKILL.md +283 -0
- package/skills/tailwind/SKILL.md +28 -4
- package/skills/testing/SKILL.md +130 -0
- package/skills/testing/bindings.md +103 -0
- package/skills/testing/cache-prerender.md +127 -0
- package/skills/testing/client-components.md +124 -0
- package/skills/testing/e2e-parity.md +125 -0
- package/skills/testing/flight.md +91 -0
- package/skills/testing/handles.md +131 -0
- package/skills/testing/loader.md +128 -0
- package/skills/testing/middleware.md +99 -0
- package/skills/testing/render-handler.md +122 -0
- package/skills/testing/response-routes.md +95 -0
- package/skills/testing/reverse-and-types.md +85 -0
- package/skills/testing/server-actions.md +107 -0
- package/skills/testing/server-tree.md +128 -0
- package/skills/testing/setup.md +123 -0
- package/skills/theme/SKILL.md +1 -1
- package/skills/typesafety/SKILL.md +45 -626
- package/skills/typesafety/env-and-bindings.md +254 -0
- package/skills/typesafety/generated-files-and-cli.md +335 -0
- package/skills/typesafety/params-and-search.md +153 -0
- package/skills/typesafety/route-types.md +209 -0
- package/skills/use-cache/SKILL.md +74 -15
- package/skills/vercel/SKILL.md +128 -0
- package/skills/view-transitions/SKILL.md +337 -0
- package/src/__augment-tests__/augment.ts +81 -0
- package/src/__augment-tests__/augmented.check.ts +116 -0
- package/src/__internal.ts +0 -65
- package/src/browser/action-coordinator.ts +53 -36
- package/src/browser/action-fence.ts +47 -0
- package/src/browser/app-shell.ts +39 -0
- package/src/browser/connection-warmup.ts +134 -0
- package/src/browser/cookie-name.ts +140 -0
- package/src/browser/event-controller.ts +252 -158
- package/src/browser/history-state.ts +21 -0
- package/src/browser/index.ts +3 -3
- package/src/browser/invalidate-client-cache.ts +52 -0
- package/src/browser/logging.ts +28 -0
- package/src/browser/merge-segment-loaders.ts +6 -4
- package/src/browser/navigation-bridge.ts +94 -25
- package/src/browser/navigation-client.ts +144 -79
- package/src/browser/navigation-store-handle.ts +38 -0
- package/src/browser/navigation-store.ts +161 -73
- package/src/browser/navigation-transaction.ts +9 -59
- package/src/browser/network-error-handler.ts +34 -7
- package/src/browser/partial-update.ts +183 -144
- package/src/browser/prefetch/cache.ts +242 -77
- package/src/browser/prefetch/fetch.ts +325 -69
- package/src/browser/prefetch/queue.ts +61 -12
- package/src/browser/rango-state.ts +158 -76
- package/src/browser/react/Link.tsx +58 -20
- package/src/browser/react/NavigationProvider.tsx +202 -120
- package/src/browser/react/ScrollRestoration.tsx +10 -6
- package/src/browser/react/filter-segment-order.ts +66 -7
- package/src/browser/react/index.ts +0 -48
- package/src/browser/react/location-state-shared.ts +178 -8
- package/src/browser/react/location-state.ts +39 -14
- package/src/browser/react/use-action.ts +6 -15
- package/src/browser/react/use-handle.ts +17 -14
- package/src/browser/react/use-href.tsx +8 -1
- package/src/browser/react/use-link-status.ts +33 -8
- package/src/browser/react/use-navigation.ts +32 -7
- package/src/browser/react/use-params.ts +20 -10
- package/src/browser/react/use-reverse.ts +106 -0
- package/src/browser/react/use-router.ts +25 -3
- package/src/browser/react/use-search-params.ts +0 -5
- package/src/browser/react/use-segments.ts +11 -21
- package/src/browser/response-adapter.ts +99 -8
- package/src/browser/rsc-router.tsx +145 -28
- package/src/browser/scroll-restoration.ts +37 -22
- package/src/browser/segment-reconciler.ts +31 -21
- package/src/browser/segment-structure-assert.ts +2 -2
- package/src/browser/server-action-bridge.ts +236 -65
- package/src/browser/types.ts +102 -9
- package/src/browser/validate-redirect-origin.ts +43 -16
- package/src/build/collect-fallback-refs.ts +107 -0
- package/src/build/generate-manifest.ts +203 -154
- package/src/build/generate-route-types.ts +3 -1
- package/src/build/index.ts +11 -3
- package/src/build/prefix-tree-utils.ts +123 -0
- package/src/build/route-trie.ts +152 -21
- package/src/build/route-types/ast-route-extraction.ts +15 -8
- package/src/build/route-types/codegen.ts +16 -5
- package/src/build/route-types/include-resolution.ts +456 -62
- package/src/build/route-types/param-extraction.ts +6 -3
- package/src/build/route-types/per-module-writer.ts +22 -6
- package/src/build/route-types/router-processing.ts +128 -51
- package/src/build/route-types/scan-filter.ts +1 -1
- package/src/build/route-types/source-scan.ts +216 -0
- package/src/build/runtime-discovery.ts +13 -21
- package/src/cache/cache-error.ts +104 -0
- package/src/cache/cache-key-utils.ts +58 -13
- package/src/cache/cache-policy.ts +108 -34
- package/src/cache/cache-runtime.ts +421 -58
- package/src/cache/cache-scope.ts +187 -96
- package/src/cache/cache-tag.ts +149 -0
- package/src/cache/cf/cf-base64.ts +33 -0
- package/src/cache/cf/cf-cache-constants.ts +127 -0
- package/src/cache/cf/cf-cache-store.ts +2202 -372
- package/src/cache/cf/cf-cache-types.ts +349 -0
- package/src/cache/cf/cf-kv-utils.ts +46 -0
- package/src/cache/cf/cf-tag-marker-memo.ts +105 -0
- package/src/cache/cf/index.ts +6 -16
- package/src/cache/document-cache.ts +126 -41
- package/src/cache/handle-snapshot.ts +70 -0
- package/src/cache/index.ts +23 -20
- package/src/cache/memory-segment-store.ts +243 -37
- package/src/cache/profile-registry.ts +46 -31
- package/src/cache/read-through-swr.ts +56 -12
- package/src/cache/segment-codec.ts +13 -21
- package/src/cache/shell-snapshot.ts +417 -0
- package/src/cache/tag-invalidation.ts +230 -0
- package/src/cache/types.ts +180 -99
- package/src/cache/vercel/index.ts +11 -0
- package/src/cache/vercel/vercel-cache-store.ts +1127 -0
- package/src/client.rsc.tsx +41 -21
- package/src/client.tsx +33 -61
- package/src/cloudflare/index.ts +11 -0
- package/src/cloudflare/tracing.ts +108 -0
- package/src/component-utils.ts +19 -0
- package/src/components/DefaultDocument.tsx +8 -2
- package/src/context-var.ts +18 -6
- package/src/decode-loader-results.ts +52 -0
- package/src/defer.ts +185 -0
- package/src/deps/ssr.ts +0 -1
- package/src/encode-kv.ts +49 -0
- package/src/errors.ts +30 -4
- package/src/escape-script.ts +52 -0
- package/src/handle.ts +67 -37
- package/src/handles/MetaTags.tsx +24 -53
- package/src/handles/Scripts.tsx +183 -0
- package/src/handles/breadcrumbs.ts +35 -8
- package/src/handles/deferred-resolution.ts +127 -0
- package/src/handles/is-thenable.ts +18 -0
- package/src/handles/meta.ts +14 -40
- package/src/handles/script.ts +244 -0
- package/src/host/cookie-handler.ts +9 -60
- package/src/host/errors.ts +13 -22
- package/src/host/index.ts +9 -2
- package/src/host/pattern-matcher.ts +23 -52
- package/src/host/router.ts +107 -99
- package/src/host/testing.ts +40 -27
- package/src/host/types.ts +37 -4
- package/src/host/utils.ts +1 -1
- package/src/href-client.ts +137 -22
- package/src/index.rsc.ts +97 -12
- package/src/index.ts +98 -14
- package/src/internal-debug.ts +11 -10
- package/src/loader-store.ts +500 -0
- package/src/loader.rsc.ts +20 -13
- package/src/loader.ts +12 -11
- package/src/missing-id-error.ts +68 -0
- package/src/outlet-context.ts +1 -1
- package/src/outlet-provider.tsx +1 -5
- package/src/prerender/param-hash.ts +16 -16
- package/src/prerender/store.ts +32 -37
- package/src/prerender.ts +78 -10
- package/src/redirect-origin.ts +114 -0
- package/src/regex-escape.ts +8 -0
- package/src/render-error-thrower.tsx +20 -0
- package/src/response-utils.ts +62 -0
- package/src/reverse.ts +65 -39
- package/src/root-error-boundary.tsx +1 -19
- package/src/route-content-wrapper.tsx +19 -77
- package/src/route-definition/dsl-helpers.ts +304 -309
- package/src/route-definition/helper-factories.ts +28 -140
- package/src/route-definition/helpers-types.ts +87 -59
- package/src/route-definition/index.ts +1 -2
- package/src/route-definition/redirect.ts +44 -11
- package/src/route-definition/resolve-handler-use.ts +12 -1
- package/src/route-definition/use-item-types.ts +29 -0
- package/src/route-map-builder.ts +41 -20
- package/src/route-types.ts +19 -46
- package/src/router/basename.ts +14 -0
- package/src/router/content-negotiation.ts +73 -25
- package/src/router/error-handling.ts +45 -18
- package/src/router/find-match.ts +129 -30
- package/src/router/handler-context.ts +27 -42
- package/src/router/instrument.ts +355 -0
- package/src/router/intercept-resolution.ts +39 -20
- package/src/router/lazy-includes.ts +82 -59
- package/src/router/loader-resolution.ts +167 -72
- package/src/router/logging.ts +0 -6
- package/src/router/manifest.ts +74 -40
- package/src/router/match-api.ts +80 -55
- package/src/router/match-context.ts +0 -22
- package/src/router/match-handlers.ts +211 -165
- package/src/router/match-middleware/background-revalidation.ts +40 -24
- package/src/router/match-middleware/cache-lookup.ts +159 -285
- package/src/router/match-middleware/cache-store.ts +64 -52
- package/src/router/match-middleware/intercept-resolution.ts +0 -22
- package/src/router/match-middleware/segment-resolution.ts +0 -22
- package/src/router/match-pipelines.ts +1 -42
- package/src/router/match-result.ts +69 -79
- package/src/router/metrics.ts +0 -34
- package/src/router/middleware-types.ts +7 -134
- package/src/router/middleware.ts +298 -172
- package/src/router/navigation-snapshot.ts +7 -56
- package/src/router/params-util.ts +23 -0
- package/src/router/parse-pattern.ts +115 -0
- package/src/router/pattern-matching.ts +181 -150
- package/src/router/prefetch-cache-ttl.ts +51 -0
- package/src/router/prefetch-limits.ts +37 -0
- package/src/router/prerender-match.ts +112 -67
- package/src/router/preview-match.ts +6 -2
- package/src/router/request-classification.ts +50 -69
- package/src/router/revalidation.ts +123 -73
- package/src/router/route-snapshot.ts +14 -3
- package/src/router/router-context.ts +6 -29
- package/src/router/router-interfaces.ts +115 -36
- package/src/router/router-options.ts +166 -5
- package/src/router/router-registry.ts +2 -5
- package/src/router/segment-resolution/fresh.ts +131 -86
- package/src/router/segment-resolution/helpers.ts +86 -6
- package/src/router/segment-resolution/loader-cache.ts +139 -39
- package/src/router/segment-resolution/loader-mask.ts +67 -0
- package/src/router/segment-resolution/loader-snapshot.ts +251 -0
- package/src/router/segment-resolution/revalidation.ts +272 -320
- package/src/router/segment-resolution/static-store.ts +19 -5
- package/src/router/segment-resolution/streamed-handler-telemetry.ts +52 -0
- package/src/router/segment-resolution/view-transition-default.ts +56 -0
- package/src/router/segment-resolution.ts +5 -1
- package/src/router/segment-wrappers.ts +6 -5
- package/src/router/state-cookie-name.ts +33 -0
- package/src/router/substitute-pattern-params.ts +75 -0
- package/src/router/telemetry-otel.ts +160 -200
- package/src/router/telemetry.ts +105 -20
- package/src/router/timeout.ts +0 -20
- package/src/router/tracing.ts +215 -0
- package/src/router/trie-matching.ts +171 -59
- package/src/router/types.ts +9 -63
- package/src/router/url-params.ts +57 -0
- package/src/router.ts +157 -71
- package/src/rsc/full-payload.ts +70 -0
- package/src/rsc/handler-context.ts +3 -2
- package/src/rsc/handler.ts +291 -217
- package/src/rsc/helpers.ts +168 -46
- package/src/rsc/index.ts +2 -5
- package/src/rsc/json-route-result.ts +38 -0
- package/src/rsc/loader-fetch.ts +114 -38
- package/src/rsc/manifest-init.ts +29 -42
- package/src/rsc/nonce.ts +10 -1
- package/src/rsc/origin-guard.ts +39 -25
- package/src/rsc/progressive-enhancement.ts +124 -13
- package/src/rsc/redirect-guard.ts +100 -0
- package/src/rsc/response-cache-serve.ts +238 -0
- package/src/rsc/response-error.ts +79 -12
- package/src/rsc/response-route-handler.ts +99 -189
- package/src/rsc/rsc-rendering.ts +421 -76
- package/src/rsc/runtime-warnings.ts +23 -10
- package/src/rsc/server-action.ts +282 -116
- package/src/rsc/shell-capture.ts +1158 -0
- package/src/rsc/shell-serve.ts +150 -0
- package/src/rsc/ssr-setup.ts +16 -0
- package/src/rsc/transition-gate.ts +89 -0
- package/src/rsc/types.ts +53 -5
- package/src/runtime-env.ts +18 -0
- package/src/search-params.ts +35 -30
- package/src/segment-loader-promise.ts +49 -4
- package/src/segment-system.tsx +350 -149
- package/src/serialize.ts +243 -0
- package/src/server/context.ts +208 -51
- package/src/server/cookie-parse.ts +32 -0
- package/src/server/cookie-store.ts +152 -5
- package/src/server/handle-store.ts +21 -38
- package/src/server/loader-registry.ts +33 -42
- package/src/server/request-context.ts +395 -176
- package/src/ssr/index.tsx +458 -178
- package/src/ssr/ssr-root.tsx +228 -0
- package/src/static-handler.ts +10 -13
- package/src/testing/cache-status.ts +162 -0
- package/src/testing/collect-handle.ts +46 -0
- package/src/testing/dispatch.ts +813 -0
- package/src/testing/dom.entry.ts +22 -0
- package/src/testing/e2e/fixture.ts +188 -0
- package/src/testing/e2e/index.ts +128 -0
- package/src/testing/e2e/matchers.ts +35 -0
- package/src/testing/e2e/page-helpers.ts +272 -0
- package/src/testing/e2e/parity.ts +387 -0
- package/src/testing/e2e/server.ts +195 -0
- package/src/testing/flight-matchers.ts +97 -0
- package/src/testing/flight-normalize.ts +11 -0
- package/src/testing/flight-runtime.d.ts +57 -0
- package/src/testing/flight-tree.ts +682 -0
- package/src/testing/flight.entry.ts +52 -0
- package/src/testing/flight.ts +257 -0
- package/src/testing/generated-routes.ts +199 -0
- package/src/testing/index.ts +105 -0
- package/src/testing/internal/context.ts +371 -0
- package/src/testing/internal/flight-client-globals.ts +30 -0
- package/src/testing/internal/seed-vars.ts +54 -0
- package/src/testing/render-handler.ts +357 -0
- package/src/testing/render-route.tsx +584 -0
- package/src/testing/run-loader.ts +385 -0
- package/src/testing/run-middleware.ts +205 -0
- package/src/testing/run-transition-when.ts +164 -0
- package/src/testing/vitest-stubs/cloudflare-email.ts +9 -0
- package/src/testing/vitest-stubs/cloudflare-workers.ts +21 -0
- package/src/testing/vitest-stubs/plugin-rsc.ts +16 -0
- package/src/testing/vitest-stubs/version.ts +5 -0
- package/src/testing/vitest.ts +305 -0
- package/src/theme/ThemeProvider.tsx +56 -84
- package/src/theme/ThemeScript.tsx +7 -9
- package/src/theme/constants.ts +52 -13
- package/src/theme/index.ts +0 -7
- package/src/theme/theme-context.ts +1 -5
- package/src/theme/theme-script.ts +22 -21
- package/src/theme/use-theme.ts +0 -3
- package/src/types/boundaries.ts +0 -35
- package/src/types/cache-types.ts +13 -4
- package/src/types/error-types.ts +30 -90
- package/src/types/global-namespace.ts +54 -41
- package/src/types/handler-context.ts +110 -62
- package/src/types/index.ts +3 -10
- package/src/types/loader-types.ts +11 -9
- package/src/types/request-scope.ts +112 -0
- package/src/types/route-config.ts +20 -52
- package/src/types/route-entry.ts +0 -6
- package/src/types/segments.ts +135 -14
- package/src/urls/include-helper.ts +19 -64
- package/src/urls/include-provider.ts +71 -0
- package/src/urls/index.ts +2 -11
- package/src/urls/path-helper-types.ts +63 -17
- package/src/urls/path-helper.ts +22 -106
- package/src/urls/pattern-types.ts +72 -19
- package/src/urls/response-types.ts +22 -29
- package/src/urls/type-extraction.ts +98 -154
- package/src/urls/urls-function.ts +1 -19
- package/src/use-loader.tsx +292 -107
- package/src/vercel/index.ts +11 -0
- package/src/vercel/tracing.ts +88 -0
- package/src/vite/debug.ts +185 -0
- package/src/vite/discovery/bundle-postprocess.ts +8 -7
- package/src/vite/discovery/dev-prerender-cache.ts +117 -0
- package/src/vite/discovery/discover-routers.ts +127 -86
- package/src/vite/discovery/discovery-errors.ts +255 -0
- package/src/vite/discovery/gate-state.ts +171 -0
- package/src/vite/discovery/prerender-collection.ts +96 -68
- 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 +45 -1
- package/src/vite/discovery/virtual-module-codegen.ts +14 -34
- package/src/vite/index.ts +4 -0
- package/src/vite/inject-client-debug.ts +88 -0
- package/src/vite/plugin-types.ts +210 -10
- package/src/vite/plugins/cjs-to-esm.ts +16 -19
- package/src/vite/plugins/client-ref-dedup.ts +16 -11
- package/src/vite/plugins/client-ref-hashing.ts +28 -15
- 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 +194 -0
- package/src/vite/plugins/expose-action-id.ts +48 -95
- package/src/vite/plugins/expose-id-utils.ts +88 -55
- package/src/vite/plugins/expose-ids/export-analysis.ts +101 -34
- package/src/vite/plugins/expose-ids/handler-transform.ts +11 -90
- package/src/vite/plugins/expose-ids/loader-transform.ts +14 -24
- package/src/vite/plugins/expose-ids/router-transform.ts +118 -29
- package/src/vite/plugins/expose-internal-ids.ts +505 -486
- package/src/vite/plugins/performance-tracks.ts +26 -25
- package/src/vite/plugins/refresh-cmd.ts +1 -1
- package/src/vite/plugins/use-cache-transform.ts +73 -83
- package/src/vite/plugins/vercel-output.ts +384 -0
- package/src/vite/plugins/version-injector.ts +40 -29
- package/src/vite/plugins/version-plugin.ts +37 -40
- package/src/vite/plugins/virtual-entries.ts +138 -27
- package/src/vite/rango.ts +236 -138
- package/src/vite/router-discovery.ts +927 -136
- package/src/vite/utils/ast-handler-extract.ts +26 -35
- package/src/vite/utils/banner.ts +1 -1
- package/src/vite/utils/bundle-analysis.ts +10 -15
- package/src/vite/utils/client-chunks.ts +184 -0
- package/src/vite/utils/directive-prologue.ts +40 -0
- package/src/vite/utils/forward-user-plugins.ts +171 -0
- package/src/vite/utils/manifest-utils.ts +4 -59
- package/src/vite/utils/package-resolution.ts +20 -52
- package/src/vite/utils/prerender-utils.ts +71 -43
- package/src/vite/utils/shared-utils.ts +142 -43
- package/src/browser/action-response-classifier.ts +0 -99
- package/src/browser/react/use-client-cache.ts +0 -58
- package/src/browser/shallow.ts +0 -40
- package/src/handles/index.ts +0 -7
- package/src/network-error-thrower.tsx +0 -23
- package/src/router/middleware-cookies.ts +0 -55
package/src/host/types.ts
CHANGED
|
@@ -35,12 +35,24 @@ export type Middleware = (
|
|
|
35
35
|
*/
|
|
36
36
|
export type HostPattern = string | string[];
|
|
37
37
|
|
|
38
|
+
/**
|
|
39
|
+
* Whether a route entry is an inline request handler or a lazy module mount.
|
|
40
|
+
*
|
|
41
|
+
* Stored on the entry so discovery and runtime act on the consumer's declared
|
|
42
|
+
* intent instead of inferring it from the function's shape (arity/return value),
|
|
43
|
+
* which is ambiguous: a lazy loader may declare an ignored param, and an inline
|
|
44
|
+
* handler may be async. `.map()` registers `"handler"`, `.lazy()` registers
|
|
45
|
+
* `"lazy"`.
|
|
46
|
+
*/
|
|
47
|
+
export type RouteEntryKind = "handler" | "lazy";
|
|
48
|
+
|
|
38
49
|
/**
|
|
39
50
|
* Result from testing a hostname against patterns
|
|
40
51
|
*/
|
|
41
52
|
export interface HostMatchResult {
|
|
42
53
|
pattern: string;
|
|
43
54
|
handler: Handler | LazyHandler;
|
|
55
|
+
kind: RouteEntryKind;
|
|
44
56
|
}
|
|
45
57
|
|
|
46
58
|
/**
|
|
@@ -53,9 +65,24 @@ export interface HostRouteBuilder {
|
|
|
53
65
|
use(...middleware: Middleware[]): HostRouteBuilder;
|
|
54
66
|
|
|
55
67
|
/**
|
|
56
|
-
* Map to
|
|
68
|
+
* Map to an inline request handler `(request, input) => Response`.
|
|
69
|
+
*
|
|
70
|
+
* For a lazily-imported sub-app or handler module, use {@link lazy} instead -
|
|
71
|
+
* `.map(() => import(...))` is rejected (the return type is not a `Response`)
|
|
72
|
+
* and would not be discovered at build time.
|
|
73
|
+
*/
|
|
74
|
+
map(handler: Handler): HostRouter;
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* Mount a lazily-imported handler or host router:
|
|
78
|
+
* `.lazy(() => import("./sub-app"))`.
|
|
79
|
+
*
|
|
80
|
+
* The loader takes no arguments and resolves to a module whose `default`
|
|
81
|
+
* export is a request `Handler` or a nested `HostRouter`. Only `.lazy()`
|
|
82
|
+
* entries are invoked during build-time discovery to trigger the sub-app's
|
|
83
|
+
* `createRouter()` registration.
|
|
57
84
|
*/
|
|
58
|
-
|
|
85
|
+
lazy(handler: LazyHandler): HostRouter;
|
|
59
86
|
}
|
|
60
87
|
|
|
61
88
|
/**
|
|
@@ -83,9 +110,13 @@ export interface HostRouter {
|
|
|
83
110
|
fallback(): HostRouteBuilder;
|
|
84
111
|
|
|
85
112
|
/**
|
|
86
|
-
* Test which handler would match a hostname
|
|
113
|
+
* Test which handler would match a hostname (and optional pathname).
|
|
114
|
+
*
|
|
115
|
+
* `pathname` defaults to `"/"`. Pass it to probe path-prefixed patterns
|
|
116
|
+
* such as `host(["example.com/admin"])`, which only match when the request
|
|
117
|
+
* path is under the prefix.
|
|
87
118
|
*/
|
|
88
|
-
test(hostname: string): HostMatchResult | null;
|
|
119
|
+
test(hostname: string, pathname?: string): HostMatchResult | null;
|
|
89
120
|
}
|
|
90
121
|
|
|
91
122
|
/**
|
|
@@ -134,6 +165,8 @@ export interface RouteEntry {
|
|
|
134
165
|
patterns: string[];
|
|
135
166
|
middleware: Middleware[];
|
|
136
167
|
handler: Handler | LazyHandler;
|
|
168
|
+
/** Whether `handler` is an inline request handler or a lazy module mount. */
|
|
169
|
+
kind: RouteEntryKind;
|
|
137
170
|
isFallback?: boolean;
|
|
138
171
|
}
|
|
139
172
|
|
package/src/host/utils.ts
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* app: ['*', 'www.*']
|
|
16
16
|
* });
|
|
17
17
|
*
|
|
18
|
-
* router.host(hosts.admin).
|
|
18
|
+
* router.host(hosts.admin).lazy(() => import("./apps/admin")); // Type-safe!
|
|
19
19
|
* ```
|
|
20
20
|
*/
|
|
21
21
|
export function defineHosts<T extends Record<string, string | string[]>>(
|
package/src/href-client.ts
CHANGED
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
*/
|
|
16
16
|
|
|
17
17
|
import type { GetRegisteredRoutes } from "./types.js";
|
|
18
|
-
import type {
|
|
18
|
+
import type { JsonSerialize } from "./serialize.js";
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* Parse constraint values into a union type for paths
|
|
@@ -103,29 +103,75 @@ type NameForPattern<TPattern extends string, TRoutes = GetRegisteredRoutes> = {
|
|
|
103
103
|
}[keyof TRoutes];
|
|
104
104
|
|
|
105
105
|
/**
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
106
|
+
* Strip a query (`?…`) and/or hash (`#…`) suffix before matching, so a concrete
|
|
107
|
+
* URL like `/api/health?ts=1` still resolves to its route's response. Removes
|
|
108
|
+
* from the earliest of `?`/`#`: a `#` before the first `?` (the query is part of
|
|
109
|
+
* a fragment, e.g. `/health#top?x=1`) is handled, as is a `/:` that only appears
|
|
110
|
+
* inside the query (e.g. `/health?next=/:id`).
|
|
111
|
+
*/
|
|
112
|
+
type StripPathSuffix<T extends string> = T extends `${infer Base}?${string}`
|
|
113
|
+
? Base extends `${infer Frag}#${string}`
|
|
114
|
+
? Frag
|
|
115
|
+
: Base
|
|
116
|
+
: T extends `${infer Base}#${string}`
|
|
117
|
+
? Base
|
|
118
|
+
: T;
|
|
119
|
+
|
|
120
|
+
/** Extract a route entry's response payload (or `never` for RSC routes). */
|
|
121
|
+
type ResponsePayloadOf<TRoutes, K extends keyof TRoutes> = TRoutes[K] extends {
|
|
122
|
+
readonly response: infer R;
|
|
123
|
+
}
|
|
124
|
+
? Exclude<R, Response>
|
|
125
|
+
: never;
|
|
126
|
+
|
|
127
|
+
/**
|
|
128
|
+
* Look up the response payload for a route, keyed by either a route pattern
|
|
129
|
+
* (`/api/products/:id`) or a concrete path (`/api/products/123`). The same type
|
|
130
|
+
* serves a pattern lookup and a typed `fetch` wrapper that forwards a concrete
|
|
131
|
+
* `Rango.Path`:
|
|
110
132
|
*
|
|
111
|
-
*
|
|
112
|
-
* PathResponse<"/api/
|
|
133
|
+
* PathResponse<"/api/products/:id"> → Product // by pattern
|
|
134
|
+
* PathResponse<"/api/products/123"> → Product // by concrete path
|
|
113
135
|
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
136
|
+
* The query/hash suffix is stripped first; the stripped key is then treated as a
|
|
137
|
+
* pattern when it contains a `/:param` segment and matched exactly (precise even
|
|
138
|
+
* for nested dynamic routes), otherwise as a concrete path matched against each
|
|
139
|
+
* route's `PatternToPath` template. Because those holes are `${string}`
|
|
140
|
+
* (slash-greedy), a concrete path under a *nested* dynamic route can match several
|
|
141
|
+
* patterns and union their responses — pattern lookups do not have this
|
|
142
|
+
* looseness. RSC routes (no response) and unmatched keys resolve to `never`.
|
|
143
|
+
*/
|
|
144
|
+
type ResponsePayloadFor<
|
|
145
|
+
TPath extends string,
|
|
146
|
+
TRoutes = GetRegisteredRoutes,
|
|
147
|
+
> = ResponsePayloadForKey<StripPathSuffix<TPath>, TRoutes>;
|
|
148
|
+
|
|
149
|
+
type ResponsePayloadForKey<
|
|
150
|
+
TKey extends string,
|
|
151
|
+
TRoutes,
|
|
152
|
+
> = TKey extends `${string}/:${string}`
|
|
153
|
+
? {
|
|
154
|
+
[K in keyof TRoutes]: RoutePattern<TRoutes, K> extends TKey
|
|
155
|
+
? ResponsePayloadOf<TRoutes, K>
|
|
156
|
+
: never;
|
|
157
|
+
}[keyof TRoutes]
|
|
158
|
+
: {
|
|
159
|
+
[K in keyof TRoutes]: TKey extends PatternToPath<RoutePattern<TRoutes, K>>
|
|
160
|
+
? ResponsePayloadOf<TRoutes, K>
|
|
161
|
+
: never;
|
|
162
|
+
}[keyof TRoutes];
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Public response type for a route, keyed by pattern or concrete path. JSON
|
|
166
|
+
* response routes send the handler's return value verbatim (bare), so the
|
|
167
|
+
* payload is wrapped only in `JsonSerialize` to describe the JSON **wire** value
|
|
168
|
+
* a consumer receives from `fetch().then(r => r.json())` — e.g. a handler
|
|
169
|
+
* returning `{ createdAt: Date }` resolves here to `{ createdAt: string }`.
|
|
116
170
|
*/
|
|
117
171
|
export type PathResponse<
|
|
118
|
-
|
|
172
|
+
TPath extends string,
|
|
119
173
|
TRoutes = GetRegisteredRoutes,
|
|
120
|
-
> =
|
|
121
|
-
{
|
|
122
|
-
[K in keyof TRoutes]: RoutePattern<TRoutes, K> extends TPattern
|
|
123
|
-
? TRoutes[K] extends { readonly response: infer R }
|
|
124
|
-
? Exclude<R, Response>
|
|
125
|
-
: never
|
|
126
|
-
: never;
|
|
127
|
-
}[keyof TRoutes]
|
|
128
|
-
>;
|
|
174
|
+
> = JsonSerialize<ResponsePayloadFor<TPath, TRoutes>>;
|
|
129
175
|
|
|
130
176
|
/**
|
|
131
177
|
* Strip trailing slash from a path (e.g., "/blog/" -> "/blog" | "/blog/")
|
|
@@ -140,7 +186,7 @@ type OptionalTrailingSlash<T extends string> = T extends `${infer Base}/`
|
|
|
140
186
|
/**
|
|
141
187
|
* Union of all valid paths from registered routes
|
|
142
188
|
*
|
|
143
|
-
* Generated from
|
|
189
|
+
* Generated from Rango.RegisteredRoutes via module augmentation.
|
|
144
190
|
* Allows optional query strings and hash fragments.
|
|
145
191
|
*/
|
|
146
192
|
export type ValidPaths<TRoutes = GetRegisteredRoutes> =
|
|
@@ -154,6 +200,76 @@ export type ValidPaths<TRoutes = GetRegisteredRoutes> =
|
|
|
154
200
|
}[keyof TRoutes]
|
|
155
201
|
>;
|
|
156
202
|
|
|
203
|
+
// Module-scoped alias so the ambient `Rango.PathResponse` below can reference
|
|
204
|
+
// the module-level `PathResponse` without the global namespace shadowing the
|
|
205
|
+
// name when both are called `PathResponse`.
|
|
206
|
+
type GlobalPathResponse<
|
|
207
|
+
TPattern extends string,
|
|
208
|
+
TRoutes = GetRegisteredRoutes,
|
|
209
|
+
> = PathResponse<TPattern, TRoutes>;
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Ambient path types on the `Rango` namespace.
|
|
213
|
+
*
|
|
214
|
+
* These live on the same global namespace consumers already augment for
|
|
215
|
+
* `Rango.Env` / `Rango.Vars`, so they are reachable with no import wherever the
|
|
216
|
+
* router's types are in scope. They are the public, recommended surface for
|
|
217
|
+
* typing anything that wraps `href()`. `ValidPaths` / `PathResponse` stay as the
|
|
218
|
+
* internal building blocks behind them.
|
|
219
|
+
*/
|
|
220
|
+
declare global {
|
|
221
|
+
namespace Rango {
|
|
222
|
+
/**
|
|
223
|
+
* Union of every valid route path accepted by `href()`.
|
|
224
|
+
*
|
|
225
|
+
* Type a wrapper's path parameter as `Rango.Path` so it shares `href()`'s
|
|
226
|
+
* compile-time validation against the registered routes:
|
|
227
|
+
*
|
|
228
|
+
* ```ts
|
|
229
|
+
* import { href } from "@rangojs/router/client";
|
|
230
|
+
*
|
|
231
|
+
* export const appHref = (path: Rango.Path) => href(path);
|
|
232
|
+
* ```
|
|
233
|
+
*
|
|
234
|
+
* Resolves from `Rango.RegisteredRoutes` when augmented, otherwise the
|
|
235
|
+
* auto-generated `Rango.GeneratedRouteMap`, otherwise a permissive
|
|
236
|
+
* `/${string}` fallback.
|
|
237
|
+
*/
|
|
238
|
+
type Path<TRoutes = GetRegisteredRoutes> = ValidPaths<TRoutes>;
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* Response payload for a route, looked up from the global route map by
|
|
242
|
+
* either a route pattern (`/api/products/:id`) or a concrete path
|
|
243
|
+
* (`/api/products/123`). Because it accepts a concrete `Rango.Path`, it
|
|
244
|
+
* doubles as the return type of a typed `fetch` wrapper:
|
|
245
|
+
*
|
|
246
|
+
* ```ts
|
|
247
|
+
* type Product = Rango.PathResponse<"/api/products/:id">; // by pattern
|
|
248
|
+
* type Same = Rango.PathResponse<"/api/products/42">; // by concrete path
|
|
249
|
+
*
|
|
250
|
+
* const get = async <T extends Rango.Path>(
|
|
251
|
+
* path: T,
|
|
252
|
+
* ): Promise<Rango.PathResponse<T>> =>
|
|
253
|
+
* fetch(href(path)).then((r) => r.json());
|
|
254
|
+
* ```
|
|
255
|
+
*
|
|
256
|
+
* The payload is the JSON **wire** shape (via `Rango.JsonSerialize`), not the
|
|
257
|
+
* handler's raw return — a handler returning `{ createdAt: Date }` resolves
|
|
258
|
+
* here to `{ createdAt: string }` (bare, no envelope), matching what
|
|
259
|
+
* `fetch().then(r => r.json())` actually yields.
|
|
260
|
+
*
|
|
261
|
+
* Only resolves once `Rango.RegisteredRoutes` carries response metadata (the
|
|
262
|
+
* generated map has paths and search but no payloads). Pass an explicit route
|
|
263
|
+
* map as the second argument to look up against a non-global map (rarely
|
|
264
|
+
* needed in app code).
|
|
265
|
+
*/
|
|
266
|
+
type PathResponse<
|
|
267
|
+
TPath extends string,
|
|
268
|
+
TRoutes = GetRegisteredRoutes,
|
|
269
|
+
> = GlobalPathResponse<TPath, TRoutes>;
|
|
270
|
+
}
|
|
271
|
+
}
|
|
272
|
+
|
|
157
273
|
/**
|
|
158
274
|
* Type-safe href function for client-side use
|
|
159
275
|
*
|
|
@@ -182,11 +298,10 @@ export type ValidPaths<TRoutes = GetRegisteredRoutes> =
|
|
|
182
298
|
*/
|
|
183
299
|
export function href<T extends ValidPaths>(path: T, mount?: string): string {
|
|
184
300
|
if (mount && mount !== "/") {
|
|
185
|
-
// Strip trailing slash from mount to avoid double-slash when joining
|
|
186
301
|
const normalizedMount = mount.endsWith("/") ? mount.slice(0, -1) : mount;
|
|
187
302
|
return normalizedMount + path;
|
|
188
303
|
}
|
|
189
|
-
return path;
|
|
304
|
+
return path as string;
|
|
190
305
|
}
|
|
191
306
|
|
|
192
307
|
/**
|
package/src/index.rsc.ts
CHANGED
|
@@ -18,6 +18,7 @@ export {
|
|
|
18
18
|
MiddlewareError,
|
|
19
19
|
HandlerError,
|
|
20
20
|
BuildError,
|
|
21
|
+
DslContextError,
|
|
21
22
|
InvalidHandlerError,
|
|
22
23
|
RouterError,
|
|
23
24
|
Skip,
|
|
@@ -43,6 +44,7 @@ export type {
|
|
|
43
44
|
// Revalidation types
|
|
44
45
|
RevalidateParams,
|
|
45
46
|
Revalidate,
|
|
47
|
+
ActionRef,
|
|
46
48
|
RouteKeys,
|
|
47
49
|
// Loader types
|
|
48
50
|
LoaderDefinition,
|
|
@@ -63,16 +65,29 @@ export type {
|
|
|
63
65
|
ErrorPhase,
|
|
64
66
|
OnErrorContext,
|
|
65
67
|
OnErrorCallback,
|
|
68
|
+
// View transition types (also exported from the default entry; route
|
|
69
|
+
// definitions resolve to this react-server entry, so they must be here too)
|
|
70
|
+
TransitionConfig,
|
|
71
|
+
TransitionWhenFn,
|
|
72
|
+
TransitionWhenContext,
|
|
73
|
+
ViewTransitionClass,
|
|
66
74
|
} from "./types.js";
|
|
67
75
|
|
|
68
76
|
// Router options type (server-only, so import directly)
|
|
69
77
|
export type {
|
|
70
|
-
|
|
78
|
+
RangoOptions,
|
|
71
79
|
SSRStreamMode,
|
|
72
80
|
SSROptions,
|
|
73
81
|
ResolveStreamingContext,
|
|
74
82
|
} from "./router.js";
|
|
75
83
|
|
|
84
|
+
// Origin-check callback types (referenced by the RangoOptions.originCheck JSDoc)
|
|
85
|
+
export type {
|
|
86
|
+
OriginCheckConfig,
|
|
87
|
+
OriginCheckContext,
|
|
88
|
+
OriginCheckPhase,
|
|
89
|
+
} from "./rsc/origin-guard.js";
|
|
90
|
+
|
|
76
91
|
// Server-side createLoader and redirect
|
|
77
92
|
export {
|
|
78
93
|
createLoader,
|
|
@@ -88,7 +103,6 @@ export {
|
|
|
88
103
|
loading,
|
|
89
104
|
parallel,
|
|
90
105
|
intercept,
|
|
91
|
-
when,
|
|
92
106
|
errorBoundary,
|
|
93
107
|
notFoundBoundary,
|
|
94
108
|
transition,
|
|
@@ -105,6 +119,12 @@ export type {
|
|
|
105
119
|
|
|
106
120
|
// Handle API
|
|
107
121
|
export { createHandle, isHandle, type Handle } from "./handle.js";
|
|
122
|
+
export {
|
|
123
|
+
DEFAULT_DEFER_TIMEOUT_MS,
|
|
124
|
+
type DeferOptions,
|
|
125
|
+
type HandlePush,
|
|
126
|
+
type HandlePushFn,
|
|
127
|
+
} from "./defer.js";
|
|
108
128
|
|
|
109
129
|
// Context variable API (typed ctx.set/ctx.get tokens)
|
|
110
130
|
export { createVar, type ContextVar } from "./context-var.js";
|
|
@@ -122,22 +142,27 @@ export {
|
|
|
122
142
|
type BuildContext,
|
|
123
143
|
type StaticBuildContext,
|
|
124
144
|
type GetParamsContext,
|
|
145
|
+
type PrerenderPassthroughResult,
|
|
125
146
|
} from "./prerender.js";
|
|
126
147
|
|
|
127
148
|
// Static handler API
|
|
128
|
-
export {
|
|
149
|
+
export {
|
|
150
|
+
Static,
|
|
151
|
+
type StaticHandlerDefinition,
|
|
152
|
+
type StaticHandlerOptions,
|
|
153
|
+
} from "./static-handler.js";
|
|
129
154
|
|
|
130
155
|
// Django-style URL patterns (RSC/server context)
|
|
131
156
|
export {
|
|
132
157
|
urls,
|
|
133
158
|
type PathHelpers,
|
|
134
159
|
type PathOptions,
|
|
160
|
+
type PartialPrerenderProps,
|
|
135
161
|
type UrlPatterns,
|
|
136
162
|
type IncludeOptions,
|
|
137
163
|
type IncludeItem,
|
|
138
164
|
type RouteResponse,
|
|
139
|
-
type
|
|
140
|
-
type ResponseEnvelope,
|
|
165
|
+
type ProblemDetails,
|
|
141
166
|
type ResponseHandler,
|
|
142
167
|
type ResponseHandlerContext,
|
|
143
168
|
type JsonResponseHandler,
|
|
@@ -151,7 +176,7 @@ export {
|
|
|
151
176
|
// Core router (server-side)
|
|
152
177
|
export {
|
|
153
178
|
createRouter,
|
|
154
|
-
type
|
|
179
|
+
type Rango,
|
|
155
180
|
type RootLayoutProps,
|
|
156
181
|
type RouterRequestInput,
|
|
157
182
|
} from "./router.js";
|
|
@@ -161,6 +186,11 @@ export type { HandlerCacheConfig } from "./rsc/types.js";
|
|
|
161
186
|
|
|
162
187
|
// Built-in handles (server-side)
|
|
163
188
|
export { Meta } from "./handles/meta.js";
|
|
189
|
+
export {
|
|
190
|
+
Script,
|
|
191
|
+
type ScriptConfig,
|
|
192
|
+
type ScriptAttributes,
|
|
193
|
+
} from "./handles/script.js";
|
|
164
194
|
export { Breadcrumbs, type BreadcrumbItem } from "./handles/breadcrumbs.js";
|
|
165
195
|
|
|
166
196
|
// Request context (for accessing request data in server actions/components).
|
|
@@ -172,6 +202,9 @@ export type { PublicRequestContext as RequestContext } from "./server/request-co
|
|
|
172
202
|
import type { PublicRequestContext } from "./server/request-context.js";
|
|
173
203
|
import type { DefaultEnv } from "./types/global-namespace.js";
|
|
174
204
|
|
|
205
|
+
// Shared base for every user-facing request context (mirrors index.ts).
|
|
206
|
+
export type { RequestScope, ExecutionContext } from "./types/request-scope.js";
|
|
207
|
+
|
|
175
208
|
export const getRequestContext: <
|
|
176
209
|
TEnv = DefaultEnv,
|
|
177
210
|
>() => PublicRequestContext<TEnv> = _getRequestContextInternal;
|
|
@@ -180,16 +213,31 @@ export const getRequestContext: <
|
|
|
180
213
|
export {
|
|
181
214
|
cookies,
|
|
182
215
|
headers,
|
|
216
|
+
invalidateClientCache,
|
|
217
|
+
keepClientCache,
|
|
183
218
|
type CookieStore,
|
|
184
219
|
type Cookie,
|
|
185
220
|
type ReadonlyHeaders,
|
|
186
221
|
} from "./server/cookie-store.js";
|
|
187
222
|
|
|
223
|
+
// Cache tag APIs (server-only)
|
|
224
|
+
// cacheTag: tag the current "use cache" entry at runtime.
|
|
225
|
+
// updateTag: read-your-own-writes invalidation (awaitable, for Server Actions).
|
|
226
|
+
// revalidateTag: background hard-purge invalidation (not awaited, for route handlers / webhooks).
|
|
227
|
+
export { cacheTag } from "./cache/cache-tag.js";
|
|
228
|
+
export { updateTag, revalidateTag } from "./cache/tag-invalidation.js";
|
|
229
|
+
|
|
188
230
|
// Meta types
|
|
189
231
|
export type { MetaDescriptor, MetaDescriptorBase } from "./router/types.js";
|
|
190
232
|
|
|
191
233
|
// Middleware context types
|
|
192
|
-
export type {
|
|
234
|
+
export type {
|
|
235
|
+
MiddlewareContext,
|
|
236
|
+
CookieOptions,
|
|
237
|
+
// The function type of a middleware. Public so the documented "extract the
|
|
238
|
+
// middleware and unit-test it with runMiddleware" pattern has a nameable type.
|
|
239
|
+
MiddlewareFn,
|
|
240
|
+
} from "./router/middleware.js";
|
|
193
241
|
|
|
194
242
|
// Reverse type utilities for type-safe URL generation (Django-style URL reversal)
|
|
195
243
|
export type {
|
|
@@ -217,14 +265,51 @@ export {
|
|
|
217
265
|
type LocationStateOptions,
|
|
218
266
|
} from "./browser/react/location-state-shared.js";
|
|
219
267
|
|
|
220
|
-
// Path
|
|
221
|
-
|
|
268
|
+
// Path and response types are ambient on the `Rango` namespace (`Rango.Path`,
|
|
269
|
+
// `Rango.PathResponse`, declared in href-client.ts) — no import needed.
|
|
222
270
|
|
|
223
|
-
// Telemetry sink
|
|
271
|
+
// Telemetry sink (event-shaped facts)
|
|
224
272
|
export { createConsoleSink } from "./router/telemetry.js";
|
|
225
273
|
export { createOTelSink } from "./router/telemetry-otel.js";
|
|
226
|
-
|
|
227
|
-
export
|
|
274
|
+
// OTel phase-span adapter for the `tracing` slot (the canonical span layer).
|
|
275
|
+
export { createOTelTracing } from "./router/telemetry-otel.js";
|
|
276
|
+
export type {
|
|
277
|
+
OTelTracer,
|
|
278
|
+
OTelActiveSpanTracer,
|
|
279
|
+
OTelSpan,
|
|
280
|
+
OTelTracingOptions,
|
|
281
|
+
} from "./router/telemetry-otel.js";
|
|
282
|
+
// The full TelemetryEvent union PLUS its member types, so a consumer writing a
|
|
283
|
+
// TelemetrySink can annotate a per-`type` handler (or construct an event literal
|
|
284
|
+
// in a test) instead of only narrowing the opaque union.
|
|
285
|
+
export type {
|
|
286
|
+
TelemetrySink,
|
|
287
|
+
TelemetryEvent,
|
|
288
|
+
RequestStartEvent,
|
|
289
|
+
RequestEndEvent,
|
|
290
|
+
RequestErrorEvent,
|
|
291
|
+
LoaderStartEvent,
|
|
292
|
+
LoaderEndEvent,
|
|
293
|
+
LoaderErrorEvent,
|
|
294
|
+
HandlerErrorEvent,
|
|
295
|
+
CacheSegmentStatus,
|
|
296
|
+
CacheSegmentSignal,
|
|
297
|
+
CacheDecisionEvent,
|
|
298
|
+
RevalidationDecisionEvent,
|
|
299
|
+
RequestTimeoutEvent,
|
|
300
|
+
OriginCheckRejectedEvent,
|
|
301
|
+
} from "./router/telemetry.js";
|
|
302
|
+
|
|
303
|
+
// Span tracing config types a consumer annotates. SpanRunner/TraceSpan are the
|
|
304
|
+
// internal runner contract (consumers go through createOTelTracing /
|
|
305
|
+
// createCloudflareTracing, which return a ready RouterTracingConfig) and are not
|
|
306
|
+
// exported.
|
|
307
|
+
export type {
|
|
308
|
+
RouterTracingConfig,
|
|
309
|
+
TracePhase,
|
|
310
|
+
TracePhaseToggles,
|
|
311
|
+
TracingToggleOptions,
|
|
312
|
+
} from "./router/tracing.js";
|
|
228
313
|
|
|
229
314
|
// Timeout types and error class
|
|
230
315
|
export { RouterTimeoutError } from "./router/timeout.js";
|
package/src/index.ts
CHANGED
|
@@ -18,6 +18,7 @@ export {
|
|
|
18
18
|
MiddlewareError,
|
|
19
19
|
HandlerError,
|
|
20
20
|
BuildError,
|
|
21
|
+
DslContextError,
|
|
21
22
|
InvalidHandlerError,
|
|
22
23
|
RouterError,
|
|
23
24
|
Skip,
|
|
@@ -43,6 +44,7 @@ export type {
|
|
|
43
44
|
// Revalidation types
|
|
44
45
|
RevalidateParams,
|
|
45
46
|
Revalidate,
|
|
47
|
+
ActionRef,
|
|
46
48
|
RouteKeys,
|
|
47
49
|
// Loader types
|
|
48
50
|
LoaderDefinition,
|
|
@@ -80,7 +82,12 @@ export { createLoader } from "./loader.js";
|
|
|
80
82
|
|
|
81
83
|
// Route definition types (safe to import anywhere)
|
|
82
84
|
export type { RouteHelpers, RouteHandlers } from "./route-definition.js";
|
|
83
|
-
export type {
|
|
85
|
+
export type {
|
|
86
|
+
TransitionConfig,
|
|
87
|
+
TransitionWhenFn,
|
|
88
|
+
TransitionWhenContext,
|
|
89
|
+
ViewTransitionClass,
|
|
90
|
+
} from "./types.js";
|
|
84
91
|
|
|
85
92
|
// Composition types for reusable callback factories
|
|
86
93
|
export type {
|
|
@@ -102,8 +109,8 @@ export type {
|
|
|
102
109
|
JsonResponsePathFn,
|
|
103
110
|
TextResponsePathFn,
|
|
104
111
|
RouteResponse,
|
|
105
|
-
|
|
106
|
-
|
|
112
|
+
ProblemDetails,
|
|
113
|
+
PartialPrerenderProps,
|
|
107
114
|
} from "./urls.js";
|
|
108
115
|
|
|
109
116
|
// Middleware context types
|
|
@@ -139,6 +146,12 @@ export function redirect(): never {
|
|
|
139
146
|
|
|
140
147
|
// Handle API (universal - works on both server and client)
|
|
141
148
|
export { createHandle, isHandle, type Handle } from "./handle.js";
|
|
149
|
+
export {
|
|
150
|
+
DEFAULT_DEFER_TIMEOUT_MS,
|
|
151
|
+
type DeferOptions,
|
|
152
|
+
type HandlePush,
|
|
153
|
+
type HandlePushFn,
|
|
154
|
+
} from "./defer.js";
|
|
142
155
|
|
|
143
156
|
// Context variable API (typed ctx.set/ctx.get tokens)
|
|
144
157
|
export { createVar, type ContextVar } from "./context-var.js";
|
|
@@ -216,6 +229,17 @@ export function headers(): never {
|
|
|
216
229
|
throw serverOnlyStubError("headers");
|
|
217
230
|
}
|
|
218
231
|
|
|
232
|
+
/**
|
|
233
|
+
* Client implementation of `invalidateClientCache()`. Unlike the server-only
|
|
234
|
+
* stubs above this is a REAL function under the `default` condition (it marks
|
|
235
|
+
* the client's caches stale); the `react-server` condition (index.rsc.ts)
|
|
236
|
+
* selects the server implementation that writes a rotated `Set-Cookie`.
|
|
237
|
+
*/
|
|
238
|
+
export {
|
|
239
|
+
invalidateClientCache,
|
|
240
|
+
keepClientCache,
|
|
241
|
+
} from "./browser/invalidate-client-cache.js";
|
|
242
|
+
|
|
219
243
|
/**
|
|
220
244
|
* Error-throwing stub for server-only `createReverse` function.
|
|
221
245
|
*/
|
|
@@ -236,6 +260,18 @@ export function middleware(): never {
|
|
|
236
260
|
export function revalidate(): never {
|
|
237
261
|
throw serverOnlyStubError("revalidate");
|
|
238
262
|
}
|
|
263
|
+
// Cache tag APIs are server-only (real implementations in index.rsc.ts). These
|
|
264
|
+
// stubs keep the named-export shape identical under the default/non-react-server
|
|
265
|
+
// condition so SSR/client/default bundles that encounter the import link cleanly.
|
|
266
|
+
export function cacheTag(): never {
|
|
267
|
+
throw serverOnlyStubError("cacheTag");
|
|
268
|
+
}
|
|
269
|
+
export function updateTag(): never {
|
|
270
|
+
throw serverOnlyStubError("updateTag");
|
|
271
|
+
}
|
|
272
|
+
export function revalidateTag(): never {
|
|
273
|
+
throw serverOnlyStubError("revalidateTag");
|
|
274
|
+
}
|
|
239
275
|
export function loader(): never {
|
|
240
276
|
throw serverOnlyStubError("loader");
|
|
241
277
|
}
|
|
@@ -248,9 +284,6 @@ export function parallel(): never {
|
|
|
248
284
|
export function intercept(): never {
|
|
249
285
|
throw serverOnlyStubError("intercept");
|
|
250
286
|
}
|
|
251
|
-
export function when(): never {
|
|
252
|
-
throw serverOnlyStubError("when");
|
|
253
|
-
}
|
|
254
287
|
export function errorBoundary(): never {
|
|
255
288
|
throw serverOnlyStubError("errorBoundary");
|
|
256
289
|
}
|
|
@@ -264,6 +297,9 @@ export function transition(): never {
|
|
|
264
297
|
// Request context type (safe for client)
|
|
265
298
|
export type { PublicRequestContext as RequestContext } from "./server/request-context.js";
|
|
266
299
|
|
|
300
|
+
// Shared base for every user-facing request context.
|
|
301
|
+
export type { RequestScope, ExecutionContext } from "./types/request-scope.js";
|
|
302
|
+
|
|
267
303
|
// Cookie store types (safe for client)
|
|
268
304
|
export type {
|
|
269
305
|
CookieStore,
|
|
@@ -273,6 +309,11 @@ export type {
|
|
|
273
309
|
|
|
274
310
|
// Built-in handles (universal — work on both server and client)
|
|
275
311
|
export { Meta } from "./handles/meta.js";
|
|
312
|
+
export {
|
|
313
|
+
Script,
|
|
314
|
+
type ScriptConfig,
|
|
315
|
+
type ScriptAttributes,
|
|
316
|
+
} from "./handles/script.js";
|
|
276
317
|
export { Breadcrumbs } from "./handles/breadcrumbs.js";
|
|
277
318
|
|
|
278
319
|
// Meta types
|
|
@@ -299,14 +340,57 @@ export {
|
|
|
299
340
|
type LocationStateOptions,
|
|
300
341
|
} from "./browser/react/location-state-shared.js";
|
|
301
342
|
|
|
302
|
-
// Path
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
// Telemetry
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
343
|
+
// Path and response types are ambient on the `Rango` namespace (`Rango.Path`,
|
|
344
|
+
// `Rango.PathResponse`, declared in href-client.ts) — no import needed.
|
|
345
|
+
|
|
346
|
+
// Telemetry types only — the createConsoleSink / createOTelSink /
|
|
347
|
+
// createOTelTracing VALUES are server-only and live in index.rsc.ts (the
|
|
348
|
+
// `react-server` condition of the bare `@rangojs/router` import). Re-exporting
|
|
349
|
+
// them as values from this (default/client) entry would pull telemetry.ts and
|
|
350
|
+
// telemetry-otel.ts into the client module graph; both tree-shake to zero bytes
|
|
351
|
+
// but still appear in bundle analysis output and slow build-time module
|
|
352
|
+
// resolution. The factory values are NOT re-exported from `@rangojs/router/server`
|
|
353
|
+
// either — that subpath is internal, not user-facing (see server.ts header).
|
|
354
|
+
// Non-RSC server code imports these TYPES from the root and obtains the factory
|
|
355
|
+
// VALUES from its own router definition module, which resolves to index.rsc.ts
|
|
356
|
+
// under the `react-server` condition.
|
|
357
|
+
export type {
|
|
358
|
+
OTelTracer,
|
|
359
|
+
OTelActiveSpanTracer,
|
|
360
|
+
OTelSpan,
|
|
361
|
+
OTelTracingOptions,
|
|
362
|
+
} from "./router/telemetry-otel.js";
|
|
363
|
+
// The full TelemetryEvent union PLUS its member types, so a consumer writing a
|
|
364
|
+
// TelemetrySink can annotate a per-`type` handler (or construct an event literal
|
|
365
|
+
// in a test) instead of only narrowing the opaque union.
|
|
366
|
+
export type {
|
|
367
|
+
TelemetrySink,
|
|
368
|
+
TelemetryEvent,
|
|
369
|
+
RequestStartEvent,
|
|
370
|
+
RequestEndEvent,
|
|
371
|
+
RequestErrorEvent,
|
|
372
|
+
LoaderStartEvent,
|
|
373
|
+
LoaderEndEvent,
|
|
374
|
+
LoaderErrorEvent,
|
|
375
|
+
HandlerErrorEvent,
|
|
376
|
+
CacheSegmentStatus,
|
|
377
|
+
CacheSegmentSignal,
|
|
378
|
+
CacheDecisionEvent,
|
|
379
|
+
RevalidationDecisionEvent,
|
|
380
|
+
RequestTimeoutEvent,
|
|
381
|
+
OriginCheckRejectedEvent,
|
|
382
|
+
} from "./router/telemetry.js";
|
|
383
|
+
|
|
384
|
+
// Span tracing config types a consumer annotates. SpanRunner/TraceSpan are the
|
|
385
|
+
// internal runner contract (consumers go through createOTelTracing /
|
|
386
|
+
// createCloudflareTracing, which return a ready RouterTracingConfig) and are not
|
|
387
|
+
// exported.
|
|
388
|
+
export type {
|
|
389
|
+
RouterTracingConfig,
|
|
390
|
+
TracePhase,
|
|
391
|
+
TracePhaseToggles,
|
|
392
|
+
TracingToggleOptions,
|
|
393
|
+
} from "./router/tracing.js";
|
|
310
394
|
|
|
311
395
|
// Timeout types and error class
|
|
312
396
|
export { RouterTimeoutError } from "./router/timeout.js";
|