feat: 更新版本号并优化插件管理功能

- 将项目版本号从 0.1.7 更新至 0.1.8
- 优化 `DocSplitter` 插件的参数描述
- 简化 `DocBase` 中 `docLoaders` 的返回逻辑
- 在 `app` 包中添加 `es-toolkit` 和 `zod-to-json-schema` 依赖
- 更新 `README.md` 中的 TODO 列表
- 在插件管理 API 中增加参数校验 schema 的转换功能

Author: SOVLOOKUP

README.md

@@ -44,10 +44,9 @@ docker-compose up -d
 
 ### 下载安装客户端
 
-<!-- 客户端版（插件、多模态重构结束后才会做） -->
-<!-- 动态选择知识库目录功能 -->
+<!-- 客户端版 -->
+<!-- 多知识库前端页面 -->
 <!-- 本地自动部署 meilisearch -->
-<!-- 制作为 aiaw 插件（MCP协议） -->
 <!-- 整合 aiaw 前端 -->
 <!-- 制作图文发小红书 -->
 
@@ -67,28 +66,23 @@ docker-compose up -d
 
 <!-- 下一步-->
 <!-- TODO 开一个可信插件仓库 -->
-<!-- TODO 前端插件管理页面 -->
-<!-- TODO 文档补充搜索参数和插件管理 -->
-<!-- TODO 制作宣传视频发 bilibili -->
-
-<!-- 工程化 -->
 <!-- TODO 打点日志 -->
-
-<!-- 插件需完善 -->
-<!-- TODO 添加数据持久化层，将插件安装、配置、映射信息存入 -->
-<!-- TODO 启动时加载全部插件 -->
-
-<!-- 功能 -->
 <!-- TODO 文件加载器、分割器支持自定义向量，搜索同时搜索docs和chunks -->
 <!-- TODO 数据持久化层 -->
-<!-- TODO 插件完善 -->
+<!-- TODO 添加数据持久化层，将插件安装、配置、映射信息存入 -->
+<!-- TODO 启动时加载全部插件 -->
+<!-- TODO 前端插件管理页面 -->
+<!-- TODO 文档补充更多搜索参数/插件管理 -->
 <!-- TODO 多知识库 -->
 <!-- TODO 客户端版 -->
+<!-- TODO 文档补充客户端/多知识库 -->
+<!-- TODO 制作宣传视频发 bilibili -->
 <!-- TODO 前端 i8n -->
 
 <!-- 企业版 -->
-<!-- 多知识库管理 -->
-<!-- 知识库粒度的权限管理（webdav权限+搜索权限控制） -->
 <!-- 文件时光旅行功能，记录修改记录 -->
-<!-- 知识库分享、挂载 -->
+<!-- 知识库 MCP 服务 -->
+<!-- 多用户 -->
 <!-- OIDC 认证 -->
+<!-- 知识库粒度的权限管理（webdav权限+搜索权限控制） -->
+<!-- 知识库分享、挂载 -->

bun.lock

@@ -14,14 +14,16 @@
       "name": "app",
       "dependencies": {
         "@hey-api/client-fetch": "^0.8.3",
-        "nypm": "^0.6.0",
       },
       "devDependencies": {
         "@hey-api/openapi-ts": "^0.64.12",
         "@hono/swagger-ui": "^0.5.1",
         "@hono/zod-openapi": "^0.19.2",
         "core": "workspace:*",
+        "es-toolkit": "^1.33.0",
         "hono": "^4.7.4",
+        "nypm": "^0.6.0",
+        "zod-to-json-schema": "^3.24.4",
       },
     },
     "packages/core": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docbase",
-  "version": "0.1.7",
+  "version": "0.1.8",
   "type": "module",
   "workspaces": [
     "packages/*"

packages/app/package.json

@@ -11,10 +11,12 @@
     "@hono/zod-openapi": "^0.19.2",
     "hono": "^4.7.4",
     "core": "workspace:*",
+    "es-toolkit": "^1.33.0",
+    "nypm": "^0.6.0",
+    "zod-to-json-schema": "^3.24.4",
     "@hey-api/openapi-ts": "^0.64.12"
   },
   "dependencies": {
-    "@hey-api/client-fetch": "^0.8.3",
-    "nypm": "^0.6.0"
+    "@hey-api/client-fetch": "^0.8.3"
   }
-}
+}

packages/app/src/apis/plugin/index.ts

@@ -1,6 +1,8 @@
 import { createRoute, z } from "@hono/zod-openapi";
 import { OpenAPIHono } from "@hono/zod-openapi";
 import { DocBasePlugin } from "core/src";
+import { merge } from "es-toolkit";
+import { zodToJsonSchema } from "zod-to-json-schema";
 
 const app = new OpenAPIHono();
 
@@ -109,6 +111,8 @@ const listPlugin = createRoute({
               homepage: z.string().optional(),
               /** 插件图标 */
               icon: z.string().optional(),
+              /** 插件参数校验 schema */
+              paramsSchema: z.any().optional(),
             })),
             docSplitter: z.object({
               /** 插件类型，固定为"DocLoader" */
@@ -127,6 +131,8 @@ const listPlugin = createRoute({
               homepage: z.string().optional(),
               /** 插件图标 */
               icon: z.string().optional(),
+              /** 插件参数校验 schema */
+              paramsSchema: z.any().optional(),
             }),
           }),
         },
@@ -233,11 +239,13 @@ app.openapi(addPlugin, async (c) => {
   }
 })
 
+const convertJSONSchema = (i: { paramsSchema?: z.ZodType; }) => merge(i, { paramsSchema: i.paramsSchema ? zodToJsonSchema(i.paramsSchema) : i.paramsSchema })
+
 app.openapi(listPlugin, async (c) => {
   const docBase = c.get("docbase");
   return c.json({
-    docLoaders: docBase.docLoaders.map(i => i),
-    docSplitter: docBase.docSplitter,
+    docLoaders: docBase.docLoaders.map(convertJSONSchema).toArray(),
+    docSplitter: convertJSONSchema(docBase.docSplitter),
   });
 })
 

packages/core/src/DocBase.ts

@@ -88,9 +88,7 @@ export class DocBase {
   /** 获取所有可用文档加载器 */
   get docLoaders() {
     // 去掉 func init
-    return Array.from(
-      this.#docLoaders.values().map((v) => omit(v, ["func", "init"]))
-    );
+    return this.#docLoaders.values().map((v) => omit(v, ["func", "init"]));
   }
 
   get docSplitter() {

packages/core/src/DocSplitter.ts

@@ -22,8 +22,7 @@ export interface DocSplitterPlugin<T extends AnyZodObject = AnyZodObject>
 }
 
 const DocSplitterPluginParams = z.object({
-  /** 每个文本块的长度 */
-  len: z.number(),
+  len: z.number().describe("分割得到的每个文本块的长度"),
 })
 
 // 默认实现 ============