@modastar/z-router 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lanstar
+
+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.cjs

@@ -0,0 +1,185 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  DefaultTransitionDuration: () => DefaultTransitionDuration,
+  LocationContext: () => LocationContext,
+  RouteContext: () => RouteContext,
+  RouterContext: () => RouterContext,
+  createRouter: () => createRouter,
+  matchRoute: () => matchRoute,
+  matchUrl: () => matchUrl,
+  parseLocationFromHref: () => parseLocationFromHref,
+  redirect: () => redirect,
+  useLocation: () => useLocation,
+  useMatches: () => useMatches,
+  useRoute: () => useRoute,
+  useRouter: () => useRouter
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/utils.ts
+var DefaultTransitionDuration = 300;
+var redirect = (options) => {
+  return new Error("", { cause: options });
+};
+var matchUrl = (pattern, url) => {
+  try {
+    let pathname, searchParams;
+    if (url.startsWith("http://") || url.startsWith("https://")) {
+      const urlObj = new URL(url);
+      pathname = urlObj.pathname;
+      searchParams = urlObj.searchParams;
+    } else {
+      const [path, queryString] = url.split("?");
+      if (!path) {
+        return null;
+      }
+      pathname = path;
+      searchParams = new URLSearchParams(queryString || "");
+    }
+    const cleanPath = pathname.replaceAll(/^\/|\/$/g, "");
+    const cleanPattern = pattern.replaceAll(/^\/|\/$/g, "");
+    const pathSegments = cleanPath.split("/");
+    const patternSegments = cleanPattern.split("/");
+    if (pathSegments.length !== patternSegments.length) {
+      return null;
+    }
+    const params = {};
+    for (let i = 0; i < patternSegments.length; i++) {
+      const patternSegment = patternSegments[i];
+      const pathSegment = pathSegments[i];
+      if (patternSegment.startsWith(":")) {
+        const paramName = patternSegment.slice(1);
+        params[paramName] = decodeURIComponent(pathSegment);
+      } else if (patternSegment !== pathSegment) {
+        return null;
+      }
+    }
+    const query = Object.fromEntries(searchParams.entries());
+    return { params, query };
+  } catch {
+    return null;
+  }
+};
+var matchRoute = (rootRoute, url) => {
+  const _matchRoute = (matches, route) => {
+    if (route.children) {
+      for (const childRoute of route.children) {
+        const matchesResult = _matchRoute([...matches, childRoute], childRoute);
+        if (matchesResult) {
+          return matchesResult;
+        }
+      }
+      return null;
+    }
+    let pattern = "";
+    for (const match of matches) {
+      if (match.pathname === void 0) continue;
+      pattern += `/${match.pathname}`;
+    }
+    const result = matchUrl(pattern, url);
+    if (result) {
+      return { matches, ...result };
+    }
+    return null;
+  };
+  return _matchRoute([], rootRoute);
+};
+var parseLocationFromHref = (rootRoute, to) => {
+  const result = matchRoute(rootRoute, to);
+  if (!result) return null;
+  return {
+    pathname: to,
+    params: result.params,
+    query: result.query
+  };
+};
+var createRouter = (options) => {
+  return options;
+};
+
+// src/context/locationContext.ts
+var import_react = require("react");
+var LocationContext = (0, import_react.createContext)(null);
+
+// src/context/routeContext.ts
+var import_react2 = require("react");
+var RouteContext = (0, import_react2.createContext)(null);
+
+// src/context/routerContext.ts
+var import_react3 = require("react");
+var RouterContext = (0, import_react3.createContext)(null);
+
+// src/hooks/useLocation.ts
+var import_react4 = require("react");
+var useLocation = () => {
+  const context = (0, import_react4.useContext)(LocationContext);
+  if (context === null) {
+    throw new Error("useLocation must be used within a LocationProvider");
+  }
+  return context;
+};
+
+// src/hooks/useRoute.ts
+var import_react5 = require("react");
+var useRoute = () => {
+  const route = (0, import_react5.useContext)(RouteContext);
+  if (route === null) {
+    throw new Error("useRoute must be used within a RouteProvider");
+  }
+  return route;
+};
+
+// src/hooks/useMatches.ts
+var useMatches = () => {
+  const route = useRoute();
+  const location = useLocation();
+  if (!location) return [];
+  return matchRoute(route, location.pathname)?.matches || [];
+};
+
+// src/hooks/useRouter.ts
+var import_react6 = require("react");
+var useRouter = () => {
+  const router = (0, import_react6.useContext)(RouterContext);
+  if (router === null) {
+    throw new Error("useRouter must be used within a Stack");
+  }
+  return router;
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DefaultTransitionDuration,
+  LocationContext,
+  RouteContext,
+  RouterContext,
+  createRouter,
+  matchRoute,
+  matchUrl,
+  parseLocationFromHref,
+  redirect,
+  useLocation,
+  useMatches,
+  useRoute,
+  useRouter
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/utils.ts","../src/context/locationContext.ts","../src/context/routeContext.ts","../src/context/routerContext.ts","../src/hooks/useLocation.ts","../src/hooks/useRoute.ts","../src/hooks/useMatches.ts","../src/hooks/useRouter.ts"],"sourcesContent":["export * from \"./utils.js\";\n\nexport * from \"./context/index.js\";\nexport * from \"./hooks/index.js\";\n","import type { Location, RootRoute, Route, RouterOptions } from \"./types.js\";\n\nexport const DefaultTransitionDuration = 300;\n\nexport const redirect = (options: { to: string; replace?: boolean }) => {\n  return new Error(\"\", { cause: options });\n};\n\nexport const matchUrl = (\n  pattern: string,\n  url: string\n): { params: Record<string, string>; query: Record<string, string> } | null => {\n  try {\n    // 解析 URL\n    let pathname, searchParams;\n\n    if (url.startsWith(\"http://\") || url.startsWith(\"https://\")) {\n      const urlObj = new URL(url);\n      pathname = urlObj.pathname;\n      searchParams = urlObj.searchParams;\n    } else {\n      // 處理相對路徑\n      const [path, queryString] = url.split(\"?\");\n      if (!path) {\n        return null;\n      }\n      pathname = path;\n      searchParams = new URLSearchParams(queryString || \"\");\n    }\n\n    // 移除路徑首尾的斜線以便比較\n    const cleanPath = pathname.replaceAll(/^\\/|\\/$/g, \"\");\n    const cleanPattern = pattern.replaceAll(/^\\/|\\/$/g, \"\");\n\n    // 分割路徑段\n    const pathSegments = cleanPath.split(\"/\");\n    const patternSegments = cleanPattern.split(\"/\");\n\n    // 路徑段數量不同則不匹配\n    if (pathSegments.length !== patternSegments.length) {\n      return null;\n    }\n\n    // 提取路徑參數\n    const params: Record<string, string> = {};\n    for (let i = 0; i < patternSegments.length; i++) {\n      const patternSegment = patternSegments[i];\n      const pathSegment = pathSegments[i];\n\n      if (patternSegment.startsWith(\":\")) {\n        // 動態參數\n        const paramName = patternSegment.slice(1);\n        params[paramName] = decodeURIComponent(pathSegment);\n      } else if (patternSegment !== pathSegment) {\n        // 靜態段不匹配\n        return null;\n      }\n    }\n\n    // 提取查詢參數\n    const query = Object.fromEntries(searchParams.entries());\n\n    return { params, query };\n  } catch {\n    return null;\n  }\n};\n\nexport const matchRoute = (\n  rootRoute: RootRoute,\n  url: string\n): {\n  matches: Route[];\n  params: Record<string, string>;\n  query: Record<string, string>;\n} | null => {\n  const _matchRoute = (\n    matches: Route[],\n    route: Route\n  ): {\n    matches: Route[];\n    params: Record<string, string>;\n    query: Record<string, string>;\n  } | null => {\n    if (route.children) {\n      for (const childRoute of route.children) {\n        const matchesResult = _matchRoute([...matches, childRoute], childRoute);\n        if (matchesResult) {\n          return matchesResult;\n        }\n      }\n      return null;\n    }\n\n    let pattern = \"\";\n    for (const match of matches) {\n      if (match.pathname === undefined) continue;\n      pattern += `/${match.pathname}`;\n    }\n    const result = matchUrl(pattern, url);\n    if (result) {\n      return { matches, ...result };\n    }\n    return null;\n  };\n\n  return _matchRoute([], rootRoute);\n};\n\nexport const parseLocationFromHref = (\n  rootRoute: RootRoute,\n  to: string\n): Pick<Location, \"pathname\" | \"params\" | \"query\"> | null => {\n  const result = matchRoute(rootRoute, to);\n  if (!result) return null;\n  return {\n    pathname: to,\n    params: result.params,\n    query: result.query,\n  };\n};\n\nexport const createRouter = (options: RouterOptions): RouterOptions => {\n  return options;\n};\n","import { createContext } from \"react\";\n\nimport type { Location } from \"@/types.js\";\n\nexport const LocationContext = createContext<Location | null>(null);\n","import { createContext } from \"react\";\n\nimport type { RootRoute } from \"@/types.js\";\n\nexport const RouteContext = createContext<RootRoute | null>(null);\n","import { createContext } from \"react\";\n\nimport type {\n  BackOptions,\n  ForwardOptions,\n  Location,\n  NavigateOptions,\n  RouterOptions,\n} from \"@/types.js\";\n\nexport interface RouterContextType {\n  // Router Config\n  options: RouterOptions;\n\n  // Navigation State\n  history: Location[];\n  currentLocationIndex: number;\n  location: Location | null;\n  canGoBack: boolean;\n  canGoForward: boolean;\n\n  // Transition state\n  isTransitioning: boolean;\n  transitionDuration: number;\n  transitioningToIndex: number | null;\n\n  // Actions\n  navigate: (options: NavigateOptions) => void;\n  back: (options: BackOptions) => void;\n  forward: (options: ForwardOptions) => void;\n}\n\nexport const RouterContext = createContext<RouterContextType | null>(null);\n","import { useContext } from \"react\";\n\nimport { LocationContext } from \"@/context/locationContext.js\";\n\nexport const useLocation = () => {\n  const context = useContext(LocationContext);\n  if (context === null) {\n    throw new Error(\"useLocation must be used within a LocationProvider\");\n  }\n  return context;\n};\n","import { useContext } from \"react\";\n\nimport { RouteContext } from \"@/context/routeContext.js\";\n\nexport const useRoute = () => {\n  const route = useContext(RouteContext);\n  if (route === null) {\n    throw new Error(\"useRoute must be used within a RouteProvider\");\n  }\n  return route;\n};\n","import { matchRoute } from \"@/utils.js\";\n\nimport { useLocation } from \"./useLocation.js\";\nimport { useRoute } from \"./useRoute.js\";\n\nexport const useMatches = () => {\n  const route = useRoute();\n  const location = useLocation();\n  if (!location) return [];\n  return matchRoute(route, location.pathname)?.matches || [];\n};\n","import { useContext } from \"react\";\n\nimport { RouterContext } from \"@/context/routerContext.js\";\n\nexport const useRouter = () => {\n  const router = useContext(RouterContext);\n  if (router === null) {\n    throw new Error(\"useRouter must be used within a Stack\");\n  }\n  return router;\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACEO,IAAM,4BAA4B;AAElC,IAAM,WAAW,CAAC,YAA+C;AACtE,SAAO,IAAI,MAAM,IAAI,EAAE,OAAO,QAAQ,CAAC;AACzC;AAEO,IAAM,WAAW,CACtB,SACA,QAC6E;AAC7E,MAAI;AAEF,QAAI,UAAU;AAEd,QAAI,IAAI,WAAW,SAAS,KAAK,IAAI,WAAW,UAAU,GAAG;AAC3D,YAAM,SAAS,IAAI,IAAI,GAAG;AAC1B,iBAAW,OAAO;AAClB,qBAAe,OAAO;AAAA,IACxB,OAAO;AAEL,YAAM,CAAC,MAAM,WAAW,IAAI,IAAI,MAAM,GAAG;AACzC,UAAI,CAAC,MAAM;AACT,eAAO;AAAA,MACT;AACA,iBAAW;AACX,qBAAe,IAAI,gBAAgB,eAAe,EAAE;AAAA,IACtD;AAGA,UAAM,YAAY,SAAS,WAAW,YAAY,EAAE;AACpD,UAAM,eAAe,QAAQ,WAAW,YAAY,EAAE;AAGtD,UAAM,eAAe,UAAU,MAAM,GAAG;AACxC,UAAM,kBAAkB,aAAa,MAAM,GAAG;AAG9C,QAAI,aAAa,WAAW,gBAAgB,QAAQ;AAClD,aAAO;AAAA,IACT;AAGA,UAAM,SAAiC,CAAC;AACxC,aAAS,IAAI,GAAG,IAAI,gBAAgB,QAAQ,KAAK;AAC/C,YAAM,iBAAiB,gBAAgB,CAAC;AACxC,YAAM,cAAc,aAAa,CAAC;AAElC,UAAI,eAAe,WAAW,GAAG,GAAG;AAElC,cAAM,YAAY,eAAe,MAAM,CAAC;AACxC,eAAO,SAAS,IAAI,mBAAmB,WAAW;AAAA,MACpD,WAAW,mBAAmB,aAAa;AAEzC,eAAO;AAAA,MACT;AAAA,IACF;AAGA,UAAM,QAAQ,OAAO,YAAY,aAAa,QAAQ,CAAC;AAEvD,WAAO,EAAE,QAAQ,MAAM;AAAA,EACzB,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEO,IAAM,aAAa,CACxB,WACA,QAKU;AACV,QAAM,cAAc,CAClB,SACA,UAKU;AACV,QAAI,MAAM,UAAU;AAClB,iBAAW,cAAc,MAAM,UAAU;AACvC,cAAM,gBAAgB,YAAY,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU;AACtE,YAAI,eAAe;AACjB,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAEA,QAAI,UAAU;AACd,eAAW,SAAS,SAAS;AAC3B,UAAI,MAAM,aAAa,OAAW;AAClC,iBAAW,IAAI,MAAM,QAAQ;AAAA,IAC/B;AACA,UAAM,SAAS,SAAS,SAAS,GAAG;AACpC,QAAI,QAAQ;AACV,aAAO,EAAE,SAAS,GAAG,OAAO;AAAA,IAC9B;AACA,WAAO;AAAA,EACT;AAEA,SAAO,YAAY,CAAC,GAAG,SAAS;AAClC;AAEO,IAAM,wBAAwB,CACnC,WACA,OAC2D;AAC3D,QAAM,SAAS,WAAW,WAAW,EAAE;AACvC,MAAI,CAAC,OAAQ,QAAO;AACpB,SAAO;AAAA,IACL,UAAU;AAAA,IACV,QAAQ,OAAO;AAAA,IACf,OAAO,OAAO;AAAA,EAChB;AACF;AAEO,IAAM,eAAe,CAAC,YAA0C;AACrE,SAAO;AACT;;;AC5HA,mBAA8B;AAIvB,IAAM,sBAAkB,4BAA+B,IAAI;;;ACJlE,IAAAA,gBAA8B;AAIvB,IAAM,mBAAe,6BAAgC,IAAI;;;ACJhE,IAAAC,gBAA8B;AAgCvB,IAAM,oBAAgB,6BAAwC,IAAI;;;AChCzE,IAAAC,gBAA2B;AAIpB,IAAM,cAAc,MAAM;AAC/B,QAAM,cAAU,0BAAW,eAAe;AAC1C,MAAI,YAAY,MAAM;AACpB,UAAM,IAAI,MAAM,oDAAoD;AAAA,EACtE;AACA,SAAO;AACT;;;ACVA,IAAAC,gBAA2B;AAIpB,IAAM,WAAW,MAAM;AAC5B,QAAM,YAAQ,0BAAW,YAAY;AACrC,MAAI,UAAU,MAAM;AAClB,UAAM,IAAI,MAAM,8CAA8C;AAAA,EAChE;AACA,SAAO;AACT;;;ACLO,IAAM,aAAa,MAAM;AAC9B,QAAM,QAAQ,SAAS;AACvB,QAAM,WAAW,YAAY;AAC7B,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,SAAO,WAAW,OAAO,SAAS,QAAQ,GAAG,WAAW,CAAC;AAC3D;;;ACVA,IAAAC,gBAA2B;AAIpB,IAAM,YAAY,MAAM;AAC7B,QAAM,aAAS,0BAAW,aAAa;AACvC,MAAI,WAAW,MAAM;AACnB,UAAM,IAAI,MAAM,uCAAuC;AAAA,EACzD;AACA,SAAO;AACT;","names":["import_react","import_react","import_react","import_react","import_react"]}

package/dist/index.d.cts

@@ -0,0 +1,103 @@
+import { Pathname } from '@/lib/router';
+import * as react from 'react';
+
+interface Route {
+  id?: string;
+  pathname?: string;
+  beforeLoad?: ({ location }: { location: Location }) => Promise<void>;
+  component?: React.ComponentType<{ children?: React.ReactNode }>;
+  pendingComponent?: React.ComponentType;
+  children?: Route[];
+}
+
+interface RootRoute extends Route {
+  notFoundComponent?: React.ComponentType;
+}
+
+interface Location {
+  index: number;
+  pathname: Pathname;
+  params: any;
+  query: any;
+  state?: Map<string, any>;
+}
+
+interface RouterOptions {
+  defaultViewTransition?: (
+    fromLocation: Location | undefined,
+    toLocation: Location | undefined
+  ) => boolean;
+}
+
+interface TransitionOptions {
+  transition?: boolean;
+  duration?: number;
+  onFinish?: () => void;
+}
+
+type NavigateOptions = Partial<
+  Pick<Location, "params" | "query" | "state">
+> & {
+  to: string;
+  replace?: boolean;
+  updateHistory?: boolean;
+} & TransitionOptions;
+
+type BackOptions =
+  | (TransitionOptions & {
+      depth?: number;
+    })
+  | void;
+
+type ForwardOptions =
+  | (TransitionOptions & {
+      depth?: number;
+    })
+  | void;
+
+declare const DefaultTransitionDuration = 300;
+declare const redirect: (options: {
+    to: string;
+    replace?: boolean;
+}) => Error;
+declare const matchUrl: (pattern: string, url: string) => {
+    params: Record<string, string>;
+    query: Record<string, string>;
+} | null;
+declare const matchRoute: (rootRoute: RootRoute, url: string) => {
+    matches: Route[];
+    params: Record<string, string>;
+    query: Record<string, string>;
+} | null;
+declare const parseLocationFromHref: (rootRoute: RootRoute, to: string) => Pick<Location, "pathname" | "params" | "query"> | null;
+declare const createRouter: (options: RouterOptions) => RouterOptions;
+
+declare const LocationContext: react.Context<Location | null>;
+
+declare const RouteContext: react.Context<RootRoute | null>;
+
+interface RouterContextType {
+    options: RouterOptions;
+    history: Location[];
+    currentLocationIndex: number;
+    location: Location | null;
+    canGoBack: boolean;
+    canGoForward: boolean;
+    isTransitioning: boolean;
+    transitionDuration: number;
+    transitioningToIndex: number | null;
+    navigate: (options: NavigateOptions) => void;
+    back: (options: BackOptions) => void;
+    forward: (options: ForwardOptions) => void;
+}
+declare const RouterContext: react.Context<RouterContextType | null>;
+
+declare const useLocation: () => Location;
+
+declare const useMatches: () => Route[];
+
+declare const useRoute: () => RootRoute;
+
+declare const useRouter: () => RouterContextType;
+
+export { DefaultTransitionDuration, LocationContext, RouteContext, RouterContext, type RouterContextType, createRouter, matchRoute, matchUrl, parseLocationFromHref, redirect, useLocation, useMatches, useRoute, useRouter };

package/dist/index.d.ts

@@ -0,0 +1,103 @@
+import { Pathname } from '@/lib/router';
+import * as react from 'react';
+
+interface Route {
+  id?: string;
+  pathname?: string;
+  beforeLoad?: ({ location }: { location: Location }) => Promise<void>;
+  component?: React.ComponentType<{ children?: React.ReactNode }>;
+  pendingComponent?: React.ComponentType;
+  children?: Route[];
+}
+
+interface RootRoute extends Route {
+  notFoundComponent?: React.ComponentType;
+}
+
+interface Location {
+  index: number;
+  pathname: Pathname;
+  params: any;
+  query: any;
+  state?: Map<string, any>;
+}
+
+interface RouterOptions {
+  defaultViewTransition?: (
+    fromLocation: Location | undefined,
+    toLocation: Location | undefined
+  ) => boolean;
+}
+
+interface TransitionOptions {
+  transition?: boolean;
+  duration?: number;
+  onFinish?: () => void;
+}
+
+type NavigateOptions = Partial<
+  Pick<Location, "params" | "query" | "state">
+> & {
+  to: string;
+  replace?: boolean;
+  updateHistory?: boolean;
+} & TransitionOptions;
+
+type BackOptions =
+  | (TransitionOptions & {
+      depth?: number;
+    })
+  | void;
+
+type ForwardOptions =
+  | (TransitionOptions & {
+      depth?: number;
+    })
+  | void;
+
+declare const DefaultTransitionDuration = 300;
+declare const redirect: (options: {
+    to: string;
+    replace?: boolean;
+}) => Error;
+declare const matchUrl: (pattern: string, url: string) => {
+    params: Record<string, string>;
+    query: Record<string, string>;
+} | null;
+declare const matchRoute: (rootRoute: RootRoute, url: string) => {
+    matches: Route[];
+    params: Record<string, string>;
+    query: Record<string, string>;
+} | null;
+declare const parseLocationFromHref: (rootRoute: RootRoute, to: string) => Pick<Location, "pathname" | "params" | "query"> | null;
+declare const createRouter: (options: RouterOptions) => RouterOptions;
+
+declare const LocationContext: react.Context<Location | null>;
+
+declare const RouteContext: react.Context<RootRoute | null>;
+
+interface RouterContextType {
+    options: RouterOptions;
+    history: Location[];
+    currentLocationIndex: number;
+    location: Location | null;
+    canGoBack: boolean;
+    canGoForward: boolean;
+    isTransitioning: boolean;
+    transitionDuration: number;
+    transitioningToIndex: number | null;
+    navigate: (options: NavigateOptions) => void;
+    back: (options: BackOptions) => void;
+    forward: (options: ForwardOptions) => void;
+}
+declare const RouterContext: react.Context<RouterContextType | null>;
+
+declare const useLocation: () => Location;
+
+declare const useMatches: () => Route[];
+
+declare const useRoute: () => RootRoute;
+
+declare const useRouter: () => RouterContextType;
+
+export { DefaultTransitionDuration, LocationContext, RouteContext, RouterContext, type RouterContextType, createRouter, matchRoute, matchUrl, parseLocationFromHref, redirect, useLocation, useMatches, useRoute, useRouter };

package/dist/index.js

@@ -0,0 +1,146 @@
+// src/utils.ts
+var DefaultTransitionDuration = 300;
+var redirect = (options) => {
+  return new Error("", { cause: options });
+};
+var matchUrl = (pattern, url) => {
+  try {
+    let pathname, searchParams;
+    if (url.startsWith("http://") || url.startsWith("https://")) {
+      const urlObj = new URL(url);
+      pathname = urlObj.pathname;
+      searchParams = urlObj.searchParams;
+    } else {
+      const [path, queryString] = url.split("?");
+      if (!path) {
+        return null;
+      }
+      pathname = path;
+      searchParams = new URLSearchParams(queryString || "");
+    }
+    const cleanPath = pathname.replaceAll(/^\/|\/$/g, "");
+    const cleanPattern = pattern.replaceAll(/^\/|\/$/g, "");
+    const pathSegments = cleanPath.split("/");
+    const patternSegments = cleanPattern.split("/");
+    if (pathSegments.length !== patternSegments.length) {
+      return null;
+    }
+    const params = {};
+    for (let i = 0; i < patternSegments.length; i++) {
+      const patternSegment = patternSegments[i];
+      const pathSegment = pathSegments[i];
+      if (patternSegment.startsWith(":")) {
+        const paramName = patternSegment.slice(1);
+        params[paramName] = decodeURIComponent(pathSegment);
+      } else if (patternSegment !== pathSegment) {
+        return null;
+      }
+    }
+    const query = Object.fromEntries(searchParams.entries());
+    return { params, query };
+  } catch {
+    return null;
+  }
+};
+var matchRoute = (rootRoute, url) => {
+  const _matchRoute = (matches, route) => {
+    if (route.children) {
+      for (const childRoute of route.children) {
+        const matchesResult = _matchRoute([...matches, childRoute], childRoute);
+        if (matchesResult) {
+          return matchesResult;
+        }
+      }
+      return null;
+    }
+    let pattern = "";
+    for (const match of matches) {
+      if (match.pathname === void 0) continue;
+      pattern += `/${match.pathname}`;
+    }
+    const result = matchUrl(pattern, url);
+    if (result) {
+      return { matches, ...result };
+    }
+    return null;
+  };
+  return _matchRoute([], rootRoute);
+};
+var parseLocationFromHref = (rootRoute, to) => {
+  const result = matchRoute(rootRoute, to);
+  if (!result) return null;
+  return {
+    pathname: to,
+    params: result.params,
+    query: result.query
+  };
+};
+var createRouter = (options) => {
+  return options;
+};
+
+// src/context/locationContext.ts
+import { createContext } from "react";
+var LocationContext = createContext(null);
+
+// src/context/routeContext.ts
+import { createContext as createContext2 } from "react";
+var RouteContext = createContext2(null);
+
+// src/context/routerContext.ts
+import { createContext as createContext3 } from "react";
+var RouterContext = createContext3(null);
+
+// src/hooks/useLocation.ts
+import { useContext } from "react";
+var useLocation = () => {
+  const context = useContext(LocationContext);
+  if (context === null) {
+    throw new Error("useLocation must be used within a LocationProvider");
+  }
+  return context;
+};
+
+// src/hooks/useRoute.ts
+import { useContext as useContext2 } from "react";
+var useRoute = () => {
+  const route = useContext2(RouteContext);
+  if (route === null) {
+    throw new Error("useRoute must be used within a RouteProvider");
+  }
+  return route;
+};
+
+// src/hooks/useMatches.ts
+var useMatches = () => {
+  const route = useRoute();
+  const location = useLocation();
+  if (!location) return [];
+  return matchRoute(route, location.pathname)?.matches || [];
+};
+
+// src/hooks/useRouter.ts
+import { useContext as useContext3 } from "react";
+var useRouter = () => {
+  const router = useContext3(RouterContext);
+  if (router === null) {
+    throw new Error("useRouter must be used within a Stack");
+  }
+  return router;
+};
+export {
+  DefaultTransitionDuration,
+  LocationContext,
+  RouteContext,
+  RouterContext,
+  createRouter,
+  matchRoute,
+  matchUrl,
+  parseLocationFromHref,
+  redirect,
+  useLocation,
+  useMatches,
+  useRoute,
+  useRouter
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/utils.ts","../src/context/locationContext.ts","../src/context/routeContext.ts","../src/context/routerContext.ts","../src/hooks/useLocation.ts","../src/hooks/useRoute.ts","../src/hooks/useMatches.ts","../src/hooks/useRouter.ts"],"sourcesContent":["import type { Location, RootRoute, Route, RouterOptions } from \"./types.js\";\n\nexport const DefaultTransitionDuration = 300;\n\nexport const redirect = (options: { to: string; replace?: boolean }) => {\n  return new Error(\"\", { cause: options });\n};\n\nexport const matchUrl = (\n  pattern: string,\n  url: string\n): { params: Record<string, string>; query: Record<string, string> } | null => {\n  try {\n    // 解析 URL\n    let pathname, searchParams;\n\n    if (url.startsWith(\"http://\") || url.startsWith(\"https://\")) {\n      const urlObj = new URL(url);\n      pathname = urlObj.pathname;\n      searchParams = urlObj.searchParams;\n    } else {\n      // 處理相對路徑\n      const [path, queryString] = url.split(\"?\");\n      if (!path) {\n        return null;\n      }\n      pathname = path;\n      searchParams = new URLSearchParams(queryString || \"\");\n    }\n\n    // 移除路徑首尾的斜線以便比較\n    const cleanPath = pathname.replaceAll(/^\\/|\\/$/g, \"\");\n    const cleanPattern = pattern.replaceAll(/^\\/|\\/$/g, \"\");\n\n    // 分割路徑段\n    const pathSegments = cleanPath.split(\"/\");\n    const patternSegments = cleanPattern.split(\"/\");\n\n    // 路徑段數量不同則不匹配\n    if (pathSegments.length !== patternSegments.length) {\n      return null;\n    }\n\n    // 提取路徑參數\n    const params: Record<string, string> = {};\n    for (let i = 0; i < patternSegments.length; i++) {\n      const patternSegment = patternSegments[i];\n      const pathSegment = pathSegments[i];\n\n      if (patternSegment.startsWith(\":\")) {\n        // 動態參數\n        const paramName = patternSegment.slice(1);\n        params[paramName] = decodeURIComponent(pathSegment);\n      } else if (patternSegment !== pathSegment) {\n        // 靜態段不匹配\n        return null;\n      }\n    }\n\n    // 提取查詢參數\n    const query = Object.fromEntries(searchParams.entries());\n\n    return { params, query };\n  } catch {\n    return null;\n  }\n};\n\nexport const matchRoute = (\n  rootRoute: RootRoute,\n  url: string\n): {\n  matches: Route[];\n  params: Record<string, string>;\n  query: Record<string, string>;\n} | null => {\n  const _matchRoute = (\n    matches: Route[],\n    route: Route\n  ): {\n    matches: Route[];\n    params: Record<string, string>;\n    query: Record<string, string>;\n  } | null => {\n    if (route.children) {\n      for (const childRoute of route.children) {\n        const matchesResult = _matchRoute([...matches, childRoute], childRoute);\n        if (matchesResult) {\n          return matchesResult;\n        }\n      }\n      return null;\n    }\n\n    let pattern = \"\";\n    for (const match of matches) {\n      if (match.pathname === undefined) continue;\n      pattern += `/${match.pathname}`;\n    }\n    const result = matchUrl(pattern, url);\n    if (result) {\n      return { matches, ...result };\n    }\n    return null;\n  };\n\n  return _matchRoute([], rootRoute);\n};\n\nexport const parseLocationFromHref = (\n  rootRoute: RootRoute,\n  to: string\n): Pick<Location, \"pathname\" | \"params\" | \"query\"> | null => {\n  const result = matchRoute(rootRoute, to);\n  if (!result) return null;\n  return {\n    pathname: to,\n    params: result.params,\n    query: result.query,\n  };\n};\n\nexport const createRouter = (options: RouterOptions): RouterOptions => {\n  return options;\n};\n","import { createContext } from \"react\";\n\nimport type { Location } from \"@/types.js\";\n\nexport const LocationContext = createContext<Location | null>(null);\n","import { createContext } from \"react\";\n\nimport type { RootRoute } from \"@/types.js\";\n\nexport const RouteContext = createContext<RootRoute | null>(null);\n","import { createContext } from \"react\";\n\nimport type {\n  BackOptions,\n  ForwardOptions,\n  Location,\n  NavigateOptions,\n  RouterOptions,\n} from \"@/types.js\";\n\nexport interface RouterContextType {\n  // Router Config\n  options: RouterOptions;\n\n  // Navigation State\n  history: Location[];\n  currentLocationIndex: number;\n  location: Location | null;\n  canGoBack: boolean;\n  canGoForward: boolean;\n\n  // Transition state\n  isTransitioning: boolean;\n  transitionDuration: number;\n  transitioningToIndex: number | null;\n\n  // Actions\n  navigate: (options: NavigateOptions) => void;\n  back: (options: BackOptions) => void;\n  forward: (options: ForwardOptions) => void;\n}\n\nexport const RouterContext = createContext<RouterContextType | null>(null);\n","import { useContext } from \"react\";\n\nimport { LocationContext } from \"@/context/locationContext.js\";\n\nexport const useLocation = () => {\n  const context = useContext(LocationContext);\n  if (context === null) {\n    throw new Error(\"useLocation must be used within a LocationProvider\");\n  }\n  return context;\n};\n","import { useContext } from \"react\";\n\nimport { RouteContext } from \"@/context/routeContext.js\";\n\nexport const useRoute = () => {\n  const route = useContext(RouteContext);\n  if (route === null) {\n    throw new Error(\"useRoute must be used within a RouteProvider\");\n  }\n  return route;\n};\n","import { matchRoute } from \"@/utils.js\";\n\nimport { useLocation } from \"./useLocation.js\";\nimport { useRoute } from \"./useRoute.js\";\n\nexport const useMatches = () => {\n  const route = useRoute();\n  const location = useLocation();\n  if (!location) return [];\n  return matchRoute(route, location.pathname)?.matches || [];\n};\n","import { useContext } from \"react\";\n\nimport { RouterContext } from \"@/context/routerContext.js\";\n\nexport const useRouter = () => {\n  const router = useContext(RouterContext);\n  if (router === null) {\n    throw new Error(\"useRouter must be used within a Stack\");\n  }\n  return router;\n};\n"],"mappings":";AAEO,IAAM,4BAA4B;AAElC,IAAM,WAAW,CAAC,YAA+C;AACtE,SAAO,IAAI,MAAM,IAAI,EAAE,OAAO,QAAQ,CAAC;AACzC;AAEO,IAAM,WAAW,CACtB,SACA,QAC6E;AAC7E,MAAI;AAEF,QAAI,UAAU;AAEd,QAAI,IAAI,WAAW,SAAS,KAAK,IAAI,WAAW,UAAU,GAAG;AAC3D,YAAM,SAAS,IAAI,IAAI,GAAG;AAC1B,iBAAW,OAAO;AAClB,qBAAe,OAAO;AAAA,IACxB,OAAO;AAEL,YAAM,CAAC,MAAM,WAAW,IAAI,IAAI,MAAM,GAAG;AACzC,UAAI,CAAC,MAAM;AACT,eAAO;AAAA,MACT;AACA,iBAAW;AACX,qBAAe,IAAI,gBAAgB,eAAe,EAAE;AAAA,IACtD;AAGA,UAAM,YAAY,SAAS,WAAW,YAAY,EAAE;AACpD,UAAM,eAAe,QAAQ,WAAW,YAAY,EAAE;AAGtD,UAAM,eAAe,UAAU,MAAM,GAAG;AACxC,UAAM,kBAAkB,aAAa,MAAM,GAAG;AAG9C,QAAI,aAAa,WAAW,gBAAgB,QAAQ;AAClD,aAAO;AAAA,IACT;AAGA,UAAM,SAAiC,CAAC;AACxC,aAAS,IAAI,GAAG,IAAI,gBAAgB,QAAQ,KAAK;AAC/C,YAAM,iBAAiB,gBAAgB,CAAC;AACxC,YAAM,cAAc,aAAa,CAAC;AAElC,UAAI,eAAe,WAAW,GAAG,GAAG;AAElC,cAAM,YAAY,eAAe,MAAM,CAAC;AACxC,eAAO,SAAS,IAAI,mBAAmB,WAAW;AAAA,MACpD,WAAW,mBAAmB,aAAa;AAEzC,eAAO;AAAA,MACT;AAAA,IACF;AAGA,UAAM,QAAQ,OAAO,YAAY,aAAa,QAAQ,CAAC;AAEvD,WAAO,EAAE,QAAQ,MAAM;AAAA,EACzB,QAAQ;AACN,WAAO;AAAA,EACT;AACF;AAEO,IAAM,aAAa,CACxB,WACA,QAKU;AACV,QAAM,cAAc,CAClB,SACA,UAKU;AACV,QAAI,MAAM,UAAU;AAClB,iBAAW,cAAc,MAAM,UAAU;AACvC,cAAM,gBAAgB,YAAY,CAAC,GAAG,SAAS,UAAU,GAAG,UAAU;AACtE,YAAI,eAAe;AACjB,iBAAO;AAAA,QACT;AAAA,MACF;AACA,aAAO;AAAA,IACT;AAEA,QAAI,UAAU;AACd,eAAW,SAAS,SAAS;AAC3B,UAAI,MAAM,aAAa,OAAW;AAClC,iBAAW,IAAI,MAAM,QAAQ;AAAA,IAC/B;AACA,UAAM,SAAS,SAAS,SAAS,GAAG;AACpC,QAAI,QAAQ;AACV,aAAO,EAAE,SAAS,GAAG,OAAO;AAAA,IAC9B;AACA,WAAO;AAAA,EACT;AAEA,SAAO,YAAY,CAAC,GAAG,SAAS;AAClC;AAEO,IAAM,wBAAwB,CACnC,WACA,OAC2D;AAC3D,QAAM,SAAS,WAAW,WAAW,EAAE;AACvC,MAAI,CAAC,OAAQ,QAAO;AACpB,SAAO;AAAA,IACL,UAAU;AAAA,IACV,QAAQ,OAAO;AAAA,IACf,OAAO,OAAO;AAAA,EAChB;AACF;AAEO,IAAM,eAAe,CAAC,YAA0C;AACrE,SAAO;AACT;;;AC5HA,SAAS,qBAAqB;AAIvB,IAAM,kBAAkB,cAA+B,IAAI;;;ACJlE,SAAS,iBAAAA,sBAAqB;AAIvB,IAAM,eAAeA,eAAgC,IAAI;;;ACJhE,SAAS,iBAAAC,sBAAqB;AAgCvB,IAAM,gBAAgBA,eAAwC,IAAI;;;AChCzE,SAAS,kBAAkB;AAIpB,IAAM,cAAc,MAAM;AAC/B,QAAM,UAAU,WAAW,eAAe;AAC1C,MAAI,YAAY,MAAM;AACpB,UAAM,IAAI,MAAM,oDAAoD;AAAA,EACtE;AACA,SAAO;AACT;;;ACVA,SAAS,cAAAC,mBAAkB;AAIpB,IAAM,WAAW,MAAM;AAC5B,QAAM,QAAQC,YAAW,YAAY;AACrC,MAAI,UAAU,MAAM;AAClB,UAAM,IAAI,MAAM,8CAA8C;AAAA,EAChE;AACA,SAAO;AACT;;;ACLO,IAAM,aAAa,MAAM;AAC9B,QAAM,QAAQ,SAAS;AACvB,QAAM,WAAW,YAAY;AAC7B,MAAI,CAAC,SAAU,QAAO,CAAC;AACvB,SAAO,WAAW,OAAO,SAAS,QAAQ,GAAG,WAAW,CAAC;AAC3D;;;ACVA,SAAS,cAAAC,mBAAkB;AAIpB,IAAM,YAAY,MAAM;AAC7B,QAAM,SAASC,YAAW,aAAa;AACvC,MAAI,WAAW,MAAM;AACnB,UAAM,IAAI,MAAM,uCAAuC;AAAA,EACzD;AACA,SAAO;AACT;","names":["createContext","createContext","useContext","useContext","useContext","useContext"]}

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@modastar/z-router",
+  "version": "0.0.2",
+  "description": "",
+  "keywords": [],
+  "homepage": "https://github.com/xLanStar/z-router#readme",
+  "bugs": {
+    "url": "https://github.com/xLanStar/z-router/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/xLanStar/z-router.git"
+  },
+  "license": "MIT",
+  "author": "Lanstar <danny95624268@gmail.com>",
+  "type": "module",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsup",
+    "build:watch": "tsup --watch",
+    "prepublishOnly": "pnpm run build"
+  },
+  "packageManager": "pnpm@10.23.0",
+  "dependencies": {
+    "react": "^19.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.7",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3"
+  }
+}