@nahisaho/musubix-core 1.0.0

package/dist/design/c4-generator.d.ts

@@ -0,0 +1,267 @@
+/**
+ * C4 Model Generator
+ *
+ * Generates C4 architecture diagrams from design specifications
+ *
+ * @packageDocumentation
+ * @module design/c4-generator
+ *
+ * @see REQ-DES-004 - C4 Model Generation
+ * @see Article IV - Design-Implementation Consistency
+ */
+/**
+ * C4 diagram level
+ */
+export type C4Level = 'context' | 'container' | 'component' | 'code';
+/**
+ * C4 element type
+ */
+export type C4ElementType = 'person' | 'software-system' | 'container' | 'component' | 'code-element' | 'enterprise-boundary' | 'system-boundary' | 'container-boundary';
+/**
+ * C4 relationship type
+ */
+export type C4RelationshipType = 'uses' | 'calls' | 'sends' | 'reads' | 'writes' | 'subscribes' | 'publishes' | 'depends-on' | 'extends' | 'implements';
+/**
+ * C4 element
+ */
+export interface C4Element {
+    /** Element ID */
+    id: string;
+    /** Element type */
+    type: C4ElementType;
+    /** Name */
+    name: string;
+    /** Description */
+    description: string;
+    /** Technology */
+    technology?: string;
+    /** Tags */
+    tags?: string[];
+    /** Properties */
+    properties?: Record<string, string>;
+    /** External system */
+    external?: boolean;
+    /** Container ID (for components) */
+    containerId?: string;
+    /** System ID (for containers) */
+    systemId?: string;
+}
+/**
+ * C4 relationship
+ */
+export interface C4Relationship {
+    /** Relationship ID */
+    id: string;
+    /** Source element ID */
+    sourceId: string;
+    /** Target element ID */
+    targetId: string;
+    /** Relationship type */
+    type: C4RelationshipType;
+    /** Description */
+    description: string;
+    /** Technology/protocol */
+    technology?: string;
+    /** Tags */
+    tags?: string[];
+}
+/**
+ * C4 diagram
+ */
+export interface C4Diagram {
+    /** Diagram ID */
+    id: string;
+    /** Diagram title */
+    title: string;
+    /** Level */
+    level: C4Level;
+    /** Scope (system/container being detailed) */
+    scope?: string;
+    /** Elements */
+    elements: C4Element[];
+    /** Relationships */
+    relationships: C4Relationship[];
+    /** Description */
+    description?: string;
+    /** Generated at */
+    generatedAt: Date;
+}
+/**
+ * C4 model (complete set of diagrams)
+ */
+export interface C4Model {
+    /** Model ID */
+    id: string;
+    /** Model name */
+    name: string;
+    /** Diagrams */
+    diagrams: C4Diagram[];
+    /** All elements */
+    elements: C4Element[];
+    /** All relationships */
+    relationships: C4Relationship[];
+    /** Generated at */
+    generatedAt: Date;
+}
+/**
+ * Design input for generation
+ */
+export interface DesignInput {
+    /** System name */
+    systemName: string;
+    /** System description */
+    systemDescription: string;
+    /** Users/actors */
+    users?: Array<{
+        name: string;
+        description: string;
+    }>;
+    /** External systems */
+    externalSystems?: Array<{
+        name: string;
+        description: string;
+    }>;
+    /** Containers/services */
+    containers?: Array<{
+        name: string;
+        description: string;
+        technology: string;
+        type?: 'web-app' | 'api' | 'database' | 'queue' | 'storage' | 'service';
+    }>;
+    /** Components */
+    components?: Array<{
+        name: string;
+        description: string;
+        technology?: string;
+        containerId: string;
+    }>;
+    /** Interactions */
+    interactions?: Array<{
+        from: string;
+        to: string;
+        description: string;
+        technology?: string;
+    }>;
+}
+/**
+ * Output format
+ */
+export type OutputFormat = 'structurizr' | 'plantuml' | 'mermaid' | 'json';
+/**
+ * Generator config
+ */
+export interface C4GeneratorConfig {
+    /** Output format */
+    outputFormat: OutputFormat;
+    /** Include all levels */
+    includeAllLevels: boolean;
+    /** Generate code level diagrams */
+    includeCodeLevel: boolean;
+    /** Auto-detect containers */
+    autoDetectContainers: boolean;
+    /** Style configuration */
+    style?: C4Style;
+}
+/**
+ * C4 style configuration
+ */
+export interface C4Style {
+    /** Person color */
+    personColor?: string;
+    /** Software system color */
+    softwareSystemColor?: string;
+    /** Container color */
+    containerColor?: string;
+    /** Component color */
+    componentColor?: string;
+    /** External system color */
+    externalColor?: string;
+    /** Database color */
+    databaseColor?: string;
+}
+/**
+ * Default configuration
+ */
+export declare const DEFAULT_C4_CONFIG: C4GeneratorConfig;
+/**
+ * Default style
+ */
+export declare const DEFAULT_C4_STYLE: C4Style;
+/**
+ * C4 Model Generator
+ */
+export declare class C4ModelGenerator {
+    private config;
+    private elementCounter;
+    private relationshipCounter;
+    constructor(config?: Partial<C4GeneratorConfig>);
+    /**
+     * Generate C4 model from design input
+     */
+    generate(input: DesignInput): C4Model;
+    /**
+     * Export diagram to specified format
+     */
+    export(diagram: C4Diagram, format?: OutputFormat): string;
+    /**
+     * Export entire model
+     */
+    exportModel(model: C4Model, format?: OutputFormat): string;
+    /**
+     * Generate context diagram
+     */
+    private generateContextDiagram;
+    /**
+     * Generate container diagram
+     */
+    private generateContainerDiagram;
+    /**
+     * Generate component diagram
+     */
+    private generateComponentDiagram;
+    /**
+     * Create an element
+     */
+    private createElement;
+    /**
+     * Create a relationship
+     */
+    private createRelationship;
+    /**
+     * Find element by name
+     */
+    private findElement;
+    /**
+     * Export to Structurizr DSL
+     */
+    private toStructurizr;
+    /**
+     * Export to PlantUML
+     */
+    private toPlantUML;
+    /**
+     * Export to Mermaid
+     */
+    private toMermaid;
+    /**
+     * Get PlantUML container type
+     */
+    private getPlantUMLContainerType;
+    /**
+     * Get Mermaid icon for element
+     */
+    private getMermaidIcon;
+    /**
+     * Sanitize ID for diagram formats
+     */
+    private sanitizeId;
+    /**
+     * Capitalize first letter
+     */
+    private capitalizeFirst;
+}
+/**
+ * Create C4 model generator instance
+ */
+export declare function createC4ModelGenerator(config?: Partial<C4GeneratorConfig>): C4ModelGenerator;
+//# sourceMappingURL=c4-generator.d.ts.map

package/dist/design/c4-generator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"c4-generator.d.ts","sourceRoot":"","sources":["../../src/design/c4-generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,SAAS,GAAG,WAAW,GAAG,WAAW,GAAG,MAAM,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,QAAQ,GACR,iBAAiB,GACjB,WAAW,GACX,WAAW,GACX,cAAc,GACd,qBAAqB,GACrB,iBAAiB,GACjB,oBAAoB,CAAC;AAEzB;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAC1B,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,YAAY,GACZ,WAAW,GACX,YAAY,GACZ,SAAS,GACT,YAAY,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,mBAAmB;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,iBAAiB;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,iBAAiB;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACpC,sBAAsB;IACtB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,sBAAsB;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,IAAI,EAAE,kBAAkB,CAAC;IACzB,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,0BAA0B;IAC1B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW;IACX,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,YAAY;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe;IACf,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,oBAAoB;IACpB,aAAa,EAAE,cAAc,EAAE,CAAC;IAChC,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mBAAmB;IACnB,WAAW,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,eAAe;IACf,EAAE,EAAE,MAAM,CAAC;IACX,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,mBAAmB;IACnB,QAAQ,EAAE,SAAS,EAAE,CAAC;IACtB,wBAAwB;IACxB,aAAa,EAAE,cAAc,EAAE,CAAC;IAChC,mBAAmB;IACnB,WAAW,EAAE,IAAI,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,kBAAkB;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,yBAAyB;IACzB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,mBAAmB;IACnB,KAAK,CAAC,EAAE,KAAK,CAAC;QACZ,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,uBAAuB;IACvB,eAAe,CAAC,EAAE,KAAK,CAAC;QACtB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,0BAA0B;IAC1B,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,SAAS,GAAG,KAAK,GAAG,UAAU,GAAG,OAAO,GAAG,SAAS,GAAG,SAAS,CAAC;KACzE,CAAC,CAAC;IACH,iBAAiB;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;IACH,mBAAmB;IACnB,YAAY,CAAC,EAAE,KAAK,CAAC;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,CAAC;QACX,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,GAAG,MAAM,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,oBAAoB;IACpB,YAAY,EAAE,YAAY,CAAC;IAC3B,yBAAyB;IACzB,gBAAgB,EAAE,OAAO,CAAC;IAC1B,mCAAmC;IACnC,gBAAgB,EAAE,OAAO,CAAC;IAC1B,6BAA6B;IAC7B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,0BAA0B;IAC1B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,mBAAmB;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,4BAA4B;IAC5B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,sBAAsB;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,sBAAsB;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4BAA4B;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,qBAAqB;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,iBAK/B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,OAO9B,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAoB;IAClC,OAAO,CAAC,cAAc,CAAK;IAC3B,OAAO,CAAC,mBAAmB,CAAK;gBAEpB,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC;IAI/C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO;IAyFrC;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,SAAS,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,MAAM;IAiBzD;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,YAAY,GAAG,MAAM;IAU1D;;OAEG;IACH,OAAO,CAAC,sBAAsB;IA6B9B;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA+BhC;;OAEG;IACH,OAAO,CAAC,wBAAwB;IA8BhC;;OAEG;IACH,OAAO,CAAC,aAAa;IAerB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAiB1B;;OAEG;IACH,OAAO,CAAC,WAAW;IAInB;;OAEG;IACH,OAAO,CAAC,aAAa;IA8CrB;;OAEG;IACH,OAAO,CAAC,UAAU;IA8ClB;;OAEG;IACH,OAAO,CAAC,SAAS;IA2FjB;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAOhC;;OAEG;IACH,OAAO,CAAC,cAAc;IAUtB;;OAEG;IACH,OAAO,CAAC,UAAU;IAIlB;;OAEG;IACH,OAAO,CAAC,eAAe;CAGxB;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,gBAAgB,CAE5F"}