@backendkit-labs/auto-learning 0.1.0

package/dist/index-DnQ9xssn.d.cts

@@ -0,0 +1,208 @@
+import { LoggerService, DynamicModule } from '@nestjs/common';
+import { Result } from '@backendkit-labs/result';
+
+type EndpointPattern = {
+    method: string;
+    path: string;
+    statusCode: number;
+    durationMs: number;
+    timestamp: Date;
+    correlationId?: string;
+    metadata?: Record<string, unknown>;
+};
+type AggregatePattern = {
+    method: string;
+    path: string;
+    windowStart: Date;
+    windowEnd: Date;
+    count: number;
+    avgDurationMs: number;
+    p50Ms: number;
+    p95Ms: number;
+    p99Ms: number;
+    errorCount: number;
+    errorRate: number;
+};
+type AnomalySeverity = 'low' | 'medium' | 'high' | 'critical';
+type AnomalyReport$1 = {
+    id: string;
+    endpoint: string;
+    method: string;
+    severity: AnomalySeverity;
+    metric: 'latency' | 'error_rate' | 'frequency' | 'unknown_endpoint';
+    expectedValue: number;
+    actualValue: number;
+    deviation: number;
+    detectedAt: Date;
+};
+type TunableConfig = {
+    timeoutMs: number;
+    maxRetries: number;
+    circuitBreakerThreshold: number;
+    circuitBreakerHalfOpenAfterMs: number;
+    bulkheadMaxConcurrent: number;
+};
+type LearningCycleEvent = {
+    cycleId: string;
+    timestamp: Date;
+    patternsProcessed: number;
+    anomaliesFound: number;
+    configChanges: Partial<TunableConfig>;
+    durationMs: number;
+};
+
+type LearningErrorTag = 'STORAGE_ERROR' | 'INSUFFICIENT_DATA' | 'INVALID_CONFIG' | 'ANOMALY_DETECTION_FAILED' | 'FEEDBACK_LOOP_ALREADY_RUNNING' | 'FEEDBACK_LOOP_NOT_RUNNING';
+type LearningError = {
+    readonly tag: LearningErrorTag;
+    readonly message: string;
+    readonly cause?: unknown;
+    readonly required?: number;
+    readonly actual?: number;
+    readonly key?: string;
+    readonly value?: unknown;
+};
+
+interface IPatternRegistry {
+    record(pattern: EndpointPattern): Result<void, LearningError>;
+    getAggregates(windowMinutes: number): Result<AggregatePattern[], LearningError>;
+    getHistory(endpoint: string, method: string, limit: number): Result<EndpointPattern[], LearningError>;
+    getStats(): Result<RegistryStats, LearningError>;
+}
+type RegistryStats = {
+    totalPatterns: number;
+    uniqueEndpoints: number;
+    oldestPattern: Date;
+    newestPattern: Date;
+};
+
+interface StorageAdapter {
+    savePattern(pattern: EndpointPattern): Result<void, LearningError>;
+    getPatterns(windowStart: Date, windowEnd: Date): Result<EndpointPattern[], LearningError>;
+    getAggregates(windowMinutes: number): Result<AggregatePattern[], LearningError>;
+    saveAnomaly(report: AnomalyReport$1): Result<void, LearningError>;
+    getRecentAnomalies(limit: number): Result<AnomalyReport$1[], LearningError>;
+    saveConfig(config: TunableConfig): Result<void, LearningError>;
+    loadConfig(): Result<TunableConfig | null, LearningError>;
+    saveCycleEvent(event: LearningCycleEvent): Result<void, LearningError>;
+    getLastCycleTime(): Result<Date | null, LearningError>;
+    prune(before: Date): Result<number, LearningError>;
+}
+
+interface ObservabilityAdapter {
+    info(msg: string, meta?: Record<string, unknown>): void;
+    warn(msg: string, meta?: Record<string, unknown>): void;
+    error(msg: string, meta?: Record<string, unknown>): void;
+    debug(msg: string, meta?: Record<string, unknown>): void;
+    incrementMetric(name: string, value?: number, tags?: Record<string, string>): void;
+    gaugeMetric(name: string, value: number, tags?: Record<string, string>): void;
+    histogramMetric(name: string, value: number, tags?: Record<string, string>): void;
+}
+
+interface IAnomalyDetector {
+    analyze(current: EndpointPattern, baseline: AggregatePattern): Result<AnomalyReport | null, LearningError>;
+    batchAnalyze(windowPatterns: EndpointPattern[], baselines: AggregatePattern[]): Result<AnomalyReport[], LearningError>;
+}
+type AnomalyReport = {
+    id: string;
+    endpoint: string;
+    method: string;
+    severity: AnomalySeverity;
+    metric: 'latency' | 'error_rate' | 'frequency' | 'unknown_endpoint';
+    expectedValue: number;
+    actualValue: number;
+    deviation: number;
+    detectedAt: Date;
+};
+type AnomalyDetectorConfig = {
+    latencyStdDevThreshold: number;
+    errorRateThreshold: number;
+    frequencyDeviationThreshold: number;
+    enableUnknownEndpointDetection: boolean;
+};
+declare const DEFAULT_ANOMALY_CONFIG: AnomalyDetectorConfig;
+
+interface IConfigTuner {
+    getCurrentConfig(): TunableConfig;
+    tune(aggregates: AggregatePattern[], anomalies: AnomalyReport$1[]): Result<TunableConfig, LearningError>;
+    reset(): Result<TunableConfig, LearningError>;
+    onConfigChange(callback: (config: TunableConfig) => void): void;
+}
+type ConfigTunerConfig = {
+    minTimeoutMs: number;
+    maxTimeoutMs: number;
+    smoothingFactor: number;
+    adjustmentStepMs: number;
+};
+declare const DEFAULT_TUNER_CONFIG: ConfigTunerConfig;
+
+interface IFeedbackLoop {
+    start(intervalMs?: number): void;
+    stop(): void;
+    isRunning(): boolean;
+    runOnce(): Promise<Result<LearningCycleEvent, LearningError>>;
+    onCycle(callback: (event: LearningCycleEvent) => void): void;
+}
+type FeedbackLoopConfig = {
+    defaultIntervalMs: number;
+    windowSizeMinutes: number;
+    minSamplesBeforeTuning: number;
+    cooldownBetweenChangesMs: number;
+};
+declare const DEFAULT_LOOP_CONFIG: FeedbackLoopConfig;
+
+type AutoLearningCoreOptions = {
+    storage?: StorageAdapter;
+    observability?: ObservabilityAdapter;
+    anomalyConfig?: Partial<AnomalyDetectorConfig>;
+    tunerConfig?: Partial<ConfigTunerConfig>;
+    loopConfig?: Partial<FeedbackLoopConfig>;
+};
+declare class AutoLearningCore {
+    readonly patternRegistry: IPatternRegistry;
+    readonly anomalyDetector: IAnomalyDetector;
+    readonly configTuner: IConfigTuner;
+    readonly feedbackLoop: IFeedbackLoop;
+    readonly storage: StorageAdapter;
+    readonly observability: ObservabilityAdapter;
+    private constructor();
+    static create(options?: AutoLearningCoreOptions): AutoLearningCore;
+    recordPattern(pattern: EndpointPattern): Result<void, LearningError>;
+    getCurrentConfig(): TunableConfig;
+    startFeedbackLoop(intervalMs?: number): void;
+    stopFeedbackLoop(): void;
+    isFeedbackLoopRunning(): boolean;
+    runOnce(): Promise<Result<LearningCycleEvent, LearningError>>;
+    onConfigChange(callback: (config: TunableConfig) => void): void;
+    onCycle(callback: (event: LearningCycleEvent) => void): void;
+}
+
+type AutoLearningModuleOptions = {
+    intervalMs?: number;
+    storage?: 'memory' | 'redis' | 'sql';
+    redisUrl?: string;
+    observability?: {
+        logger?: LoggerService;
+        metrics?: {
+            increment?: (name: string, value?: number, tags?: Record<string, string>) => void;
+            gauge?: (name: string, value: number, tags?: Record<string, string>) => void;
+            histogram?: (name: string, value: number, tags?: Record<string, string>) => void;
+        };
+    };
+    coreOptions?: Omit<AutoLearningCoreOptions, 'storage' | 'observability'>;
+};
+declare class AutoLearningModule {
+    static forRoot(options?: AutoLearningModuleOptions): DynamicModule;
+}
+
+type AutoLearnOptions = {
+    trackParams?: boolean;
+    trackBody?: boolean;
+    customMetadata?: (req: any) => Record<string, unknown>;
+};
+declare const AutoLearn: (options?: AutoLearnOptions) => MethodDecorator;
+
+declare const AUTO_LEARNING_OPTIONS: unique symbol;
+declare const AUTO_LEARNING_INSTANCE: unique symbol;
+declare const AUTO_LEARN_METADATA = "auto_learn_metadata";
+
+export { type AggregatePattern as A, type ConfigTunerConfig as C, DEFAULT_ANOMALY_CONFIG as D, type EndpointPattern as E, type FeedbackLoopConfig as F, type IPatternRegistry as I, type LearningError as L, type ObservabilityAdapter as O, type RegistryStats as R, type StorageAdapter as S, type TunableConfig as T, type IAnomalyDetector as a, type AnomalyDetectorConfig as b, type AnomalyReport as c, type IConfigTuner as d, type AnomalyReport$1 as e, type IFeedbackLoop as f, type LearningCycleEvent as g, AUTO_LEARNING_INSTANCE as h, AUTO_LEARNING_OPTIONS as i, AUTO_LEARN_METADATA as j, type AnomalySeverity as k, AutoLearn as l, type AutoLearnOptions as m, AutoLearningCore as n, type AutoLearningCoreOptions as o, AutoLearningModule as p, type AutoLearningModuleOptions as q, DEFAULT_LOOP_CONFIG as r, DEFAULT_TUNER_CONFIG as s };

package/dist/index-DnQ9xssn.d.ts

@@ -0,0 +1,208 @@
+import { LoggerService, DynamicModule } from '@nestjs/common';
+import { Result } from '@backendkit-labs/result';
+
+type EndpointPattern = {
+    method: string;
+    path: string;
+    statusCode: number;
+    durationMs: number;
+    timestamp: Date;
+    correlationId?: string;
+    metadata?: Record<string, unknown>;
+};
+type AggregatePattern = {
+    method: string;
+    path: string;
+    windowStart: Date;
+    windowEnd: Date;
+    count: number;
+    avgDurationMs: number;
+    p50Ms: number;
+    p95Ms: number;
+    p99Ms: number;
+    errorCount: number;
+    errorRate: number;
+};
+type AnomalySeverity = 'low' | 'medium' | 'high' | 'critical';
+type AnomalyReport$1 = {
+    id: string;
+    endpoint: string;
+    method: string;
+    severity: AnomalySeverity;
+    metric: 'latency' | 'error_rate' | 'frequency' | 'unknown_endpoint';
+    expectedValue: number;
+    actualValue: number;
+    deviation: number;
+    detectedAt: Date;
+};
+type TunableConfig = {
+    timeoutMs: number;
+    maxRetries: number;
+    circuitBreakerThreshold: number;
+    circuitBreakerHalfOpenAfterMs: number;
+    bulkheadMaxConcurrent: number;
+};
+type LearningCycleEvent = {
+    cycleId: string;
+    timestamp: Date;
+    patternsProcessed: number;
+    anomaliesFound: number;
+    configChanges: Partial<TunableConfig>;
+    durationMs: number;
+};
+
+type LearningErrorTag = 'STORAGE_ERROR' | 'INSUFFICIENT_DATA' | 'INVALID_CONFIG' | 'ANOMALY_DETECTION_FAILED' | 'FEEDBACK_LOOP_ALREADY_RUNNING' | 'FEEDBACK_LOOP_NOT_RUNNING';
+type LearningError = {
+    readonly tag: LearningErrorTag;
+    readonly message: string;
+    readonly cause?: unknown;
+    readonly required?: number;
+    readonly actual?: number;
+    readonly key?: string;
+    readonly value?: unknown;
+};
+
+interface IPatternRegistry {
+    record(pattern: EndpointPattern): Result<void, LearningError>;
+    getAggregates(windowMinutes: number): Result<AggregatePattern[], LearningError>;
+    getHistory(endpoint: string, method: string, limit: number): Result<EndpointPattern[], LearningError>;
+    getStats(): Result<RegistryStats, LearningError>;
+}
+type RegistryStats = {
+    totalPatterns: number;
+    uniqueEndpoints: number;
+    oldestPattern: Date;
+    newestPattern: Date;
+};
+
+interface StorageAdapter {
+    savePattern(pattern: EndpointPattern): Result<void, LearningError>;
+    getPatterns(windowStart: Date, windowEnd: Date): Result<EndpointPattern[], LearningError>;
+    getAggregates(windowMinutes: number): Result<AggregatePattern[], LearningError>;
+    saveAnomaly(report: AnomalyReport$1): Result<void, LearningError>;
+    getRecentAnomalies(limit: number): Result<AnomalyReport$1[], LearningError>;
+    saveConfig(config: TunableConfig): Result<void, LearningError>;
+    loadConfig(): Result<TunableConfig | null, LearningError>;
+    saveCycleEvent(event: LearningCycleEvent): Result<void, LearningError>;
+    getLastCycleTime(): Result<Date | null, LearningError>;
+    prune(before: Date): Result<number, LearningError>;
+}
+
+interface ObservabilityAdapter {
+    info(msg: string, meta?: Record<string, unknown>): void;
+    warn(msg: string, meta?: Record<string, unknown>): void;
+    error(msg: string, meta?: Record<string, unknown>): void;
+    debug(msg: string, meta?: Record<string, unknown>): void;
+    incrementMetric(name: string, value?: number, tags?: Record<string, string>): void;
+    gaugeMetric(name: string, value: number, tags?: Record<string, string>): void;
+    histogramMetric(name: string, value: number, tags?: Record<string, string>): void;
+}
+
+interface IAnomalyDetector {
+    analyze(current: EndpointPattern, baseline: AggregatePattern): Result<AnomalyReport | null, LearningError>;
+    batchAnalyze(windowPatterns: EndpointPattern[], baselines: AggregatePattern[]): Result<AnomalyReport[], LearningError>;
+}
+type AnomalyReport = {
+    id: string;
+    endpoint: string;
+    method: string;
+    severity: AnomalySeverity;
+    metric: 'latency' | 'error_rate' | 'frequency' | 'unknown_endpoint';
+    expectedValue: number;
+    actualValue: number;
+    deviation: number;
+    detectedAt: Date;
+};
+type AnomalyDetectorConfig = {
+    latencyStdDevThreshold: number;
+    errorRateThreshold: number;
+    frequencyDeviationThreshold: number;
+    enableUnknownEndpointDetection: boolean;
+};
+declare const DEFAULT_ANOMALY_CONFIG: AnomalyDetectorConfig;
+
+interface IConfigTuner {
+    getCurrentConfig(): TunableConfig;
+    tune(aggregates: AggregatePattern[], anomalies: AnomalyReport$1[]): Result<TunableConfig, LearningError>;
+    reset(): Result<TunableConfig, LearningError>;
+    onConfigChange(callback: (config: TunableConfig) => void): void;
+}
+type ConfigTunerConfig = {
+    minTimeoutMs: number;
+    maxTimeoutMs: number;
+    smoothingFactor: number;
+    adjustmentStepMs: number;
+};
+declare const DEFAULT_TUNER_CONFIG: ConfigTunerConfig;
+
+interface IFeedbackLoop {
+    start(intervalMs?: number): void;
+    stop(): void;
+    isRunning(): boolean;
+    runOnce(): Promise<Result<LearningCycleEvent, LearningError>>;
+    onCycle(callback: (event: LearningCycleEvent) => void): void;
+}
+type FeedbackLoopConfig = {
+    defaultIntervalMs: number;
+    windowSizeMinutes: number;
+    minSamplesBeforeTuning: number;
+    cooldownBetweenChangesMs: number;
+};
+declare const DEFAULT_LOOP_CONFIG: FeedbackLoopConfig;
+
+type AutoLearningCoreOptions = {
+    storage?: StorageAdapter;
+    observability?: ObservabilityAdapter;
+    anomalyConfig?: Partial<AnomalyDetectorConfig>;
+    tunerConfig?: Partial<ConfigTunerConfig>;
+    loopConfig?: Partial<FeedbackLoopConfig>;
+};
+declare class AutoLearningCore {
+    readonly patternRegistry: IPatternRegistry;
+    readonly anomalyDetector: IAnomalyDetector;
+    readonly configTuner: IConfigTuner;
+    readonly feedbackLoop: IFeedbackLoop;
+    readonly storage: StorageAdapter;
+    readonly observability: ObservabilityAdapter;
+    private constructor();
+    static create(options?: AutoLearningCoreOptions): AutoLearningCore;
+    recordPattern(pattern: EndpointPattern): Result<void, LearningError>;
+    getCurrentConfig(): TunableConfig;
+    startFeedbackLoop(intervalMs?: number): void;
+    stopFeedbackLoop(): void;
+    isFeedbackLoopRunning(): boolean;
+    runOnce(): Promise<Result<LearningCycleEvent, LearningError>>;
+    onConfigChange(callback: (config: TunableConfig) => void): void;
+    onCycle(callback: (event: LearningCycleEvent) => void): void;
+}
+
+type AutoLearningModuleOptions = {
+    intervalMs?: number;
+    storage?: 'memory' | 'redis' | 'sql';
+    redisUrl?: string;
+    observability?: {
+        logger?: LoggerService;
+        metrics?: {
+            increment?: (name: string, value?: number, tags?: Record<string, string>) => void;
+            gauge?: (name: string, value: number, tags?: Record<string, string>) => void;
+            histogram?: (name: string, value: number, tags?: Record<string, string>) => void;
+        };
+    };
+    coreOptions?: Omit<AutoLearningCoreOptions, 'storage' | 'observability'>;
+};
+declare class AutoLearningModule {
+    static forRoot(options?: AutoLearningModuleOptions): DynamicModule;
+}
+
+type AutoLearnOptions = {
+    trackParams?: boolean;
+    trackBody?: boolean;
+    customMetadata?: (req: any) => Record<string, unknown>;
+};
+declare const AutoLearn: (options?: AutoLearnOptions) => MethodDecorator;
+
+declare const AUTO_LEARNING_OPTIONS: unique symbol;
+declare const AUTO_LEARNING_INSTANCE: unique symbol;
+declare const AUTO_LEARN_METADATA = "auto_learn_metadata";
+
+export { type AggregatePattern as A, type ConfigTunerConfig as C, DEFAULT_ANOMALY_CONFIG as D, type EndpointPattern as E, type FeedbackLoopConfig as F, type IPatternRegistry as I, type LearningError as L, type ObservabilityAdapter as O, type RegistryStats as R, type StorageAdapter as S, type TunableConfig as T, type IAnomalyDetector as a, type AnomalyDetectorConfig as b, type AnomalyReport as c, type IConfigTuner as d, type AnomalyReport$1 as e, type IFeedbackLoop as f, type LearningCycleEvent as g, AUTO_LEARNING_INSTANCE as h, AUTO_LEARNING_OPTIONS as i, AUTO_LEARN_METADATA as j, type AnomalySeverity as k, AutoLearn as l, type AutoLearnOptions as m, AutoLearningCore as n, type AutoLearningCoreOptions as o, AutoLearningModule as p, type AutoLearningModuleOptions as q, DEFAULT_LOOP_CONFIG as r, DEFAULT_TUNER_CONFIG as s };