@nahisaho/musubix-core 1.0.0

package/dist/explanation/visual-explanation.d.ts

@@ -0,0 +1,315 @@
+/**
+ * Visual Explanation Generator
+ *
+ * Generates visual diagrams and explanations for complex concepts
+ *
+ * @packageDocumentation
+ * @module explanation/visual
+ *
+ * @see REQ-EXP-003 - Visual Explanation Generation
+ * @see Article VI - Explainable AI
+ */
+/**
+ * Diagram type
+ */
+export type DiagramType = 'flowchart' | 'sequence' | 'class' | 'entity-relationship' | 'state' | 'component' | 'deployment' | 'mindmap' | 'gantt' | 'pie';
+/**
+ * Output format
+ */
+export type OutputFormat = 'mermaid' | 'plantuml' | 'svg' | 'ascii' | 'json';
+/**
+ * Visual element
+ */
+export interface VisualElement {
+    /** Element ID */
+    id: string;
+    /** Type */
+    type: 'node' | 'edge' | 'group' | 'annotation';
+    /** Label */
+    label: string;
+    /** Description */
+    description?: string;
+    /** Style */
+    style?: ElementStyle;
+    /** Metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Element style
+ */
+export interface ElementStyle {
+    /** Fill color */
+    fill?: string;
+    /** Stroke color */
+    stroke?: string;
+    /** Shape */
+    shape?: 'rectangle' | 'ellipse' | 'diamond' | 'hexagon' | 'cylinder' | 'cloud';
+    /** Line style */
+    lineStyle?: 'solid' | 'dashed' | 'dotted';
+    /** Font size */
+    fontSize?: number;
+}
+/**
+ * Node element
+ */
+export interface NodeElement extends VisualElement {
+    type: 'node';
+    /** Position */
+    position?: {
+        x: number;
+        y: number;
+    };
+    /** Size */
+    size?: {
+        width: number;
+        height: number;
+    };
+}
+/**
+ * Edge element
+ */
+export interface EdgeElement extends VisualElement {
+    type: 'edge';
+    /** Source node ID */
+    source: string;
+    /** Target node ID */
+    target: string;
+    /** Arrow type */
+    arrow?: 'none' | 'single' | 'double' | 'open' | 'filled';
+}
+/**
+ * Group element
+ */
+export interface GroupElement extends VisualElement {
+    type: 'group';
+    /** Child element IDs */
+    children: string[];
+}
+/**
+ * Diagram structure
+ */
+export interface Diagram {
+    /** Diagram ID */
+    id: string;
+    /** Title */
+    title: string;
+    /** Type */
+    type: DiagramType;
+    /** Description */
+    description?: string;
+    /** Elements */
+    elements: VisualElement[];
+    /** Layout direction */
+    direction?: 'TB' | 'BT' | 'LR' | 'RL';
+    /** Theme */
+    theme?: DiagramTheme;
+}
+/**
+ * Diagram theme
+ */
+export interface DiagramTheme {
+    /** Primary color */
+    primary: string;
+    /** Secondary color */
+    secondary: string;
+    /** Background color */
+    background: string;
+    /** Text color */
+    text: string;
+    /** Accent colors */
+    accents: string[];
+}
+/**
+ * Default themes
+ */
+export declare const DIAGRAM_THEMES: Record<string, DiagramTheme>;
+/**
+ * Explanation context
+ */
+export interface ExplanationContext {
+    /** Subject being explained */
+    subject: string;
+    /** Target audience */
+    audience: 'developer' | 'manager' | 'stakeholder' | 'general';
+    /** Complexity level */
+    complexity: 'simple' | 'intermediate' | 'detailed';
+    /** Additional context */
+    additionalContext?: string;
+}
+/**
+ * Visual explanation result
+ */
+export interface VisualExplanation {
+    /** Generated diagram */
+    diagram: Diagram;
+    /** Narrative explanation */
+    narrative: string;
+    /** Key insights */
+    insights: string[];
+    /** Rendered output */
+    rendered: Record<OutputFormat, string>;
+    /** Related concepts */
+    relatedConcepts?: string[];
+}
+/**
+ * Generator configuration
+ */
+export interface VisualGeneratorConfig {
+    /** Default diagram type */
+    defaultType: DiagramType;
+    /** Default output format */
+    defaultFormat: OutputFormat;
+    /** Default theme */
+    defaultTheme: string;
+    /** Include narrative */
+    includeNarrative: boolean;
+    /** Include insights */
+    includeInsights: boolean;
+    /** Max elements per diagram */
+    maxElements: number;
+}
+/**
+ * Default configuration
+ */
+export declare const DEFAULT_VISUAL_CONFIG: VisualGeneratorConfig;
+/**
+ * Visual Explanation Generator
+ */
+export declare class VisualExplanationGenerator {
+    private config;
+    private elementCounter;
+    constructor(config?: Partial<VisualGeneratorConfig>);
+    /**
+     * Generate visual explanation
+     */
+    generate(context: ExplanationContext, diagramType?: DiagramType): VisualExplanation;
+    /**
+     * Create diagram from context
+     */
+    private createDiagram;
+    /**
+     * Generate flowchart elements
+     */
+    private generateFlowchartElements;
+    /**
+     * Generate sequence diagram elements
+     */
+    private generateSequenceElements;
+    /**
+     * Generate class diagram elements
+     */
+    private generateClassElements;
+    /**
+     * Generate mindmap elements
+     */
+    private generateMindmapElements;
+    /**
+     * Generate state diagram elements
+     */
+    private generateStateElements;
+    /**
+     * Generate component diagram elements
+     */
+    private generateComponentElements;
+    /**
+     * Generate generic elements
+     */
+    private generateGenericElements;
+    /**
+     * Create node element
+     */
+    private createNode;
+    /**
+     * Create edge element
+     */
+    private createEdge;
+    /**
+     * Derive process steps from context
+     */
+    private deriveProcessSteps;
+    /**
+     * Derive participants for sequence diagram
+     */
+    private deriveParticipants;
+    /**
+     * Derive interactions for sequence diagram
+     */
+    private deriveInteractions;
+    /**
+     * Derive classes for class diagram
+     */
+    private deriveClasses;
+    /**
+     * Derive relationships for class diagram
+     */
+    private deriveRelationships;
+    /**
+     * Derive branches for mindmap
+     */
+    private deriveBranches;
+    /**
+     * Derive states for state diagram
+     */
+    private deriveStates;
+    /**
+     * Derive transitions for state diagram
+     */
+    private deriveTransitions;
+    /**
+     * Derive components for component diagram
+     */
+    private deriveComponents;
+    /**
+     * Derive dependencies for component diagram
+     */
+    private deriveDependencies;
+    /**
+     * Generate narrative explanation
+     */
+    private generateNarrative;
+    /**
+     * Extract insights from explanation
+     */
+    private extractInsights;
+    /**
+     * Find related concepts
+     */
+    private findRelatedConcepts;
+    /**
+     * Render diagram in all formats
+     */
+    private renderAllFormats;
+    /**
+     * Render as Mermaid
+     */
+    renderMermaid(diagram: Diagram): string;
+    /**
+     * Get Mermaid shape syntax
+     */
+    private mermaidShape;
+    /**
+     * Get Mermaid arrow syntax
+     */
+    private mermaidArrow;
+    /**
+     * Render as PlantUML
+     */
+    renderPlantUML(diagram: Diagram): string;
+    /**
+     * Render as SVG (simplified)
+     */
+    renderSVG(diagram: Diagram): string;
+    /**
+     * Render as ASCII art
+     */
+    renderASCII(diagram: Diagram): string;
+    /**
+     * Generate unique ID
+     */
+    private generateId;
+}
+/**
+ * Create visual explanation generator instance
+ */
+export declare function createVisualExplanationGenerator(config?: Partial<VisualGeneratorConfig>): VisualExplanationGenerator;
+//# sourceMappingURL=visual-explanation.d.ts.map

package/dist/explanation/visual-explanation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visual-explanation.d.ts","sourceRoot":"","sources":["../../src/explanation/visual-explanation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,UAAU,GACV,OAAO,GACP,qBAAqB,GACrB,OAAO,GACP,WAAW,GACX,YAAY,GACZ,SAAS,GACT,OAAO,GACP,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,KAAK,GAAG,OAAO,GAAG,MAAM,CAAC;AAE7E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW;IACX,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,CAAC;IAC/C,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY;IACZ,KAAK,CAAC,EAAE,YAAY,CAAC;IACrB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,iBAAiB;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,mBAAmB;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY;IACZ,KAAK,CAAC,EAAE,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,OAAO,CAAC;IAC/E,iBAAiB;IACjB,SAAS,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC1C,gBAAgB;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,QAAQ,CAAC,EAAE;QAAE,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpC,WAAW;IACX,IAAI,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,qBAAqB;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,iBAAiB;IACjB,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,YAAa,SAAQ,aAAa;IACjD,IAAI,EAAE,OAAO,CAAC;IACd,wBAAwB;IACxB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,WAAW;IACX,IAAI,EAAE,WAAW,CAAC;IAClB,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe;IACf,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,uBAAuB;IACvB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAC;IACtC,YAAY;IACZ,KAAK,CAAC,EAAE,YAAY,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAsBvD,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,8BAA8B;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,sBAAsB;IACtB,QAAQ,EAAE,WAAW,GAAG,SAAS,GAAG,aAAa,GAAG,SAAS,CAAC;IAC9D,uBAAuB;IACvB,UAAU,EAAE,QAAQ,GAAG,cAAc,GAAG,UAAU,CAAC;IACnD,yBAAyB;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wBAAwB;IACxB,OAAO,EAAE,OAAO,CAAC;IACjB,4BAA4B;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB;IACnB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,sBAAsB;IACtB,QAAQ,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;IACvC,uBAAuB;IACvB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,2BAA2B;IAC3B,WAAW,EAAE,WAAW,CAAC;IACzB,4BAA4B;IAC5B,aAAa,EAAE,YAAY,CAAC;IAC5B,oBAAoB;IACpB,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uBAAuB;IACvB,eAAe,EAAE,OAAO,CAAC;IACzB,+BAA+B;IAC/B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,qBAOnC,CAAC;AAEF;;GAEG;AACH,qBAAa,0BAA0B;IACrC,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,cAAc,CAAK;gBAEf,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAInD;;OAEG;IACH,QAAQ,CACN,OAAO,EAAE,kBAAkB,EAC3B,WAAW,CAAC,EAAE,WAAW,GACxB,iBAAiB;IA4BpB;;OAEG;IACH,OAAO,CAAC,aAAa;IAwCrB;;OAEG;IACH,OAAO,CAAC,yBAAyB;IA6BjC;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAuBhC;;OAEG;IACH,OAAO,CAAC,qBAAqB;IA4B7B;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAyB/B;;OAEG;IACH,OAAO,CAAC,qBAAqB;IA4B7B;;OAEG;IACH,OAAO,CAAC,yBAAyB;IAoBjC;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAkB/B;;OAEG;IACH,OAAO,CAAC,UAAU;IAUlB;;OAEG;IACH,OAAO,CAAC,UAAU;IAiBlB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA+B1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAa1B;;OAEG;IACH,OAAO,CAAC,aAAa;IAgBrB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;IACH,OAAO,CAAC,cAAc;IAYtB;;OAEG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAazB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAYxB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAW1B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA0CzB;;OAEG;IACH,OAAO,CAAC,eAAe;IAsCvB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAuB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAUxB;;OAEG;IACH,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IA0CvC;;OAEG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;IACH,OAAO,CAAC,YAAY;IAWpB;;OAEG;IACH,cAAc,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAuBxC;;OAEG;IACH,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IAuBnC;;OAEG;IACH,WAAW,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM;IA4BrC;;OAEG;IACH,OAAO,CAAC,UAAU;CAGnB;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAC9C,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACtC,0BAA0B,CAE5B"}