UNPKG

34.3 kBJavaScriptView Raw
1/**
2 * react-router v8.3.0
3 *
4 * Copyright (c) Remix Software Inc.
5 *
6 * This source code is licensed under the MIT license found in the
7 * LICENSE.md file in the root directory of this source tree.
8 *
9 * @license MIT
10 */
11import { ABSOLUTE_URL_REGEX, PROTOCOL_RELATIVE_URL_REGEX, normalizeProtocolRelativeUrl } from "./url.js";
12import { invariant, parsePath, warning } from "./history.js";
13import * as React$1 from "react";
14//#region lib/router/utils.ts
15/**
16* Creates a type-safe {@link RouterContext} object that can be used to
17* store and retrieve arbitrary values in [`action`](../../start/framework/route-module#action)s,
18* [`loader`](../../start/framework/route-module#loader)s, and [middleware](../../how-to/middleware).
19* Similar to React's [`createContext`](https://react.dev/reference/react/createContext),
20* but specifically designed for React Router's request/response lifecycle.
21*
22* If a `defaultValue` is provided, it will be returned from `context.get()`
23* when no value has been set for the context. Otherwise, reading this context
24* when no value has been set will throw an error.
25*
26* ```tsx filename=app/context.ts
27* import { createContext } from "react-router";
28*
29* // Create a context for user data
30* export const userContext =
31* createContext<User | null>(null);
32* ```
33*
34* ```tsx filename=app/middleware/auth.ts
35* import { getUserFromSession } from "~/auth.server";
36* import { userContext } from "~/context";
37*
38* export const authMiddleware = async ({
39* context,
40* request,
41* }) => {
42* const user = await getUserFromSession(request);
43* context.set(userContext, user);
44* };
45* ```
46*
47* ```tsx filename=app/routes/profile.tsx
48* import { userContext } from "~/context";
49*
50* export async function loader({
51* context,
52* }: Route.LoaderArgs) {
53* const user = context.get(userContext);
54*
55* if (!user) {
56* throw new Response("Unauthorized", { status: 401 });
57* }
58*
59* return { user };
60* }
61* ```
62*
63* @public
64* @category Utils
65* @mode framework
66* @mode data
67* @param defaultValue An optional default value for the context. This value
68* will be returned if no value has been set for this context.
69* @returns A {@link RouterContext} object that can be used with
70* `context.get()` and `context.set()` in [`action`](../../start/framework/route-module#action)s,
71* [`loader`](../../start/framework/route-module#loader)s, and [middleware](../../how-to/middleware).
72*/
73function createContext(defaultValue) {
74 return { defaultValue };
75}
76/**
77* Provides methods for writing/reading values in application context in a
78* type-safe way. Primarily for usage with [middleware](../../how-to/middleware).
79*
80* @example
81* import {
82* createContext,
83* RouterContextProvider
84* } from "react-router";
85*
86* const userContext = createContext<User | null>(null);
87* const contextProvider = new RouterContextProvider();
88* contextProvider.set(userContext, getUser());
89* // ^ Type-safe
90* const user = contextProvider.get(userContext);
91* // ^ User
92*
93* @public
94* @category Utils
95* @mode framework
96* @mode data
97*/
98var RouterContextProvider = class {
99 #map = /* @__PURE__ */ new Map();
100 /**
101 * Create a new `RouterContextProvider` instance
102 * @param init An optional initial context map to populate the provider with
103 */
104 constructor(init) {
105 if (init) for (let [context, value] of init) this.set(context, value);
106 }
107 /**
108 * Access a value from the context. If no value has been set for the context,
109 * it will return the context's `defaultValue` if provided, or throw an error
110 * if no `defaultValue` was set.
111 * @param context The context to get the value for
112 * @returns The value for the context, or the context's `defaultValue` if no
113 * value was set
114 */
115 get(context) {
116 if (this.#map.has(context)) return this.#map.get(context);
117 if (context.defaultValue !== void 0) return context.defaultValue;
118 throw new Error("No value found for context");
119 }
120 /**
121 * Set a value for the context. If the context already has a value set, this
122 * will overwrite it.
123 *
124 * @param context The context to set the value for
125 * @param value The value to set for the context
126 * @returns {void}
127 */
128 set(context, value) {
129 this.#map.set(context, value);
130 }
131};
132const unsupportedLazyRouteObjectKeys = new Set([
133 "lazy",
134 "caseSensitive",
135 "path",
136 "id",
137 "index",
138 "children"
139]);
140function isUnsupportedLazyRouteObjectKey(key) {
141 return unsupportedLazyRouteObjectKeys.has(key);
142}
143const unsupportedLazyRouteFunctionKeys = new Set([
144 "lazy",
145 "caseSensitive",
146 "path",
147 "id",
148 "index",
149 "middleware",
150 "children"
151]);
152function isUnsupportedLazyRouteFunctionKey(key) {
153 return unsupportedLazyRouteFunctionKeys.has(key);
154}
155function isIndexRoute(route) {
156 return route.index === true;
157}
158function defaultMapRouteProperties(route) {
159 let updates = {};
160 if (route.Component) {
161 if (route.element) warning(false, "You should not include both `Component` and `element` on your route - `Component` will be used.");
162 Object.assign(updates, {
163 element: React$1.createElement(route.Component),
164 Component: void 0
165 });
166 }
167 if (route.HydrateFallback) {
168 if (route.hydrateFallbackElement) warning(false, "You should not include both `HydrateFallback` and `hydrateFallbackElement` on your route - `HydrateFallback` will be used.");
169 Object.assign(updates, {
170 hydrateFallbackElement: React$1.createElement(route.HydrateFallback),
171 HydrateFallback: void 0
172 });
173 }
174 if (route.ErrorBoundary) {
175 if (route.errorElement) warning(false, "You should not include both `ErrorBoundary` and `errorElement` on your route - `ErrorBoundary` will be used.");
176 Object.assign(updates, {
177 errorElement: React$1.createElement(route.ErrorBoundary),
178 ErrorBoundary: void 0
179 });
180 }
181 return updates;
182}
183function convertRoutesToDataRoutes(routes, mapRouteProperties = defaultMapRouteProperties, parentPath = [], manifest = {}, allowInPlaceMutations = false) {
184 return routes.map((route, index) => {
185 let treePath = [...parentPath, String(index)];
186 let id = typeof route.id === "string" ? route.id : treePath.join("-");
187 invariant(route.index !== true || !route.children, `Cannot specify children on an index route`);
188 invariant(allowInPlaceMutations || !manifest[id], `Found a route id collision on id "${id}". Route id's must be globally unique within Data Router usages`);
189 if (isIndexRoute(route)) {
190 let indexRoute = {
191 ...route,
192 id
193 };
194 manifest[id] = mergeRouteUpdates(indexRoute, mapRouteProperties(indexRoute));
195 return indexRoute;
196 } else {
197 let pathOrLayoutRoute = {
198 ...route,
199 id,
200 children: void 0
201 };
202 manifest[id] = mergeRouteUpdates(pathOrLayoutRoute, mapRouteProperties(pathOrLayoutRoute));
203 if (route.children) pathOrLayoutRoute.children = convertRoutesToDataRoutes(route.children, mapRouteProperties, treePath, manifest, allowInPlaceMutations);
204 return pathOrLayoutRoute;
205 }
206 });
207}
208function mergeRouteUpdates(route, updates) {
209 return Object.assign(route, {
210 ...updates,
211 ...typeof updates.lazy === "object" && updates.lazy != null ? { lazy: {
212 ...route.lazy,
213 ...updates.lazy
214 } } : {}
215 });
216}
217/**
218* Matches the given routes to a location and returns the match data.
219*
220* @example
221* import { matchRoutes } from "react-router";
222*
223* let routes = [{
224* path: "/",
225* Component: Root,
226* children: [{
227* path: "dashboard",
228* Component: Dashboard,
229* }]
230* }];
231*
232* matchRoutes(routes, "/dashboard"); // [rootMatch, dashboardMatch]
233*
234* @public
235* @category Utils
236* @param routes The array of route objects to match against.
237* @param locationArg The location to match against, either a string path or a
238* partial {@link Location} object
239* @param basename Optional base path to strip from the location before matching.
240* Defaults to `/`.
241* @returns An array of matched routes, or `null` if no matches were found.
242*/
243function matchRoutes(routes, locationArg, basename = "/") {
244 return matchRoutesImpl(routes, locationArg, basename, false);
245}
246function matchRoutesImpl(routes, locationArg, basename, allowPartial, precomputedBranches) {
247 let pathname = stripBasename((typeof locationArg === "string" ? parsePath(locationArg) : locationArg).pathname || "/", basename);
248 if (pathname == null) return null;
249 let branches = precomputedBranches ?? flattenAndRankRoutes(routes);
250 let matches = null;
251 let decoded = decodePath(pathname);
252 for (let i = 0; matches == null && i < branches.length; ++i) matches = matchRouteBranch(branches[i], decoded, allowPartial);
253 return matches;
254}
255function convertRouteMatchToUiMatch(match, loaderData) {
256 let { route, pathname, params } = match;
257 return {
258 id: route.id,
259 pathname,
260 params,
261 loaderData: loaderData[route.id],
262 handle: route.handle
263 };
264}
265function flattenAndRankRoutes(routes) {
266 let branches = flattenRoutes(routes);
267 rankRouteBranches(branches);
268 return branches;
269}
270function flattenRoutes(routes, branches = [], parentsMeta = [], parentPath = "", _hasParentOptionalSegments = false) {
271 let flattenRoute = (route, index, hasParentOptionalSegments = _hasParentOptionalSegments, relativePath) => {
272 let meta = {
273 relativePath: relativePath === void 0 ? route.path || "" : relativePath,
274 caseSensitive: route.caseSensitive === true,
275 childrenIndex: index,
276 route
277 };
278 if (meta.relativePath.startsWith("/")) {
279 if (!meta.relativePath.startsWith(parentPath) && hasParentOptionalSegments) return;
280 invariant(meta.relativePath.startsWith(parentPath), `Absolute route path "${meta.relativePath}" nested under path "${parentPath}" is not valid. An absolute child route path must start with the combined path of all its parent routes.`);
281 meta.relativePath = meta.relativePath.slice(parentPath.length);
282 }
283 let path = joinPaths([parentPath, meta.relativePath]);
284 let routesMeta = parentsMeta.concat(meta);
285 if (route.children && route.children.length > 0) {
286 invariant(route.index !== true, `Index routes must not have child routes. Please remove all child routes from route path "${path}".`);
287 flattenRoutes(route.children, branches, routesMeta, path, hasParentOptionalSegments);
288 }
289 if (route.path == null && !route.index) return;
290 branches.push({
291 path,
292 score: computeScore(path, route.index),
293 routesMeta: routesMeta.map((meta, i) => {
294 let [matcher, params] = compilePath(meta.relativePath, meta.caseSensitive, i === routesMeta.length - 1);
295 return {
296 ...meta,
297 matcher,
298 compiledParams: params
299 };
300 })
301 });
302 };
303 routes.forEach((route, index) => {
304 if (route.path === "" || !route.path?.includes("?")) flattenRoute(route, index);
305 else for (let exploded of explodeOptionalSegments(route.path)) flattenRoute(route, index, true, exploded);
306 });
307 return branches;
308}
309function explodeOptionalSegments(path) {
310 let segments = path.split("/");
311 if (segments.length === 0) return [];
312 let [first, ...rest] = segments;
313 let isOptional = first.endsWith("?");
314 let required = first.replace(/\?$/, "");
315 if (rest.length === 0) return isOptional ? [required, ""] : [required];
316 let restExploded = explodeOptionalSegments(rest.join("/"));
317 let result = [];
318 result.push(...restExploded.map((subpath) => subpath === "" ? required : [required, subpath].join("/")));
319 if (isOptional) result.push(...restExploded);
320 return result.map((exploded) => path.startsWith("/") && exploded === "" ? "/" : exploded);
321}
322function rankRouteBranches(branches) {
323 branches.sort((a, b) => a.score !== b.score ? b.score - a.score : compareIndexes(a.routesMeta.map((meta) => meta.childrenIndex), b.routesMeta.map((meta) => meta.childrenIndex)));
324}
325const paramRe = /^:[\w-]+$/;
326const partialParamRe = /^:[\w-]+/;
327const partialDynamicSegmentValue = 3.5;
328const dynamicSegmentValue = 3;
329const indexRouteValue = 2;
330const emptySegmentValue = 1;
331const staticSegmentValue = 10;
332const splatPenalty = -2;
333const isSplat = (s) => s === "*";
334function computeScore(path, index) {
335 let segments = path.split("/");
336 let initialScore = segments.length;
337 if (segments.some(isSplat)) initialScore += splatPenalty;
338 if (index) initialScore += indexRouteValue;
339 return segments.filter((s) => !isSplat(s)).reduce((score, segment) => score + (paramRe.test(segment) ? dynamicSegmentValue : partialParamRe.test(segment) ? partialDynamicSegmentValue : segment === "" ? emptySegmentValue : staticSegmentValue), initialScore);
340}
341function compareIndexes(a, b) {
342 return a.length === b.length && a.slice(0, -1).every((n, i) => n === b[i]) ? a[a.length - 1] - b[b.length - 1] : 0;
343}
344function matchRouteBranch(branch, pathname, allowPartial = false) {
345 let { routesMeta } = branch;
346 let matchedParams = {};
347 let matchedPathname = "/";
348 let matches = [];
349 for (let i = 0; i < routesMeta.length; ++i) {
350 let meta = routesMeta[i];
351 let end = i === routesMeta.length - 1;
352 let remainingPathname = matchedPathname === "/" ? pathname : pathname.slice(matchedPathname.length) || "/";
353 let pattern = {
354 path: meta.relativePath,
355 caseSensitive: meta.caseSensitive,
356 end
357 };
358 let match = meta.matcher && meta.compiledParams ? matchPathImpl(pattern, remainingPathname, meta.matcher, meta.compiledParams) : matchPath(pattern, remainingPathname);
359 let route = meta.route;
360 if (!match && end && allowPartial && !routesMeta[routesMeta.length - 1].route.index) match = matchPath({
361 path: meta.relativePath,
362 caseSensitive: meta.caseSensitive,
363 end: false
364 }, remainingPathname);
365 if (!match) return null;
366 Object.assign(matchedParams, match.params);
367 matches.push({
368 params: matchedParams,
369 pathname: joinPaths([matchedPathname, match.pathname]),
370 pathnameBase: normalizePathname(joinPaths([matchedPathname, match.pathnameBase])),
371 route
372 });
373 if (match.pathnameBase !== "/") matchedPathname = joinPaths([matchedPathname, match.pathnameBase]);
374 }
375 return matches;
376}
377/**
378* Characters that `encodeURIComponent` escapes but that are valid literally in
379* a URL path segment. Per RFC 3986 §3.3, a path segment is made of `pchar`:
380*
381* ```
382* pchar = unreserved / pct-encoded / sub-delims / ":" / "@"
383* sub-delims = "!" / "$" / "&" / "'" / "(" / ")" / "*" / "+" / "," / ";" / "="
384* ```
385*
386* `encodeURIComponent` targets query-string values, where `$ & + , ; = : @`
387* are delimiters and must be escaped — but in a path segment they carry no
388* special meaning, and browsers keep them literal in `location.pathname`.
389* (`! ' ( ) *` and the unreserved set are already left alone by
390* `encodeURIComponent`, so they need no restoring.)
391*/
392const PATH_PARAM_OVERESCAPED = {
393 "%24": "$",
394 "%26": "&",
395 "%2B": "+",
396 "%2C": ",",
397 "%3A": ":",
398 "%3B": ";",
399 "%3D": "=",
400 "%40": "@"
401};
402/**
403* Encodes a param value for interpolation into a single URL path segment.
404*
405* Escapes characters that would break the path (`/ ? # %`, whitespace,
406* non-ASCII, …) while leaving characters that RFC 3986 permits literally in a
407* path segment untouched. Escaping those would needlessly rewrite URLs — e.g.
408* a semver build param `1.0.0+1` would become `1.0.0%2B1` even though browsers
409* display and match the `+` literally in `location.pathname`.
410*
411* See [RFC 3986 §3.3](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3))
412*
413* @param value The param value to encode.
414* @returns The encoded value, safe for use as a single path segment.
415*/
416function encodePathParam(value) {
417 return encodeURIComponent(value).replace(/%(?:24|26|2B|2C|3A|3B|3D|40)/g, (match) => PATH_PARAM_OVERESCAPED[match]);
418}
419/**
420* Returns a path with params interpolated.
421*
422* Param values are percent-encoded for use in a path segment: characters that
423* would change the URL structure (`/`, `?`, `#`, `%`, whitespace, non-ASCII)
424* are escaped, while characters that RFC 3986 allows literally in a path
425* segment (`$ & + , ; = : @`) are kept as-is. Note this differs from query-string
426* encoding (`encodeURIComponent`/`URLSearchParams`), where those characters are
427* delimiters and must be escaped. Splat (`*`) values are encoded per segment,
428* preserving `/` separators.
429*
430* See [RFC 3986 §3.3](https://datatracker.ietf.org/doc/html/rfc3986#section-3.3)
431*
432* @example
433* import { generatePath } from "react-router";
434*
435* generatePath("/users/:id", { id: "123" }); // "/users/123"
436* generatePath("/files/:name", { name: "a b" }); // "/files/a%20b"
437* generatePath("/releases/:v", { v: "1.0.0+1" }); // "/releases/1.0.0+1"
438*
439* @public
440* @category Utils
441* @param originalPath The original path to generate.
442* @param params The parameters to interpolate into the path.
443* @returns The generated path with parameters interpolated.
444*/
445function generatePath(originalPath, params = {}) {
446 let path = originalPath;
447 if (path.endsWith("*") && path !== "*" && !path.endsWith("/*")) {
448 warning(false, `Route path "${path}" will be treated as if it were "${path.replace(/\*$/, "/*")}" because the \`*\` character must always follow a \`/\` in the pattern. To get rid of this warning, please change the route path to "${path.replace(/\*$/, "/*")}".`);
449 path = path.replace(/\*$/, "/*");
450 }
451 const prefix = path.startsWith("/") ? "/" : "";
452 const stringify = (p) => p == null ? "" : typeof p === "string" ? p : String(p);
453 return prefix + path.split(/\/+/).map((segment, index, array) => {
454 if (index === array.length - 1 && segment === "*") return stringify(params["*"]);
455 const keyMatch = segment.match(/^:([\w-]+)(\??)(.*)/);
456 if (keyMatch) {
457 const [, key, optional, suffix] = keyMatch;
458 let param = params[key];
459 invariant(optional === "?" || param != null, `Missing ":${key}" param`);
460 return encodePathParam(stringify(param)) + suffix;
461 }
462 return segment.replace(/\?$/g, "");
463 }).filter((segment) => !!segment).join("/");
464}
465/**
466* Performs pattern matching on a URL pathname and returns information about
467* the match.
468*
469* @public
470* @category Utils
471* @param pattern The pattern to match against the URL pathname. This can be a
472* string or a {@link PathPattern} object. If a string is provided, it will be
473* treated as a pattern with `caseSensitive` set to `false` and `end` set to
474* `true`.
475* @param pathname The URL pathname to match against the pattern.
476* @returns A path match object if the pattern matches the pathname,
477* or `null` if it does not match.
478*/
479function matchPath(pattern, pathname) {
480 if (typeof pattern === "string") pattern = {
481 path: pattern,
482 caseSensitive: false,
483 end: true
484 };
485 let [matcher, compiledParams] = compilePath(pattern.path, pattern.caseSensitive, pattern.end);
486 return matchPathImpl(pattern, pathname, matcher, compiledParams);
487}
488function matchPathImpl(pattern, pathname, matcher, compiledParams) {
489 let match = pathname.match(matcher);
490 if (!match) return null;
491 let matchedPathname = match[0];
492 let pathnameBase = matchedPathname.replace(/(.)\/+$/, "$1");
493 let captureGroups = match.slice(1);
494 return {
495 params: compiledParams.reduce((memo, { paramName, isOptional }, index) => {
496 if (paramName === "*") {
497 let splatValue = captureGroups[index] || "";
498 pathnameBase = matchedPathname.slice(0, matchedPathname.length - splatValue.length).replace(/(.)\/+$/, "$1");
499 }
500 const value = captureGroups[index];
501 if (isOptional && !value) memo[paramName] = void 0;
502 else memo[paramName] = (value || "").replace(/%2F/g, "/");
503 return memo;
504 }, {}),
505 pathname: matchedPathname,
506 pathnameBase,
507 pattern
508 };
509}
510function compilePath(path, caseSensitive = false, end = true) {
511 warning(path === "*" || !path.endsWith("*") || path.endsWith("/*"), `Route path "${path}" will be treated as if it were "${path.replace(/\*$/, "/*")}" because the \`*\` character must always follow a \`/\` in the pattern. To get rid of this warning, please change the route path to "${path.replace(/\*$/, "/*")}".`);
512 let params = [];
513 let regexpSource = "^" + path.replace(/\/*\*?$/, "").replace(/^\/*/, "/").replace(/[\\.*+^${}|()[\]]/g, "\\$&").replace(/\/:([\w-]+)(\?)?/g, (match, paramName, isOptional, index, str) => {
514 params.push({
515 paramName,
516 isOptional: isOptional != null
517 });
518 if (isOptional) {
519 let nextChar = str.charAt(index + match.length);
520 if (nextChar && nextChar !== "/") return "/([^\\/]*)";
521 return "(?:/([^\\/]*))?";
522 }
523 return "/([^\\/]+)";
524 }).replace(/\/([\w-]+)\?(?=\/|$|\()/g, "(?:/$1)?");
525 if (path.endsWith("*")) {
526 params.push({ paramName: "*" });
527 regexpSource += path === "*" || path === "/*" ? "(.*)$" : "(?:\\/(.+)|\\/*)$";
528 } else if (end) regexpSource += "\\/*$";
529 else if (path !== "" && path !== "/") regexpSource += "(?:(?=\\/|$))";
530 return [new RegExp(regexpSource, caseSensitive ? void 0 : "i"), params];
531}
532function decodePath(value) {
533 try {
534 return value.split("/").map((v) => decodeURIComponent(v).replace(/\//g, "%2F")).join("/");
535 } catch (error) {
536 warning(false, `The URL path "${value}" could not be decoded because it is a malformed URL segment. This is probably due to a bad percent encoding (${error}).`);
537 return value;
538 }
539}
540function stripBasename(pathname, basename) {
541 if (basename === "/") return pathname;
542 if (!pathname.toLowerCase().startsWith(basename.toLowerCase())) return null;
543 let startIndex = basename.endsWith("/") ? basename.length - 1 : basename.length;
544 let nextChar = pathname.charAt(startIndex);
545 if (nextChar && nextChar !== "/") return null;
546 return pathname.slice(startIndex) || "/";
547}
548function prependBasename({ basename, pathname }) {
549 return pathname === "/" ? basename : joinPaths([basename, pathname]);
550}
551const isAbsoluteUrl = (url) => ABSOLUTE_URL_REGEX.test(url);
552/**
553* Returns a resolved {@link Path} object relative to the given pathname.
554*
555* @public
556* @category Utils
557* @param to The path to resolve, either a string or a partial {@link Path}
558* object.
559* @param fromPathname The pathname to resolve the path from. Defaults to `/`.
560* @returns A {@link Path} object with the resolved pathname, search, and hash.
561*/
562function resolvePath(to, fromPathname = "/") {
563 let { pathname: toPathname, search = "", hash = "" } = typeof to === "string" ? parsePath(to) : to;
564 let pathname;
565 if (toPathname) {
566 toPathname = removeDoubleSlashes(toPathname);
567 if (toPathname.startsWith("/")) pathname = resolvePathname(toPathname.substring(1), "/");
568 else pathname = resolvePathname(toPathname, fromPathname);
569 } else pathname = fromPathname;
570 return {
571 pathname,
572 search: normalizeSearch(search),
573 hash: normalizeHash(hash)
574 };
575}
576function resolvePathname(relativePath, fromPathname) {
577 let segments = removeTrailingSlash(fromPathname).split("/");
578 relativePath.split("/").forEach((segment) => {
579 if (segment === "..") {
580 if (segments.length > 1) segments.pop();
581 } else if (segment !== ".") segments.push(segment);
582 });
583 return segments.length > 1 ? segments.join("/") : "/";
584}
585function getInvalidPathError(char, field, dest, path) {
586 return `Cannot include a '${char}' character in a manually specified \`to.${field}\` field [${JSON.stringify(path)}]. Please separate it out to the \`to.${dest}\` field. Alternatively you may provide the full path as a string in <Link to="..."> and the router will parse it for you.`;
587}
588function getPathContributingMatches(matches) {
589 return matches.filter((match, index) => index === 0 || match.route.path && match.route.path.length > 0);
590}
591function getResolveToMatches(matches) {
592 let pathMatches = getPathContributingMatches(matches);
593 return pathMatches.map((match, idx) => idx === pathMatches.length - 1 ? match.pathname : match.pathnameBase);
594}
595function resolveTo(toArg, routePathnames, locationPathname, isPathRelative = false) {
596 let to;
597 if (typeof toArg === "string") to = parsePath(toArg);
598 else {
599 to = { ...toArg };
600 invariant(!to.pathname || !to.pathname.includes("?"), getInvalidPathError("?", "pathname", "search", to));
601 invariant(!to.pathname || !to.pathname.includes("#"), getInvalidPathError("#", "pathname", "hash", to));
602 invariant(!to.search || !to.search.includes("#"), getInvalidPathError("#", "search", "hash", to));
603 }
604 let isEmptyPath = toArg === "" || to.pathname === "";
605 let toPathname = isEmptyPath ? "/" : to.pathname;
606 let from;
607 if (toPathname == null) from = locationPathname;
608 else {
609 let routePathnameIndex = routePathnames.length - 1;
610 if (!isPathRelative && toPathname.startsWith("..")) {
611 let toSegments = toPathname.split("/");
612 while (toSegments[0] === "..") {
613 toSegments.shift();
614 routePathnameIndex -= 1;
615 }
616 to.pathname = toSegments.join("/");
617 }
618 from = routePathnameIndex >= 0 ? routePathnames[routePathnameIndex] : "/";
619 }
620 let path = resolvePath(to, from);
621 let hasExplicitTrailingSlash = toPathname && toPathname !== "/" && toPathname.endsWith("/");
622 let hasCurrentTrailingSlash = (isEmptyPath || toPathname === ".") && locationPathname.endsWith("/");
623 if (!path.pathname.endsWith("/") && (hasExplicitTrailingSlash || hasCurrentTrailingSlash)) path.pathname += "/";
624 return path;
625}
626const removeDoubleSlashes = (path) => path.replace(/[\\/]{2,}/g, "/");
627const joinPaths = (paths) => removeDoubleSlashes(paths.join("/"));
628const removeTrailingSlash = (path) => path.replace(/\/+$/, "");
629const normalizePathname = (pathname) => removeTrailingSlash(pathname).replace(/^\/*/, "/");
630const normalizeSearch = (search) => !search || search === "?" ? "" : search.startsWith("?") ? search : "?" + search;
631const normalizeHash = (hash) => !hash || hash === "#" ? "" : hash.startsWith("#") ? hash : "#" + hash;
632var DataWithResponseInit = class {
633 type = "DataWithResponseInit";
634 data;
635 init;
636 constructor(data, init) {
637 this.data = data;
638 this.init = init || null;
639 }
640};
641/**
642* Create "responses" that contain `headers`/`status` without forcing
643* serialization into an actual [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
644*
645* @example
646* import { data } from "react-router";
647*
648* export async function action({ request }: Route.ActionArgs) {
649* let formData = await request.formData();
650* let item = await createItem(formData);
651* return data(item, {
652* headers: { "X-Custom-Header": "value" }
653* status: 201,
654* });
655* }
656*
657* @public
658* @category Utils
659* @mode framework
660* @mode data
661* @param data The data to be included in the response.
662* @param init The status code or a `ResponseInit` object to be included in the
663* response.
664* @returns A {@link DataWithResponseInit} instance containing the data and
665* response init.
666*/
667function data(data, init) {
668 return new DataWithResponseInit(data, typeof init === "number" ? { status: init } : init);
669}
670/**
671* A redirect [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response).
672* Sets the status code and the [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
673* header. Defaults to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302).
674*
675* This utility accepts absolute URLs and can navigate to external domains, so
676* the application should validate any user-supplied inputs to redirects.
677*
678* @example
679* import { redirect } from "react-router";
680*
681* export async function loader({ request }: Route.LoaderArgs) {
682* if (!isLoggedIn(request))
683* throw redirect("/login");
684* }
685*
686* // ...
687* }
688*
689* @public
690* @category Utils
691* @mode framework
692* @mode data
693* @param url The URL to redirect to.
694* @param init The status code or a `ResponseInit` object to be included in the
695* response.
696* @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
697* object with the redirect status and [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
698* header.
699*/
700const redirect = (url, init = 302) => {
701 let responseInit = init;
702 if (typeof responseInit === "number") responseInit = { status: responseInit };
703 else if (typeof responseInit.status === "undefined") responseInit.status = 302;
704 let headers = new Headers(responseInit.headers);
705 headers.set("Location", url);
706 return new Response(null, {
707 ...responseInit,
708 headers
709 });
710};
711/**
712* A redirect [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
713* that will force a document reload to the new location. Sets the status code
714* and the [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
715* header. Defaults to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302).
716*
717* This utility accepts absolute URLs and can navigate to external domains, so
718* the application should validate any user-supplied inputs to redirects.
719*
720* ```tsx filename=routes/logout.tsx
721* import { redirectDocument } from "react-router";
722*
723* import { destroySession } from "../sessions.server";
724*
725* export async function action({ request }: Route.ActionArgs) {
726* let session = await getSession(request.headers.get("Cookie"));
727* return redirectDocument("/", {
728* headers: { "Set-Cookie": await destroySession(session) }
729* });
730* }
731* ```
732*
733* @public
734* @category Utils
735* @mode framework
736* @mode data
737* @param url The URL to redirect to.
738* @param init The status code or a `ResponseInit` object to be included in the
739* response.
740* @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
741* object with the redirect status and [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
742* header.
743*/
744const redirectDocument = (url, init) => {
745 let response = redirect(url, init);
746 response.headers.set("X-Remix-Reload-Document", "true");
747 return response;
748};
749/**
750* A redirect [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
751* that will perform a [`history.replaceState`](https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState)
752* instead of a [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState)
753* for client-side navigation redirects. Sets the status code and the [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
754* header. Defaults to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302).
755*
756* @example
757* import { replace } from "react-router";
758*
759* export async function loader() {
760* return replace("/new-location");
761* }
762*
763* @public
764* @category Utils
765* @mode framework
766* @mode data
767* @param url The URL to redirect to.
768* @param init The status code or a `ResponseInit` object to be included in the
769* response.
770* @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
771* object with the redirect status and [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
772* header.
773*/
774const replace = (url, init) => {
775 let response = redirect(url, init);
776 response.headers.set("X-Remix-Replace", "true");
777 return response;
778};
779const SUPPORTED_ERROR_TYPES = [
780 "EvalError",
781 "RangeError",
782 "ReferenceError",
783 "SyntaxError",
784 "TypeError",
785 "URIError"
786];
787var ErrorResponseImpl = class {
788 status;
789 statusText;
790 data;
791 error;
792 internal;
793 constructor(status, statusText, data, internal = false) {
794 this.status = status;
795 this.statusText = statusText || "";
796 this.internal = internal;
797 if (data instanceof Error) {
798 this.data = data.toString();
799 this.error = data;
800 } else this.data = data;
801 }
802};
803/**
804* Check if the given error is an {@link ErrorResponse} generated from a 4xx/5xx
805* [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
806* thrown from an [`action`](../../start/framework/route-module#action) or
807* [`loader`](../../start/framework/route-module#loader) function.
808*
809* @example
810* import { isRouteErrorResponse } from "react-router";
811*
812* export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
813* if (isRouteErrorResponse(error)) {
814* return (
815* <>
816* <p>Error: `${error.status}: ${error.statusText}`</p>
817* <p>{error.data}</p>
818* </>
819* );
820* }
821*
822* return (
823* <p>Error: {error instanceof Error ? error.message : "Unknown Error"}</p>
824* );
825* }
826*
827* @public
828* @category Utils
829* @mode framework
830* @mode data
831* @param error The error to check.
832* @returns `true` if the error is an {@link ErrorResponse}, `false` otherwise.
833*/
834function isRouteErrorResponse(error) {
835 return error != null && typeof error.status === "number" && typeof error.statusText === "string" && typeof error.internal === "boolean" && "data" in error;
836}
837function getRoutePattern(matches) {
838 return joinPaths(matches.map((m) => m.route.path).filter(Boolean)) || "/";
839}
840function createDataFunctionUrl(request, path) {
841 let url = new URL(typeof request === "string" || request instanceof URL ? request : request.url);
842 let parsed = typeof path === "string" ? parsePath(path) : path;
843 url.pathname = parsed.pathname || "/";
844 if (parsed.search) {
845 let searchParams = new URLSearchParams(parsed.search);
846 let indexValues = searchParams.getAll("index");
847 searchParams.delete("index");
848 for (let value of indexValues.filter(Boolean)) searchParams.append("index", value);
849 let search = searchParams.toString();
850 url.search = search ? `?${search}` : "";
851 } else url.search = "";
852 url.hash = parsed.hash || "";
853 return url;
854}
855const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined" && typeof window.document.createElement !== "undefined";
856function parseToInfo(_to, basename) {
857 let to = _to;
858 if (typeof to !== "string" || !ABSOLUTE_URL_REGEX.test(to)) return {
859 absoluteURL: void 0,
860 isExternal: false,
861 to
862 };
863 let absoluteURL = to;
864 let isExternal = false;
865 if (isBrowser) try {
866 let currentUrl = new URL(window.location.href);
867 let targetUrl = PROTOCOL_RELATIVE_URL_REGEX.test(to) ? new URL(normalizeProtocolRelativeUrl(to, currentUrl.protocol)) : new URL(to);
868 let path = stripBasename(targetUrl.pathname, basename);
869 if (targetUrl.origin === currentUrl.origin && path != null) to = path + targetUrl.search + targetUrl.hash;
870 else isExternal = true;
871 } catch (e) {
872 warning(false, `<Link to="${to}"> contains an invalid URL which will probably break when clicked - please update to a valid URL path.`);
873 }
874 return {
875 absoluteURL,
876 isExternal,
877 to
878 };
879}
880//#endregion
881export { ErrorResponseImpl, RouterContextProvider, SUPPORTED_ERROR_TYPES, compilePath, convertRouteMatchToUiMatch, convertRoutesToDataRoutes, createContext, createDataFunctionUrl, data, decodePath, defaultMapRouteProperties, encodePathParam, flattenAndRankRoutes, generatePath, getPathContributingMatches, getResolveToMatches, getRoutePattern, isAbsoluteUrl, isBrowser, isRouteErrorResponse, isUnsupportedLazyRouteFunctionKey, isUnsupportedLazyRouteObjectKey, joinPaths, matchPath, matchRoutes, matchRoutesImpl, parseToInfo, prependBasename, redirect, redirectDocument, removeDoubleSlashes, removeTrailingSlash, replace, resolvePath, resolveTo, stripBasename };