react-markdown-table-ts 0.2.0 → 0.2.1

package/dist/index.esm.js

@@ -1,50 +1,4 @@
-import require$$0, { useRef, useMemo, useEffect } from 'react';
-
-/******************************************************************************
-Copyright (c) Microsoft Corporation.
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
-***************************************************************************** */
-/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
-
-var extendStatics = function(d, b) {
-    extendStatics = Object.setPrototypeOf ||
-        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-        function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-    return extendStatics(d, b);
-};
-
-function __extends(d, b) {
-    if (typeof b !== "function" && b !== null)
-        throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-    extendStatics(d, b);
-    function __() { this.constructor = d; }
-    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-}
-
-function __spreadArray(to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-}
-
-typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
-    var e = new Error(message);
-    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
-};
+import require$$0, { useMemo, useEffect } from 'react';
 
 var jsxRuntime = {exports: {}};
 
@@ -1419,21 +1373,61 @@ if (process.env.NODE_ENV === 'production') {
 
 var jsxRuntimeExports = jsxRuntime.exports;
 
-// Error class
-var MarkdownTableError = /** @class */ (function (_super) {
-    __extends(MarkdownTableError, _super);
-    function MarkdownTableError(message) {
-        var _this = _super.call(this, message) || this;
-        _this.name = 'MarkdownTableError';
-        return _this;
-    }
-    return MarkdownTableError;
-}(Error));
-// Styles
-var prismStyles = "\n  code[class*=language-],pre[class*=language-]{color:#000;background:0 0;text-shadow:0 1px #fff;font-family:Consolas,Monaco,'Andale Mono','Ubuntu Mono',monospace;font-size:1em;text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;line-height:1.5;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none}\n  code[class*=language-] ::-moz-selection,code[class*=language-]::-moz-selection,pre[class*=language-] ::-moz-selection,pre[class*=language-]::-moz-selection{text-shadow:none;background:#b3d4fc}\n  code[class*=language-] ::selection,code[class*=language-]::selection,pre[class*=language-] ::selection,pre[class*=language-]::selection{text-shadow:none;background:#b3d4fc}\n  @media print{code[class*=language-],pre[class*=language-]{text-shadow:none}}\n  pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}\n  :not(pre)>code[class*=language-],pre[class*=language-]{background:#f5f2f0}\n  :not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}\n  .token.cdata,.token.comment,.token.doctype,.token.prolog{color:#708090}\n  .token.punctuation{color:#999}\n  .token.namespace{opacity:.7}\n  .token.boolean,.token.constant,.token.deleted,.token.number,.token.property,.token.symbol,.token.tag{color:#905}\n  .token.attr-name,.token.builtin,.token.char,.token.inserted,.token.selector,.token.string{color:#690}\n  .language-css .token.string,.style .token.string,.token.entity,.token.operator,.token.url{color:#9a6e3a;background:hsla(0,0%,100%,.5)}\n  .token.atrule,.token.attr-value,.token.keyword{color:#07a}\n  .token.class-name,.token.function{color:#dd4a68}\n  .token.important,.token.regex,.token.variable{color:#e90}\n  .token.bold,.token.important{font-weight:700}\n  .token.italic{font-style:italic}\n  .token.entity{cursor:help}\n  \n  /* Line Numbers */\n  pre[class*=\"language-\"].line-numbers {\n    position: relative;\n    padding-left: 3.8em;\n    counter-reset: linenumber;\n  }\n\n  pre[class*=\"language-\"].line-numbers > code {\n    position: relative;\n    white-space: inherit;\n  }\n\n  .line-numbers .line-numbers-rows {\n    position: absolute;\n    pointer-events: none;\n    top: 0;\n    font-size: 100%;\n    left: -3.8em;\n    width: 3em; /* works for line-numbers below 1000 lines */\n    letter-spacing: -1px;\n    border-right: 1px solid #999;\n    -webkit-user-select: none;\n    -moz-user-select: none;\n    -ms-user-select: none;\n    user-select: none;\n  }\n\n  .line-numbers-rows > span {\n    display: block;\n    counter-increment: linenumber;\n  }\n\n  .line-numbers-rows > span:before {\n    content: counter(linenumber);\n    color: #999;\n    display: block;\n    padding-right: 0.8em;\n    text-align: right;\n  }\n";
-// Helper functions
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+var extendStatics = function(d, b) {
+    extendStatics = Object.setPrototypeOf ||
+        ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+        function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+    return extendStatics(d, b);
+};
+
+function __extends(d, b) {
+    if (typeof b !== "function" && b !== null)
+        throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+    extendStatics(d, b);
+    function __() { this.constructor = d; }
+    d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+}
+
+function __spreadArray(to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+// src/utils.ts
+/**
+ * Calculates the maximum width for each column based on the content.
+ * @param allRows - All rows (header and body) of the table.
+ * @param maxColumnCount - The maximum number of columns in the table.
+ * @returns An array of maximum widths for each column.
+ */
 function calculateColumnWidths(allRows, maxColumnCount) {
-    var widths = new Array(maxColumnCount).fill(3);
+    var widths = new Array(maxColumnCount).fill(3); // Minimum width of 3 for each column.
     allRows.forEach(function (row) {
         var _a;
         for (var i = 0; i < maxColumnCount; i++) {
@@ -1443,9 +1437,24 @@ function calculateColumnWidths(allRows, maxColumnCount) {
     });
     return widths;
 }
+/**
+ * Replaces newline characters in a string with <br> tags.
+ * @param cell - The cell content to process.
+ * @returns The processed cell content with newlines replaced.
+ */
 function replaceNewlinesInCell(cell) {
     return cell.replace(/\n/g, '<br>');
 }
+/**
+ * Formats a single row into a Markdown-formatted string.
+ * @param columnCount - The number of columns in the table.
+ * @param row - The data of the current row.
+ * @param columnAlignments - Alignment settings for each column.
+ * @param columnWidths - Widths of each column.
+ * @param useTabs - Flag to use tabs between columns.
+ * @param replaceNewlines - Flag to replace newlines with <br> tags.
+ * @returns The Markdown string for the row.
+ */
 function formatMarkdownRow(columnCount, row, columnAlignments, columnWidths, useTabs, replaceNewlines) {
     var _a, _b;
     if (useTabs === void 0) { useTabs = false; }
@@ -1471,11 +1480,20 @@ function formatMarkdownRow(columnCount, row, columnAlignments, columnWidths, use
             markdownRow += "".concat(useTabs ? '\t' : ' ').concat(' '.repeat(paddingLeft)).concat(cell).concat(' '.repeat(paddingRight)).concat(useTabs ? '\t' : ' ', "|");
         }
         else {
+            // Left alignment or default
             markdownRow += "".concat(useTabs ? '\t' : ' ').concat(cell.padEnd(targetWidth)).concat(useTabs ? '\t' : ' ', "|");
         }
     }
     return markdownRow;
 }
+/**
+ * Generates the alignment row for the Markdown table syntax.
+ * @param columnCount - The number of columns in the table.
+ * @param columnAlignments - Alignment settings for each column.
+ * @param columnWidths - Widths of each column.
+ * @param useTabs - Flag to use tabs between columns.
+ * @returns The Markdown string for the alignment row.
+ */
 function formatAlignmentRow(columnCount, columnAlignments, columnWidths, useTabs) {
     var _a;
     if (useTabs === void 0) { useTabs = false; }
@@ -1505,6 +1523,15 @@ function formatAlignmentRow(columnCount, columnAlignments, columnWidths, useTabs
     }
     return alignmentRow;
 }
+/**
+ * Generates a complete Markdown table string from the provided data.
+ * @param tableData - The table data including headers and rows.
+ * @param columnAlignments - Alignment settings for each column.
+ * @param adjustColumnWidths - Flag to adjust column widths based on content.
+ * @param useTabs - Flag to use tabs between columns.
+ * @param replaceNewlines - Flag to replace newlines with <br> tags.
+ * @returns The complete Markdown table string.
+ */
 function generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, useTabs, replaceNewlines) {
     if (adjustColumnWidths === void 0) { adjustColumnWidths = true; }
     if (useTabs === void 0) { useTabs = false; }
@@ -1522,46 +1549,112 @@ function generateMarkdownTableString(tableData, columnAlignments, adjustColumnWi
         return formatMarkdownRow(maxColumnCount, row, columnAlignments, columnWidths, useTabs, replaceNewlines);
     })
         .join('\n');
-    var lines = "".concat(markdownHeaderRow, "\n").concat(markdownAlignmentRow, "\n").concat(markdownBodyRows)
-        .trimEnd()
-        .split('\n');
-    var lineNumbers = lines.map(function (_, index) { return "".concat(index + 1); });
-    var maxLineNumberWidth = lineNumbers[lineNumbers.length - 1].length;
-    var numberedLines = lines.map(function (line, index) {
-        var paddedLineNumber = lineNumbers[index].padStart(maxLineNumberWidth, ' ');
-        return "".concat(paddedLineNumber, " | ").concat(line);
-    });
-    return numberedLines.join('\n');
+    return "".concat(markdownHeaderRow, "\n").concat(markdownAlignmentRow, "\n").concat(markdownBodyRows).trimEnd();
 }
-function generateAlphabetHeaders(columnCount) {
-    var headers = [];
-    for (var i = 0; i < columnCount; i++) {
-        headers.push(getColumnName(i));
+
+// src/errors.ts
+/**
+ * Custom error class for handling Markdown table generation errors.
+ */
+var MarkdownTableError = /** @class */ (function (_super) {
+    __extends(MarkdownTableError, _super);
+    function MarkdownTableError(message) {
+        var _this = _super.call(this, message) || this;
+        _this.name = 'MarkdownTableError';
+        Object.setPrototypeOf(_this, MarkdownTableError.prototype);
+        return _this;
     }
-    return headers;
-}
-function getColumnName(index) {
-    var name = '';
-    var currentIndex = index;
-    while (currentIndex >= 0) {
-        name = String.fromCharCode((currentIndex % 26) + 65) + name;
-        currentIndex = Math.floor(currentIndex / 26) - 1;
+    return MarkdownTableError;
+}(Error));
+
+// src/validation.ts
+/**
+ * Validates the structure of the table data based on the `hasHeader` flag.
+ * Throws an error if validation fails.
+ * @param props - The props to validate.
+ */
+function validateMarkdownTableProps(props) {
+    var data = props.data, _a = props.hasHeader, hasHeader = _a === void 0 ? true : _a, columnAlignments = props.columnAlignments, _b = props.isCompact, isCompact = _b === void 0 ? false : _b, _c = props.hasTabs, hasTabs = _c === void 0 ? false : _c, _d = props.canReplaceNewlines, canReplaceNewlines = _d === void 0 ? false : _d;
+    if (!Array.isArray(data)) {
+        throw new MarkdownTableError("The 'data' prop must be a two-dimensional array.");
+    }
+    if (data.length === 0) {
+        throw new MarkdownTableError("The 'data' array must contain at least one row.");
+    }
+    // If hasHeader is true, ensure the first row exists and is valid
+    if (hasHeader) {
+        var header = data[0];
+        if (!Array.isArray(header) || header.length === 0) {
+            throw new MarkdownTableError("The first row of 'data' must be a non-empty array representing the header.");
+        }
+        // Validate each header cell is a string
+        header.forEach(function (cell, index) {
+            if (typeof cell !== 'string') {
+                throw new MarkdownTableError("Header cell at index ".concat(index, " must be a string."));
+            }
+        });
+    }
+    // Validate each row
+    data.forEach(function (row, rowIndex) {
+        if (!Array.isArray(row)) {
+            throw new MarkdownTableError("Row ".concat(rowIndex + 1, " in 'data' must be an array of strings."));
+        }
+        row.forEach(function (cell, cellIndex) {
+            if (typeof cell !== 'string') {
+                throw new MarkdownTableError("Cell at row ".concat(rowIndex + 1, ", column ").concat(cellIndex + 1, " must be a string."));
+            }
+        });
+    });
+    // Validate columnAlignments if provided
+    if (columnAlignments) {
+        if (!Array.isArray(columnAlignments)) {
+            throw new MarkdownTableError("'columnAlignments' must be an array of alignment strings.");
+        }
+        var validAlignments_1 = ['left', 'center', 'right', 'none'];
+        columnAlignments.forEach(function (alignment, index) {
+            if (!validAlignments_1.includes(alignment)) {
+                throw new MarkdownTableError("Invalid alignment '".concat(alignment, "' at index ").concat(index, ". Valid options are 'left', 'center', 'right', 'none'."));
+            }
+        });
+    }
+    // Validate isCompact
+    if (typeof isCompact !== 'boolean') {
+        throw new MarkdownTableError("'isCompact' must be a boolean.");
+    }
+    // Validate hasTabs
+    if (typeof hasTabs !== 'boolean') {
+        throw new MarkdownTableError("'hasTabs' must be a boolean.");
+    }
+    // Validate canReplaceNewlines
+    if (typeof canReplaceNewlines !== 'boolean') {
+        throw new MarkdownTableError("'canReplaceNewlines' must be a boolean.");
     }
-    return name;
 }
-// Main component
+
+/**
+ * React component that generates and displays Markdown table syntax.
+ * @param props - The input parameters for table generation.
+ * @returns A <pre> element containing the Markdown table syntax or an error message.
+ */
 var MarkdownTable = function (_a) {
     var _b = _a.data, data = _b === void 0 ? null : _b, _c = _a.hasHeader, hasHeader = _c === void 0 ? true : _c, _d = _a.columnAlignments, columnAlignments = _d === void 0 ? [] : _d, _e = _a.isCompact, isCompact = _e === void 0 ? false : _e, _f = _a.hasTabs, hasTabs = _f === void 0 ? false : _f, _g = _a.canReplaceNewlines, canReplaceNewlines = _g === void 0 ? false : _g, className = _a.className, onTableCreate = _a.onTableCreate;
+    // Invert isCompact to get adjustColumnWidths
     var adjustColumnWidths = !isCompact;
-    var preRef = useRef(null);
+    // Generate Markdown table
     var markdownSyntax = useMemo(function () {
         if (data === null) {
             return 'Error: No data provided for the table.';
         }
         try {
-            if (!Array.isArray(data) || data.length === 0) {
-                throw new MarkdownTableError("The 'data' prop must be a non-empty two-dimensional array.");
-            }
+            validateMarkdownTableProps({
+                data: data,
+                hasHeader: hasHeader,
+                columnAlignments: columnAlignments,
+                isCompact: isCompact,
+                hasTabs: hasTabs,
+                canReplaceNewlines: canReplaceNewlines,
+            });
+            // Determine header and rows based on hasHeader
             var tableData = hasHeader
                 ? {
                     header: data[0],
@@ -1594,13 +1687,35 @@ var MarkdownTable = function (_a) {
             onTableCreate(markdownSyntax);
         }
     }, [markdownSyntax, onTableCreate]);
-    useEffect(function () {
-        if (preRef.current && window.Prism) {
-            window.Prism.highlightElement(preRef.current.querySelector('code'));
-        }
-    }, [markdownSyntax]);
-    return (jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [jsxRuntimeExports.jsx("style", { children: prismStyles }), jsxRuntimeExports.jsx("pre", { ref: preRef, className: "".concat(className, " language-markdown line-numbers"), children: jsxRuntimeExports.jsx("code", { children: markdownSyntax }) })] }));
+    return jsxRuntimeExports.jsx("pre", { className: className, children: markdownSyntax });
 };
+/**
+ * Generates alphabetical headers (A, B, C, ...) based on the number of columns.
+ * @param columnCount - The number of columns.
+ * @returns An array of alphabetical headers.
+ */
+function generateAlphabetHeaders(columnCount) {
+    var headers = [];
+    for (var i = 0; i < columnCount; i++) {
+        headers.push(getColumnName(i));
+    }
+    return headers;
+}
+/**
+ * Converts a zero-based column index to its corresponding alphabetical representation.
+ * For example, 0 -> 'A', 1 -> 'B', ..., 25 -> 'Z', 26 -> 'AA', etc.
+ * @param index - The zero-based column index.
+ * @returns The alphabetical column name.
+ */
+function getColumnName(index) {
+    var name = '';
+    var currentIndex = index;
+    while (currentIndex >= 0) {
+        name = String.fromCharCode((currentIndex % 26) + 65) + name;
+        currentIndex = Math.floor(currentIndex / 26) - 1;
+    }
+    return name;
+}
 
-export { MarkdownTable };
+export { MarkdownTable, MarkdownTableError };
 //# sourceMappingURL=index.esm.js.map