@imolko/create-ultra-reporter 2.1.23-beta

package/bin/reporters/data-transformation.js

@@ -0,0 +1,392 @@
+"use strict";
+// ---------------------------------------------------------------------------
+// Data-transformation layer — pure functions that enrich and transform data.
+// All functions are stateless and have no I/O side effects.
+// ---------------------------------------------------------------------------
+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.extractProperties = extractProperties;
+exports.extractClassProperties = extractClassProperties;
+exports.extractMethodDefinitions = extractMethodDefinitions;
+exports.matchJsdocToArtifacts = matchJsdocToArtifacts;
+exports.matchTests = matchTests;
+exports.aggregateTestCounts = aggregateTestCounts;
+exports.buildArtifactId = buildArtifactId;
+exports.enrichArtifact = enrichArtifact;
+exports.enrichUseCase = enrichUseCase;
+exports.matchTestAnnotations = matchTestAnnotations;
+exports.buildManifestEntries = buildManifestEntries;
+const path = __importStar(require("path"));
+const data_loading_1 = require("./data-loading");
+// ---------------------------------------------------------------------------
+// extractProperties — extracts Property[] from JSDoc props.ts entries
+// ---------------------------------------------------------------------------
+/**
+ * Extracts property definitions from JSDoc elements whose meta.filename is 'props.ts'.
+ * Iterates over each matching element's `.properties` array and maps them
+ * to typed Property objects.
+ */
+function extractProperties(jsdocElems) {
+    const properties = [];
+    for (const jsdocElem of jsdocElems) {
+        if (jsdocElem.meta?.filename !== 'props.ts') {
+            continue;
+        }
+        if (!jsdocElem.properties) {
+            continue;
+        }
+        for (const prop of jsdocElem.properties) {
+            const elem = {
+                name: prop.name || '',
+                description: prop.description || '',
+                type: prop.type?.names?.[0]
+                    ? prop.type.names[0]
+                    : '',
+            };
+            properties.push(elem);
+        }
+    }
+    return properties;
+}
+// ---------------------------------------------------------------------------
+// extractClassProperties — extracts ClassProperty[] from JSDoc definition.ts
+// ---------------------------------------------------------------------------
+/**
+ * Extracts ClassProperty definitions from JSDoc elements whose
+ * meta.filename is 'definition.ts' and meta.code.type is 'ClassProperty'.
+ */
+function extractClassProperties(jsdocElems) {
+    const classProperties = [];
+    for (const jsdocElem of jsdocElems) {
+        const type = jsdocElem.meta?.code?.type ?? '';
+        if (jsdocElem.meta?.filename !== 'definition.ts') {
+            continue;
+        }
+        if (type !== 'ClassProperty') {
+            continue;
+        }
+        const elem = {
+            name: jsdocElem.name,
+            type: 'ClassProperty',
+            comment: jsdocElem.comment,
+            deprecated: jsdocElem.deprecated || '',
+            description: jsdocElem.description || '',
+            params: jsdocElem.params || [],
+            examples: jsdocElem.examples || [],
+            returns: jsdocElem.returns || [],
+        };
+        classProperties.push(elem);
+    }
+    return classProperties;
+}
+// ---------------------------------------------------------------------------
+// extractMethodDefinitions — extracts MethodDefinition[] from JSDoc
+// ---------------------------------------------------------------------------
+/**
+ * Extracts MethodDefinition from JSDoc elements whose meta.filename is
+ * 'definition.ts' and meta.code.type is 'MethodDefinition'.
+ */
+function extractMethodDefinitions(jsdocElems) {
+    const methodDefinitions = [];
+    for (const jsdocElem of jsdocElems) {
+        const codeType = jsdocElem.meta?.code?.type ?? '';
+        if (jsdocElem.meta?.filename !== 'definition.ts') {
+            continue;
+        }
+        if (codeType !== 'MethodDefinition') {
+            continue;
+        }
+        const elem = {
+            name: jsdocElem.name,
+            type: 'MethodDefinition',
+            comment: jsdocElem.comment,
+            deprecated: jsdocElem.deprecated || '',
+            description: jsdocElem.description || '',
+            params: jsdocElem.params || [],
+            examples: jsdocElem.examples || [],
+            returns: jsdocElem.returns || [],
+        };
+        methodDefinitions.push(elem);
+    }
+    return methodDefinitions;
+}
+// ---------------------------------------------------------------------------
+// matchJsdocToArtifacts — directory-based JSDoc path matching (FIXED)
+// ---------------------------------------------------------------------------
+/**
+ * Matches JSDoc elements to artifacts using directory-based path matching.
+ *
+ * For each artifact with jsondocMustMatchPath (e.g. "/MyEntity"), the function
+ * checks if the JSDoc element's meta.path contains that directory as a path
+ * segment (e.g. ".../MyEntity/definition.ts" matches "/MyEntity").
+ *
+ * This replaces the broken exact-suffix regex approach in the original code.
+ */
+function matchJsdocToArtifacts(jsdocData, artifacts) {
+    const result = new Map();
+    for (const jsdocElem of jsdocData) {
+        const jsdocPath = jsdocElem.meta?.path ?? '';
+        if (!jsdocPath) {
+            continue;
+        }
+        for (const artifact of artifacts) {
+            const targetPath = artifact.jsondocMustMatchPath;
+            if (!targetPath) {
+                continue;
+            }
+            // Strip leading slash for segment matching
+            const dirName = targetPath.replace(/^\//, '');
+            // Split path into segments and check for exact directory match
+            const segments = jsdocPath.split('/');
+            if (!segments.includes(dirName)) {
+                continue;
+            }
+            if (!result.has(targetPath)) {
+                result.set(targetPath, []);
+            }
+            result.get(targetPath).push(jsdocElem);
+        }
+    }
+    return result;
+}
+// ---------------------------------------------------------------------------
+// matchTests — matches test files to an artifact by path inclusion
+// ---------------------------------------------------------------------------
+/**
+ * Returns test files whose testFilePath includes the given artifactPath.
+ * The original code uses `artifactPath + '/'` to prevent matching similar names.
+ */
+function matchTests(artifactPath, testResults) {
+    const matched = [];
+    for (const testFile of testResults) {
+        if ((testFile.testFilePath || '').includes(artifactPath)) {
+            matched.push(testFile);
+        }
+    }
+    return matched;
+}
+/**
+ * Sums pass/fail/pending/todo test counts across a list of test files.
+ */
+function aggregateTestCounts(tests) {
+    const counts = {
+        numPassingTests: 0,
+        numFailingTests: 0,
+        numPendingTests: 0,
+        numTodoTests: 0,
+    };
+    for (const test of tests) {
+        counts.numPassingTests += test.numPassingTests || 0;
+        counts.numFailingTests += test.numFailingTests || 0;
+        counts.numPendingTests += test.numPendingTests || 0;
+        counts.numTodoTests += test.numTodoTests || 0;
+    }
+    return counts;
+}
+/**
+ * Generates an anchor-safe id and a filename-safe idMarkdown from the
+ * artifact name and context name.
+ *
+ * - `id`: "contextName-artifactName" lowered, spaces→hyphens, stripped of special chars
+ * - `idMarkdown`: "artifactName" lowered, spaces→hyphens, stripped of special chars
+ */
+function buildArtifactId(name, contextName) {
+    const sanitize = (input) => input
+        .trim()
+        .toLocaleLowerCase()
+        .replace(/[\s\t]+/g, '-')
+        .replace(/[^a-zA-Z0-9\-]/g, '');
+    return {
+        id: sanitize(`${contextName}-${name}`),
+        idMarkdown: sanitize(name),
+    };
+}
+// ---------------------------------------------------------------------------
+// enrichArtifact — composes extraction, loading, matching into EnrichedArtifact
+// ---------------------------------------------------------------------------
+/**
+ * Enriches a raw artifact with JSDoc data, YAML definition, attachments,
+ * matched test results, and computed IDs.
+ *
+ * Calls data-loading functions (loadArtifactMetadataAndContent) for I/O
+ * and pure transformation functions for data processing.
+ */
+async function enrichArtifact(artifact, jsdocElems, allTestResults, cwd, basePath, contextName) {
+    const properties = extractProperties(jsdocElems);
+    const classProperties = extractClassProperties(jsdocElems);
+    const methodDefinitions = extractMethodDefinitions(jsdocElems);
+    const { definition: definitionData, attachmentsMd } = await (0, data_loading_1.loadArtifactMetadataAndContent)(artifact.name, basePath, cwd);
+    // Build relative path so it matches test file paths (which are relative to cwd)
+    const artifactPath = path.relative(cwd, path.resolve(cwd, basePath, artifact.name)) + '/';
+    const testResults = matchTests(artifactPath, allTestResults);
+    const annotatedTestResults = matchTestAnnotations(testResults, jsdocElems);
+    const testCounts = aggregateTestCounts(annotatedTestResults);
+    const { id, idMarkdown } = buildArtifactId(artifact.name, contextName);
+    return {
+        name: artifact.name,
+        type: artifact.type,
+        jsondocMustMatchPath: artifact.jsondocMustMatchPath,
+        category: artifact.category,
+        description: definitionData.description || artifact.description || '',
+        id,
+        idMarkdown,
+        title: definitionData.title || artifact.name,
+        properties,
+        classProperties,
+        methodDefinitions,
+        tags: definitionData.tags || [],
+        hasAttachments: attachmentsMd.trim() !== '',
+        attachmentsMd,
+        testResults: annotatedTestResults,
+        ...testCounts,
+    };
+}
+// ---------------------------------------------------------------------------
+// enrichUseCase — enriches a raw use-case with test data and computed IDs
+// ---------------------------------------------------------------------------
+/**
+ * Enriches a raw use-case with matched test results, aggregated test counts,
+ * and computed IDs.
+ *
+ * Uses the same matchTests and aggregateTestCounts as the domain pipeline.
+ * The ID-building differs from buildArtifactId: use-case IDs include the
+ * index (for uniqueness within a context) and idMarkdown uses the title
+ * instead of an artifact name.
+ */
+function enrichUseCase(raw, allTestResults, index, contextName) {
+    const sanitize = (input) => input
+        .trim()
+        .toLocaleLowerCase()
+        .replace(/[\s\t]+/g, '-')
+        .replace(/[^a-zA-Z0-9\-]/g, '');
+    const testResults = matchTests(raw.path, allTestResults);
+    const counts = aggregateTestCounts(testResults);
+    return {
+        ...raw,
+        id: sanitize(`${contextName}-${raw.title}-${index}`),
+        idMarkdown: sanitize(raw.title),
+        testResults,
+        ...counts,
+    };
+}
+// ---------------------------------------------------------------------------
+// matchTestAnnotations — matches spec.ts JSDoc elements to test results
+// ---------------------------------------------------------------------------
+/**
+ * Matches JSDoc elements from .spec.ts files to individual test results.
+ *
+ * For each test result in each test file, finds the first JSDoc element
+ * whose `name` (from @name tag) is contained in the test's `fullName`
+ * AND whose `meta.path` shares at least one path segment with the test
+ * file's directory path.
+ *
+ * Matching annotations are attached as `result.annotation`.
+ *
+ * @param testFiles - Array of test files with their test results
+ * @param jsdocElems - JSDoc elements (may include spec.ts entries with annotations)
+ * @returns The test files with annotations attached (mutated in place)
+ */
+function matchTestAnnotations(testFiles, jsdocElems) {
+    // Filter to spec.ts JSDoc elements that have a name (@name tag required)
+    const specDocs = jsdocElems.filter((elem) => elem.meta?.filename?.includes('spec.ts') &&
+        !!elem.name);
+    if (specDocs.length === 0) {
+        return testFiles;
+    }
+    for (const testFile of testFiles) {
+        // Extract the directory path from the test file path
+        const testDir = extractDir(testFile.testFilePath);
+        for (const testResult of testFile.testResults) {
+            const match = specDocs.find((doc) => {
+                // Name matching: testFullName must include the JSDoc element's name
+                if (!testResult.fullName.includes(doc.name)) {
+                    return false;
+                }
+                // Path matching: test file's directory must be contained within
+                // the JSDoc element's meta.path (or vice versa), ensuring they
+                // belong to the same artifact directory.
+                const docPath = doc.meta?.path || '';
+                return testDir !== '' && docPath !== '' &&
+                    (docPath.includes(testDir) || testDir.includes(docPath));
+            });
+            if (match) {
+                testResult.annotation = {
+                    description: match.description || '',
+                    tags: match.tags || [],
+                };
+            }
+        }
+    }
+    return testFiles;
+}
+/**
+ * Extracts the directory portion of a file path (strips filename).
+ *
+ * @example
+ * extractDir('/project/domain/src/MyEntity/entity.spec.ts')
+ * // => '/project/domain/src/MyEntity'
+ */
+function extractDir(filePath) {
+    const lastSlash = filePath.lastIndexOf('/');
+    return lastSlash >= 0 ? filePath.slice(0, lastSlash) : filePath;
+}
+// ---------------------------------------------------------------------------
+// buildManifestEntries — converts enriched artifacts to manifest entries
+// ---------------------------------------------------------------------------
+/**
+ * Converts a list of enriched artifacts to manifest entries for the
+ * searchable artifact table.
+ *
+ * Aggregate artifacts get `categories: ["domain-artifacts", "aggregates"]`;
+ * all other types get `categories: ["domain-artifacts"]`.
+ *
+ * @param artifacts - The fully enriched artifacts
+ * @param contextName - The bounded context name for this package root
+ * @returns Manifest entries ready for serialization to JSON
+ */
+function buildManifestEntries(artifacts, contextName) {
+    return artifacts.map((artifact) => ({
+        name: artifact.name,
+        type: artifact.type,
+        tags: artifact.tags || [],
+        contextName,
+        description: artifact.description || '',
+        idMarkdown: artifact.idMarkdown,
+        categories: artifact.type === 'aggregate'
+            ? ['domain-artifacts', 'aggregates']
+            : ['domain-artifacts'],
+    }));
+}
+//# sourceMappingURL=data-transformation.js.map

package/bin/reporters/data-transformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"data-transformation.js","sourceRoot":"","sources":["../../src/reporters/data-transformation.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,6EAA6E;AAC7E,4DAA4D;AAC5D,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAgB9E,8CAyBC;AAUD,wDA2BC;AAUD,4DA2BC;AAeD,sDAkCC;AAUD,gCAUC;AAiBD,kDAgBC;AAmBD,0CAYC;AAaD,wCA4CC;AAeD,sCAuBC;AAoBD,oDA4CC;AA6BD,oDAgBC;AAlcD,2CAA6B;AAG7B,iDAAgE;AAEhE,8EAA8E;AAC9E,sEAAsE;AACtE,8EAA8E;AAE9E;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,UAAuB;IACvD,MAAM,UAAU,GAAe,EAAE,CAAC;IAClC,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC5C,SAAS;QACX,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;YAC1B,SAAS;QACX,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,IAAI,GAAa;gBACrB,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,EAAE;gBACrB,WAAW,EAAE,IAAI,CAAC,WAAW,IAAI,EAAE;gBACnC,IAAI,EACF,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;oBACnB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;oBACpB,CAAC,CAAC,EAAE;aACT,CAAC;YACF,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,CAAC;IACH,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,8EAA8E;AAC9E,6EAA6E;AAC7E,8EAA8E;AAE9E;;;GAGG;AACH,SAAgB,sBAAsB,CAAC,UAAuB;IAC5D,MAAM,eAAe,GAAoB,EAAE,CAAC;IAC5C,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;QAE9C,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,KAAK,eAAe,EAAE,CAAC;YACjD,SAAS;QACX,CAAC;QAED,IAAI,IAAI,KAAK,eAAe,EAAE,CAAC;YAC7B,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAkB;YAC1B,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,IAAI,EAAE,eAAe;YACrB,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,UAAU,EAAE,SAAS,CAAC,UAAU,IAAI,EAAE;YACtC,WAAW,EAAE,SAAS,CAAC,WAAW,IAAI,EAAE;YACxC,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,EAAE;YAC9B,QAAQ,EAAE,SAAS,CAAC,QAAQ,IAAI,EAAE;YAClC,OAAO,EAAE,SAAS,CAAC,OAAO,IAAI,EAAE;SACjC,CAAC;QACF,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED,8EAA8E;AAC9E,oEAAoE;AACpE,8EAA8E;AAE9E;;;GAGG;AACH,SAAgB,wBAAwB,CAAC,UAAuB;IAC9D,MAAM,iBAAiB,GAAuB,EAAE,CAAC;IACjD,KAAK,MAAM,SAAS,IAAI,UAAU,EAAE,CAAC;QACnC,MAAM,QAAQ,GAAG,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;QAElD,IAAI,SAAS,CAAC,IAAI,EAAE,QAAQ,KAAK,eAAe,EAAE,CAAC;YACjD,SAAS;QACX,CAAC;QAED,IAAI,QAAQ,KAAK,kBAAkB,EAAE,CAAC;YACpC,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAqB;YAC7B,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,IAAI,EAAE,kBAAkB;YACxB,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,UAAU,EAAE,SAAS,CAAC,UAAU,IAAI,EAAE;YACtC,WAAW,EAAE,SAAS,CAAC,WAAW,IAAI,EAAE;YACxC,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,EAAE;YAC9B,QAAQ,EAAE,SAAS,CAAC,QAAQ,IAAI,EAAE;YAClC,OAAO,EAAE,SAAS,CAAC,OAAO,IAAI,EAAE;SACjC,CAAC;QACF,iBAAiB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,8EAA8E;AAC9E,sEAAsE;AACtE,8EAA8E;AAE9E;;;;;;;;GAQG;AACH,SAAgB,qBAAqB,CACnC,SAAsB,EACtB,SAAwB;IAExB,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;IAE9C,KAAK,MAAM,SAAS,IAAI,SAAS,EAAE,CAAC;QAClC,MAAM,SAAS,GAAW,SAAS,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;QACrD,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,SAAS;QACX,CAAC;QAED,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;YACjC,MAAM,UAAU,GAAG,QAAQ,CAAC,oBAAoB,CAAC;YACjD,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,SAAS;YACX,CAAC;YACD,2CAA2C;YAC3C,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;YAC9C,+DAA+D;YAC/D,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACtC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChC,SAAS;YACX,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;gBAC5B,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;YAC7B,CAAC;YAED,MAAM,CAAC,GAAG,CAAC,UAAU,CAAE,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,8EAA8E;AAC9E,mEAAmE;AACnE,8EAA8E;AAE9E;;;GAGG;AACH,SAAgB,UAAU,CAAC,YAAoB,EAAE,WAAuB;IACtE,MAAM,OAAO,GAAe,EAAE,CAAC;IAE/B,KAAK,MAAM,QAAQ,IAAI,WAAW,EAAE,CAAC;QACnC,IAAI,CAAC,QAAQ,CAAC,YAAY,IAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;YACzD,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC;AAcD;;GAEG;AACH,SAAgB,mBAAmB,CAAC,KAAiB;IACnD,MAAM,MAAM,GAAe;QACzB,eAAe,EAAE,CAAC;QAClB,eAAe,EAAE,CAAC;QAClB,eAAe,EAAE,CAAC;QAClB,YAAY,EAAE,CAAC;KAChB,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,eAAe,IAAI,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;QACpD,MAAM,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY,IAAI,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAYD;;;;;;GAMG;AACH,SAAgB,eAAe,CAAC,IAAY,EAAE,WAAmB;IAC/D,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAU,EAAE,CACzC,KAAK;SACF,IAAI,EAAE;SACN,iBAAiB,EAAE;SACnB,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAEpC,OAAO;QACL,EAAE,EAAE,QAAQ,CAAC,GAAG,WAAW,IAAI,IAAI,EAAE,CAAC;QACtC,UAAU,EAAE,QAAQ,CAAC,IAAI,CAAC;KAC3B,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,gFAAgF;AAChF,8EAA8E;AAE9E;;;;;;GAMG;AACI,KAAK,UAAU,cAAc,CAClC,QAAqB,EACrB,UAAuB,EACvB,cAA0B,EAC1B,GAAW,EACX,QAAgB,EAChB,WAAmB;IAEnB,MAAM,UAAU,GAAG,iBAAiB,CAAC,UAAU,CAAC,CAAC;IACjD,MAAM,eAAe,GAAG,sBAAsB,CAAC,UAAU,CAAC,CAAC;IAC3D,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,UAAU,CAAC,CAAC;IAE/D,MAAM,EAAE,UAAU,EAAE,cAAc,EAAE,aAAa,EAAE,GAAG,MAAM,IAAA,6CAA8B,EAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,EAAE,GAAG,CAAC,CAAC;IAEzH,gFAAgF;IAChF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;IAC1F,MAAM,WAAW,GAAG,UAAU,CAAC,YAAY,EAAE,cAAc,CAAC,CAAC;IAC7D,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;IAC3E,MAAM,UAAU,GAAG,mBAAmB,CAAC,oBAAoB,CAAC,CAAC;IAE7D,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,GAAG,eAAe,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;IAEvE,OAAO;QACL,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB;QACnD,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,WAAW,EAAG,cAAc,CAAC,WAAsB,IAAI,QAAQ,CAAC,WAAW,IAAI,EAAE;QAEjF,EAAE;QACF,UAAU;QACV,KAAK,EAAG,cAAc,CAAC,KAAgB,IAAI,QAAQ,CAAC,IAAI;QAExD,UAAU;QACV,eAAe;QACf,iBAAiB;QAEjB,IAAI,EAAG,cAAc,CAAC,IAAiB,IAAI,EAAE;QAC7C,cAAc,EAAE,aAAa,CAAC,IAAI,EAAE,KAAK,EAAE;QAC3C,aAAa;QAEb,WAAW,EAAE,oBAAoB;QACjC,GAAG,UAAU;KACd,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,0EAA0E;AAC1E,8EAA8E;AAE9E;;;;;;;;GAQG;AACH,SAAgB,aAAa,CAC3B,GAAe,EACf,cAA0B,EAC1B,KAAa,EACb,WAAmB;IAEnB,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAU,EAAE,CACzC,KAAK;SACF,IAAI,EAAE;SACN,iBAAiB,EAAE;SACnB,OAAO,CAAC,UAAU,EAAE,GAAG,CAAC;SACxB,OAAO,CAAC,iBAAiB,EAAE,EAAE,CAAC,CAAC;IAEpC,MAAM,WAAW,GAAG,UAAU,CAAC,GAAG,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAEhD,OAAO;QACL,GAAG,GAAG;QACN,EAAE,EAAE,QAAQ,CAAC,GAAG,WAAW,IAAI,GAAG,CAAC,KAAK,IAAI,KAAK,EAAE,CAAC;QACpD,UAAU,EAAE,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC;QAC/B,WAAW;QACX,GAAG,MAAM;KACV,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,wEAAwE;AACxE,8EAA8E;AAE9E;;;;;;;;;;;;;GAaG;AACH,SAAgB,oBAAoB,CAClC,SAAqB,EACrB,UAAuB;IAEvB,yEAAyE;IACzE,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAChC,CAAC,IAAI,EAAE,EAAE,CACP,IAAI,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC;QACxC,CAAC,CAAC,IAAI,CAAC,IAAI,CACd,CAAC;IAEF,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,qDAAqD;QACrD,MAAM,OAAO,GAAG,UAAU,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;QAElD,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClC,oEAAoE;gBACpE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC;oBAC5C,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,gEAAgE;gBAChE,+DAA+D;gBAC/D,yCAAyC;gBACzC,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC;gBACrC,OAAO,OAAO,KAAK,EAAE,IAAI,OAAO,KAAK,EAAE;oBACrC,CAAC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC;YAC7D,CAAC,CAAC,CAAC;YAEH,IAAI,KAAK,EAAE,CAAC;gBACV,UAAU,CAAC,UAAU,GAAG;oBACtB,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,EAAE;oBACpC,IAAI,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;iBACvB,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,QAAgB;IAClC,MAAM,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,SAAS,IAAI,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC;AAClE,CAAC;AAED,8EAA8E;AAC9E,yEAAyE;AACzE,8EAA8E;AAE9E;;;;;;;;;;GAUG;AACH,SAAgB,oBAAoB,CAClC,SAA6B,EAC7B,WAAmB;IAEnB,OAAO,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAClC,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,IAAI,EAAE,QAAQ,CAAC,IAAI,IAAI,EAAE;QACzB,WAAW;QACX,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,EAAE;QACvC,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,UAAU,EACR,QAAQ,CAAC,IAAI,KAAK,WAAW;YAC3B,CAAC,CAAC,CAAC,kBAAkB,EAAE,YAAY,CAAC;YACpC,CAAC,CAAC,CAAC,kBAAkB,CAAC;KAC3B,CAAC,CAAC,CAAC;AACN,CAAC"}

package/bin/reporters/file-writing.d.ts

@@ -0,0 +1,29 @@
+import type { ArtifactManifestEntry, UseCasePage } from './types';
+/** A rendered artifact page ready for writing. */
+export interface ArtifactPage {
+    markdown: string;
+    destPaths: string[];
+}
+/**
+ * Writes each artifact page to its destination paths.
+ * Creates parent directories as needed and overwrites existing files.
+ *
+ * Aggregates get written to multiple destinations (domain + aggregates tabs).
+ */
+export declare function writeArtifactPages(pages: ArtifactPage[]): void;
+/**
+ * Writes each use-case page to its destination path.
+ * Creates parent directories as needed and overwrites existing files.
+ */
+export declare function writeUseCasePages(pages: UseCasePage[]): void;
+/**
+ * Appends artifact manifest entries to `static/data/artifacts-manifest.json`
+ * inside the given documentation path.
+ *
+ * Reads the existing manifest if it exists, appends the new entries, and
+ * writes the combined array back. Creates parent directories as needed.
+ *
+ * @param entries - The manifest entries to append
+ * @param documentationPath - Root path of the documentation site
+ */
+export declare function appendManifestToStatic(entries: ArtifactManifestEntry[], documentationPath: string): void;

package/bin/reporters/file-writing.js

@@ -0,0 +1,100 @@
+"use strict";
+// ---------------------------------------------------------------------------
+// File-writing layer — writes rendered artifact pages to disk.
+// ---------------------------------------------------------------------------
+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.writeArtifactPages = writeArtifactPages;
+exports.writeUseCasePages = writeUseCasePages;
+exports.appendManifestToStatic = appendManifestToStatic;
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * Writes each artifact page to its destination paths.
+ * Creates parent directories as needed and overwrites existing files.
+ *
+ * Aggregates get written to multiple destinations (domain + aggregates tabs).
+ */
+function writeArtifactPages(pages) {
+    for (const page of pages) {
+        for (const destPath of page.destPaths) {
+            const dir = path.dirname(destPath);
+            fs.mkdirSync(dir, { recursive: true });
+            fs.writeFileSync(destPath, page.markdown);
+        }
+    }
+}
+/**
+ * Writes each use-case page to its destination path.
+ * Creates parent directories as needed and overwrites existing files.
+ */
+function writeUseCasePages(pages) {
+    for (const page of pages) {
+        const dir = path.dirname(page.destPath);
+        fs.mkdirSync(dir, { recursive: true });
+        fs.writeFileSync(page.destPath, page.markdown);
+    }
+}
+// ---------------------------------------------------------------------------
+// appendManifestToStatic — appends artifact entries to the static manifest
+// ---------------------------------------------------------------------------
+/**
+ * Appends artifact manifest entries to `static/data/artifacts-manifest.json`
+ * inside the given documentation path.
+ *
+ * Reads the existing manifest if it exists, appends the new entries, and
+ * writes the combined array back. Creates parent directories as needed.
+ *
+ * @param entries - The manifest entries to append
+ * @param documentationPath - Root path of the documentation site
+ */
+function appendManifestToStatic(entries, documentationPath) {
+    const manifestDir = path.join(documentationPath, 'static', 'data');
+    const manifestPath = path.join(manifestDir, 'artifacts-manifest.json');
+    let existing = [];
+    if (fs.existsSync(manifestPath)) {
+        try {
+            const raw = fs.readFileSync(manifestPath, 'utf8');
+            existing = JSON.parse(raw);
+        }
+        catch {
+            existing = [];
+        }
+    }
+    const combined = [...existing, ...entries];
+    fs.mkdirSync(manifestDir, { recursive: true });
+    fs.writeFileSync(manifestPath, JSON.stringify(combined, null, 2));
+}
+//# sourceMappingURL=file-writing.js.map

package/bin/reporters/file-writing.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-writing.js","sourceRoot":"","sources":["../../src/reporters/file-writing.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,+DAA+D;AAC/D,8EAA8E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkB9E,gDAQC;AAMD,8CAMC;AAgBD,wDAsBC;AA1ED,uCAAyB;AACzB,2CAA6B;AAS7B;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,KAAqB;IACtD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACtC,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;YACnC,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;YACvC,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,KAAoB;IACpD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,EAAE,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACvC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;AACH,CAAC;AAED,8EAA8E;AAC9E,2EAA2E;AAC3E,8EAA8E;AAE9E;;;;;;;;;GASG;AACH,SAAgB,sBAAsB,CACpC,OAAgC,EAChC,iBAAyB;IAEzB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IACnE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,yBAAyB,CAAC,CAAC;IAEvE,IAAI,QAAQ,GAA4B,EAAE,CAAC;IAE3C,IAAI,EAAE,CAAC,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,EAAE,CAAC,YAAY,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;YAClD,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAA4B,CAAC;QACxD,CAAC;QAAC,MAAM,CAAC;YACP,QAAQ,GAAG,EAAE,CAAC;QAChB,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,OAAO,CAAC,CAAC;IAE3C,EAAE,CAAC,SAAS,CAAC,WAAW,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IAC/C,EAAE,CAAC,aAAa,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACpE,CAAC"}

package/bin/reporters/generate-domain-documentation.d.ts

@@ -0,0 +1,17 @@
+export interface DomainReporterArgs {
+    packageRootName: string;
+    contextName: string;
+    documentationPath: string;
+    domainPath: string;
+    domainTabName: string;
+    aggregateTabName: string;
+    templateDir: string;
+    repoSourceUrl?: string;
+}
+/**
+ * Generates domain documentation by composing the full pipeline:
+ * load artifacts/JSDoc/tests → match & enrich → render → write.
+ *
+ * @param args - Paths and naming configuration
+ */
+export declare function generateDomainDocumentation(args: DomainReporterArgs): Promise<void>;