ondc-code-generator 0.8.9 → 1.0.0

package/dist/generator/generators/documentation/templates/style.css

@@ -1,204 +1,449 @@
-/* RESET DEFAULT STYLES */
-body, ul, li, p, blockquote {
-	margin: 0;
-	padding: 0;
+/* ═══════════════════════════════════════════════════════════════
+   VARIABLES
+═══════════════════════════════════════════════════════════════ */
+:root {
+    --bg: #0f1117;
+    --bg-mid: #161b27;
+    --bg-card: #1c2333;
+    --border: #2d3748;
+    --accent: #1296d9;
+    --accent-dim: #0e6fa3;
+    --text: #e2e8f0;
+    --text-muted: #8892a4;
+    --group-bg: #1a2540;
+    --group-text: #93c5fd;
+    --leaf-bg: #1c2333;
+    --mark-bg: #ffdd57;
+    --mark-text: #1a1a1a;
+    --sidebar-w: 200px;
+    --topbar-h: 56px;
+    --radius: 6px;
+    --font: "Inter", "Segoe UI", system-ui, sans-serif;
+    --font-mono: "JetBrains Mono", "Fira Code", "Cascadia Code", monospace;
 }
-ul, li {
-	list-style: none;
+
+/* ═══════════════════════════════════════════════════════════════
+   RESET & BASE
+═══════════════════════════════════════════════════════════════ */
+*,
+*::before,
+*::after {
+    box-sizing: border-box;
+    margin: 0;
+    padding: 0;
+}
+
+html {
+    scroll-behavior: smooth;
 }
 
-/* BODY STYLES */
 body {
-	font-family: "Helvetica Neue", Arial, sans-serif;
-	background-color: #ffffff; /* Light background */
-	color: #333333; /* Dark text */
-	line-height: 1.8;
-	padding: 20px;
+    font-family: var(--font);
+    background: var(--bg);
+    color: var(--text);
+    line-height: 1.6;
+    font-size: 14px;
+    min-height: 100vh;
 }
 
-/* LIST STYLES */
-ul {
-	padding-left: 20px;
+a {
+    color: var(--accent);
+    text-decoration: none;
+}
+a:hover {
+    text-decoration: underline;
 }
 
-li {
-	margin-bottom: 16px;
-	position: relative;
+mark {
+    background: var(--mark-bg);
+    color: var(--mark-text);
+    border-radius: 2px;
+    padding: 0 2px;
 }
 
-li > p {
-	margin-bottom: 8px;
-	background-color: #f7f7f7; /* Light background */
-	color: #555555; /* Dark text */
-	padding: 10px 15px;
-	border: 1px solid #ddd;
-	border-radius: 5px;
-	box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
-	transition: background-color 0.3s, border 0.3s, box-shadow 0.3s;
+/* ═══════════════════════════════════════════════════════════════
+   TOP BAR
+═══════════════════════════════════════════════════════════════ */
+.top-bar {
+    position: fixed;
+    top: 0;
+    left: 0;
+    right: 0;
+    height: var(--topbar-h);
+    background: var(--bg-mid);
+    border-bottom: 1px solid var(--border);
+    display: flex;
+    align-items: center;
+    gap: 16px;
+    padding: 0 20px;
+    z-index: 100;
 }
 
-li > p:hover {
-	background-color: #e8e8e8;
-	border-color: #1296d9; /* Updated to blue accent color */
-	box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
+.logo {
+    font-weight: 700;
+    font-size: 15px;
+    color: var(--accent);
+    white-space: nowrap;
+    margin-right: 8px;
 }
 
-/* NESTED LIST ITEMS */
-ul ul li > p {
-	background-color: #f0f0f0; /* Slightly darker than parent */
+.toolbar {
+    display: flex;
+    align-items: center;
+    gap: 12px;
+    flex: 1;
+    overflow: hidden;
 }
 
-ul ul li > p:hover {
-	background-color: #e0e0e0;
+/* ── Search ── */
+.search-wrap {
+    position: relative;
+    display: flex;
+    align-items: center;
+    flex: 1;
+    max-width: 480px;
 }
 
-/* HEADINGS AND EMPHASIS TEXT */
-h2,
-li > p > strong {
-	color: #1296d9; /* Changed header color to match blue theme */
-	font-weight: 600;
+.search-icon {
+    position: absolute;
+    left: 10px;
+    width: 16px;
+    height: 16px;
+    color: var(--text-muted);
+    pointer-events: none;
 }
 
-li > p > strong {
-	font-size: 1.1em;
+#search {
+    width: 100%;
+    background: var(--bg-card);
+    border: 1px solid var(--border);
+    border-radius: var(--radius);
+    color: var(--text);
+    font-family: var(--font);
+    font-size: 13px;
+    padding: 7px 34px 7px 34px;
+    outline: none;
+    transition: border-color 0.15s;
 }
 
-/* BLOCKQUOTE STYLES */
-blockquote {
-	margin: 15px 0;
-	padding: 15px 20px;
-	background-color: #f7f7f7;
-	border-left: 5px solid #1296d9; /* Updated border to blue */
-	color: #555555;
-	font-style: italic;
-	box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
-	transition: background-color 0.3s, border-left-color 0.3s, box-shadow 0.3s;
+#search:focus {
+    border-color: var(--accent);
+    box-shadow: 0 0 0 2px rgba(18, 150, 217, 0.18);
 }
 
-blockquote:hover {
-	background-color: #e8e8e8;
-	border-left-color: #1296d9; /* Updated hover border to blue */
-	box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
+#search::placeholder {
+    color: var(--text-muted);
 }
 
-/* BLOCKQUOTE INTERNAL ELEMENTS */
-blockquote > p {
-	margin-bottom: 12px;
-	padding: 10px 15px;
-	background-color: #f7f7f7;
-	border-radius: 5px;
-	font-size: 1em;
-	box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
-	transition: background-color 0.3s, border 0.3s, box-shadow 0.3s;
+.clear-btn {
+    position: absolute;
+    right: 8px;
+    background: none;
+    border: none;
+    color: var(--text-muted);
+    font-size: 16px;
+    cursor: pointer;
+    line-height: 1;
+    padding: 2px 4px;
+}
+.clear-btn:hover {
+    color: var(--text);
 }
 
-blockquote > p:hover {
-	background-color: #e8e8e8;
-	border: 1px solid #1296d9; /* Updated border to blue on hover */
-	box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
+/* ── Filter pills ── */
+.filter-group {
+    display: flex;
+    gap: 6px;
+    flex-shrink: 0;
 }
 
-blockquote > ul {
-	padding-left: 20px;
-	margin-top: 10px;
+.pill {
+    background: var(--bg-card);
+    border: 1px solid var(--border);
+    border-radius: 20px;
+    color: var(--text-muted);
+    font-size: 12px;
+    padding: 4px 12px;
+    cursor: pointer;
+    white-space: nowrap;
+    transition:
+        background 0.15s,
+        color 0.15s,
+        border-color 0.15s;
 }
 
-blockquote > ul > li {
-	margin-bottom: 16px;
-	position: relative;
-	background-color: #f7f7f7;
-	padding: 10px 15px;
-	border: 1px solid #ddd;
-	border-radius: 5px;
-	box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
-	transition: background-color 0.3s, border 0.3s, box-shadow 0.3s;
+.pill:hover {
+    border-color: var(--accent);
+    color: var(--text);
+}
+.pill.active {
+    background: var(--accent);
+    border-color: var(--accent);
+    color: #fff;
+    font-weight: 600;
 }
 
-blockquote > ul > li:hover {
-	background-color: #e8e8e8;
-	border-color: #1296d9; /* Updated border to blue on hover */
-	box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);
+/* ── Match count badge ── */
+#match-count {
+    position: fixed;
+    bottom: 16px;
+    right: 20px;
+    background: var(--accent);
+    color: #fff;
+    font-size: 12px;
+    font-weight: 600;
+    padding: 5px 12px;
+    border-radius: 20px;
+    z-index: 200;
+    box-shadow: 0 2px 8px rgba(0, 0, 0, 0.4);
 }
 
-blockquote > ul > li > strong {
-	color: #1296d9; /* Changed to blue for emphasis */
-	font-weight: 600;
-	font-size: 1.1em;
+/* ═══════════════════════════════════════════════════════════════
+   LAYOUT
+═══════════════════════════════════════════════════════════════ */
+.layout {
+    display: flex;
+    margin-top: var(--topbar-h);
+    min-height: calc(100vh - var(--topbar-h));
 }
 
-blockquote > ul > li > ul {
-	padding-left: 20px;
-	margin-top: 8px;
+/* ── Sidebar ── */
+#sidebar {
+    position: fixed;
+    top: var(--topbar-h);
+    left: 0;
+    bottom: 0;
+    width: var(--sidebar-w);
+    background: var(--bg-mid);
+    border-right: 1px solid var(--border);
+    overflow-y: auto;
+    padding: 16px 0 24px;
+    scrollbar-width: thin;
+    scrollbar-color: var(--border) transparent;
 }
 
-blockquote > ul > li > ul > li {
-	background-color: #f0f0f0;
-	padding: 8px 12px;
-	border: 1px solid #ccc;
-	border-radius: 4px;
-	box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
-	transition: background-color 0.3s, border 0.3s, box-shadow 0.3s;
+.nav-heading {
+    font-size: 10px;
+    font-weight: 700;
+    letter-spacing: 0.08em;
+    text-transform: uppercase;
+    color: var(--text-muted);
+    padding: 0 16px 8px;
 }
 
-blockquote > ul > li > ul > li:hover {
-	background-color: #e0e0e0;
-	border-color: #1296d9; /* Updated border to blue on hover */
-	box-shadow: 0 2px 5px rgba(0, 0, 0, 0.2);
+#sidebar a {
+    display: block;
+    padding: 7px 16px;
+    font-size: 13px;
+    color: var(--text-muted);
+    white-space: nowrap;
+    overflow: hidden;
+    text-overflow: ellipsis;
+    border-left: 2px solid transparent;
+    transition:
+        color 0.12s,
+        border-color 0.12s,
+        background 0.12s;
 }
 
-/* COLLAPSIBLE INDICATORS */
-li.collapsible > p {
-	cursor: pointer;
+#sidebar a:hover {
+    color: var(--text);
+    background: rgba(255, 255, 255, 0.04);
+    text-decoration: none;
 }
 
-li.collapsible > p::before {
-	content: "▼";
-	display: inline-block;
-	margin-right: 8px;
-	transition: transform 0.3s, color 0.3s;
-	color: #1296d9; /* Updated color to blue */
+#sidebar a.active {
+    color: var(--accent);
+    border-left-color: var(--accent);
+    background: rgba(18, 150, 217, 0.08);
+    font-weight: 600;
 }
 
-li.collapsible.collapsed > p::before {
-	transform: rotate(-90deg);
+/* ── Main ── */
+#content {
+    margin-left: var(--sidebar-w);
+    padding: 28px 32px 60px;
+    flex: 1;
+    min-width: 0;
+    overflow-x: auto;
 }
 
-li.collapsible > p:hover::before {
-	color: #1296d9; /* Lighter blue on hover */
+/* ═══════════════════════════════════════════════════════════════
+   TYPOGRAPHY
+═══════════════════════════════════════════════════════════════ */
+#content h1 {
+    font-size: 20px;
+    font-weight: 700;
+    color: var(--text);
+    margin: 32px 0 6px;
+    border-bottom: 1px solid var(--border);
+    padding-bottom: 8px;
 }
 
-/* Hide nested lists by default */
-li.collapsible.collapsed > ul {
-	display: none;
+#content h1:first-child {
+    margin-top: 0;
 }
 
-/* RESPONSIVE DESIGN */
-@media only screen and (max-width: 768px) {
-	body {
-		padding: 15px;
-	}
-	ul {
-		padding-left: 15px;
-	}
-	li > p,
-	blockquote > p,
-	blockquote > ul > li {
-		font-size: 0.95em;
-		padding: 8px 12px;
-	}
+#content > p {
+    color: var(--text-muted);
+    margin-bottom: 16px;
+    font-size: 13px;
 }
 
-/* CUSTOM SCROLLBAR */
-::-webkit-scrollbar {
-	width: 8px;
-	background-color: #ffffff;
+#content hr {
+    border: none;
+    border-top: 1px solid var(--border);
+    margin: 20px 0;
 }
 
-::-webkit-scrollbar-thumb {
-	background-color: #ccc;
-	border-radius: 10px;
+code {
+    font-family: var(--font-mono);
+    font-size: 12px;
+    background: rgba(255, 255, 255, 0.07);
+    border: 1px solid var(--border);
+    padding: 1px 5px;
+    border-radius: 4px;
+    color: #a5d6fa;
+}
+
+/* ═══════════════════════════════════════════════════════════════
+   TABLE
+═══════════════════════════════════════════════════════════════ */
+table {
+    width: 100%;
+    border-collapse: collapse;
+    font-size: 13px;
+    margin-bottom: 8px;
+    table-layout: auto;
+}
+
+/* Sticky header */
+thead {
+    position: sticky;
+    top: var(--topbar-h);
+    z-index: 10;
+}
+
+thead th {
+    background: var(--bg-mid);
+    border-bottom: 2px solid var(--accent);
+    padding: 10px 12px;
+    font-size: 11px;
+    font-weight: 700;
+    letter-spacing: 0.06em;
+    text-transform: uppercase;
+    color: var(--text-muted);
+    white-space: nowrap;
+    text-align: left;
+}
+
+thead th:first-child {
+    text-align: right;
+}
+thead th:nth-child(2) {
+    text-align: center;
+}
+
+tbody tr {
+    border-bottom: 1px solid var(--border);
+}
+
+/* Group rows */
+tbody tr[data-rowtype="group"] {
+    background: var(--group-bg);
+}
+tbody tr[data-rowtype="group"] td {
+    color: var(--group-text);
+    font-weight: 600;
+}
+
+/* Leaf rows */
+tbody tr[data-rowtype="leaf"] {
+    background: var(--leaf-bg);
+}
+
+tbody tr:hover {
+    background: rgba(255, 255, 255, 0.04);
 }
 
+td {
+    padding: 9px 12px;
+    vertical-align: top;
+    line-height: 1.5;
+    max-width: 420px;
+}
+
+/* # column */
+td:first-child {
+    text-align: right;
+    color: var(--text-muted);
+    font-size: 11px;
+    white-space: nowrap;
+    padding-right: 8px;
+    min-width: 32px;
+}
+
+/* Type column */
+td:nth-child(2) {
+    text-align: center;
+    width: 36px;
+    font-size: 15px;
+}
+
+/* Dash placeholder */
+td:empty::after,
+td:only-child.empty::after {
+    content: "—";
+    color: var(--text-muted);
+}
+
+/* ── Skip If cell: softer red/orange tint ── */
+td:has(> *):nth-child(7) {
+    color: #f6ad55;
+}
+
+/* Error code pill */
+td:last-child:not(:only-child) {
+    white-space: nowrap;
+}
+
+/* ── "—" em dash placeholder cells ── */
+td {
+    /* GFM table renders literal "—" for empty cells from our generator */
+}
+td:has(> em) {
+    color: var(--text-muted);
+}
+
+/* ── Description / skip multiline list ── */
+td ul,
+td ol {
+    padding-left: 16px;
+    margin: 0;
+}
+td li {
+    margin-bottom: 2px;
+}
+
+/* ═══════════════════════════════════════════════════════════════
+   UTILITY
+═══════════════════════════════════════════════════════════════ */
+.hidden {
+    display: none !important;
+}
+
+/* Scrollbar */
+::-webkit-scrollbar {
+    width: 6px;
+    height: 6px;
+}
+::-webkit-scrollbar-track {
+    background: transparent;
+}
+::-webkit-scrollbar-thumb {
+    background: var(--border);
+    border-radius: 3px;
+}
 ::-webkit-scrollbar-thumb:hover {
-	background-color: #bbb;
+    background: var(--text-muted);
 }

package/dist/generator/generators/go/go-generator.js

@@ -42,7 +42,7 @@ export class GoGenerator extends CodeGenerator {
             await writeAndFormatCode(this.rootPath, `./${this.codeConfig.goPkgName}/go.mod`, goModCode, "text");
             await this.generateSessionDataCode();
             await this.generateUnitTestingCode();
-            await new MarkdownDocGenerator(this.validationConfig, this.errorCodes, this.rootPath).generateCode();
+            await new MarkdownDocGenerator(this.validationConfig, this.errorCodes, this.rootPath).generateCode(codeConfig);
         };
         this.generateTestFunction = async (testObject) => {
             const template = readFileSync(path.resolve(__dirname, "./templates/test-object.mustache"), "utf-8");

package/dist/generator/generators/javascript/js-generator.js

@@ -45,7 +45,7 @@ export class JavascriptGenerator extends CodeGenerator {
                 await this.generatePackageJson(codeConfig.codeName);
                 // Step 6: Generate documentation
                 logger.debug("Step 6: Generating documentation");
-                await new MarkdownDocGenerator(this.validationConfig, this.errorCodes, this.rootPath).generateCode();
+                await new MarkdownDocGenerator(this.validationConfig, this.errorCodes, this.rootPath).generateCode(codeConfig);
                 // Step 7: Clean up temporary files
                 logger.debug("Step 7: Cleaning up temporary files");
                 await this.cleanup();

package/dist/generator/generators/python/py-generator.js

@@ -107,7 +107,7 @@ export class PythonGenerator extends CodeGenerator {
             await writeAndFormatCode(this.rootPath, "requirements.txt", requirements, "text");
             await writeAndFormatCode(this.rootPath, "error.py", this.generateErrorFile(this.errorCodes), "python");
             await writeAndFormatCode(this.rootPath, "__init__.py", this.generateIndexFile(apiNames, codeConfig.codeName), "python");
-            await new MarkdownDocGenerator(this.validationConfig, this.errorCodes, this.rootPath).generateCode();
+            await new MarkdownDocGenerator(this.validationConfig, this.errorCodes, this.rootPath).generateCode(codeConfig);
             await this.generateSessionDataCode();
         };
         this.generateTestFunction = async (testObject) => {

package/dist/generator/generators/rag/rag-generator.d.ts

@@ -0,0 +1,48 @@
+import { CodeGenerator, CodeGeneratorProps } from "../classes/abstract-generator.js";
+/**
+ * RagGenerator — produces one Markdown file per API action under ./rag-docs/.
+ *
+ * Each file is a self-contained, richly structured document intended to be
+ * fed directly into a Retrieval-Augmented Generation (RAG) pipeline.
+ *
+ * Layout per file:
+ *   ---
+ *   YAML frontmatter (action, codeName, numTests, generated date)
+ *   ---
+ *   # <codeName> — <action> Validations
+ *   Short context paragraph
+ *   Numbered list of every test with its human-readable description,
+ *   error code, scope, and (indented) skip condition when present.
+ */
+export declare class RagGenerator extends CodeGenerator {
+    generateSessionDataCode(): Promise<void>;
+    generateUnitTestingCode(): Promise<void>;
+    generateValidationCode: () => Promise<void>;
+    generateCode: (codeConfig: CodeGeneratorProps) => Promise<void>;
+    private buildActionMarkdown;
+    /** Count only leaf (non-group) tests recursively. */
+    private countLeafTests;
+    /**
+     * Renders a numbered top-level section (##) for a test object.
+     *
+     * - Leaf test  → full human-readable description + metadata badges
+     * - Group node → brief intro line + all children rendered as ### sub-sections
+     *                (recursing further for deeply nested groups)
+     *
+     * This preserves the parent→child relationship in the output so RAG
+     * consumers can see exactly which sub-validations belong to which group.
+     */
+    private buildTestSection;
+    /**
+     * Renders a child/nested section at the given heading level.
+     * Recurses deeper (####, #####, …) for nested groups.
+     */
+    private renderChildSection;
+    /**
+     * Renders the skip block for a group node as a blockquote.
+     * Returns an empty string when there is no _CONTINUE_ on this node.
+     */
+    private renderSkipBlock;
+    /** Renders a leaf test's heading, metadata badges, and compiled description. */
+    private renderLeaf;
+}