@befly-addon/admin 1.0.2
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.
- package/LICENSE +201 -0
- package/README.md +179 -0
- package/addon.config.json +13 -0
- package/apis/.gitkeep +0 -0
- package/checks/.gitkeep +0 -0
- package/config/.gitkeep +0 -0
- package/package.json +43 -0
- package/plugins/.gitkeep +0 -0
- package/scripts/.gitkeep +0 -0
- package/tables/.gitkeep +0 -0
- package/tables/admin.json +14 -0
- package/tables/api.json +8 -0
- package/tables/dict.json +8 -0
- package/tables/menu.json +8 -0
- package/tables/role.json +8 -0
- package/types/index.ts +44 -0
- package/util.ts +224 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# Admin 管理后台插件
|
|
2
|
+
|
|
3
|
+
## 功能说明
|
|
4
|
+
|
|
5
|
+
提供管理后台的基础功能,包括:
|
|
6
|
+
|
|
7
|
+
- 管理员注册
|
|
8
|
+
- 管理员登录(支持邮箱和手机号两种方式)
|
|
9
|
+
- 发送短信验证码
|
|
10
|
+
- 获取用户信息
|
|
11
|
+
- 退出登录
|
|
12
|
+
|
|
13
|
+
## API 接口
|
|
14
|
+
|
|
15
|
+
所有接口路由前缀: `/api/admin/`
|
|
16
|
+
|
|
17
|
+
### 1. 注册接口
|
|
18
|
+
|
|
19
|
+
**路由**: `POST /api/admin/register`
|
|
20
|
+
|
|
21
|
+
**请求参数**:
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"name": "管理员姓名",
|
|
26
|
+
"email": "admin@example.com",
|
|
27
|
+
"password": "密码(至少6位)"
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
**响应**:
|
|
32
|
+
|
|
33
|
+
```json
|
|
34
|
+
{
|
|
35
|
+
"code": 0,
|
|
36
|
+
"msg": "注册成功",
|
|
37
|
+
"data": {
|
|
38
|
+
"id": 1,
|
|
39
|
+
"name": "管理员姓名",
|
|
40
|
+
"email": "admin@example.com"
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### 2. 登录接口
|
|
46
|
+
|
|
47
|
+
**路由**: `POST /api/admin/login`
|
|
48
|
+
|
|
49
|
+
**邮箱登录**:
|
|
50
|
+
|
|
51
|
+
```json
|
|
52
|
+
{
|
|
53
|
+
"email": "admin@example.com",
|
|
54
|
+
"password": "密码"
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**手机号登录**:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"phone": "13800138000",
|
|
63
|
+
"code": "验证码"
|
|
64
|
+
}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
**响应**:
|
|
68
|
+
|
|
69
|
+
```json
|
|
70
|
+
{
|
|
71
|
+
"code": 0,
|
|
72
|
+
"msg": "登录成功",
|
|
73
|
+
"data": {
|
|
74
|
+
"token": "JWT Token",
|
|
75
|
+
"userInfo": {
|
|
76
|
+
"id": 1,
|
|
77
|
+
"name": "管理员姓名",
|
|
78
|
+
"email": "admin@example.com",
|
|
79
|
+
"role": "admin",
|
|
80
|
+
"status": 1
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### 3. 发送短信验证码
|
|
87
|
+
|
|
88
|
+
**路由**: `POST /api/admin/sendSmsCode`
|
|
89
|
+
|
|
90
|
+
**请求参数**:
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"phone": "13800138000"
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
**响应**:
|
|
99
|
+
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"code": 0,
|
|
103
|
+
"msg": "验证码已发送",
|
|
104
|
+
"data": {
|
|
105
|
+
"code": "123456" // 仅开发环境返回
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### 4. 获取用户信息
|
|
111
|
+
|
|
112
|
+
**路由**: `GET /api/admin/userInfo`
|
|
113
|
+
|
|
114
|
+
**请求头**:
|
|
115
|
+
|
|
116
|
+
```
|
|
117
|
+
Authorization: Bearer {token}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
**响应**:
|
|
121
|
+
|
|
122
|
+
```json
|
|
123
|
+
{
|
|
124
|
+
"code": 0,
|
|
125
|
+
"msg": "获取成功",
|
|
126
|
+
"data": {
|
|
127
|
+
"id": 1,
|
|
128
|
+
"name": "管理员姓名",
|
|
129
|
+
"email": "admin@example.com",
|
|
130
|
+
"role": "admin",
|
|
131
|
+
"status": 1
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### 5. 退出登录
|
|
137
|
+
|
|
138
|
+
**路由**: `POST /api/admin/logout`
|
|
139
|
+
|
|
140
|
+
**请求头**:
|
|
141
|
+
|
|
142
|
+
```
|
|
143
|
+
Authorization: Bearer {token}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
**响应**:
|
|
147
|
+
|
|
148
|
+
```json
|
|
149
|
+
{
|
|
150
|
+
"code": 0,
|
|
151
|
+
"msg": "退出成功",
|
|
152
|
+
"data": null
|
|
153
|
+
}
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
## 数据库表
|
|
157
|
+
|
|
158
|
+
### admin_admin 表
|
|
159
|
+
|
|
160
|
+
| 字段 | 类型 | 说明 |
|
|
161
|
+
| --------------- | -------------------- | ------------------- |
|
|
162
|
+
| id | int | 主键 ID |
|
|
163
|
+
| name | varchar(50) | 姓名 |
|
|
164
|
+
| email | varchar(100) | 邮箱 |
|
|
165
|
+
| phone | varchar(20) | 手机号 |
|
|
166
|
+
| password | varchar(255) | 密码(加密) |
|
|
167
|
+
| role | enum('admin','user') | 角色 |
|
|
168
|
+
| status | tinyint(1) | 状态(1-启用 0-禁用) |
|
|
169
|
+
| last_login_time | datetime | 最后登录时间 |
|
|
170
|
+
| last_login_ip | varchar(50) | 最后登录 IP |
|
|
171
|
+
| created_at | datetime | 创建时间 |
|
|
172
|
+
| updated_at | datetime | 更新时间 |
|
|
173
|
+
|
|
174
|
+
## 注意事项
|
|
175
|
+
|
|
176
|
+
1. 短信验证码功能需要配置短信服务提供商
|
|
177
|
+
2. 建议在生产环境配置 Redis 来存储验证码和 token 黑名单
|
|
178
|
+
3. 密码使用 bcrypt 加密存储
|
|
179
|
+
4. Token 有效期默认为 7 天
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "admin",
|
|
3
|
+
"title": "管理后台",
|
|
4
|
+
"version": "1.0.0",
|
|
5
|
+
"description": "提供管理后台的基础功能,包括管理员注册、登录、用户信息管理等",
|
|
6
|
+
"author": {
|
|
7
|
+
"name": "Befly Team"
|
|
8
|
+
},
|
|
9
|
+
"keywords": ["admin", "backend", "management"],
|
|
10
|
+
"entry": "index.ts",
|
|
11
|
+
"enabled": true,
|
|
12
|
+
"license": "MIT"
|
|
13
|
+
}
|
package/apis/.gitkeep
ADDED
|
File without changes
|
package/checks/.gitkeep
ADDED
|
File without changes
|
package/config/.gitkeep
ADDED
|
File without changes
|
package/package.json
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@befly-addon/admin",
|
|
3
|
+
"version": "1.0.2",
|
|
4
|
+
"description": "Befly Admin Addon - 管理后台功能组件",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"private": false,
|
|
7
|
+
"publishConfig": {
|
|
8
|
+
"access": "public",
|
|
9
|
+
"registry": "https://registry.npmjs.org"
|
|
10
|
+
},
|
|
11
|
+
"main": "addon.config.json",
|
|
12
|
+
"files": [
|
|
13
|
+
"addon.config.json",
|
|
14
|
+
"apis",
|
|
15
|
+
"checks",
|
|
16
|
+
"config",
|
|
17
|
+
"plugins",
|
|
18
|
+
"scripts",
|
|
19
|
+
"tables",
|
|
20
|
+
"types",
|
|
21
|
+
"util.ts",
|
|
22
|
+
"README.md"
|
|
23
|
+
],
|
|
24
|
+
"keywords": [
|
|
25
|
+
"befly",
|
|
26
|
+
"addon",
|
|
27
|
+
"admin",
|
|
28
|
+
"rbac",
|
|
29
|
+
"auth",
|
|
30
|
+
"typescript"
|
|
31
|
+
],
|
|
32
|
+
"author": "chenbimo",
|
|
33
|
+
"license": "Apache-2.0",
|
|
34
|
+
"repository": {
|
|
35
|
+
"type": "git",
|
|
36
|
+
"url": "https://github.com/chenbimo/befly.git",
|
|
37
|
+
"directory": "packages/addon-admin"
|
|
38
|
+
},
|
|
39
|
+
"peerDependencies": {
|
|
40
|
+
"befly": "^3.0.0"
|
|
41
|
+
},
|
|
42
|
+
"gitHead": "66e103e5effbb89dd6de894972766fa1a03d564e"
|
|
43
|
+
}
|
package/plugins/.gitkeep
ADDED
|
File without changes
|
package/scripts/.gitkeep
ADDED
|
File without changes
|
package/tables/.gitkeep
ADDED
|
File without changes
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "姓名|string|2|50|null|0|null",
|
|
3
|
+
"nickname": "昵称|string|2|50|null|0|null",
|
|
4
|
+
"email": "邮箱|string|5|100|null|1|^[\\w.-]+@[\\w.-]+\\.\\w+$",
|
|
5
|
+
"phone": "手机号|string|11|11|null|0|^1[3-9]\\d{9}$",
|
|
6
|
+
"username": "用户名|string|3|30|null|0|^[a-zA-Z0-9_]+$",
|
|
7
|
+
"password": "密码|string|6|500|null|0|null",
|
|
8
|
+
"avatar": "头像|string|0|500|null|0|null",
|
|
9
|
+
"roleId": "角色ID|number|1|999999999999999|null|1|null",
|
|
10
|
+
"roleCode": "角色编码|string|2|50|null|0|^[a-zA-Z0-9_]+$",
|
|
11
|
+
"roleType": "角色类型|string|4|5|user|1|^(admin|user)$",
|
|
12
|
+
"lastLoginTime": "最后登录时间|number|0|null|0|0|null",
|
|
13
|
+
"lastLoginIp": "最后登录IP|string|0|50|null|0|null"
|
|
14
|
+
}
|
package/tables/api.json
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "接口名称|string|2|100|null|1|null",
|
|
3
|
+
"path": "接口路径|string|1|200|null|1|null",
|
|
4
|
+
"method": "请求方法|string|3|10|POST|1|^(GET|POST|PUT|DELETE|PATCH)$",
|
|
5
|
+
"description": "接口描述|string|0|500|null|0|null",
|
|
6
|
+
"addonName": "所属插件|string|0|50|null|0|null",
|
|
7
|
+
"addonTitle": "插件标题|string|0|100|null|0|null"
|
|
8
|
+
}
|
package/tables/dict.json
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "字典名称|string|2|50|null|1|null",
|
|
3
|
+
"code": "字典代码|string|2|50|null|1|^[a-zA-Z0-9_]+$",
|
|
4
|
+
"value": "字典值|string|0|200|null|1|null",
|
|
5
|
+
"sort": "排序|number|0|9999|0|0|null",
|
|
6
|
+
"pid": "父级ID|number|0|999999999999999|0|1|null",
|
|
7
|
+
"description": "描述|string|0|200|null|0|null"
|
|
8
|
+
}
|
package/tables/menu.json
ADDED
package/tables/role.json
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "角色名称|string|2|50|null|1|null",
|
|
3
|
+
"code": "角色编码|string|2|50|null|1|^[a-zA-Z0-9_]+$",
|
|
4
|
+
"description": "角色描述|string|0|200|null|0|null",
|
|
5
|
+
"menus": "菜单权限|array_text|null|null|null|0|null",
|
|
6
|
+
"apis": "接口权限|array_text|null|null|null|0|null",
|
|
7
|
+
"sort": "排序|number|0|9999|0|0|null"
|
|
8
|
+
}
|
package/types/index.ts
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin 相关的类型定义
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
// 管理员信息
|
|
6
|
+
export interface Admin {
|
|
7
|
+
id: number;
|
|
8
|
+
name: string;
|
|
9
|
+
email: string;
|
|
10
|
+
phone?: string;
|
|
11
|
+
password: string;
|
|
12
|
+
role: 'admin' | 'user';
|
|
13
|
+
state: 0 | 1 | 2; // 0=删除, 1=正常, 2=禁用
|
|
14
|
+
last_login_time?: string;
|
|
15
|
+
last_login_ip?: string;
|
|
16
|
+
created_at?: string;
|
|
17
|
+
updated_at?: string;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
// 登录请求
|
|
21
|
+
export interface LoginRequest {
|
|
22
|
+
email?: string;
|
|
23
|
+
password?: string;
|
|
24
|
+
phone?: string;
|
|
25
|
+
code?: string;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
// 登录响应
|
|
29
|
+
export interface LoginResponse {
|
|
30
|
+
token: string;
|
|
31
|
+
userInfo: Omit<Admin, 'password'>;
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
// 注册请求
|
|
35
|
+
export interface RegisterRequest {
|
|
36
|
+
name: string;
|
|
37
|
+
email: string;
|
|
38
|
+
password: string;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
// 发送验证码请求
|
|
42
|
+
export interface SendSmsCodeRequest {
|
|
43
|
+
phone: string;
|
|
44
|
+
}
|
package/util.ts
ADDED
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Admin 插件通用工具函数
|
|
3
|
+
*/
|
|
4
|
+
|
|
5
|
+
import { Logger } from 'befly';
|
|
6
|
+
import type { BeflyContext } from 'befly/types/befly';
|
|
7
|
+
import { readdirSync, statSync, readFileSync } from 'node:fs';
|
|
8
|
+
import path from 'node:path';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* 递归扫描目录下的所有 .ts 文件
|
|
12
|
+
* @param dir - 目录路径
|
|
13
|
+
* @param fileList - 文件列表
|
|
14
|
+
* @returns 文件路径数组
|
|
15
|
+
*/
|
|
16
|
+
export function scanTsFiles(dir: string, fileList: string[] = []): string[] {
|
|
17
|
+
try {
|
|
18
|
+
const files = readdirSync(dir);
|
|
19
|
+
|
|
20
|
+
for (const file of files) {
|
|
21
|
+
const filePath = path.join(dir, file);
|
|
22
|
+
const stat = statSync(filePath);
|
|
23
|
+
|
|
24
|
+
if (stat.isDirectory()) {
|
|
25
|
+
// 递归扫描子目录
|
|
26
|
+
scanTsFiles(filePath, fileList);
|
|
27
|
+
} else if (file.endsWith('.ts') && !file.endsWith('.d.ts')) {
|
|
28
|
+
fileList.push(filePath);
|
|
29
|
+
}
|
|
30
|
+
}
|
|
31
|
+
} catch (error: any) {
|
|
32
|
+
Logger.warn(`扫描目录失败: ${dir}`, error.message);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return fileList;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* 检查数据表是否存在
|
|
40
|
+
* @param helper - DbHelper 实例
|
|
41
|
+
* @param tableName - 表名
|
|
42
|
+
* @returns 是否存在
|
|
43
|
+
*/
|
|
44
|
+
export async function checkTableExists(helper: any, tableName: string): Promise<boolean> {
|
|
45
|
+
Logger.info('=== 检查数据表 ===');
|
|
46
|
+
const exists = await helper.tableExists(tableName);
|
|
47
|
+
|
|
48
|
+
if (!exists) {
|
|
49
|
+
Logger.error(`❌ 表 ${tableName} 不存在,请先运行 befly syncDb 同步数据库`);
|
|
50
|
+
return false;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
Logger.info(`✅ 表 ${tableName} 存在`);
|
|
54
|
+
return true;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
/**
|
|
58
|
+
* 删除数据库中不存在于配置的记录
|
|
59
|
+
* @param helper - DbHelper 实例
|
|
60
|
+
* @param tableName - 表名
|
|
61
|
+
* @param configPaths - 配置中的路径集合
|
|
62
|
+
* @param pathField - 路径字段名(默认为 'path')
|
|
63
|
+
* @returns 删除数量
|
|
64
|
+
*/
|
|
65
|
+
export async function deleteObsoleteRecords(helper: any, tableName: string, configPaths: Set<string>, pathField: string = 'path'): Promise<number> {
|
|
66
|
+
Logger.info(`\n=== 删除配置中不存在的记录 ===`);
|
|
67
|
+
|
|
68
|
+
const allRecords = await helper.getAll({
|
|
69
|
+
table: tableName,
|
|
70
|
+
fields: ['id', pathField, 'name']
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
let deletedCount = 0;
|
|
74
|
+
for (const record of allRecords) {
|
|
75
|
+
if (record[pathField] && !configPaths.has(record[pathField])) {
|
|
76
|
+
await helper.delData({
|
|
77
|
+
table: tableName,
|
|
78
|
+
where: { id: record.id }
|
|
79
|
+
});
|
|
80
|
+
deletedCount++;
|
|
81
|
+
Logger.info(` └ 删除记录: ${record.name} (ID: ${record.id}, ${pathField}: ${record[pathField]})`);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
if (deletedCount === 0) {
|
|
86
|
+
Logger.info(' ✅ 无需删除的记录');
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
return deletedCount;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* 输出同步统计信息
|
|
94
|
+
* @param stats - 统计对象
|
|
95
|
+
* @param deletedCount - 删除数量
|
|
96
|
+
* @param resourceName - 资源名称(如:菜单、接口)
|
|
97
|
+
*/
|
|
98
|
+
export function logSyncStats(stats: { created: number; updated: number }, deletedCount: number, resourceName: string = '记录'): void {
|
|
99
|
+
Logger.info(`\n=== ${resourceName}同步完成 ===`);
|
|
100
|
+
Logger.info(`新增${resourceName}: ${stats.created} 个`);
|
|
101
|
+
Logger.info(`更新${resourceName}: ${stats.updated} 个`);
|
|
102
|
+
Logger.info(`删除${resourceName}: ${deletedCount} 个`);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
/**
|
|
106
|
+
* 缓存角色权限到 Redis Set(增量更新)
|
|
107
|
+
* @param befly - Befly 上下文
|
|
108
|
+
* @param roleCode - 角色代码
|
|
109
|
+
* @param apiIds - 接口 ID 数组(逗号分隔的字符串)
|
|
110
|
+
*/
|
|
111
|
+
export async function cacheRolePermissions(befly: BeflyContext, roleCode: string, apiIds: string): Promise<void> {
|
|
112
|
+
try {
|
|
113
|
+
if (!apiIds) {
|
|
114
|
+
// 如果没有权限,删除缓存
|
|
115
|
+
await befly.redis.del(`role:apis:${roleCode}`);
|
|
116
|
+
Logger.debug(`已删除角色 ${roleCode} 的权限缓存(无权限)`);
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
// 解析接口 ID 列表
|
|
121
|
+
const apiIdArray = apiIds
|
|
122
|
+
.split(',')
|
|
123
|
+
.map((id: string) => parseInt(id.trim()))
|
|
124
|
+
.filter((id: number) => !isNaN(id));
|
|
125
|
+
|
|
126
|
+
if (apiIdArray.length === 0) {
|
|
127
|
+
await befly.redis.del(`role:apis:${roleCode}`);
|
|
128
|
+
Logger.debug(`已删除角色 ${roleCode} 的权限缓存(ID 列表为空)`);
|
|
129
|
+
return;
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
// 查询所有接口
|
|
133
|
+
const allApis = await befly.db.getAll({
|
|
134
|
+
table: 'addon_admin_api',
|
|
135
|
+
fields: ['id', 'path', 'method']
|
|
136
|
+
});
|
|
137
|
+
|
|
138
|
+
// 根据 ID 过滤出接口路径
|
|
139
|
+
const roleApiPaths = allApis.filter((api: any) => apiIdArray.includes(api.id)).map((api: any) => `${api.method}${api.path}`);
|
|
140
|
+
|
|
141
|
+
if (roleApiPaths.length === 0) {
|
|
142
|
+
await befly.redis.del(`role:apis:${roleCode}`);
|
|
143
|
+
Logger.debug(`已删除角色 ${roleCode} 的权限缓存(无匹配接口)`);
|
|
144
|
+
return;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
// 使用 Redis Set 缓存(先删除再添加,确保数据一致性)
|
|
148
|
+
const redisKey = `role:apis:${roleCode}`;
|
|
149
|
+
await befly.redis.del(redisKey);
|
|
150
|
+
const result = await befly.redis.sadd(redisKey, roleApiPaths);
|
|
151
|
+
|
|
152
|
+
Logger.debug(`已缓存角色 ${roleCode} 的权限: ${result} 个接口`);
|
|
153
|
+
} catch (error: any) {
|
|
154
|
+
Logger.warn(`缓存角色 ${roleCode} 权限失败:`, error?.message || '未知错误');
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
/**
|
|
159
|
+
* 删除角色权限缓存
|
|
160
|
+
* @param befly - Befly 上下文
|
|
161
|
+
* @param roleCode - 角色代码
|
|
162
|
+
*/
|
|
163
|
+
export async function deleteRolePermissions(befly: BeflyContext, roleCode: string): Promise<void> {
|
|
164
|
+
try {
|
|
165
|
+
await befly.redis.del(`role:apis:${roleCode}`);
|
|
166
|
+
Logger.debug(`已删除角色 ${roleCode} 的权限缓存`);
|
|
167
|
+
} catch (error: any) {
|
|
168
|
+
Logger.warn(`删除角色 ${roleCode} 权限缓存失败:`, error?.message || '未知错误');
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* 获取插件列表
|
|
174
|
+
* @returns 插件列表
|
|
175
|
+
*/
|
|
176
|
+
export function getAddonList(): Array<{ name: string; title: string; version: string; description: string; enabled: boolean }> {
|
|
177
|
+
const addonList: Array<{ name: string; title: string; version: string; description: string; enabled: boolean }> = [];
|
|
178
|
+
|
|
179
|
+
// 获取 addons 目录路径
|
|
180
|
+
const addonsDir = path.join(process.cwd(), 'addons');
|
|
181
|
+
|
|
182
|
+
try {
|
|
183
|
+
const addonNames = readdirSync(addonsDir);
|
|
184
|
+
|
|
185
|
+
for (const addonName of addonNames) {
|
|
186
|
+
const addonPath = path.join(addonsDir, addonName);
|
|
187
|
+
const stat = statSync(addonPath);
|
|
188
|
+
|
|
189
|
+
// 只处理目录
|
|
190
|
+
if (!stat.isDirectory()) {
|
|
191
|
+
continue;
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
// 读取插件配置文件
|
|
195
|
+
const configPath = path.join(addonPath, 'addon.config.json');
|
|
196
|
+
|
|
197
|
+
try {
|
|
198
|
+
const configContent = readFileSync(configPath, 'utf-8');
|
|
199
|
+
const config = JSON.parse(configContent);
|
|
200
|
+
|
|
201
|
+
addonList.push({
|
|
202
|
+
name: config.name || addonName,
|
|
203
|
+
title: config.title || addonName,
|
|
204
|
+
version: config.version || '1.0.0',
|
|
205
|
+
description: config.description || '',
|
|
206
|
+
enabled: true
|
|
207
|
+
});
|
|
208
|
+
} catch (error) {
|
|
209
|
+
// 配置文件不存在或解析失败,使用默认值
|
|
210
|
+
addonList.push({
|
|
211
|
+
name: addonName,
|
|
212
|
+
title: addonName,
|
|
213
|
+
version: '1.0.0',
|
|
214
|
+
description: '',
|
|
215
|
+
enabled: true
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
}
|
|
219
|
+
} catch (error: any) {
|
|
220
|
+
Logger.warn(`扫描插件目录失败:`, error?.message || '未知错误');
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
return addonList;
|
|
224
|
+
}
|