@intent-framework/router 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mahyar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { createRouter } from "./router.js";
+export type { Router, RouteDefinition, RouteMatch, RouteParams, RoutePathArgs, RouteParamsFor, RouteContextFor, RouteContext, RouterNavigate, RouterServices, RoutesFromPaths, } from "./router.js";

package/dist/index.js

@@ -0,0 +1,89 @@
+//#region src/router.ts
+function normalizePath(path) {
+	let normalized = path;
+	if (!normalized.startsWith("/")) normalized = "/" + normalized;
+	if (normalized.length > 1 && normalized.endsWith("/")) normalized = normalized.slice(0, -1);
+	return normalized;
+}
+function compilePattern(path) {
+	const segments = path.split("/");
+	const paramNames = [];
+	const regexParts = [];
+	for (const segment of segments) if (segment.startsWith(":")) {
+		paramNames.push(segment.slice(1));
+		regexParts.push("([^/]+)");
+	} else if (segment.length > 0) regexParts.push(segment.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"));
+	const pattern = new RegExp(`^/${regexParts.join("/")}$`);
+	return {
+		pattern,
+		paramNames
+	};
+}
+function createRouter() {
+	const build = (currentRoutes, currentByName, currentByPath) => {
+		const router = {
+			route(name, path, screen) {
+				if (currentByName.has(name)) throw new Error(`Route name "${name}" is already registered.`);
+				const normalized = normalizePath(path);
+				if (currentByPath.has(normalized)) throw new Error(`Route path "${normalized}" is already registered.`);
+				const { pattern, paramNames } = compilePattern(normalized);
+				const route = {
+					name,
+					path: normalized,
+					pattern,
+					paramNames,
+					screen
+				};
+				const newByName = new Map(currentByName).set(name, route);
+				const newByPath = new Map(currentByPath).set(normalized, true);
+				const newRoutes = [...currentRoutes, route];
+				return build(newRoutes, newByName, newByPath);
+			},
+			match(pathname) {
+				const normalized = normalizePath(pathname);
+				for (const route of currentRoutes) {
+					const m = normalized.match(route.pattern);
+					if (m) {
+						const params = {};
+						for (let i = 0; i < route.paramNames.length; i++) {
+							const value = m[i + 1];
+							if (value !== void 0) params[route.paramNames[i]] = value;
+						}
+						return {
+							found: true,
+							name: route.name,
+							path: route.path,
+							params,
+							screen: route.screen
+						};
+					}
+				}
+				return {
+					found: false,
+					pathname: normalized
+				};
+			},
+			path(name, params = {}) {
+				const route = currentByName.get(name);
+				if (!route) throw new Error(`Route "${name}" not found`);
+				let result = route.path;
+				for (const [key, value] of Object.entries(params)) result = result.replace(`:${key}`, value);
+				const unresolved = result.match(/:(\w+)/g);
+				if (unresolved) throw new Error(`Missing params for route "${name}": ${unresolved.join(", ")}`);
+				return result;
+			},
+			routes() {
+				return currentRoutes.map((r) => ({
+					name: r.name,
+					path: r.path,
+					screen: r.screen
+				}));
+			}
+		};
+		return router;
+	};
+	return build([], /* @__PURE__ */ new Map(), /* @__PURE__ */ new Map());
+}
+
+//#endregion
+export { createRouter };

package/dist/router.d.ts

@@ -0,0 +1,68 @@
+import type { ScreenDefinition, DefaultScreenServices } from "@intent-framework/core";
+export type RouteDefinition<TServices extends object = DefaultScreenServices> = {
+    name: string;
+    path: string;
+    screen: ScreenDefinition<TServices>;
+};
+export type RouteParamNames<Path extends string> = string extends Path ? string : Path extends `${string}/:${infer Param}/${infer Rest}` ? Param | RouteParamNames<`/${Rest}`> : Path extends `${string}/:${infer Param}` ? Param : never;
+export type RouteParams<Path extends string> = [
+    RouteParamNames<Path>
+] extends [never] ? {} : {
+    [Key in RouteParamNames<Path>]: string;
+};
+export type RoutePathArgs<Path extends string> = [
+    RouteParamNames<Path>
+] extends [never] ? [] : [params: RouteParams<Path>];
+export type RouteParamsFor<Routes extends Record<string, {
+    path: string;
+}>, Name extends Extract<keyof Routes, string>> = RouteParams<Routes[Name]["path"]>;
+export type RouteContextFor<Routes extends Record<string, {
+    path: string;
+}>, Name extends Extract<keyof Routes, string>> = {
+    name: Name;
+    path: Routes[Name]["path"];
+    params: RouteParamsFor<Routes, Name>;
+};
+export type RouteContext<Routes extends Record<string, {
+    path: string;
+}>> = {
+    [Name in Extract<keyof Routes, string>]: RouteContextFor<Routes, Name>;
+}[Extract<keyof Routes, string>];
+export type RouterNavigate<Routes extends Record<string, {
+    path: string;
+}>> = <Name extends Extract<keyof Routes, string>>(name: Name, ...args: RoutePathArgs<Routes[Name]["path"]>) => void;
+export type RouterServices<Routes extends Record<string, {
+    path: string;
+}>, ExtraServices extends object = {}> = ExtraServices & {
+    navigate: RouterNavigate<Routes>;
+};
+export type RoutesFromPaths<Paths extends Record<string, string>> = {
+    [Name in Extract<keyof Paths, string>]: {
+        path: Paths[Name];
+    };
+};
+export type RouteMatch<Routes extends Record<string, {
+    path: string;
+}> = Record<string, {
+    path: string;
+}>, TServices extends object = DefaultScreenServices> = {
+    found: true;
+    name: keyof Routes;
+    path: string;
+    params: Record<string, string>;
+    screen: ScreenDefinition<TServices>;
+} | {
+    found: false;
+    pathname: string;
+};
+export type Router<Routes extends Record<string, {
+    path: string;
+}> = {}, TServices extends object = DefaultScreenServices> = {
+    route<Name extends string, Path extends string>(name: Name, path: Path, screen: ScreenDefinition<TServices>): Router<Routes & Record<Name, {
+        path: Path;
+    }>, TServices>;
+    match(pathname: string): RouteMatch<Routes, TServices>;
+    path<Name extends Extract<keyof Routes, string>>(name: Name, ...args: RoutePathArgs<Routes[Name]["path"]>): string;
+    routes(): RouteDefinition<TServices>[];
+};
+export declare function createRouter<TServices extends object = DefaultScreenServices>(): Router<{}, TServices>;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@intent-framework/router",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.0-alpha.0",
+  "description": "Typed route definitions and navigation for Intent",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/intent-framework/intent.git",
+    "directory": "packages/router"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@intent-framework/core": "0.1.0-alpha.0"
+  },
+  "devDependencies": {
+    "tsdown": "^0.3.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "typecheck": "tsc -b --noEmit",
+    "lint": "tsc -b --noEmit"
+  }
+}