schema 移到编译阶段

Author: SOVLOOKUP

package.json

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

packages/app/package.json

@@ -13,7 +13,6 @@
     "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": {

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

@@ -1,8 +1,6 @@
 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();
 
@@ -111,8 +109,6 @@ const listPlugin = createRoute({
               homepage: z.string().optional(),
               /** 插件图标 */
               icon: z.string().optional(),
-              /** 插件参数校验 schema */
-              paramsSchema: z.any().optional(),
             })),
             docSplitter: z.object({
               /** 插件类型，固定为"DocLoader" */
@@ -131,8 +127,6 @@ const listPlugin = createRoute({
               homepage: z.string().optional(),
               /** 插件图标 */
               icon: z.string().optional(),
-              /** 插件参数校验 schema */
-              paramsSchema: z.any().optional(),
             }),
           }),
         },
@@ -239,13 +233,11 @@ 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(convertJSONSchema).toArray(),
-    docSplitter: convertJSONSchema(docBase.docSplitter),
+    docLoaders: docBase.docLoaders.toArray(),
+    docSplitter: docBase.docSplitter,
   });
 })
 

packages/app/src/plugins/pkgManager.ts

@@ -1,6 +1,7 @@
 import { removeDependency, addDependency } from "nypm"
 import { exists, readJSON } from "fs-extra"
 import { join } from "path"
+import { DocBasePlugin } from "core/src"
 
 export class PackageManager {
     #path: string
@@ -12,7 +13,7 @@ export class PackageManager {
         this.#modulePath = join(path, "node_modules")
     }
 
-    import = async (name: string) => {
+    import = async (name: string): Promise<DocBasePlugin> => {
         const m = await import(join(this.#modulePath, name))
         if (m.default) {
             return m.default

packages/core/src/DocSplitter.ts

@@ -36,7 +36,6 @@ export const defaultDocSplitterPlugin: DocSplitterPlugin<typeof DocSplitterPlugi
   name: "default",
   version,
   type: "DocSplitter",
-  paramsSchema: DocSplitterPluginParams,
   init:
     ({ len }) =>
       (text: string) => {

packages/core/src/Plugin.ts

@@ -27,8 +27,6 @@ export interface BasePlugin<
   homepage?: string;
   /** 插件图标 */
   icon?: string;
-  /** 插件参数校验 schema */
-  paramsSchema?: PluginParams;
   /**
    * 插件初始化函数
    * @param params - 插件初始化参数

packages/docbase-plugin-docloader-extra/build.ts

@@ -1,6 +1,15 @@
-Bun.build({
-    entrypoints: ["./index.ts"],
-    outdir: "./dist",
-    minify: true,
-    target: "bun",
-})
+import { zodToJsonSchema } from "zod-to-json-schema";
+import { schema } from "./index"
+import { write } from "bun";
+
+Promise.all(
+    [
+        Bun.build({
+            entrypoints: ["./index.ts"],
+            outdir: "./dist",
+            minify: true,
+            target: "bun",
+        }),
+        write("dist/schema.json", JSON.stringify(zodToJsonSchema(schema), null, 2))
+    ]
+)

packages/docbase-plugin-docloader-extra/index.ts

@@ -11,9 +11,9 @@ import { basename } from "path";
 import { single, transform } from "itertools-ts"
 import { z } from "zod"
 
-const paramsSchema = z.object({})
+export const schema = z.object({})
 
-const plugin: DocBasePlugin<typeof paramsSchema> = {
+const plugin: DocBasePlugin<typeof schema> = {
     type: "DocLoader",
     exts: exts,
     name: name,
@@ -23,7 +23,6 @@ const plugin: DocBasePlugin<typeof paramsSchema> = {
     description: description,
     homepage,
     icon,
-    paramsSchema,
     init: async () => {
         return async (path) => {
             if (basename(path).startsWith("~$")) {

packages/docbase-plugin-docloader-extra/package.json

@@ -7,6 +7,7 @@
   "homepage": "https://docbase.cc",
   "main": "dist/index.js",
   "module": "dist/index.js",
+  "schema": "dist/schema.json",
   "description": "DocBase 额外文档加载插件，支持更多格式",
   "icon": "https://docbase.cc/logo.svg",
   "exts": [
@@ -23,6 +24,7 @@
     "test": "bun run ./test.ts"
   },
   "devDependencies": {
+    "zod-to-json-schema": "^3.24.4",
     "@llm-tools/embedjs": "^0.1.28",
     "@llm-tools/embedjs-interfaces": "^0.1.28",
     "@llm-tools/embedjs-loader-csv": "^0.1.28",