@spacego/fe-components 0.0.1-alpha.1

package/lib/types/fe-layouts/basics-layout/components/utils/index.d.ts

@@ -0,0 +1,41 @@
+import { RouteObject } from 'react-router-dom';
+import { MenuItem } from '../../../../router/utils';
+/** RouteNode 类型定义 */
+export type RouteNode = RouteObject & {
+    parentId?: string;
+    children?: RouteNode[];
+    handle?: {
+        title?: string;
+        isIndependentMenu?: boolean;
+        activeRouteMenuId?: string;
+    };
+};
+/**
+ * 规范化路径（统一格式，去除末尾斜杠）
+ */
+export declare function normalizePath(path?: string): string;
+/**
+ * 根据路径查找对应的路由节点
+ * 优先查找子路由，避免匹配到布局路由（如 root）
+ */
+export declare function findRouteByPath(path: string, routeList: RouteNode[]): RouteNode | null;
+/**
+ * 构建路由映射表（id -> RouteNode）
+ */
+export declare function buildRouteMap(routeList: RouteNode[]): Map<string, RouteNode>;
+/**
+ * 根据 id 查找路由节点
+ */
+export declare function getRouteById(id: string, routeMap: Map<string, RouteNode>): RouteNode | null;
+/**
+ * 递归查找父级路由链（从根到当前），根据 isIndependentMenu 过滤层级
+ */
+export declare function findParentRoutes(route: RouteNode, routeMap: Map<string, RouteNode>): RouteNode[];
+/**
+ * 递归查找菜单的父级 key
+ */
+export declare function findMenuParentKeys(targetKey: string, menuList: MenuItem[], parents?: string[]): string[] | null;
+/**
+ * 递归查找菜单项
+ */
+export declare function findMenuByKey(key: string, menuList: MenuItem[]): MenuItem | null;

package/lib/types/fe-layouts/basics-layout/index.d.ts

@@ -0,0 +1 @@
+export default function BasicsLayout(): import("react/jsx-runtime").JSX.Element;

package/lib/types/fe-layouts/blank-layout/index.d.ts

@@ -0,0 +1 @@
+export default function BlankLayout(): import("react/jsx-runtime").JSX.Element;

package/lib/types/fe-layouts/context/context.d.ts

@@ -0,0 +1,7 @@
+import { IGlobalContext } from './global-context';
+export declare const GlobalContext: import('react').Context<IGlobalContext>;
+/**
+ * @name 使用全局上下文
+ * @returns
+ */
+export declare const useGlobal: () => IGlobalContext;

package/lib/types/fe-layouts/context/global-context.provider.d.ts

@@ -0,0 +1,2 @@
+import { IGlobalContextProps } from '.';
+export default function GlobalContextProvider(props: React.PropsWithChildren<IGlobalContextProps>): import("react/jsx-runtime").JSX.Element;

package/lib/types/fe-layouts/context/index.d.ts

@@ -0,0 +1,3 @@
+export * from './context';
+export * from './global-context.d';
+export { default as GlobalContextProvider } from './global-context.provider';

package/lib/types/fe-layouts/index.d.ts

@@ -0,0 +1,6 @@
+export { default as AuthLayout } from './auth-layout';
+export { default as BasicsLayout } from './basics-layout';
+export { default as BlankLayout } from './blank-layout';
+export * from './context';
+export type { IFeLayoutProps } from './layout';
+export { default as FeLayout } from './layout';

package/lib/types/fe-layouts/layout.d.ts

@@ -0,0 +1,7 @@
+export interface IFeLayoutProps {
+    /**
+     * 布局类型，空白布局和后台布局
+     */
+    layoutType: 'blank' | 'basic' | 'auth';
+}
+export default function FeLayout(props: IFeLayoutProps): import("react/jsx-runtime").JSX.Element;

package/lib/types/hooks/index.d.ts

@@ -0,0 +1 @@
+export * from './use-auth.hook';

package/lib/types/hooks/use-auth.hook.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 登录和退出登录的 hook
+ * @returns
+ */
+export declare function useAuth(): {
+    login: (token: string, redirectTo?: string) => void;
+    logout: () => void;
+};

package/lib/types/index.d.ts

@@ -0,0 +1,10 @@
+/**------------------------------------------- utils ------------------------------------------- */
+export * from './utils';
+/**------------------------------------------- store ------------------------------------------- */
+export * from './store';
+/**------------------------------------------- config ------------------------------------------- */
+export * from './config';
+/**------------------------------------------- router ------------------------------------------- */
+export * from './router';
+/**------------------------------------------- components ------------------------------------------- */
+export * from './fe-layouts';

package/lib/types/router/index.d.ts

@@ -0,0 +1,40 @@
+import { ComponentType } from 'react';
+import { RouteObject } from 'react-router-dom';
+import { TokenHelpers } from './permission';
+import { TModule } from './utils';
+export interface CreateRouterOptions {
+    /** 页面模块集合 import.meta.glob的结果 */
+    modules: TModule;
+    /** token 操作方法 */
+    token: TokenHelpers;
+    /** 基础布局组件 */
+    BaseLayout: ComponentType<any>;
+    /** 外部传入的路由配置（第一层，RouteObject结构） */
+    routes?: RouteObject[];
+}
+/**
+ * 创建路由器配置（第一层）
+ * @param options
+ * @returns { routes, permissionHelpers }
+ */
+export declare function createRouter(options: CreateRouterOptions): {
+    /** 最终合并后的路由配置 */
+    routes: RouteObject[];
+    /** 权限帮助函数，包含 ProtectedLoader 等，用于外部调用 processRoutes */
+    permissionHelpers: {
+        RootLoader: () => import('./permission').AuthStatus;
+        ProtectedLoader: ({ request }: import('react-router-dom').LoaderFunctionArgs) => Response | null;
+        LoginLoader: () => Promise<Response | null>;
+        LoginAction: ({ request }: import('react-router-dom').LoaderFunctionArgs) => Promise<boolean | Response>;
+        LogoutAction: () => Response;
+    };
+};
+/**
+ * 生成路由表
+ * @param routes 路由数组
+ * @returns
+ */
+export declare function generateRouter(routes: RouteObject[]): import('react-router-dom').DataRouter;
+export * from './permission';
+export * from './routes';
+export * from './utils';

package/lib/types/router/permission.d.ts

@@ -0,0 +1,23 @@
+import { LoaderFunctionArgs } from 'react-router-dom';
+export type AuthStatus = {
+    token: string | void | null;
+};
+export interface TokenHelpers {
+    /** 获取token */
+    getToken: () => string | void | null;
+    /** 设置token */
+    setToken: (token: string) => void;
+    /** 移除token */
+    removeToken: () => void;
+}
+/**
+ * 创建权限相关的 loader 和 action
+ * @param tokenHelpers token 操作方法
+ */
+export declare function createPermissionHelpers(tokenHelpers: TokenHelpers): {
+    RootLoader: () => AuthStatus;
+    ProtectedLoader: ({ request }: LoaderFunctionArgs) => Response | null;
+    LoginLoader: () => Promise<Response | null>;
+    LoginAction: ({ request }: LoaderFunctionArgs) => Promise<boolean | Response>;
+    LogoutAction: () => Response;
+};

package/lib/types/router/routes.d.ts

@@ -0,0 +1,11 @@
+import { ComponentType } from 'react';
+import { RouteObject } from 'react-router-dom';
+import { createPermissionHelpers } from './permission';
+import { TModule } from './utils';
+/**
+ * 创建默认路由表
+ * @param modules 页面模块集合
+ * @param permissionHelpers 权限相关的 loader 和 action
+ * @param BaseLayout 基础布局组件
+ */
+export declare function createDefaultRoutes(modules: TModule, permissionHelpers: ReturnType<typeof createPermissionHelpers>, BaseLayout: ComponentType<any>): RouteObject[];

package/lib/types/router/utils.d.ts

@@ -0,0 +1,56 @@
+import { ComponentType } from 'react';
+import { RouteObject } from 'react-router-dom';
+import { IRoute, MenuType } from '../typings';
+export type TModule = {
+    [keys in string]: () => Promise<{
+        default: ComponentType<any>;
+    }>;
+};
+/**
+ * 获取页面路径
+ * @param name
+ * @returns
+ */
+export declare function getPath(name: string): string;
+/**
+ * 获取动态页面
+ * @param name
+ * @param modules
+ * @returns
+ */
+export declare function createLazyComponent(name: string, modules: TModule): import('react').LazyExoticComponent<ComponentType<any>> | undefined;
+/** 路由节点类型 */
+type RouteNode = RouteObject & {
+    parentId: string;
+    children?: RouteNode[];
+};
+/** 菜单项类型（用于 antd Menu 组件） */
+export interface MenuItem {
+    key: string;
+    label: string;
+    icon?: string;
+    /** 对应的路由节点信息（不包含 children） */
+    routeNode?: Omit<RouteNode, 'children'>;
+    children?: MenuItem[];
+    menuType?: MenuType;
+    /** 是否独立菜单 */
+    isIndependentMenu?: boolean;
+}
+/** 处理结果类型 */
+export interface ProcessedRoutes {
+    /** react-router 路由配置 */
+    routes: RouteNode[];
+    /** antd Menu 菜单配置 */
+    menus: MenuItem[];
+    /** 按钮权限列表 */
+    permissions: string[];
+}
+/**
+ * 将扁平的 IRoute 数组处理成三份数据
+ * @param rawRoutes 扁平路由数组
+ * @param modules 页面模块集合
+ * @param protectedLoader 受保护路由的加载器
+ * @returns { routes, menus, permissions }
+ */
+export declare function processRoutes(rawRoutes: IRoute[], modules: TModule, protectedLoader?: any): ProcessedRoutes;
+export {};

package/lib/types/store/index.d.ts

@@ -0,0 +1,2 @@
+export * from './modules/layout-config.store';
+export * from './modules/theme.store';