@octanejs/remix-router 0.1.0

package/src/lib/href.ts

@@ -0,0 +1,71 @@
+// Vendored from react-router@7.18.1 packages/react-router/lib/href.ts — unmodified.
+// Re-vendor with `node scripts/vendor-remix-router.mjs`; never hand-edit.
+import type { Pages } from './types/register';
+import type { Equal } from './types/utils';
+
+type Args = { [K in keyof Pages]: ToArgs<Pages[K]['params']> };
+
+// prettier-ignore
+type ToArgs<Params extends Record<string, string | undefined>> =
+  // path without params -> no `params` arg
+  Equal<Params, {}> extends true ? [] :
+  // path with only optional params -> optional `params` arg
+  Partial<Params> extends Params ? [Params] | [] :
+  // otherwise, require `params` arg
+  [Params];
+
+/**
+  Returns a resolved URL path for the specified route.
+
+  ```tsx
+  const h = href("/:lang?/about", { lang: "en" })
+  // -> `/en/about`
+
+  <Link to={href("/products/:id", { id: "abc123" })} />
+  ```
+ */
+export function href<Path extends keyof Args>(path: Path, ...args: Args[Path]): string {
+	let params = args[0];
+	let result = trimTrailingSplat(path) // Ignore trailing / and /*, we'll handle it below
+		.replace(
+			/\/:([\w-]+)(\?)?/g, // same regex as in .\router\utils.ts: compilePath().
+			(_: string, param: string, questionMark: string | undefined) => {
+				const isRequired = questionMark === undefined;
+				const value = params?.[param];
+				if (isRequired && value === undefined) {
+					throw new Error(`Path '${path}' requires param '${param}' but it was not provided`);
+				}
+				return value === undefined ? '' : '/' + value;
+			},
+		);
+
+	if (path.endsWith('*')) {
+		// treat trailing splat the same way as compilePath, and force it to be as if it were `/*`.
+		// `react-router typegen` will not generate the params for a malformed splat, causing a type error, but we can still do the correct thing here.
+		const value = params?.['*'];
+		if (value !== undefined) {
+			result += '/' + value;
+		}
+	}
+
+	return result || '/';
+}
+
+/**
+ * Removes a trailing splat and any number of slashes from the end of the path.
+ *
+ * Benchmarked to be faster than `path.replace(/\/*\*?$/, "")`, which backtracks.
+ */
+function trimTrailingSplat(path: string): string {
+	let i = path.length - 1;
+	let char = path[i];
+	if (char !== '*' && char !== '/') return path;
+
+	// for/break benchmarks faster than do/while
+	i--;
+	for (; i >= 0; i--) {
+		if (path[i] !== '/') break;
+	}
+
+	return path.slice(0, i + 1);
+}

package/src/lib/react-types.ts

@@ -0,0 +1,10 @@
+// Local type shim for the vendored core's type-only `react` import
+// (lib/router/utils.ts references React.ReactNode / React.ComponentType on
+// RouteObject's element/Component fields). This package's consumers compile
+// against octane, not @types/react — alias the two names onto octane's
+// equivalents. Renderables in octane are element descriptors / primitives /
+// arrays (see octane's ElementDescriptor), and components are ComponentBody.
+import type { ComponentBody } from 'octane';
+
+export type ReactNode = unknown;
+export type ComponentType<P = any> = ComponentBody<P>;