@ibm/ibmi-mcp-server 0.1.0

package/dist/utils/formatting/markdownBuilder.js

@@ -0,0 +1,501 @@
+/**
+ * @fileoverview Markdown builder utility for creating well-structured, semantic markdown content
+ * @module utils/formatting/markdownBuilder
+ */
+/**
+ * Utility class for building well-formatted markdown content with consistent structure.
+ *
+ * This builder provides a fluent API for creating markdown documents with proper
+ * spacing, hierarchy, and semantic structure. It helps eliminate string concatenation
+ * and ensures consistent formatting across all tool response formatters.
+ *
+ * @example
+ * ```typescript
+ * const md = new MarkdownBuilder()
+ *   .h1('Commit Created Successfully')
+ *   .keyValue('Commit Hash', 'abc123def')
+ *   .keyValue('Author', 'John Doe')
+ *   .section('Files Changed', () => {
+ *     md.list(['file1.ts', 'file2.ts']);
+ *   });
+ *
+ * const markdown = md.build();
+ * ```
+ */
+export class MarkdownBuilder {
+    sections = [];
+    /**
+     * Add a level 1 heading.
+     * @param text - The heading text
+     * @param emoji - Optional emoji to prepend
+     * @returns this builder for chaining
+     */
+    h1(text, emoji) {
+        const prefix = emoji ? `${emoji} ` : "";
+        this.sections.push(`# ${prefix}${text}\n\n`);
+        return this;
+    }
+    /**
+     * Add a level 2 heading.
+     * @param text - The heading text
+     * @param emoji - Optional emoji to prepend
+     * @returns this builder for chaining
+     */
+    h2(text, emoji) {
+        const prefix = emoji ? `${emoji} ` : "";
+        this.sections.push(`## ${prefix}${text}\n\n`);
+        return this;
+    }
+    /**
+     * Add a level 3 heading.
+     * @param text - The heading text
+     * @param emoji - Optional emoji to prepend
+     * @returns this builder for chaining
+     */
+    h3(text, emoji) {
+        const prefix = emoji ? `${emoji} ` : "";
+        this.sections.push(`### ${prefix}${text}\n\n`);
+        return this;
+    }
+    /**
+     * Add a level 4 heading.
+     * @param text - The heading text
+     * @returns this builder for chaining
+     */
+    h4(text) {
+        this.sections.push(`#### ${text}\n\n`);
+        return this;
+    }
+    /**
+     * Add a bold key-value pair on a single line.
+     * @param key - The key (will be bolded)
+     * @param value - The value
+     * @returns this builder for chaining
+     */
+    keyValue(key, value) {
+        const displayValue = value === null ? "null" : String(value);
+        this.sections.push(`**${key}:** ${displayValue}\n`);
+        return this;
+    }
+    /**
+     * Add a key-value pair without bolding (for less emphasis).
+     * @param key - The key
+     * @param value - The value
+     * @returns this builder for chaining
+     */
+    keyValuePlain(key, value) {
+        const displayValue = value === null ? "null" : String(value);
+        this.sections.push(`${key}: ${displayValue}\n`);
+        return this;
+    }
+    /**
+     * Add a bulleted or numbered list.
+     * @param items - Array of items to list
+     * @param ordered - If true, creates a numbered list
+     * @returns this builder for chaining
+     */
+    list(items, ordered = false) {
+        if (items.length === 0)
+            return this;
+        const marker = ordered ? (i) => `${i + 1}.` : () => "-";
+        this.sections.push(items.map((item, i) => `${marker(i)} ${item}`).join("\n") + "\n\n");
+        return this;
+    }
+    /**
+     * Add a code block with optional language syntax highlighting.
+     * @param content - The code content
+     * @param language - Optional language identifier (e.g., 'typescript', 'diff', 'json')
+     * @returns this builder for chaining
+     */
+    codeBlock(content, language = "") {
+        this.sections.push(`\`\`\`${language}\n${content}\n\`\`\`\n\n`);
+        return this;
+    }
+    /**
+     * Add inline code (backticks).
+     * @param code - The code text
+     * @returns this builder for chaining
+     */
+    inlineCode(code) {
+        this.sections.push(`\`${code}\``);
+        return this;
+    }
+    /**
+     * Add a paragraph of text.
+     * @param text - The paragraph content
+     * @returns this builder for chaining
+     */
+    paragraph(text) {
+        this.sections.push(`${text}\n\n`);
+        return this;
+    }
+    /**
+     * Add a blockquote.
+     * @param text - The quoted text
+     * @returns this builder for chaining
+     */
+    blockquote(text) {
+        const lines = text.split("\n");
+        const quoted = lines.map((line) => `> ${line}`).join("\n");
+        this.sections.push(`${quoted}\n\n`);
+        return this;
+    }
+    /**
+     * Add a horizontal rule.
+     * @returns this builder for chaining
+     */
+    hr() {
+        this.sections.push("---\n\n");
+        return this;
+    }
+    /**
+     * Add a link.
+     * @param text - The link text
+     * @param url - The URL
+     * @returns this builder for chaining
+     */
+    link(text, url) {
+        this.sections.push(`[${text}](${url})`);
+        return this;
+    }
+    /**
+     * Add a table from structured data.
+     * @param headers - Array of column headers
+     * @param rows - Array of rows, each row is an array of cell values
+     * @returns this builder for chaining
+     */
+    table(headers, rows) {
+        if (headers.length === 0 || rows.length === 0)
+            return this;
+        // Header row
+        this.sections.push(`| ${headers.join(" | ")} |\n`);
+        // Separator row
+        this.sections.push(`| ${headers.map(() => "---").join(" | ")} |\n`);
+        // Data rows
+        rows.forEach((row) => {
+            this.sections.push(`| ${row.join(" | ")} |\n`);
+        });
+        this.sections.push("\n");
+        return this;
+    }
+    /**
+     * Add a section with a heading and callback for content.
+     * This is useful for grouping related content.
+     *
+     * @example
+     * ```typescript
+     * md.section('Files Changed', () => {
+     *   md.list(['file1.ts', 'file2.ts']);
+     * });
+     * ```
+     *
+     * @param title - The section heading
+     * @param levelOrContent - Heading level (2-4) or callback function
+     * @param content - Callback function (if level is provided)
+     * @returns this builder for chaining
+     */
+    section(title, levelOrContent, content) {
+        const level = typeof levelOrContent === "function" ? 2 : levelOrContent;
+        const callback = typeof levelOrContent === "function" ? levelOrContent : content;
+        switch (level) {
+            case 2:
+                this.h2(title);
+                break;
+            case 3:
+                this.h3(title);
+                break;
+            case 4:
+                this.h4(title);
+                break;
+        }
+        callback();
+        return this;
+    }
+    /**
+     * Add a collapsible details section (HTML details/summary).
+     * Note: Not all markdown renderers support this.
+     *
+     * @param summary - The summary text (always visible)
+     * @param details - The detailed content (collapsed by default)
+     * @returns this builder for chaining
+     */
+    details(summary, details) {
+        this.sections.push(`<details>\n<summary>${summary}</summary>\n\n`);
+        this.sections.push(`${details}\n\n`);
+        this.sections.push(`</details>\n\n`);
+        return this;
+    }
+    /**
+     * Add a status/alert box (GitHub/GitLab style).
+     * Renders as a highlighted blockquote with an icon.
+     *
+     * Supported types:
+     * - 'note': 📝 Neutral information
+     * - 'tip': 💡 Helpful suggestions
+     * - 'important': ❗ Critical information
+     * - 'warning': ⚠️ Warning/caution
+     * - 'caution': 🚨 Danger/destructive action
+     *
+     * @param type - Alert type
+     * @param content - Alert content (can be multi-line)
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.alert('warning', 'This operation cannot be undone!');
+     * // Renders: > [!WARNING]
+     * //          > This operation cannot be undone!
+     * ```
+     */
+    alert(type, content) {
+        const typeUpper = type.toUpperCase();
+        const lines = content.split("\n");
+        this.sections.push(`> [!${typeUpper}]\n`);
+        lines.forEach((line) => {
+            this.sections.push(`> ${line}\n`);
+        });
+        this.sections.push("\n");
+        return this;
+    }
+    /**
+     * Add a task list with checkboxes (GitHub style).
+     *
+     * @param items - Array of tasks with checked status
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.taskList([
+     *   { checked: true, text: 'Complete setup' },
+     *   { checked: false, text: 'Run tests' },
+     * ]);
+     * // Renders: - [x] Complete setup
+     * //          - [ ] Run tests
+     * ```
+     */
+    taskList(items) {
+        if (items.length === 0)
+            return this;
+        this.sections.push(items
+            .map((item) => `- [${item.checked ? "x" : " "}] ${item.text}`)
+            .join("\n") + "\n\n");
+        return this;
+    }
+    /**
+     * Add an image with alt text and optional title.
+     *
+     * @param altText - Alternative text for the image
+     * @param url - Image URL
+     * @param title - Optional title (shown on hover)
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.image('Architecture diagram', '/assets/diagram.png', 'System Architecture');
+     * // Renders: ![Architecture diagram](/assets/diagram.png "System Architecture")
+     * ```
+     */
+    image(altText, url, title) {
+        const titlePart = title ? ` "${title}"` : "";
+        this.sections.push(`![${altText}](${url}${titlePart})\n\n`);
+        return this;
+    }
+    /**
+     * Add strikethrough text.
+     *
+     * @param text - Text to strike through
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.text('Price: ').strikethrough('$100').text(' $80');
+     * // Renders: Price: ~~$100~~ $80
+     * ```
+     */
+    strikethrough(text) {
+        this.sections.push(`~~${text}~~`);
+        return this;
+    }
+    /**
+     * Add a diff-style code block showing additions and deletions.
+     * Useful for showing file changes, configuration updates, etc.
+     *
+     * @param changes - Object with optional additions, deletions, and context lines
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.diff({
+     *   additions: ['const newFeature = true;'],
+     *   deletions: ['const oldFeature = false;'],
+     *   context: ['// Configuration'],
+     * });
+     * // Renders as a diff code block with +/- prefixes
+     * ```
+     */
+    diff(changes) {
+        const lines = [];
+        // Context lines (no prefix)
+        if (changes.context) {
+            lines.push(...changes.context.map((line) => `  ${line}`));
+        }
+        // Deletions (- prefix)
+        if (changes.deletions) {
+            lines.push(...changes.deletions.map((line) => `- ${line}`));
+        }
+        // Additions (+ prefix)
+        if (changes.additions) {
+            lines.push(...changes.additions.map((line) => `+ ${line}`));
+        }
+        if (lines.length > 0) {
+            this.codeBlock(lines.join("\n"), "diff");
+        }
+        return this;
+    }
+    /**
+     * Add a badge/shield (uses shields.io style).
+     *
+     * @param label - Badge label (left side)
+     * @param message - Badge message (right side)
+     * @param color - Optional color (e.g., 'green', 'red', 'blue', 'yellow')
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.badge('build', 'passing', 'green');
+     * // Renders: ![build: passing](https://img.shields.io/badge/build-passing-green)
+     * ```
+     */
+    badge(label, message, color = "blue") {
+        const encodedLabel = encodeURIComponent(label);
+        const encodedMessage = encodeURIComponent(message);
+        const url = `https://img.shields.io/badge/${encodedLabel}-${encodedMessage}-${color}`;
+        this.sections.push(`![${label}: ${message}](${url})`);
+        return this;
+    }
+    /**
+     * Add bold text.
+     *
+     * @param text - Text to make bold
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.text('This is ').bold('important').text(' information.');
+     * // Renders: This is **important** information.
+     * ```
+     */
+    bold(text) {
+        this.sections.push(`**${text}**`);
+        return this;
+    }
+    /**
+     * Add italic text.
+     *
+     * @param text - Text to make italic
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.text('This is ').italic('emphasized').text('.');
+     * // Renders: This is *emphasized*.
+     * ```
+     */
+    italic(text) {
+        this.sections.push(`*${text}*`);
+        return this;
+    }
+    /**
+     * Add bold and italic text.
+     *
+     * @param text - Text to make bold and italic
+     * @returns this builder for chaining
+     *
+     * @example
+     * ```typescript
+     * md.boldItalic('Very important');
+     * // Renders: ***Very important***
+     * ```
+     */
+    boldItalic(text) {
+        this.sections.push(`***${text}***`);
+        return this;
+    }
+    /**
+     * Add raw markdown content directly.
+     * Use this for custom formatting not covered by other methods.
+     *
+     * @param markdown - Raw markdown string
+     * @returns this builder for chaining
+     */
+    raw(markdown) {
+        this.sections.push(markdown);
+        return this;
+    }
+    /**
+     * Add a blank line for spacing.
+     * @returns this builder for chaining
+     */
+    blankLine() {
+        this.sections.push("\n");
+        return this;
+    }
+    /**
+     * Add text without any formatting or line breaks.
+     * Useful for inline text that will be followed by other inline elements.
+     *
+     * @param text - The text to add
+     * @returns this builder for chaining
+     */
+    text(text) {
+        this.sections.push(text);
+        return this;
+    }
+    /**
+     * Conditionally add content based on a predicate.
+     *
+     * @example
+     * ```typescript
+     * md.when(files.length > 0, () => {
+     *   md.h2('Files Changed').list(files);
+     * });
+     * ```
+     *
+     * @param condition - If true, execute the callback
+     * @param content - Callback function to build conditional content
+     * @returns this builder for chaining
+     */
+    when(condition, content) {
+        if (condition) {
+            content();
+        }
+        return this;
+    }
+    /**
+     * Build the final markdown string.
+     * Trims trailing whitespace and ensures the document ends cleanly.
+     *
+     * @returns The complete markdown document as a string
+     */
+    build() {
+        return this.sections.join("").trim();
+    }
+    /**
+     * Reset the builder to start building a new document.
+     * @returns this builder for chaining
+     */
+    reset() {
+        this.sections = [];
+        return this;
+    }
+}
+/**
+ * Helper function to create a MarkdownBuilder instance.
+ * Provides a shorter alternative to `new MarkdownBuilder()`.
+ *
+ * @returns A new MarkdownBuilder instance
+ */
+export function markdown() {
+    return new MarkdownBuilder();
+}
+//# sourceMappingURL=markdownBuilder.js.map

package/dist/utils/formatting/markdownBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdownBuilder.js","sourceRoot":"","sources":["../../../src/utils/formatting/markdownBuilder.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,OAAO,eAAe;IAClB,QAAQ,GAAa,EAAE,CAAC;IAEhC;;;;;OAKG;IACH,EAAE,CAAC,IAAY,EAAE,KAAc;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,EAAE,CAAC,IAAY,EAAE,KAAc;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,MAAM,GAAG,IAAI,MAAM,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,EAAE,CAAC,IAAY,EAAE,KAAc;QAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACxC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,MAAM,GAAG,IAAI,MAAM,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,EAAE,CAAC,IAAY;QACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,CAAC;QACvC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,QAAQ,CAAC,GAAW,EAAE,KAAuC;QAC3D,MAAM,YAAY,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,OAAO,YAAY,IAAI,CAAC,CAAC;QACpD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,aAAa,CAAC,GAAW,EAAE,KAAuC;QAChE,MAAM,YAAY,GAAG,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC7D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,GAAG,KAAK,YAAY,IAAI,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,KAAe,EAAE,OAAO,GAAG,KAAK;QACnC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAEpC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,CAAS,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC;QAChE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CACnE,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,SAAS,CAAC,OAAe,EAAE,QAAQ,GAAG,EAAE;QACtC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,QAAQ,KAAK,OAAO,cAAc,CAAC,CAAC;QAChE,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAY;QACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,IAAY;QACpB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,IAAY;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,MAAM,MAAM,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,EAAE;QACA,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,IAAY,EAAE,GAAW;QAC5B,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,KAAK,GAAG,GAAG,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,OAAiB,EAAE,IAAgB;QACvC,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAE3D,aAAa;QACb,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEnD,gBAAgB;QAChB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEpE,YAAY;QACZ,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;YACnB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,OAAO,CACL,KAAa,EACb,cAAwC,EACxC,OAAoB;QAEpB,MAAM,KAAK,GAAG,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;QACxE,MAAM,QAAQ,GACZ,OAAO,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,OAAQ,CAAC;QACnE,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,CAAC;gBACJ,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBACf,MAAM;YACR,KAAK,CAAC;gBACJ,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBACf,MAAM;YACR,KAAK,CAAC;gBACJ,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;gBACf,MAAM;QACV,CAAC;QACD,QAAQ,EAAE,CAAC;QACX,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,OAAe,EAAE,OAAe;QACtC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,uBAAuB,OAAO,gBAAgB,CAAC,CAAC;QACnE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;QACrC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACrC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,KAAK,CACH,IAA0D,EAC1D,OAAe;QAEf,MAAM,SAAS,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,SAAS,KAAK,CAAC,CAAC;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,KAAgD;QACvD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,IAAI,CAAC;QAEpC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChB,KAAK;aACF,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;aAC7D,IAAI,CAAC,IAAI,CAAC,GAAG,MAAM,CACvB,CAAC;QACF,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,OAAe,EAAE,GAAW,EAAE,KAAc;QAChD,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7C,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,OAAO,KAAK,GAAG,GAAG,SAAS,OAAO,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,IAAY;QACxB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,IAAI,CAAC,OAIJ;QACC,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,4BAA4B;QAC5B,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACpB,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAC5D,CAAC;QAED,uBAAuB;QACvB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9D,CAAC;QAED,uBAAuB;QACvB,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC;QAC9D,CAAC;QAED,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACrB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;QAC3C,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,KAAa,EAAE,OAAe,EAAE,KAAK,GAAG,MAAM;QAClD,MAAM,YAAY,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,cAAc,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;QACnD,MAAM,GAAG,GAAG,gCAAgC,YAAY,IAAI,cAAc,IAAI,KAAK,EAAE,CAAC;QACtF,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,KAAK,KAAK,OAAO,KAAK,GAAG,GAAG,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAY;QACjB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,IAAY;QACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,GAAG,CAAC,QAAgB;QAClB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,IAAI,CAAC,IAAY;QACf,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAI,CAAC,SAAkB,EAAE,OAAmB;QAC1C,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,EAAE,CAAC;QACZ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK;QACH,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACH,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,UAAU,QAAQ;IACtB,OAAO,IAAI,eAAe,EAAE,CAAC;AAC/B,CAAC"}

package/dist/utils/formatting/sqlFormattingUtils.d.ts

@@ -0,0 +1,69 @@
+/**
+ * @fileoverview SQL formatting utilities for database result presentation.
+ * Provides type-aware formatting helpers for SQL results, including column alignment
+ * and type indicators.
+ * @module src/utils/formatting/sqlFormattingUtils
+ */
+import type { Alignment } from "./tableFormatter.js";
+/**
+ * Determine the appropriate column alignment based on IBM i DB2 data type.
+ * Numeric types are right-aligned for better visual comparison,
+ * while text and temporal types are left-aligned.
+ *
+ * @param columnType - The database column type (e.g., 'INTEGER', 'VARCHAR')
+ * @returns The recommended alignment for this column type
+ *
+ * @example
+ * ```typescript
+ * getColumnAlignment('INTEGER');    // 'right'
+ * getColumnAlignment('VARCHAR');    // 'left'
+ * getColumnAlignment('TIMESTAMP');  // 'left'
+ * getColumnAlignment('UNKNOWN');    // 'left' (default)
+ * ```
+ */
+export declare function getColumnAlignment(columnType: string | undefined): Alignment;
+/**
+ * Format a column header with type indicator.
+ * Appends the data type in parentheses for LLM clarity.
+ *
+ * @param columnName - The column name
+ * @param columnType - The database column type (optional)
+ * @returns Formatted header string
+ *
+ * @example
+ * ```typescript
+ * formatColumnHeader('EMPLOYEE_ID', 'INTEGER');
+ * // Returns: 'EMPLOYEE_ID (INTEGER)'
+ *
+ * formatColumnHeader('NAME', 'VARCHAR(50)');
+ * // Returns: 'NAME (VARCHAR)'
+ *
+ * formatColumnHeader('STATUS');
+ * // Returns: 'STATUS'
+ * ```
+ */
+export declare function formatColumnHeader(columnName: string, columnType?: string): string;
+/**
+ * Build a column alignment map for use with TableFormatter.
+ * Maps column names to their appropriate alignment based on their data types.
+ *
+ * @param columns - Array of column definitions with name and type
+ * @returns Record mapping column names to alignment values
+ *
+ * @example
+ * ```typescript
+ * const columns = [
+ *   { name: 'ID', type: 'INTEGER' },
+ *   { name: 'NAME', type: 'VARCHAR' },
+ *   { name: 'SALARY', type: 'DECIMAL' }
+ * ];
+ *
+ * buildColumnAlignmentMap(columns);
+ * // Returns: { ID: 'right', NAME: 'left', SALARY: 'right' }
+ * ```
+ */
+export declare function buildColumnAlignmentMap(columns: Array<{
+    name: string;
+    type?: string;
+}>): Record<string, Alignment>;
+//# sourceMappingURL=sqlFormattingUtils.d.ts.map

package/dist/utils/formatting/sqlFormattingUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sqlFormattingUtils.d.ts","sourceRoot":"","sources":["../../../src/utils/formatting/sqlFormattingUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AA2CrD;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAmB5E;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,kBAAkB,CAChC,UAAU,EAAE,MAAM,EAClB,UAAU,CAAC,EAAE,MAAM,GAClB,MAAM,CAQR;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,GAC9C,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAQ3B"}