@esmx/router 3.0.0-rc.17 → 3.0.0-rc.19

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Vanelink
+Copyright (c) 2020 Esmx Team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -0,0 +1,70 @@
+<div align="center">
+  <img src="https://www.esmnext.com/logo.svg?t=2025" width="120" alt="Esmx Logo" />
+  <h1>@esmx/router</h1>
+  
+  <div>
+    <a href="https://www.npmjs.com/package/@esmx/router">
+      <img src="https://img.shields.io/npm/v/@esmx/router.svg" alt="npm version" />
+    </a>
+    <a href="https://github.com/esmnext/esmx/actions/workflows/build.yml">
+      <img src="https://github.com/esmnext/esmx/actions/workflows/build.yml/badge.svg" alt="Build" />
+    </a>
+    <a href="https://www.esmnext.com/coverage/">
+      <img src="https://img.shields.io/badge/coverage-live%20report-brightgreen" alt="Coverage Report" />
+    </a>
+    <a href="https://nodejs.org/">
+      <img src="https://img.shields.io/node/v/@esmx/router.svg" alt="node version" />
+    </a>
+    <a href="https://bundlephobia.com/package/@esmx/router">
+      <img src="https://img.shields.io/bundlephobia/minzip/@esmx/router" alt="size" />
+    </a>
+  </div>
+  
+  <p>A universal, framework-agnostic router that works seamlessly with modern frontend frameworks</p>
+  
+  <p>
+    English | <a href="https://github.com/esmnext/esmx/blob/master/packages/router/README.zh-CN.md">中文</a>
+  </p>
+</div>
+
+## 🚀 Features
+
+- **Framework Agnostic** - Works with any frontend framework (Vue, React, Preact, Solid, etc.)
+- **Universal Support** - Runs in both browser and Node.js environments
+- **TypeScript Ready** - Full TypeScript support with excellent type inference
+- **High Performance** - Optimized for production use with minimal bundle size
+- **SSR Compatible** - Complete server-side rendering support
+- **Modern API** - Clean and intuitive API design
+
+## 📦 Installation
+
+```bash
+npm install @esmx/router
+```
+
+## 🚀 Quick Start
+
+```typescript
+import { Router, RouterMode } from '@esmx/router';
+
+// Create router instance
+const router = new Router({
+  root: '#app', // Required in browser environment
+  mode: RouterMode.history,
+  routes: [
+    { path: '/', component: () => 'Home Page' },
+    { path: '/about', component: () => 'About Page' }
+  ]
+});
+
+// Navigate to route
+await router.push('/about');
+```
+
+## 📚 Documentation
+
+Visit the [official documentation](https://www.esmnext.com) for detailed usage guides and API reference.
+
+## 📄 License
+
+MIT © [Esmx Team](https://github.com/esmnext/esmx) 

package/README.zh-CN.md

@@ -0,0 +1,70 @@
+<div align="center">
+  <img src="https://www.esmnext.com/logo.svg?t=2025" width="120" alt="Esmx Logo" />
+  <h1>@esmx/router</h1>
+  
+  <div>
+    <a href="https://www.npmjs.com/package/@esmx/router">
+      <img src="https://img.shields.io/npm/v/@esmx/router.svg" alt="npm version" />
+    </a>
+    <a href="https://github.com/esmnext/esmx/actions/workflows/build.yml">
+      <img src="https://github.com/esmnext/esmx/actions/workflows/build.yml/badge.svg" alt="Build" />
+    </a>
+    <a href="https://www.esmnext.com/coverage/">
+      <img src="https://img.shields.io/badge/coverage-live%20report-brightgreen" alt="Coverage Report" />
+    </a>
+    <a href="https://nodejs.org/">
+      <img src="https://img.shields.io/node/v/@esmx/router.svg" alt="node version" />
+    </a>
+    <a href="https://bundlephobia.com/package/@esmx/router">
+      <img src="https://img.shields.io/bundlephobia/minzip/@esmx/router" alt="size" />
+    </a>
+  </div>
+  
+  <p>通用的框架无关路由器，与现代前端框架无缝协作</p>
+  
+  <p>
+    <a href="https://github.com/esmnext/esmx/blob/master/packages/router/README.md">English</a> | 中文
+  </p>
+</div>
+
+## 🚀 特性
+
+- **框架无关** - 适用于任何前端框架（Vue、React、Preact、Solid 等）
+- **通用支持** - 在浏览器和 Node.js 环境中运行
+- **TypeScript 就绪** - 完整的 TypeScript 支持，出色的类型推断
+- **高性能** - 为生产环境优化，最小化包体积
+- **SSR 兼容** - 完整的服务端渲染支持
+- **现代 API** - 简洁直观的 API 设计
+
+## 📦 安装
+
+```bash
+npm install @esmx/router
+```
+
+## 🚀 快速开始
+
+```typescript
+import { Router, RouterMode } from '@esmx/router';
+
+// 创建路由器实例
+const router = new Router({
+  root: '#app', // 浏览器环境中必需
+  mode: RouterMode.history,
+  routes: [
+    { path: '/', component: () => '首页' },
+    { path: '/about', component: () => '关于页面' }
+  ]
+});
+
+// 导航到路由
+await router.push('/about');
+```
+
+## 📚 文档
+
+访问[官方文档](https://www.esmnext.com)获取详细的使用指南和 API 参考。
+
+## 📄 许可证
+
+MIT © [Esmx Team](https://github.com/esmnext/esmx) 

package/dist/error.d.ts

@@ -0,0 +1,23 @@
+import type { Route } from './route';
+export declare class RouteError extends Error {
+    readonly code: string;
+    readonly to: Route;
+    readonly from: Route | null;
+    constructor(message: string, code: string, to: Route, from?: Route | null);
+}
+export declare class RouteTaskCancelledError extends RouteError {
+    readonly taskName: string;
+    constructor(taskName: string, to: Route, from?: Route | null);
+}
+export declare class RouteTaskExecutionError extends RouteError {
+    readonly taskName: string;
+    readonly originalError: Error;
+    constructor(taskName: string, to: Route, from?: Route | null, originalError?: unknown);
+}
+export declare class RouteNavigationAbortedError extends RouteError {
+    readonly taskName: string;
+    constructor(taskName: string, to: Route, from?: Route | null);
+}
+export declare class RouteSelfRedirectionError extends RouteError {
+    constructor(fullPath: string, to: Route, from?: Route | null);
+}

package/dist/error.mjs

@@ -0,0 +1,61 @@
+export class RouteError extends Error {
+  code;
+  to;
+  from;
+  constructor(message, code, to, from = null) {
+    super(message);
+    this.name = "RouteError";
+    this.code = code;
+    this.to = to;
+    this.from = from;
+  }
+}
+export class RouteTaskCancelledError extends RouteError {
+  taskName;
+  constructor(taskName, to, from = null) {
+    super(
+      `Route task "${taskName}" was cancelled`,
+      "ROUTE_TASK_CANCELLED",
+      to,
+      from
+    );
+    this.name = "RouteTaskCancelledError";
+    this.taskName = taskName;
+  }
+}
+export class RouteTaskExecutionError extends RouteError {
+  taskName;
+  originalError;
+  constructor(taskName, to, from = null, originalError) {
+    const error = originalError instanceof Error ? originalError : new Error(String(originalError));
+    const message = `Route task "${taskName}" failed${error.message ? `: ${error.message}` : ""}`;
+    super(message, "ROUTE_TASK_EXECUTION_ERROR", to, from);
+    this.name = "RouteTaskExecutionError";
+    this.taskName = taskName;
+    this.originalError = error;
+  }
+}
+export class RouteNavigationAbortedError extends RouteError {
+  taskName;
+  constructor(taskName, to, from = null) {
+    super(
+      `Navigation was aborted by task "${taskName}"`,
+      "ROUTE_NAVIGATION_ABORTED",
+      to,
+      from
+    );
+    this.name = "RouteNavigationAbortedError";
+    this.taskName = taskName;
+  }
+}
+export class RouteSelfRedirectionError extends RouteError {
+  constructor(fullPath, to, from = null) {
+    super(
+      `Detected a self-redirection to "${fullPath}". Aborting navigation.`,
+      "ROUTE_SELF_REDIRECTION",
+      to,
+      from
+    );
+    this.name = "RouteSelfRedirectionError";
+  }
+}

package/dist/increment-id.d.ts

@@ -0,0 +1,7 @@
+export declare class IncrementId {
+    private value;
+    equal(id: number): boolean;
+    next(): number;
+}
+export declare const PAGE_ID: IncrementId;
+export declare const LAYER_ID: IncrementId;

package/dist/increment-id.mjs

@@ -0,0 +1,11 @@
+export class IncrementId {
+  value = 0;
+  equal(id) {
+    return this.value === id;
+  }
+  next() {
+    return ++this.value;
+  }
+}
+export const PAGE_ID = new IncrementId();
+export const LAYER_ID = new IncrementId();

package/dist/index.d.ts

@@ -1,3 +1,5 @@
-export { createRouter } from './router';
-export * from './types';
-export * from './utils';
+export { Router } from './router';
+export { Route } from './route';
+export { RouteTransition, ROUTE_TYPE_HANDLERS } from './route-transition';
+export { type Awaitable, RouterMode, RouteType, type RouteConfirmHook, type RouteConfirmHookResult, type RouteVerifyHook, type RouteHandleHook, type RouteNotifyHook, type RouteMeta, type RouteState, type RouteHandleResult, type RouteMatchType, type RouteLocation, type RouteLocationInput, type RouteConfig, type RouteParsedConfig, type RouteMatchResult, type RouteMatcher, type RouteOptions, type RouteLayerOptions, type RouteLayerResult, type RouterLayerOptions, type RouterMicroApp, type RouterMicroAppCallback, type RouterMicroAppOptions, type RouterOptions, type RouterParsedOptions, type RouterLinkType, type RouterLinkAttributes, type RouterLinkProps, type RouterLinkResolved } from './types';
+export { RouteError, RouteTaskCancelledError, RouteTaskExecutionError, RouteNavigationAbortedError, RouteSelfRedirectionError } from './error';

package/dist/index.mjs

@@ -1,3 +1,14 @@
-export { createRouter } from "./router.mjs";
-export * from "./types";
-export * from "./utils/index.mjs";
+export { Router } from "./router.mjs";
+export { Route } from "./route.mjs";
+export { RouteTransition, ROUTE_TYPE_HANDLERS } from "./route-transition.mjs";
+export {
+  RouterMode,
+  RouteType
+} from "./types.mjs";
+export {
+  RouteError,
+  RouteTaskCancelledError,
+  RouteTaskExecutionError,
+  RouteNavigationAbortedError,
+  RouteSelfRedirectionError
+} from "./error.mjs";

package/dist/index.test.mjs

@@ -0,0 +1,8 @@
+import { describe, expect, it } from "vitest";
+import { Router as IndexRouter } from "./index.mjs";
+import { Router } from "./router.mjs";
+describe("index exports", () => {
+  it("should export Router correctly", () => {
+    expect(IndexRouter).toBe(Router);
+  });
+});

package/dist/location.d.ts

@@ -0,0 +1,15 @@
+import type { RouteLocationInput } from './types';
+/**
+ * Normalizes a URL input into a URL object.
+ * @param url - The URL or string to normalize.
+ * @param base - The base URL to resolve against if the input is relative.
+ * @returns A URL object.
+ */
+export declare function normalizeURL(url: string | URL, base: URL): URL;
+/**
+ * Parses a RouteLocationInput object into a full URL.
+ * @param toInput - The route location input.
+ * @param baseURL - The base URL to resolve against.
+ * @returns The parsed URL object.
+ */
+export declare function parseLocation(toInput: RouteLocationInput, baseURL: URL): URL;

package/dist/location.mjs

@@ -0,0 +1,53 @@
+import { isNotNullish } from "./util.mjs";
+export function normalizeURL(url, base) {
+  if (url instanceof URL) {
+    return url;
+  }
+  if (url.startsWith("//")) {
+    return new URL(`http:${url}`);
+  }
+  if (url.startsWith("/")) {
+    const newBase = new URL(".", base);
+    const parsed = new URL(url, newBase);
+    parsed.pathname = newBase.pathname.slice(0, -1) + parsed.pathname;
+    return parsed;
+  }
+  try {
+    return new URL(url);
+  } catch (e) {
+    return new URL(url, base);
+  }
+}
+export function parseLocation(toInput, baseURL) {
+  if (typeof toInput === "string") {
+    return normalizeURL(toInput, baseURL);
+  }
+  const url = normalizeURL(toInput.path ?? toInput.url ?? "", baseURL);
+  const searchParams = url.searchParams;
+  const mergedQuery = {};
+  if (toInput.query) {
+    Object.entries(toInput.query).forEach(([key, value]) => {
+      if (typeof value !== "undefined") {
+        mergedQuery[key] = value;
+      }
+    });
+  }
+  if (toInput.queryArray) {
+    Object.entries(toInput.queryArray).forEach(([key, value]) => {
+      if (typeof value !== "undefined") {
+        mergedQuery[key] = value;
+      }
+    });
+  }
+  Object.entries(mergedQuery).forEach(([key, value]) => {
+    searchParams.delete(key);
+    value = Array.isArray(value) ? value : [value];
+    value.filter((v) => isNotNullish(v) && !Number.isNaN(v)).forEach((v) => {
+      searchParams.append(key, String(v));
+    });
+  });
+  if (toInput.hash) {
+    url.hash = toInput.hash;
+  }
+  return url;
+}

package/dist/location.test.d.ts

@@ -0,0 +1,8 @@
+declare module 'vitest' {
+    interface ToEqURLMatchers {
+        toEqURL(expected: URL | string): void;
+    }
+    interface Assertion extends ToEqURLMatchers {
+    }
+}
+export {};