react-markdown-table-ts 0.2.5 → 0.3.1

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/errors.js

@@ -0,0 +1,31 @@
+// src/errors.ts
+var __extends = (this && this.__extends) || (function () {
+    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);
+    };
+    return function (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 __());
+    };
+})();
+/**
+ * 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));
+export { MarkdownTableError };
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,gBAAgB;;;;;;;;;;;;;;;;AAEhB;;GAEG;AACH;IAAwC,sCAAK;IAC3C,4BAAY,OAAe;QAA3B,YACE,kBAAM,OAAO,CAAC,SAGf;QAFC,KAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,KAAI,EAAE,kBAAkB,CAAC,SAAS,CAAC,CAAC;;IAC5D,CAAC;IACH,yBAAC;AAAD,CAAC,AAND,CAAwC,KAAK,GAM5C"}

package/dist/helpers.js

@@ -0,0 +1,93 @@
+// src/helpers.ts
+var __spreadArray = (this && this.__spreadArray) || function (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));
+};
+/**
+ * Calculates the maximum width for each column based on the content.
+ * @param params - The parameters for column width calculation.
+ * @returns An array of maximum widths for each column.
+ */
+export function calculateColumnWidths(_a) {
+    var allRows = _a.allRows, maxColumnCount = _a.maxColumnCount;
+    return allRows.reduce(function (widths, row) {
+        var _a, _b;
+        for (var i = 0; i < maxColumnCount; i++) {
+            var cell = (_a = row[i]) !== null && _a !== void 0 ? _a : '';
+            widths[i] = Math.max((_b = widths[i]) !== null && _b !== void 0 ? _b : 3, cell.length);
+        }
+        return widths;
+    }, new Array(maxColumnCount).fill(3));
+}
+/**
+ * Formats a single row into a Markdown-formatted string.
+ * @param params - The parameters for row formatting.
+ * @returns The Markdown string for the row.
+ */
+export function formatMarkdownRow(_a) {
+    var _b, _c;
+    var columnCount = _a.columnCount, row = _a.row, _d = _a.columnAlignments, columnAlignments = _d === void 0 ? [] : _d, columnWidths = _a.columnWidths;
+    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 = (_b = row[i]) !== null && _b !== void 0 ? _b : '';
+        var alignment = (_c = adjustedAlignments[i]) !== null && _c !== void 0 ? _c : defaultAlignment;
+        var targetWidth = columnWidths ? columnWidths[i] : cell.length;
+        if (alignment === 'right') {
+            markdownRow += " ".concat(cell.padStart(targetWidth), " |");
+        }
+        else if (alignment === 'center') {
+            var totalPadding = targetWidth - cell.length;
+            var paddingLeft = Math.floor(totalPadding / 2);
+            var paddingRight = totalPadding - paddingLeft;
+            markdownRow += " ".concat(' '.repeat(paddingLeft)).concat(cell).concat(' '.repeat(paddingRight), " |");
+        }
+        else {
+            // Left alignment or default
+            markdownRow += " ".concat(cell.padEnd(targetWidth), " |");
+        }
+    }
+    return markdownRow;
+}
+/**
+ * Generates the alignment row for the Markdown table syntax.
+ * @param params - The parameters for alignment row generation.
+ * @returns The Markdown string for the alignment row.
+ */
+export function formatAlignmentRow(_a) {
+    var _b;
+    var columnCount = _a.columnCount, _c = _a.columnAlignments, columnAlignments = _c === void 0 ? [] : _c, columnWidths = _a.columnWidths;
+    var defaultAlignment = 'left';
+    var adjustedAlignments = columnAlignments.length < columnCount
+        ? __spreadArray(__spreadArray([], columnAlignments, true), Array(columnCount - columnAlignments.length).fill(defaultAlignment), true) : columnAlignments;
+    var alignmentRow = '|';
+    for (var i = 0; i < columnCount; i++) {
+        var alignment = (_b = adjustedAlignments[i]) !== null && _b !== void 0 ? _b : defaultAlignment;
+        var targetWidth = columnWidths ? columnWidths[i] : 3;
+        var alignIndicator = '';
+        switch (alignment) {
+            case 'left':
+                alignIndicator = ":".concat('-'.repeat(targetWidth - 1));
+                break;
+            case 'center':
+                alignIndicator = ":".concat('-'.repeat(targetWidth - 2), ":");
+                break;
+            case 'right':
+                alignIndicator = "".concat('-'.repeat(targetWidth - 1), ":");
+                break;
+            default:
+                alignIndicator = "".concat('-'.repeat(targetWidth));
+                break;
+        }
+        alignmentRow += " ".concat(alignIndicator, " |");
+    }
+    return alignmentRow;
+}
+//# sourceMappingURL=helpers.js.map

package/dist/helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAAA,iBAAiB;;;;;;;;;;AAQjB;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,EAMrC;QALC,OAAO,aAAA,EACP,cAAc,oBAAA;IAKd,OAAO,OAAO,CAAC,MAAM,CAAC,UAAC,MAAM,EAAE,GAAG;;QAChC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,cAAc,EAAE,CAAC,EAAE,EAAE;YACvC,IAAM,IAAI,GAAG,MAAA,GAAG,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;YAC1B,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,MAAA,MAAM,CAAC,CAAC,CAAC,mCAAI,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;SACnD;QACD,OAAO,MAAM,CAAC;IAChB,CAAC,EAAE,IAAI,KAAK,CAAS,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,EAUjC;;QATC,WAAW,iBAAA,EACX,GAAG,SAAA,EACH,wBAAqB,EAArB,gBAAgB,mBAAG,EAAE,KAAA,EACrB,YAAY,kBAAA;IAOZ,IAAM,gBAAgB,GAAyC,MAAM,CAAC;IACtE,IAAM,kBAAkB,GACtB,gBAAgB,CAAC,MAAM,GAAG,WAAW;QACnC,CAAC,iCACM,gBAAgB,SAChB,KAAK,CAAC,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,CAClD,gBAAgB,CACjB,QAEL,CAAC,CAAC,gBAAgB,CAAC;IAEvB,IAAI,WAAW,GAAG,GAAG,CAAC;IACtB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,IAAM,IAAI,GAAG,MAAA,GAAG,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC1B,IAAM,SAAS,GAAG,MAAA,kBAAkB,CAAC,CAAC,CAAC,mCAAI,gBAAgB,CAAC;QAC5D,IAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC;QAEjE,IAAI,SAAS,KAAK,OAAO,EAAE;YACzB,WAAW,IAAI,WAAI,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,OAAI,CAAC;SACnD;aAAM,IAAI,SAAS,KAAK,QAAQ,EAAE;YACjC,IAAM,YAAY,GAAG,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC;YAC/C,IAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;YACjD,IAAM,YAAY,GAAG,YAAY,GAAG,WAAW,CAAC;YAChD,WAAW,IAAI,WAAI,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,SAAG,IAAI,SAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,OAAI,CAAC;SAClF;aAAM;YACL,4BAA4B;YAC5B,WAAW,IAAI,WAAI,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,OAAI,CAAC;SACjD;KACF;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAQlC;;QAPC,WAAW,iBAAA,EACX,wBAAqB,EAArB,gBAAgB,mBAAG,EAAE,KAAA,EACrB,YAAY,kBAAA;IAMZ,IAAM,gBAAgB,GAAyC,MAAM,CAAC;IACtE,IAAM,kBAAkB,GACtB,gBAAgB,CAAC,MAAM,GAAG,WAAW;QACnC,CAAC,iCACM,gBAAgB,SAChB,KAAK,CAAC,WAAW,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC,IAAI,CAClD,gBAAgB,CACjB,QAEL,CAAC,CAAC,gBAAgB,CAAC;IAEvB,IAAI,YAAY,GAAG,GAAG,CAAC;IACvB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,IAAM,SAAS,GAAG,MAAA,kBAAkB,CAAC,CAAC,CAAC,mCAAI,gBAAgB,CAAC;QAC5D,IAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACvD,IAAI,cAAc,GAAG,EAAE,CAAC;QAExB,QAAQ,SAAS,EAAE;YACjB,KAAK,MAAM;gBACT,cAAc,GAAG,WAAI,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,CAAE,CAAC;gBACnD,MAAM;YACR,KAAK,QAAQ;gBACX,cAAc,GAAG,WAAI,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,MAAG,CAAC;gBACpD,MAAM;YACR,KAAK,OAAO;gBACV,cAAc,GAAG,UAAG,GAAG,CAAC,MAAM,CAAC,WAAW,GAAG,CAAC,CAAC,MAAG,CAAC;gBACnD,MAAM;YACR;gBACE,cAAc,GAAG,UAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,CAAE,CAAC;gBAC9C,MAAM;SACT;QAED,YAAY,IAAI,WAAI,cAAc,OAAI,CAAC;KACxC;IAED,OAAO,YAAY,CAAC;AACtB,CAAC"}

package/dist/index.cjs.js

@@ -4058,7 +4058,7 @@ 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";
+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 MarkdownTableError = /** @class */ (function (_super) {
     __extends(MarkdownTableError, _super);
     function MarkdownTableError(message) {
@@ -4177,25 +4177,25 @@ function getColumnName(index) {
     return name;
 }
 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),
+                    header: inputData[0],
+                    rows: inputData.slice(1),
                 }
                 : {
-                    header: generateAlphabetHeaders(data[0].length),
-                    rows: data,
+                    header: generateAlphabetHeaders(inputData[0].length),
+                    rows: inputData,
                 };
             return generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, hasTabs, canReplaceNewlines);
         }
@@ -4208,7 +4208,7 @@ var MarkdownTable = function (_a) {
             }
         }
     }, [
-        data,
+        inputData,
         hasHeader,
         columnAlignments,
         isCompact,
@@ -4217,15 +4217,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", { 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;