@jeffusion/bungee-types 2.3.1 → 3.0.0

package/dist/types.d.ts

@@ -1,3 +1,19 @@
+/**
+ * 插件配置值类型
+ * 定义了插件配置中允许的值类型，比 `any` 更具体
+ *
+ * 这个类型约束了配置值可以是：
+ * - 基本类型: string, number, boolean, null
+ * - 数组: 元素可以是任意 PluginConfigValue
+ * - 对象: 值可以是任意 PluginConfigValue
+ */
+export type PluginConfigValue = string | number | boolean | null | PluginConfigValue[] | {
+    [key: string]: PluginConfigValue;
+};
+/**
+ * 插件配置选项类型
+ */
+export type PluginConfigOptions = Record<string, PluginConfigValue>;
 export interface ModificationRules {
     headers?: {
         add?: Record<string, string>;
@@ -56,10 +72,14 @@ export interface AuthConfig {
     tokens: string[];
 }
 export interface Upstream extends ModificationRules {
+    id?: string;
     target: string;
     weight?: number;
     priority?: number;
     plugins?: Array<PluginConfig | string>;
+    disabled?: boolean;
+    description?: string;
+    condition?: string;
 }
 export interface RouteConfig extends ModificationRules {
     path: string;
@@ -69,13 +89,15 @@ export interface RouteConfig extends ModificationRules {
     upstreams: Upstream[];
     failover?: {
         enabled: boolean;
-        retryableStatusCodes: number[];
+        retryableStatusCodes?: number | string | (number | string)[];
         consecutiveFailuresThreshold?: number;
         recoveryIntervalMs?: number;
         recoveryTimeoutMs?: number;
         healthyThreshold?: number;
         requestTimeoutMs?: number;
         connectTimeoutMs?: number;
+        autoDisableThreshold?: number;
+        autoEnableOnHealthCheck?: boolean;
         slowStart?: {
             enabled: boolean;
             durationMs?: number;
@@ -90,6 +112,10 @@ export interface RouteConfig extends ModificationRules {
             expectedStatus?: number[];
             unhealthyThreshold?: number;
             healthyThreshold?: number;
+            body?: string;
+            contentType?: string;
+            headers?: Record<string, string>;
+            query?: Record<string, string>;
         };
     };
 }
@@ -102,16 +128,33 @@ export interface LoggingConfig {
 }
 /**
  * Plugin 配置
+ *
+ * 支持两种引用方式：
+ * 1. 通过 name 引用（推荐）：自动从插件目录解析路径
+ * 2. 通过 path 引用（高级）：手动指定插件文件路径
  */
 export interface PluginConfig {
     /**
-     * Plugin 文件路径（绝对路径或相对于配置文件的路径）
+     * Plugin 名称（唯一标识符）
+     * 这是插件的唯一标识，用于引用和管理插件
+     *
+     * 示例: "ai-transformer", "token-cache"
      */
-    path: string;
+    name: string;
+    /**
+     * Plugin 文件路径（可选，仅用于高级场景）
+     * 如果指定了 path，将直接加载该路径的插件文件
+     * 如果未指定，将通过 name 在插件目录中查找
+     *
+     * 支持：
+     * - 绝对路径: "/absolute/path/to/plugin.ts"
+     * - 相对路径（相对于配置文件）: "./plugins/custom-plugin.ts"
+     */
+    path?: string;
     /**
      * 传递给 Plugin 的初始化选项
      */
-    options?: Record<string, any>;
+    options?: PluginConfigOptions;
     /**
      * Plugin 是否启用（默认 true）
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeffusion/bungee-types",
-  "version": "2.3.1",
+  "version": "3.0.0",
   "description": "TypeScript type definitions for Bungee",
   "main": "./dist/index.d.ts",
   "types": "./dist/index.d.ts",
@@ -27,6 +27,11 @@
     "*.ts",
     "README.md"
   ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jeffusion/bungee",
+    "directory": "packages/types"
+  },
   "license": "MIT",
   "devDependencies": {
     "bun-types": "^1.3.2",