qfai 0.2.5 → 0.2.8

package/dist/index.d.ts

@@ -1,2 +1,135 @@
-export * from "./core/index.js";
-//# sourceMappingURL=index.d.ts.map
+type IssueSeverity = "info" | "warning" | "error";
+declare const VALIDATION_SCHEMA_VERSION: "0.2";
+type IssueLocation = {
+    line: number;
+    column?: number;
+};
+type Issue = {
+    code: string;
+    severity: IssueSeverity;
+    message: string;
+    file?: string;
+    refs?: string[];
+    rule?: string;
+    loc?: IssueLocation;
+};
+type ValidationCounts = {
+    info: number;
+    warning: number;
+    error: number;
+};
+type ValidationResult = {
+    schemaVersion: typeof VALIDATION_SCHEMA_VERSION;
+    toolVersion: string;
+    issues: Issue[];
+    counts: ValidationCounts;
+};
+
+type FailOn = "never" | "warning" | "error";
+type OutputFormat = "text" | "json" | "github";
+type TraceabilitySeverity = "warning" | "error";
+type QfaiPaths = {
+    specDir: string;
+    decisionsDir: string;
+    scenariosDir: string;
+    contractsDir: string;
+    uiContractsDir: string;
+    apiContractsDir: string;
+    dataContractsDir: string;
+    srcDir: string;
+    testsDir: string;
+};
+type QfaiValidationConfig = {
+    failOn: FailOn;
+    require: {
+        specSections: string[];
+    };
+    traceability: {
+        brMustHaveSc: boolean;
+        scMustTouchContracts: boolean;
+        allowOrphanContracts: boolean;
+        unknownContractIdSeverity: TraceabilitySeverity;
+    };
+};
+type QfaiOutputConfig = {
+    format: OutputFormat;
+    jsonPath: string;
+};
+type QfaiConfig = {
+    paths: QfaiPaths;
+    validation: QfaiValidationConfig;
+    output: QfaiOutputConfig;
+};
+type ConfigPathKey = keyof QfaiPaths;
+type ConfigLoadResult = {
+    config: QfaiConfig;
+    issues: Issue[];
+    configPath: string;
+};
+declare const defaultConfig: QfaiConfig;
+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 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 ReportSummary = {
+    specs: number;
+    scenarios: number;
+    decisions: number;
+    contracts: {
+        api: number;
+        ui: number;
+        db: number;
+    };
+    counts: ValidationCounts;
+};
+type ReportIds = {
+    spec: string[];
+    br: string[];
+    sc: string[];
+    ui: string[];
+    api: string[];
+    data: string[];
+};
+type ReportTraceability = {
+    upstreamIdsFound: number;
+    referencedInCodeOrTests: boolean;
+};
+type ReportData = {
+    tool: "qfai";
+    version: string;
+    generatedAt: string;
+    root: string;
+    configPath: string;
+    summary: ReportSummary;
+    ids: ReportIds;
+    traceability: ReportTraceability;
+    issues: Issue[];
+};
+declare function createReportData(root: string, validation?: ValidationResult, configResult?: ConfigLoadResult): Promise<ReportData>;
+declare function formatReportMarkdown(data: ReportData): string;
+declare function formatReportJson(data: ReportData): string;
+
+declare function validateProject(root: string, configResult?: ConfigLoadResult): Promise<ValidationResult>;
+
+declare function resolveToolVersion(): Promise<string>;
+
+declare function validateContracts(root: string, config: QfaiConfig): Promise<Issue[]>;
+declare function lintSql(text: string, file: string): Issue[];
+
+declare function validateDefinedIds(root: string, config: QfaiConfig): Promise<Issue[]>;
+
+declare function validateScenarios(root: string, config: QfaiConfig): Promise<Issue[]>;
+declare function validateScenarioContent(text: string, file: string): Issue[];
+
+declare function validateSpecs(root: string, config: QfaiConfig): Promise<Issue[]>;
+declare function validateSpecContent(text: string, file: string, requiredSections: string[]): Issue[];
+
+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, VALIDATION_SCHEMA_VERSION, type ValidationCounts, type ValidationResult, createReportData, defaultConfig, extractAllIds, extractIds, extractInvalidIds, formatReportJson, formatReportMarkdown, getConfigPath, lintSql, loadConfig, resolvePath, resolveToolVersion, validateContracts, validateDefinedIds, validateProject, validateScenarioContent, validateScenarios, validateSpecContent, validateSpecs, validateTraceability };