@zhin.js/console 1.0.0
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 +21 -0
- package/README.md +161 -0
- package/lib/index.d.ts +18 -0
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +174 -0
- package/lib/index.js.map +1 -0
- package/package.json +45 -0
- package/src/index.ts +195 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 凉菜
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
# @zhin.js/console
|
|
2
|
+
|
|
3
|
+
Zhin 机器人框架的 Web 控制台插件,提供开发环境下的可视化管理界面和调试工具。
|
|
4
|
+
|
|
5
|
+
## 功能特性
|
|
6
|
+
|
|
7
|
+
- 🌐 基于 Vite 的开发服务器
|
|
8
|
+
- 🔥 支持热模块替换 (HMR)
|
|
9
|
+
- 📊 实时状态监控
|
|
10
|
+
- 🔧 插件开发调试
|
|
11
|
+
- 📝 日志实时查看
|
|
12
|
+
- 🛠️ 开发工具集成
|
|
13
|
+
- 📱 WebSocket 实时通信
|
|
14
|
+
|
|
15
|
+
## 技术架构
|
|
16
|
+
|
|
17
|
+
- **构建工具**: Vite 7.x
|
|
18
|
+
- **前端框架**: Vue 3 + TypeScript
|
|
19
|
+
- **开发服务器**: 集成到 Koa 路由
|
|
20
|
+
- **WebSocket**: 实时数据同步
|
|
21
|
+
- **组件解析**: unplugin-vue-components
|
|
22
|
+
- **UI组件**: PrimeVue 自动导入
|
|
23
|
+
|
|
24
|
+
## 安装
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
npm install @zhin.js/console
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## 使用
|
|
31
|
+
|
|
32
|
+
### 基本配置
|
|
33
|
+
|
|
34
|
+
```javascript
|
|
35
|
+
// 在插件中使用
|
|
36
|
+
import '@zhin.js/console'
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
插件会自动:
|
|
40
|
+
1. 启动 Vite 开发服务器
|
|
41
|
+
2. 配置路由中间件
|
|
42
|
+
3. 设置 WebSocket 连接
|
|
43
|
+
4. 提供静态文件服务
|
|
44
|
+
|
|
45
|
+
### 访问地址
|
|
46
|
+
|
|
47
|
+
默认情况下,控制台可以通过以下地址访问:
|
|
48
|
+
```
|
|
49
|
+
http://localhost:8086/vite/
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## 核心功能
|
|
53
|
+
|
|
54
|
+
### Web 服务器集成
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
interface WebServer {
|
|
58
|
+
vite: ViteDevServer // Vite开发服务器
|
|
59
|
+
addEntry(entry: string): () => void // 添加入口文件
|
|
60
|
+
entries: Record<string, string> // 入口文件映射
|
|
61
|
+
ws: WebSocketServer // WebSocket服务器
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### 实时数据同步
|
|
66
|
+
|
|
67
|
+
- 📡 WebSocket 连接管理
|
|
68
|
+
- 🔄 动态入口文件更新
|
|
69
|
+
- 📊 状态实时同步
|
|
70
|
+
- 🔥 热更新支持
|
|
71
|
+
|
|
72
|
+
### 开发工具
|
|
73
|
+
|
|
74
|
+
- 🐛 调试信息展示
|
|
75
|
+
- 📝 实时日志查看
|
|
76
|
+
- 🔍 错误追踪
|
|
77
|
+
- ⚡ 性能监控
|
|
78
|
+
|
|
79
|
+
## 配置选项
|
|
80
|
+
|
|
81
|
+
### Vite 配置
|
|
82
|
+
|
|
83
|
+
```javascript
|
|
84
|
+
{
|
|
85
|
+
root: '@zhin.js/client/app',
|
|
86
|
+
base: '/vite/',
|
|
87
|
+
plugins: [
|
|
88
|
+
vue(),
|
|
89
|
+
Components({
|
|
90
|
+
resolvers: [PrimeVueResolver()]
|
|
91
|
+
})
|
|
92
|
+
],
|
|
93
|
+
server: {
|
|
94
|
+
middlewareMode: true
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### 路由配置
|
|
100
|
+
|
|
101
|
+
- 支持所有路由通过 Vite 处理
|
|
102
|
+
- 静态文件自动服务
|
|
103
|
+
- 动态入口文件管理
|
|
104
|
+
- SPA 路由支持
|
|
105
|
+
|
|
106
|
+
## 开发
|
|
107
|
+
|
|
108
|
+
### 项目结构
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
src/
|
|
112
|
+
├── index.ts # 主入口,集成Vite服务器
|
|
113
|
+
└── types/ # TypeScript类型定义
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 构建
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
npm run build # 构建插件
|
|
120
|
+
npm run clean # 清理构建文件
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## WebSocket API
|
|
124
|
+
|
|
125
|
+
### 消息类型
|
|
126
|
+
|
|
127
|
+
```typescript
|
|
128
|
+
// 同步数据
|
|
129
|
+
{ type: 'sync', data: { key: string, value: any } }
|
|
130
|
+
|
|
131
|
+
// 添加数据
|
|
132
|
+
{ type: 'add', data: { key: string, value: any } }
|
|
133
|
+
|
|
134
|
+
// 删除数据
|
|
135
|
+
{ type: 'delete', data: { key: string, value: any } }
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## 依赖项
|
|
139
|
+
|
|
140
|
+
### 核心依赖
|
|
141
|
+
- `@vitejs/plugin-vue` - Vue插件支持
|
|
142
|
+
- `koa-connect` - Koa中间件集成
|
|
143
|
+
- `vue` - Vue框架
|
|
144
|
+
- `vite` - 构建工具
|
|
145
|
+
|
|
146
|
+
### 对等依赖
|
|
147
|
+
- `@zhin.js/client` - 客户端代码
|
|
148
|
+
- `@zhin.js/http` - HTTP服务器
|
|
149
|
+
- `unplugin-vue-components` - 组件自动导入
|
|
150
|
+
- `@primevue/auto-import-resolver` - PrimeVue组件解析
|
|
151
|
+
|
|
152
|
+
## 使用场景
|
|
153
|
+
|
|
154
|
+
- 🧪 插件开发和调试
|
|
155
|
+
- 📊 机器人状态监控
|
|
156
|
+
- 🔍 问题诊断和分析
|
|
157
|
+
- 🛠️ 开发环境管理
|
|
158
|
+
|
|
159
|
+
## 许可证
|
|
160
|
+
|
|
161
|
+
MIT License
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { WebSocketServer } from 'ws';
|
|
2
|
+
import { ViteDevServer } from 'vite';
|
|
3
|
+
declare module '@zhin.js/types' {
|
|
4
|
+
interface GlobalContext {
|
|
5
|
+
web: WebServer;
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
export type WebEntry = string | {
|
|
9
|
+
production: string;
|
|
10
|
+
development: string;
|
|
11
|
+
};
|
|
12
|
+
export type WebServer = {
|
|
13
|
+
vite: ViteDevServer;
|
|
14
|
+
addEntry(entry: WebEntry): () => void;
|
|
15
|
+
entries: Record<string, string>;
|
|
16
|
+
ws: WebSocketServer;
|
|
17
|
+
};
|
|
18
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAiB,EAAC,eAAe,EAAC,MAAM,IAAI,CAAC;AAC7C,OAAO,EAAc,aAAa,EAAwB,MAAM,MAAM,CAAC;AASvE,OAAO,QAAQ,gBAAgB,CAAC;IAC5B,UAAU,aAAa;QACnB,GAAG,EAAE,SAAS,CAAC;KAClB;CACJ;AACD,MAAM,MAAM,QAAQ,GAAC,MAAM,GAAC;IACxB,UAAU,EAAC,MAAM,CAAA;IACjB,WAAW,EAAC,MAAM,CAAA;CACrB,CAAA;AACD,MAAM,MAAM,SAAS,GAAG;IACpB,IAAI,EAAC,aAAa,CAAC;IACnB,QAAQ,CAAC,KAAK,EAAE,QAAQ,GAAG,MAAM,IAAI,CAAC;IACtC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,EAAE,EAAC,eAAe,CAAA;CACrB,CAAC"}
|
package/lib/index.js
ADDED
|
@@ -0,0 +1,174 @@
|
|
|
1
|
+
import { register, useContext, useLogger } from '@zhin.js/core';
|
|
2
|
+
import WebSocket from 'ws';
|
|
3
|
+
import { createServer, searchForWorkspaceRoot } from 'vite';
|
|
4
|
+
import Components from 'unplugin-vue-components/vite';
|
|
5
|
+
import { PrimeVueResolver } from '@primevue/auto-import-resolver';
|
|
6
|
+
import connect from 'koa-connect';
|
|
7
|
+
import vuePlugin from "@vitejs/plugin-vue";
|
|
8
|
+
import * as fs from 'fs';
|
|
9
|
+
import * as path from 'path';
|
|
10
|
+
import { fileURLToPath } from "node:url";
|
|
11
|
+
const createSyncMsg = (key, value) => {
|
|
12
|
+
return {
|
|
13
|
+
type: 'sync',
|
|
14
|
+
data: {
|
|
15
|
+
key,
|
|
16
|
+
value,
|
|
17
|
+
},
|
|
18
|
+
};
|
|
19
|
+
};
|
|
20
|
+
const createAddMsg = (key, value) => {
|
|
21
|
+
return {
|
|
22
|
+
type: 'add',
|
|
23
|
+
data: {
|
|
24
|
+
key,
|
|
25
|
+
value,
|
|
26
|
+
},
|
|
27
|
+
};
|
|
28
|
+
};
|
|
29
|
+
const createDeleteMsg = (key, value) => {
|
|
30
|
+
return {
|
|
31
|
+
type: 'delete',
|
|
32
|
+
data: {
|
|
33
|
+
key,
|
|
34
|
+
value,
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
};
|
|
38
|
+
const logger = useLogger();
|
|
39
|
+
useContext('router', async (router) => {
|
|
40
|
+
const root = path.join(process.cwd(), 'node_modules', '@zhin.js', 'client', 'app');
|
|
41
|
+
const base = '/vite/';
|
|
42
|
+
const vite = await createServer({
|
|
43
|
+
root,
|
|
44
|
+
base,
|
|
45
|
+
plugins: [
|
|
46
|
+
vuePlugin(),
|
|
47
|
+
Components({
|
|
48
|
+
resolvers: [
|
|
49
|
+
PrimeVueResolver()
|
|
50
|
+
]
|
|
51
|
+
})
|
|
52
|
+
],
|
|
53
|
+
server: {
|
|
54
|
+
middlewareMode: true,
|
|
55
|
+
fs: {
|
|
56
|
+
allow: [searchForWorkspaceRoot(fileURLToPath(import.meta.url))],
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
resolve: {
|
|
60
|
+
dedupe: ['vue', 'vue-router', 'pinia', 'primevue', 'primeicons'],
|
|
61
|
+
alias: {
|
|
62
|
+
'@zhin.js/client': path.resolve(root, '../src'),
|
|
63
|
+
},
|
|
64
|
+
},
|
|
65
|
+
optimizeDeps: {
|
|
66
|
+
include: ['vue', 'pinia'],
|
|
67
|
+
},
|
|
68
|
+
build: {
|
|
69
|
+
rollupOptions: {
|
|
70
|
+
input: root + '/index.html',
|
|
71
|
+
},
|
|
72
|
+
},
|
|
73
|
+
});
|
|
74
|
+
router.all('*all', async (ctx, next) => {
|
|
75
|
+
await next();
|
|
76
|
+
const url = ctx.request.originalUrl.replace(base, '');
|
|
77
|
+
const name = ctx.path.slice(1);
|
|
78
|
+
const sendFile = (filename) => {
|
|
79
|
+
ctx.type = path.extname(filename);
|
|
80
|
+
if (filename.endsWith('.ts'))
|
|
81
|
+
ctx.type = 'text/javascript';
|
|
82
|
+
return (ctx.body = fs.createReadStream(filename));
|
|
83
|
+
};
|
|
84
|
+
if (Object.keys(webServer.entries).includes(name)) {
|
|
85
|
+
return sendFile(path.resolve(process.cwd(), webServer.entries[name]));
|
|
86
|
+
}
|
|
87
|
+
const filename = path.resolve(root, name);
|
|
88
|
+
if (!filename.startsWith(root) && !filename.includes('node_modules')) {
|
|
89
|
+
return (ctx.status = 403);
|
|
90
|
+
}
|
|
91
|
+
if (fs.existsSync(filename)) {
|
|
92
|
+
const fileState = fs.statSync(filename);
|
|
93
|
+
if (fileState.isFile())
|
|
94
|
+
return sendFile(filename);
|
|
95
|
+
}
|
|
96
|
+
const template = fs.readFileSync(path.resolve(root, 'index.html'), 'utf8');
|
|
97
|
+
ctx.type = 'html';
|
|
98
|
+
ctx.body = await vite.transformIndexHtml(url, template);
|
|
99
|
+
});
|
|
100
|
+
router.use((ctx, next) => {
|
|
101
|
+
if (ctx.request.originalUrl.startsWith('/api'))
|
|
102
|
+
return next();
|
|
103
|
+
return connect(vite.middlewares)(ctx, next);
|
|
104
|
+
});
|
|
105
|
+
const webServer = {
|
|
106
|
+
vite,
|
|
107
|
+
entries: {},
|
|
108
|
+
addEntry(entry) {
|
|
109
|
+
const hash = Date.now().toString(16);
|
|
110
|
+
const entryFile = typeof entry === "string" ? entry : entry[process.env.NODE_ENV || 'development'];
|
|
111
|
+
this.entries[hash] = `/vite/@fs/${entryFile}`;
|
|
112
|
+
for (const ws of this.ws.clients || []) {
|
|
113
|
+
ws.send(JSON.stringify(createAddMsg('entries', this.entries[hash])));
|
|
114
|
+
}
|
|
115
|
+
return () => {
|
|
116
|
+
for (const ws of this.ws.clients || []) {
|
|
117
|
+
ws.send(JSON.stringify(createDeleteMsg('entries', this.entries[hash])));
|
|
118
|
+
}
|
|
119
|
+
delete this.entries[hash];
|
|
120
|
+
};
|
|
121
|
+
},
|
|
122
|
+
ws: router.ws('/server')
|
|
123
|
+
};
|
|
124
|
+
// 数据推送函数
|
|
125
|
+
const broadcastToAll = (message) => {
|
|
126
|
+
for (const ws of webServer.ws.clients || []) {
|
|
127
|
+
if (ws.readyState === WebSocket.OPEN) {
|
|
128
|
+
ws.send(JSON.stringify(message));
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
};
|
|
132
|
+
// 推送数据更新通知
|
|
133
|
+
const notifyDataUpdate = () => {
|
|
134
|
+
broadcastToAll({
|
|
135
|
+
type: 'data-update',
|
|
136
|
+
timestamp: Date.now()
|
|
137
|
+
});
|
|
138
|
+
};
|
|
139
|
+
// WebSocket 连接处理
|
|
140
|
+
webServer.ws.on('connection', (ws) => {
|
|
141
|
+
// 发送初始数据
|
|
142
|
+
ws.send(JSON.stringify(createSyncMsg('entries', Object.values(webServer.entries))));
|
|
143
|
+
// 通知客户端进行数据初始化
|
|
144
|
+
ws.send(JSON.stringify({
|
|
145
|
+
type: 'init-data',
|
|
146
|
+
timestamp: Date.now()
|
|
147
|
+
}));
|
|
148
|
+
ws.on('close', () => {
|
|
149
|
+
});
|
|
150
|
+
ws.on('error', (error) => {
|
|
151
|
+
// console.error 已替换为注释
|
|
152
|
+
});
|
|
153
|
+
});
|
|
154
|
+
// 定时通知客户端更新数据
|
|
155
|
+
const dataUpdateInterval = setInterval(() => {
|
|
156
|
+
notifyDataUpdate();
|
|
157
|
+
}, 5000); // 每5秒通知一次更新
|
|
158
|
+
// 插件卸载时清理定时器
|
|
159
|
+
process.on('exit', () => {
|
|
160
|
+
clearInterval(dataUpdateInterval);
|
|
161
|
+
});
|
|
162
|
+
register({
|
|
163
|
+
name: 'web',
|
|
164
|
+
description: "web服务",
|
|
165
|
+
async mounted() {
|
|
166
|
+
return webServer;
|
|
167
|
+
},
|
|
168
|
+
async dispose(server) {
|
|
169
|
+
await server.vite.close();
|
|
170
|
+
server.ws.close();
|
|
171
|
+
}
|
|
172
|
+
});
|
|
173
|
+
});
|
|
174
|
+
//# sourceMappingURL=index.js.map
|
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAC,MAAM,eAAe,CAAC;AAC9D,OAAO,SAA2B,MAAM,IAAI,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAe,sBAAsB,EAAC,MAAM,MAAM,CAAC;AACvE,OAAO,UAAU,MAAM,8BAA8B,CAAC;AACtD,OAAO,EAAC,gBAAgB,EAAC,MAAM,gCAAgC,CAAC;AAChE,OAAO,OAAO,MAAM,aAAa,CAAC;AAClC,OAAO,SAAS,MAAM,oBAAoB,CAAC;AAC3C,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,KAAK,IAAI,MAAM,MAAM,CAAC;AAC7B,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AAiBvC,MAAM,aAAa,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;IAC9C,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE;YACF,GAAG;YACH,KAAK;SACR;KACJ,CAAC;AACN,CAAC,CAAC;AACF,MAAM,YAAY,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;IAC7C,OAAO;QACH,IAAI,EAAE,KAAK;QACX,IAAI,EAAE;YACF,GAAG;YACH,KAAK;SACR;KACJ,CAAC;AACN,CAAC,CAAC;AACF,MAAM,eAAe,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,EAAE;IAChD,OAAO;QACH,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE;YACF,GAAG;YACH,KAAK;SACR;KACJ,CAAC;AACN,CAAC,CAAC;AACF,MAAM,MAAM,GAAC,SAAS,EAAE,CAAC;AACzB,UAAU,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;IAClC,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAC,cAAc,EAAC,UAAU,EAAC,QAAQ,EAAC,KAAK,CAAC,CAAC;IAC/E,MAAM,IAAI,GAAC,QAAQ,CAAA;IACnB,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC;QAC5B,IAAI;QACJ,IAAI;QACJ,OAAO,EAAE;YACL,SAAS,EAAE;YACX,UAAU,CAAC;gBACP,SAAS,EAAE;oBACP,gBAAgB,EAAE;iBACrB;aACJ,CAAC;SACL;QACD,MAAM,EAAE;YACJ,cAAc,EAAE,IAAI;YACpB,EAAE,EAAE;gBACA,KAAK,EAAE,CAAC,sBAAsB,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;aAClE;SACJ;QACD,OAAO,EAAE;YACL,MAAM,EAAE,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAC,UAAU,EAAC,YAAY,CAAC;YAC9D,KAAK,EAAE;gBACH,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,QAAQ,CAAC;aAClD;SACJ;QACD,YAAY,EAAE;YACV,OAAO,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC;SAC5B;QACD,KAAK,EAAE;YACH,aAAa,EAAE;gBACX,KAAK,EAAE,IAAI,GAAG,aAAa;aAC9B;SACJ;KACJ,CAAC,CAAC;IACH,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACnC,MAAM,IAAI,EAAE,CAAC;QACb,MAAM,GAAG,GAAC,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,EAAC,EAAE,CAAC,CAAA;QAClD,MAAM,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,QAAQ,GAAG,CAAC,QAAgB,EAAE,EAAE;YAClC,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClC,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,GAAG,CAAC,IAAI,GAAG,iBAAiB,CAAC;YAC3D,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,EAAE,CAAC,gBAAgB,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtD,CAAC,CAAC;QACF,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAChD,OAAO,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC1E,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE,CAAC;YACnE,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,MAAM,SAAS,GAAG,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACxC,IAAI,SAAS,CAAC,MAAM,EAAE;gBAAE,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACtD,CAAC;QACD,MAAM,QAAQ,GAAG,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,EAAE,MAAM,CAAC,CAAC;QAC3E,GAAG,CAAC,IAAI,GAAG,MAAM,CAAC;QAClB,GAAG,CAAC,IAAI,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5D,CAAC,CAAC,CAAC;IACH,MAAM,CAAC,GAAG,CAAC,CAAC,GAAQ,EAAE,IAAS,EAAE,EAAE;QAC/B,IAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,EAAE,CAAA;QAC5D,OAAO,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,GAAG,EAAC,IAAI,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAW;QACtB,IAAI;QACJ,OAAO,EAAE,EAAE;QACX,QAAQ,CAAC,KAAK;YACV,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACrC,MAAM,SAAS,GAAC,OAAO,KAAK,KAAG,QAAQ,CAAA,CAAC,CAAA,KAAK,CAAA,CAAC,CAAA,KAAK,CAAE,OAAO,CAAC,GAAG,CAAC,QAAuC,IAAE,aAAa,CAAC,CAAC;YACzH,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,SAAS,EAAE,CAAC;YAC9C,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;gBACrC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;YACzE,CAAC;YACD,OAAO,GAAG,EAAE;gBACR,KAAK,MAAM,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;oBACrC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;gBAC5E,CAAC;gBACD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC9B,CAAC,CAAC;QACN,CAAC;QACD,EAAE,EAAC,MAAM,CAAC,EAAE,CAAC,SAAS,CAAC;KAC1B,CAAA;IACD,SAAS;IACT,MAAM,cAAc,GAAG,CAAC,OAAY,EAAE,EAAE;QACpC,KAAK,MAAM,EAAE,IAAI,SAAS,CAAC,EAAE,CAAC,OAAO,IAAI,EAAE,EAAE,CAAC;YAC1C,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS,CAAC,IAAI,EAAE,CAAC;gBACnC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;IACL,CAAC,CAAA;IAED,WAAW;IACX,MAAM,gBAAgB,GAAG,GAAG,EAAE;QAC1B,cAAc,CAAC;YACX,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACxB,CAAC,CAAC;IACP,CAAC,CAAA;IAED,iBAAiB;IACjB,SAAS,CAAC,EAAE,CAAC,EAAE,CAAC,YAAY,EAAE,CAAC,EAAa,EAAE,EAAE;QAC5C,SAAS;QACT,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QAEpF,eAAe;QACf,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;YACnB,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACxB,CAAC,CAAC,CAAC;QAEJ,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACpB,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YACrB,uBAAuB;QAC3B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,cAAc;IACd,MAAM,kBAAkB,GAAG,WAAW,CAAC,GAAG,EAAE;QACxC,gBAAgB,EAAE,CAAC;IACvB,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,YAAY;IAEtB,aAAa;IACb,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;QACpB,aAAa,CAAC,kBAAkB,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;IACH,QAAQ,CAAC;QACL,IAAI,EAAC,KAAK;QACV,WAAW,EAAC,OAAO;QACnB,KAAK,CAAC,OAAO;YACT,OAAO,SAAS,CAAA;QACpB,CAAC;QACD,KAAK,CAAC,OAAO,CAAC,MAAM;YAChB,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAC1B,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAA;QACrB,CAAC;KACJ,CAAC,CAAA;AAEN,CAAC,CAAC,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@zhin.js/console",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Zhin 控制台",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "./lib/index.js",
|
|
7
|
+
"types": "./lib/index.d.ts",
|
|
8
|
+
"exports": {
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./lib/index.d.ts",
|
|
11
|
+
"import": "./lib/index.js"
|
|
12
|
+
}
|
|
13
|
+
},
|
|
14
|
+
"dependencies": {
|
|
15
|
+
"@vitejs/plugin-vue": "^6.0.1",
|
|
16
|
+
"koa-connect": "^2.1.0",
|
|
17
|
+
"ws": "^8.18.3",
|
|
18
|
+
"vue": "^3.5.18",
|
|
19
|
+
"vite": "^7.0.6"
|
|
20
|
+
},
|
|
21
|
+
"peerDependencies": {
|
|
22
|
+
"@types/ws": "^8.18.1",
|
|
23
|
+
"unplugin-vue-components": "^29.0.0",
|
|
24
|
+
"@primevue/auto-import-resolver": "^4.3.7",
|
|
25
|
+
"@zhin.js/client": "^1.0.0",
|
|
26
|
+
"@zhin.js/http": "^1.0.1",
|
|
27
|
+
"@zhin.js/core": "^1.0.1",
|
|
28
|
+
"@zhin.js/types": "^1.0.1"
|
|
29
|
+
},
|
|
30
|
+
"peerDependenciesMeta": {
|
|
31
|
+
"@zhin.js/types": {
|
|
32
|
+
"optional": true
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"files": [
|
|
36
|
+
"lib",
|
|
37
|
+
"src",
|
|
38
|
+
"global.d.ts",
|
|
39
|
+
"app"
|
|
40
|
+
],
|
|
41
|
+
"scripts": {
|
|
42
|
+
"build": "tsc",
|
|
43
|
+
"clean": "rm -rf lib"
|
|
44
|
+
}
|
|
45
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,195 @@
|
|
|
1
|
+
import {register, useContext, useLogger} from '@zhin.js/core';
|
|
2
|
+
import WebSocket,{WebSocketServer} from 'ws';
|
|
3
|
+
import {createServer,ViteDevServer,searchForWorkspaceRoot} from 'vite';
|
|
4
|
+
import Components from 'unplugin-vue-components/vite';
|
|
5
|
+
import {PrimeVueResolver} from '@primevue/auto-import-resolver';
|
|
6
|
+
import connect from 'koa-connect';
|
|
7
|
+
import vuePlugin from "@vitejs/plugin-vue";
|
|
8
|
+
import * as fs from 'fs';
|
|
9
|
+
import * as path from 'path';
|
|
10
|
+
import {fileURLToPath} from "node:url";
|
|
11
|
+
|
|
12
|
+
declare module '@zhin.js/types' {
|
|
13
|
+
interface GlobalContext {
|
|
14
|
+
web: WebServer;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
export type WebEntry=string|{
|
|
18
|
+
production:string
|
|
19
|
+
development:string
|
|
20
|
+
}
|
|
21
|
+
export type WebServer = {
|
|
22
|
+
vite:ViteDevServer,
|
|
23
|
+
addEntry(entry: WebEntry): () => void;
|
|
24
|
+
entries: Record<string, string>;
|
|
25
|
+
ws:WebSocketServer
|
|
26
|
+
};
|
|
27
|
+
const createSyncMsg = (key: string, value: any) => {
|
|
28
|
+
return {
|
|
29
|
+
type: 'sync',
|
|
30
|
+
data: {
|
|
31
|
+
key,
|
|
32
|
+
value,
|
|
33
|
+
},
|
|
34
|
+
};
|
|
35
|
+
};
|
|
36
|
+
const createAddMsg = (key: string, value: any) => {
|
|
37
|
+
return {
|
|
38
|
+
type: 'add',
|
|
39
|
+
data: {
|
|
40
|
+
key,
|
|
41
|
+
value,
|
|
42
|
+
},
|
|
43
|
+
};
|
|
44
|
+
};
|
|
45
|
+
const createDeleteMsg = (key: string, value: any) => {
|
|
46
|
+
return {
|
|
47
|
+
type: 'delete',
|
|
48
|
+
data: {
|
|
49
|
+
key,
|
|
50
|
+
value,
|
|
51
|
+
},
|
|
52
|
+
};
|
|
53
|
+
};
|
|
54
|
+
const logger=useLogger();
|
|
55
|
+
useContext('router', async (router) => {
|
|
56
|
+
const root = path.join(process.cwd(),'node_modules','@zhin.js','client','app');
|
|
57
|
+
const base='/vite/'
|
|
58
|
+
const vite = await createServer({
|
|
59
|
+
root,
|
|
60
|
+
base,
|
|
61
|
+
plugins: [
|
|
62
|
+
vuePlugin(),
|
|
63
|
+
Components({
|
|
64
|
+
resolvers: [
|
|
65
|
+
PrimeVueResolver()
|
|
66
|
+
]
|
|
67
|
+
})
|
|
68
|
+
],
|
|
69
|
+
server: {
|
|
70
|
+
middlewareMode: true,
|
|
71
|
+
fs: {
|
|
72
|
+
allow: [searchForWorkspaceRoot(fileURLToPath(import.meta.url))],
|
|
73
|
+
},
|
|
74
|
+
},
|
|
75
|
+
resolve: {
|
|
76
|
+
dedupe: ['vue', 'vue-router', 'pinia','primevue','primeicons'],
|
|
77
|
+
alias: {
|
|
78
|
+
'@zhin.js/client': path.resolve(root, '../src'),
|
|
79
|
+
},
|
|
80
|
+
},
|
|
81
|
+
optimizeDeps: {
|
|
82
|
+
include: ['vue', 'pinia'],
|
|
83
|
+
},
|
|
84
|
+
build: {
|
|
85
|
+
rollupOptions: {
|
|
86
|
+
input: root + '/index.html',
|
|
87
|
+
},
|
|
88
|
+
},
|
|
89
|
+
});
|
|
90
|
+
router.all('*all', async (ctx, next) => {
|
|
91
|
+
await next();
|
|
92
|
+
const url=ctx.request.originalUrl.replace(base,'')
|
|
93
|
+
const name = ctx.path.slice(1);
|
|
94
|
+
const sendFile = (filename: string) => {
|
|
95
|
+
ctx.type = path.extname(filename);
|
|
96
|
+
if (filename.endsWith('.ts')) ctx.type = 'text/javascript';
|
|
97
|
+
return (ctx.body = fs.createReadStream(filename));
|
|
98
|
+
};
|
|
99
|
+
if (Object.keys(webServer.entries).includes(name)) {
|
|
100
|
+
return sendFile(path.resolve(process.cwd(), webServer.entries[name]));
|
|
101
|
+
}
|
|
102
|
+
const filename = path.resolve(root, name);
|
|
103
|
+
if (!filename.startsWith(root) && !filename.includes('node_modules')) {
|
|
104
|
+
return (ctx.status = 403);
|
|
105
|
+
}
|
|
106
|
+
if (fs.existsSync(filename)) {
|
|
107
|
+
const fileState = fs.statSync(filename);
|
|
108
|
+
if (fileState.isFile()) return sendFile(filename);
|
|
109
|
+
}
|
|
110
|
+
const template = fs.readFileSync(path.resolve(root, 'index.html'), 'utf8');
|
|
111
|
+
ctx.type = 'html';
|
|
112
|
+
ctx.body = await vite.transformIndexHtml(url, template);
|
|
113
|
+
});
|
|
114
|
+
router.use((ctx: any, next: any) => {
|
|
115
|
+
if(ctx.request.originalUrl.startsWith('/api')) return next()
|
|
116
|
+
return connect(vite.middlewares)(ctx,next);
|
|
117
|
+
});
|
|
118
|
+
|
|
119
|
+
const webServer:WebServer={
|
|
120
|
+
vite,
|
|
121
|
+
entries: {},
|
|
122
|
+
addEntry(entry) {
|
|
123
|
+
const hash = Date.now().toString(16);
|
|
124
|
+
const entryFile=typeof entry==="string"?entry:entry[(process.env.NODE_ENV as 'development'|'production')||'development'];
|
|
125
|
+
this.entries[hash] = `/vite/@fs/${entryFile}`;
|
|
126
|
+
for (const ws of this.ws.clients || []) {
|
|
127
|
+
ws.send(JSON.stringify(createAddMsg('entries', this.entries[hash])));
|
|
128
|
+
}
|
|
129
|
+
return () => {
|
|
130
|
+
for (const ws of this.ws.clients || []) {
|
|
131
|
+
ws.send(JSON.stringify(createDeleteMsg('entries', this.entries[hash])));
|
|
132
|
+
}
|
|
133
|
+
delete this.entries[hash];
|
|
134
|
+
};
|
|
135
|
+
},
|
|
136
|
+
ws:router.ws('/server')
|
|
137
|
+
}
|
|
138
|
+
// 数据推送函数
|
|
139
|
+
const broadcastToAll = (message: any) => {
|
|
140
|
+
for (const ws of webServer.ws.clients || []) {
|
|
141
|
+
if (ws.readyState === WebSocket.OPEN) {
|
|
142
|
+
ws.send(JSON.stringify(message));
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
// 推送数据更新通知
|
|
148
|
+
const notifyDataUpdate = () => {
|
|
149
|
+
broadcastToAll({
|
|
150
|
+
type: 'data-update',
|
|
151
|
+
timestamp: Date.now()
|
|
152
|
+
});
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
// WebSocket 连接处理
|
|
156
|
+
webServer.ws.on('connection', (ws: WebSocket) => {
|
|
157
|
+
// 发送初始数据
|
|
158
|
+
ws.send(JSON.stringify(createSyncMsg('entries', Object.values(webServer.entries))));
|
|
159
|
+
|
|
160
|
+
// 通知客户端进行数据初始化
|
|
161
|
+
ws.send(JSON.stringify({
|
|
162
|
+
type: 'init-data',
|
|
163
|
+
timestamp: Date.now()
|
|
164
|
+
}));
|
|
165
|
+
|
|
166
|
+
ws.on('close', () => {
|
|
167
|
+
});
|
|
168
|
+
|
|
169
|
+
ws.on('error', (error) => {
|
|
170
|
+
// console.error 已替换为注释
|
|
171
|
+
});
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
// 定时通知客户端更新数据
|
|
175
|
+
const dataUpdateInterval = setInterval(() => {
|
|
176
|
+
notifyDataUpdate();
|
|
177
|
+
}, 5000); // 每5秒通知一次更新
|
|
178
|
+
|
|
179
|
+
// 插件卸载时清理定时器
|
|
180
|
+
process.on('exit', () => {
|
|
181
|
+
clearInterval(dataUpdateInterval);
|
|
182
|
+
});
|
|
183
|
+
register({
|
|
184
|
+
name:'web',
|
|
185
|
+
description:"web服务",
|
|
186
|
+
async mounted(){
|
|
187
|
+
return webServer
|
|
188
|
+
},
|
|
189
|
+
async dispose(server){
|
|
190
|
+
await server.vite.close();
|
|
191
|
+
server.ws.close()
|
|
192
|
+
}
|
|
193
|
+
})
|
|
194
|
+
|
|
195
|
+
});
|