react-markdown-table-ts 0.3.15 → 0.4.1

package/dist/types.d.ts

@@ -1,13 +1,13 @@
 /**
- * Represents a single row of data in the input table, consisting of cells.
+ * Represents a single row in a table, consisting of cells.
  */
-export type InputTableRowData = readonly string[];
+export type TableRow = readonly string[];
 /**
- * Represents the structure of the input table.
+ * Represents the structure of a Markdown table.
  */
-export interface InputTableData {
-    inputTableHeader: string[];
-    inputTableBody: readonly string[][];
+export interface InputData {
+    inputDataHeader: string[];
+    inputDataBody: readonly string[][];
 }
 /**
  * Props for the MarkdownTable component.

package/dist/utils.d.ts

@@ -1,13 +1,11 @@
-import { InputTableData, InputTableRowData } from './types';
+import { TableRow, InputData } from './types';
 /**
- * Calculates the maximum width for each column based on the content and newline replacement rules.
- * @param inputDataRows - All rows (header and body) of the input table.
- * @param maxColumnCount - The maximum number of columns in the input table.
- * @param minWidth - The minimum width for each column. Defaults to 3.
- * @param canReplaceNewlines - Whether to replace newlines with '<br>' (affects width) or a space.
+ * 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.
  */
-export declare function calculateColumnWidths(inputDataRows: readonly InputTableRowData[], maxColumnCount: number, minWidth: number | undefined, canReplaceNewlines: boolean): number[];
+export declare function calculateColumnWidths(tableRows: readonly TableRow[], maxColumnCount: number): number[];
 /**
  * Formats a single row into a Markdown-formatted string.
  * @param columnCount - The number of columns in the table.
@@ -18,7 +16,7 @@ export declare function calculateColumnWidths(inputDataRows: readonly InputTable
  * @param canReplaceNewlines - Flag to replace newlines with <br> tags.
  * @returns The Markdown string for the row.
  */
-export declare function formatMarkdownTableBody(columnCount: number, currentRow: InputTableRowData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean, canReplaceNewlines?: boolean): string;
+export declare function formatMarkdownRow(columnCount: number, currentRow: TableRow, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean, canReplaceNewlines?: boolean): string;
 /**
  * Generates the alignment row for the Markdown table syntax.
  * @param columnCount - The number of columns in the table.
@@ -27,7 +25,7 @@ export declare function formatMarkdownTableBody(columnCount: number, currentRow:
  * @param useTabs - Flag to use tabs between columns.
  * @returns The Markdown string for the alignment row.
  */
-export declare function formatMarkdownTableAlignmentRow(columnCount: number, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean): string;
+export declare function formatAlignmentRow(columnCount: number, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean): string;
 /**
  * Generates a complete Markdown table string from the provided data.
  * @param inputData - The table data including headers and rows.
@@ -37,7 +35,13 @@ export declare function formatMarkdownTableAlignmentRow(columnCount: number, col
  * @param replaceNewlines - Flag to replace newlines with <br> tags.
  * @returns The complete Markdown table string.
  */
-export declare function generateMarkdownTableString(inputData: InputTableData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean): string;
+export declare function generateMarkdownTableString(inputData: InputData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean): string;
+/**
+ * Replaces newline characters in a string with <br> tags.
+ * @param cell - The cell content to process.
+ * @returns The processed cell content with newlines replaced.
+ */
+export declare function replaceNewlinesInCell(cell: string): string;
 /**
  * Converts a zero-based column index to its corresponding Excel-style column name.
  * For example, 0 -> 'A', 1 -> 'B', ..., 25 -> 'Z', 26 -> 'AA', etc.

package/package.json

@@ -1,75 +1,78 @@
-{
-  "name": "react-markdown-table-ts",
-  "version": "0.3.15",
-  "description": "A React component that converts structured data into Markdown table syntax and displays it within a `<pre>` tag.",
-  "main": "dist/index.cjs.js",
-  "module": "dist/index.esm.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "scripts": {
-    "build": "rollup -c",
-    "type-check": "tsc --noEmit",
-    "prepublishOnly": "npm run build",
-    "prepare": "npm run build",
-    "lint": "gts lint",
-    "clean": "gts clean",
-    "compile": "tsc",
-    "fix": "gts fix",
-    "pretest": "npm run compile",
-    "posttest": "npm run lint",
-    "test": "jest --config jest.config.js --coverage",
-    "test:watch": "jest --config jest.config.js --watch",
-    "test:ci": "jest --config jest.config.js --coverage --ci",
-    "release": "standard-version"
-  },
-  "keywords": [
-    "markdown",
-    "md",
-    "table",
-    "tables",
-    "react",
-    "ts",
-    "typescript",
-    "types",
-    "typed",
-    "generate",
-    "generator",
-    "convert",
-    "converter"
-  ],
-  "author": "Keith Walsh",
-  "license": "MIT",
-  "repository": "https://github.com/keithwalsh/react-markdown-table-ts.git",
-  "peerDependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^26.0.3",
-    "@rollup/plugin-node-resolve": "^15.3.0",
-    "@rollup/plugin-typescript": "^11.1.6",
-    "@testing-library/jest-dom": "^6.5.0",
-    "@testing-library/react": "^16.0.1",
-    "@types/jest": "^29.5.13",
-    "@types/node": "20.12.7",
-    "@types/prismjs": "^1.26.4",
-    "@types/react": "^18.3.8",
-    "@types/react-dom": "^18.3.0",
-    "gts": "^5.3.1",
-    "identity-obj-proxy": "^3.0.0",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
-    "rollup": "^2.79.1",
-    "rollup-plugin-typescript2": "^0.36.0",
-    "standard-version": "^9.5.0",
-    "ts-jest": "^29.2.5",
-    "typescript": "^5.1.6"
-  },
-  "dependencies": {
-    "prismjs": "^1.29.0"
-  }
-}
+{
+  "name": "react-markdown-table-ts",
+  "version": "0.4.1",
+  "description": "A React component that converts structured data into Markdown table syntax and displays it within a `<pre>` tag.",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "type-check": "tsc --noEmit",
+    "prepublishOnly": "npm run build",
+    "prepare": "npm run build",
+    "lint": "gts lint",
+    "clean": "gts clean",
+    "compile": "tsc",
+    "fix": "gts fix",
+    "pretest": "npm run compile",
+    "posttest": "npm run lint",
+    "test": "jest --config jest.config.js --coverage",
+    "test:watch": "jest --config jest.config.js --watch",
+    "test:ci": "jest --config jest.config.js --coverage --ci",
+    "release": "standard-version"
+  },
+  "keywords": [
+    "markdown",
+    "md",
+    "table",
+    "tables",
+    "react",
+    "ts",
+    "typescript",
+    "types",
+    "typed",
+    "generate",
+    "generator",
+    "convert",
+    "converter"
+  ],
+  "author": "Keith Walsh",
+  "license": "MIT",
+  "repository": "https://github.com/keithwalsh/react-markdown-table-ts.git",
+  "peerDependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^26.0.3",
+    "@rollup/plugin-node-resolve": "^15.3.0",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@testing-library/jest-dom": "^6.5.0",
+    "@testing-library/react": "^16.0.1",
+    "@types/jest": "^29.5.13",
+    "@types/node": "20.12.7",
+    "@types/prismjs": "^1.26.4",
+    "@types/react": "^18.3.8",
+    "@types/react-dom": "^18.3.0",
+    "gts": "^5.3.1",
+    "identity-obj-proxy": "^3.0.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rollup": "^2.79.1",
+    "rollup-plugin-typescript2": "^0.36.0",
+    "standard-version": "^9.5.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@emotion/react": "^11.13.5",
+    "@emotion/styled": "^11.13.5",
+    "@mui/material": "^6.1.8",
+    "prismjs": "^1.29.0"
+  }
+}

package/dist/jest.setup.d.ts

@@ -1,2 +0,0 @@
-import '@testing-library/jest-dom';
-import '@testing-library/react';

package/dist/jest.setup.js

@@ -1,3 +0,0 @@
-import '@testing-library/jest-dom';
-import '@testing-library/react';
-//# sourceMappingURL=jest.setup.js.map

package/dist/jest.setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"jest.setup.js","sourceRoot":"","sources":["../jest.setup.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC;AACnC,OAAO,wBAAwB,CAAC"}

package/dist/src/index.d.ts

@@ -1,5 +0,0 @@
-import React from 'react';
-import 'prismjs/components/prism-markdown';
-import 'prismjs/plugins/line-numbers/prism-line-numbers';
-import { MarkdownTableProps } from './types';
-export declare const MarkdownTable: React.FC<MarkdownTableProps>;

package/dist/src/index.js

@@ -1,62 +0,0 @@
-import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
-// src/index.tsx
-import { useEffect, useMemo, useRef } from 'react';
-import Prism from 'prismjs';
-import 'prismjs/components/prism-markdown';
-import 'prismjs/plugins/line-numbers/prism-line-numbers';
-import { MarkdownTableError } from './validation';
-import { generateMarkdownTableString, generateAlphabetHeaders } from './utils';
-// 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";
-export var MarkdownTable = function (_a) {
-    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 preElementRef = useRef(null);
-    var markdownTableSyntax = useMemo(function () {
-        if (inputData === null) {
-            return 'Error: No data provided for the table.';
-        }
-        try {
-            if (!Array.isArray(inputData) || inputData.length === 0) {
-                throw new MarkdownTableError("The 'data' prop must be a non-empty two-dimensional array.");
-            }
-            var tableData = hasHeader
-                ? {
-                    inputTableHeader: inputData[0],
-                    inputTableBody: inputData.slice(1),
-                }
-                : {
-                    inputTableHeader: generateAlphabetHeaders(inputData[0].length),
-                    inputTableBody: inputData,
-                };
-            return generateMarkdownTableString(tableData, columnAlignments, adjustColumnWidths, hasTabs, canReplaceNewlines);
-        }
-        catch (error) {
-            if (error instanceof MarkdownTableError) {
-                return "Error: ".concat(error.message);
-            }
-            else {
-                throw error;
-            }
-        }
-    }, [
-        inputData,
-        hasHeader,
-        columnAlignments,
-        isCompact,
-        hasTabs,
-        canReplaceNewlines,
-    ]);
-    useEffect(function () {
-        if (onTableCreate) {
-            onTableCreate(markdownTableSyntax);
-        }
-    }, [markdownTableSyntax, onTableCreate]);
-    useEffect(function () {
-        if (preElementRef.current) {
-            Prism.highlightElement(preElementRef.current.querySelector('code'));
-        }
-    }, [markdownTableSyntax]);
-    return (_jsxs(_Fragment, { children: [_jsx("style", { children: PRISM_CSS }), _jsx("pre", { ref: preElementRef, className: "".concat(className, " language-markdown line-numbers"), children: _jsx("code", { className: "language-markdown", role: "code", children: markdownTableSyntax }) })] }));
-};
-//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.tsx"],"names":[],"mappings":";AAAA,gBAAgB;AAEhB,OAAc,EAAC,SAAS,EAAE,OAAO,EAAE,MAAM,EAAC,MAAM,OAAO,CAAC;AACxD,OAAO,KAAK,MAAM,SAAS,CAAC;AAC5B,OAAO,mCAAmC,CAAC;AAC3C,OAAO,iDAAiD,CAAC;AAEzD,OAAO,EAAC,kBAAkB,EAAC,MAAM,cAAc,CAAC;AAChD,OAAO,EAAC,2BAA2B,EAAE,uBAAuB,EAAC,MAAM,SAAS,CAAC;AAC7E,aAAa;AACb,IAAM,SAAS,GAAG,koDAEjB,CAAC;AAEF,MAAM,CAAC,IAAM,aAAa,GAAiC,UAAC,EAS3D;QARC,iBAAgB,EAAhB,SAAS,mBAAG,IAAI,KAAA,EAChB,iBAAgB,EAAhB,SAAS,mBAAG,IAAI,KAAA,EAChB,wBAAqB,EAArB,gBAAgB,mBAAG,EAAE,KAAA,EACrB,iBAAiB,EAAjB,SAAS,mBAAG,KAAK,KAAA,EACjB,eAAe,EAAf,OAAO,mBAAG,KAAK,KAAA,EACf,0BAA0B,EAA1B,kBAAkB,mBAAG,KAAK,KAAA,EAC1B,SAAS,eAAA,EACT,aAAa,mBAAA;IAEb,IAAM,kBAAkB,GAAG,CAAC,SAAS,CAAC;IACtC,IAAM,aAAa,GAAG,MAAM,CAAiB,IAAI,CAAC,CAAC;IAEnD,IAAM,mBAAmB,GAAG,OAAO,CAAC;QAClC,IAAI,SAAS,KAAK,IAAI,EAAE;YACtB,OAAO,wCAAwC,CAAC;SACjD;QACD,IAAI;YACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvD,MAAM,IAAI,kBAAkB,CAC1B,4DAA4D,CAC7D,CAAC;aACH;YAED,IAAM,SAAS,GAAG,SAAS;gBACzB,CAAC,CAAC;oBACE,gBAAgB,EAAE,SAAS,CAAC,CAAC,CAAC;oBAC9B,cAAc,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;iBACnC;gBACH,CAAC,CAAC;oBACE,gBAAgB,EAAE,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;oBAC9D,cAAc,EAAE,SAAS;iBAC1B,CAAC;YAEN,OAAO,2BAA2B,CAChC,SAAS,EACT,gBAAgB,EAChB,kBAAkB,EAClB,OAAO,EACP,kBAAkB,CACnB,CAAC;SACH;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,kBAAkB,EAAE;gBACvC,OAAO,iBAAU,KAAK,CAAC,OAAO,CAAE,CAAC;aAClC;iBAAM;gBACL,MAAM,KAAK,CAAC;aACb;SACF;IACH,CAAC,EAAE;QACD,SAAS;QACT,SAAS;QACT,gBAAgB;QAChB,SAAS;QACT,OAAO;QACP,kBAAkB;KACnB,CAAC,CAAC;IAEH,SAAS,CAAC;QACR,IAAI,aAAa,EAAE;YACjB,aAAa,CAAC,mBAAmB,CAAC,CAAC;SACpC;IACH,CAAC,EAAE,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC,CAAC;IAEzC,SAAS,CAAC;QACR,IAAI,aAAa,CAAC,OAAO,EAAE;YACzB,KAAK,CAAC,gBAAgB,CACpB,aAAa,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAgB,CAC3D,CAAC;SACH;IACH,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAE1B,OAAO,CACL,8BACE,0BAAQ,SAAS,GAAS,EAC1B,cACE,GAAG,EAAE,aAAa,EAClB,SAAS,EAAE,UAAG,SAAS,oCAAiC,YAExD,eAAM,SAAS,EAAC,mBAAmB,EAAC,IAAI,EAAC,MAAM,YAC5C,mBAAmB,GACf,GACH,IACL,CACJ,CAAC;AACJ,CAAC,CAAC"}

package/dist/src/types.d.ts

@@ -1,56 +0,0 @@
-/**
- * Represents a single row of data in the input table, consisting of cells.
- */
-export type InputTableRowData = readonly string[];
-/**
- * Represents the structure of the input table.
- */
-export interface InputTableData {
-    inputTableHeader: string[];
-    inputTableBody: readonly string[][];
-}
-/**
- * Props for the MarkdownTable component.
- */
-export interface MarkdownTableProps {
-    /**
-     * The entire table data as a two-dimensional array.
-     * If `hasHeader` is true, the first row is treated as the header.
-     * @default null
-     */
-    inputData?: string[][] | null;
-    /**
-     * Indicates whether the first row of `data` is a header.
-     * @default true
-     */
-    hasHeader?: boolean;
-    /**
-     * Optional array specifying the alignment for each column.
-     * Acceptable values are 'left', 'center', 'right', or 'none'.
-     */
-    columnAlignments?: readonly ('left' | 'center' | 'right' | 'none')[];
-    /**
-     * Optional flag to provide a compact version of the table with minimal column widths.
-     * When `true`, column widths are not adjusted based on content.
-     * @default false
-     */
-    isCompact?: boolean;
-    /**
-     * Optional flag to add tabs between columns in the Markdown table.
-     * @default false
-     */
-    hasTabs?: boolean;
-    /**
-     * Optional CSS class for styling the rendered Markdown table.
-     */
-    className?: string;
-    /**
-     * Optional flag to replace newlines with <br> tags in table cells.
-     * @default false
-     */
-    canReplaceNewlines?: boolean;
-    /**
-     * Optional callback function to receive the generated Markdown table string.
-     */
-    onTableCreate?: (markdownTableString: string) => void;
-}

package/dist/src/types.js

@@ -1,3 +0,0 @@
-// src/types.ts
-export {};
-//# sourceMappingURL=types.js.map

package/dist/src/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA,eAAe"}

package/dist/src/utils.d.ts

@@ -1,58 +0,0 @@
-import { InputTableData, InputTableRowData } from './types';
-/**
- * Calculates the maximum width for each column based on the content.
- * @param inputDataRows - All rows (header and body) of the input table.
- * @param maxColumnCount - The maximum number of columns in the input table.
- * @param minWidth - The minimum width for each column. Defaults to 3.
- * @returns An array of maximum widths for each column.
- */
-export declare function calculateColumnWidths(inputDataRows: readonly InputTableRowData[], maxColumnCount: number, minWidth?: number): number[];
-/**
- * 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.
- */
-export declare function formatMarkdownRow(columnCount: number, currentRow: InputTableRowData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean, canReplaceNewlines?: boolean): string;
-/**
- * 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.
- */
-export declare function formatAlignmentRow(columnCount: number, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean): string;
-/**
- * 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.
- */
-export declare function generateMarkdownTableString(inputData: InputTableData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], canAdjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean): string;
-/**
- * Replaces newline characters in a string with <br> tags.
- * @param cell - The cell content to process.
- * @returns The processed cell content with newlines replaced.
- */
-export declare function replaceNewlinesInCell(cell: string): string;
-/**
- * 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.
- */
-export declare function getColumnName(index: number): string;
-/**
- * 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.
- */
-export declare function generateAlphabetHeaders(columnCount: number): string[];

package/dist/src/utils.js

@@ -1,179 +0,0 @@
-// src/utils.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 inputDataRows - All rows (header and body) of the input table.
- * @param maxColumnCount - The maximum number of columns in the input table.
- * @param minWidth - The minimum width for each column. Defaults to 3.
- * @returns An array of maximum widths for each column.
- */
-export function calculateColumnWidths(inputDataRows, maxColumnCount, minWidth) {
-    if (minWidth === void 0) { minWidth = 3; }
-    // Initialize column widths with the minimum width.
-    var columnWidths = Array.from({ length: maxColumnCount }, function () { return minWidth; });
-    // Iterate over each row in the input data.
-    for (var _i = 0, inputDataRows_1 = inputDataRows; _i < inputDataRows_1.length; _i++) {
-        var currentRow = inputDataRows_1[_i];
-        // Iterate over each column index up to maxColumnCount.
-        for (var columnIndex = 0; columnIndex < maxColumnCount; columnIndex++) {
-            // Retrieve the cell value; default to an empty string if undefined or null.
-            var cellValue = currentRow[columnIndex];
-            var cellString = cellValue !== null && cellValue !== undefined ? String(cellValue) : '';
-            // Update the column width if the current cell's length is greater.
-            if (cellString.length > columnWidths[columnIndex]) {
-                columnWidths[columnIndex] = cellString.length;
-            }
-        }
-    }
-    return columnWidths;
-}
-/**
- * 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.
- */
-export function formatMarkdownRow(columnCount, currentRow, columnAlignments, columnWidths, useTabs, canReplaceNewlines) {
-    var _a, _b;
-    if (useTabs === void 0) { useTabs = 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 = currentRow[i]) !== null && _a !== void 0 ? _a : '';
-        if (canReplaceNewlines) {
-            cell = replaceNewlinesInCell(cell);
-        }
-        var alignment = (_b = adjustedAlignments[i]) !== null && _b !== void 0 ? _b : defaultAlignment;
-        var targetWidth = columnWidths ? columnWidths[i] : cell.length;
-        if (alignment === 'right') {
-            markdownRow += "".concat(useTabs ? '\t' : ' ').concat(cell.padStart(targetWidth)).concat(useTabs ? '\t' : ' ', "|");
-        }
-        else if (alignment === 'center') {
-            var totalPadding = targetWidth - cell.length;
-            var paddingLeft = Math.floor(totalPadding / 2);
-            var paddingRight = totalPadding - paddingLeft;
-            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.
- */
-export function formatAlignmentRow(columnCount, columnAlignments, columnWidths, useTabs) {
-    var _a;
-    if (useTabs === void 0) { useTabs = false; }
-    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 = (_a = adjustedAlignments[i]) !== null && _a !== void 0 ? _a : 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(useTabs ? '\t' : ' ').concat(alignIndicator).concat(useTabs ? '\t' : ' ', "|");
-    }
-    return alignmentRow;
-}
-/**
- * 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.
- */
-export 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 = inputData.inputTableHeader.length;
-    var bodyColumnCounts = inputData.inputTableBody.map(function (currentRow) { return currentRow.length; });
-    var maxColumnCount = Math.max.apply(Math, __spreadArray([headerColumnCount], bodyColumnCounts, false));
-    var columnWidths = canAdjustColumnWidths
-        ? calculateColumnWidths(__spreadArray([inputData.inputTableHeader], inputData.inputTableBody, true), maxColumnCount)
-        : undefined;
-    var markdownHeaderRow = formatMarkdownRow(maxColumnCount, inputData.inputTableHeader, columnAlignments, columnWidths, useTabs, replaceNewlines);
-    var markdownAlignmentRow = formatAlignmentRow(maxColumnCount, columnAlignments, columnWidths, useTabs);
-    var markdownBodyRows = inputData.inputTableBody
-        .map(function (currentRow) {
-        return formatMarkdownRow(maxColumnCount, currentRow, columnAlignments, columnWidths, useTabs, replaceNewlines);
-    })
-        .join('\n');
-    return "".concat(markdownHeaderRow, "\n").concat(markdownAlignmentRow, "\n").concat(markdownBodyRows).trimEnd();
-}
-/**
- * Replaces newline characters in a string with <br> tags.
- * @param cell - The cell content to process.
- * @returns The processed cell content with newlines replaced.
- */
-export 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.
- */
-export function getColumnName(index) {
-    var columnName = '';
-    var currentIndex = index;
-    while (currentIndex >= 0) {
-        columnName = String.fromCharCode((currentIndex % 26) + 65) + columnName;
-        currentIndex = Math.floor(currentIndex / 26) - 1;
-    }
-    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.
- */
-export function generateAlphabetHeaders(columnCount) {
-    var alphabetHeaders = [];
-    for (var i = 0; i < columnCount; i++) {
-        alphabetHeaders.push(getColumnName(i));
-    }
-    return alphabetHeaders;
-}
-//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AAAA,eAAe;;;;;;;;;;AAIf;;;;;;GAMG;AACH,MAAM,UAAU,qBAAqB,CACnC,aAA2C,EAC3C,cAAsB,EACtB,QAAY;IAAZ,yBAAA,EAAA,YAAY;IAEZ,mDAAmD;IACnD,IAAM,YAAY,GAAa,KAAK,CAAC,IAAI,CACvC,EAAC,MAAM,EAAE,cAAc,EAAC,EACxB,cAAM,OAAA,QAAQ,EAAR,CAAQ,CACf,CAAC;IAEF,2CAA2C;IAC3C,KAAyB,UAAa,EAAb,+BAAa,EAAb,2BAAa,EAAb,IAAa,EAAE;QAAnC,IAAM,UAAU,sBAAA;QACnB,uDAAuD;QACvD,KAAK,IAAI,WAAW,GAAG,CAAC,EAAE,WAAW,GAAG,cAAc,EAAE,WAAW,EAAE,EAAE;YACrE,4EAA4E;YAC5E,IAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;YAC1C,IAAM,UAAU,GACd,SAAS,KAAK,IAAI,IAAI,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YAEzE,mEAAmE;YACnE,IAAI,UAAU,CAAC,MAAM,GAAG,YAAY,CAAC,WAAW,CAAC,EAAE;gBACjD,YAAY,CAAC,WAAW,CAAC,GAAG,UAAU,CAAC,MAAM,CAAC;aAC/C;SACF;KACF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,iBAAiB,CAC/B,WAAmB,EACnB,UAA6B,EAC7B,gBAAmE,EACnE,YAAgC,EAChC,OAAe,EACf,kBAA0B;;IAD1B,wBAAA,EAAA,eAAe;IACf,mCAAA,EAAA,0BAA0B;IAE1B,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,IAAI,IAAI,GAAG,MAAA,UAAU,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;QAC/B,IAAI,kBAAkB,EAAE;YACtB,IAAI,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;SACpC;QACD,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,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,IAAI,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;SAC/F;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,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,SAAG,IAAI,SAAG,GAAG,CAAC,MAAM,CAAC,YAAY,CAAC,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;SAC9H;aAAM;YACL,4BAA4B;YAC5B,WAAW,IAAI,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;SAC7F;KACF;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAChC,WAAmB,EACnB,gBAAmE,EACnE,YAAgC,EAChC,OAAe;;IAAf,wBAAA,EAAA,eAAe;IAEf,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,UAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,SAAG,cAAc,SAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAG,CAAC;KACpF;IAED,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,2BAA2B,CACzC,SAAyB,EACzB,gBAAmE,EACnE,qBAA4B,EAC5B,OAAe,EACf,eAAuB;IAFvB,sCAAA,EAAA,4BAA4B;IAC5B,wBAAA,EAAA,eAAe;IACf,gCAAA,EAAA,uBAAuB;IAEvB,IAAM,iBAAiB,GAAG,SAAS,CAAC,gBAAgB,CAAC,MAAM,CAAC;IAC5D,IAAM,gBAAgB,GAAG,SAAS,CAAC,cAAc,CAAC,GAAG,CACnD,UAAC,UAA6B,IAAK,OAAA,UAAU,CAAC,MAAM,EAAjB,CAAiB,CACrD,CAAC;IACF,IAAM,cAAc,GAAG,IAAI,CAAC,GAAG,OAAR,IAAI,iBAAK,iBAAiB,GAAK,gBAAgB,SAAC,CAAC;IAExE,IAAM,YAAY,GAAG,qBAAqB;QACxC,CAAC,CAAC,qBAAqB,gBAClB,SAAS,CAAC,gBAAgB,GAAK,SAAS,CAAC,cAAc,SACxD,cAAc,CACf;QACH,CAAC,CAAC,SAAS,CAAC;IAEd,IAAM,iBAAiB,GAAG,iBAAiB,CACzC,cAAc,EACd,SAAS,CAAC,gBAAgB,EAC1B,gBAAgB,EAChB,YAAY,EACZ,OAAO,EACP,eAAe,CAChB,CAAC;IACF,IAAM,oBAAoB,GAAG,kBAAkB,CAC7C,cAAc,EACd,gBAAgB,EAChB,YAAY,EACZ,OAAO,CACR,CAAC;IAEF,IAAM,gBAAgB,GAAG,SAAS,CAAC,cAAc;SAC9C,GAAG,CAAC,UAAC,UAA6B;QACjC,OAAA,iBAAiB,CACf,cAAc,EACd,UAAU,EACV,gBAAgB,EAChB,YAAY,EACZ,OAAO,EACP,eAAe,CAChB;IAPD,CAOC,CACF;SACA,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO,UAAG,iBAAiB,eAAK,oBAAoB,eAAK,gBAAgB,CAAE,CAAC,OAAO,EAAE,CAAC;AACxF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;AACrC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,IAAI,UAAU,GAAG,EAAE,CAAC;IACpB,IAAI,YAAY,GAAG,KAAK,CAAC;IACzB,OAAO,YAAY,IAAI,CAAC,EAAE;QACxB,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC,GAAG,UAAU,CAAC;QACxE,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC;KAClD;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,WAAmB;IACzD,IAAM,eAAe,GAAa,EAAE,CAAC;IACrC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;QACpC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC;KACxC;IACD,OAAO,eAAe,CAAC;AACzB,CAAC"}

package/dist/src/validation.d.ts

@@ -1,13 +0,0 @@
-import { MarkdownTableProps } from './types';
-/**
- * Custom error class for handling Markdown table generation errors.
- */
-export declare class MarkdownTableError extends Error {
-    constructor(message: string);
-}
-/**
- * Validates the structure of the table data based on the `hasHeader` flag.
- * Throws an error if validation fails.
- * @param markdownTableProps - The props to validate.
- */
-export declare function validateMarkdownTableProps(markdownTableProps: MarkdownTableProps): void;