@nahisaho/musubix-core 1.0.0

package/dist/requirements/related-finder.d.ts

@@ -0,0 +1,261 @@
+/**
+ * Related Requirements Finder
+ *
+ * Finds related requirements based on semantic similarity
+ *
+ * @packageDocumentation
+ * @module requirements/related-finder
+ *
+ * @see REQ-RA-003 - Related Requirements Finding
+ * @see Article III - Traceability
+ */
+/**
+ * Similarity algorithm
+ */
+export type SimilarityAlgorithm = 'cosine' | 'jaccard' | 'levenshtein' | 'tfidf' | 'semantic';
+/**
+ * Relationship type
+ */
+export type RelationshipType = 'derives' | 'refines' | 'conflicts' | 'depends' | 'similar' | 'parent' | 'child' | 'implements' | 'verifies' | 'traces';
+/**
+ * Requirement for analysis
+ */
+export interface AnalyzableRequirement {
+    /** Requirement ID */
+    id: string;
+    /** Title */
+    title: string;
+    /** Description/content */
+    description: string;
+    /** Type (functional, non-functional, etc.) */
+    type?: string;
+    /** Priority */
+    priority?: string;
+    /** Tags/keywords */
+    tags?: string[];
+    /** Category */
+    category?: string;
+    /** Parent requirement */
+    parent?: string;
+    /** Metadata */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Related requirement result
+ */
+export interface RelatedRequirement {
+    /** Requirement ID */
+    id: string;
+    /** Requirement title */
+    title: string;
+    /** Relationship type */
+    relationshipType: RelationshipType;
+    /** Similarity score (0-1) */
+    similarity: number;
+    /** Reason for relationship */
+    reason: string;
+    /** Shared terms */
+    sharedTerms: string[];
+    /** Confidence (0-1) */
+    confidence: number;
+}
+/**
+ * Search result
+ */
+export interface SearchResult {
+    /** Source requirement ID */
+    sourceId: string;
+    /** Related requirements */
+    related: RelatedRequirement[];
+    /** Search time (ms) */
+    searchTime: number;
+    /** Algorithm used */
+    algorithm: SimilarityAlgorithm;
+    /** Total candidates analyzed */
+    candidatesAnalyzed: number;
+}
+/**
+ * Requirement cluster
+ */
+export interface RequirementCluster {
+    /** Cluster ID */
+    id: string;
+    /** Cluster name/theme */
+    name: string;
+    /** Requirements in cluster */
+    requirements: string[];
+    /** Central requirement */
+    centroid: string;
+    /** Cohesion score */
+    cohesion: number;
+    /** Key terms */
+    keyTerms: string[];
+}
+/**
+ * Related finder config
+ */
+export interface RelatedFinderConfig {
+    /** Default algorithm */
+    algorithm: SimilarityAlgorithm;
+    /** Minimum similarity threshold */
+    minSimilarity: number;
+    /** Maximum results */
+    maxResults: number;
+    /** Include relationship inference */
+    inferRelationships: boolean;
+    /** Stop words to ignore */
+    stopWords: string[];
+    /** Domain-specific synonyms */
+    synonyms: Map<string, string[]>;
+    /** Weight for title matching */
+    titleWeight: number;
+    /** Weight for description matching */
+    descriptionWeight: number;
+    /** Weight for tag matching */
+    tagWeight: number;
+}
+/**
+ * Default configuration
+ */
+export declare const DEFAULT_FINDER_CONFIG: RelatedFinderConfig;
+/**
+ * Related Requirements Finder
+ */
+export declare class RelatedRequirementsFinder {
+    private config;
+    private requirements;
+    private tfDocuments;
+    private idfScores;
+    private documentCount;
+    constructor(config?: Partial<RelatedFinderConfig>);
+    /**
+     * Add requirements to the index
+     */
+    index(requirements: AnalyzableRequirement[]): void;
+    /**
+     * Add a single requirement
+     */
+    add(requirement: AnalyzableRequirement): void;
+    /**
+     * Remove a requirement
+     */
+    remove(id: string): void;
+    /**
+     * Find related requirements
+     */
+    findRelated(requirementId: string, options?: {
+        algorithm?: SimilarityAlgorithm;
+        minSimilarity?: number;
+        maxResults?: number;
+        relationshipTypes?: RelationshipType[];
+    }): SearchResult;
+    /**
+     * Find requirements similar to text
+     */
+    findByText(text: string, options?: {
+        algorithm?: SimilarityAlgorithm;
+        minSimilarity?: number;
+        maxResults?: number;
+    }): RelatedRequirement[];
+    /**
+     * Cluster requirements by similarity
+     */
+    cluster(options?: {
+        threshold?: number;
+        minClusterSize?: number;
+    }): RequirementCluster[];
+    /**
+     * Find gaps in requirement coverage
+     */
+    findGaps(): {
+        orphanRequirements: string[];
+        weaklyConnected: string[];
+        missingRelationships: Array<{
+            from: string;
+            to: string;
+            suggestedType: RelationshipType;
+        }>;
+    };
+    /**
+     * Get requirement by ID
+     */
+    get(id: string): AnalyzableRequirement | undefined;
+    /**
+     * Get all requirements
+     */
+    getAll(): AnalyzableRequirement[];
+    /**
+     * Get statistics
+     */
+    getStatistics(): {
+        totalRequirements: number;
+        avgSimilarity: number;
+        termCount: number;
+        clusterCount: number;
+    };
+    /**
+     * Build TF-IDF index
+     */
+    private buildIndex;
+    /**
+     * Tokenize a requirement
+     */
+    private tokenize;
+    /**
+     * Calculate similarity between two requirements
+     */
+    private calculateSimilarity;
+    /**
+     * Cosine similarity
+     */
+    private cosineSimilarity;
+    /**
+     * Calculate cosine similarity directly from terms
+     */
+    private calculateCosineDirect;
+    /**
+     * Jaccard similarity
+     */
+    private jaccardSimilarity;
+    /**
+     * Levenshtein similarity
+     */
+    private levenshteinSimilarity;
+    /**
+     * Calculate Levenshtein distance
+     */
+    private levenshteinDistance;
+    /**
+     * TF-IDF similarity
+     */
+    private tfidfSimilarity;
+    /**
+     * Calculate TF-IDF scores for terms
+     */
+    private calculateTFIDF;
+    /**
+     * Infer relationship between requirements
+     */
+    private inferRelationship;
+    /**
+     * Find shared terms between requirements
+     */
+    private findSharedTerms;
+    /**
+     * Check if explicit relationship exists
+     */
+    private hasExplicitRelationship;
+    /**
+     * Extract key terms from cluster
+     */
+    private extractClusterTerms;
+    /**
+     * Calculate cluster cohesion
+     */
+    private calculateClusterCohesion;
+}
+/**
+ * Create related requirements finder instance
+ */
+export declare function createRelatedRequirementsFinder(config?: Partial<RelatedFinderConfig>): RelatedRequirementsFinder;
+//# sourceMappingURL=related-finder.d.ts.map

package/dist/requirements/related-finder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"related-finder.d.ts","sourceRoot":"","sources":["../../src/requirements/related-finder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,GAAG,aAAa,GAAG,OAAO,GAAG,UAAU,CAAC;AAE9F;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,SAAS,GACT,WAAW,GACX,SAAS,GACT,SAAS,GACT,QAAQ,GACR,OAAO,GACP,YAAY,GACZ,UAAU,GACV,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,YAAY;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,0BAA0B;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oBAAoB;IACpB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,yBAAyB;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,qBAAqB;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,6BAA6B;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,4BAA4B;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,2BAA2B;IAC3B,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,uBAAuB;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,qBAAqB;IACrB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,gCAAgC;IAChC,kBAAkB,EAAE,MAAM,CAAC;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,iBAAiB;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,gBAAgB;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,wBAAwB;IACxB,SAAS,EAAE,mBAAmB,CAAC;IAC/B,mCAAmC;IACnC,aAAa,EAAE,MAAM,CAAC;IACtB,sBAAsB;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,qCAAqC;IACrC,kBAAkB,EAAE,OAAO,CAAC;IAC5B,2BAA2B;IAC3B,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,+BAA+B;IAC/B,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAChC,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,sCAAsC;IACtC,iBAAiB,EAAE,MAAM,CAAC;IAC1B,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,mBA6BnC,CAAC;AAWF;;GAEG;AACH,qBAAa,yBAAyB;IACpC,OAAO,CAAC,MAAM,CAAsB;IACpC,OAAO,CAAC,YAAY,CAAqC;IACzD,OAAO,CAAC,WAAW,CAA0B;IAC7C,OAAO,CAAC,SAAS,CAAsB;IACvC,OAAO,CAAC,aAAa,CAAK;gBAEd,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC;IAOjD;;OAEG;IACH,KAAK,CAAC,YAAY,EAAE,qBAAqB,EAAE,GAAG,IAAI;IAOlD;;OAEG;IACH,GAAG,CAAC,WAAW,EAAE,qBAAqB,GAAG,IAAI;IAK7C;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI;IAMxB;;OAEG;IACH,WAAW,CACT,aAAa,EAAE,MAAM,EACrB,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,mBAAmB,CAAC;QAChC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;KACxC,GACA,YAAY;IA6Df;;OAEG;IACH,UAAU,CACR,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,mBAAmB,CAAC;QAChC,aAAa,CAAC,EAAE,MAAM,CAAC;QACvB,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,GACA,kBAAkB,EAAE;IAmCvB;;OAEG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,cAAc,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,kBAAkB,EAAE;IA4CxF;;OAEG;IACH,QAAQ,IAAI;QACV,kBAAkB,EAAE,MAAM,EAAE,CAAC;QAC7B,eAAe,EAAE,MAAM,EAAE,CAAC;QAC1B,oBAAoB,EAAE,KAAK,CAAC;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,EAAE,EAAE,MAAM,CAAC;YAAC,aAAa,EAAE,gBAAgB,CAAA;SAAE,CAAC,CAAC;KAC5F;IAyCD;;OAEG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAIlD;;OAEG;IACH,MAAM,IAAI,qBAAqB,EAAE;IAIjC;;OAEG;IACH,aAAa,IAAI;QACf,iBAAiB,EAAE,MAAM,CAAC;QAC1B,aAAa,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,YAAY,EAAE,MAAM,CAAC;KACtB;IAwBD;;OAEG;IACH,OAAO,CAAC,UAAU;IAwClB;;OAEG;IACH,OAAO,CAAC,QAAQ;IA+BhB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAsB3B;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAuBxB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAwB7B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAWzB;;OAEG;IACH,OAAO,CAAC,qBAAqB;IAW7B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAmC3B;;OAEG;IACH,OAAO,CAAC,eAAe;IAwBvB;;OAEG;IACH,OAAO,CAAC,cAAc;IAetB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA8DzB;;OAEG;IACH,OAAO,CAAC,eAAe;IAgBvB;;OAEG;IACH,OAAO,CAAC,uBAAuB;IAK/B;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAuB3B;;OAEG;IACH,OAAO,CAAC,wBAAwB;CAqBjC;AAED;;GAEG;AACH,wBAAgB,+BAA+B,CAC7C,MAAM,CAAC,EAAE,OAAO,CAAC,mBAAmB,CAAC,GACpC,yBAAyB,CAE3B"}