d5655f02e3
* docs(other): update function parameters jsdoc - 移除`vue-router.d.ts`中`activePath`属性的默认值注释。 - 重构`generateRoutes`函数签名，增加`options`参数。 - 调整`authLogin`函数文档，增加`onSuccess`回调函数的说明。 * docs: 删除 `activePath` 属性的默认值注释 在路线文档中，移除了`activePath`属性的默认值注释，以清晰说明其行为。此更改更新了文档内容，使其更准确地反映代码实现。
87 lines
2.0 KiB
TypeScript
87 lines
2.0 KiB
TypeScript
import type {
|
||
AccessModeType,
|
||
GenerateMenuAndRoutesOptions,
|
||
RouteRecordRaw,
|
||
} from '@vben/types';
|
||
|
||
import {
|
||
cloneDeep,
|
||
generateMenus,
|
||
generateRoutesByBackend,
|
||
generateRoutesByFrontend,
|
||
mapTree,
|
||
} from '@vben/utils';
|
||
|
||
async function generateAccessible(
|
||
mode: AccessModeType,
|
||
options: GenerateMenuAndRoutesOptions,
|
||
) {
|
||
const { router } = options;
|
||
|
||
options.routes = cloneDeep(options.routes);
|
||
// 生成路由
|
||
const accessibleRoutes = await generateRoutes(mode, options);
|
||
|
||
// 动态添加到router实例内
|
||
accessibleRoutes.forEach((route) => {
|
||
router.addRoute(route);
|
||
});
|
||
|
||
// 生成菜单
|
||
const accessibleMenus = await generateMenus(accessibleRoutes, options.router);
|
||
|
||
return { accessibleMenus, accessibleRoutes };
|
||
}
|
||
|
||
/**
|
||
* Generate routes
|
||
* @param mode
|
||
* @param options
|
||
*/
|
||
async function generateRoutes(
|
||
mode: AccessModeType,
|
||
options: GenerateMenuAndRoutesOptions,
|
||
) {
|
||
const { forbiddenComponent, roles, routes } = options;
|
||
|
||
let resultRoutes: RouteRecordRaw[] = routes;
|
||
switch (mode) {
|
||
case 'frontend': {
|
||
resultRoutes = await generateRoutesByFrontend(
|
||
routes,
|
||
roles || [],
|
||
forbiddenComponent,
|
||
);
|
||
break;
|
||
}
|
||
case 'backend': {
|
||
resultRoutes = await generateRoutesByBackend(options);
|
||
break;
|
||
}
|
||
}
|
||
|
||
/**
|
||
* 调整路由树，做以下处理：
|
||
* 1. 对未添加redirect的路由添加redirect
|
||
*/
|
||
resultRoutes = mapTree(resultRoutes, (route) => {
|
||
// 如果有redirect或者没有子路由，则直接返回
|
||
if (route.redirect || !route.children || route.children.length === 0) {
|
||
return route;
|
||
}
|
||
const firstChild = route.children[0];
|
||
|
||
// 如果子路由不是以/开头，则直接返回,这种情况需要计算全部父级的path才能得出正确的path，这里不做处理
|
||
if (!firstChild?.path || !firstChild.path.startsWith('/')) {
|
||
return route;
|
||
}
|
||
|
||
route.redirect = firstChild.path;
|
||
return route;
|
||
});
|
||
|
||
return resultRoutes;
|
||
}
|
||
|
||
export { generateAccessible };
|