@zhin.js/http 1.0.4 → 1.0.6

package/lib/index.js

@@ -1,35 +1,43 @@
-import { register, useApp, useDatabase } from '@zhin.js/core';
-import { createServer } from 'http';
-import os from 'node:os';
-import Koa from 'koa';
-import auth from 'koa-basic-auth';
-import KoaBodyParser from 'koa-bodyparser';
-import { Router } from './router.js';
-import * as process from 'process';
-export * from './router.js';
+import { register, defineSchema, Schema, usePlugin, useApp, useDatabase, } from "@zhin.js/core";
+import { createServer } from "http";
+import os from "node:os";
+import Koa from "koa";
+import auth from "koa-basic-auth";
+import KoaBodyParser from "koa-bodyparser";
+import { Router } from "./router.js";
+import * as process from "process";
+export * from "./router.js";
+const plugin = usePlugin();
+const schema = defineSchema(Schema.object({
+    port: Schema.number("port").default(8086).description("HTTP 服务端口"),
+    username: Schema.string("username").description("HTTP 基本认证用户名, 默认为当前系统用户名"),
+    password: Schema.string("password").description("HTTP 基本认证密码, 默认为随机生成的6位字符串"),
+    base: Schema.string("base")
+        .default("/api")
+        .description("HTTP 路由前缀, 默认为 /api"),
+}));
 const koa = new Koa();
 const server = createServer(koa.callback());
-const router = new Router(server, { prefix: process.env.routerPrefix || '' });
+const router = new Router(server, { prefix: process.env.routerPrefix || "" });
 // 获取当前计算机登录用户名
 const getCurrentUsername = () => {
     try {
         return os.userInfo().username;
     }
     catch {
-        return 'admin'; // 如果获取失败，使用默认用户名
+        return "admin"; // 如果获取失败，使用默认用户名
     }
 };
 // 生成6位随机密码
 const generateRandomPassword = () => {
-    const chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-    let result = '';
+    const chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+    let result = "";
     for (let i = 0; i < 6; i++) {
         result += chars.charAt(Math.floor(Math.random() * chars.length));
     }
     return result;
 };
-const username = process.env.username || getCurrentUsername();
-const password = process.env.password || generateRandomPassword();
+const { port = 8086, username = getCurrentUsername(), password = generateRandomPassword(), base = "/api", } = schema(plugin.config, "http");
 const app = useApp();
 koa.use(auth({
     name: username,
@@ -39,7 +47,7 @@ koa.use(auth({
 // API 路由
 // ============================================================================
 // 系统状态 API
-router.get('/api/system/status', async (ctx) => {
+router.get(`${base}/system/status`, async (ctx) => {
     try {
         ctx.body = {
             success: true,
@@ -50,8 +58,8 @@ router.get('/api/system/status', async (ctx) => {
                 platform: process.platform,
                 nodeVersion: process.version,
                 pid: process.pid,
-                timestamp: new Date().toISOString()
-            }
+                timestamp: new Date().toISOString(),
+            },
         };
     }
     catch (error) {
@@ -60,25 +68,25 @@ router.get('/api/system/status', async (ctx) => {
     }
 });
 // 健康检查 API
-router.get('/api/health', async (ctx) => {
+router.get(`${base}/health`, async (ctx) => {
     ctx.body = {
         success: true,
-        status: 'ok',
-        timestamp: new Date().toISOString()
+        status: "ok",
+        timestamp: new Date().toISOString(),
     };
 });
 // 统计信息 API
-router.get('/api/stats', async (ctx) => {
+router.get(`${base}/stats`, async (ctx) => {
     try {
         // 统计插件数量
         const pluginCount = app.dependencyList.length;
-        const activePluginCount = app.dependencyList.filter(dep => dep.mounted).length;
+        const activePluginCount = app.dependencyList.filter((dep) => dep.mounted).length;
         // 统计机器人数量
         let botCount = 0;
         let onlineBotCount = 0;
         for (const context of app.contextList) {
             const adapter = app.getContext(context.name);
-            if (adapter && typeof adapter === 'object' && 'bots' in adapter) {
+            if (adapter && typeof adapter === "object" && "bots" in adapter) {
                 const adapterBots = adapter.bots;
                 if (adapterBots && adapterBots instanceof Map) {
                     botCount += adapterBots.size;
@@ -105,7 +113,7 @@ router.get('/api/stats', async (ctx) => {
                 components: componentCount,
                 uptime: process.uptime(),
                 memory: process.memoryUsage().heapUsed / 1024 / 1024, // MB
-            }
+            },
         };
     }
     catch (error) {
@@ -114,18 +122,18 @@ router.get('/api/stats', async (ctx) => {
     }
 });
 // 插件管理 API
-router.get('/api/plugins', async (ctx) => {
+router.get(`${base}/plugins`, async (ctx) => {
     try {
         // 获取详细的插件数据
-        const plugins = app.dependencyList.map(dep => {
+        const plugins = app.dependencyList.map((dep) => {
             return {
                 name: dep.name,
-                status: dep.mounted ? 'active' : 'inactive',
+                status: dep.mounted ? "active" : "inactive",
                 commandCount: dep.commands.length,
                 componentCount: dep.components.size,
                 middlewareCount: dep.middlewares.length,
                 contextCount: dep.contexts.size,
-                description: dep.description || '无描述',
+                description: dep.description || "无描述",
             };
         });
         ctx.body = { success: true, data: plugins, total: plugins.length };
@@ -136,68 +144,68 @@ router.get('/api/plugins', async (ctx) => {
     }
 });
 // 插件详情 API
-router.get('/api/plugins/:name', async (ctx) => {
+router.get("/api/plugins/:name", async (ctx) => {
     try {
         const pluginName = ctx.params.name;
-        const plugin = app.dependencyList.find(dep => dep.name === pluginName);
+        const plugin = app.dependencyList.find((dep) => dep.name === pluginName);
         if (!plugin) {
             ctx.status = 404;
-            ctx.body = { success: false, error: '插件不存在' };
+            ctx.body = { success: false, error: "插件不存在" };
             return;
         }
         // 获取命令详情
-        const commands = plugin.commands.map(cmd => ({
-            name: cmd.pattern
+        const commands = plugin.commands.map((cmd) => ({
+            name: cmd.pattern,
         }));
         // 获取组件详情
         const components = Array.from(plugin.components.entries()).map(([name, comp]) => ({
             name,
             props: comp.props || {},
-            type: typeof comp
+            type: typeof comp,
         }));
         // 获取中间件详情
         const middlewares = plugin.middlewares.map((_, index) => ({
             id: `middleware-${index}`,
-            type: 'function'
+            type: "function",
         }));
         // 获取上下文详情
         const contexts = Array.from(plugin.contexts.entries()).map(([name, ctx]) => ({
             name,
-            description: ctx.description || '无描述'
+            description: ctx.description || "无描述",
         }));
         // 获取定时任务详情
         const crons = plugin.crons.map((cron, index) => ({
             id: `cron-${index}`,
-            pattern: cron.pattern || 'unknown',
-            running: cron.running || false
+            pattern: cron.pattern || "unknown",
+            running: cron.running || false,
         }));
         // 获取数据模型详情
-        const schemas = Array.from(plugin.schemas.entries()).map(([name, schema]) => ({
+        const definitions = Array.from(plugin.definitions.entries()).map(([name, definition]) => ({
             name,
-            fields: Object.keys(schema.fields || {})
+            fields: Object.keys(definition),
         }));
         ctx.body = {
             success: true,
             data: {
                 name: plugin.name,
                 filename: plugin.filename,
-                status: plugin.mounted ? 'active' : 'inactive',
-                description: plugin.description || '无描述',
+                status: plugin.mounted ? "active" : "inactive",
+                description: plugin.description || "无描述",
                 commands,
                 components,
                 middlewares,
                 contexts,
                 crons,
-                schemas,
+                definitions,
                 statistics: {
                     commandCount: commands.length,
                     componentCount: components.length,
                     middlewareCount: middlewares.length,
                     contextCount: contexts.length,
                     cronCount: crons.length,
-                    schemaCount: schemas.length
-                }
-            }
+                    definitionCount: definitions.length,
+                },
+            },
         };
     }
     catch (error) {
@@ -206,13 +214,13 @@ router.get('/api/plugins/:name', async (ctx) => {
     }
 });
 // 适配器和机器人状态 API
-router.get('/api/bots', async (ctx) => {
+router.get(`${base}/bots`, async (ctx) => {
     try {
         const bots = [];
         // 遍历所有上下文，查找适配器
         for (const context of app.contextList) {
             const adapter = app.getContext(context.name);
-            if (adapter && typeof adapter === 'object' && 'bots' in adapter) {
+            if (adapter && typeof adapter === "object" && "bots" in adapter) {
                 const adapterBots = adapter.bots;
                 if (adapterBots && adapterBots instanceof Map) {
                     for (const [botName, bot] of adapterBots.entries()) {
@@ -220,7 +228,7 @@ router.get('/api/bots', async (ctx) => {
                             name: botName,
                             adapter: context.name,
                             connected: bot.$connected || false,
-                            status: bot.$connected ? 'online' : 'offline'
+                            status: bot.$connected ? "online" : "offline",
                             // 移除 config 字段以保护隐私
                         });
                     }
@@ -235,7 +243,7 @@ router.get('/api/bots', async (ctx) => {
     }
 });
 // 框架配置信息 API
-router.get('/api/config', async (ctx) => {
+router.get(`${base}/config`, async (ctx) => {
     try {
         const config = app.getConfig();
         ctx.body = { success: true, data: config };
@@ -245,8 +253,126 @@ router.get('/api/config', async (ctx) => {
         ctx.body = { success: false, error: error.message };
     }
 });
+// 获取所有插件的 Schema API
+router.get(`${base}/schemas`, async (ctx) => {
+    try {
+        const schemas = {};
+        // 获取 App 的 Schema
+        const appSchema = app.schema.toJSON();
+        if (appSchema) {
+            schemas["app"] = appSchema;
+        }
+        // 获取所有插件的 Schema
+        for (const plugin of app.dependencyList) {
+            const schema = plugin.schema.toJSON();
+            if (schema) {
+                schemas[plugin.name] = schema;
+            }
+        }
+        ctx.body = {
+            success: true,
+            data: schemas,
+            total: Object.keys(schemas).length,
+        };
+    }
+    catch (error) {
+        ctx.status = 500;
+        ctx.body = { success: false, error: error.message };
+    }
+});
+// 获取单个插件的 Schema API
+router.get(`${base}/schemas/:name`, async (ctx) => {
+    try {
+        const { name } = ctx.params;
+        if (name === "app") {
+            const schema = app.schema?.toJSON();
+            if (!schema) {
+                ctx.status = 404;
+                ctx.body = { success: false, error: "App schema not found" };
+                return;
+            }
+            ctx.body = { success: true, data: schema };
+            return;
+        }
+        const plugin = app.findPluginByName(name);
+        if (!plugin) {
+            ctx.status = 404;
+            ctx.body = { success: false, error: `Plugin ${name} not found` };
+            return;
+        }
+        const schema = plugin.schema.toJSON();
+        if (!schema) {
+            ctx.status = 404;
+            ctx.body = {
+                success: false,
+                error: `Schema for plugin ${name} not found`,
+            };
+            return;
+        }
+        ctx.body = { success: true, data: schema };
+    }
+    catch (error) {
+        ctx.status = 500;
+        ctx.body = { success: false, error: error.message };
+    }
+});
+// 获取插件配置 API
+router.get(`${base}/config/:name`, async (ctx) => {
+    try {
+        const { name } = ctx.params;
+        if (name === "app") {
+            const config = app.getConfig();
+            ctx.body = { success: true, data: config };
+            return;
+        }
+        const plugin = app.findPluginByName(name);
+        if (!plugin) {
+            ctx.status = 404;
+            ctx.body = { success: false, error: `Plugin ${name} not found` };
+            return;
+        }
+        const config = plugin.config;
+        ctx.body = { success: true, data: config };
+    }
+    catch (error) {
+        ctx.status = 500;
+        ctx.body = { success: false, error: error.message };
+    }
+});
+// 更新插件配置 API
+router.post(`${base}/config/:name`, async (ctx) => {
+    try {
+        const { name } = ctx.params;
+        const newConfig = ctx.request.body;
+        if (name === "app") {
+            app.config = newConfig;
+            ctx.body = {
+                success: true,
+                message: "App configuration updated successfully",
+                data: app.getConfig(),
+            };
+            return;
+        }
+        const plugin = app.findPluginByName(name);
+        if (!plugin) {
+            ctx.status = 404;
+            ctx.body = { success: false, error: `Plugin ${name} not found` };
+            return;
+        }
+        plugin.config = newConfig;
+        ctx.body = {
+            success: true,
+            message: `Plugin ${name} configuration updated successfully`,
+            data: plugin.config,
+        };
+    }
+    catch (error) {
+        ctx.status = 500;
+        ctx.body = { success: false, error: error.message };
+    }
+});
 // 消息发送 API
-router.post('/api/message/send', async (ctx) => {
+router.post(`${base}/message/send`, async (ctx) => {
     try {
         const body = ctx.request.body;
         const { context, bot, id, type, content } = body;
@@ -254,7 +380,7 @@ router.post('/api/message/send', async (ctx) => {
             ctx.status = 400;
             ctx.body = {
                 success: false,
-                error: 'Missing required fields: context, bot, id, type, content'
+                error: "Missing required fields: context, bot, id, type, content",
             };
             return;
         }
@@ -262,8 +388,15 @@ router.post('/api/message/send', async (ctx) => {
         // console.log 已替换为注释
         ctx.body = {
             success: true,
-            message: 'Message sent successfully',
-            data: { context, bot, id, type, content, timestamp: new Date().toISOString() }
+            message: "Message sent successfully",
+            data: {
+                context,
+                bot,
+                id,
+                type,
+                content,
+                timestamp: new Date().toISOString(),
+            },
         };
     }
     catch (error) {
@@ -272,43 +405,45 @@ router.post('/api/message/send', async (ctx) => {
     }
 });
 // 日志 API - 获取日志
-router.get('/api/logs', async (ctx) => {
+router.get(`${base}/logs`, async (ctx) => {
     try {
         const database = useDatabase();
         if (!database) {
             ctx.status = 503;
-            ctx.body = { success: false, error: 'Database not available' };
+            ctx.body = { success: false, error: "Database not available" };
             return;
         }
         // 获取查询参数
         const limit = parseInt(ctx.query.limit) || 100;
         const level = ctx.query.level;
-        const LogModel = database.model('SystemLog');
+        const LogModel = database.model("SystemLog");
         if (!LogModel) {
             ctx.status = 500;
-            ctx.body = { success: false, error: 'SystemLog model not found' };
+            ctx.body = { success: false, error: "SystemLog model not found" };
             return;
         }
         // 查询日志
         let selection = LogModel.select();
         // 按级别过滤
-        if (level && level !== 'all') {
+        if (level && level !== "all") {
             selection = selection.where({ level });
         }
         // 按时间倒序，限制数量
-        const logs = await selection.orderBy('timestamp', 'DESC').limit(limit);
+        const logs = await selection.orderBy("timestamp", "DESC").limit(limit);
         // 格式化返回数据
         const formattedLogs = logs.map((log) => ({
             level: log.level,
             name: log.name,
             message: log.message,
             source: log.source,
-            timestamp: log.timestamp instanceof Date ? log.timestamp.toISOString() : log.timestamp
+            timestamp: log.timestamp instanceof Date
+                ? log.timestamp.toISOString()
+                : log.timestamp,
         }));
         ctx.body = {
             success: true,
             data: formattedLogs,
-            total: formattedLogs.length
+            total: formattedLogs.length,
         };
     }
     catch (error) {
@@ -317,25 +452,25 @@ router.get('/api/logs', async (ctx) => {
     }
 });
 // 日志 API - 清空日志
-router.delete('/api/logs', async (ctx) => {
+router.delete(`${base}/logs`, async (ctx) => {
     try {
         const database = useDatabase();
         if (!database) {
             ctx.status = 503;
-            ctx.body = { success: false, error: 'Database not available' };
+            ctx.body = { success: false, error: "Database not available" };
             return;
         }
-        const LogModel = database.model('SystemLog');
+        const LogModel = database.model("SystemLog");
         if (!LogModel) {
             ctx.status = 500;
-            ctx.body = { success: false, error: 'SystemLog model not found' };
+            ctx.body = { success: false, error: "SystemLog model not found" };
             return;
         }
         // 删除所有日志
         await LogModel.delete({});
         ctx.body = {
             success: true,
-            message: '日志已清空'
+            message: "日志已清空",
         };
     }
     catch (error) {
@@ -344,49 +479,46 @@ router.delete('/api/logs', async (ctx) => {
     }
 });
 // 日志 API - 获取日志统计
-router.get('/api/logs/stats', async (ctx) => {
+router.get(`${base}/logs/stats`, async (ctx) => {
     try {
         const database = useDatabase();
         if (!database) {
             ctx.status = 503;
-            ctx.body = { success: false, error: 'Database not available' };
+            ctx.body = { success: false, error: "Database not available" };
             return;
         }
-        const LogModel = database.model('SystemLog');
+        const LogModel = database.model("SystemLog");
         if (!LogModel) {
             ctx.status = 500;
-            ctx.body = { success: false, error: 'SystemLog model not found' };
+            ctx.body = { success: false, error: "SystemLog model not found" };
             return;
         }
         // 获取总日志数
         const total = await LogModel.select();
         const totalCount = total.length;
         // 获取各级别日志数
-        const levels = ['info', 'warn', 'error'];
+        const levels = ["info", "warn", "error"];
         const levelCounts = {};
         for (const level of levels) {
-            const count = await LogModel
-                .select()
-                .where({ level });
+            const count = await LogModel.select().where({ level });
             levelCounts[level] = count.length;
         }
         // 获取最旧日志时间
-        const oldestLog = await LogModel
-            .select('timestamp')
-            .orderBy('timestamp', 'ASC')
+        const oldestLog = await LogModel.select("timestamp")
+            .orderBy("timestamp", "ASC")
             .limit(1);
         const oldestTimestamp = oldestLog.length > 0
-            ? (oldestLog[0].timestamp instanceof Date
+            ? oldestLog[0].timestamp instanceof Date
                 ? oldestLog[0].timestamp.toISOString()
-                : oldestLog[0].timestamp)
+                : oldestLog[0].timestamp
             : null;
         ctx.body = {
             success: true,
             data: {
                 total: totalCount,
                 byLevel: levelCounts,
-                oldestTimestamp
-            }
+                oldestTimestamp,
+            },
         };
     }
     catch (error) {
@@ -395,38 +527,36 @@ router.get('/api/logs/stats', async (ctx) => {
     }
 });
 // 日志 API - 清理旧日志（手动触发）
-router.post('/api/logs/cleanup', async (ctx) => {
+router.post(`${base}/logs/cleanup`, async (ctx) => {
     try {
         const database = useDatabase();
         if (!database) {
             ctx.status = 503;
-            ctx.body = { success: false, error: 'Database not available' };
+            ctx.body = { success: false, error: "Database not available" };
             return;
         }
-        const LogModel = database.model('SystemLog');
+        const LogModel = database.model("SystemLog");
         if (!LogModel) {
             ctx.status = 500;
-            ctx.body = { success: false, error: 'SystemLog model not found' };
+            ctx.body = { success: false, error: "SystemLog model not found" };
             return;
         }
         const { days, maxRecords } = ctx.request.body || {};
         let deletedCount = 0;
         // 按天数清理
-        if (days && typeof days === 'number' && days > 0) {
+        if (days && typeof days === "number" && days > 0) {
             const cutoffDate = new Date();
             cutoffDate.setDate(cutoffDate.getDate() - days);
-            const deleted = await LogModel
-                .delete({ timestamp: { $lt: cutoffDate } });
+            const deleted = await LogModel.delete({ timestamp: { $lt: cutoffDate } });
             deletedCount += deleted || 0;
         }
         // 按数量清理
-        if (maxRecords && typeof maxRecords === 'number' && maxRecords > 0) {
+        if (maxRecords && typeof maxRecords === "number" && maxRecords > 0) {
             const totalCount = await LogModel.select();
             if (totalCount.length > maxRecords) {
                 const excessCount = totalCount - maxRecords;
-                const oldestLogs = await LogModel
-                    .select('id', 'timestamp')
-                    .orderBy('timestamp', 'ASC')
+                const oldestLogs = await LogModel.select("id", "timestamp")
+                    .orderBy("timestamp", "ASC")
                     .limit(excessCount);
                 const idsToDelete = oldestLogs.map((log) => log.id);
                 if (idsToDelete.length > 0) {
@@ -440,7 +570,7 @@ router.post('/api/logs/cleanup', async (ctx) => {
         ctx.body = {
             success: true,
             message: `已清理 ${deletedCount} 条日志`,
-            deletedCount
+            deletedCount,
         };
     }
     catch (error) {
@@ -452,38 +582,40 @@ router.post('/api/logs/cleanup', async (ctx) => {
 // 上下文注册
 // ============================================================================
 register({
-    name: 'server',
+    name: "server",
     description: "http server",
     mounted(p) {
         return new Promise((resolve) => {
             server.listen({
-                host: '0.0.0.0',
-                port: Number((process.env.port ||= '8086')),
+                host: "0.0.0.0",
+                port: port,
             }, () => {
                 const address = server.address();
                 if (!address)
                     return;
-                const visitAddress = typeof address === 'string' ? address : `${address.address}:${address.port}`;
+                const visitAddress = typeof address === "string"
+                    ? address
+                    : `${address.address}:${address.port}`;
                 p.logger.info(`server is running at http://${visitAddress}`);
-                p.logger.info('your username is：', username);
-                p.logger.info('your password is：', password);
+                p.logger.info("your username is：", username);
+                p.logger.info("your password is：", password);
                 resolve(server);
             });
         });
     },
     dispose(s) {
         s.close();
-    }
+    },
 });
 register({
     name: "koa",
     description: "koa instance",
-    value: koa
+    value: koa,
 });
 register({
-    name: 'router',
+    name: "router",
     description: "koa router",
-    value: router
+    value: router,
 });
 koa.use(KoaBodyParser()).use(router.routes()).use(router.allowedMethods());
 //# sourceMappingURL=index.js.map