ding-react-admin 2.0.0 → 2.0.4

package/src/router/guards.tsx

@@ -1,63 +1,63 @@
-import type { ReactElement } from "react";
-import { Navigate } from "react-router-dom";
-import { useAuth } from "../context/AuthProvider";
-import { usePermissions } from "../context/PermissionsProvider";
-
-export function Guard({
-  when,
-  redirect,
-  children,
-}: {
-  when: boolean;
-  redirect: string;
-  children: ReactElement;
-}) {
-  return when ? children : <Navigate to={redirect} replace />;
-}
-
-export function Protected({
-  children,
-  redirectTo = "/login",
-}: {
-  children: ReactElement;
-  redirectTo?: string;
-}) {
-  const { isAuthenticated } = useAuth();
-  return (
-    <Guard when={isAuthenticated} redirect={redirectTo}>
-      {children}
-    </Guard>
-  );
-}
-
-export function GuestOnly({
-  children,
-  redirectTo = "/",
-}: {
-  children: ReactElement;
-  redirectTo?: string;
-}) {
-  const { isAuthenticated } = useAuth();
-  return (
-    <Guard when={!isAuthenticated} redirect={redirectTo}>
-      {children}
-    </Guard>
-  );
-}
-
-export function RequirePermission({
-  permission,
-  redirect,
-  children,
-}: {
-  permission: string;
-  redirect: string;
-  children: ReactElement;
-}) {
-  const can = usePermissions();
-  return (
-    <Guard when={can(permission)} redirect={redirect}>
-      {children}
-    </Guard>
-  );
-}
+import type { ReactElement } from "react";
+import { Navigate } from "react-router-dom";
+import { useAuth } from "../context/AuthProvider";
+import { usePermissions } from "../context/PermissionsProvider";
+
+export function Guard({
+  when,
+  redirect,
+  children,
+}: {
+  when: boolean;
+  redirect: string;
+  children: ReactElement;
+}) {
+  return when ? children : <Navigate to={redirect} replace />;
+}
+
+export function Protected({
+  children,
+  redirectTo = "/login",
+}: {
+  children: ReactElement;
+  redirectTo?: string;
+}) {
+  const { isAuthenticated } = useAuth();
+  return (
+    <Guard when={isAuthenticated} redirect={redirectTo}>
+      {children}
+    </Guard>
+  );
+}
+
+export function GuestOnly({
+  children,
+  redirectTo = "/",
+}: {
+  children: ReactElement;
+  redirectTo?: string;
+}) {
+  const { isAuthenticated } = useAuth();
+  return (
+    <Guard when={!isAuthenticated} redirect={redirectTo}>
+      {children}
+    </Guard>
+  );
+}
+
+export function RequirePermission({
+  permission,
+  redirect,
+  children,
+}: {
+  permission: string;
+  redirect: string;
+  children: ReactElement;
+}) {
+  const can = usePermissions();
+  return (
+    <Guard when={can(permission)} redirect={redirect}>
+      {children}
+    </Guard>
+  );
+}

package/src/router/routeAccess.ts

@@ -1,89 +1,89 @@
-import type { RouteObject } from "react-router-dom";
-import type { AdminRouteChild, AuthRedirects, RouteAccess } from "../types";
-
-export function getRouteAccess(route: AdminRouteChild): RouteAccess {
-  return route.access ?? "protected";
-}
-
-export function partitionAdminRoutes(routes: AdminRouteChild[]) {
-  const guest: AdminRouteChild[] = [];
-  const publicRoutes: AdminRouteChild[] = [];
-  const protectedRoutes: AdminRouteChild[] = [];
-
-  for (const route of routes) {
-    const access = getRouteAccess(route);
-    if (access === "guest") guest.push(route);
-    else if (access === "public") publicRoutes.push(route);
-    else protectedRoutes.push(route);
-  }
-
-  return { guest, public: publicRoutes, protected: protectedRoutes };
-}
-
-/** React Router path segment for a top-level route (`/login` → `login`). */
-export function toRouterSegment(path: string): string {
-  return path.replace(/^\/+/, "");
-}
-
-export function toAbsolutePath(path: string): string {
-  return `/${toRouterSegment(path)}`;
-}
-
-/**
- * Resolve redirect targets from declared routes and optional overrides.
- * Throws when protected or guest routes exist but paths cannot be determined.
- */
-export function deriveAuthPaths(
-  routes: AdminRouteChild[],
-  redirects?: AuthRedirects,
-): { loginPath: string; homePath: string } {
-  const { guest, protected: protectedRoutes } = partitionAdminRoutes(routes);
-  const firstGuest = guest.find((r) => "path" in r && r.path);
-  const indexProtected = protectedRoutes.find(
-    (r) => "index" in r && r.index,
-  );
-  const firstProtectedPath = protectedRoutes.find(
-    (r) => "path" in r && r.path,
-  );
-
-  let loginPath: string | undefined = redirects?.unauthenticated;
-  if (!loginPath && firstGuest && "path" in firstGuest && firstGuest.path) {
-    loginPath = toAbsolutePath(firstGuest.path);
-  }
-
-  let homePath: string | undefined = redirects?.afterLogin;
-  if (!homePath) {
-    if (indexProtected) homePath = "/";
-    else if (
-      firstProtectedPath &&
-      "path" in firstProtectedPath &&
-      firstProtectedPath.path
-    ) {
-      homePath = toAbsolutePath(firstProtectedPath.path);
-    }
-  }
-
-  if (protectedRoutes.length > 0 && !loginPath) {
-    throw new Error(
-      'createAdminRouter: protected routes require redirects.unauthenticated or a guest route (access: "guest").',
-    );
-  }
-
-  if (guest.length > 0 && !homePath) {
-    throw new Error(
-      'createAdminRouter: guest routes require redirects.afterLogin or a protected route (index or path).',
-    );
-  }
-
-  return {
-    loginPath: loginPath ?? "/",
-    homePath: homePath ?? "/",
-  };
-}
-
-export function toProtectedRouteObject(route: AdminRouteChild): RouteObject {
-  if ("index" in route && route.index) {
-    return { index: true, element: route.element };
-  }
-  return { path: route.path!, element: route.element };
-}
+import type { RouteObject } from "react-router-dom";
+import type { AdminRouteChild, AuthRedirects, RouteAccess } from "../types";
+
+export function getRouteAccess(route: AdminRouteChild): RouteAccess {
+  return route.access ?? "protected";
+}
+
+export function partitionAdminRoutes(routes: AdminRouteChild[]) {
+  const guest: AdminRouteChild[] = [];
+  const publicRoutes: AdminRouteChild[] = [];
+  const protectedRoutes: AdminRouteChild[] = [];
+
+  for (const route of routes) {
+    const access = getRouteAccess(route);
+    if (access === "guest") guest.push(route);
+    else if (access === "public") publicRoutes.push(route);
+    else protectedRoutes.push(route);
+  }
+
+  return { guest, public: publicRoutes, protected: protectedRoutes };
+}
+
+/** React Router path segment for a top-level route (`/login` → `login`). */
+export function toRouterSegment(path: string): string {
+  return path.replace(/^\/+/, "");
+}
+
+export function toAbsolutePath(path: string): string {
+  return `/${toRouterSegment(path)}`;
+}
+
+/**
+ * Resolve redirect targets from declared routes and optional overrides.
+ * Throws when protected or guest routes exist but paths cannot be determined.
+ */
+export function deriveAuthPaths(
+  routes: AdminRouteChild[],
+  redirects?: AuthRedirects,
+): { loginPath: string; homePath: string } {
+  const { guest, protected: protectedRoutes } = partitionAdminRoutes(routes);
+  const firstGuest = guest.find((r) => "path" in r && r.path);
+  const indexProtected = protectedRoutes.find(
+    (r) => "index" in r && r.index,
+  );
+  const firstProtectedPath = protectedRoutes.find(
+    (r) => "path" in r && r.path,
+  );
+
+  let loginPath: string | undefined = redirects?.unauthenticated;
+  if (!loginPath && firstGuest && "path" in firstGuest && firstGuest.path) {
+    loginPath = toAbsolutePath(firstGuest.path);
+  }
+
+  let homePath: string | undefined = redirects?.afterLogin;
+  if (!homePath) {
+    if (indexProtected) homePath = "/";
+    else if (
+      firstProtectedPath &&
+      "path" in firstProtectedPath &&
+      firstProtectedPath.path
+    ) {
+      homePath = toAbsolutePath(firstProtectedPath.path);
+    }
+  }
+
+  if (protectedRoutes.length > 0 && !loginPath) {
+    throw new Error(
+      'createAdminRouter: protected routes require redirects.unauthenticated or a guest route (access: "guest").',
+    );
+  }
+
+  if (guest.length > 0 && !homePath) {
+    throw new Error(
+      'createAdminRouter: guest routes require redirects.afterLogin or a protected route (index or path).',
+    );
+  }
+
+  return {
+    loginPath: loginPath ?? "/",
+    homePath: homePath ?? "/",
+  };
+}
+
+export function toProtectedRouteObject(route: AdminRouteChild): RouteObject {
+  if ("index" in route && route.index) {
+    return { index: true, element: route.element };
+  }
+  return { path: route.path!, element: route.element };
+}

package/src/types.ts

@@ -35,6 +35,11 @@ export type AuthAdapter = {
   logout: () => void;
   /** Synchronous read of session (e.g. token). Used after mount and after login/logout. */
   getToken: () => string | null;
+  /**
+   * Label for the account menu in `AdminLayout` (top-right button).
+   * Return `null` when no user is loaded. Defaults to `"User"` when omitted.
+   */
+  getUserLabel?: () => string | null;
 };
 
 /** How a route participates in auth when using `AdminApp` / `createAdminRouter`. */
@@ -77,6 +82,11 @@ export type AdminLayoutProps = {
   loginPath?: string;
   /** localStorage key for sider collapsed state. Default `ding-react-admin-sider-collapsed`. */
   siderCollapsedStorageKey?: string;
+  /**
+   * Sidebar menu search. Enabled by default; pass `false` to hide.
+   * Use an object to customize the placeholder.
+   */
+  navSearch?: boolean | { placeholder?: string };
 };
 
 export type { AuthPageLayoutProps } from "./layouts/AuthPageLayout";

package/src/vite-env.d.ts

@@ -1 +1 @@
-/// <reference types="vite/client" />
+/// <reference types="vite/client" />