@e7w/easy-routes 0.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 Kamil Bysiec
+
+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/README.md

@@ -0,0 +1 @@
+# 自用React-router配置

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@e7w/easy-routes",
+  "version": "0.0.1",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "type": "module",
+  "exports": {
+    "types": "./src/index.ts",
+    "import": "./src/index.ts"
+  },
+  "dependencies": {
+    "@e7w/easy-model": "^0.2.1",
+    "nprogress": "^0.2.0",
+    "react": "^19.2.0",
+    "react-router": "^7.13.1",
+    "tailwindcss": "^4.2.1",
+    "zod": "^4.3.6"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@types/node": "^24.10.1",
+    "@types/nprogress": "^0.2.3",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.1.1",
+    "eslint": "^9.39.1",
+    "eslint-plugin-react-hooks": "^7.0.1",
+    "eslint-plugin-react-refresh": "^0.4.24",
+    "globals": "^16.5.0",
+    "typescript": "~5.9.3",
+    "typescript-eslint": "^8.48.0",
+    "vite": "^8.0.0-beta.13",
+    "vitest": "^4.0.18"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "lint": "eslint ."
+  }
+}

package/src/assets/index.css

@@ -0,0 +1,109 @@
+@import "tailwindcss";
+
+/* KEYFRAMES */
+
+@keyframes spin {
+  from {
+    transform: rotate(0);
+  }
+  to {
+    transform: rotate(359deg);
+  }
+}
+
+@keyframes spin3D {
+  from {
+    transform: rotate3d(0.5, 0.5, 0.5, 360deg);
+  }
+  to {
+    transform: rotate3d(0deg);
+  }
+}
+
+@keyframes configure-clockwise {
+  0% {
+    transform: rotate(0);
+  }
+  25% {
+    transform: rotate(90deg);
+  }
+  50% {
+    transform: rotate(180deg);
+  }
+  75% {
+    transform: rotate(270deg);
+  }
+  100% {
+    transform: rotate(360deg);
+  }
+}
+
+@keyframes configure-xclockwise {
+  0% {
+    transform: rotate(45deg);
+  }
+  25% {
+    transform: rotate(-45deg);
+  }
+  50% {
+    transform: rotate(-135deg);
+  }
+  75% {
+    transform: rotate(-225deg);
+  }
+  100% {
+    transform: rotate(-315deg);
+  }
+}
+
+@keyframes pulse {
+  from {
+    opacity: 1;
+    transform: scale(1);
+  }
+  to {
+    opacity: 0.25;
+    transform: scale(0.75);
+  }
+}
+
+/* GRID STYLING */
+.spinner-box {
+  @apply top-0 left-0 w-full h-full flex justify-center items-center bg-transparent fixed z-50 backdrop-blur-sm;
+}
+
+.leo {
+  @apply absolute flex justify-center items-center rounded-full;
+}
+
+.blue-orbit {
+  @apply w-[165px] h-[165px] border-[1px] border-blue-400/70 border-solid animate-[spin3D_3s_linear_0.2s_infinite];
+}
+
+.green-orbit {
+  @apply w-[120px] h-[120px] border-[1px] border-solid border-green-400/70 animate-[spin3D_2s_linear_0s_infinite];
+}
+
+.red-orbit {
+  @apply w-[90px] h-[30px] border-[1px] border-solid border-orange-400/70 animate-[spin3D_1s_linear_0s_infinite];
+}
+
+.white-orbit {
+  @apply w-[60px] h-[60px] border-2 border-solid border-white animate-[spin3D_10s_linear_0s_infinite];
+}
+
+.w1 {
+  transform: rotate3D(1, 1, 1, 90deg);
+}
+
+.w2 {
+  transform: rotate3D(1, 2, 0.5, 90deg);
+}
+
+.w3 {
+  transform: rotate3D(0.5, 1, 2, 90deg);
+}
+
+.markdown-body {
+  background-color: var(--color-base-300);
+}

package/src/components/DefaultOutlet.tsx

@@ -0,0 +1,8 @@
+import type { FC } from "react";
+import { Outlet } from "react-router";
+
+export const DefaultOutlet: FC = () => (
+  <>
+    <Outlet />
+  </>
+);

package/src/components/ErrorBoundary.tsx

@@ -0,0 +1,25 @@
+import type { FC } from "react";
+import { isRouteErrorResponse, useRouteError } from "react-router";
+
+export const ErrorBoundary: FC = () => {
+  const error = useRouteError();
+  return (
+    <div className="flex h-full w-full items-center justify-center">
+      <div className="flex flex-col items-center justify-center">
+        <h1 className="text-2xl font-bold mb-4">Error</h1>
+        <p>Something went wrong.</p>
+        {isRouteErrorResponse(error) && (
+          <>
+            <p className="text-red-300">
+              {error.status} {error.statusText}
+            </p>
+            <p className="text-red-300">{JSON.stringify(error.data)}</p>
+          </>
+        )}
+        {error instanceof Error && (
+          <p className="text-red-300">{error.message}</p>
+        )}
+      </div>
+    </div>
+  );
+};

package/src/components/Loading.tsx

@@ -0,0 +1,23 @@
+import { type FC } from "react";
+import { useDebouncedValue } from "../utils/hooks";
+import { useLoader } from "@e7w/easy-model";
+import "../assets/index.css";
+
+export const Loading: FC = () => {
+  const { isGlobalLoading } = useLoader();
+  const visible = useDebouncedValue(isGlobalLoading);
+  if (!visible) return;
+  return (
+    <div className="spinner-box">
+      <div className="blue-orbit leo"></div>
+
+      <div className="green-orbit leo"></div>
+
+      <div className="red-orbit leo"></div>
+
+      <div className="white-orbit w1 leo"></div>
+      <div className="white-orbit w2 leo"></div>
+      <div className="white-orbit w3 leo"></div>
+    </div>
+  );
+};

package/src/components/ProgressLayout.tsx

@@ -0,0 +1,31 @@
+import { useEffect, type FC } from "react";
+import { Outlet, useNavigation } from "react-router";
+import nProgress from "nprogress";
+import "nprogress/nprogress.css";
+import { Loading } from "./Loading";
+
+nProgress.configure({
+  showSpinner: false, // 是否显示右上角螺旋加载提示（通常关掉更简洁）
+  speed: 500, // 动画速度（毫秒）
+  minimum: 0.1, // 进度条开始时的最小百分比
+  easing: "ease", // 动画缓动函数
+  trickleSpeed: 200, // 进度条自动递增的频率（毫秒）
+});
+
+export const ProgressLayout: FC = () => {
+  const { state } = useNavigation();
+  useEffect(() => {
+    if (state === "loading") {
+      nProgress.start();
+    } else {
+      nProgress.done();
+    }
+  }, [state]);
+
+  return (
+    <>
+      <Outlet />
+      <Loading />
+    </>
+  );
+};

package/src/index.ts

@@ -0,0 +1,3 @@
+export type { Loader } from "./types";
+export { routerSchema } from "./models/system";
+export { routes } from "./router";

package/src/models/system.ts

@@ -0,0 +1,49 @@
+import { inject, loader, provide } from "@e7w/easy-model";
+import z from "zod";
+import type { Ctx } from "../types";
+import type { Params } from "react-router";
+
+export interface RouterSchema {
+  init(): void | Promise<void>;
+  permission: number;
+  defaultTitle?: string;
+}
+
+export const routerSchema: z.ZodType<RouterSchema, RouterSchema> = z.object({
+  init: z.function({
+    output: z.union([z.promise(z.void()), z.void()]),
+  }),
+  permission: z.number(),
+  defaultTitle: z.string().optional(),
+});
+
+export const system = provide(
+  class System {
+    @inject(routerSchema)
+    router: RouterSchema = {
+      init() {},
+      permission: 0,
+      defaultTitle: document.title,
+    };
+
+    @loader.once
+    @loader.load(true)
+    async init() {
+      await this.router.init();
+    }
+
+    hasPermission(permission: number = 0) {
+      return (this.router.permission & permission) === permission;
+    }
+
+    getCtx(params: Params, request: Request, permission = 0): Ctx {
+      return {
+        title: this.router.defaultTitle || document.title,
+        signed: (permission & 1) === 0 || this.hasPermission(1),
+        noPermission: !this.hasPermission(permission),
+        params,
+        query: Object.fromEntries(new URL(request.url).searchParams),
+      };
+    }
+  },
+)();

package/src/router.tsx

@@ -0,0 +1,96 @@
+import type { FC } from "react";
+import { Navigate, redirect, type RouteObject } from "react-router";
+import { DefaultOutlet } from "./components/DefaultOutlet";
+import { ErrorBoundary } from "./components/ErrorBoundary";
+import { ProgressLayout } from "./components/ProgressLayout";
+import type { Meta } from "./types";
+import { system } from "./models/system";
+
+const pages: Record<string, FC> = import.meta.glob("/src/pages/**/index.tsx", {
+  eager: true,
+  import: "Page",
+}) as Record<string, FC>;
+const layouts: Record<string, FC> = import.meta.glob(
+  "/src/pages/**/layout.tsx",
+  {
+    eager: true,
+    import: "Layout",
+  },
+) as Record<string, FC>;
+const metas: Record<string, Meta> = import.meta.glob("/src/pages/**/meta.ts", {
+  eager: true,
+});
+
+const routes: RouteObject[] = [];
+const obj: Record<string, RouteObject> = {};
+const filePaths = new Set(
+  Object.keys({ ...pages, ...layouts }).map((p) =>
+    p.replace(/\/(index|layout)\.tsx$/, ""),
+  ),
+);
+filePaths.forEach((filePath) => {
+  const pagePath = filePath + "/index.tsx";
+  const Page = pages[pagePath];
+  const layoutPath = filePath + "/layout.tsx";
+  const Layout = layouts[layoutPath] || DefaultOutlet;
+  const metaPath = filePath + "/meta.ts";
+  const meta = metas[metaPath] || {};
+  const path =
+    filePath.replace(/.*\/pages/, "").replace(/\[([^\]]+)\]/, ":$1") || "/";
+
+  const hasPage = Boolean(Page);
+  obj[path] = {
+    path,
+    element: <Layout />,
+    children: [
+      {
+        element: hasPage ? <Page /> : <Navigate to="/" replace />,
+        index: true,
+        loader: hasPage
+          ? async ({ params, request }) => {
+              await system.init();
+              const ctx = system.getCtx(params, request, meta.permission);
+              await meta.loader?.(ctx, meta);
+              if (!ctx.signed) return redirect("/login");
+              if (ctx.noPermission) return redirect("/403");
+              document.title = ctx.title;
+              return ctx.data;
+            }
+          : undefined,
+      },
+    ],
+  };
+});
+
+filePaths.forEach((filePath) => {
+  const path =
+    filePath.replace(/.*\/pages/, "").replace(/\[([^\]]+)\]/, ":$1") || "/";
+  if (path === "/") return;
+  const currentObj = obj[path];
+  const segments = path.split("/").filter(Boolean);
+  const paths = ["/"];
+  segments.reduce((acc, curr) => {
+    const newPath = acc + "/" + curr;
+    if (newPath !== path) paths.unshift(newPath);
+    return newPath;
+  }, "");
+  for (let index = 0; index < paths.length; index++) {
+    const p = paths[index];
+    if (obj[p]) {
+      obj[p].children!.push(currentObj);
+      break;
+    }
+  }
+});
+obj["/"].errorElement = <ErrorBoundary />;
+routes.push({
+  path: "/",
+  element: <ProgressLayout />,
+  children: [obj["/"]],
+});
+routes.push({
+  path: "*",
+  element: <Navigate to={obj["/404"] ? "/404" : "/"} replace />,
+});
+
+export { routes };

package/src/types/index.ts

@@ -0,0 +1,18 @@
+import type { Params } from "react-router";
+
+export interface Ctx {
+  title: string;
+  signed: boolean;
+  noPermission: boolean;
+  params: Params;
+  query: Params;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  data?: any;
+}
+
+export type Meta = {
+  permission?: number;
+  loader?: Loader;
+} & Record<string, unknown>;
+
+export type Loader = (ctx: Ctx, meta: Meta) => void | Promise<void>;

package/src/utils/hooks.ts

@@ -0,0 +1,16 @@
+import { useEffect, useRef, useState } from "react";
+
+export function useDebouncedValue<T>(value: T): T {
+  const [result, setResult] = useState(value);
+  const timer = useRef<number | undefined>(undefined);
+  useEffect(() => {
+    clearTimeout(timer.current);
+    timer.current = setTimeout(() => {
+      setResult(value);
+    }, 700);
+    return () => {
+      clearTimeout(timer.current);
+    };
+  }, [result, value]);
+  return result;
+}