@jeffusion/bungee-types 4.0.0 → 4.2.0

package/dist/types.d.ts

@@ -71,76 +71,135 @@ export interface AuthConfig {
      */
     tokens: string[];
 }
-export interface Upstream extends ModificationRules {
+export interface Endpoint extends ModificationRules {
     id?: string;
     target: string;
     weight?: number;
     priority?: number;
     plugins?: Array<PluginConfig | string>;
-    disabled?: boolean;
+    is_disabled?: boolean;
     description?: string;
     condition?: string;
 }
 export interface StickySessionConfig {
     enabled: boolean;
-    keyExpression?: string;
+    key_expression?: string;
 }
 export interface RouteTimeoutsConfig {
-    connectMs?: number;
-    requestMs?: number;
+    connect_ms?: number;
+    request_ms?: number;
 }
 export interface FailoverPassiveHealthConfig {
-    consecutiveFailures?: number;
-    healthySuccesses?: number;
-    autoDisableThreshold?: number;
-    autoEnableOnActiveHealthCheck?: boolean;
+    consecutive_failures?: number;
+    healthy_successes?: number;
+    auto_disable_threshold?: number;
+    auto_enable_on_active_health_check?: boolean;
 }
 export interface FailoverRecoveryConfig {
-    probeIntervalMs?: number;
-    probeTimeoutMs?: number;
+    probe_interval_ms?: number;
+    probe_timeout_ms?: number;
 }
 export interface FailoverSlowStartConfig {
     enabled: boolean;
-    durationMs?: number;
-    initialWeightFactor?: number;
+    duration_ms?: number;
+    initial_weight_factor?: number;
 }
 export interface FailoverHealthCheckConfig {
     enabled: boolean;
-    intervalMs?: number;
-    timeoutMs?: number;
+    interval_ms?: number;
+    timeout_ms?: number;
     path?: string;
     method?: string;
-    expectedStatus?: number[];
-    unhealthyThreshold?: number;
-    healthyThreshold?: number;
+    expected_status?: number[];
+    unhealthy_threshold?: number;
+    healthy_threshold?: number;
     body?: string;
-    contentType?: string;
+    content_type?: string;
     headers?: Record<string, string>;
     query?: Record<string, string>;
 }
+export interface Service {
+    name: string;
+    endpoints: Endpoint[];
+    plugins?: Array<PluginConfig | string>;
+    health_check?: FailoverHealthCheckConfig;
+    failover?: FailoverConfig;
+    sticky_session?: StickySessionConfig;
+}
 export interface FailoverConfig {
     enabled: boolean;
-    retryOn?: number | string | (number | string)[];
-    passiveHealth?: FailoverPassiveHealthConfig;
+    retry_on?: number | string | (number | string)[];
+    passive_health?: FailoverPassiveHealthConfig;
     recovery?: FailoverRecoveryConfig;
-    slowStart?: FailoverSlowStartConfig;
-    healthCheck?: FailoverHealthCheckConfig;
+    slow_start?: FailoverSlowStartConfig;
+    health_check?: FailoverHealthCheckConfig;
+}
+export interface RateLimitConfig {
+    enabled: boolean;
+    requests_per_second?: number;
+    burst?: number;
+    key_expression?: string;
+}
+export interface CorsConfig {
+    enabled: boolean;
+    allowed_origins?: string[];
+    allowed_methods?: string[];
+    allowed_headers?: string[];
+    expose_headers?: string[];
+    allow_credentials?: boolean;
+    max_age?: number;
+}
+export interface DirectResponseConfig {
+    enabled: boolean;
+    status: number;
+    body?: string;
+    content_type?: string;
+    headers?: Record<string, string>;
+}
+export interface RedirectConfig {
+    enabled: boolean;
+    url: string;
+    status?: 301 | 302 | 307 | 308;
+    preserve_path?: boolean;
+}
+export interface ResponseRuleConfig {
+    enabled: boolean;
+    path: string;
+    match_type?: 'exact' | 'prefix' | 'regex';
+    type: 'direct_response' | 'redirect';
+    status?: number;
+    body?: string;
+    content_type?: string;
+    headers?: Record<string, string>;
+    url?: string;
+    preserve_path?: boolean;
+}
+export interface RetryConfig {
+    enabled: boolean;
+    max_retries?: number;
+    retry_on?: number[];
+    per_retry_timeout_ms?: number;
 }
 export interface RouteConfig extends ModificationRules {
     path: string;
-    pathRewrite?: Record<string, string>;
+    service?: string;
+    endpoints?: Endpoint[];
+    path_rewrite?: Record<string, string>;
     auth?: AuthConfig;
     plugins?: Array<PluginConfig | string>;
-    stickySession?: StickySessionConfig;
-    upstreams: Upstream[];
     timeouts?: RouteTimeoutsConfig;
-    failover?: FailoverConfig;
+    rate_limit?: RateLimitConfig;
+    cors?: CorsConfig;
+    response_rules?: ResponseRuleConfig[];
+    direct_response?: DirectResponseConfig;
+    redirect?: RedirectConfig;
+    retry?: RetryConfig;
 }
 export interface LoggingConfig {
     body?: {
         enabled: boolean;
-        maxSize: number;
-        retentionDays: number;
+        max_size: number;
+        retention_days: number;
     };
 }
 /**
@@ -177,12 +236,29 @@ 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 {
-    configVersion?: number;
-    logLevel?: string;
-    bodyParserLimit?: string;
+    config_version?: number;
+    log_level?: string;
+    body_parser_limit?: string;
     auth?: AuthConfig;
     logging?: LoggingConfig;
     plugins?: Array<PluginConfig | string>;
+    services?: Service[];
     routes: RouteConfig[];
 }

package/package.json

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