@pubinfo-pr/module-rbac 0.234.1 → 0.237.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +74 -0
  2. package/package.json +3 -3
package/README.md ADDED
@@ -0,0 +1,74 @@
1
+ # @pubinfo/module-rbac
2
+
3
+ Pubinfo 的权限与后台管理模块。它既提供 RBAC 相关页面和组件,也负责根据配置注册权限管理路由、初始化路由视图数据,并建立模块内部的 WebSocket 同步能力。
4
+
5
+ ## 它在做什么
6
+
7
+ - 提供 `rbac()` 模块注册函数
8
+ - 支持两种页面来源:
9
+ - 本地静态页面配置
10
+ - `dynamic` 资源管理驱动的动态页面
11
+ - 注册并过滤一整套后台管理路由
12
+ - 初始化视图路由数据和 WebSocket 管理器
13
+ - 导出常用选择器、资源选择组件、字典工具、路由系统工具和 view store
14
+
15
+ ## 基本用法
16
+
17
+ ```ts
18
+ import { rbac } from '@pubinfo/module-rbac';
19
+
20
+ export function setupRbac() {
21
+ return rbac({
22
+ request: basic,
23
+ id: 'RBAC',
24
+ pages: 'dynamic',
25
+ });
26
+ }
27
+ ```
28
+
29
+ 如果使用本地注册路由:
30
+
31
+ ```ts
32
+ rbac({
33
+ request: basic,
34
+ sort: 100,
35
+ pages: {
36
+ AuthorityManage: {
37
+ Resource: true,
38
+ Role: true,
39
+ },
40
+ },
41
+ });
42
+ ```
43
+
44
+ ## 页面范围
45
+
46
+ 从路由定义看,模块默认覆盖这些后台域:
47
+
48
+ - `AuthorityManage`: 资源、角色、角色组、数据权限、组织、用户、租户
49
+ - `SystemManage`: 字典、岗位、区域、分组
50
+ - `SettingManage`: 主题、布局、页面动画、分页、菜单、Tabbar、工具栏、面包屑、其他设置
51
+ - `SafeManage`: 黑白名单、安全设置、水印设置
52
+ - `LogManage`: 登录历史、操作历史
53
+
54
+ ## 主要导出
55
+
56
+ - `rbac`
57
+ - `ResourceSelector`
58
+ - `OrgUserSelector` 相关导出
59
+ - `useWebSocketManager`
60
+ - `useViewStore`
61
+ - 字典工具
62
+ - 路由系统工具
63
+ - `RbacOptions` / `RbacPages`
64
+
65
+ ## 工作方式
66
+
67
+ - 如果 `pages !== 'dynamic'`,模块会调用 `defineAsyncRoutes()` 注入过滤后的本地路由
68
+ - 模块启动时会执行 `viewStore.initializeRouteData()`
69
+ - 同时会初始化 `useWebSocketManager()`,用于模块内部实时同步
70
+ - 之后再异步加载 `routeSystem` 完成路由系统初始化
71
+
72
+ ## 适用场景
73
+
74
+ 适合需要完整后台权限管理能力的 Pubinfo 项目,而不只是简单的按钮鉴权。这个模块本质上是“权限系统 + 后台管理页面集合”。
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@pubinfo-pr/module-rbac",
3
3
  "type": "module",
4
- "version": "0.234.1",
4
+ "version": "0.237.1",
5
5
  "exports": {
6
6
  ".": {
7
7
  "types": "./dist/index.d.ts",
@@ -25,7 +25,7 @@
25
25
  "alova": "^3.5.0",
26
26
  "ant-design-vue": "^4.2.6",
27
27
  "pinia": "^3.0.4",
28
- "pubinfo-pr": "0.234.1"
28
+ "pubinfo-pr": "0.237.1"
29
29
  },
30
30
  "dependencies": {
31
31
  "@destyler/color-picker": "^0.2.6",
@@ -50,7 +50,7 @@
50
50
  "alova": "^3.5.0",
51
51
  "ant-design-vue": "^4.2.6",
52
52
  "pinia": "^3.0.4",
53
- "pubinfo-pr": "0.234.1",
53
+ "pubinfo-pr": "0.237.1",
54
54
  "type-fest": "^5.4.4"
55
55
  },
56
56
  "scripts": {