@jeffusion/bungee-types 5.21.0 → 5.22.0

package/README.md

@@ -13,13 +13,13 @@ bun add @jeffusion/bungee-types
 ## Usage
 
 ```typescript
-import type { AppConfig, RouteConfig, AuthConfig } from '@jeffusion/bungee-types';
+import type { AppConfig, RouteConfig } from '@jeffusion/bungee-types';
 
 const config: AppConfig = {
   routes: [
     {
       path: '/api',
-      upstreams: [
+      endpoints: [
         { target: 'http://localhost:3000' }
       ]
     }
@@ -32,8 +32,7 @@ const config: AppConfig = {
 ### Core Configuration Types
 - `AppConfig` - Main application configuration
 - `RouteConfig` - Route configuration with upstreams and plugins
-- `AuthConfig` - Authentication configuration
-- `Upstream` - Upstream server configuration
+- `Endpoint` - Upstream target, weight, conditions and directional rules
 
 ### Modification and Plugin Types
 - `ModificationRules` - Request/response modification rules
@@ -42,7 +41,7 @@ const config: AppConfig = {
 
 ## Type Exports
 
-### Default Export
+### Root Entry
 ```typescript
 import type { AppConfig } from '@jeffusion/bungee-types';
 ```
@@ -54,7 +53,9 @@ import type { RouteConfig } from '@jeffusion/bungee-types/types';
 
 ## Documentation
 
-For full documentation, visit [Bungee Documentation](https://github.com/jeffusion/bungee).
+For storage aggregates and runtime validation, see [configuration reference](../../docs/reference/configuration.md). Management identity and proxy Keys are plugin capabilities; an exported TypeScript shape does not bypass configuration validation.
+
+Plugin runtime interfaces use `@jeffusion/bungee-core/plugin`, not this package.
 
 ## License
 

package/dist/configuration.d.ts

@@ -0,0 +1,68 @@
+import type { AppConfig, Endpoint, PluginConfigOptions, RouteConfig, Service } from './types.js';
+export type ConfigurationId = string;
+export type Sha256Digest = `sha256:${string}`;
+export interface PluginActivation {
+    readonly plugin_name: string;
+}
+export interface PluginBinding {
+    readonly id: ConfigurationId;
+    readonly position: number;
+    readonly name: string;
+    readonly options?: PluginConfigOptions;
+    readonly enabled: boolean;
+}
+export interface UpstreamManagedBy {
+    readonly plugin: string;
+    readonly contributionId: string;
+    readonly bindingId: ConfigurationId;
+}
+type ConfigurationUpstreamPolicy = Omit<Endpoint, 'id' | 'plugins' | 'weight' | 'priority' | 'is_disabled'>;
+export interface ConfigurationUpstream extends ConfigurationUpstreamPolicy {
+    readonly id: ConfigurationId;
+    readonly position: number;
+    readonly weight: number;
+    readonly priority: number;
+    readonly is_disabled: boolean;
+    readonly managedBy?: UpstreamManagedBy;
+    readonly plugins: readonly PluginBinding[];
+}
+type ConfigurationServicePolicy = Omit<Service, 'name' | 'endpoints' | 'plugins'>;
+export interface ConfigurationService extends ConfigurationServicePolicy {
+    readonly id: ConfigurationId;
+    readonly position: number;
+    readonly name: string;
+    readonly endpoints: readonly ConfigurationUpstream[];
+    readonly plugins: readonly PluginBinding[];
+}
+type ConfigurationRoutePolicy = Omit<RouteConfig, 'path' | 'service' | 'endpoints' | 'plugins'>;
+interface ConfigurationRouteBase extends ConfigurationRoutePolicy {
+    readonly id: ConfigurationId;
+    readonly position: number;
+    readonly path: string;
+    readonly plugins: readonly PluginBinding[];
+}
+export interface ConfigurationServiceRoute extends ConfigurationRouteBase {
+    readonly service_id: ConfigurationId;
+    readonly endpoints?: never;
+}
+export interface ConfigurationDirectRoute extends ConfigurationRouteBase {
+    readonly service_id?: never;
+    readonly endpoints: readonly ConfigurationUpstream[];
+}
+export type ConfigurationRoute = ConfigurationServiceRoute | ConfigurationDirectRoute;
+type ConfigurationGlobalPolicy = Omit<AppConfig, 'config_version' | 'plugins' | 'services' | 'routes'>;
+export interface LogicalConfiguration extends ConfigurationGlobalPolicy {
+    readonly services: readonly ConfigurationService[];
+    readonly routes: readonly ConfigurationRoute[];
+    readonly plugins: readonly PluginBinding[];
+}
+export interface ConfigurationAggregate {
+    readonly logical_configuration: LogicalConfiguration;
+    readonly plugin_activations: readonly PluginActivation[];
+}
+export interface CommittedConfigurationSnapshot {
+    readonly revision: number;
+    readonly content_hash: Sha256Digest;
+    readonly aggregate: ConfigurationAggregate;
+}
+export {};

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 export * from './types.js';
-export * from './config-v2.js';
+export * from './configuration.js';
 export * from './rate-limit.js';
 export * from './daemon-control.js';
 export * from './publication-policy.js';
 export * from './sse-log.js';
+export * from './plugin-config-contract.js';

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from './types.js';
-export * from './config-v2.js';
+export * from './configuration.js';
 export * from './rate-limit.js';
 export * from './daemon-control.js';
 export * from './publication-policy.js';
 export * from './sse-log.js';
+export * from './plugin-config-contract.js';

package/dist/plugin-config-contract.d.ts

@@ -0,0 +1,14 @@
+/** Runtime instance placement declared by a plugin manifest. */
+export type PluginRuntimeScope = 'global' | 'scoped' | 'global-and-scoped';
+/** Whitelist of scalar tuples across independent, top-level config fields.
+ * Omitted fields do not match a tuple; an entirely omitted optional group is ignored.
+ * Required-field checks remain the responsibility of configSchema.
+ */
+export interface PluginAllowedTuplesConstraint {
+    readonly type: 'allowed-tuples';
+    readonly fields: readonly string[];
+    readonly tuples: readonly (readonly (string | number | boolean | null)[])[];
+    readonly message?: string;
+}
+export type PluginConfigConstraint = PluginAllowedTuplesConstraint;
+export declare function pluginConfigConstraintSatisfied(options: Readonly<Record<string, unknown>>, constraint: PluginConfigConstraint): boolean;

package/dist/plugin-config-contract.js

@@ -0,0 +1,7 @@
+export function pluginConfigConstraintSatisfied(options, constraint) {
+    const values = constraint.fields.map(field => options[field]);
+    if (values.every(value => value === undefined))
+        return true;
+    return constraint.tuples.some(tuple => tuple.length === values.length
+        && tuple.every((value, index) => value === values[index]));
+}

package/dist/types.d.ts

@@ -258,7 +258,7 @@ export interface PluginConfig {
      * Plugin 名称（唯一标识符）
      * 这是插件的唯一标识，用于引用和管理插件
      *
-     * 示例: "ai-transformer", "token-cache"
+     * 示例: "llm-protocol-adapter", "token-cache"
      */
     name: string;
     /**

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@jeffusion/bungee-types",
-  "version": "5.21.0",
+  "version": "5.22.0",
   "description": "TypeScript type definitions for Bungee",
   "type": "module",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
-    "build": "tsc",
+    "build": "rm -rf dist && tsc",
     "prepublishOnly": "bun run build",
-    "test": "bun run build && bun test tests/published-runtime.test.ts"
+    "test": "bun run build && bun test tests/"
   },
   "exports": {
     ".": {

package/dist/config-v2.d.ts

@@ -1,68 +0,0 @@
-import type { AppConfig, Endpoint, PluginConfigOptions, RouteConfig, Service } from './types.js';
-export type ConfigurationId = string;
-export type Sha256Digest = `sha256:${string}`;
-export interface PluginActivationV2 {
-    readonly plugin_name: string;
-}
-export interface PluginBindingV2 {
-    readonly id: ConfigurationId;
-    readonly position: number;
-    readonly name: string;
-    readonly options?: PluginConfigOptions;
-    readonly enabled: boolean;
-}
-export interface UpstreamManagedByV2 {
-    readonly plugin: string;
-    readonly contributionId: string;
-    readonly bindingId: ConfigurationId;
-}
-type UpstreamPolicyV2 = Omit<Endpoint, 'id' | 'plugins' | 'weight' | 'priority' | 'is_disabled'>;
-export interface UpstreamV2 extends UpstreamPolicyV2 {
-    readonly id: ConfigurationId;
-    readonly position: number;
-    readonly weight: number;
-    readonly priority: number;
-    readonly is_disabled: boolean;
-    readonly managedBy?: UpstreamManagedByV2;
-    readonly plugins: readonly PluginBindingV2[];
-}
-type ServicePolicyV2 = Omit<Service, 'name' | 'endpoints' | 'plugins'>;
-export interface ServiceV2 extends ServicePolicyV2 {
-    readonly id: ConfigurationId;
-    readonly position: number;
-    readonly name: string;
-    readonly endpoints: readonly UpstreamV2[];
-    readonly plugins: readonly PluginBindingV2[];
-}
-type RoutePolicyV2 = Omit<RouteConfig, 'path' | 'service' | 'endpoints' | 'plugins'>;
-interface RouteV2Base extends RoutePolicyV2 {
-    readonly id: ConfigurationId;
-    readonly position: number;
-    readonly path: string;
-    readonly plugins: readonly PluginBindingV2[];
-}
-export interface ServiceRouteV2 extends RouteV2Base {
-    readonly service_id: ConfigurationId;
-    readonly endpoints?: never;
-}
-export interface DirectRouteV2 extends RouteV2Base {
-    readonly service_id?: never;
-    readonly endpoints: readonly UpstreamV2[];
-}
-export type RouteV2 = ServiceRouteV2 | DirectRouteV2;
-type GlobalPolicyV2 = Omit<AppConfig, 'config_version' | 'plugins' | 'services' | 'routes'>;
-export interface LogicalConfigurationV2 extends GlobalPolicyV2 {
-    readonly services: readonly ServiceV2[];
-    readonly routes: readonly RouteV2[];
-    readonly plugins: readonly PluginBindingV2[];
-}
-export interface ConfigurationAggregateV2 {
-    readonly logical_configuration: LogicalConfigurationV2;
-    readonly plugin_activations: readonly PluginActivationV2[];
-}
-export interface CommittedConfigurationSnapshotV2 {
-    readonly revision: number;
-    readonly content_hash: Sha256Digest;
-    readonly aggregate: ConfigurationAggregateV2;
-}
-export {};