mgacn-commonsdk 1.0.3 → 1.0.6

package/README.md

@@ -28,16 +28,68 @@ npm install mgacn-commonsdk
 ## 使用
 
 ```js
+import 'element-plus/dist/index.css';
 import MgacnCommonSdk from 'mgacn-commonsdk';
+// 含全局主题：element-variables / common / reset-element
 import 'mgacn-commonsdk/style.css';
 
 app.use(MgacnCommonSdk, {
   tokenKey: 'your_token_key',
   baseURL: import.meta.env.VITE_API_BASE_URL,
-  systemIdKey: 'mgacn_systemid', // 可选，有的系统需要
+  systemId: '', // 可选；子应用也可接口拿到后 setSystemId
 });
 ```
 
+`style.css` 已包含门户与子系统共用的主题样式（须放在 `element-plus` 样式之后）：
+
+- `element-variables.scss` — 品牌色与 EP 变量
+- `common.scss` — 通用工具类
+- `reset-element.scss` — Element Plus 样式重置
+
+子应用从接口获取 `systemId` 后（接口待定）：
+
+```js
+import { setSystemId } from 'mgacn-commonsdk';
+
+setSystemId(systemId); // 之后请求头会带 systemId
+```
+
+### 按钮权限
+
+`app.use` 时传入权限列表读取函数（通常来自菜单 store 的 `permissions`），SDK 会注册指令并提供 `hasPermission`：
+
+```js
+import { useMenuStore } from '@/store/menuStore';
+
+app.use(MgacnCommonSdk, {
+  tokenKey: 'mgacn_token',
+  getPermissions: () => useMenuStore().permissions,
+});
+```
+
+也可事后设置：
+
+```js
+import { setPermissionGetter, hasPermission, checkPermission } from 'mgacn-commonsdk';
+
+setPermissionGetter(() => useMenuStore().permissions);
+
+hasPermission('menu:add');
+hasPermission(['menu:add', 'menu:edit']); // 且
+hasPermission(['menu:add', 'menu:edit'], 'or'); // 或
+checkPermission(['menu:add'], 'menu:add'); // 纯函数，不依赖 getter
+```
+
+模板指令（`install` 时自动注册）：
+
+```vue
+<el-button v-hasPermission="'menu:add'">新增</el-button>
+<el-button v-hasAnyPermission="'menu:add,menu:edit'">编辑类</el-button>
+<span v-hasNoPermission="'menu:add'">无新增权限时可见</span>
+```
+
+未传入 `getPermissions` / `setPermissionGetter` 时，`hasPermission` 不拦截（恒为 `true`）。
+
 ### 网络请求（宿主使用 .GET / .POST）
 
 先 `app.use` 后，页面里这样调：
@@ -241,7 +293,7 @@ import { createRequest, createApi } from 'mgacn-commonsdk';
 const request = createRequest({
   tokenKey: 'your_token_key',
   baseURL: '/api',
-  systemIdKey: 'mgacn_systemid', // 可选
+  systemId: '', // 可选；也可事后 setSystemId
 });
 const api = createApi(request);
 ```