qfai 0.4.0 → 0.4.4

package/dist/index.d.cts

@@ -1,3 +1,16 @@
+type ScCoverage = {
+    total: number;
+    covered: number;
+    missing: number;
+    missingIds: string[];
+    refs: Record<string, string[]>;
+};
+type TestFileScan = {
+    globs: string[];
+    excludeGlobs: string[];
+    matchedFileCount: number;
+};
+
 type IssueSeverity = "info" | "warning" | "error";
 type IssueLocation = {
     line: number;
@@ -17,10 +30,15 @@ type ValidationCounts = {
     warning: number;
     error: number;
 };
+type ValidationTraceability = {
+    sc: ScCoverage;
+    testFiles: TestFileScan;
+};
 type ValidationResult = {
     toolVersion: string;
     issues: Issue[];
     counts: ValidationCounts;
+    traceability?: ValidationTraceability;
 };
 
 type FailOn = "never" | "warning" | "error";
@@ -42,8 +60,9 @@ type QfaiValidationConfig = {
     };
     traceability: {
         brMustHaveSc: boolean;
-        scMustTouchContracts: boolean;
         scMustHaveTest: boolean;
+        testFileGlobs: string[];
+        testFileExcludeGlobs: string[];
         scNoTestSeverity: TraceabilitySeverity;
         allowOrphanContracts: boolean;
         unknownContractIdSeverity: TraceabilitySeverity;
@@ -68,20 +87,12 @@ declare function getConfigPath(root: string): string;
 declare function loadConfig(root: string): Promise<ConfigLoadResult>;
 declare function resolvePath(root: string, config: QfaiConfig, key: ConfigPathKey): string;
 
-type IdPrefix = "SPEC" | "BR" | "SC" | "UI" | "API" | "DATA";
+type IdPrefix = "SPEC" | "BR" | "SC" | "UI" | "API" | "DB";
 type IdFormatPrefix = IdPrefix | "ADR";
 declare function extractIds(text: string, prefix: IdPrefix): string[];
 declare function extractAllIds(text: string): string[];
 declare function extractInvalidIds(text: string, prefixes: IdFormatPrefix[]): string[];
 
-type ScCoverage = {
-    total: number;
-    covered: number;
-    missing: number;
-    missingIds: string[];
-    refs: Record<string, string[]>;
-};
-
 type ReportSummary = {
     specs: number;
     scenarios: number;
@@ -98,12 +109,26 @@ type ReportIds = {
     sc: string[];
     ui: string[];
     api: string[];
-    data: string[];
+    db: string[];
+};
+type ReportContractCoverage = {
+    total: number;
+    referenced: number;
+    orphan: number;
+    idToSpecs: Record<string, string[]>;
+};
+type ReportSpecCoverage = {
+    contractRefMissing: number;
+    specToContractIds: Record<string, string[]>;
 };
 type ReportTraceability = {
     upstreamIdsFound: number;
     referencedInCodeOrTests: boolean;
     sc: ScCoverage;
+    scSources: Record<string, string[]>;
+    testFiles: TestFileScan;
+    contracts: ReportContractCoverage;
+    specs: ReportSpecCoverage;
 };
 type ReportData = {
     tool: "qfai";
@@ -139,4 +164,4 @@ declare function validateSpecContent(text: string, file: string, requiredSection
 
 declare function validateTraceability(root: string, config: QfaiConfig): Promise<Issue[]>;
 
-export { type ConfigLoadResult, type ConfigPathKey, type FailOn, type IdFormatPrefix, type IdPrefix, type Issue, type IssueLocation, type IssueSeverity, type OutputFormat, type QfaiConfig, type QfaiOutputConfig, type QfaiPaths, type QfaiValidationConfig, type ReportData, type ReportIds, type ReportSummary, type ReportTraceability, type TraceabilitySeverity, type ValidationCounts, type ValidationResult, createReportData, defaultConfig, extractAllIds, extractIds, extractInvalidIds, formatReportJson, formatReportMarkdown, getConfigPath, lintSql, loadConfig, resolvePath, resolveToolVersion, validateContracts, validateDefinedIds, validateDeltas, validateProject, validateScenarioContent, validateScenarios, validateSpecContent, validateSpecs, validateTraceability };
+export { type ConfigLoadResult, type ConfigPathKey, type FailOn, type IdFormatPrefix, type IdPrefix, type Issue, type IssueLocation, type IssueSeverity, type OutputFormat, type QfaiConfig, type QfaiOutputConfig, type QfaiPaths, type QfaiValidationConfig, type ReportContractCoverage, type ReportData, type ReportIds, type ReportSpecCoverage, type ReportSummary, type ReportTraceability, type TraceabilitySeverity, type ValidationCounts, type ValidationResult, type ValidationTraceability, createReportData, defaultConfig, extractAllIds, extractIds, extractInvalidIds, formatReportJson, formatReportMarkdown, getConfigPath, lintSql, loadConfig, resolvePath, resolveToolVersion, validateContracts, validateDefinedIds, validateDeltas, validateProject, validateScenarioContent, validateScenarios, validateSpecContent, validateSpecs, validateTraceability };