2026-09-30 18:14:16 +08:00

210 lines
8.7 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
* 静态路由表(PAGE_REGISTRY)
*
* 为什么需要它:`pages.json` 只服务于**编译**(微信只认 pages / style / subPackages / tabBar),
* 运行时代码里**读不出来**。而后端 `user.info` 下发的菜单只给**逻辑路径**
* (`wms_permission.path`,形如 `/inbound/list`),前端必须持有一份
* 「逻辑路径 → 物理页面」的运行时映射,才能渲染入口并跳转。
*
* 三条约定(务必遵守):
* 1. `key` = 逻辑路径,**必须与后端 `wms_permission.path`(type='miniprogram_pages')一致**
* 2. `path` = 物理页面路径,**必须与 `pages.json` 完全一致**(页面挪分包 / 改目录名只改这一处)
* 3. **只登记真实存在的页面** —— 登记了 `pages.json` 里没有的页面,用户点进去必然失败
* (用 `npm run check:pages` 校验 1/2/3 是否成立)
*
* 与 new3 的 `router/map.ts`(`componentMap`)是同一个思想:
* **后端只给逻辑标识,前端持有「标识 → 真实页面」的映射**。
*
* 详见《页面渲染框架-设计与任务清单.md》§3.2
*/
/** 页面登录策略 —— 见设计文档 §3.4 */
export type AuthMode = 'public' | 'optional' | 'required'
export interface PageMeta {
/** 逻辑路径:与后端 `wms_permission.path` 对齐(后端只需知道这个,不感知分包/目录) */
key: string
/** 小程序物理页面路径(必须与 `pages.json` 一致,不带 `.vue` 后缀、不带前导 `/`) */
path: string
/** 页面标题:后端菜单未下发 `meta_title` 时的兜底显示名 */
title: string
/** uview-plus 图标名:后端菜单未下发 `meta_icon` 时的兜底 */
icon?: string
/**
* 登录策略:
* - `public` 未登录即可看完整内容
* - `optional` 未登录渲染占位/引导,已登录渲染真实数据
* - `required` 未登录页内提示「请先登录」(**不自动跳转**)
*/
auth: AuthMode
/** 是否 tabBar 页 —— 跳转必须用 `uni.switchTab`,不能用 `navigateTo` */
tabBar?: boolean
/** 是否不进导航入口(九宫格 / 功能菜单):可被跳转,但不作为入口展示 */
hidden?: boolean
/**
* 是否进首页**本地**「常用功能」列表
*
* - **必须显式写 `common: true` 才会进**(不设置 = 不进)
* - 该列表在 `router/entries.ts` 的 `LOCAL_COMMON_ENTRIES`,**与后端菜单无关**:
* 不受登录态 / 授权 / 接口故障 / 后端是否配置影响 → 用来常驻放测试页、公开页这类页面
* - 后端 `miniprogram_pages` 只负责「登录后**还**能看到什么」,
* 在首页以**分类段**(如「外仓商品」)追加在「常用功能」之后;两处重复的 key 会自动去重
*
* ⚠️ `auth: 'public'` 的页面建议一并标 `common: true` —— 否则未登录时首页可能一个入口都没有
*/
common?: boolean
}
export const PAGE_REGISTRY: PageMeta[] = [
// ─────────────── 公共页面:无需登录即可访问,不会被拦截 ───────────────
{
key: '/home',
path: 'pages/index/index',
title: '首页',
icon: 'home',
auth: 'public',
tabBar: true,
// tabBar 本身就是入口,不再进九宫格
hidden: true
},
{
key: '/mine',
path: 'pages/mine/mine',
title: '我的',
icon: 'account',
auth: 'optional',
tabBar: true,
hidden: true
},
{
key: '/mine/user-info',
path: 'pages/mine/user-info',
title: '用户信息',
icon: 'account-fill',
// 未登录也能进(页内引导登录,不自动跳转),故为 optional
auth: 'optional',
// 仅由「我的」页菜单进入,不作为九宫格 / 功能菜单入口
hidden: true
},
{
key: '/login',
path: 'pages/login/login',
title: '登录 / 注册',
icon: 'account-fill',
auth: 'public',
// 由「我的」页主动进入,不作为入口展示
hidden: true
},
{
key: '/login/confirm-login',
path: 'pages/login/confirm-login',
title: '确认登录',
icon: 'checkmark-circle',
// 未登录也能进(页内引导登录),故为 public
auth: 'public',
// 仅由扫码入口(spm 场景 4)navigateTo 进入,不作为入口展示
hidden: true
},
// ──────── 框架示例页(分包 pagesA):验证三态渲染与权限,业务页上线后可删 ────────
{
key: '/demo/public',
path: 'pagesA/demo/public',
title: '公开示例',
icon: 'info-circle',
auth: 'public',
// 未登录也必须有可浏览内容(微信审核要求)→ 常驻首页「常用功能」
common: true
},
{
key: '/demo/required',
path: 'pagesA/demo/required',
title: '需登录示例',
icon: 'lock',
auth: 'required',
// 需登录的页不进公共入口;登录后由后端菜单下发才出现在九宫格
hidden: true
},
{
key: '/test/index',
path: 'pagesA/test/index',
title: '测试页',
icon: 'grid',
auth: 'required',
// 常驻首页「常用功能」:不依赖后端菜单 / 授权,开发联调随时能进
common: true
// 不设 hidden → 登录后后端菜单(wms_permission id=628)也会下发;
// 与本地列表重复,首页会自动去重(只显示一次)
},
// ─────────────── 业务页(分包)───────────────
{
key: '/external-stock/list',
path: 'pagesA/external-stock/list',
title: '外仓商品',
icon: 'bag',
auth: 'required'
// ⚠️ 后端 wms_permission 里这条记录的 path(type='miniprogram_pages')
// 必须与上面的 key **逐字符相等**,否则入口会被忽略并进 permissionStore.missing
// 不设 hidden → 登录后由后端菜单下发才出现,首页以「外仓商品」**分类段**展示
// 未设 common → 不进本地「常用功能」(它属于后端菜单那一侧)
},
{
key: '/external-inventory/receiving',
path: 'pagesA/external-inventory/receiving',
title: '收货单',
// 图标只是**本地兜底**:后端下发 meta_icon 时以后端为准(id=633 目前是 bag)
icon: 'order',
auth: 'required'
// 对应后端 id=633(父节点 632「外仓库存」分类)—— 同样必须与 key 逐字符相等
// 不设 hidden → 登录后由后端菜单下发才出现;不设 common → 走「后端菜单」那一侧
},
{
key: '/external-inventory/report',
path: 'pagesA/external-inventory/report',
title: '库存报表',
// 本地兜底图标;后端 id=637 下发的是 file-text(uview 图标表里存在同名图标)
icon: 'file-text',
auth: 'required'
// 对应后端 id=637(父节点 632「外仓库存」分类,sort=1 排在「收货单」之后)
// 接口 stock.report.searchStore(**货主侧**),见 api/stock/report.ts
}
// ─────────────── 待启用(页面文件就绪后再登记)───────────────
// ⚠️ pagesB / pagesC 目前只有 .gitkeep 占位,**先不登记**:
// 登记了 pages.json 里没有的页面 = 用户点进去必然失败。
// 启用步骤:① 建页面文件 → ② 注册到 pages.json 的 subPackages → ③ 打开下面的注释。
// { key: '/outbound/list', path: 'pagesB/outbound/list', title: '出库', icon: 'car', auth: 'required' },
// { key: '/stocktaking/list', path: 'pagesC/stocktaking/list', title: '盘点', icon: 'list', auth: 'required' },
// { key: '/inventory/list', path: 'pagesC/inventory/list', title: '库存查询', icon: 'search', auth: 'required' }
]
/** 逻辑路径 → 页面元数据(菜单渲染 / 跳转时查表用) */
export const PAGE_MAP = new Map<string, PageMeta>(
PAGE_REGISTRY.map((page) => [page.key, page])
)
/** 物理路径 → 页面元数据(「当前页面反查元数据」时用) */
export const PAGE_BY_PATH = new Map<string, PageMeta>(
PAGE_REGISTRY.map((page) => [page.path, page])
)
/** 按逻辑路径取页面元数据 */
export function getPageByKey(key: string): PageMeta | undefined {
return PAGE_MAP.get(key)
}
/**
* 按物理路径取页面元数据
* 兼容带前导 `/` 的写法(如 `getCurrentPages()` 与手写路径两种习惯)
*/
export function getPageByPath(path: string): PageMeta | undefined {
return PAGE_BY_PATH.get(path.replace(/^\//, ''))
}
/** 是否为 tabBar 页 —— 决定跳转用 `switchTab` 还是 `navigateTo` */
export function isTabBarPage(keyOrPath: string): boolean {
const page = getPageByKey(keyOrPath) || getPageByPath(keyOrPath)
return !!page?.tabBar
}