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.
This commit is contained in:
David Snelling 2025-08-28 12:37:07 -07:00
parent 99c11385ab
commit b409075d0b
11 changed files with 3511 additions and 62 deletions

View file

@ -109,6 +109,30 @@ export interface BrainyAugmentation {
* Optional: Cleanup when BrainyData is destroyed
*/
shutdown?(): Promise<void>
/**
* Optional: Computed fields this augmentation provides
* Used for discovery, TypeScript support, and API documentation
*/
computedFields?: {
[namespace: string]: {
[field: string]: {
type: 'string' | 'number' | 'boolean' | 'object' | 'array'
description: string
confidence?: number
}
}
}
/**
* Optional: Compute fields for a result entity
* Called when user accesses getDisplay(), getSchema(), etc.
*
* @param result - The result entity (VectorDocument, GraphVerb, etc.)
* @param namespace - The namespace being requested ('display', 'schema', etc.)
* @returns Computed fields for the namespace
*/
computeFields?(result: any, namespace: string): Promise<Record<string, any>> | Record<string, any>
}
/**
@ -205,6 +229,27 @@ export abstract class BaseAugmentation implements BrainyAugmentation {
// Default: no-op
}
/**
* Optional computed fields declaration (override in subclasses)
*/
computedFields?: {
[namespace: string]: {
[field: string]: {
type: 'string' | 'number' | 'boolean' | 'object' | 'array'
description: string
confidence?: number
}
}
}
/**
* Optional computed fields implementation (override in subclasses)
* @param result The result entity
* @param namespace The requested namespace
* @returns Computed fields for the namespace
*/
computeFields?(result: any, namespace: string): Promise<Record<string, any>> | Record<string, any>
/**
* Log a message with the augmentation name
*/