UNPKG

31.5 kBJavaScriptView Raw
1/**
2 * react-router v8.2.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) Object.assign(updates, {
161 element: React$1.createElement(route.Component),
162 Component: void 0
163 });
164 if (route.HydrateFallback) Object.assign(updates, {
165 hydrateFallbackElement: React$1.createElement(route.HydrateFallback),
166 HydrateFallback: void 0
167 });
168 if (route.ErrorBoundary) Object.assign(updates, {
169 errorElement: React$1.createElement(route.ErrorBoundary),
170 ErrorBoundary: void 0
171 });
172 return updates;
173}
174function convertRoutesToDataRoutes(routes, mapRouteProperties = defaultMapRouteProperties, parentPath = [], manifest = {}, allowInPlaceMutations = false) {
175 return routes.map((route, index) => {
176 let treePath = [...parentPath, String(index)];
177 let id = typeof route.id === "string" ? route.id : treePath.join("-");
178 invariant(route.index !== true || !route.children, `Cannot specify children on an index route`);
179 invariant(allowInPlaceMutations || !manifest[id], `Found a route id collision on id "${id}". Route id's must be globally unique within Data Router usages`);
180 if (isIndexRoute(route)) {
181 let indexRoute = {
182 ...route,
183 id
184 };
185 manifest[id] = mergeRouteUpdates(indexRoute, mapRouteProperties(indexRoute));
186 return indexRoute;
187 } else {
188 let pathOrLayoutRoute = {
189 ...route,
190 id,
191 children: void 0
192 };
193 manifest[id] = mergeRouteUpdates(pathOrLayoutRoute, mapRouteProperties(pathOrLayoutRoute));
194 if (route.children) pathOrLayoutRoute.children = convertRoutesToDataRoutes(route.children, mapRouteProperties, treePath, manifest, allowInPlaceMutations);
195 return pathOrLayoutRoute;
196 }
197 });
198}
199function mergeRouteUpdates(route, updates) {
200 return Object.assign(route, {
201 ...updates,
202 ...typeof updates.lazy === "object" && updates.lazy != null ? { lazy: {
203 ...route.lazy,
204 ...updates.lazy
205 } } : {}
206 });
207}
208/**
209* Matches the given routes to a location and returns the match data.
210*
211* @example
212* import { matchRoutes } from "react-router";
213*
214* let routes = [{
215* path: "/",
216* Component: Root,
217* children: [{
218* path: "dashboard",
219* Component: Dashboard,
220* }]
221* }];
222*
223* matchRoutes(routes, "/dashboard"); // [rootMatch, dashboardMatch]
224*
225* @public
226* @category Utils
227* @param routes The array of route objects to match against.
228* @param locationArg The location to match against, either a string path or a
229* partial {@link Location} object
230* @param basename Optional base path to strip from the location before matching.
231* Defaults to `/`.
232* @returns An array of matched routes, or `null` if no matches were found.
233*/
234function matchRoutes(routes, locationArg, basename = "/") {
235 return matchRoutesImpl(routes, locationArg, basename, false);
236}
237function matchRoutesImpl(routes, locationArg, basename, allowPartial, precomputedBranches) {
238 let pathname = stripBasename((typeof locationArg === "string" ? parsePath(locationArg) : locationArg).pathname || "/", basename);
239 if (pathname == null) return null;
240 let branches = precomputedBranches ?? flattenAndRankRoutes(routes);
241 let matches = null;
242 let decoded = decodePath(pathname);
243 for (let i = 0; matches == null && i < branches.length; ++i) matches = matchRouteBranch(branches[i], decoded, allowPartial);
244 return matches;
245}
246function convertRouteMatchToUiMatch(match, loaderData) {
247 let { route, pathname, params } = match;
248 return {
249 id: route.id,
250 pathname,
251 params,
252 loaderData: loaderData[route.id],
253 handle: route.handle
254 };
255}
256function flattenAndRankRoutes(routes) {
257 let branches = flattenRoutes(routes);
258 rankRouteBranches(branches);
259 return branches;
260}
261function flattenRoutes(routes, branches = [], parentsMeta = [], parentPath = "", _hasParentOptionalSegments = false) {
262 let flattenRoute = (route, index, hasParentOptionalSegments = _hasParentOptionalSegments, relativePath) => {
263 let meta = {
264 relativePath: relativePath === void 0 ? route.path || "" : relativePath,
265 caseSensitive: route.caseSensitive === true,
266 childrenIndex: index,
267 route
268 };
269 if (meta.relativePath.startsWith("/")) {
270 if (!meta.relativePath.startsWith(parentPath) && hasParentOptionalSegments) return;
271 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.`);
272 meta.relativePath = meta.relativePath.slice(parentPath.length);
273 }
274 let path = joinPaths([parentPath, meta.relativePath]);
275 let routesMeta = parentsMeta.concat(meta);
276 if (route.children && route.children.length > 0) {
277 invariant(route.index !== true, `Index routes must not have child routes. Please remove all child routes from route path "${path}".`);
278 flattenRoutes(route.children, branches, routesMeta, path, hasParentOptionalSegments);
279 }
280 if (route.path == null && !route.index) return;
281 branches.push({
282 path,
283 score: computeScore(path, route.index),
284 routesMeta: routesMeta.map((meta, i) => {
285 let [matcher, params] = compilePath(meta.relativePath, meta.caseSensitive, i === routesMeta.length - 1);
286 return {
287 ...meta,
288 matcher,
289 compiledParams: params
290 };
291 })
292 });
293 };
294 routes.forEach((route, index) => {
295 if (route.path === "" || !route.path?.includes("?")) flattenRoute(route, index);
296 else for (let exploded of explodeOptionalSegments(route.path)) flattenRoute(route, index, true, exploded);
297 });
298 return branches;
299}
300function explodeOptionalSegments(path) {
301 let segments = path.split("/");
302 if (segments.length === 0) return [];
303 let [first, ...rest] = segments;
304 let isOptional = first.endsWith("?");
305 let required = first.replace(/\?$/, "");
306 if (rest.length === 0) return isOptional ? [required, ""] : [required];
307 let restExploded = explodeOptionalSegments(rest.join("/"));
308 let result = [];
309 result.push(...restExploded.map((subpath) => subpath === "" ? required : [required, subpath].join("/")));
310 if (isOptional) result.push(...restExploded);
311 return result.map((exploded) => path.startsWith("/") && exploded === "" ? "/" : exploded);
312}
313function rankRouteBranches(branches) {
314 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)));
315}
316const paramRe = /^:[\w-]+$/;
317const partialParamRe = /^:[\w-]+/;
318const partialDynamicSegmentValue = 3.5;
319const dynamicSegmentValue = 3;
320const indexRouteValue = 2;
321const emptySegmentValue = 1;
322const staticSegmentValue = 10;
323const splatPenalty = -2;
324const isSplat = (s) => s === "*";
325function computeScore(path, index) {
326 let segments = path.split("/");
327 let initialScore = segments.length;
328 if (segments.some(isSplat)) initialScore += splatPenalty;
329 if (index) initialScore += indexRouteValue;
330 return segments.filter((s) => !isSplat(s)).reduce((score, segment) => score + (paramRe.test(segment) ? dynamicSegmentValue : partialParamRe.test(segment) ? partialDynamicSegmentValue : segment === "" ? emptySegmentValue : staticSegmentValue), initialScore);
331}
332function compareIndexes(a, b) {
333 return a.length === b.length && a.slice(0, -1).every((n, i) => n === b[i]) ? a[a.length - 1] - b[b.length - 1] : 0;
334}
335function matchRouteBranch(branch, pathname, allowPartial = false) {
336 let { routesMeta } = branch;
337 let matchedParams = {};
338 let matchedPathname = "/";
339 let matches = [];
340 for (let i = 0; i < routesMeta.length; ++i) {
341 let meta = routesMeta[i];
342 let end = i === routesMeta.length - 1;
343 let remainingPathname = matchedPathname === "/" ? pathname : pathname.slice(matchedPathname.length) || "/";
344 let pattern = {
345 path: meta.relativePath,
346 caseSensitive: meta.caseSensitive,
347 end
348 };
349 let match = meta.matcher && meta.compiledParams ? matchPathImpl(pattern, remainingPathname, meta.matcher, meta.compiledParams) : matchPath(pattern, remainingPathname);
350 let route = meta.route;
351 if (!match && end && allowPartial && !routesMeta[routesMeta.length - 1].route.index) match = matchPath({
352 path: meta.relativePath,
353 caseSensitive: meta.caseSensitive,
354 end: false
355 }, remainingPathname);
356 if (!match) return null;
357 Object.assign(matchedParams, match.params);
358 matches.push({
359 params: matchedParams,
360 pathname: joinPaths([matchedPathname, match.pathname]),
361 pathnameBase: normalizePathname(joinPaths([matchedPathname, match.pathnameBase])),
362 route
363 });
364 if (match.pathnameBase !== "/") matchedPathname = joinPaths([matchedPathname, match.pathnameBase]);
365 }
366 return matches;
367}
368/**
369* Returns a path with params interpolated.
370*
371* @example
372* import { generatePath } from "react-router";
373*
374* generatePath("/users/:id", { id: "123" }); // "/users/123"
375*
376* @public
377* @category Utils
378* @param originalPath The original path to generate.
379* @param params The parameters to interpolate into the path.
380* @returns The generated path with parameters interpolated.
381*/
382function generatePath(originalPath, params = {}) {
383 let path = originalPath;
384 if (path.endsWith("*") && path !== "*" && !path.endsWith("/*")) {
385 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(/\*$/, "/*")}".`);
386 path = path.replace(/\*$/, "/*");
387 }
388 const prefix = path.startsWith("/") ? "/" : "";
389 const stringify = (p) => p == null ? "" : typeof p === "string" ? p : String(p);
390 return prefix + path.split(/\/+/).map((segment, index, array) => {
391 if (index === array.length - 1 && segment === "*") return stringify(params["*"]);
392 const keyMatch = segment.match(/^:([\w-]+)(\??)(.*)/);
393 if (keyMatch) {
394 const [, key, optional, suffix] = keyMatch;
395 let param = params[key];
396 invariant(optional === "?" || param != null, `Missing ":${key}" param`);
397 return encodeURIComponent(stringify(param)) + suffix;
398 }
399 return segment.replace(/\?$/g, "");
400 }).filter((segment) => !!segment).join("/");
401}
402/**
403* Performs pattern matching on a URL pathname and returns information about
404* the match.
405*
406* @public
407* @category Utils
408* @param pattern The pattern to match against the URL pathname. This can be a
409* string or a {@link PathPattern} object. If a string is provided, it will be
410* treated as a pattern with `caseSensitive` set to `false` and `end` set to
411* `true`.
412* @param pathname The URL pathname to match against the pattern.
413* @returns A path match object if the pattern matches the pathname,
414* or `null` if it does not match.
415*/
416function matchPath(pattern, pathname) {
417 if (typeof pattern === "string") pattern = {
418 path: pattern,
419 caseSensitive: false,
420 end: true
421 };
422 let [matcher, compiledParams] = compilePath(pattern.path, pattern.caseSensitive, pattern.end);
423 return matchPathImpl(pattern, pathname, matcher, compiledParams);
424}
425function matchPathImpl(pattern, pathname, matcher, compiledParams) {
426 let match = pathname.match(matcher);
427 if (!match) return null;
428 let matchedPathname = match[0];
429 let pathnameBase = matchedPathname.replace(/(.)\/+$/, "$1");
430 let captureGroups = match.slice(1);
431 return {
432 params: compiledParams.reduce((memo, { paramName, isOptional }, index) => {
433 if (paramName === "*") {
434 let splatValue = captureGroups[index] || "";
435 pathnameBase = matchedPathname.slice(0, matchedPathname.length - splatValue.length).replace(/(.)\/+$/, "$1");
436 }
437 const value = captureGroups[index];
438 if (isOptional && !value) memo[paramName] = void 0;
439 else memo[paramName] = (value || "").replace(/%2F/g, "/");
440 return memo;
441 }, {}),
442 pathname: matchedPathname,
443 pathnameBase,
444 pattern
445 };
446}
447function compilePath(path, caseSensitive = false, end = true) {
448 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(/\*$/, "/*")}".`);
449 let params = [];
450 let regexpSource = "^" + path.replace(/\/*\*?$/, "").replace(/^\/*/, "/").replace(/[\\.*+^${}|()[\]]/g, "\\$&").replace(/\/:([\w-]+)(\?)?/g, (match, paramName, isOptional, index, str) => {
451 params.push({
452 paramName,
453 isOptional: isOptional != null
454 });
455 if (isOptional) {
456 let nextChar = str.charAt(index + match.length);
457 if (nextChar && nextChar !== "/") return "/([^\\/]*)";
458 return "(?:/([^\\/]*))?";
459 }
460 return "/([^\\/]+)";
461 }).replace(/\/([\w-]+)\?(?=\/|$|\()/g, "(?:/$1)?");
462 if (path.endsWith("*")) {
463 params.push({ paramName: "*" });
464 regexpSource += path === "*" || path === "/*" ? "(.*)$" : "(?:\\/(.+)|\\/*)$";
465 } else if (end) regexpSource += "\\/*$";
466 else if (path !== "" && path !== "/") regexpSource += "(?:(?=\\/|$))";
467 return [new RegExp(regexpSource, caseSensitive ? void 0 : "i"), params];
468}
469function decodePath(value) {
470 try {
471 return value.split("/").map((v) => decodeURIComponent(v).replace(/\//g, "%2F")).join("/");
472 } catch (error) {
473 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}).`);
474 return value;
475 }
476}
477function stripBasename(pathname, basename) {
478 if (basename === "/") return pathname;
479 if (!pathname.toLowerCase().startsWith(basename.toLowerCase())) return null;
480 let startIndex = basename.endsWith("/") ? basename.length - 1 : basename.length;
481 let nextChar = pathname.charAt(startIndex);
482 if (nextChar && nextChar !== "/") return null;
483 return pathname.slice(startIndex) || "/";
484}
485function prependBasename({ basename, pathname }) {
486 return pathname === "/" ? basename : joinPaths([basename, pathname]);
487}
488const isAbsoluteUrl = (url) => ABSOLUTE_URL_REGEX.test(url);
489/**
490* Returns a resolved {@link Path} object relative to the given pathname.
491*
492* @public
493* @category Utils
494* @param to The path to resolve, either a string or a partial {@link Path}
495* object.
496* @param fromPathname The pathname to resolve the path from. Defaults to `/`.
497* @returns A {@link Path} object with the resolved pathname, search, and hash.
498*/
499function resolvePath(to, fromPathname = "/") {
500 let { pathname: toPathname, search = "", hash = "" } = typeof to === "string" ? parsePath(to) : to;
501 let pathname;
502 if (toPathname) {
503 toPathname = removeDoubleSlashes(toPathname);
504 if (toPathname.startsWith("/")) pathname = resolvePathname(toPathname.substring(1), "/");
505 else pathname = resolvePathname(toPathname, fromPathname);
506 } else pathname = fromPathname;
507 return {
508 pathname,
509 search: normalizeSearch(search),
510 hash: normalizeHash(hash)
511 };
512}
513function resolvePathname(relativePath, fromPathname) {
514 let segments = removeTrailingSlash(fromPathname).split("/");
515 relativePath.split("/").forEach((segment) => {
516 if (segment === "..") {
517 if (segments.length > 1) segments.pop();
518 } else if (segment !== ".") segments.push(segment);
519 });
520 return segments.length > 1 ? segments.join("/") : "/";
521}
522function getInvalidPathError(char, field, dest, path) {
523 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.`;
524}
525function getPathContributingMatches(matches) {
526 return matches.filter((match, index) => index === 0 || match.route.path && match.route.path.length > 0);
527}
528function getResolveToMatches(matches) {
529 let pathMatches = getPathContributingMatches(matches);
530 return pathMatches.map((match, idx) => idx === pathMatches.length - 1 ? match.pathname : match.pathnameBase);
531}
532function resolveTo(toArg, routePathnames, locationPathname, isPathRelative = false) {
533 let to;
534 if (typeof toArg === "string") to = parsePath(toArg);
535 else {
536 to = { ...toArg };
537 invariant(!to.pathname || !to.pathname.includes("?"), getInvalidPathError("?", "pathname", "search", to));
538 invariant(!to.pathname || !to.pathname.includes("#"), getInvalidPathError("#", "pathname", "hash", to));
539 invariant(!to.search || !to.search.includes("#"), getInvalidPathError("#", "search", "hash", to));
540 }
541 let isEmptyPath = toArg === "" || to.pathname === "";
542 let toPathname = isEmptyPath ? "/" : to.pathname;
543 let from;
544 if (toPathname == null) from = locationPathname;
545 else {
546 let routePathnameIndex = routePathnames.length - 1;
547 if (!isPathRelative && toPathname.startsWith("..")) {
548 let toSegments = toPathname.split("/");
549 while (toSegments[0] === "..") {
550 toSegments.shift();
551 routePathnameIndex -= 1;
552 }
553 to.pathname = toSegments.join("/");
554 }
555 from = routePathnameIndex >= 0 ? routePathnames[routePathnameIndex] : "/";
556 }
557 let path = resolvePath(to, from);
558 let hasExplicitTrailingSlash = toPathname && toPathname !== "/" && toPathname.endsWith("/");
559 let hasCurrentTrailingSlash = (isEmptyPath || toPathname === ".") && locationPathname.endsWith("/");
560 if (!path.pathname.endsWith("/") && (hasExplicitTrailingSlash || hasCurrentTrailingSlash)) path.pathname += "/";
561 return path;
562}
563const removeDoubleSlashes = (path) => path.replace(/[\\/]{2,}/g, "/");
564const joinPaths = (paths) => removeDoubleSlashes(paths.join("/"));
565const removeTrailingSlash = (path) => path.replace(/\/+$/, "");
566const normalizePathname = (pathname) => removeTrailingSlash(pathname).replace(/^\/*/, "/");
567const normalizeSearch = (search) => !search || search === "?" ? "" : search.startsWith("?") ? search : "?" + search;
568const normalizeHash = (hash) => !hash || hash === "#" ? "" : hash.startsWith("#") ? hash : "#" + hash;
569var DataWithResponseInit = class {
570 type = "DataWithResponseInit";
571 data;
572 init;
573 constructor(data, init) {
574 this.data = data;
575 this.init = init || null;
576 }
577};
578/**
579* Create "responses" that contain `headers`/`status` without forcing
580* serialization into an actual [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
581*
582* @example
583* import { data } from "react-router";
584*
585* export async function action({ request }: Route.ActionArgs) {
586* let formData = await request.formData();
587* let item = await createItem(formData);
588* return data(item, {
589* headers: { "X-Custom-Header": "value" }
590* status: 201,
591* });
592* }
593*
594* @public
595* @category Utils
596* @mode framework
597* @mode data
598* @param data The data to be included in the response.
599* @param init The status code or a `ResponseInit` object to be included in the
600* response.
601* @returns A {@link DataWithResponseInit} instance containing the data and
602* response init.
603*/
604function data(data, init) {
605 return new DataWithResponseInit(data, typeof init === "number" ? { status: init } : init);
606}
607/**
608* A redirect [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response).
609* Sets the status code and the [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
610* header. Defaults to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302).
611*
612* This utility accepts absolute URLs and can navigate to external domains, so
613* the application should validate any user-supplied inputs to redirects.
614*
615* @example
616* import { redirect } from "react-router";
617*
618* export async function loader({ request }: Route.LoaderArgs) {
619* if (!isLoggedIn(request))
620* throw redirect("/login");
621* }
622*
623* // ...
624* }
625*
626* @public
627* @category Utils
628* @mode framework
629* @mode data
630* @param url The URL to redirect to.
631* @param init The status code or a `ResponseInit` object to be included in the
632* response.
633* @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
634* object with the redirect status and [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
635* header.
636*/
637const redirect = (url, init = 302) => {
638 let responseInit = init;
639 if (typeof responseInit === "number") responseInit = { status: responseInit };
640 else if (typeof responseInit.status === "undefined") responseInit.status = 302;
641 let headers = new Headers(responseInit.headers);
642 headers.set("Location", url);
643 return new Response(null, {
644 ...responseInit,
645 headers
646 });
647};
648/**
649* A redirect [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
650* that will force a document reload to the new location. Sets the status code
651* and the [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
652* header. Defaults to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302).
653*
654* This utility accepts absolute URLs and can navigate to external domains, so
655* the application should validate any user-supplied inputs to redirects.
656*
657* ```tsx filename=routes/logout.tsx
658* import { redirectDocument } from "react-router";
659*
660* import { destroySession } from "../sessions.server";
661*
662* export async function action({ request }: Route.ActionArgs) {
663* let session = await getSession(request.headers.get("Cookie"));
664* return redirectDocument("/", {
665* headers: { "Set-Cookie": await destroySession(session) }
666* });
667* }
668* ```
669*
670* @public
671* @category Utils
672* @mode framework
673* @mode data
674* @param url The URL to redirect to.
675* @param init The status code or a `ResponseInit` object to be included in the
676* response.
677* @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
678* object with the redirect status and [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
679* header.
680*/
681const redirectDocument = (url, init) => {
682 let response = redirect(url, init);
683 response.headers.set("X-Remix-Reload-Document", "true");
684 return response;
685};
686/**
687* A redirect [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
688* that will perform a [`history.replaceState`](https://developer.mozilla.org/en-US/docs/Web/API/History/replaceState)
689* instead of a [`history.pushState`](https://developer.mozilla.org/en-US/docs/Web/API/History/pushState)
690* for client-side navigation redirects. Sets the status code and the [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
691* header. Defaults to [`302 Found`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/302).
692*
693* @example
694* import { replace } from "react-router";
695*
696* export async function loader() {
697* return replace("/new-location");
698* }
699*
700* @public
701* @category Utils
702* @mode framework
703* @mode data
704* @param url The URL to redirect to.
705* @param init The status code or a `ResponseInit` object to be included in the
706* response.
707* @returns A [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
708* object with the redirect status and [`Location`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Location)
709* header.
710*/
711const replace = (url, init) => {
712 let response = redirect(url, init);
713 response.headers.set("X-Remix-Replace", "true");
714 return response;
715};
716const SUPPORTED_ERROR_TYPES = [
717 "EvalError",
718 "RangeError",
719 "ReferenceError",
720 "SyntaxError",
721 "TypeError",
722 "URIError"
723];
724var ErrorResponseImpl = class {
725 status;
726 statusText;
727 data;
728 error;
729 internal;
730 constructor(status, statusText, data, internal = false) {
731 this.status = status;
732 this.statusText = statusText || "";
733 this.internal = internal;
734 if (data instanceof Error) {
735 this.data = data.toString();
736 this.error = data;
737 } else this.data = data;
738 }
739};
740/**
741* Check if the given error is an {@link ErrorResponse} generated from a 4xx/5xx
742* [`Response`](https://developer.mozilla.org/en-US/docs/Web/API/Response)
743* thrown from an [`action`](../../start/framework/route-module#action) or
744* [`loader`](../../start/framework/route-module#loader) function.
745*
746* @example
747* import { isRouteErrorResponse } from "react-router";
748*
749* export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
750* if (isRouteErrorResponse(error)) {
751* return (
752* <>
753* <p>Error: `${error.status}: ${error.statusText}`</p>
754* <p>{error.data}</p>
755* </>
756* );
757* }
758*
759* return (
760* <p>Error: {error instanceof Error ? error.message : "Unknown Error"}</p>
761* );
762* }
763*
764* @public
765* @category Utils
766* @mode framework
767* @mode data
768* @param error The error to check.
769* @returns `true` if the error is an {@link ErrorResponse}, `false` otherwise.
770*/
771function isRouteErrorResponse(error) {
772 return error != null && typeof error.status === "number" && typeof error.statusText === "string" && typeof error.internal === "boolean" && "data" in error;
773}
774function getRoutePattern(matches) {
775 return joinPaths(matches.map((m) => m.route.path).filter(Boolean)) || "/";
776}
777function createDataFunctionUrl(request, path) {
778 let url = new URL(typeof request === "string" || request instanceof URL ? request : request.url);
779 let parsed = typeof path === "string" ? parsePath(path) : path;
780 url.pathname = parsed.pathname || "/";
781 if (parsed.search) {
782 let searchParams = new URLSearchParams(parsed.search);
783 let indexValues = searchParams.getAll("index");
784 searchParams.delete("index");
785 for (let value of indexValues.filter(Boolean)) searchParams.append("index", value);
786 let search = searchParams.toString();
787 url.search = search ? `?${search}` : "";
788 } else url.search = "";
789 url.hash = parsed.hash || "";
790 return url;
791}
792const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined" && typeof window.document.createElement !== "undefined";
793function parseToInfo(_to, basename) {
794 let to = _to;
795 if (typeof to !== "string" || !ABSOLUTE_URL_REGEX.test(to)) return {
796 absoluteURL: void 0,
797 isExternal: false,
798 to
799 };
800 let absoluteURL = to;
801 let isExternal = false;
802 if (isBrowser) try {
803 let currentUrl = new URL(window.location.href);
804 let targetUrl = PROTOCOL_RELATIVE_URL_REGEX.test(to) ? new URL(normalizeProtocolRelativeUrl(to, currentUrl.protocol)) : new URL(to);
805 let path = stripBasename(targetUrl.pathname, basename);
806 if (targetUrl.origin === currentUrl.origin && path != null) to = path + targetUrl.search + targetUrl.hash;
807 else isExternal = true;
808 } catch (e) {
809 warning(false, `<Link to="${to}"> contains an invalid URL which will probably break when clicked - please update to a valid URL path.`);
810 }
811 return {
812 absoluteURL,
813 isExternal,
814 to
815 };
816}
817//#endregion
818export { ErrorResponseImpl, RouterContextProvider, SUPPORTED_ERROR_TYPES, compilePath, convertRouteMatchToUiMatch, convertRoutesToDataRoutes, createContext, createDataFunctionUrl, data, decodePath, defaultMapRouteProperties, flattenAndRankRoutes, generatePath, getPathContributingMatches, getResolveToMatches, getRoutePattern, isAbsoluteUrl, isBrowser, isRouteErrorResponse, isUnsupportedLazyRouteFunctionKey, isUnsupportedLazyRouteObjectKey, joinPaths, matchPath, matchRoutes, matchRoutesImpl, parseToInfo, prependBasename, redirect, redirectDocument, removeDoubleSlashes, removeTrailingSlash, replace, resolvePath, resolveTo, stripBasename };