react-markdown-table-ts 0.3.0 → 0.3.2

package/README.md

@@ -34,10 +34,10 @@ npm install react-markdown-table-ts
 
 |         Prop         |                     Type                      |   Default   |                 Description                 |
 | :------------------: | :-------------------------------------------: | :---------: | :-----------------------------------------: |
-|        `data`        |                 `string[][]`                  | (required)  |   The table data as a 2D array of strings   |
+|        `data`        |                 `string[][]`                  |   `null`    |   The table data as a 2D array of strings   |
 |  `columnAlignments`  | `('left' \| 'center' \| 'right' \| 'none')[]` |    `[]`     |          Alignment for each column          |
 |     `isCompact`      |                   `boolean`                   |   `false`   |          Use minimal column widths          |
-|     `className`      |                   `string`                    | `undefined` |      CSS class for the rendered table       |
+|     `className`      |                   `string`                    | `undefined` |        CSS class for the `<pre>` tag        |
 |      `hasTabs`       |                   `boolean`                   |   `false`   |       Add tabs between table columns        |
 | `canReplaceNewlines` |                   `boolean`                   |   `false`   | Replace newlines in cells with `<br>` tags  |
 |   `onTableCreate`    |      `(markdownString: string) => void`       | `undefined` |   Callback to receive the Markdown string   |

package/dist/index.cjs.js

@@ -8,52 +8,6 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 
 var require$$0__default = /*#__PURE__*/_interopDefaultLegacy(require$$0);
 
-/******************************************************************************
-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;
-};
-
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
 function getDefaultExportFromCjs (x) {
@@ -4057,42 +4011,106 @@ var Prism$1 = /*@__PURE__*/getDefaultExportFromCjs(prismExports);
 
 }());
 
-// CSS styles
-var prismStyles = "\ncode[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}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}code[class*=language-] ::selection,code[class*=language-]::selection,pre[class*=language-] ::selection,pre[class*=language-]::selection{text-shadow:none;background:#b3d4fc}@media print{code[class*=language-],pre[class*=language-]{text-shadow:none}}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#f5f2f0}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}pre[class*=language-].line-numbers{position:relative;padding-left:3.8em;counter-reset:linenumber}pre[class*=language-].line-numbers>code{position:relative;white-space:inherit}.line-numbers .line-numbers-rows{position:absolute;pointer-events:none;top:0;font-size:100%;left:-3.8em;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.line-numbers-rows>span{display:block;counter-increment:linenumber}.line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}\n";
+/******************************************************************************
+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/validation.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 MarkdownTableError;
 }(Error));
-function calculateColumnWidths(allRows, maxColumnCount) {
-    var widths = new Array(maxColumnCount).fill(3);
-    allRows.forEach(function (row) {
+
+// src/utils.ts
+/**
+ * Calculates the maximum width for each column based on the content.
+ * @param tableRows - 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(tableRows, maxColumnCount) {
+    var widths = new Array(maxColumnCount).fill(3); // Minimum width of 3 for each column.
+    tableRows.forEach(function (currentRow) {
         var _a;
         for (var i = 0; i < maxColumnCount; i++) {
-            var cell = (_a = row[i]) !== null && _a !== void 0 ? _a : '';
+            var cell = (_a = currentRow[i]) !== null && _a !== void 0 ? _a : '';
             widths[i] = Math.max(widths[i], cell.length);
         }
     });
     return widths;
 }
-function replaceNewlinesInCell(cell) {
-    return cell.replace(/\n/g, '<br>');
-}
-function formatMarkdownRow(columnCount, row, columnAlignments, columnWidths, useTabs, replaceNewlines) {
+/**
+ * Formats a single row into a Markdown-formatted string.
+ * @param columnCount - The number of columns in the table.
+ * @param currentRow - 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 canReplaceNewlines - Flag to replace newlines with <br> tags.
+ * @returns The Markdown string for the row.
+ */
+function formatMarkdownRow(columnCount, currentRow, columnAlignments, columnWidths, useTabs, canReplaceNewlines) {
     var _a, _b;
     if (useTabs === void 0) { useTabs = false; }
-    if (replaceNewlines === void 0) { replaceNewlines = false; }
+    if (canReplaceNewlines === void 0) { canReplaceNewlines = false; }
     var defaultAlignment = 'left';
     var adjustedAlignments = columnAlignments.length < columnCount
         ? __spreadArray(__spreadArray([], columnAlignments, true), Array(columnCount - columnAlignments.length).fill(defaultAlignment), true) : columnAlignments;
     var markdownRow = '|';
     for (var i = 0; i < columnCount; i++) {
-        var cell = (_a = row[i]) !== null && _a !== void 0 ? _a : '';
-        if (replaceNewlines) {
+        var cell = (_a = currentRow[i]) !== null && _a !== void 0 ? _a : '';
+        if (canReplaceNewlines) {
             cell = replaceNewlinesInCell(cell);
         }
         var alignment = (_b = adjustedAlignments[i]) !== null && _b !== void 0 ? _b : defaultAlignment;
@@ -4107,11 +4125,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; }
@@ -4141,61 +4168,92 @@ function formatAlignmentRow(columnCount, columnAlignments, columnWidths, useTabs
     }
     return alignmentRow;
 }
-function generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, useTabs, replaceNewlines) {
-    if (adjustColumnWidths === void 0) { adjustColumnWidths = true; }
+/**
+ * Generates a complete Markdown table string from the provided data.
+ * @param inputData - The table data including headers and rows.
+ * @param columnAlignments - Alignment settings for each column.
+ * @param canAdjustColumnWidths - 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(inputData, columnAlignments, canAdjustColumnWidths, useTabs, replaceNewlines) {
+    if (canAdjustColumnWidths === void 0) { canAdjustColumnWidths = true; }
     if (useTabs === void 0) { useTabs = false; }
     if (replaceNewlines === void 0) { replaceNewlines = false; }
-    var headerColumnCount = tableData.header.length;
-    var bodyColumnCounts = tableData.rows.map(function (row) { return row.length; });
+    var headerColumnCount = inputData.inputDataHeader.length;
+    var bodyColumnCounts = inputData.inputDataBody.map(function (currentRow) { return currentRow.length; });
     var maxColumnCount = Math.max.apply(Math, __spreadArray([headerColumnCount], bodyColumnCounts, false));
-    var columnWidths = adjustColumnWidths
-        ? calculateColumnWidths(__spreadArray([tableData.header], tableData.rows, true), maxColumnCount)
+    var columnWidths = canAdjustColumnWidths
+        ? calculateColumnWidths(__spreadArray([inputData.inputDataHeader], inputData.inputDataBody, true), maxColumnCount)
         : undefined;
-    var markdownHeaderRow = formatMarkdownRow(maxColumnCount, tableData.header, columnAlignments, columnWidths, useTabs, replaceNewlines);
+    var markdownHeaderRow = formatMarkdownRow(maxColumnCount, inputData.inputDataHeader, columnAlignments, columnWidths, useTabs, replaceNewlines);
     var markdownAlignmentRow = formatAlignmentRow(maxColumnCount, columnAlignments, columnWidths, useTabs);
-    var markdownBodyRows = tableData.rows
-        .map(function (row) {
-        return formatMarkdownRow(maxColumnCount, row, columnAlignments, columnWidths, useTabs, replaceNewlines);
+    var markdownBodyRows = inputData.inputDataBody
+        .map(function (currentRow) {
+        return formatMarkdownRow(maxColumnCount, currentRow, columnAlignments, columnWidths, useTabs, replaceNewlines);
     })
         .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));
-    }
-    return headers;
+/**
+ * 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>');
 }
+/**
+ * Converts a zero-based column index to its corresponding Excel-style column name.
+ * For example, 0 -> 'A', 1 -> 'B', ..., 25 -> 'Z', 26 -> 'AA', etc.
+ * @param index - The zero-based column index.
+ * @returns The corresponding column name.
+ */
 function getColumnName(index) {
-    var name = '';
+    var columnName = '';
     var currentIndex = index;
     while (currentIndex >= 0) {
-        name = String.fromCharCode((currentIndex % 26) + 65) + name;
+        columnName = String.fromCharCode((currentIndex % 26) + 65) + columnName;
         currentIndex = Math.floor(currentIndex / 26) - 1;
     }
-    return name;
+    return columnName;
 }
+/**
+ * Generates an array of alphabetic headers based on the specified column count.
+ * @param columnCount - The number of columns.
+ * @returns An array of column header names.
+ */
+function generateAlphabetHeaders(columnCount) {
+    var alphabetHeaders = [];
+    for (var i = 0; i < columnCount; i++) {
+        alphabetHeaders.push(getColumnName(i));
+    }
+    return alphabetHeaders;
+}
+
+// CSS styles
+var PRISM_CSS = "\ncode[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}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}code[class*=language-] ::selection,code[class*=language-]::selection,pre[class*=language-] ::selection,pre[class*=language-]::selection{text-shadow:none;background:#b3d4fc}@media print{code[class*=language-],pre[class*=language-]{text-shadow:none}}pre[class*=language-]{padding:1em;margin:.5em 0;overflow:auto}:not(pre)>code[class*=language-],pre[class*=language-]{background:#f5f2f0}:not(pre)>code[class*=language-]{padding:.1em;border-radius:.3em;white-space:normal}pre[class*=language-].line-numbers{position:relative;padding-left:3.8em;counter-reset:linenumber}pre[class*=language-].line-numbers>code{position:relative;white-space:inherit}.line-numbers .line-numbers-rows{position:absolute;pointer-events:none;top:0;font-size:100%;left:-3.8em;width:3em;letter-spacing:-1px;border-right:1px solid #999;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}.line-numbers-rows>span{display:block;counter-increment:linenumber}.line-numbers-rows>span:before{content:counter(linenumber);color:#999;display:block;padding-right:.8em;text-align:right}\n";
 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;
+    var _b = _a.inputData, inputData = _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;
     var adjustColumnWidths = !isCompact;
-    var preRef = require$$0.useRef(null);
-    var markdownSyntax = require$$0.useMemo(function () {
-        if (data === null) {
+    var preElementRef = require$$0.useRef(null);
+    var markdownTableSyntax = require$$0.useMemo(function () {
+        if (inputData === null) {
             return 'Error: No data provided for the table.';
         }
         try {
-            if (!Array.isArray(data) || data.length === 0) {
+            if (!Array.isArray(inputData) || inputData.length === 0) {
                 throw new MarkdownTableError("The 'data' prop must be a non-empty two-dimensional array.");
             }
             var tableData = hasHeader
                 ? {
-                    header: data[0],
-                    rows: data.slice(1),
+                    inputDataHeader: inputData[0],
+                    inputDataBody: inputData.slice(1),
                 }
                 : {
-                    header: generateAlphabetHeaders(data[0].length),
-                    rows: data,
+                    inputDataHeader: generateAlphabetHeaders(inputData[0].length),
+                    inputDataBody: inputData,
                 };
             return generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, hasTabs, canReplaceNewlines);
         }
@@ -4208,7 +4266,7 @@ var MarkdownTable = function (_a) {
             }
         }
     }, [
-        data,
+        inputData,
         hasHeader,
         columnAlignments,
         isCompact,
@@ -4217,15 +4275,15 @@ var MarkdownTable = function (_a) {
     ]);
     require$$0.useEffect(function () {
         if (onTableCreate) {
-            onTableCreate(markdownSyntax);
+            onTableCreate(markdownTableSyntax);
         }
-    }, [markdownSyntax, onTableCreate]);
+    }, [markdownTableSyntax, onTableCreate]);
     require$$0.useEffect(function () {
-        if (preRef.current) {
-            Prism$1.highlightElement(preRef.current.querySelector('code'));
+        if (preElementRef.current) {
+            Prism$1.highlightElement(preElementRef.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", { className: "language-markdown", role: "code", children: markdownSyntax }) })] }));
+    }, [markdownTableSyntax]);
+    return (jsxRuntimeExports.jsxs(jsxRuntimeExports.Fragment, { children: [jsxRuntimeExports.jsx("style", { children: PRISM_CSS }), jsxRuntimeExports.jsx("pre", { ref: preElementRef, className: "".concat(className, " language-markdown line-numbers"), children: jsxRuntimeExports.jsx("code", { className: "language-markdown", role: "code", children: markdownTableSyntax }) })] }));
 };
 
 exports.MarkdownTable = MarkdownTable;