@jeffusion/bungee-types 2.0.0

package/README.md

@@ -0,0 +1,61 @@
+# @jeffusion/bungee-types
+
+TypeScript type definitions for [Bungee](https://github.com/jeffusion/bungee) - a high-performance reverse proxy server.
+
+## Installation
+
+```bash
+npm install @jeffusion/bungee-types
+# or
+bun add @jeffusion/bungee-types
+```
+
+## Usage
+
+```typescript
+import type { AppConfig, RouteConfig, AuthConfig } from '@jeffusion/bungee-types';
+
+const config: AppConfig = {
+  routes: [
+    {
+      path: '/api',
+      upstreams: [
+        { target: 'http://localhost:3000' }
+      ]
+    }
+  ]
+};
+```
+
+## Available Types
+
+### Core Configuration Types
+- `AppConfig` - Main application configuration
+- `RouteConfig` - Route configuration with upstreams and plugins
+- `AuthConfig` - Authentication configuration
+- `Upstream` - Upstream server configuration
+
+### Modification and Plugin Types
+- `ModificationRules` - Request/response modification rules
+- `PluginConfig` - Plugin configuration
+- `LoggingConfig` - Logging configuration
+
+## Type Exports
+
+### Default Export
+```typescript
+import type { AppConfig } from '@jeffusion/bungee-types';
+```
+
+### Type-Only Export
+```typescript
+import type { RouteConfig } from '@jeffusion/bungee-types/types';
+```
+
+## Documentation
+
+For full documentation, visit [Bungee Documentation](https://github.com/jeffusion/bungee).
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/types.d.ts

@@ -0,0 +1,120 @@
+export interface ModificationRules {
+    headers?: {
+        add?: Record<string, string>;
+        replace?: Record<string, string>;
+        remove?: string[];
+    };
+    body?: {
+        add?: Record<string, any>;
+        replace?: Record<string, any>;
+        remove?: string[];
+        default?: Record<string, any>;
+    };
+}
+/**
+ * Token 认证配置
+ *
+ * @example
+ * // 简单 token 验证
+ * {
+ *   "enabled": true,
+ *   "tokens": ["{{ env.API_TOKEN }}"]
+ * }
+ *
+ * @example
+ * // 多 token 支持（多租户场景）
+ * {
+ *   "enabled": true,
+ *   "tokens": [
+ *     "{{ env.TENANT_A_TOKEN }}",
+ *     "{{ env.TENANT_B_TOKEN }}",
+ *     "hardcoded-dev-token"
+ *   ]
+ * }
+ *
+ * 行为说明：
+ * - 从 Authorization header 提取 token（支持 "Bearer <token>" 或直接 "<token>"）
+ * - 使用恒定时间比较进行 token 验证（防止时序攻击）
+ * - 认证通过后，自动移除 Authorization header（不会转发给 upstream）
+ */
+export interface AuthConfig {
+    /**
+     * 是否启用认证
+     */
+    enabled: boolean;
+    /**
+     * 有效的 token 列表（支持表达式）
+     * 支持多个 token，适用于多租户、多客户端场景
+     * 示例: ["{{ env.API_TOKEN }}", "sk-1234567890"]
+     */
+    tokens: string[];
+}
+export interface Upstream extends ModificationRules {
+    target: string;
+    weight?: number;
+    priority?: number;
+    plugins?: Array<PluginConfig | string>;
+}
+export interface RouteConfig extends ModificationRules {
+    path: string;
+    pathRewrite?: Record<string, string>;
+    auth?: AuthConfig;
+    plugins?: Array<PluginConfig | string>;
+    upstreams: Upstream[];
+    failover?: {
+        enabled: boolean;
+        retryableStatusCodes: number[];
+        consecutiveFailuresThreshold?: number;
+        recoveryIntervalMs?: number;
+        recoveryTimeoutMs?: number;
+        healthyThreshold?: number;
+        requestTimeoutMs?: number;
+        connectTimeoutMs?: number;
+        slowStart?: {
+            enabled: boolean;
+            durationMs?: number;
+            initialWeightFactor?: number;
+        };
+        healthCheck?: {
+            enabled: boolean;
+            intervalMs?: number;
+            timeoutMs?: number;
+            path?: string;
+            method?: string;
+            expectedStatus?: number[];
+            unhealthyThreshold?: number;
+            healthyThreshold?: number;
+        };
+    };
+}
+export interface LoggingConfig {
+    body?: {
+        enabled: boolean;
+        maxSize: number;
+        retentionDays: number;
+    };
+}
+/**
+ * Plugin 配置
+ */
+export interface PluginConfig {
+    /**
+     * Plugin 文件路径（绝对路径或相对于配置文件的路径）
+     */
+    path: string;
+    /**
+     * 传递给 Plugin 的初始化选项
+     */
+    options?: Record<string, any>;
+    /**
+     * Plugin 是否启用（默认 true）
+     */
+    enabled?: boolean;
+}
+export interface AppConfig {
+    bodyParserLimit?: string;
+    auth?: AuthConfig;
+    logging?: LoggingConfig;
+    plugins?: Array<PluginConfig | string>;
+    routes: RouteConfig[];
+}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@jeffusion/bungee-types",
+  "version": "2.0.0",
+  "description": "TypeScript type definitions for Bungee",
+  "main": "./dist/index.d.ts",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "prepublishOnly": "bun run build",
+    "test": "echo 'No tests for types package yet'"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts"
+    }
+  },
+  "keywords": [
+    "bungee",
+    "types",
+    "typescript"
+  ],
+  "files": [
+    "dist/",
+    "*.ts",
+    "README.md"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "bun-types": "^1.3.2",
+    "typescript": "^5.7.2"
+  }
+}