@imolko/create-ultra-reporter 2.1.23-beta

package/bin/reporters/rendering.js

@@ -0,0 +1,385 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderExample = renderExample;
+exports.renderTestPanel = renderTestPanel;
+exports.renderTestPanels = renderTestPanels;
+exports.renderMethodsSection = renderMethodsSection;
+exports.renderTestsSection = renderTestsSection;
+exports.renderPropertiesSection = renderPropertiesSection;
+exports.renderPropertiesTable = renderPropertiesTable;
+exports.renderMethodDefinition = renderMethodDefinition;
+exports.renderMethodDefinitions = renderMethodDefinitions;
+exports.renderArtifactPage = renderArtifactPage;
+exports.renderUseCasePage = renderUseCasePage;
+const labels_1 = require("../scripts/labels");
+const markdown_1 = require("../scripts/markdown");
+const names_1 = require("../scripts/names");
+/**
+ * Renders a single code example as a styled HTML div.
+ *
+ * @param example - The example code string
+ * @returns HTML div string with inline styling
+ */
+function renderExample(example) {
+    return `<div style={{backgroundColor:'#EEE', margin:'32px 0px', padding: '16px 16px'}}>${example}</div>`;
+}
+/** Status-to-label-type mapping for test result colors. */
+const STATUS_LABEL_TYPE = {
+    passed: 'success',
+    failed: 'danger',
+    pending: 'warning',
+    todo: 'default',
+};
+/**
+ * Renders a single test result as a collapsible detail element.
+ *
+ * Each test gets a colored status label (green=passed, red=failed,
+ * yellow=pending, blue=todo) and a messages section inside a styled div.
+ *
+ * @param test - The test result to render (may include annotation from JSDoc)
+ * @param testFilePath - The file path containing the test
+ * @param messages - Optional messages to display (@deprecated, prefer test.annotation)
+ * @returns HTML string for the test panel (includes trailing // test-panel marker)
+ */
+function renderTestPanel(test, testFilePath, messages, repoSourceUrl) {
+    const labelType = STATUS_LABEL_TYPE[test.status] || 'default';
+    const labelHtml = (0, labels_1.getHtmlLabel)(labelType, test.status).replace(`display: 'inline'`, `display: 'inline-block', width: '80px', textAlign: 'center'`);
+    const headerText = `${labelHtml} ${test.title}`;
+    // Build comments from annotation (preferred) or fall back to messages
+    let comments = '';
+    if (test.annotation) {
+        // Render annotation: description + tags (matching old getDocumentationFromTest format)
+        const parts = [];
+        if (test.annotation.description) {
+            const descLines = test.annotation.description.replace(/\n/g, '<br/>');
+            parts.push(`<h3>Description</h3><p>${descLines}</p>`);
+        }
+        for (const tag of test.annotation.tags) {
+            const title = tag.title
+                ? tag.title.charAt(0).toUpperCase() + tag.title.slice(1).toLowerCase()
+                : '';
+            const value = tag.value ? tag.value.replace(/\n/g, '<br/>') : '';
+            parts.push(`<h3>${title}</h3><p>${value}</p>`);
+        }
+        comments = parts.join('');
+    }
+    else if (messages && messages.length > 0) {
+        comments = messages.map((msg) => `<div>${msg}</div>`).join('');
+    }
+    const pathHtml = repoSourceUrl
+        ? `<a href="${repoSourceUrl.replace(/\/+$/, '')}/${testFilePath}">[View source]</a>`
+        : testFilePath;
+    return TEST_PANEL_TEMPLATE.replace('{/* title */}', headerText)
+        .replace('{/* path */}', pathHtml)
+        .replace('{/* comments */}', comments);
+}
+/**
+ * Renders all test results across all test files as concatenated test panels.
+ *
+ * @param testFiles - Array of test files with their results
+ * @returns Concatenated HTML string of all test panels
+ */
+function renderTestPanels(testFiles, repoSourceUrl) {
+    let result = '';
+    for (const testFile of testFiles) {
+        for (const testResult of testFile.testResults) {
+            result += renderTestPanel(testResult, testFile.testFilePath, undefined, repoSourceUrl);
+        }
+    }
+    return result;
+}
+/**
+ * Renders the complete methods section with count header and collapsible
+ * method definitions. Returns empty string when there are no methods.
+ *
+ * @param methods - Array of method definitions
+ * @returns HTML string for the entire methods section, or '' if empty
+ */
+function renderMethodsSection(methods) {
+    if (methods.length === 0)
+        return '';
+    const methodsHtml = renderMethodDefinitions(methods);
+    return `<h2>Methods <span style={{ color: '#bbb' }}>[${methods.length}]</span></h2>\n${methodsHtml}`;
+}
+/**
+ * Renders the complete tests section with count header and collapsible test panels.
+ * Returns empty string when there are no tests.
+ *
+ * @param testFiles - Array of test files with their results
+ * @returns HTML string for the entire tests section, or '' if no tests
+ */
+function renderTestsSection(testFiles, repoSourceUrl) {
+    const totalTests = testFiles.reduce((sum, f) => sum + f.testResults.length, 0);
+    if (totalTests === 0)
+        return '';
+    const panelsHtml = renderTestPanels(testFiles, repoSourceUrl);
+    return `<h2>Tests <span style={{ color: '#bbb' }}>[${totalTests}]</span></h2>\n${panelsHtml}`;
+}
+/**
+ * Renders the complete properties section with count header and
+ * collapsible table. Returns empty string when there are no properties.
+ *
+ * @param properties - Array of property definitions
+ * @returns HTML string for the entire properties section, or '' if empty
+ */
+function renderPropertiesSection(properties) {
+    if (properties.length === 0)
+        return '';
+    const tableHtml = renderPropertiesTable(properties);
+    return `<h2>Properties <span style={{ color: '#bbb' }}>[${properties.length}]</span></h2>\n<details style={{ marginBottom: '16px' }}>\n<summary>${properties.length} properties</summary>\n${tableHtml}\n</details>`;
+}
+/**
+ * Renders a markdown table of artifact properties (name, type, description).
+ *
+ * The type column renders as a link using the same logic as the monolith's
+ * linkToType: strips `<...>` suffix that follows a dot (e.g., `java.util.List<String>`
+ * → `java.util.List`), then converts the type name using names().fileName.
+ *
+ * @param properties - Array of property definitions
+ * @returns HTML table string
+ */
+function renderPropertiesTable(properties) {
+    const rows = properties.map((prop) => {
+        const linkedType = linkToType(prop.type);
+        return `<tr><td>${prop.name}</td><td>${linkedType}</td><td>${prop.description}</td></tr>`;
+    });
+    const rowsText = rows.join('\n');
+    return PROPERTIES_TABLE_TEMPLATE.replace('{/* row */}', rowsText);
+}
+/**
+ * Converts a type string to a link (same logic as monolith's linkToType).
+ */
+function linkToType(type) {
+    const typeSanatize = `${type}`.replace(/\.<.+>/, '');
+    const typeFileName = (0, names_1.names)(typeSanatize).fileName;
+    return `<a href="./${typeFileName}">${typeSanatize}</a>`;
+}
+/**
+ * Renders a single method definition with name, description,
+ * parameters table, and examples.
+ *
+ * @param method - The method definition to render
+ * @returns HTML string for the method definition (includes trailing
+ *          // method-definition marker for composition)
+ */
+function renderMethodDefinition(method) {
+    // Build method name: name(param1, param2, ...)
+    const paramsList = method.params
+        .filter((p) => p.name)
+        .map((p) => p.name)
+        .join(', ');
+    const methodName = `${method.name}(${paramsList})`;
+    // Build description from comment + description, deduped per line
+    const commentDesc = (0, markdown_1.getMainDescriptionFromComment)(method.comment || '');
+    const rawDesc = `${commentDesc}${method.description || ''}`;
+    const methodDescription = dedupeLines(rawDesc)
+        .map((line) => `<p>${line}</p>`)
+        .join('\n');
+    // Build parameters rows
+    const parametersRows = method.params
+        .map((param) => {
+        const typeName = param.type && param.type.names && param.type.names[0]
+            ? param.type.names[0]
+            : '';
+        const linkedType = typeName ? linkToType(typeName) : '';
+        return `<tr><td>${param.name}</td><td>${linkedType}</td><td>${param.description}</td></tr>`;
+    })
+        .join('\n');
+    // Build examples
+    const examplesHtml = method.examples
+        .map((example) => renderExample(example))
+        .join('');
+    return METHOD_DEFINITION_TEMPLATE.replace('{/* method-name */}', methodName)
+        .replace('{/* method-description */}', methodDescription)
+        .replace('{/* row */}', parametersRows)
+        .replace('{/* example */}', examplesHtml);
+}
+/**
+ * Splits text by newline, deduplicates (exact match), preserving empty strings.
+ * Matches the monolith's reduce+includes logic.
+ */
+function dedupeLines(text) {
+    return text.split('\n').reduce((prev, curr) => {
+        if (prev.includes(curr))
+            return prev;
+        prev.push(curr);
+        return prev;
+    }, []);
+}
+/**
+ * Renders multiple method definitions by composing renderMethodDefinition
+ * calls. Uses the trailing `{ /* method-definition * / }` marker for
+ * recursive composition (matches the monolith template pattern).
+ *
+ * @param methods - Array of method definitions
+ * @returns Concatenated HTML string of all method definitions
+ */
+function renderMethodDefinitions(methods) {
+    if (methods.length === 0)
+        return '';
+    let result = renderMethodDefinition(methods[0]);
+    for (let i = 1; i < methods.length; i++) {
+        result = result.replace('{/* method-definition */}', renderMethodDefinition(methods[i]));
+    }
+    return result;
+}
+/**
+ * Renders the full artifact documentation page.
+ *
+ * Composes all sections: header (title, type+tags, description), attachments,
+ * properties table, method definitions, and test panels.
+ *
+ * @param artifact - The fully enriched artifact to render
+ * @param options - Optional rendering flags
+ * @returns Complete HTML page string for the artifact
+ */
+function renderArtifactPage(artifact, options) {
+    const skipAttachments = options?.skipAttachments ?? false;
+    const typeAndTags = `${(0, labels_1.typeTag)(artifact.type)} ${(0, labels_1.setupTagsHtml)(artifact.tags)}`;
+    // Replace title, type, description in the page template
+    let page = ARTIFACT_PAGE_TEMPLATE.replace('{/* title */}', artifact.title)
+        .replace('{/* type */}', typeAndTags)
+        .replace('{/* description */}', artifact.description || '');
+    // Attachments section
+    if (skipAttachments) {
+        // Leave marker in place for deferred replacement after minification
+    }
+    else if (artifact.hasAttachments && artifact.attachmentsMd) {
+        const attachmentsHtml = `\n\n<div style={{ backgroundColor: '#EEE', margin: '32px 0', padding: '16px' }}>\n\n${artifact.attachmentsMd}\n\n </div>\n\n`;
+        page = page.replace('{/* attachments-md */}', attachmentsHtml);
+    }
+    else {
+        page = page.replace('{/* attachments-md */}', '');
+    }
+    // Properties section
+    page = page.replace('{/* properties */}', renderPropertiesSection(artifact.properties));
+    // Method definitions section
+    page = page.replace('{/* method-definition */}', renderMethodsSection(artifact.methodDefinitions));
+    // Tests section
+    page = page.replace('{/* test-panel */}', renderTestsSection(artifact.testResults, options?.repoSourceUrl));
+    return page;
+}
+/** Raw template for the artifact page shell, from artifact.template.jsx. */
+const ARTIFACT_PAGE_TEMPLATE = `<div>
+    <div>
+        <h1 style={{ textAlign: 'start', color: '#000000', margin: '2rem 0' }}>
+            {/* title */}
+        </h1>
+        <p>{/* type */}</p>
+        <h3 style={{ textAlign: 'start', color: 'grey', marginBottom: '2rem' }}>
+            {/* description */}
+        </h3>
+    </div>
+</div>
+{/* attachments-md */}
+<div>
+    {/* properties */}
+    {/* method-definition */}
+    {/* test-panel */}
+</div>`;
+/** Raw template for the method definition, from method-definition.template.jsx. */
+const METHOD_DEFINITION_TEMPLATE = `<div>
+<details style={{ marginBottom: '16px' }}>
+<summary><h4 style={{ color: '#000000', display: 'inline' }}>
+  {/* method-name */}
+</h4></summary>
+<div style={{ color: 'grey' }}>
+  {/* method-description */}
+</div>
+<h5 style={{ fontWeight: 600 }}>Parameters:</h5>
+<table className="table">
+  <thead>
+    <tr>
+      <th>Name</th>
+      <th>Type</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    {/* row */}
+  </tbody>
+</table>
+<h5 style={{ fontWeight: 600 }}>Examples:</h5>
+{/* example */}
+</details>
+</div>
+{/* method-definition */}`;
+/** Raw template for the properties table, from properties.template.jsx. */
+const PROPERTIES_TABLE_TEMPLATE = `<div style={{ margin: '32px 0' }}>
+    <table className="table">
+        <thead>
+            <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            </tr>
+        </thead>
+        <tbody>
+            {/* row */}
+            {/* <tr>
+            <td>name</td>
+            <td>type</td>
+            <td>description</td>
+            </tr> */}
+        </tbody>
+    </table>
+</div>`;
+/** Raw template for a single test panel, from test.template.jsx. */
+const TEST_PANEL_TEMPLATE = `<details style={{ marginBottom: '16px' }}>
+<summary>{/* title */}</summary>
+{/* comments */}
+<p>{/* path */}</p>
+</details>
+{/* test-panel */}`;
+// ---------------------------------------------------------------------------
+// Use-case rendering
+// ---------------------------------------------------------------------------
+/** Raw template for a use-case page, from use-case.template.jsx. */
+const USE_CASE_PAGE_TEMPLATE = `<div>
+    <div>
+        <h1 style={{ textAlign: 'start', color: '#000000', margin: '2rem 0' }}>
+            {/* title */}
+        </h1>
+        <p>{/* type */}</p>
+        <h3 style={{ textAlign: 'start', color: 'grey', marginBottom: '2rem' }}>
+            {/* description */}
+        </h3>
+    </div>
+</div>
+{/* attachments-md */}
+<div>
+    {/* test-panel */}
+</div>`;
+/**
+ * Renders a full use-case documentation page.
+ *
+ * Composes: header (title, type+modelStatus+tags, description),
+ * attachments section, and test panels.
+ *
+ * @param useCase - The fully enriched use-case to render
+ * @param options - Optional rendering flags
+ * @returns Complete HTML page string for the use-case
+ */
+function renderUseCasePage(useCase, options) {
+    const skipAttachments = options?.skipAttachments ?? false;
+    const typeAndTags = `${(0, labels_1.typeTag)(useCase.type)} ${(0, labels_1.modelStatusTag)(useCase.modelStatus)} ${(0, labels_1.setupTagsHtml)(useCase.tags)}`;
+    // Replace title, type, description
+    let page = USE_CASE_PAGE_TEMPLATE.replace('{/* title */}', useCase.title)
+        .replace('{/* type */}', typeAndTags)
+        .replace('{/* description */}', (0, markdown_1.htmlDescription)(useCase.description));
+    // Attachments section
+    if (skipAttachments) {
+        // Leave marker for deferred replacement after minification
+    }
+    else if (useCase.attachmentsMd) {
+        const attachmentsHtml = `\n\n<div style={{ backgroundColor: '#EEE', margin: '32px 0', padding: '16px' }}>\n\n${useCase.attachmentsMd}\n\n </div>\n\n`;
+        page = page.replace('{/* attachments-md */}', attachmentsHtml);
+    }
+    else {
+        page = page.replace('{/* attachments-md */}', '');
+    }
+    // Tests section
+    page = page.replace('{/* test-panel */}', renderTestsSection(useCase.testResults, options?.repoSourceUrl));
+    return page;
+}
+//# sourceMappingURL=rendering.js.map

package/bin/reporters/rendering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rendering.js","sourceRoot":"","sources":["../../src/reporters/rendering.ts"],"names":[],"mappings":";;AAWA,sCAEC;AAqBD,0CA6CC;AAQD,4CAUC;AASD,oDAIC;AASD,gDAQC;AASD,0DAIC;AAYD,sDASC;AAmBD,wDAuCC;AAsBD,0DAaC;AAwBD,gDA4CC;AA6GD,8CAgCC;AA/cD,8CAAyF;AACzF,kDAAqF;AACrF,4CAAyC;AAGzC;;;;;GAKG;AACH,SAAgB,aAAa,CAAC,OAAe;IAC3C,OAAO,kFAAkF,OAAO,QAAQ,CAAC;AAC3G,CAAC;AAED,2DAA2D;AAC3D,MAAM,iBAAiB,GAA2B;IAChD,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,QAAQ;IAChB,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,SAAS;CAChB,CAAC;AAEF;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAC7B,IAAgB,EAChB,YAAoB,EACpB,QAAmB,EACnB,aAAsB;IAEtB,MAAM,SAAS,GAAG,iBAAiB,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,SAAS,CAAC;IAC9D,MAAM,SAAS,GAAG,IAAA,qBAAY,EAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAC5D,mBAAmB,EACnB,6DAA6D,CAC9D,CAAC;IACF,MAAM,UAAU,GAAG,GAAG,SAAS,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;IAEhD,sEAAsE;IACtE,IAAI,QAAQ,GAAG,EAAE,CAAC;IAElB,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;QACpB,uFAAuF;QACvF,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,IAAI,CAAC,UAAU,CAAC,WAAW,EAAE,CAAC;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;YACtE,KAAK,CAAC,IAAI,CAAC,0BAA0B,SAAS,MAAM,CAAC,CAAC;QACxD,CAAC;QAED,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;YACvC,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK;gBACrB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE;gBACtE,CAAC,CAAC,EAAE,CAAC;YACP,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACjE,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,WAAW,KAAK,MAAM,CAAC,CAAC;QACjD,CAAC;QAED,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC;SAAM,IAAI,QAAQ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3C,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,QAAQ,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjE,CAAC;IAED,MAAM,QAAQ,GAAG,aAAa;QAC5B,CAAC,CAAC,YAAY,aAAa,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,YAAY,qBAAqB;QACpF,CAAC,CAAC,YAAY,CAAC;IAEjB,OAAO,mBAAmB,CAAC,OAAO,CAAC,eAAe,EAAE,UAAU,CAAC;SAC5D,OAAO,CAAC,cAAc,EAAE,QAAQ,CAAC;SACjC,OAAO,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAC,SAAqB,EAAE,aAAsB;IAC5E,IAAI,MAAM,GAAG,EAAE,CAAC;IAEhB,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,KAAK,MAAM,UAAU,IAAI,QAAQ,CAAC,WAAW,EAAE,CAAC;YAC9C,MAAM,IAAI,eAAe,CAAC,UAAU,EAAE,QAAQ,CAAC,YAAY,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;QACzF,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAAC,OAA2B;IAC9D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,WAAW,GAAG,uBAAuB,CAAC,OAAO,CAAC,CAAC;IACrD,OAAO,gDAAgD,OAAO,CAAC,MAAM,kBAAkB,WAAW,EAAE,CAAC;AACvG,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,kBAAkB,CAAC,SAAqB,EAAE,aAAsB;IAC9E,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CACjC,CAAC,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,WAAW,CAAC,MAAM,EACtC,CAAC,CACF,CAAC;IACF,IAAI,UAAU,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAChC,MAAM,UAAU,GAAG,gBAAgB,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;IAC9D,OAAO,8CAA8C,UAAU,kBAAkB,UAAU,EAAE,CAAC;AAChG,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,uBAAuB,CAAC,UAAsB;IAC5D,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACvC,MAAM,SAAS,GAAG,qBAAqB,CAAC,UAAU,CAAC,CAAC;IACpD,OAAO,mDAAmD,UAAU,CAAC,MAAM,uEAAuE,UAAU,CAAC,MAAM,0BAA0B,SAAS,cAAc,CAAC;AACvN,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CAAC,UAAsB;IAC1D,MAAM,IAAI,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACnC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,WAAW,IAAI,CAAC,IAAI,YAAY,UAAU,YAAY,IAAI,CAAC,WAAW,YAAY,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEjC,OAAO,yBAAyB,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;AACpE,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,IAAY;IAC9B,MAAM,YAAY,GAAG,GAAG,IAAI,EAAE,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;IACrD,MAAM,YAAY,GAAG,IAAA,aAAK,EAAC,YAAY,CAAC,CAAC,QAAQ,CAAC;IAClD,OAAO,cAAc,YAAY,KAAK,YAAY,MAAM,CAAC;AAC3D,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,sBAAsB,CAAC,MAAwB;IAC7D,+CAA+C;IAC/C,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM;SAC7B,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SACrB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;SAClB,IAAI,CAAC,IAAI,CAAC,CAAC;IACd,MAAM,UAAU,GAAG,GAAG,MAAM,CAAC,IAAI,IAAI,UAAU,GAAG,CAAC;IAEnD,iEAAiE;IACjE,MAAM,WAAW,GAAG,IAAA,wCAA6B,EAAC,MAAM,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;IACxE,MAAM,OAAO,GAAG,GAAG,WAAW,GAAG,MAAM,CAAC,WAAW,IAAI,EAAE,EAAE,CAAC;IAC5D,MAAM,iBAAiB,GAAG,WAAW,CAAC,OAAO,CAAC;SAC3C,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,MAAM,CAAC;SAC/B,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,wBAAwB;IACxB,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM;SACjC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACb,MAAM,QAAQ,GACZ,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACnD,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;YACrB,CAAC,CAAC,EAAE,CAAC;QACT,MAAM,UAAU,GAAG,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,OAAO,WAAW,KAAK,CAAC,IAAI,YAAY,UAAU,YAAY,KAAK,CAAC,WAAW,YAAY,CAAC;IAC9F,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,iBAAiB;IACjB,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ;SACjC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;SACxC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEZ,OAAO,0BAA0B,CAAC,OAAO,CACvC,qBAAqB,EACrB,UAAU,CACX;SACE,OAAO,CAAC,4BAA4B,EAAE,iBAAiB,CAAC;SACxD,OAAO,CAAC,aAAa,EAAE,cAAc,CAAC;SACtC,OAAO,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;AAC9C,CAAC;AAED;;;GAGG;AACH,SAAS,WAAW,CAAC,IAAY;IAC/B,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAW,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE;QACtD,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChB,OAAO,IAAI,CAAC;IACd,CAAC,EAAE,EAAE,CAAC,CAAC;AACT,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,uBAAuB,CAAC,OAA2B;IACjE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEpC,IAAI,MAAM,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAEhD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,MAAM,GAAG,MAAM,CAAC,OAAO,CACrB,2BAA2B,EAC3B,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CACnC,CAAC;IACJ,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAcD;;;;;;;;;GASG;AACH,SAAgB,kBAAkB,CAChC,QAA0B,EAC1B,OAAmC;IAEnC,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,KAAK,CAAC;IAC1D,MAAM,WAAW,GAAG,GAAG,IAAA,gBAAO,EAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAA,sBAAa,EAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;IAEhF,wDAAwD;IACxD,IAAI,IAAI,GAAG,sBAAsB,CAAC,OAAO,CACvC,eAAe,EACf,QAAQ,CAAC,KAAK,CACf;SACE,OAAO,CAAC,cAAc,EAAE,WAAW,CAAC;SACpC,OAAO,CAAC,qBAAqB,EAAE,QAAQ,CAAC,WAAW,IAAI,EAAE,CAAC,CAAC;IAE9D,sBAAsB;IACtB,IAAI,eAAe,EAAE,CAAC;QACpB,oEAAoE;IACtE,CAAC;SAAM,IAAI,QAAQ,CAAC,cAAc,IAAI,QAAQ,CAAC,aAAa,EAAE,CAAC;QAC7D,MAAM,eAAe,GAAG,uFAAuF,QAAQ,CAAC,aAAa,iBAAiB,CAAC;QACvJ,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,qBAAqB;IACrB,IAAI,GAAG,IAAI,CAAC,OAAO,CACjB,oBAAoB,EACpB,uBAAuB,CAAC,QAAQ,CAAC,UAAU,CAAC,CAC7C,CAAC;IAEF,6BAA6B;IAC7B,IAAI,GAAG,IAAI,CAAC,OAAO,CACjB,2BAA2B,EAC3B,oBAAoB,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CACjD,CAAC;IAEF,gBAAgB;IAChB,IAAI,GAAG,IAAI,CAAC,OAAO,CACjB,oBAAoB,EACpB,kBAAkB,CAAC,QAAQ,CAAC,WAAW,EAAE,OAAO,EAAE,aAAa,CAAC,CACjE,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,4EAA4E;AAC5E,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;;;OAgBxB,CAAC;AAER,mFAAmF;AACnF,MAAM,0BAA0B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;0BAyBT,CAAC;AAE3B,2EAA2E;AAC3E,MAAM,yBAAyB,GAAG;;;;;;;;;;;;;;;;;;OAkB3B,CAAC;AAER,oEAAoE;AACpE,MAAM,mBAAmB,GAAG;;;;;mBAKT,CAAC;AAEpB,8EAA8E;AAC9E,qBAAqB;AACrB,8EAA8E;AAE9E,oEAAoE;AACpE,MAAM,sBAAsB,GAAG;;;;;;;;;;;;;;OAcxB,CAAC;AAER;;;;;;;;;GASG;AACH,SAAgB,iBAAiB,CAC/B,OAAwB,EACxB,OAA+D;IAE/D,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,KAAK,CAAC;IAC1D,MAAM,WAAW,GAAG,GAAG,IAAA,gBAAO,EAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAA,uBAAc,EAAC,OAAO,CAAC,WAAW,CAAC,IAAI,IAAA,sBAAa,EAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;IAErH,mCAAmC;IACnC,IAAI,IAAI,GAAG,sBAAsB,CAAC,OAAO,CACvC,eAAe,EACf,OAAO,CAAC,KAAK,CACd;SACE,OAAO,CAAC,cAAc,EAAE,WAAW,CAAC;SACpC,OAAO,CAAC,qBAAqB,EAAE,IAAA,0BAAe,EAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC;IAExE,sBAAsB;IACtB,IAAI,eAAe,EAAE,CAAC;QACpB,2DAA2D;IAC7D,CAAC;SAAM,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;QACjC,MAAM,eAAe,GAAG,uFAAuF,OAAO,CAAC,aAAa,iBAAiB,CAAC;QACtJ,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,eAAe,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACN,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,gBAAgB;IAChB,IAAI,GAAG,IAAI,CAAC,OAAO,CACjB,oBAAoB,EACpB,kBAAkB,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,EAAE,aAAa,CAAC,CAChE,CAAC;IAEF,OAAO,IAAI,CAAC;AACd,CAAC"}

package/bin/reporters/templates/README.md

@@ -0,0 +1,28 @@
+# Reporter Templates
+
+These templates are used by the **domain reporter** to render the **intro page** of the domain documentation.
+
+## What they generate
+
+| Template file | Used by | Generates | Docusaurus URL |
+|---|---|---|---|
+| `cards-container.template.jsx` | `generateIntro()` in `../generate-domain-documentation.ts` | `docs/package-root-intro.md` | `/docs/package-root-intro` |
+| `card.template.jsx` | ^ same | ^ same | ^ same |
+
+## What they do NOT generate
+
+- `/docs/category/aggregates` — that's a Docusaurus auto-generated category index (from `_category_.json`)
+- `/docs/category/domain-artifacts` — same
+- `/docs/domain/*.md` — artifact pages are rendered by `../rendering.ts`, not these templates
+- `/docs/aggregates/*.md` — same
+
+## How to iterate on these templates
+
+1. Edit `cards-container.template.jsx` or `card.template.jsx`
+2. Run `regenerate_fixture_docs.sh` from the repo root
+3. Open `/docs/package-root-intro` in Docusaurus to see the changes
+4. Run `UPDATE_GOLDENS=true npx jest --runInBand generate-documentation.char` to update the golden file once satisfied
+
+## Test coverage
+
+The intro page output is protected by a characterization test (`generate-documentation.char.spec.ts`). Any change to these templates will cause the test to fail — regenerate the golden file to accept intentional changes.

package/bin/reporters/templates/card.template.jsx

@@ -0,0 +1,5 @@
+  <div style={{flex: "0 1 280px", borderRadius: "8px", boxShadow: "0 2px 4px rgba(0,0,0,0.1)", padding: "16px", backgroundColor: "white"}}>
+    <h2 style={{margin: "0 0 12px 0", color: "#333", fontSize: "20px"}}><a href="/docs/domain/{/* name-link */}">{/* name */}</a></h2>
+    <p style={{margin: 0, color: "#666", lineHeight: 1.5}}>{/* description */}</p>
+  </div>
+  {/* card */}

package/bin/reporters/templates/cards-container.template.jsx

@@ -0,0 +1,5 @@
+### Aggregates
+
+<div style={{display: "flex", flexWrap: "wrap", gap: "20px", padding: "20px", justifyContent: "center", maxWidth: "1200px", margin: "0 auto"}}>
+  {/* card */}
+</div>

package/bin/reporters/types.d.ts

@@ -0,0 +1,190 @@
+/** A JSDoc custom tag (e.g., @scenario, @edge-case). */
+export interface Tag {
+    title: string;
+    value: string;
+}
+/** A single test assertion result. */
+export interface TestResult {
+    ancestorTitles: string[];
+    duration: number;
+    failureMessages: string[];
+    fullName: string;
+    status: 'passed' | 'failed' | 'pending' | 'todo';
+    title: string;
+    /** Optional test annotation extracted from JSDoc comments above the it() block. */
+    annotation?: {
+        description: string;
+        tags: Tag[];
+    };
+}
+/** A test file with aggregated counts and individual test results. */
+export interface TestFile {
+    numFailingTests: number;
+    numPassingTests: number;
+    numPendingTests: number;
+    numTodoTests: number;
+    testFilePath: string;
+    testResults: TestResult[];
+}
+/** A raw property as it appears inside a JSDoc element's .properties array. */
+export interface JsdocProperty {
+    name: string;
+    description: string;
+    type?: {
+        names: string[];
+    };
+}
+/** A single JSDoc element from jsdoc-to-json output. */
+export interface JsdocElem {
+    comment: string;
+    meta: {
+        filename: string;
+        path: string;
+        code: {
+            type: string;
+        };
+    };
+    name: string;
+    description: string;
+    deprecated?: string;
+    params: Param[];
+    examples: string[];
+    returns: Return[];
+    properties?: JsdocProperty[];
+    /** Custom tags (e.g., @scenario, @edge-case). Present when JSDoc doclet has tags. */
+    tags?: Tag[];
+}
+export interface Param {
+    name: string;
+    description: string;
+    type?: {
+        names: string[];
+    };
+}
+export interface Return {
+    type: {
+        names: string[];
+    };
+    description: string;
+}
+/** A raw artifact as read from artifacts.json. */
+export interface ArtifactRaw {
+    name: string;
+    type: string;
+    jsondocMustMatchPath: string;
+    category?: string;
+    description?: string;
+}
+/** Parsed YAML definition for an artifact or use-case. */
+export interface DefinitionData {
+    title?: string;
+    description?: string;
+    type?: string;
+    modelStatus?: string;
+    tags?: string[];
+    [key: string]: unknown;
+}
+/** A property extracted from JSDoc props.ts entries. */
+export interface Property {
+    name: string;
+    description: string;
+    type: string;
+}
+/** A ClassProperty extracted from JSDoc definition.ts entries. */
+export interface ClassProperty {
+    name: string;
+    type: 'ClassProperty';
+    comment: string;
+    deprecated: string;
+    description: string;
+    params: Param[];
+    examples: string[];
+    returns: Return[];
+}
+/** A MethodDefinition extracted from JSDoc definition.ts entries. */
+export interface MethodDefinition {
+    name: string;
+    type: 'MethodDefinition';
+    comment: string;
+    deprecated: string;
+    description: string;
+    params: Param[];
+    examples: string[];
+    returns: Return[];
+}
+/** An artifact fully enriched with JSDoc data, YAML definition, and test results. */
+export interface EnrichedArtifact {
+    name: string;
+    type: string;
+    jsondocMustMatchPath: string;
+    category?: string;
+    description?: string;
+    id: string;
+    idMarkdown: string;
+    title: string;
+    properties: Property[];
+    classProperties: ClassProperty[];
+    methodDefinitions: MethodDefinition[];
+    tags: string[];
+    hasAttachments: boolean;
+    attachmentsMd: string;
+    testResults: TestFile[];
+    numPassingTests: number;
+    numFailingTests: number;
+    numPendingTests: number;
+    numTodoTests: number;
+}
+/** A documentation context (one reporter invocation per package root). */
+export interface EnrichedContext {
+    name: string;
+    title: string;
+    artifacts: EnrichedArtifact[];
+}
+/** Loaded template strings used by render functions. */
+export interface Templates {
+    artifactTemplate: string;
+    testTemplate: string;
+    propertiesTemplate: string;
+    methodDefinitionTemplate: string;
+    exampleTemplate: string;
+}
+/** A rendered artifact page ready for writing. */
+export interface ArtifactPage {
+    markdown: string;
+    destPaths: string[];
+}
+/** A raw use-case built from a folder's definition.yaml and attachments.md. */
+export interface UseCaseRaw {
+    title: string;
+    description: string;
+    type: string;
+    modelStatus: string;
+    tags: string[];
+    attachmentsMd: string;
+    path: string;
+}
+/** A fully enriched use-case ready for rendering. */
+export interface EnrichedUseCase extends UseCaseRaw {
+    id: string;
+    idMarkdown: string;
+    testResults: TestFile[];
+    numPassingTests: number;
+    numFailingTests: number;
+    numPendingTests: number;
+    numTodoTests: number;
+}
+/** A rendered use-case page ready for writing. */
+export interface UseCasePage {
+    markdown: string;
+    destPath: string;
+}
+/** A single artifact entry in the static manifest for the searchable table. */
+export interface ArtifactManifestEntry {
+    name: string;
+    type: string;
+    tags: string[];
+    contextName: string;
+    description: string;
+    idMarkdown: string;
+    categories: string[];
+}

package/bin/reporters/types.js

@@ -0,0 +1,8 @@
+"use strict";
+// ---------------------------------------------------------------------------
+// Shared data types for the reporter decomposition layers.
+// These serve as the contract between data-loading, data-transformation,
+// rendering, and file-writing.
+// ---------------------------------------------------------------------------
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/bin/reporters/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/reporters/types.ts"],"names":[],"mappings":";AAAA,8EAA8E;AAC9E,2DAA2D;AAC3D,yEAAyE;AACzE,+BAA+B;AAC/B,8EAA8E"}

package/bin/scaffold/assembler.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Assembles (or re-assembles if needed) the Docusaurus scaffold into the
+ * .ultra-reporter/docusaurus/ directory.
+ *
+ * @param configDir - Directory containing ultra-reporter.config.json
+ * @param libraryTemplateDir - Path to the library's templates/documentation/ directory
+ * @param force - If true, re-assemble even if version matches
+ */
+export declare function assembleScaffold(configDir: string, libraryTemplateDir: string, force?: boolean): void;
+/**
+ * Checks if an existing scaffold is up-to-date.
+ */
+export declare function isScaffoldCurrent(docusaurusDir: string): boolean;