@imolko/create-ultra-reporter 2.1.23-beta

package/bin/pipeline/generate.js

@@ -0,0 +1,269 @@
+"use strict";
+// ---------------------------------------------------------------------------
+// Shared generation pipeline
+//
+// Orchestrates the full documentation generation:
+//   1. Track artifacts → artifacts.json
+//   2. JSDoc extraction → jsdoc-report.txt
+//   3. CTRF conversion → test-results.json
+//   4. Domain reporter → generated .md
+//   5. Use-cases reporter → generated .md
+//
+// All output goes to .ultra-reporter/generated-docs/ and .ultra-reporter/cache/.
+// Used by serve, generate, and build commands.
+// ---------------------------------------------------------------------------
+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;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.derivePipelinePaths = derivePipelinePaths;
+exports.generateAllDocs = generateAllDocs;
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const path_1 = require("path");
+const utils_1 = require("../utils");
+const delete_paths_1 = require("../scripts/delete-paths");
+const run_command_1 = require("../utils/run-command");
+const converter_1 = require("../scripts/converter");
+const generate_domain_documentation_1 = require("../reporters/generate-domain-documentation");
+const generate_use_cases_documentation_1 = require("../reporters/generate-use-cases-documentation");
+const reader_1 = require("../config/reader");
+const logger_1 = __importDefault(require("../classes/logger"));
+const pipeLogger = logger_1.default.createContextLogger('pipeline:generate');
+/**
+ * Derives pipeline paths from the config file location.
+ */
+function derivePipelinePaths(configDir) {
+    const ultraReporterRoot = path.resolve(configDir, '.ultra-reporter');
+    const cacheDir = path.resolve(ultraReporterRoot, 'cache');
+    const generatedDocsDir = path.resolve(ultraReporterRoot, 'generated-docs');
+    const configPath = path.resolve(configDir, 'ultra-reporter.config.json');
+    const packageRootName = path.basename(configDir).replace(/[^a-zA-Z0-9]+/g, '-') || 'project';
+    return {
+        ultraReporterRoot,
+        cacheDir,
+        generatedDocsDir,
+        configPath,
+        packageRootName,
+    };
+}
+/**
+ * Generates all documentation for the project.
+ *
+ * @param configDir - Directory containing ultra-reporter.config.json
+ * @param cmdRoot - Path to the bin/ directory (for locating internal scripts)
+ */
+async function generateAllDocs(configDir, cmdRoot) {
+    const config = (0, reader_1.readConfig)(configDir);
+    const paths = derivePipelinePaths(configDir);
+    // Ensure output directories exist
+    await (0, utils_1.createFolder)(paths.ultraReporterRoot);
+    await (0, utils_1.createFolder)(paths.cacheDir);
+    // Clean generated docs on each run
+    await (0, delete_paths_1.deletePaths)([paths.generatedDocsDir]);
+    await (0, utils_1.createFolder)(paths.generatedDocsDir);
+    // ---- Domain target ----
+    await generateDomainTarget(config, paths, configDir, cmdRoot);
+    // ---- Use-cases target ----
+    if (config.useCases) {
+        await generateUseCasesTarget(config, paths, configDir, cmdRoot);
+    }
+}
+// ---------------------------------------------------------------------------
+// Domain target generation
+// ---------------------------------------------------------------------------
+async function generateDomainTarget(config, paths, cwd, cmdRoot) {
+    const domain = config.domain;
+    const domainSrc = domain.srcPath;
+    const packageRootName = paths.packageRootName;
+    const artifactsFolderPath = (0, path_1.resolve)(cwd, domainSrc);
+    // 1. Track artifacts → artifacts.json
+    const trackArtifactsScriptPath = (0, path_1.resolve)(cmdRoot, 'scripts/track-artifacts.js');
+    const artifactsJsonPath = (0, path_1.resolve)(paths.cacheDir, 'artifacts.json');
+    if ((0, utils_1.existsFile)(trackArtifactsScriptPath)) {
+        await (0, run_command_1.runCommand)(`node ${trackArtifactsScriptPath} ${artifactsFolderPath} ${artifactsJsonPath} ${domain.name}`);
+    }
+    else {
+        pipeLogger.warn('track-artifacts script not found, skipping artifact discovery');
+    }
+    // 2. JSDoc extraction
+    const jsdocOutputFile = (0, path_1.resolve)(paths.cacheDir, 'jsdoc-report.txt');
+    const internalJsdocConfigPath = (0, path_1.resolve)(cmdRoot, '../../jsdoc.conf.json');
+    const packageRootPath = (0, path_1.resolve)(cwd, findPackageRoot(cwd, domainSrc));
+    if ((0, utils_1.existsFile)(internalJsdocConfigPath)) {
+        const jsonFile = await (0, utils_1.getJSONFile)(internalJsdocConfigPath);
+        const includePath = (0, path_1.resolve)(cwd, domainSrc);
+        jsonFile.source.include = [includePath];
+        const jsdocConfigPath = (0, path_1.resolve)(paths.cacheDir, 'jsdoc.conf.json');
+        fs.writeFileSync(jsdocConfigPath, JSON.stringify(jsonFile, null, 2));
+        try {
+            await (0, run_command_1.runCommand)(`./node_modules/.bin/jsdoc --explain -c ${jsdocConfigPath} > ${jsdocOutputFile}`);
+        }
+        catch {
+            pipeLogger.warn('JSDoc extraction failed, continuing without JSDoc data');
+        }
+        // Clean up temp config
+        fs.unlinkSync(jsdocConfigPath);
+    }
+    // 3. CTRF conversion → test-results.json
+    if (domain.testResultsPath) {
+        const testResultsPath = (0, path_1.resolve)(cwd, domain.testResultsPath);
+        const ctrfFile = (0, path_1.resolve)(paths.cacheDir, 'ctrf-test-results.json');
+        if ((0, utils_1.existsFile)(testResultsPath)) {
+            const testResults = await (0, utils_1.getJSONFile)(testResultsPath);
+            fs.writeFileSync(ctrfFile, JSON.stringify(testResults, null, 2));
+            const newTestResultsFile = (0, path_1.resolve)(paths.cacheDir, 'test-results.json');
+            (0, converter_1.convertTestJsonFormat)(ctrfFile, newTestResultsFile);
+        }
+        else {
+            pipeLogger.warn(`Test results file not found: ${testResultsPath}. Generating docs without test data.`);
+            writeEmptyTestResults((0, path_1.resolve)(paths.cacheDir, 'test-results.json'));
+        }
+    }
+    else {
+        writeEmptyTestResults((0, path_1.resolve)(paths.cacheDir, 'test-results.json'));
+    }
+    // 4. Generate domain documentation
+    const domainTabName = 'domain';
+    const aggregateTabName = 'aggregates';
+    await (0, generate_domain_documentation_1.generateDomainDocumentation)({
+        packageRootName,
+        contextName: domain.name,
+        documentationPath: paths.ultraReporterRoot,
+        domainPath: domainSrc,
+        domainTabName,
+        aggregateTabName,
+        templateDir: (0, path_1.resolve)(cmdRoot, '../reporters/templates'),
+        repoSourceUrl: config.repoSourceUrl,
+    });
+}
+// ---------------------------------------------------------------------------
+// Use-cases target generation
+// ---------------------------------------------------------------------------
+async function generateUseCasesTarget(config, paths, cwd, cmdRoot) {
+    if (!config.useCases)
+        return;
+    const useCases = config.useCases;
+    const useCasesSrc = useCases.srcPath;
+    const packageRootName = paths.packageRootName;
+    // 1. JSDoc extraction
+    const jsdocOutputFile = (0, path_1.resolve)(paths.cacheDir, 'jsdoc-report-uc.txt');
+    const internalJsdocConfigPath = (0, path_1.resolve)(cmdRoot, '../../jsdoc.conf.json');
+    if ((0, utils_1.existsFile)(internalJsdocConfigPath)) {
+        const jsonFile = await (0, utils_1.getJSONFile)(internalJsdocConfigPath);
+        const includePath = (0, path_1.resolve)(cwd, useCasesSrc);
+        jsonFile.source.include = [includePath];
+        const jsdocConfigPath = (0, path_1.resolve)(paths.cacheDir, 'jsdoc-uc.conf.json');
+        fs.writeFileSync(jsdocConfigPath, JSON.stringify(jsonFile, null, 2));
+        try {
+            await (0, run_command_1.runCommand)(`./node_modules/.bin/jsdoc --explain -c ${jsdocConfigPath} > ${jsdocOutputFile}`);
+        }
+        catch {
+            pipeLogger.warn('JSDoc extraction failed for use-cases, continuing without JSDoc data');
+        }
+        fs.unlinkSync(jsdocConfigPath);
+    }
+    // 2. CTRF conversion
+    if (useCases.testResultsPath) {
+        const testResultsPath = (0, path_1.resolve)(cwd, useCases.testResultsPath);
+        const ctrfFile = (0, path_1.resolve)(paths.cacheDir, 'ctrf-test-results-uc.json');
+        if ((0, utils_1.existsFile)(testResultsPath)) {
+            const testResults = await (0, utils_1.getJSONFile)(testResultsPath);
+            fs.writeFileSync(ctrfFile, JSON.stringify(testResults, null, 2));
+            const newTestResultsFile = (0, path_1.resolve)(paths.cacheDir, 'test-results-uc.json');
+            (0, converter_1.convertTestJsonFormat)(ctrfFile, newTestResultsFile);
+        }
+        else {
+            writeEmptyTestResults((0, path_1.resolve)(paths.cacheDir, 'test-results-uc.json'));
+        }
+    }
+    else {
+        writeEmptyTestResults((0, path_1.resolve)(paths.cacheDir, 'test-results-uc.json'));
+    }
+    // 3. Generate use-cases documentation
+    const useCasesTabName = 'use-cases';
+    await (0, generate_use_cases_documentation_1.generateUseCasesDocumentation)({
+        packageRootName,
+        title: useCases.title,
+        documentationPath: paths.ultraReporterRoot,
+        useCasesPath: useCasesSrc,
+        useCasesTabName,
+        templateDir: (0, path_1.resolve)(cmdRoot, '../reporters/templates'),
+        cwd,
+        repoSourceUrl: config.repoSourceUrl,
+    });
+}
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+/**
+ * Finds the package root for a source path by walking up to find package.json.
+ */
+function findPackageRoot(cwd, srcPath) {
+    let currentDir = (0, path_1.resolve)(cwd, srcPath);
+    // eslint-disable-next-line no-constant-condition
+    while (true) {
+        if (fs.existsSync(path.join(currentDir, 'package.json'))) {
+            return currentDir;
+        }
+        const parentDir = path.dirname(currentDir);
+        if (parentDir === currentDir)
+            break;
+        currentDir = parentDir;
+    }
+    return cwd; // Fallback to cwd
+}
+/** Writes an empty test results file to prevent errors downstream. */
+function writeEmptyTestResults(filePath) {
+    const empty = {
+        numFailedTestSuites: 0,
+        numFailedTests: 0,
+        numPassedTestSuites: 0,
+        numPassedTests: 0,
+        numPendingTestSuites: 0,
+        numPendingTests: 0,
+        numRuntimeErrorTestSuites: 0,
+        numTodoTests: 0,
+        numTotalTestSuites: 0,
+        numTotalTests: 0,
+        startTime: 0,
+        success: true,
+        testResults: [],
+    };
+    fs.mkdirSync(path.dirname(filePath), { recursive: true });
+    fs.writeFileSync(filePath, JSON.stringify(empty, null, 2));
+}
+//# sourceMappingURL=generate.js.map

package/bin/pipeline/generate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/pipeline/generate.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,6BAA6B;AAC7B,EAAE;AACF,kDAAkD;AAClD,wCAAwC;AACxC,2CAA2C;AAC3C,2CAA2C;AAC3C,uCAAuC;AACvC,0CAA0C;AAC1C,EAAE;AACF,iFAAiF;AACjF,+CAA+C;AAC/C,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAoC9E,kDAcC;AAQD,0CAsBC;AA9ED,2CAA6B;AAC7B,uCAAyB;AACzB,+BAA+B;AAC/B,oCAAiE;AACjE,0DAAsD;AACtD,sDAAkD;AAClD,oDAA6D;AAC7D,8FAAyF;AACzF,oGAA8F;AAC9F,6CAA8C;AAE9C,+DAAuC;AAEvC,MAAM,UAAU,GAAG,gBAAM,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,CAAC;AAkBnE;;GAEG;AACH,SAAgB,mBAAmB,CAAC,SAAiB;IACnD,MAAM,iBAAiB,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC;IACrE,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;IAC1D,MAAM,gBAAgB,GAAG,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;IACzE,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC,IAAI,SAAS,CAAC;IAE7F,OAAO;QACL,iBAAiB;QACjB,QAAQ;QACR,gBAAgB;QAChB,UAAU;QACV,eAAe;KAChB,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACI,KAAK,UAAU,eAAe,CACnC,SAAiB,EACjB,OAAe;IAEf,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,SAAS,CAAC,CAAC;IACrC,MAAM,KAAK,GAAG,mBAAmB,CAAC,SAAS,CAAC,CAAC;IAE7C,kCAAkC;IAClC,MAAM,IAAA,oBAAY,EAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAC5C,MAAM,IAAA,oBAAY,EAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAEnC,mCAAmC;IACnC,MAAM,IAAA,0BAAW,EAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAC5C,MAAM,IAAA,oBAAY,EAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAE3C,0BAA0B;IAC1B,MAAM,oBAAoB,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAE9D,6BAA6B;IAC7B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,sBAAsB,CAAC,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,2BAA2B;AAC3B,8EAA8E;AAE9E,KAAK,UAAU,oBAAoB,CACjC,MAA2B,EAC3B,KAAoB,EACpB,GAAW,EACX,OAAe;IAEf,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC7B,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC;IACjC,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IAE9C,MAAM,mBAAmB,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC;IAEpD,sCAAsC;IACtC,MAAM,wBAAwB,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,4BAA4B,CAAC,CAAC;IAChF,MAAM,iBAAiB,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;IAEpE,IAAI,IAAA,kBAAU,EAAC,wBAAwB,CAAC,EAAE,CAAC;QACzC,MAAM,IAAA,wBAAU,EACd,QAAQ,wBAAwB,IAAI,mBAAmB,IAAI,iBAAiB,IAAI,MAAM,CAAC,IAAI,EAAE,CAC9F,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,UAAU,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;IAED,sBAAsB;IACtB,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;IACpE,MAAM,uBAAuB,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IAC1E,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,eAAe,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC,CAAC;IAEtE,IAAI,IAAA,kBAAU,EAAC,uBAAuB,CAAC,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAW,EAAC,uBAAuB,CAA4B,CAAC;QACvF,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QAC3C,QAAQ,CAAC,MAAkC,CAAC,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QAErE,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;QACnE,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAErE,IAAI,CAAC;YACH,MAAM,IAAA,wBAAU,EACd,0CAA0C,eAAe,MAAM,eAAe,EAAE,CACjF,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,UAAU,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;QAC5E,CAAC;QAED,uBAAuB;QACvB,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACjC,CAAC;IAED,yCAAyC;IACzC,IAAI,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3B,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,MAAM,CAAC,eAAe,CAAC,CAAC;QAC7D,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,wBAAwB,CAAC,CAAC;QAEnE,IAAI,IAAA,kBAAU,EAAC,eAAe,CAAC,EAAE,CAAC;YAChC,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAW,EAAC,eAAe,CAAC,CAAC;YACvD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACjE,MAAM,kBAAkB,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC;YACxE,IAAA,iCAAqB,EAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,UAAU,CAAC,IAAI,CACb,gCAAgC,eAAe,sCAAsC,CACtF,CAAC;YACF,qBAAqB,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC;QACtE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,qBAAqB,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IAED,mCAAmC;IACnC,MAAM,aAAa,GAAG,QAAQ,CAAC;IAC/B,MAAM,gBAAgB,GAAG,YAAY,CAAC;IAEtC,MAAM,IAAA,2DAA2B,EAAC;QAChC,eAAe;QACf,WAAW,EAAE,MAAM,CAAC,IAAI;QACxB,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;QAC1C,UAAU,EAAE,SAAS;QACrB,aAAa;QACb,gBAAgB;QAChB,WAAW,EAAE,IAAA,cAAO,EAAC,OAAO,EAAE,wBAAwB,CAAC;QACvD,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;AACL,CAAC;AAED,8EAA8E;AAC9E,8BAA8B;AAC9B,8EAA8E;AAE9E,KAAK,UAAU,sBAAsB,CACnC,MAA2B,EAC3B,KAAoB,EACpB,GAAW,EACX,OAAe;IAEf,IAAI,CAAC,MAAM,CAAC,QAAQ;QAAE,OAAO;IAE7B,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAC;IACjC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC;IACrC,MAAM,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC;IAE9C,sBAAsB;IACtB,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,qBAAqB,CAAC,CAAC;IACvE,MAAM,uBAAuB,GAAG,IAAA,cAAO,EAAC,OAAO,EAAE,uBAAuB,CAAC,CAAC;IAE1E,IAAI,IAAA,kBAAU,EAAC,uBAAuB,CAAC,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,MAAM,IAAA,mBAAW,EAAC,uBAAuB,CAA4B,CAAC;QACvF,MAAM,WAAW,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,WAAW,CAAC,CAAC;QAC7C,QAAQ,CAAC,MAAkC,CAAC,OAAO,GAAG,CAAC,WAAW,CAAC,CAAC;QAErE,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,oBAAoB,CAAC,CAAC;QACtE,EAAE,CAAC,aAAa,CAAC,eAAe,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;QAErE,IAAI,CAAC;YACH,MAAM,IAAA,wBAAU,EACd,0CAA0C,eAAe,MAAM,eAAe,EAAE,CACjF,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACP,UAAU,CAAC,IAAI,CAAC,sEAAsE,CAAC,CAAC;QAC1F,CAAC;QAED,EAAE,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACjC,CAAC;IAED,qBAAqB;IACrB,IAAI,QAAQ,CAAC,eAAe,EAAE,CAAC;QAC7B,MAAM,eAAe,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,QAAQ,CAAC,eAAe,CAAC,CAAC;QAC/D,MAAM,QAAQ,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,2BAA2B,CAAC,CAAC;QAEtE,IAAI,IAAA,kBAAU,EAAC,eAAe,CAAC,EAAE,CAAC;YAChC,MAAM,WAAW,GAAG,MAAM,IAAA,mBAAW,EAAC,eAAe,CAAC,CAAC;YACvD,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACjE,MAAM,kBAAkB,GAAG,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC;YAC3E,IAAA,iCAAqB,EAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QACtD,CAAC;aAAM,CAAC;YACN,qBAAqB,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC;QACzE,CAAC;IACH,CAAC;SAAM,CAAC;QACN,qBAAqB,CAAC,IAAA,cAAO,EAAC,KAAK,CAAC,QAAQ,EAAE,sBAAsB,CAAC,CAAC,CAAC;IACzE,CAAC;IAED,sCAAsC;IACtC,MAAM,eAAe,GAAG,WAAW,CAAC;IAEpC,MAAM,IAAA,gEAA6B,EAAC;QAClC,eAAe;QACf,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,iBAAiB,EAAE,KAAK,CAAC,iBAAiB;QAC1C,YAAY,EAAE,WAAW;QACzB,eAAe;QACf,WAAW,EAAE,IAAA,cAAO,EAAC,OAAO,EAAE,wBAAwB,CAAC;QACvD,GAAG;QACH,aAAa,EAAE,MAAM,CAAC,aAAa;KACpC,CAAC,CAAC;AACL,CAAC;AAED,8EAA8E;AAC9E,UAAU;AACV,8EAA8E;AAE9E;;GAEG;AACH,SAAS,eAAe,CAAC,GAAW,EAAE,OAAe;IACnD,IAAI,UAAU,GAAG,IAAA,cAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAEvC,iDAAiD;IACjD,OAAO,IAAI,EAAE,CAAC;QACZ,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC;YACzD,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC3C,IAAI,SAAS,KAAK,UAAU;YAAE,MAAM;QACpC,UAAU,GAAG,SAAS,CAAC;IACzB,CAAC;IAED,OAAO,GAAG,CAAC,CAAC,kBAAkB;AAChC,CAAC;AAED,sEAAsE;AACtE,SAAS,qBAAqB,CAAC,QAAgB;IAC7C,MAAM,KAAK,GAAG;QACZ,mBAAmB,EAAE,CAAC;QACtB,cAAc,EAAE,CAAC;QACjB,mBAAmB,EAAE,CAAC;QACtB,cAAc,EAAE,CAAC;QACjB,oBAAoB,EAAE,CAAC;QACvB,eAAe,EAAE,CAAC;QAClB,yBAAyB,EAAE,CAAC;QAC5B,YAAY,EAAE,CAAC;QACf,kBAAkB,EAAE,CAAC;QACrB,aAAa,EAAE,CAAC;QAChB,SAAS,EAAE,CAAC;QACZ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,EAAE;KAChB,CAAC;IACF,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1D,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC7D,CAAC"}

package/bin/reporters/data-loading.d.ts

@@ -0,0 +1,121 @@
+import type { ArtifactRaw, DefinitionData, JsdocElem, Templates, TestFile } from './types';
+/**
+ * Reads and parses an artifacts.json file.
+ */
+export declare function loadArtifacts(pathStr: string): Promise<ArtifactRaw[]>;
+/**
+ * Reads all required template files from the given directory.
+ * Returns a Templates object with each template as a string.
+ */
+export declare function loadTemplates(templateDir: string): Promise<Templates>;
+/**
+ * Reads and parses an artifact's definition.yaml file.
+ * Returns {} if the file doesn't exist, is empty, or contains invalid YAML.
+ */
+export declare function loadYamlDefinition(name: string, basePath: string, cwd: string): Promise<DefinitionData>;
+/**
+ * Reads an artifact's attachments.md file.
+ * Returns empty string if the file doesn't exist or is empty.
+ */
+export declare function loadAttachments(name: string, basePath: string, cwd: string): Promise<string>;
+/**
+ * Reads a jsdoc-to-json output file, strips progress lines, and parses the JSON.
+ */
+export declare function loadJsdocReport(pathStr: string): Promise<JsdocElem[]>;
+/**
+ * Reads a jest test-results.json file and extracts the testResults array.
+ */
+export declare function loadTestResults(pathStr: string): Promise<TestFile[]>;
+/**
+ * Removes "Parsing ..." and "Finished running in..." progress lines from
+ * jsdoc-to-json raw output, leaving only valid JSON.
+ */
+export declare function cleanJsdocOutput(raw: string): string;
+/**
+ * Lists folder names inside a use-cases directory.
+ * Returns an empty array if the directory does not exist or is empty.
+ */
+export declare function loadUseCaseFolders(basePath: string): Promise<string[]>;
+/**
+ * Reads and parses a use-case's definition.yaml file.
+ * Returns {} if the file doesn't exist, is empty, or contains invalid YAML.
+ */
+export declare function loadUseCaseDefinition(useCaseDirPath: string): Promise<DefinitionData>;
+/**
+ * Reads a use-case's attachments.md file.
+ * Returns empty string if the file doesn't exist or is empty.
+ */
+export declare function loadUseCaseAttachments(useCaseDirPath: string): Promise<string>;
+/** Return type for {@link parseMarkdownFrontmatter}. */
+export interface ParsedMarkdown {
+    /** Merged frontmatter fields (same shape as DefinitionData). */
+    frontmatter: DefinitionData;
+    /** The markdown body content with frontmatter block removed. */
+    body: string;
+}
+/**
+ * Parses YAML frontmatter from a markdown string.
+ *
+ * Frontmatter is a YAML block delimited by `---` at the very start of the
+ * file. Only the first `---...---` block is treated as frontmatter;
+ * subsequent `---` lines in the body are left as literal content.
+ *
+ * If there is no opening `---` on line 1, or the YAML is invalid, the
+ * entire content is returned as `body` with an empty `frontmatter`.
+ *
+ * @param rawContent - The raw markdown file content as a string.
+ * @returns Parsed frontmatter and body.
+ */
+export declare function parseMarkdownFrontmatter(rawContent: string): ParsedMarkdown;
+/** Return type for {@link loadMarkdownFilesFromFolder}. */
+export interface MergedMarkdown {
+    /** Frontmatter merged across all .md files (first alphabetical wins per key). */
+    mergedFrontmatter: DefinitionData;
+    /** Bodies of all non-empty .md files concatenated in alphabetical order. */
+    concatenatedBodies: string;
+}
+/**
+ * Scans a folder for all `.md` files, extracts frontmatter from each, and
+ * merges the results into a single frontmatter object (first file
+ * alphabetically wins on key conflicts) and a concatenated body string.
+ *
+ * Files with an empty body (after stripping frontmatter) are excluded from
+ * the concatenated body but their frontmatter is still merged.
+ *
+ * @param folderPath - Absolute path to the folder to scan.
+ * @returns Merged frontmatter and concatenated bodies.
+ */
+export declare function loadMarkdownFilesFromFolder(folderPath: string): Promise<MergedMarkdown>;
+/** Return type for {@link loadArtifactMetadataAndContent}. */
+export interface ArtifactMetadataAndContent {
+    definition: DefinitionData;
+    attachmentsMd: string;
+}
+/**
+ * Loads metadata and markdown content for a domain artifact by composing
+ * legacy `definition.yaml` loading with `.md` frontmatter scanning.
+ *
+ * 1. Loads `definition.yaml` as the base metadata.
+ * 2. Scans all `.md` files in the artifact folder for frontmatter.
+ * 3. Merges: `.md` frontmatter overrides `definition.yaml` on key conflicts.
+ * 4. Concatenates all `.md` file bodies (alphabetical, empty bodies excluded).
+ *
+ * @param name - Artifact folder name (e.g., "MyEntity").
+ * @param basePath - Base path relative to cwd (e.g., "domain/src").
+ * @param cwd - Working directory.
+ * @returns Merged definition and concatenated markdown bodies.
+ */
+export declare function loadArtifactMetadataAndContent(name: string, basePath: string, cwd: string): Promise<ArtifactMetadataAndContent>;
+/**
+ * Loads metadata and markdown content for a use-case by composing legacy
+ * `definition.yaml` loading with `.md` frontmatter scanning.
+ *
+ * 1. Loads `definition.yaml` as the base metadata.
+ * 2. Scans all `.md` files in the use-case folder for frontmatter.
+ * 3. Merges: `.md` frontmatter overrides `definition.yaml` on key conflicts.
+ * 4. Concatenates all `.md` file bodies (alphabetical, empty bodies excluded).
+ *
+ * @param useCaseDirPath - Absolute path to the use-case folder.
+ * @returns Merged definition and concatenated markdown bodies.
+ */
+export declare function loadUseCaseMetadataAndContent(useCaseDirPath: string): Promise<ArtifactMetadataAndContent>;