@litianxiang/portal-core 0.1.9 → 0.1.10

package/README.md

@@ -34,7 +34,8 @@ import {
   createAppRouter,
   createLogoutToAuth,
   calcInactivityAction,
-  createAuthHttpClient
+  createAuthHttpClient,
+  createPermissionHelper
 } from '@litianxiang/portal-core'
 ```
 
@@ -105,6 +106,26 @@ function createAuthHttpClient(options: CreateAuthHttpClientOptions): {
   logoutToAuth: () => void // 同 createLogoutToAuth，便于复用
 }
 ```
+
+`permission` 相关工具简化说明：
+
+```ts
+interface PermissionHelperOptions {
+  // 返回用户 Store 实例，需至少提供 getUserALLMenu 或 getUserPageMenu
+  getUserStore: () => any
+}
+
+interface PermissionHelper {
+  // 判断是否拥有某个页面（路由）权限
+  hasPagePermission: (path: string) => boolean
+  // 判断是否拥有某个按钮权限（约定使用菜单 path 作为唯一标识）
+  hasButtonPermission: (codeOrPath: string) => boolean
+  // 判断是否拥有给定列表中的任意一个权限
+  hasAnyPermission: (codesOrPaths: string[]) => boolean
+}
+
+function createPermissionHelper(options: PermissionHelperOptions): PermissionHelper
+```
 ```
 
 ## 子系统接入步骤
@@ -283,7 +304,37 @@ export { logoutToAuth }
 
 如需完全自定义 http 行为，也可以直接基于前面的 `auth` 工具自行编写拦截器。
 
-### 7. 项目视图目录约定
+### 7.（可选）接入菜单 / 按钮权限判断
+
+在需要做“是否显示某个按钮”或“是否放行某个页面”时，可以使用 `createPermissionHelper` 来基于菜单数据做权限判断：
+
+```ts
+// 例如在某个业务系统的全局 helper 中：
+import { createPermissionHelper } from '@litianxiang/portal-core'
+import { useUserStore } from '@/stores/user'
+
+const permission = createPermissionHelper({
+  getUserStore: () => useUserStore()
+})
+
+// 页面/路由级权限判断（基于菜单的 path，忽略 query 部分）
+permission.hasPagePermission('/system/menu')
+
+// 按钮权限判断（约定后台为按钮类型菜单配置唯一的 path 作为权限码）
+permission.hasButtonPermission('/system/menu:add')
+
+// 任一权限命中即通过（可用于复杂场景）
+permission.hasAnyPermission([
+  '/system/menu:add',
+  '/system/menu:edit'
+])
+```
+
+> 说明：
+> - `createPermissionHelper` 内部会优先使用 `userStore.getUserPageMenu`（包含 page + button），若不存在则退回 `userStore.getUserALLMenu`；
+> - 匹配时仅按基础路径（去掉 `?query`）比较，避免 query 影响权限判断。
+
+### 8. 项目视图目录约定
 
 `portal-core` 会根据后端菜单返回的 `path` 去匹配前端视图，规则如下：
 

package/dist/index.d.ts

@@ -68,4 +68,26 @@ declare function createAuthHttpClient(options: CreateAuthHttpClientOptions): {
     logoutToAuth: () => void;
 };
 
-export { type AppRouterOptions, type CreateAuthHttpClientOptions, type InactivityConfig, type InactivityResult, type LogoutToAuthOptions, calcInactivityAction, createAppRouter, createAuthHttpClient, createLogoutToAuth };
+interface PermissionHelperOptions {
+    /** 返回用户 Store 实例，需至少提供 getUserALLMenu 或 getUserPageMenu */
+    getUserStore: () => any;
+}
+interface PermissionHelper {
+    /**
+     * 判断当前用户是否拥有某个页面（路由）权限
+     * @param path 完整路径，支持携带 query（内部只按基础路径匹配）
+     */
+    hasPagePermission: (path: string) => boolean;
+    /**
+     * 判断当前用户是否拥有某个按钮权限
+     * 约定：按钮权限同样使用菜单的 path 字段作为唯一标识
+     */
+    hasButtonPermission: (codeOrPath: string) => boolean;
+    /**
+     * 判断当前用户是否拥有给定列表中的任意一个权限（页面或按钮）
+     */
+    hasAnyPermission: (codesOrPaths: string[]) => boolean;
+}
+declare function createPermissionHelper(options: PermissionHelperOptions): PermissionHelper;
+
+export { type AppRouterOptions, type CreateAuthHttpClientOptions, type InactivityConfig, type InactivityResult, type LogoutToAuthOptions, type PermissionHelper, type PermissionHelperOptions, calcInactivityAction, createAppRouter, createAuthHttpClient, createLogoutToAuth, createPermissionHelper };

package/dist/index.js

@@ -370,9 +370,66 @@ function createAuthHttpClient(options) {
   );
   return { http, logoutToAuth };
 }
+
+// src/permission.ts
+function normalizePath(raw) {
+  if (!raw) return "";
+  const [base] = raw.split("?");
+  if (!base) return "";
+  return base.startsWith("/") ? base : `/${base}`;
+}
+function findMenuByPath(menuList, targetPath, category) {
+  const target = normalizePath(targetPath);
+  if (!target || !Array.isArray(menuList)) return null;
+  for (const item of menuList) {
+    const current = normalizePath(item?.path);
+    if (current === target) {
+      if (!category || item?.category === category) {
+        return item;
+      }
+    }
+    if (item?.children && item.children.length > 0) {
+      const found = findMenuByPath(item.children, targetPath, category);
+      if (found) return found;
+    }
+  }
+  return null;
+}
+function createPermissionHelper(options) {
+  const { getUserStore } = options;
+  const getMenuTree = () => {
+    const userStore = getUserStore();
+    const pageMenu = userStore?.getUserPageMenu;
+    const allMenu = userStore?.getUserALLMenu;
+    if (Array.isArray(pageMenu)) return pageMenu;
+    if (Array.isArray(allMenu)) return allMenu;
+    return [];
+  };
+  const hasPagePermission = (path) => {
+    const menuTree = getMenuTree();
+    const item = findMenuByPath(menuTree, path);
+    if (!item) return false;
+    return item.category === "page" || item.category === "flow-page";
+  };
+  const hasButtonPermission = (codeOrPath) => {
+    const menuTree = getMenuTree();
+    const item = findMenuByPath(menuTree, codeOrPath, "button");
+    return !!item;
+  };
+  const hasAnyPermission = (codesOrPaths) => {
+    if (!Array.isArray(codesOrPaths) || codesOrPaths.length === 0) return false;
+    return codesOrPaths.some((code) => hasPagePermission(code) || hasButtonPermission(code));
+  };
+  return {
+    hasPagePermission,
+    hasButtonPermission,
+    hasAnyPermission
+  };
+}
 export {
   calcInactivityAction,
   createAppRouter,
   createAuthHttpClient,
-  createLogoutToAuth
+  createLogoutToAuth,
+  createPermissionHelper
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@litianxiang/portal-core",
-  "version": "0.1.9",
+  "version": "0.1.10",
   "private": false,
   "type": "module",
   "main": "dist/index.js",