@zucker-framework/config 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,382 @@
+import { DatabaseAdapter } from '@zucker-framework/core';
+import { EventEmitter2 } from 'eventemitter2';
+import { DynamicModule, Type, InjectionToken, OptionalFactoryDependency, CanActivate, ExecutionContext } from '@nestjs/common';
+import { FeatureFlagEvaluator } from '@zucker-framework/feature-flags';
+export { FeatureFlagDecisionReason, FeatureFlagEnvironmentReader, FeatureFlagEvaluation, FeatureFlagEvaluator, FlagContext, FlagDefinition, FlagRule, FlagRuleType, defaultFeatureFlagEnvKey } from '@zucker-framework/feature-flags';
+export { DATABASE_ADAPTER } from '@zucker-framework/crud';
+
+/**
+ * ConfigScopeCustomizer — implement to register custom config scopes.
+ *
+ * Reference: jetlinks ConfigScopeCustomizer
+ */
+interface ConfigScopeCustomizer {
+    custom(manager: ConfigScopeManager): void;
+}
+/**
+ * ConfigScopeManager — register and retrieve config scopes.
+ *
+ * Reference: jetlinks ConfigScopeManager + SimpleConfigManager
+ */
+declare class ConfigScopeManager {
+    private readonly logger;
+    private readonly scopes;
+    /**
+     * Register a fully defined scope.
+     */
+    register(scope: ConfigScope): void;
+    /**
+     * Add a scope with separate property definitions — mirrors jetlinks ConfigScopeManager.addScope().
+     *
+     * Reference: jetlinks ConfigScopeManager.addScope(ConfigScope, List<ConfigPropertyDef>)
+     */
+    addScope(scopePartial: {
+        id: string;
+        name: string;
+        publicAccess?: boolean;
+    }, properties: ConfigPropertyDef[]): void;
+    /**
+     * Apply customizers — call during module initialization.
+     *
+     * Reference: jetlinks ConfigScopeProperties.custom()
+     */
+    applyCustomizers(customizers: ConfigScopeCustomizer[]): void;
+    get(scopeId: string): ConfigScope | undefined;
+    getAll(): ConfigScope[];
+    has(scopeId: string): boolean;
+    unregister(scopeId: string): boolean;
+    /**
+     * Get all scopes marked as public access.
+     *
+     * Reference: jetlinks SystemConfigManagerController checks isPublicAccess()
+     * for unauthenticated access.
+     */
+    getPublicScopes(): ConfigScope[];
+    getProperties(scopeId: string): ConfigPropertyDef[];
+    /**
+     * Validate a config value against its scope property definition.
+     * Returns error messages if invalid.
+     */
+    validate(scopeId: string, key: string, value: unknown): string[];
+}
+
+declare const CONFIG_CHANGED_EVENT = "zucker.config-changed";
+/**
+ * TopicEventBus topic for config changes.
+ * Uses `/` delimiter to match DefaultTopicEventBus conventions.
+ * Subscribers can use wildcards: `system/config/**`
+ */
+declare const CONFIG_CHANGED_TOPIC = "system/config/changed";
+/** Optional encryption adapter for encrypting/decrypting sensitive config values */
+declare const CONFIG_ENCRYPTOR = "CONFIG_ENCRYPTOR";
+interface ConfigChangePayload {
+    scope: string;
+    key: string;
+    oldValue: unknown;
+    newValue: unknown;
+}
+/**
+ * Encryption adapter interface for config values.
+ *
+ * Reference: jetlinks stores some config values encrypted;
+ * this provides a pluggable encryption mechanism.
+ */
+interface ConfigEncryptor {
+    encrypt(value: string): string | Promise<string>;
+    decrypt(value: string): string | Promise<string>;
+}
+/** Minimal TopicEventBus interface to avoid hard dependency on @zucker-framework/event */
+interface TopicEventBusLike$1 {
+    publish(topic: string, payload: unknown): Promise<void>;
+}
+declare class ConfigService {
+    private readonly db;
+    private readonly eventEmitter?;
+    private readonly scopeManager?;
+    private readonly encryptor?;
+    private readonly topicEventBus?;
+    private readonly logger;
+    private readonly cache;
+    private static readonly CACHE_MAX_SIZE;
+    constructor(db: DatabaseAdapter, eventEmitter?: EventEmitter2 | undefined, scopeManager?: ConfigScopeManager | undefined, encryptor?: ConfigEncryptor | undefined, topicEventBus?: TopicEventBusLike$1 | undefined);
+    /**
+     * 获取指定 scope 和 key 的配置值
+     * @param scope 配置域
+     * @param key 配置键
+     * @returns 配置值，不存在时返回 undefined
+     */
+    get<T = string>(scope: string, key: string): Promise<T | undefined>;
+    /**
+     * Get a config value with a fallback default.
+     * If no stored value exists, checks the scope definition default,
+     * then falls back to the provided default.
+     *
+     * Reference: jetlinks getProperties merges defaults from ConfigPropertyDef.
+     */
+    getOrDefault<T = string>(scope: string, key: string, defaultValue: T): Promise<T>;
+    /**
+     * 设置配置值（自动触发变更事件）
+     * @param scope 配置域
+     * @param key 配置键
+     * @param value 配置值
+     * @throws ValidationException 校验失败时
+     */
+    set(scope: string, key: string, value: unknown): Promise<void>;
+    /**
+     * Set multiple properties at once for a scope.
+     * Performs batch validation first, then persists all values and emits
+     * a single consolidated event — mirrors jetlinks ConfigManager.setProperties(scope, Map)
+     * which does repository.save + cache.evict instead of N individual updates.
+     */
+    setProperties(scope: string, values: Record<string, unknown>): Promise<void>;
+    /**
+     * 获取指定 scope 下的所有配置
+     * @param scope 配置域
+     * @returns 键值对集合（包含默认值）
+     */
+    getAll(scope: string): Promise<Record<string, unknown>>;
+    /**
+     * Remove a specific config property.
+     */
+    remove(scope: string, key: string): Promise<void>;
+    /**
+     * 监听配置变更事件
+     * @param callback 变更回调
+     * @returns 订阅句柄，调用 unsubscribe() 取消监听
+     */
+    onChange(callback: (payload: ConfigChangePayload) => void): {
+        unsubscribe: () => void;
+    };
+    /**
+     * 监听指定 scope.key 的配置变更，每次变更时执行回调。
+     *
+     * @param scope 配置域
+     * @param key 配置键（可选，不传则监听整个 scope）
+     * @param callback 变更回调
+     * @returns 取消监听函数
+     */
+    watch<T = unknown>(scope: string, key: string | undefined, callback: (newValue: T, oldValue: T | undefined) => void): {
+        unsubscribe: () => void;
+    };
+    /**
+     * 清除配置缓存
+     * @param scope 可选的配置域，不传则清除所有缓存
+     */
+    clearCache(scope?: string): void;
+    /**
+     * 记录配置变更历史（自动版本号递增）
+     * 配置版本控制
+     */
+    private recordHistory;
+    /**
+     * 查询配置变更历史
+     * @param scope 配置域
+     * @param key 配置键（可选，不传则查询该 scope 所有变更）
+     * @param limit 返回条数（默认 20）
+     */
+    getHistory(scope: string, key?: string, limit?: number): Promise<Array<{
+        scope: string;
+        key: string;
+        oldValue: unknown;
+        newValue: unknown;
+        changedAt: Date;
+    }>>;
+    /**
+     * 回滚配置到指定历史版本
+     * @param historyId 历史记录 ID
+     */
+    rollback(historyId: string): Promise<void>;
+    /**
+     * Check if a property is marked as encrypted in its scope definition.
+     */
+    private isEncryptedProperty;
+}
+
+interface ZuckerConfigModuleOptions {
+    /** Optional encryption adapter for sensitive config values */
+    encryptor?: ConfigEncryptor;
+    /** Optional scope customizers to register scopes during init */
+    customizers?: ConfigScopeCustomizer[];
+}
+declare const CONFIG_MODULE_OPTIONS: unique symbol;
+interface ZuckerConfigModuleAsyncOptions {
+    imports?: Array<Type | DynamicModule>;
+    useFactory?: (...args: unknown[]) => ZuckerConfigModuleOptions | Promise<ZuckerConfigModuleOptions>;
+    useClass?: Type<ZuckerConfigModuleOptionsFactory>;
+    useExisting?: Type<ZuckerConfigModuleOptionsFactory>;
+    inject?: Array<InjectionToken | OptionalFactoryDependency>;
+}
+interface ZuckerConfigModuleOptionsFactory {
+    createConfigOptions(): ZuckerConfigModuleOptions | Promise<ZuckerConfigModuleOptions>;
+}
+declare class ZuckerConfigModule {
+    static forRoot(options?: ZuckerConfigModuleOptions): DynamicModule;
+    static forRootAsync(options: ZuckerConfigModuleAsyncOptions): DynamicModule;
+    private static createAsyncProviders;
+}
+
+declare const CONFIG_SCOPE_REGISTRY = "CONFIG_SCOPE_REGISTRY";
+interface ConfigScopeEntry {
+    name: string;
+    publicAccess: boolean;
+}
+/**
+ * ConfigGuard — 配置访问守卫
+ *
+ * 检查请求的 scope 是否标记为 publicAccess，
+ * 如果是公开的则跳过认证，否则要求请求已认证。
+ */
+declare class ConfigGuard implements CanActivate {
+    private readonly scopeRegistry;
+    private readonly logger;
+    constructor(scopeRegistry: Map<string, ConfigScopeEntry>);
+    canActivate(context: ExecutionContext): boolean;
+    private isAuthenticated;
+}
+
+type ConfigLayer = 'system' | 'tenant' | 'user';
+declare const CONFIG_LAYER_PRIORITY: Record<ConfigLayer, number>;
+declare const LAYERED_CONFIG_CHANGED_EVENT = "zucker.layered-config-changed";
+/**
+ * TopicEventBus topic for layered config changes.
+ * Uses `/` delimiter to match DefaultTopicEventBus conventions.
+ */
+declare const LAYERED_CONFIG_CHANGED_TOPIC = "system/config/layered-changed";
+/** Minimal TopicEventBus interface to avoid hard dependency on @zucker-framework/event */
+interface TopicEventBusLike {
+    publish(topic: string, payload: unknown): Promise<void>;
+}
+interface LayeredConfigChangePayload {
+    scope: string;
+    key: string;
+    layer: ConfigLayer;
+    oldValue: unknown;
+    newValue: unknown;
+}
+interface LayeredConfigContext {
+    tenantId?: string;
+    userId?: string;
+}
+/**
+ * LayeredConfigService — config with layered inheritance: system -> tenant -> user.
+ *
+ * Higher layers override lower layers. When getting a value, the most specific
+ * layer with a value wins.
+ */
+declare class LayeredConfigService {
+    private readonly db;
+    private readonly scopeManager;
+    private readonly eventEmitter?;
+    private readonly topicEventBus?;
+    private readonly logger;
+    private readonly cache;
+    constructor(db: DatabaseAdapter, scopeManager: ConfigScopeManager, eventEmitter?: EventEmitter2 | undefined, topicEventBus?: TopicEventBusLike | undefined);
+    /**
+     * Get a config value, resolving through layers (user > tenant > system > default).
+     */
+    get<T = unknown>(scope: string, key: string, context?: LayeredConfigContext): Promise<T | undefined>;
+    /**
+     * Set a config value at a specific layer.
+     */
+    set(scope: string, key: string, value: unknown, layer: ConfigLayer, ownerId?: string): Promise<void>;
+    /**
+     * Get all values for a scope, merged across layers.
+     */
+    getAll(scope: string, context?: LayeredConfigContext): Promise<Record<string, unknown>>;
+    /**
+     * Set multiple properties at a specific layer.
+     * Validates all entries first, then persists in batch.
+     *
+     * Reference: jetlinks ConfigManager.setProperties(scope, Map)
+     */
+    setProperties(scope: string, values: Record<string, unknown>, layer: ConfigLayer, ownerId?: string): Promise<void>;
+    /**
+     * Remove a config value at a specific layer.
+     */
+    remove(scope: string, key: string, layer: ConfigLayer, ownerId?: string): Promise<void>;
+    /**
+     * Clear the in-memory cache.
+     * @param scope Optional — only clear entries for this scope prefix
+     */
+    clearCache(scope?: string): void;
+    private getLayerValue;
+    private getLayerRecords;
+    private buildLayerKey;
+}
+
+declare class FeatureFlagService extends FeatureFlagEvaluator {
+    constructor();
+}
+
+/**
+ * 配置文件热重载监听器 — 对标 Claude Code changeDetector.ts
+ *
+ * 监听配置文件变化，带写入稳定性检测和删除宽限期。
+ *
+ * 用法:
+ * ```ts
+ * const watcher = new ConfigFileWatcher();
+ * watcher.watch('/path/to/config.json', () => {
+ *   configService.clearCache();
+ *   logger.log('Config reloaded');
+ * });
+ *
+ * // 停止监听
+ * watcher.close();
+ * ```
+ */
+interface ConfigWatcherOptions {
+    /** 写入稳定性延迟：文件修改后等待此时间无新修改才触发回调（毫秒） */
+    stabilityMs?: number;
+    /** 删除宽限期：文件删除后等待此时间，若重建则不触发删除回调 */
+    deleteGraceMs?: number;
+}
+declare class ConfigFileWatcher {
+    private readonly logger;
+    private readonly stabilityMs;
+    private readonly deleteGraceMs;
+    private readonly watched;
+    constructor(options?: ConfigWatcherOptions);
+    /**
+     * 开始监听文件
+     * @returns 取消监听函数
+     */
+    watch(filePath: string, callback: () => void): () => void;
+    /**
+     * 停止监听指定文件
+     */
+    unwatch(filePath: string): void;
+    /**
+     * 关闭所有监听
+     */
+    close(): void;
+    /**
+     * 获取当前监听的文件列表
+     */
+    getWatchedFiles(): string[];
+    private handleEvent;
+    private getModifiedTime;
+}
+
+interface ConfigPropertyDef {
+    key: string;
+    name: string;
+    type: string;
+    defaultValue: unknown;
+    description: string;
+    readonly: boolean;
+    /** Whether this property value should be encrypted at rest */
+    encrypted?: boolean;
+    /** Sort order for display */
+    sortOrder?: number;
+}
+interface ConfigScope {
+    id: string;
+    name: string;
+    isPublic: boolean;
+    /** Whether public access is allowed (no auth required) */
+    publicAccess: boolean;
+    properties: ConfigPropertyDef[];
+}
+
+export { CONFIG_CHANGED_EVENT, CONFIG_CHANGED_TOPIC, CONFIG_ENCRYPTOR, CONFIG_LAYER_PRIORITY, CONFIG_MODULE_OPTIONS, CONFIG_SCOPE_REGISTRY, type ConfigChangePayload, type ConfigEncryptor, ConfigFileWatcher, ConfigGuard, type ConfigLayer, type ConfigPropertyDef, type ConfigScope, type ConfigScopeCustomizer, type ConfigScopeEntry, ConfigScopeManager, ConfigService, type ConfigWatcherOptions, FeatureFlagService, LAYERED_CONFIG_CHANGED_EVENT, LAYERED_CONFIG_CHANGED_TOPIC, type LayeredConfigChangePayload, type LayeredConfigContext, LayeredConfigService, ZuckerConfigModule, type ZuckerConfigModuleAsyncOptions, type ZuckerConfigModuleOptions, type ZuckerConfigModuleOptionsFactory };