@nahisaho/musubix-core 1.0.0

package/dist/design/pattern-detector.d.ts

@@ -0,0 +1,270 @@
+/**
+ * Design Pattern Detector
+ *
+ * Detects and suggests design patterns in code and design documents
+ *
+ * @packageDocumentation
+ * @module design/pattern-detector
+ *
+ * @see REQ-DES-001 - Design Pattern Detection
+ * @see Article III - Design Validation
+ */
+/**
+ * Design pattern categories
+ */
+export type PatternCategory = 'creational' | 'structural' | 'behavioral' | 'architectural';
+/**
+ * Design pattern definition
+ */
+export interface DesignPattern {
+    /** Pattern ID */
+    id: string;
+    /** Pattern name */
+    name: string;
+    /** Category */
+    category: PatternCategory;
+    /** Description */
+    description: string;
+    /** Intent */
+    intent: string;
+    /** When to use */
+    applicability: string[];
+    /** Key participants */
+    participants: PatternParticipant[];
+    /** Detection indicators */
+    indicators: PatternIndicator[];
+    /** Related patterns */
+    relatedPatterns: string[];
+}
+/**
+ * Pattern participant
+ */
+export interface PatternParticipant {
+    /** Role name */
+    name: string;
+    /** Description */
+    description: string;
+    /** Is optional */
+    optional: boolean;
+}
+/**
+ * Pattern indicator for detection
+ */
+export interface PatternIndicator {
+    /** Indicator type */
+    type: 'naming' | 'structure' | 'method' | 'relation';
+    /** Detection pattern (regex or keyword) */
+    pattern: string;
+    /** Weight for scoring */
+    weight: number;
+}
+/**
+ * Pattern detection result
+ */
+export interface PatternDetectionResult {
+    /** Detected pattern */
+    pattern: DesignPattern;
+    /** Confidence score (0-1) */
+    confidence: number;
+    /** Where detected */
+    location: PatternLocation;
+    /** Matched indicators */
+    matchedIndicators: MatchedIndicator[];
+    /** Missing elements */
+    missingElements: string[];
+    /** Suggestions */
+    suggestions: string[];
+}
+/**
+ * Pattern location
+ */
+export interface PatternLocation {
+    /** File path */
+    file?: string;
+    /** Start line */
+    startLine?: number;
+    /** End line */
+    endLine?: number;
+    /** Class/module name */
+    className?: string;
+    /** Method names involved */
+    methods?: string[];
+}
+/**
+ * Matched indicator
+ */
+export interface MatchedIndicator {
+    /** Indicator */
+    indicator: PatternIndicator;
+    /** Matched text */
+    matchedText: string;
+    /** Location */
+    location: string;
+}
+/**
+ * Pattern suggestion
+ */
+export interface PatternSuggestion {
+    /** Suggested pattern */
+    pattern: DesignPattern;
+    /** Reason for suggestion */
+    reason: string;
+    /** Applicability score (0-1) */
+    applicability: number;
+    /** Benefits */
+    benefits: string[];
+    /** Implementation hints */
+    implementationHints: string[];
+}
+/**
+ * Code structure for analysis
+ */
+export interface CodeStructure {
+    /** Classes/interfaces */
+    classes: ClassInfo[];
+    /** Functions */
+    functions: FunctionInfo[];
+    /** Relationships */
+    relationships: RelationshipInfo[];
+}
+/**
+ * Class information
+ */
+export interface ClassInfo {
+    /** Class name */
+    name: string;
+    /** Is interface */
+    isInterface: boolean;
+    /** Is abstract */
+    isAbstract: boolean;
+    /** Methods */
+    methods: string[];
+    /** Properties */
+    properties: string[];
+    /** Extends */
+    extends?: string;
+    /** Implements */
+    implements: string[];
+}
+/**
+ * Function information
+ */
+export interface FunctionInfo {
+    /** Function name */
+    name: string;
+    /** Parameters */
+    parameters: string[];
+    /** Return type */
+    returnType?: string;
+    /** Is static */
+    isStatic: boolean;
+}
+/**
+ * Relationship information
+ */
+export interface RelationshipInfo {
+    /** Source */
+    source: string;
+    /** Target */
+    target: string;
+    /** Type */
+    type: 'inheritance' | 'composition' | 'aggregation' | 'dependency' | 'association';
+}
+/**
+ * Pattern detector configuration
+ */
+export interface PatternDetectorConfig {
+    /** Minimum confidence for detection */
+    minConfidence: number;
+    /** Categories to detect */
+    categories: PatternCategory[];
+    /** Enable suggestions */
+    enableSuggestions: boolean;
+    /** Custom patterns */
+    customPatterns: DesignPattern[];
+}
+/**
+ * Default configuration
+ */
+export declare const DEFAULT_DETECTOR_CONFIG: PatternDetectorConfig;
+/**
+ * Built-in design patterns
+ */
+export declare const DESIGN_PATTERNS: DesignPattern[];
+/**
+ * Design Pattern Detector
+ */
+export declare class PatternDetector {
+    private config;
+    private patterns;
+    constructor(config?: Partial<PatternDetectorConfig>);
+    /**
+     * Detect patterns in code structure
+     */
+    detectPatterns(structure: CodeStructure): PatternDetectionResult[];
+    /**
+     * Detect patterns in source code text
+     */
+    detectInCode(code: string, fileName?: string): PatternDetectionResult[];
+    /**
+     * Suggest patterns for a problem context
+     */
+    suggestPatterns(context: {
+        problem: string;
+        constraints?: string[];
+        existing?: string[];
+    }): PatternSuggestion[];
+    /**
+     * Detect a specific pattern
+     */
+    private detectPattern;
+    /**
+     * Match an indicator against structure
+     */
+    private matchIndicator;
+    /**
+     * Parse code into structure (simplified)
+     */
+    private parseCodeStructure;
+    /**
+     * Extract methods from class
+     */
+    private extractMethods;
+    /**
+     * Extract properties from class
+     */
+    private extractProperties;
+    /**
+     * Find location in structure
+     */
+    private findLocation;
+    /**
+     * Find missing pattern elements
+     */
+    private findMissing;
+    /**
+     * Generate improvement suggestions
+     */
+    private generateImprovements;
+    /**
+     * Generate implementation hints
+     */
+    private generateHints;
+    /**
+     * Simple text matching
+     */
+    private textMatch;
+    /**
+     * Get all available patterns
+     */
+    getPatterns(): DesignPattern[];
+    /**
+     * Get patterns by category
+     */
+    getPatternsByCategory(category: PatternCategory): DesignPattern[];
+}
+/**
+ * Create pattern detector instance
+ */
+export declare function createPatternDetector(config?: Partial<PatternDetectorConfig>): PatternDetector;
+//# sourceMappingURL=pattern-detector.d.ts.map

package/dist/design/pattern-detector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pattern-detector.d.ts","sourceRoot":"","sources":["../../src/design/pattern-detector.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,YAAY,GACZ,YAAY,GACZ,YAAY,GACZ,eAAe,CAAC;AAEpB;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,eAAe;IACf,QAAQ,EAAE,eAAe,CAAC;IAC1B,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,kBAAkB;IAClB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,uBAAuB;IACvB,YAAY,EAAE,kBAAkB,EAAE,CAAC;IACnC,2BAA2B;IAC3B,UAAU,EAAE,gBAAgB,EAAE,CAAC;IAC/B,uBAAuB;IACvB,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,gBAAgB;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,kBAAkB;IAClB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB;IACrB,IAAI,EAAE,QAAQ,GAAG,WAAW,GAAG,QAAQ,GAAG,UAAU,CAAC;IACrD,2CAA2C;IAC3C,OAAO,EAAE,MAAM,CAAC;IAChB,yBAAyB;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,uBAAuB;IACvB,OAAO,EAAE,aAAa,CAAC;IACvB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,QAAQ,EAAE,eAAe,CAAC;IAC1B,yBAAyB;IACzB,iBAAiB,EAAE,gBAAgB,EAAE,CAAC;IACtC,uBAAuB;IACvB,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,kBAAkB;IAClB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,gBAAgB;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB;IAChB,SAAS,EAAE,gBAAgB,CAAC;IAC5B,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,eAAe;IACf,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,wBAAwB;IACxB,OAAO,EAAE,aAAa,CAAC;IACvB,4BAA4B;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,gCAAgC;IAChC,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe;IACf,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,2BAA2B;IAC3B,mBAAmB,EAAE,MAAM,EAAE,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,yBAAyB;IACzB,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,gBAAgB;IAChB,SAAS,EAAE,YAAY,EAAE,CAAC;IAC1B,oBAAoB;IACpB,aAAa,EAAE,gBAAgB,EAAE,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,iBAAiB;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,mBAAmB;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc;IACd,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,iBAAiB;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,iBAAiB;IACjB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,kBAAkB;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gBAAgB;IAChB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,aAAa;IACb,MAAM,EAAE,MAAM,CAAC;IACf,WAAW;IACX,IAAI,EAAE,aAAa,GAAG,aAAa,GAAG,aAAa,GAAG,YAAY,GAAG,aAAa,CAAC;CACpF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,uCAAuC;IACvC,aAAa,EAAE,MAAM,CAAC;IACtB,2BAA2B;IAC3B,UAAU,EAAE,eAAe,EAAE,CAAC;IAC9B,yBAAyB;IACzB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,sBAAsB;IACtB,cAAc,EAAE,aAAa,EAAE,CAAC;CACjC;AAED;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,qBAKrC,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,aAAa,EAyP1C,CAAC;AAEF;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,QAAQ,CAAkB;gBAEtB,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC;IAQnD;;OAEG;IACH,cAAc,CAAC,SAAS,EAAE,aAAa,GAAG,sBAAsB,EAAE;IAgBlE;;OAEG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,sBAAsB,EAAE;IAcvE;;OAEG;IACH,eAAe,CAAC,OAAO,EAAE;QACvB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,GAAG,iBAAiB,EAAE;IAgDvB;;OAEG;IACH,OAAO,CAAC,aAAa;IAiCrB;;OAEG;IACH,OAAO,CAAC,cAAc;IAwEtB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA+C1B;;OAEG;IACH,OAAO,CAAC,cAAc;IA6BtB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAezB;;OAEG;IACH,OAAO,CAAC,YAAY;IAqBpB;;OAEG;IACH,OAAO,CAAC,WAAW;IAgBnB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAmB5B;;OAEG;IACH,OAAO,CAAC,aAAa;IAUrB;;OAEG;IACH,OAAO,CAAC,SAAS;IAKjB;;OAEG;IACH,WAAW,IAAI,aAAa,EAAE;IAI9B;;OAEG;IACH,qBAAqB,CAAC,QAAQ,EAAE,eAAe,GAAG,aAAa,EAAE;CAGlE;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACtC,eAAe,CAEjB"}