@octanejs/remix-router 0.1.0 → 0.1.2

package/src/lib/router/utils.ts

@@ -1,7 +1,7 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/router/utils.ts — unmodified except: type-only react import → local ../react-types shim.
+// Vendored from react-router@8.2.0 packages/react-router/lib/router/utils.ts — unmodified except: React types → local ../react-types shim; route descriptors → octane createElement; build-time __DEV__ constant → NODE_ENV check.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 import type * as React from '../react-types';
-import type { MiddlewareEnabled } from '../types/future';
+import { createElement } from 'octane';
 import type { Equal, Expect } from '../types/utils';
 import type { Location, Path, To } from './history';
 import { invariant, parsePath, warning } from './history';
@@ -11,6 +11,8 @@ import {
 	PROTOCOL_RELATIVE_URL_REGEX,
 } from './url';
 
+export const ENABLE_DEV_WARNINGS = process.env.NODE_ENV !== 'production';
+
 export type MaybePromise<T> = T | Promise<T>;
 
 /**
@@ -265,7 +267,7 @@ export class RouterContextProvider {
 	}
 }
 
-type DefaultContext = MiddlewareEnabled extends true ? Readonly<RouterContextProvider> : any;
+type DefaultContext = Readonly<RouterContextProvider>;
 
 /**
  * @private
@@ -277,11 +279,11 @@ interface DataFunctionArgs<Context> {
 	request: Request;
 	/**
 	 * A URL instance representing the application location being navigated to or
-	 * fetched. By default, this matches `request.url`.
+	 * fetched.
 	 *
-	 * In Framework mode with `future.v8_passThroughRequests` enabled, this is a
-	 * normalized URL with React-Router-specific implementation details removed
-	 * (`.data` suffixes, `index`/`_routes` search params).
+	 * In Framework mode, this is a normalized URL with React-Router-specific
+	 * implementation details removed (`.data` suffixes, `index`/`_routes` search
+	 * params). For the raw incoming URL, use `request.url`.
 	 */
 	url: URL;
 	/**
@@ -548,9 +550,7 @@ export type PatchRoutesOnNavigationFunction = (
  * Function provided to set route-specific properties from route objects
  */
 export interface MapRoutePropertiesFunction {
-	(route: DataRouteObject): {
-		hasErrorBoundary: boolean;
-	} & Record<string, any>;
+	(route: DataRouteObject): Partial<DataRouteObject>;
 }
 
 /**
@@ -654,8 +654,6 @@ export type BaseRouteObject = {
 	 * See [`action`](../../start/data/route-object#action).
 	 */
 	action?: ActionFunction | boolean;
-	// TODO(v8): deprecate/remove
-	hasErrorBoundary?: boolean;
 	/**
 	 * The route shouldRevalidate function.
 	 * See [`shouldRevalidate`](../../start/data/route-object#shouldRevalidate).
@@ -880,11 +878,65 @@ function isIndexRoute(route: RouteObject): route is IndexRouteObject {
 	return route.index === true;
 }
 
+export function defaultMapRouteProperties(route: DataRouteObject) {
+	let updates: Partial<DataRouteObject> = {};
+
+	if (route.Component) {
+		if (ENABLE_DEV_WARNINGS) {
+			if (route.element) {
+				warning(
+					false,
+					'You should not include both `Component` and `element` on your route - ' +
+						'`Component` will be used.',
+				);
+			}
+		}
+		Object.assign(updates, {
+			element: createElement(route.Component),
+			Component: undefined,
+		});
+	}
+
+	if (route.HydrateFallback) {
+		if (ENABLE_DEV_WARNINGS) {
+			if (route.hydrateFallbackElement) {
+				warning(
+					false,
+					'You should not include both `HydrateFallback` and `hydrateFallbackElement` on your route - ' +
+						'`HydrateFallback` will be used.',
+				);
+			}
+		}
+		Object.assign(updates, {
+			hydrateFallbackElement: createElement(route.HydrateFallback),
+			HydrateFallback: undefined,
+		});
+	}
+
+	if (route.ErrorBoundary) {
+		if (ENABLE_DEV_WARNINGS) {
+			if (route.errorElement) {
+				warning(
+					false,
+					'You should not include both `ErrorBoundary` and `errorElement` on your route - ' +
+						'`ErrorBoundary` will be used.',
+				);
+			}
+		}
+		Object.assign(updates, {
+			errorElement: createElement(route.ErrorBoundary),
+			ErrorBoundary: undefined,
+		});
+	}
+
+	return updates;
+}
+
 // Walk the route tree generating unique IDs where necessary, so we are working
 // solely with DataRouteObject's within the Router
 export function convertRoutesToDataRoutes(
 	routes: RouteObject[],
-	mapRouteProperties: MapRoutePropertiesFunction,
+	mapRouteProperties: MapRoutePropertiesFunction = defaultMapRouteProperties,
 	parentPath: string[] = [],
 	manifest: RouteManifest = {},
 	allowInPlaceMutations = false,
@@ -931,7 +983,7 @@ export function convertRoutesToDataRoutes(
 
 function mergeRouteUpdates<T extends DataRouteObject>(
 	route: T,
-	updates: ReturnType<MapRoutePropertiesFunction>,
+	updates: Partial<DataRouteObject>,
 ): T {
 	return Object.assign(route, {
 		...updates,
@@ -1019,14 +1071,6 @@ export interface UIMatch<Data = unknown, Handle = unknown> {
 	 * {@link https://reactrouter.com/start/framework/routing#dynamic-segments Dynamic route params} for the matched route.
 	 */
 	params: RouteMatch['params'];
-	/**
-	 * The return value from the matched route's loader or clientLoader. This might
-	 * be `undefined` if this route's `loader` (or a deeper route's `loader`) threw
-	 * an error and we're currently displaying an `ErrorBoundary`.
-	 *
-	 * @deprecated Use `UIMatch.loaderData` instead
-	 */
-	data: Data | undefined;
 	/**
 	 * The return value from the matched route's loader or clientLoader. This might
 	 * be `undefined` if this route's `loader` (or a deeper route's `loader`) threw
@@ -1046,7 +1090,6 @@ export function convertRouteMatchToUiMatch(match: DataRouteMatch, loaderData: Ro
 		id: route.id,
 		pathname,
 		params,
-		data: loaderData[route.id],
 		loaderData: loaderData[route.id],
 		handle: route.handle,
 	};
@@ -1243,6 +1286,8 @@ function rankRouteBranches(branches: RouteBranch[]): void {
 }
 
 const paramRe = /^:[\w-]+$/;
+const partialParamRe = /^:[\w-]+/;
+const partialDynamicSegmentValue = 3.5;
 const dynamicSegmentValue = 3;
 const indexRouteValue = 2;
 const emptySegmentValue = 1;
@@ -1265,12 +1310,13 @@ function computeScore(path: string, index: boolean | undefined): number {
 		.filter((s) => !isSplat(s))
 		.reduce(
 			(score, segment) =>
-				score +
-				(paramRe.test(segment)
-					? dynamicSegmentValue
-					: segment === ''
-						? emptySegmentValue
-						: staticSegmentValue),
+				// prettier-ignore
+				score + (
+          paramRe.test(segment) ? dynamicSegmentValue :
+          partialParamRe.test(segment) ? partialDynamicSegmentValue :
+          segment === "" ? emptySegmentValue :
+          staticSegmentValue
+        ),
 			initialScore,
 		);
 }
@@ -1577,7 +1623,7 @@ export function compilePath(
 					return '/([^\\/]+)';
 				},
 			) // Dynamic segment
-			.replace(/\/([\w-]+)\?(\/|$)/g, '(/$1)?$2'); // Optional static segment
+			.replace(/\/([\w-]+)\?(?=\/|$|\()/g, '(?:/$1)?'); // Optional static segment (non-capturing)
 
 	if (path.endsWith('*')) {
 		params.push({ paramName: '*' });
@@ -2108,11 +2154,41 @@ by the star-slash in the `getRoutePattern` regex and messes up the parsed commen
 for `isRouteErrorResponse` above.  This comment seems to reset the parser.
 */
 
-export function getRoutePattern(matches: RouteMatch[]) {
+// Accept the narrow shape we read so this can be used with server-runtime
+// matches, which do not include the full RouteMatch fields like pathnameBase.
+export function getRoutePattern(matches: { route: { path?: string } }[]) {
 	let parts = matches.map((m) => m.route.path).filter(Boolean) as string[];
 	return joinPaths(parts) || '/';
 }
 
+// Create the normalized URL instance to pass to loaders/actions/middleware.
+// We strip the `?index` param because that is a React Router implementation detail.
+export function createDataFunctionUrl(request: Request | URL | string, path: To): URL {
+	let url = new URL(typeof request === 'string' || request instanceof URL ? request : request.url);
+
+	let parsed = typeof path === 'string' ? parsePath(path) : path;
+	url.pathname = parsed.pathname || '/';
+
+	if (parsed.search) {
+		let searchParams = new URLSearchParams(parsed.search);
+
+		// Strip naked index param, preserve any other index params with values
+		let indexValues = searchParams.getAll('index');
+		searchParams.delete('index');
+		for (let value of indexValues.filter(Boolean)) {
+			searchParams.append('index', value);
+		}
+		let search = searchParams.toString();
+		url.search = search ? `?${search}` : '';
+	} else {
+		url.search = '';
+	}
+
+	url.hash = parsed.hash || '';
+
+	return url;
+}
+
 export const isBrowser =
 	typeof window !== 'undefined' &&
 	typeof window.document !== 'undefined' &&

package/src/lib/server-runtime/cookies.ts

@@ -1,12 +1,12 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/cookies.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/cookies.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
-import type { ParseOptions, SerializeOptions } from 'cookie';
-import { parse, serialize } from 'cookie';
+import type { CookieParseOptions, CookieSerializeOptions } from 'cookie-es';
+import { parse, serialize } from 'cookie-es';
 
 import { sign, unsign } from './crypto';
 import { warnOnce } from './warnings';
 
-export type { ParseOptions as CookieParseOptions, SerializeOptions as CookieSerializeOptions };
+export type { CookieParseOptions, CookieSerializeOptions };
 
 export interface CookieSignatureOptions {
 	/**
@@ -20,7 +20,7 @@ export interface CookieSignatureOptions {
 	secrets?: string[];
 }
 
-export type CookieOptions = ParseOptions & SerializeOptions & CookieSignatureOptions;
+export type CookieOptions = CookieParseOptions & CookieSerializeOptions & CookieSignatureOptions;
 
 /**
  * A HTTP cookie.
@@ -55,13 +55,13 @@ export interface Cookie {
 	 * Parses a raw `Cookie` header and returns the value of this cookie or
 	 * `null` if it's not present.
 	 */
-	parse(cookieHeader: string | null, options?: ParseOptions): Promise<any>;
+	parse(cookieHeader: string | null, options?: CookieParseOptions): Promise<any>;
 
 	/**
 	 * Serializes the given value to a string and returns the `Set-Cookie`
 	 * header.
 	 */
-	serialize(value: any, options?: SerializeOptions): Promise<string>;
+	serialize(value: any, options?: CookieSerializeOptions): Promise<string>;
 }
 
 /**

package/src/lib/server-runtime/crypto.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/crypto.ts — unmodified except: type-only: bare Uint8Array return widens to Uint8Array<ArrayBufferLike> under TS 5.7+ typed-array generics, which crypto.subtle.verify's BufferSource rejects.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/crypto.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 const encoder = /* @__PURE__ */ new TextEncoder();
 
@@ -45,7 +45,7 @@ const createKey = async (secret: string, usages: CryptoKey['usages']): Promise<C
 	);
 
 function byteStringToUint8Array(byteString: string): Uint8Array<ArrayBuffer> {
-	let array = new Uint8Array(byteString.length);
+	let array: Uint8Array<ArrayBuffer> = new Uint8Array(byteString.length);
 
 	for (let i = 0; i < byteString.length; i++) {
 		array[i] = byteString.charCodeAt(i);

package/src/lib/server-runtime/mode.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/mode.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/mode.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 /**
  * The mode to use when running the server.

package/src/lib/server-runtime/sessions/cookieStorage.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/sessions/cookieStorage.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/sessions/cookieStorage.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 import { createCookie, isCookie } from '../cookies';
 import type { SessionStorage, SessionIdStorageStrategy, SessionData } from '../sessions';

package/src/lib/server-runtime/sessions/memoryStorage.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/sessions/memoryStorage.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/sessions/memoryStorage.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 import type {
 	SessionData,

package/src/lib/server-runtime/sessions.ts

@@ -1,6 +1,6 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/sessions.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/sessions.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
-import type { ParseOptions, SerializeOptions } from 'cookie';
+import type { CookieParseOptions, CookieSerializeOptions } from 'cookie-es';
 
 import type { Cookie, CookieOptions } from './cookies';
 import { createCookie, isCookie } from './cookies';
@@ -167,14 +167,17 @@ export interface SessionStorage<Data = SessionData, FlashData = Data> {
 	 */
 	getSession: (
 		cookieHeader?: string | null,
-		options?: ParseOptions,
+		options?: CookieParseOptions,
 	) => Promise<Session<Data, FlashData>>;
 
 	/**
 	 * Stores all data in the Session and returns the Set-Cookie header to be
 	 * used in the HTTP response.
 	 */
-	commitSession: (session: Session<Data, FlashData>, options?: SerializeOptions) => Promise<string>;
+	commitSession: (
+		session: Session<Data, FlashData>,
+		options?: CookieSerializeOptions,
+	) => Promise<string>;
 
 	/**
 	 * Deletes all data associated with the Session and returns the Set-Cookie
@@ -182,7 +185,7 @@ export interface SessionStorage<Data = SessionData, FlashData = Data> {
 	 */
 	destroySession: (
 		session: Session<Data, FlashData>,
-		options?: SerializeOptions,
+		options?: CookieSerializeOptions,
 	) => Promise<string>;
 }
 

package/src/lib/server-runtime/warnings.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/server-runtime/warnings.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/server-runtime/warnings.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 const alreadyWarned: { [message: string]: boolean } = {};
 

package/src/lib/types/future.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/types/future.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/types/future.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 /**
  * An augmentable interface users can modify in their app-code to opt into
@@ -7,10 +7,4 @@
 export interface Future {
 	// We list the potential fields here in comments strictly for clarity.
 	// They will be generated by the react-router/dev/typegen/generate.ts module
-	//
-	// v8_middleware: boolean
 }
-
-// prettier-ignore
-export type MiddlewareEnabled =
-  Future extends { v8_middleware: infer T extends boolean; } ? T : false

package/src/lib/types/params.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/types/params.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/types/params.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 import type { Pages, RouteFiles } from './register';
 import type { Normalize } from './utils';

package/src/lib/types/register.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/types/register.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/types/register.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 import type { RouteModule } from './route-module';
 

package/src/lib/types/route-module.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/types/route-module.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/types/route-module.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 import type { Func } from './utils';
 

package/src/lib/types/utils.ts

@@ -1,4 +1,4 @@
-// Vendored from react-router@7.18.1 packages/react-router/lib/types/utils.ts — unmodified.
+// Vendored from react-router@8.2.0 packages/react-router/lib/types/utils.ts — unmodified.
 // Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
 export type Expect<T extends true> = T;