mirror of
https://github.com/XiaoDaiGua-Ray/ray-template.git
synced 2026-11-20 18:34:13 +08:00
Enforce live session grants for runtime routes and support profile and credential updates in both the backend and demo modes. Add the account settings workspace and document fullstack setup and PC acceptance.
503 lines
13 KiB
TypeScript
503 lines
13 KiB
TypeScript
import { APP_CATCH_KEY } from '@/app-config'
|
||
import { useI18n } from '@/hooks'
|
||
import { getAppRawRoutes } from '@/router/app-route-modules'
|
||
import { FORBIDDEN_ROUTE_PATH, isSystemRoute } from '@/router/constant'
|
||
import { validMenuItemShow, validRole } from '@/router/utils'
|
||
import { joinRoutePath } from '@/router/utils/join-route-path'
|
||
import {
|
||
getRouteAccess,
|
||
validRoutePermission,
|
||
} from '@/router/utils/route-access'
|
||
import type { RouteAccessLocation } from '@/router/utils/route-access'
|
||
import { useKeepAliveActions } from '@/store'
|
||
import type { MenuState } from '@/store/modules/menu/types'
|
||
import type { AnyFn, AppMenuOption, MenuTagOptions } from '@/types'
|
||
import { setStorage } from '@/utils/cache'
|
||
import { equalRouterPath } from '@/utils/equal-router-path'
|
||
import { updateObjectValue } from '@/utils/update-object-value'
|
||
import { pick } from 'lodash-es'
|
||
import { NEllipsis } from 'naive-ui'
|
||
import type { LocationQuery } from 'vue-router'
|
||
import { piniaNavigationHistoryStore } from '../navigation-history'
|
||
import { piniaSigningStore } from '../signing'
|
||
import { pickRouteRecordNormalizedConstant } from './constant'
|
||
import {
|
||
createMenuExtra,
|
||
createMenuIcon,
|
||
getCatchMenuTagOptions,
|
||
updateDocumentTitle,
|
||
} from './utils'
|
||
|
||
/**
|
||
*
|
||
* @param options 当前菜单树
|
||
* @param target 要匹配的路径
|
||
*
|
||
* @returns 菜单树中第一个路径匹配项。
|
||
*/
|
||
export const depthSearchAppMenu = (
|
||
options: AppMenuOption[],
|
||
target: string,
|
||
): AppMenuOption | undefined => {
|
||
for (const option of options) {
|
||
if (equalRouterPath(option.fullPath, target)) return option
|
||
|
||
const nested =
|
||
option.children && depthSearchAppMenu(option.children, target)
|
||
|
||
if (nested) return nested
|
||
}
|
||
}
|
||
|
||
export const piniaMenuStore = defineStore(
|
||
'menu',
|
||
() => {
|
||
const router = useRouter()
|
||
const { push, replace, resolve } = router
|
||
const route = useRoute()
|
||
const { t } = useI18n()
|
||
const { setKeepAliveInclude, retainKeepAliveInclude } =
|
||
useKeepAliveActions()
|
||
|
||
const menuState = reactive<MenuState>({
|
||
menuKey: null, // 当前菜单由实际 URL 决定,不从缓存选择首页。
|
||
options: [], // 菜单列表
|
||
collapsed: false, // 是否折叠菜单
|
||
menuTagOptions: getCatchMenuTagOptions(), // tag 标签菜单
|
||
breadcrumbOptions: [], // 面包屑菜单
|
||
currentMenuOption: null, // 当前激活菜单项
|
||
})
|
||
const signing = piniaSigningStore()
|
||
const navigationHistory = piniaNavigationHistoryStore()
|
||
const menuIndex = new Map<
|
||
string,
|
||
{ option: AppMenuOption; parentPath: string }
|
||
>()
|
||
const cacheTags = () => {
|
||
retainKeepAliveInclude(
|
||
new Set(menuState.menuTagOptions.map(({ name }) => name)),
|
||
)
|
||
setStorage(
|
||
APP_CATCH_KEY.appMenuTagOptions,
|
||
menuState.menuTagOptions.map(
|
||
({
|
||
name,
|
||
key,
|
||
path,
|
||
show,
|
||
meta,
|
||
breadcrumbLabel,
|
||
fullPath,
|
||
closeable,
|
||
}) => ({
|
||
name,
|
||
key,
|
||
path,
|
||
show,
|
||
meta,
|
||
breadcrumbLabel,
|
||
fullPath,
|
||
closeable,
|
||
}),
|
||
),
|
||
)
|
||
}
|
||
|
||
const clearActiveMenu = () => {
|
||
menuState.menuKey = null
|
||
menuState.currentMenuOption = null
|
||
menuState.breadcrumbOptions = []
|
||
setStorage(APP_CATCH_KEY.appMenuKey, null)
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param key menu state key
|
||
* @param value updated value
|
||
* @param cb callback function
|
||
*
|
||
* @description
|
||
* 更新 menu state 指定 key 的值。
|
||
*/
|
||
const updateMenuState = <T extends keyof MenuState>(
|
||
key: T,
|
||
value: Partial<MenuState[T]>,
|
||
cb?: AnyFn,
|
||
) => {
|
||
updateObjectValue(menuState, key, value as MenuState[T], cb)
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param option 菜单项(类似于菜单项的数据结构也可以)
|
||
*
|
||
* @returns 转换后的菜单项
|
||
*
|
||
* @description
|
||
* 将路由项或者类似于菜单项的数据结构转换为菜单项(AppMenu)。
|
||
* 但是,该方法有一个地方需要注意,那就是需要手动设置一下准确的 fullPath,
|
||
* 其实这是一个设计的失误,因为该方法不能准确的感知到 fullPath 应该是什么。
|
||
*
|
||
* @example
|
||
* resolveOption({ path: '/demo', fullPath: '/demo', name: 'Demo', meta: { ... } })
|
||
* resolveOption({ ...VueRouterRouteOption })
|
||
*/
|
||
const resolveOption = (option: AppMenuOption) => {
|
||
const { meta } = option
|
||
const { i18nKey, noLocalTitle } = meta
|
||
|
||
const getLabel = () =>
|
||
i18nKey ? t(i18nKey) : (noLocalTitle ?? option.name ?? option.path)
|
||
const resolved = {
|
||
...option,
|
||
key: option.fullPath,
|
||
label: () => h(NEllipsis, null, { default: getLabel }),
|
||
get breadcrumbLabel() {
|
||
return String(getLabel())
|
||
},
|
||
icon: createMenuIcon(option),
|
||
extra: createMenuExtra(option),
|
||
}
|
||
|
||
return Object.assign(resolved, { show: validMenuItemShow(resolved) })
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param key menu state key
|
||
*
|
||
* @description
|
||
* 设置面包屑。
|
||
*
|
||
* 如果识别到为平级模式,则会自动追加一层面包屑。
|
||
*/
|
||
const setBreadcrumbOptions = (key: string | number) => {
|
||
const trail: AppMenuOption[] = []
|
||
let entry = menuIndex.get(String(key))
|
||
|
||
while (entry) {
|
||
trail.unshift(entry.option)
|
||
entry = menuIndex.get(entry.parentPath)
|
||
}
|
||
|
||
menuState.breadcrumbOptions = trail
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param options menu tag option(s)
|
||
* @param isAppend true: 追加操作(push), false: 覆盖操作
|
||
*
|
||
* @description
|
||
* 设置标签页。
|
||
* 如果传递的 options 为数组,则进行追加操作。
|
||
* 如果传递的 options 为单个对象,则进行覆盖操作。
|
||
*/
|
||
const setMenuTagOptions = (
|
||
options: MenuTagOptions | MenuTagOptions[],
|
||
isAppend = true,
|
||
) => {
|
||
const isArray = Array.isArray(options)
|
||
const arr = (isArray ? [...options] : [options]).filter(
|
||
(option) =>
|
||
option.fullPath !== '/' &&
|
||
!isSystemRoute({ ...option, path: resolve(option.fullPath).path }) &&
|
||
!option.meta.sameLevel &&
|
||
!option.meta.windowOpen,
|
||
)
|
||
|
||
isAppend
|
||
? menuState.menuTagOptions.push(...arr)
|
||
: (menuState.menuTagOptions = arr)
|
||
|
||
cacheTags()
|
||
|
||
if (!menuState.menuTagOptions.length) clearActiveMenu()
|
||
}
|
||
|
||
const updateActiveMenu = (option: AppMenuOption) => {
|
||
setKeepAliveInclude(option)
|
||
updateDocumentTitle(option)
|
||
|
||
if (option.meta.sameLevel) {
|
||
const existing = menuState.breadcrumbOptions.findIndex(
|
||
({ key }) => key === option.key,
|
||
)
|
||
|
||
if (existing < 0) menuState.breadcrumbOptions.push(option)
|
||
else menuState.breadcrumbOptions[existing] = option
|
||
|
||
return
|
||
}
|
||
|
||
const pathname = resolve(option.fullPath).path
|
||
const tagIndex = menuState.menuTagOptions.findIndex(
|
||
({ fullPath }) => resolve(fullPath).path === pathname,
|
||
)
|
||
|
||
if (tagIndex < 0) {
|
||
menuState.menuTagOptions.push(option)
|
||
cacheTags()
|
||
} else if (
|
||
menuState.menuTagOptions[tagIndex].fullPath !== option.fullPath
|
||
) {
|
||
menuState.menuTagOptions[tagIndex] = option
|
||
cacheTags()
|
||
}
|
||
|
||
setBreadcrumbOptions(option.key)
|
||
|
||
if (!menuState.breadcrumbOptions.length)
|
||
menuState.breadcrumbOptions = [option]
|
||
|
||
menuState.currentMenuOption = option
|
||
|
||
if (
|
||
option.show !== false &&
|
||
!option.children?.length &&
|
||
!option.fullPath.includes(':')
|
||
) {
|
||
navigationHistory.recordVisit(pathname)
|
||
}
|
||
|
||
if (menuState.menuKey !== option.key) {
|
||
menuState.menuKey = option.key
|
||
setStorage(APP_CATCH_KEY.appMenuKey, option.key)
|
||
}
|
||
}
|
||
|
||
const changeMenuModelValue = (
|
||
key: string | number,
|
||
option: AppMenuOption,
|
||
query?: LocationQuery,
|
||
) => {
|
||
if (option.meta.windowOpen) {
|
||
window.open(option.meta.windowOpen, '_blank', 'noopener,noreferrer')
|
||
|
||
return
|
||
}
|
||
|
||
const path = String(key)
|
||
|
||
if (route.fullPath === path && !query) updateActiveMenu(option)
|
||
else {
|
||
const target = resolve(path)
|
||
|
||
return push({
|
||
path: target.path,
|
||
hash: target.hash,
|
||
query: { ...target.query, ...query },
|
||
})
|
||
}
|
||
}
|
||
|
||
const optionForRoute = (location: RouteAccessLocation) => {
|
||
const { fullPath: path, matched } = location
|
||
const record = matched.at(-1)
|
||
|
||
if (
|
||
!record ||
|
||
record.redirect ||
|
||
getRouteAccess(router, location) !== 'allowed'
|
||
)
|
||
return
|
||
|
||
const canonicalPath = record.aliasOf?.path ?? record.path
|
||
const menuOption = menuIndex.get(canonicalPath)?.option
|
||
|
||
if (menuOption && !canonicalPath.includes(':'))
|
||
return menuOption.fullPath === path
|
||
? menuOption
|
||
: { ...menuOption, fullPath: path }
|
||
|
||
return {
|
||
...resolveOption({
|
||
...(pick(
|
||
record,
|
||
pickRouteRecordNormalizedConstant,
|
||
) as unknown as AppMenuOption),
|
||
fullPath: path,
|
||
}),
|
||
key: resolve(path).path,
|
||
}
|
||
}
|
||
|
||
const setupAppMenu = async () => {
|
||
const currentRole = signing.signingCallback.role ?? ''
|
||
|
||
menuIndex.clear()
|
||
|
||
const resolveRoutes = (
|
||
routes: AppMenuOption[],
|
||
parentPath: string,
|
||
): AppMenuOption[] => {
|
||
const options: AppMenuOption[] = []
|
||
|
||
for (const curr of routes) {
|
||
if (
|
||
!validRole(curr.meta, currentRole) ||
|
||
!validRoutePermission(curr.meta.requiredPermission)
|
||
)
|
||
continue
|
||
|
||
const fullPath = joinRoutePath(parentPath, curr.path)
|
||
|
||
if (
|
||
'redirect' in curr &&
|
||
typeof curr.redirect === 'string' &&
|
||
getRouteAccess(router, resolve(fullPath), currentRole) !== 'allowed'
|
||
)
|
||
continue
|
||
|
||
const children = curr.children?.length
|
||
? resolveRoutes(curr.children, fullPath)
|
||
: void 0
|
||
|
||
if (children && !children.length) continue
|
||
|
||
const option = resolveOption({ ...curr, fullPath, children })
|
||
|
||
menuIndex.set(fullPath, { option, parentPath })
|
||
|
||
options.push(option)
|
||
}
|
||
|
||
return options
|
||
}
|
||
|
||
menuState.options = resolveRoutes(
|
||
getAppRawRoutes() as AppMenuOption[],
|
||
'',
|
||
)
|
||
menuState.currentMenuOption = null
|
||
menuState.breadcrumbOptions = []
|
||
|
||
const restoredTags = menuState.menuTagOptions.flatMap(({ fullPath }) => {
|
||
if (typeof fullPath !== 'string' || !fullPath.startsWith('/')) return []
|
||
|
||
const option = optionForRoute(resolve(fullPath))
|
||
|
||
return option && !option.meta.sameLevel && !option.meta.windowOpen
|
||
? [option]
|
||
: []
|
||
})
|
||
|
||
menuState.menuTagOptions = [
|
||
...new Map(
|
||
restoredTags.map((option) => [resolve(option.fullPath).path, option]),
|
||
).values(),
|
||
]
|
||
cacheTags()
|
||
|
||
const active = optionForRoute(route)
|
||
|
||
if (active) updateActiveMenu(active)
|
||
else {
|
||
clearActiveMenu()
|
||
|
||
if (getRouteAccess(router, route, currentRole) === 'forbidden')
|
||
await replace({
|
||
path: FORBIDDEN_ROUTE_PATH,
|
||
query: { from: route.fullPath },
|
||
})
|
||
}
|
||
}
|
||
|
||
/**
|
||
*
|
||
* @param collapsed 折叠菜单开关
|
||
*
|
||
* @description
|
||
* 折叠菜单。
|
||
*/
|
||
const collapsedMenu = (collapsed: boolean) =>
|
||
(menuState.collapsed = collapsed)
|
||
|
||
/**
|
||
*
|
||
* @param idx 当前关闭标签索引
|
||
* @param length 裁剪标签页长度
|
||
*
|
||
* @returns 被关闭标签项
|
||
*
|
||
* @description
|
||
* 关闭 menu tag 标签。
|
||
*/
|
||
const spliceMenTagOptions = (idx: number, length = 1) => {
|
||
const r = menuState.menuTagOptions.splice(idx, length)
|
||
|
||
cacheTags()
|
||
|
||
if (!menuState.menuTagOptions.length) clearActiveMenu()
|
||
|
||
return r
|
||
}
|
||
|
||
watch(
|
||
() => [
|
||
signing.signingCallback.role,
|
||
signing.signingCallback.id || signing.signingCallback.name,
|
||
],
|
||
(current, previous) => {
|
||
if (previous?.[1] && current[1] !== previous[1]) {
|
||
menuState.menuTagOptions = []
|
||
|
||
if (!current[1]) {
|
||
menuState.options = []
|
||
menuIndex.clear()
|
||
cacheTags()
|
||
clearActiveMenu()
|
||
|
||
return
|
||
}
|
||
}
|
||
|
||
void setupAppMenu()
|
||
},
|
||
{ immediate: true },
|
||
)
|
||
|
||
watch(
|
||
() => route.fullPath,
|
||
() => {
|
||
const option = optionForRoute(route)
|
||
|
||
if (option) updateActiveMenu(option)
|
||
else clearActiveMenu()
|
||
},
|
||
)
|
||
|
||
watch(
|
||
() => {
|
||
const { i18nKey, noLocalTitle } = route.meta
|
||
|
||
return i18nKey
|
||
? t(i18nKey)
|
||
: (noLocalTitle ?? menuState.currentMenuOption?.breadcrumbLabel)
|
||
},
|
||
(label) => {
|
||
if (label) updateDocumentTitle({ breadcrumbLabel: String(label) })
|
||
},
|
||
{ immediate: true },
|
||
)
|
||
|
||
return {
|
||
...toRefs(menuState),
|
||
changeMenuModelValue,
|
||
collapsedMenu,
|
||
spliceMenTagOptions,
|
||
setMenuTagOptions,
|
||
resolveOption,
|
||
updateMenuState,
|
||
setupAppMenu,
|
||
}
|
||
},
|
||
{
|
||
persist: {
|
||
key: APP_CATCH_KEY.appPiniaMenuStore,
|
||
storage: window.localStorage,
|
||
pick: ['collapsed'],
|
||
},
|
||
},
|
||
)
|