@jeffusion/bungee-types 4.1.0 → 4.3.0

package/dist/types.d.ts

@@ -81,22 +81,28 @@ export interface Endpoint extends ModificationRules {
     description?: string;
     condition?: string;
 }
-export interface StickySessionConfig {
-    enabled: boolean;
-    key_expression?: string;
-}
 export interface RouteTimeoutsConfig {
-    connect_ms?: number;
     request_ms?: number;
 }
+/**
+ * Service-level transport timeouts.
+ * Describes how to connect to and exchange data with this pool of upstreams.
+ * Route-level request deadline (RouteTimeoutsConfig.request_ms) is unaffected.
+ */
+export interface ServiceTimeoutsConfig {
+    connect_ms?: number;
+    send_ms?: number;
+    read_ms?: number;
+}
 export interface FailoverPassiveHealthConfig {
     consecutive_failures?: number;
     healthy_successes?: number;
     auto_disable_threshold?: number;
-    auto_enable_on_active_health_check?: boolean;
 }
 export interface FailoverRecoveryConfig {
-    probe_interval_ms?: number;
+    /** UNHEALTHY 重新允许尝试的退避基准间隔（实际退避 = base × 2^recovery_attempt_count + 20% jitter） */
+    backoff_base_ms?: number;
+    /** HALF_OPEN/UNHEALTHY 状态下请求的超时切片 */
     probe_timeout_ms?: number;
 }
 export interface FailoverSlowStartConfig {
@@ -104,7 +110,11 @@ export interface FailoverSlowStartConfig {
     duration_ms?: number;
     initial_weight_factor?: number;
 }
-export interface FailoverHealthCheckConfig {
+/**
+ * Service-level active health check configuration.
+ * Independent subsystem — no longer nested under FailoverConfig.
+ */
+export interface ServiceHealthCheckConfig {
     enabled: boolean;
     interval_ms?: number;
     timeout_ms?: number;
@@ -117,21 +127,43 @@ export interface FailoverHealthCheckConfig {
     content_type?: string;
     headers?: Record<string, string>;
     query?: Record<string, string>;
+    /** 主动健康检查恢复后自动 re-enable 被 auto_disable 的 upstream */
+    auto_enable_on_active_health_check?: boolean;
+}
+export interface HashPolicyConfig {
+    /** 直接读 header 名作为 hash 输入（简单场景） */
+    header?: string;
+    /** 表达式返回值作为 hash 输入（可 access headers/body/url/method/env 全 context） */
+    expression?: string;
+}
+export interface LoadBalancingConfig {
+    policy: 'weighted_random' | 'round_robin' | 'least_requests' | 'consistent_hash';
+    /** 仅 policy='consistent_hash' 时有意义 */
+    hash_policy?: HashPolicyConfig;
 }
 export interface Service {
     name: string;
     endpoints: Endpoint[];
-    health_check?: FailoverHealthCheckConfig;
+    plugins?: Array<PluginConfig | string>;
+    health_check?: ServiceHealthCheckConfig;
     failover?: FailoverConfig;
-    sticky_session?: StickySessionConfig;
+    load_balancing?: LoadBalancingConfig;
+    timeouts?: ServiceTimeoutsConfig;
 }
 export interface FailoverConfig {
     enabled: boolean;
     retry_on?: number | string | (number | string)[];
+    /**
+     * 响应内容触发关键字列表（与 retry_on 为 OR 关系）。
+     * 任一关键字在响应体中出现即触发 failover（大小写敏感子串匹配）。
+     *
+     * 流式：first-peek 首 4KB / 首个 SSE event；非流式：完整 body（1MB 上限）。
+     * 中段（5KB 后）错误无配置层方案。
+     */
+    retry_on_response?: string[];
     passive_health?: FailoverPassiveHealthConfig;
     recovery?: FailoverRecoveryConfig;
     slow_start?: FailoverSlowStartConfig;
-    health_check?: FailoverHealthCheckConfig;
 }
 export interface RateLimitConfig {
     enabled: boolean;
@@ -235,6 +267,22 @@ export interface PluginConfig {
      */
     enabled?: boolean;
 }
+/** Plugin execution phase in the three-phase pipeline */
+export type PluginPhase = 'route' | 'service' | 'upstream';
+/**
+ * Result of onInterceptRequest hook.
+ * Distinguishes terminal short-circuit from failover trigger.
+ * - respond: terminal short-circuit, no failover
+ * - failover: trigger upstream switch (only valid in Phase 3/upstream)
+ * - undefined: continue normal flow
+ */
+export type InterceptResult = {
+    action: 'respond';
+    response: Response;
+} | {
+    action: 'failover';
+    reason?: string;
+} | undefined;
 export interface AppConfig {
     config_version?: number;
     log_level?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jeffusion/bungee-types",
-  "version": "4.1.0",
+  "version": "4.3.0",
   "description": "TypeScript type definitions for Bungee",
   "main": "./dist/index.d.ts",
   "types": "./dist/index.d.ts",