brainy/src/augmentations/defaultAugmentations.ts
David Snelling b409075d0b feat: add Universal Display Augmentation for AI-powered enhanced output
- Implements intelligent display fields with AI-generated titles and descriptions
- Leverages existing IntelligentTypeMatcher for semantic type detection
- Adds lazy computation with LRU caching for zero performance impact
- Enhances CLI with clean, minimal formatting (no visual clutter)
- Provides method-based API (getDisplay()) to avoid namespace conflicts
- Maintains 100% backward compatibility with existing code
- Enables by default with complete isolation architecture
- Includes comprehensive tests and documentation

The augmentation transforms search results and data display with smart,
contextual information while maintaining Soulcraft's clean aesthetic.
2025-08-28 12:37:07 -07:00

123 lines
No EOL
4 KiB
TypeScript

/**
* Default Augmentations Registration
*
* Maintains zero-config philosophy by automatically registering
* core augmentations that were previously hardcoded in BrainyData.
*
* These augmentations are optional but enabled by default for
* backward compatibility and optimal performance.
*/
import { BrainyData } from '../brainyData.js'
import { BaseAugmentation } from './brainyAugmentation.js'
import { CacheAugmentation } from './cacheAugmentation.js'
import { IndexAugmentation } from './indexAugmentation.js'
import { MetricsAugmentation } from './metricsAugmentation.js'
import { MonitoringAugmentation } from './monitoringAugmentation.js'
import { UniversalDisplayAugmentation } from './universalDisplayAugmentation.js'
/**
* Create default augmentations for zero-config operation
* Returns an array of augmentations to be registered
*
* @param config - Configuration options
* @returns Array of augmentations to register
*/
export function createDefaultAugmentations(
config: {
cache?: boolean | Record<string, any>
index?: boolean | Record<string, any>
metrics?: boolean | Record<string, any>
monitoring?: boolean | Record<string, any>
display?: boolean | Record<string, any>
} = {}
): BaseAugmentation[] {
const augmentations: BaseAugmentation[] = []
// Cache augmentation (was SearchCache)
if (config.cache !== false) {
const cacheConfig = typeof config.cache === 'object' ? config.cache : {}
augmentations.push(new CacheAugmentation(cacheConfig))
}
// Index augmentation (was MetadataIndex)
if (config.index !== false) {
const indexConfig = typeof config.index === 'object' ? config.index : {}
augmentations.push(new IndexAugmentation(indexConfig))
}
// Metrics augmentation (was StatisticsCollector)
if (config.metrics !== false) {
const metricsConfig = typeof config.metrics === 'object' ? config.metrics : {}
augmentations.push(new MetricsAugmentation(metricsConfig))
}
// Display augmentation (AI-powered intelligent display fields)
if (config.display !== false) {
const displayConfig = typeof config.display === 'object' ? config.display : {}
augmentations.push(new UniversalDisplayAugmentation(displayConfig))
}
// Monitoring augmentation (was HealthMonitor)
// Only enable by default in distributed mode
const isDistributed = process.env.BRAINY_MODE === 'distributed' ||
process.env.BRAINY_DISTRIBUTED === 'true'
if (config.monitoring !== false && (config.monitoring || isDistributed)) {
const monitoringConfig = typeof config.monitoring === 'object' ? config.monitoring : {}
augmentations.push(new MonitoringAugmentation(monitoringConfig))
}
return augmentations
}
/**
* Get augmentation by name with type safety
*/
export function getAugmentation<T>(brain: BrainyData, name: string): T | null {
// Access augmentations through a public method or property
const augmentations = (brain as any).augmentations
if (!augmentations) return null
const aug = augmentations.get(name)
return aug as T | null
}
/**
* Compatibility helpers for migrating from hardcoded features
*/
export const AugmentationHelpers = {
/**
* Get cache augmentation
*/
getCache(brain: BrainyData): CacheAugmentation | null {
return getAugmentation<CacheAugmentation>(brain, 'cache')
},
/**
* Get index augmentation
*/
getIndex(brain: BrainyData): IndexAugmentation | null {
return getAugmentation<IndexAugmentation>(brain, 'index')
},
/**
* Get metrics augmentation
*/
getMetrics(brain: BrainyData): MetricsAugmentation | null {
return getAugmentation<MetricsAugmentation>(brain, 'metrics')
},
/**
* Get monitoring augmentation
*/
getMonitoring(brain: BrainyData): MonitoringAugmentation | null {
return getAugmentation<MonitoringAugmentation>(brain, 'monitoring')
},
/**
* Get display augmentation
*/
getDisplay(brain: BrainyData): UniversalDisplayAugmentation | null {
return getAugmentation<UniversalDisplayAugmentation>(brain, 'display')
}
}