api-tests-coverage 1.0.0

package/dist/src/summary/buildSummary.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Summary engine – build/CI summary generator.
+ *
+ * Generates PR/CI build summaries that include only the sections that actually
+ * ran or had gates evaluated (gate-aware inclusion).
+ *
+ * Public API:
+ *   generateBuildSummary(input): Promise<SummaryResult>
+ */
+import { SummaryInput, SummaryResult } from './markdownRenderer';
+/**
+ * Generate a full build/CI summary from analysis results.
+ *
+ * Gate-aware inclusion rules:
+ *  - A section is included when: the analyzer ran (results present) OR the gate
+ *    was explicitly configured for that category.
+ *  - A section is omitted when: neither results nor gate configuration exist.
+ *  - Security scanning section is included only when securityScan is provided.
+ *
+ * @param input     All analysis results and configuration.
+ * @param outDir    Optional directory to write output files to (e.g. "reports").
+ *                  When provided, writes pr-summary.md, build-summary.md,
+ *                  summary.json, ai-summary.md, and ai-summary.json.
+ */
+export declare function generateBuildSummary(input: SummaryInput, outDir?: string): Promise<SummaryResult>;
+export type { SummaryInput, SummaryResult, SummarySection, SummaryConfig } from './markdownRenderer';
+export { renderIntelligenceSection } from './markdownRenderer';
+//# sourceMappingURL=buildSummary.d.ts.map

package/dist/src/summary/buildSummary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"buildSummary.d.ts","sourceRoot":"","sources":["../../../src/summary/buildSummary.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAIH,OAAO,EACL,YAAY,EACZ,aAAa,EAYd,MAAM,oBAAoB,CAAC;AAK5B;;;;;;;;;;;;;GAaG;AACH,wBAAsB,oBAAoB,CACxC,KAAK,EAAE,YAAY,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,aAAa,CAAC,CAuBxB;AAkND,YAAY,EAAE,YAAY,EAAE,aAAa,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACrG,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/src/summary/buildSummary.js

@@ -0,0 +1,257 @@
+"use strict";
+/**
+ * Summary engine – build/CI summary generator.
+ *
+ * Generates PR/CI build summaries that include only the sections that actually
+ * ran or had gates evaluated (gate-aware inclusion).
+ *
+ * Public API:
+ *   generateBuildSummary(input): Promise<SummaryResult>
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderIntelligenceSection = void 0;
+exports.generateBuildSummary = generateBuildSummary;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+const markdownRenderer_1 = require("./markdownRenderer");
+const evaluateMetrics_1 = require("./evaluateMetrics");
+// ─── Build summary generator ──────────────────────────────────────────────────
+/**
+ * Generate a full build/CI summary from analysis results.
+ *
+ * Gate-aware inclusion rules:
+ *  - A section is included when: the analyzer ran (results present) OR the gate
+ *    was explicitly configured for that category.
+ *  - A section is omitted when: neither results nor gate configuration exist.
+ *  - Security scanning section is included only when securityScan is provided.
+ *
+ * @param input     All analysis results and configuration.
+ * @param outDir    Optional directory to write output files to (e.g. "reports").
+ *                  When provided, writes pr-summary.md, build-summary.md,
+ *                  summary.json, ai-summary.md, and ai-summary.json.
+ */
+async function generateBuildSummary(input, outDir) {
+    const sections = buildSections(input);
+    const included = sections.filter((s) => s.included);
+    const headerLines = buildHeader(input, 'build');
+    const bodyLines = [];
+    for (const section of included) {
+        bodyLines.push(section.markdown);
+    }
+    const footer = buildFooter(input);
+    const markdown = [...headerLines, '', ...bodyLines, footer].join('\n');
+    const aiMarkdown = (0, markdownRenderer_1.renderAiSummary)(input, sections);
+    const json = buildJsonSummary(input, sections);
+    if (outDir) {
+        await writeOutputFiles(outDir, markdown, aiMarkdown, json);
+    }
+    return { markdown, sections, json };
+}
+// ─── Internals ────────────────────────────────────────────────────────────────
+function buildHeader(input, mode) {
+    var _a, _b, _c;
+    const overallPassed = (_b = (_a = input.qualityGate) === null || _a === void 0 ? void 0 : _a.passed) !== null && _b !== void 0 ? _b : true;
+    const statusEmoji = overallPassed ? '✅' : '❌';
+    const title = mode === 'pr'
+        ? `${statusEmoji} API Coverage — ${overallPassed ? 'PASSED' : 'FAILED'}`
+        : `## ${statusEmoji} API Coverage Report — ${overallPassed ? 'PASSED' : 'FAILED'}`;
+    const lines = [title, ''];
+    lines.push('| | |');
+    lines.push('|---|---|');
+    if (input.projectName)
+        lines.push((0, markdownRenderer_1.tableRow)('Project', input.projectName));
+    if (input.branch)
+        lines.push((0, markdownRenderer_1.tableRow)('Branch', input.branch));
+    if (input.commitSha)
+        lines.push((0, markdownRenderer_1.tableRow)('Commit', `\`${input.commitSha}\``));
+    if (input.buildId)
+        lines.push((0, markdownRenderer_1.tableRow)('Build ID', `\`${input.buildId}\``));
+    lines.push('');
+    // Coverage summary table — uses evaluated metrics for correct PASS/FAIL/N/A/SKIPPED
+    if (input.results.length > 0) {
+        const evaluatedMetrics = (0, evaluateMetrics_1.evaluateMetrics)(input.results, (_c = input.thresholds) !== null && _c !== void 0 ? _c : {}, input.qualityGate);
+        lines.push('### Coverage Summary');
+        lines.push('');
+        lines.push('| Category | Total | Covered | Coverage | Status |');
+        lines.push('|---|---|---|---|---|');
+        for (const m of evaluatedMetrics) {
+            const totalCell = m.applicable ? String(m.totalItems) : '—';
+            const coveredCell = m.applicable ? String(m.coveredItems) : '—';
+            const coverageCell = m.applicable ? (0, markdownRenderer_1.pct)(m.coveragePercent) : '—';
+            lines.push(`| ${m.category} | ${totalCell} | ${coveredCell} | ${coverageCell} | ${(0, markdownRenderer_1.metricStatusCell)(m.status)} |`);
+        }
+        lines.push('');
+    }
+    return lines;
+}
+function buildSections(input) {
+    var _a, _b, _c, _d, _e, _f;
+    const sections = [];
+    const thresholds = (_a = input.thresholds) !== null && _a !== void 0 ? _a : {};
+    const onlyEvaluated = (_c = (_b = input.summaryConfig) === null || _b === void 0 ? void 0 : _b.includeOnlyEvaluatedSections) !== null && _c !== void 0 ? _c : false;
+    // Coverage sections – one per result
+    for (const result of input.results) {
+        const threshold = thresholds[result.type];
+        const gateEvaluated = threshold !== undefined;
+        const failure = (_d = input.qualityGate) === null || _d === void 0 ? void 0 : _d.failures.find((f) => f.category === result.type);
+        const passed = gateEvaluated ? failure === undefined : undefined;
+        // Gate-aware inclusion: include if results ran, unless onlyEvaluated forces us to skip
+        const included = onlyEvaluated ? gateEvaluated : true;
+        sections.push({
+            id: result.type,
+            title: (0, markdownRenderer_1.coverageTypeTitle)(result.type),
+            included,
+            gateEvaluated,
+            passed,
+            markdown: included
+                ? (0, markdownRenderer_1.renderCoverageSection)(result, threshold, failure !== undefined)
+                : '',
+        });
+    }
+    // Security scanning section
+    if (input.securityScan) {
+        const scannerResults = (_e = input.scannerResults) !== null && _e !== void 0 ? _e : [];
+        const gatePassed = (_f = input.securityScan.gateResult) === null || _f === void 0 ? void 0 : _f.passed;
+        const sectionGateEvaluated = input.securityScan.gateResult !== undefined;
+        const included = !onlyEvaluated || sectionGateEvaluated;
+        sections.push({
+            id: 'security-scan',
+            title: 'Security Scanning',
+            included,
+            gateEvaluated: sectionGateEvaluated,
+            passed: gatePassed,
+            markdown: included
+                ? (0, markdownRenderer_1.renderSecurityScanSection)(input.securityScan, scannerResults, sectionGateEvaluated, gatePassed)
+                : '',
+        });
+    }
+    // Coverage Intelligence section
+    if (input.intelligenceSummary) {
+        sections.push({
+            id: 'coverage-intelligence',
+            title: 'Coverage Intelligence',
+            included: true,
+            gateEvaluated: false,
+            passed: undefined,
+            markdown: (0, markdownRenderer_1.renderIntelligenceSection)(input.intelligenceSummary),
+        });
+    }
+    return sections;
+}
+function buildFooter(input) {
+    var _a;
+    const lines = [];
+    // Failed gates summary
+    if (input.qualityGate && input.qualityGate.failures.length > 0) {
+        lines.push('### Failed Gates');
+        lines.push('');
+        for (const f of input.qualityGate.failures) {
+            lines.push(`- **${f.category}**: expected ≥ ${(0, markdownRenderer_1.pct)(f.expected)}, actual ${(0, markdownRenderer_1.pct)(f.actual)}, gap **${(0, markdownRenderer_1.pct)(f.gap)}**`);
+        }
+        lines.push('');
+    }
+    // Interpretation section
+    if (input.results.length > 0) {
+        const evaluatedMetrics = (0, evaluateMetrics_1.evaluateMetrics)(input.results, (_a = input.thresholds) !== null && _a !== void 0 ? _a : {}, input.qualityGate);
+        lines.push((0, markdownRenderer_1.renderInterpretationSection)(evaluatedMetrics));
+    }
+    // Links
+    if (input.pagesUrl) {
+        lines.push(`📊 **[View Full Report](${input.pagesUrl})**`);
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+function buildJsonSummary(input, sections) {
+    var _a, _b, _c, _d, _e;
+    return {
+        generatedAt: new Date().toISOString(),
+        projectName: input.projectName,
+        branch: input.branch,
+        commitSha: input.commitSha,
+        buildId: input.buildId,
+        overallPassed: (_b = (_a = input.qualityGate) === null || _a === void 0 ? void 0 : _a.passed) !== null && _b !== void 0 ? _b : true,
+        coverage: input.results.map((r) => {
+            var _a, _b;
+            return ({
+                type: r.type,
+                totalItems: r.totalItems,
+                coveredItems: r.coveredItems,
+                coveragePercent: r.coveragePercent,
+                threshold: (_a = input.thresholds) === null || _a === void 0 ? void 0 : _a[r.type],
+                passed: !((_b = input.qualityGate) === null || _b === void 0 ? void 0 : _b.failures.some((f) => f.category === r.type)),
+            });
+        }),
+        failedGates: (_d = (_c = input.qualityGate) === null || _c === void 0 ? void 0 : _c.failures) !== null && _d !== void 0 ? _d : [],
+        sections: sections.map((s) => ({
+            id: s.id,
+            title: s.title,
+            included: s.included,
+            gateEvaluated: s.gateEvaluated,
+            passed: s.passed,
+        })),
+        securityScan: input.securityScan
+            ? {
+                totalFindings: input.securityScan.totalFindings,
+                bySeverity: input.securityScan.bySeverity,
+                scannersRun: input.securityScan.scannersRun,
+                gatePassed: (_e = input.securityScan.gateResult) === null || _e === void 0 ? void 0 : _e.passed,
+            }
+            : undefined,
+        intelligence: input.intelligenceSummary
+            ? {
+                totalFindings: input.intelligenceSummary.totalFindings,
+                totalRecommendations: input.intelligenceSummary.totalRecommendations,
+                maxRiskScore: input.intelligenceSummary.maxRiskScore,
+                avgRiskScore: input.intelligenceSummary.avgRiskScore,
+                criticalUncoveredItems: input.intelligenceSummary.criticalUncoveredItems,
+                unprotectedSecurityFindings: input.intelligenceSummary.unprotectedSecurityFindings,
+                recommendationsByPriority: input.intelligenceSummary.recommendationsByPriority,
+                topRiskAreas: input.intelligenceSummary.topRiskAreas,
+            }
+            : undefined,
+    };
+}
+async function writeOutputFiles(outDir, buildMarkdown, aiMarkdown, json) {
+    var _a;
+    fs.mkdirSync(outDir, { recursive: true });
+    fs.writeFileSync(path.join(outDir, 'build-summary.md'), buildMarkdown, 'utf-8');
+    fs.writeFileSync(path.join(outDir, 'ai-summary.md'), aiMarkdown, 'utf-8');
+    fs.writeFileSync(path.join(outDir, 'summary.json'), JSON.stringify(json, null, 2), 'utf-8');
+    fs.writeFileSync(path.join(outDir, 'ai-summary.json'), JSON.stringify({ aiSummary: aiMarkdown, ...((_a = json) !== null && _a !== void 0 ? _a : {}) }, null, 2), 'utf-8');
+}
+var markdownRenderer_2 = require("./markdownRenderer");
+Object.defineProperty(exports, "renderIntelligenceSection", { enumerable: true, get: function () { return markdownRenderer_2.renderIntelligenceSection; } });

package/dist/src/summary/evaluateMetrics.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Canonical metric evaluation model.
+ *
+ * evaluateMetrics() maps raw CoverageResult[] + thresholds → EvaluatedMetric[]
+ * with well-defined PASS / FAIL / SKIPPED / N/A semantics.
+ *
+ * Status rules (applied in priority order):
+ *  1. !executed                                    → SKIPPED
+ *  2. executed && totalItems === 0                 → N/A  (nothing measurable)
+ *  3. executed && applicable && !gateEvaluated     → N/A  (no threshold set)
+ *  4. executed && gateEvaluated && passes          → PASS
+ *  5. executed && gateEvaluated && fails           → FAIL
+ *
+ * Critical invariant: totalItems === 0 → always N/A, never PASS.
+ */
+import type { CoverageResult } from '../reporting';
+import type { QualityGateResult } from '../qualityGate';
+import { type EvaluatedMetric } from './summaryTypes';
+export { KNOWN_METRIC_TYPES } from './summaryTypes';
+export type { EvaluatedMetric, MetricStatus } from './summaryTypes';
+/**
+ * Evaluate all metrics and return EvaluatedMetric[] in KNOWN_METRIC_TYPES order,
+ * with any additional (plugin) types appended at the end.
+ *
+ * @param results        Coverage results that actually ran.
+ * @param thresholds     Per-type threshold map (may contain undefined values).
+ * @param qualityGate    Quality gate result (may be undefined when no gate ran).
+ * @param knownTypes     Ordered list of expected types (defaults to KNOWN_METRIC_TYPES).
+ */
+export declare function evaluateMetrics(results: CoverageResult[], thresholds: Record<string, number | undefined>, qualityGate: QualityGateResult | undefined, knownTypes?: string[]): EvaluatedMetric[];
+//# sourceMappingURL=evaluateMetrics.d.ts.map

package/dist/src/summary/evaluateMetrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"evaluateMetrics.d.ts","sourceRoot":"","sources":["../../../src/summary/evaluateMetrics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAExD,OAAO,EAAE,KAAK,eAAe,EAAyC,MAAM,gBAAgB,CAAC;AAE7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,YAAY,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAIpE;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC7B,OAAO,EAAE,cAAc,EAAE,EACzB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,EAC9C,WAAW,EAAE,iBAAiB,GAAG,SAAS,EAC1C,UAAU,GAAE,MAAM,EAAuB,GACxC,eAAe,EAAE,CAqBnB"}

package/dist/src/summary/evaluateMetrics.js

@@ -0,0 +1,118 @@
+"use strict";
+/**
+ * Canonical metric evaluation model.
+ *
+ * evaluateMetrics() maps raw CoverageResult[] + thresholds → EvaluatedMetric[]
+ * with well-defined PASS / FAIL / SKIPPED / N/A semantics.
+ *
+ * Status rules (applied in priority order):
+ *  1. !executed                                    → SKIPPED
+ *  2. executed && totalItems === 0                 → N/A  (nothing measurable)
+ *  3. executed && applicable && !gateEvaluated     → N/A  (no threshold set)
+ *  4. executed && gateEvaluated && passes          → PASS
+ *  5. executed && gateEvaluated && fails           → FAIL
+ *
+ * Critical invariant: totalItems === 0 → always N/A, never PASS.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.KNOWN_METRIC_TYPES = void 0;
+exports.evaluateMetrics = evaluateMetrics;
+const markdownRenderer_1 = require("./markdownRenderer");
+const summaryTypes_1 = require("./summaryTypes");
+var summaryTypes_2 = require("./summaryTypes");
+Object.defineProperty(exports, "KNOWN_METRIC_TYPES", { enumerable: true, get: function () { return summaryTypes_2.KNOWN_METRIC_TYPES; } });
+// ─── Public API ───────────────────────────────────────────────────────────────
+/**
+ * Evaluate all metrics and return EvaluatedMetric[] in KNOWN_METRIC_TYPES order,
+ * with any additional (plugin) types appended at the end.
+ *
+ * @param results        Coverage results that actually ran.
+ * @param thresholds     Per-type threshold map (may contain undefined values).
+ * @param qualityGate    Quality gate result (may be undefined when no gate ran).
+ * @param knownTypes     Ordered list of expected types (defaults to KNOWN_METRIC_TYPES).
+ */
+function evaluateMetrics(results, thresholds, qualityGate, knownTypes = summaryTypes_1.KNOWN_METRIC_TYPES) {
+    const resultByType = new Map();
+    for (const r of results) {
+        resultByType.set(r.type, r);
+    }
+    const evaluated = [];
+    // Process known types in canonical order
+    for (const type of knownTypes) {
+        evaluated.push(buildMetric(type, resultByType, thresholds, qualityGate));
+    }
+    // Append any plugin-added types not in knownTypes
+    for (const r of results) {
+        if (!knownTypes.includes(r.type)) {
+            evaluated.push(buildMetric(r.type, resultByType, thresholds, qualityGate));
+        }
+    }
+    return evaluated;
+}
+// ─── Internal helpers ─────────────────────────────────────────────────────────
+function buildMetric(type, resultByType, thresholds, qualityGate) {
+    var _a, _b, _c;
+    const result = resultByType.get(type);
+    const executed = result !== undefined;
+    const totalItems = (_a = result === null || result === void 0 ? void 0 : result.totalItems) !== null && _a !== void 0 ? _a : 0;
+    const coveredItems = (_b = result === null || result === void 0 ? void 0 : result.coveredItems) !== null && _b !== void 0 ? _b : 0;
+    const coveragePercent = (_c = result === null || result === void 0 ? void 0 : result.coveragePercent) !== null && _c !== void 0 ? _c : 0;
+    const applicable = executed && totalItems > 0;
+    const threshold = thresholds[type];
+    const gateEvaluated = threshold !== undefined;
+    const { status, reason } = computeStatus({
+        executed,
+        applicable,
+        totalItems,
+        coveragePercent,
+        threshold,
+        gateEvaluated,
+        qualityGate,
+        type,
+    });
+    const topGaps = result && applicable
+        ? (0, markdownRenderer_1.extractGaps)(result, 5)
+        : [];
+    return {
+        category: type,
+        executed,
+        applicable,
+        totalItems,
+        coveredItems,
+        coveragePercent,
+        threshold,
+        gateEvaluated,
+        status,
+        reason,
+        topGaps,
+    };
+}
+function computeStatus(opts) {
+    var _a;
+    const { executed, applicable, totalItems, coveragePercent, threshold, gateEvaluated, qualityGate, type } = opts;
+    if (!executed) {
+        return { status: 'SKIPPED', reason: 'Analyzer did not run for this type' };
+    }
+    if (totalItems === 0) {
+        return { status: 'N/A', reason: 'No items found to measure' };
+    }
+    if (!gateEvaluated) {
+        return { status: 'N/A', reason: 'No threshold configured — gate not evaluated' };
+    }
+    if (!applicable) {
+        // Should not reach here given totalItems > 0 implies applicable, but guard anyway
+        return { status: 'N/A', reason: 'Not applicable' };
+    }
+    const gateFailed = (_a = qualityGate === null || qualityGate === void 0 ? void 0 : qualityGate.failures.some((f) => f.category === type)) !== null && _a !== void 0 ? _a : false;
+    if (gateFailed) {
+        const gap = threshold - coveragePercent;
+        return {
+            status: 'FAIL',
+            reason: `Coverage ${coveragePercent.toFixed(2)}% is below threshold ${threshold.toFixed(2)}% (gap: ${gap.toFixed(2)}%)`,
+        };
+    }
+    return {
+        status: 'PASS',
+        reason: `Coverage ${coveragePercent.toFixed(2)}% meets threshold ${threshold.toFixed(2)}%`,
+    };
+}

package/dist/src/summary/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Summary engine – public entry point.
+ *
+ * Re-exports the full public API for the built-in summary engine.
+ */
+export { generateBuildSummary } from './buildSummary';
+export { generatePrSummary } from './prSummary';
+export type { SummaryInput, SummaryResult, SummarySection, SummaryConfig, } from './markdownRenderer';
+export { coverageTypeTitle, renderCoverageSection, renderSecurityScanSection, renderAiSummary, renderIntelligenceSection, statusBadge, pct, tableRow, extractGaps, } from './markdownRenderer';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/summary/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/summary/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAChD,YAAY,EACV,YAAY,EACZ,aAAa,EACb,cAAc,EACd,aAAa,GACd,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EACL,iBAAiB,EACjB,qBAAqB,EACrB,yBAAyB,EACzB,eAAe,EACf,yBAAyB,EACzB,WAAW,EACX,GAAG,EACH,QAAQ,EACR,WAAW,GACZ,MAAM,oBAAoB,CAAC"}

package/dist/src/summary/index.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * Summary engine – public entry point.
+ *
+ * Re-exports the full public API for the built-in summary engine.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractGaps = exports.tableRow = exports.pct = exports.statusBadge = exports.renderIntelligenceSection = exports.renderAiSummary = exports.renderSecurityScanSection = exports.renderCoverageSection = exports.coverageTypeTitle = exports.generatePrSummary = exports.generateBuildSummary = void 0;
+var buildSummary_1 = require("./buildSummary");
+Object.defineProperty(exports, "generateBuildSummary", { enumerable: true, get: function () { return buildSummary_1.generateBuildSummary; } });
+var prSummary_1 = require("./prSummary");
+Object.defineProperty(exports, "generatePrSummary", { enumerable: true, get: function () { return prSummary_1.generatePrSummary; } });
+var markdownRenderer_1 = require("./markdownRenderer");
+Object.defineProperty(exports, "coverageTypeTitle", { enumerable: true, get: function () { return markdownRenderer_1.coverageTypeTitle; } });
+Object.defineProperty(exports, "renderCoverageSection", { enumerable: true, get: function () { return markdownRenderer_1.renderCoverageSection; } });
+Object.defineProperty(exports, "renderSecurityScanSection", { enumerable: true, get: function () { return markdownRenderer_1.renderSecurityScanSection; } });
+Object.defineProperty(exports, "renderAiSummary", { enumerable: true, get: function () { return markdownRenderer_1.renderAiSummary; } });
+Object.defineProperty(exports, "renderIntelligenceSection", { enumerable: true, get: function () { return markdownRenderer_1.renderIntelligenceSection; } });
+Object.defineProperty(exports, "statusBadge", { enumerable: true, get: function () { return markdownRenderer_1.statusBadge; } });
+Object.defineProperty(exports, "pct", { enumerable: true, get: function () { return markdownRenderer_1.pct; } });
+Object.defineProperty(exports, "tableRow", { enumerable: true, get: function () { return markdownRenderer_1.tableRow; } });
+Object.defineProperty(exports, "extractGaps", { enumerable: true, get: function () { return markdownRenderer_1.extractGaps; } });

package/dist/src/summary/markdownRenderer.d.ts

@@ -0,0 +1,139 @@
+/**
+ * Summary engine – low-level markdown rendering utilities and shared types.
+ *
+ * This module owns the SummaryResult type and the building blocks used by
+ * both generateBuildSummary and generatePrSummary.
+ */
+import type { CoverageResult } from '../reporting';
+import type { QualityGateResult } from '../qualityGate';
+import type { SecurityScanSummary, ScannerResult } from '../security/types';
+import type { EvaluatedMetric, MetricStatus } from './summaryTypes';
+/** A single rendered section inside a summary */
+export interface SummarySection {
+    /** Stable machine-readable identifier (e.g. "endpoint", "security-scan") */
+    id: string;
+    /** Human-readable title shown as a Markdown heading */
+    title: string;
+    /** Whether this section was included in the final output */
+    included: boolean;
+    /** Whether a quality gate was configured and evaluated for this section */
+    gateEvaluated: boolean;
+    /** Gate pass/fail result – only present when gateEvaluated is true */
+    passed?: boolean;
+    /** The complete Markdown content for this section */
+    markdown: string;
+}
+/**
+ * The result returned by generateBuildSummary and generatePrSummary.
+ *
+ * markdown  – The full rendered Markdown document.
+ * sections  – Per-section metadata (used for gate-aware inclusion checking).
+ * json      – Machine-readable representation of the same data.
+ */
+export interface SummaryResult {
+    markdown: string;
+    sections: SummarySection[];
+    json: unknown;
+}
+/** Input accepted by the summary generators */
+export interface SummaryInput {
+    /** Coverage results from all analysis passes that actually ran */
+    results: CoverageResult[];
+    /** Quality gate evaluation output */
+    qualityGate?: QualityGateResult;
+    /** Security scan summary (if the security-scan command ran) */
+    securityScan?: SecurityScanSummary;
+    /** Individual scanner results (needed for per-scanner detail) */
+    scannerResults?: ScannerResult[];
+    /** Configured thresholds per category */
+    thresholds?: Record<string, number | undefined>;
+    /** Summary module configuration */
+    summaryConfig?: SummaryConfig;
+    /** Project name shown in the header */
+    projectName?: string;
+    /** Branch name */
+    branch?: string;
+    /** Commit SHA */
+    commitSha?: string;
+    /** Build identifier */
+    buildId?: string;
+    /** Full URL to the published Pages / HTML report */
+    pagesUrl?: string;
+    /** Coverage Intelligence summary (if the intelligence engine ran) */
+    intelligenceSummary?: {
+        totalFindings: number;
+        totalRecommendations: number;
+        maxRiskScore: number;
+        avgRiskScore: number;
+        criticalUncoveredItems: number;
+        unprotectedSecurityFindings: number;
+        recommendationsByPriority: Record<string, number>;
+        topRiskAreas: string[];
+    };
+}
+/** Summary module configuration block (mirrors coverage.config.json "summary" key) */
+export interface SummaryConfig {
+    enabled?: boolean;
+    generatePrSummary?: boolean;
+    generateBuildSummary?: boolean;
+    generateAiSummary?: boolean;
+    includeOnlyEvaluatedSections?: boolean;
+    publishPrComment?: boolean;
+    publishGithubStepSummary?: boolean;
+    publishJenkinsSummary?: boolean;
+}
+/**
+ * Map a coverage-type string to a human-readable title.
+ */
+export declare function coverageTypeTitle(type: string): string;
+/**
+ * Render a two-column Markdown table row.
+ */
+export declare function tableRow(label: string, value: string): string;
+/**
+ * Render a status badge string.
+ * "PASS" or "FAIL" – explicit wording, no ambiguous icons.
+ */
+export declare function statusBadge(passed: boolean): string;
+/**
+ * Render the coverage percentage with two decimal places.
+ */
+export declare function pct(value: number): string;
+/**
+ * Render the gap list items from a CoverageResult's details field.
+ * Returns up to `limit` bullet items.
+ */
+export declare function extractGaps(result: CoverageResult, limit?: number): string[];
+/**
+ * Render a full coverage section in the structured Markdown format required by
+ * the problem spec (§2).
+ *
+ * @param result       Coverage result for this category.
+ * @param threshold    Configured threshold for this category (may be undefined).
+ * @param gateFailure  Whether the gate failed for this category.
+ */
+export declare function renderCoverageSection(result: CoverageResult, threshold: number | undefined, gateFailure: boolean): string;
+/**
+ * Render the security scanning section.
+ */
+export declare function renderSecurityScanSection(securityScan: SecurityScanSummary, scannerResults: ScannerResult[], gateEvaluated: boolean, gatePassed: boolean | undefined): string;
+/**
+ * Render the status cell for a metric row in the coverage summary table.
+ * These are the only four valid statuses — ⚠️ PASS does not exist.
+ */
+export declare function metricStatusCell(status: MetricStatus): string;
+/**
+ * Render the "Summary Interpretation" section that explains what each metric
+ * status means in plain language.  Suitable for AI agents and humans alike.
+ */
+export declare function renderInterpretationSection(metrics: EvaluatedMetric[]): string;
+/**
+ * Render the AI-friendly summary markdown.
+ * Optimized for consumption by AI agents (test generators, fixers, etc.)
+ */
+export declare function renderAiSummary(input: SummaryInput, sections: SummarySection[]): string;
+/**
+ * Render a Coverage Intelligence section for inclusion in build/PR summaries.
+ */
+export declare function renderIntelligenceSection(intel: NonNullable<SummaryInput['intelligenceSummary']>): string;
+//# sourceMappingURL=markdownRenderer.d.ts.map

package/dist/src/summary/markdownRenderer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownRenderer.d.ts","sourceRoot":"","sources":["../../../src/summary/markdownRenderer.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAIpE,iDAAiD;AACjD,MAAM,WAAW,cAAc;IAC7B,4EAA4E;IAC5E,EAAE,EAAE,MAAM,CAAC;IACX,uDAAuD;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,QAAQ,EAAE,OAAO,CAAC;IAClB,2EAA2E;IAC3E,aAAa,EAAE,OAAO,CAAC;IACvB,sEAAsE;IACtE,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC;CACf;AAED,+CAA+C;AAC/C,MAAM,WAAW,YAAY;IAC3B,kEAAkE;IAClE,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,qCAAqC;IACrC,WAAW,CAAC,EAAE,iBAAiB,CAAC;IAChC,+DAA+D;IAC/D,YAAY,CAAC,EAAE,mBAAmB,CAAC;IACnC,iEAAiE;IACjE,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC,yCAAyC;IACzC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAChD,mCAAmC;IACnC,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,uCAAuC;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qEAAqE;IACrE,mBAAmB,CAAC,EAAE;QACpB,aAAa,EAAE,MAAM,CAAC;QACtB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,YAAY,EAAE,MAAM,CAAC;QACrB,YAAY,EAAE,MAAM,CAAC;QACrB,sBAAsB,EAAE,MAAM,CAAC;QAC/B,2BAA2B,EAAE,MAAM,CAAC;QACpC,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,YAAY,EAAE,MAAM,EAAE,CAAC;KACxB,CAAC;CACH;AAED,sFAAsF;AACtF,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,4BAA4B,CAAC,EAAE,OAAO,CAAC;IACvC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC;AAID;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAatD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAEnD;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEzC;AAED;;;GAGG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,SAAK,GAAG,MAAM,EAAE,CAgDxE;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACnC,MAAM,EAAE,cAAc,EACtB,SAAS,EAAE,MAAM,GAAG,SAAS,EAC7B,WAAW,EAAE,OAAO,GACnB,MAAM,CA2DR;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,YAAY,EAAE,mBAAmB,EACjC,cAAc,EAAE,aAAa,EAAE,EAC/B,aAAa,EAAE,OAAO,EACtB,UAAU,EAAE,OAAO,GAAG,SAAS,GAC9B,MAAM,CAuDR;AAiBD;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAO7D;AAED;;;GAGG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,eAAe,EAAE,GAAG,MAAM,CA6D9E;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,MAAM,CAuGvF;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,WAAW,CAAC,YAAY,CAAC,qBAAqB,CAAC,CAAC,GACtD,MAAM,CA8CR"}