react-markdown-table-ts 0.1.0 → 0.1.2

package/dist/src/errors.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Custom error class for handling Markdown table generation errors.
+ */
+export declare class MarkdownTableError extends Error {
+    constructor(message: string);
+}

package/dist/{types → src}/helpers.d.ts

@@ -1,46 +1,34 @@
 /**
  * @fileoverview Contains helper functions for formatting Markdown table syntax and calculating column widths.
  */
-import {TableRow} from './types';
+import { TableRow } from './types';
 /**
  * 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 declare function calculateColumnWidths({
-  allRows,
-  maxColumnCount,
-}: {
-  allRows: readonly TableRow[];
-  maxColumnCount: number;
+export declare function calculateColumnWidths({ allRows, maxColumnCount, }: {
+    allRows: readonly TableRow[];
+    maxColumnCount: number;
 }): number[];
 /**
  * Formats a single row into a Markdown-formatted string.
  * @param params - The parameters for row formatting.
  * @returns The Markdown string for the row.
  */
-export declare function formatMarkdownRow({
-  columnCount,
-  row,
-  columnAlignments,
-  columnWidths,
-}: {
-  columnCount: number;
-  row: TableRow;
-  columnAlignments?: readonly ('left' | 'right' | 'center' | 'none')[];
-  columnWidths?: readonly number[];
+export declare function formatMarkdownRow({ columnCount, row, columnAlignments, columnWidths, }: {
+    columnCount: number;
+    row: TableRow;
+    columnAlignments?: readonly ('left' | 'right' | 'center' | 'none')[];
+    columnWidths?: readonly number[];
 }): string;
 /**
  * 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 declare function formatAlignmentRow({
-  columnCount,
-  columnAlignments,
-  columnWidths,
-}: {
-  columnCount: number;
-  columnAlignments?: readonly ('left' | 'right' | 'center' | 'none')[];
-  columnWidths?: readonly number[];
+export declare function formatAlignmentRow({ columnCount, columnAlignments, columnWidths, }: {
+    columnCount: number;
+    columnAlignments?: readonly ('left' | 'right' | 'center' | 'none')[];
+    columnWidths?: readonly number[];
 }): string;

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+import React from 'react';
+import { MarkdownTableProps, TableRow } from './types';
+import { MarkdownTableError } from './errors';
+/**
+ * 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.
+ */
+export declare const MarkdownTable: React.FC<MarkdownTableProps>;
+export type { MarkdownTableProps, TableRow };
+export { MarkdownTableError };

package/dist/src/types.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Represents a single row in a table, consisting of cells.
+ */
+export type TableRow = readonly string[];
+/**
+ * Represents the structure of a Markdown table.
+ */
+export interface MarkdownTableData {
+    /**
+     * The header row of the table.
+     */
+    header: string[];
+    /**
+     * The body rows of the table.
+     */
+    rows: 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.
+     */
+    data: string[][];
+    /**
+     * 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?: (markdownString: string) => void;
+}

package/dist/src/utils.d.ts

@@ -0,0 +1,44 @@
+import { TableRow, MarkdownTableData } from './types';
+/**
+ * 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.
+ */
+export declare function calculateColumnWidths(allRows: readonly TableRow[], maxColumnCount: number): number[];
+/**
+ * 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;
+/**
+ * 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.
+ */
+export declare function formatMarkdownRow(columnCount: number, row: TableRow, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], columnWidths?: readonly number[], useTabs?: boolean, replaceNewlines?: 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 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.
+ */
+export declare function generateMarkdownTableString(tableData: MarkdownTableData, columnAlignments: readonly ('left' | 'right' | 'center' | 'none')[], adjustColumnWidths?: boolean, useTabs?: boolean, replaceNewlines?: boolean): string;

package/dist/src/validation.d.ts

@@ -0,0 +1,7 @@
+import { MarkdownTableProps } from './types';
+/**
+ * Validates the structure of the table data based on the `hasHeader` flag.
+ * Throws an error if validation fails.
+ * @param props - The props to validate.
+ */
+export declare function validateMarkdownTableProps(props: MarkdownTableProps): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-markdown-table-ts",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "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",

package/dist/types/errors.d.ts

@@ -1,13 +0,0 @@
-/**
- * @fileoverview Defines custom error classes for Markdown table syntax generation.
- */
-/**
- * Custom error class for handling Markdown table generation errors.
- */
-export declare class MarkdownTableError extends Error {
-  /**
-   * Constructs a new MarkdownTableError.
-   * @param message - The error message.
-   */
-  constructor(message: string);
-}

package/dist/types/index.d.ts

@@ -1,18 +0,0 @@
-import {CreateMarkdownTableOptions, MarkdownTableProps} from './types';
-/**
- * Generates a Markdown-formatted table as a string.
- * @param options - The parameters for table generation.
- * @returns The Markdown string for the entire table.
- * @throws {MarkdownTableError} if input validation fails.
- */
-export declare function generateMarkdownTable({
-  tableData,
-  columnAlignments,
-  adjustColumnWidths,
-}: CreateMarkdownTableOptions): string;
-/**
- * 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.
- */
-export declare function MarkdownTable(props: MarkdownTableProps): JSX.Element;

package/dist/types/types.d.ts

@@ -1,44 +0,0 @@
-/**
- * @fileoverview Defines types and interfaces for generating Markdown table syntax and displaying it in React components.
- */
-/**
- * Represents a single row in a table, consisting of cells.
- */
-export type TableRow = readonly string[];
-/**
- * Represents the structure of a Markdown table.
- */
-export interface MarkdownTableData {
-  /**
-   * The header row of the table.
-   */
-  readonly header: TableRow;
-  /**
-   * The body rows of the table.
-   */
-  readonly rows: readonly TableRow[];
-}
-/**
- * Input parameters for creating a Markdown table syntax.
- */
-export interface CreateMarkdownTableOptions {
-  /**
-   * The table data including headers and body rows.
-   */
-  readonly tableData: MarkdownTableData;
-  /**
-   * Optional flag to adjust column widths based on content.
-   * @default true
-   */
-  readonly adjustColumnWidths?: boolean;
-  /**
-   * Optional alignment settings for each column.
-   */
-  readonly columnAlignments?: readonly ('left' | 'right' | 'center' | 'none')[];
-}
-/**
- * Props for the MarkdownTable component.
- */
-export interface MarkdownTableProps extends CreateMarkdownTableOptions {
-  className?: string;
-}

package/dist/types/validation.d.ts

@@ -1,29 +0,0 @@
-/**
- * @fileoverview Provides validation functions for inputs used in Markdown table syntax generation.
- */
-import {MarkdownTableData, CreateMarkdownTableOptions} from './types';
-/**
- * Validates the structure of the table data.
- * Throws an error if validation fails.
- * @param tableData - The table data to validate.
- * @throws {MarkdownTableError} if validation fails.
- */
-export declare function validateTableData(tableData: MarkdownTableData): void;
-/**
- * Validates the column alignments array.
- * Throws an error if validation fails.
- * @param columnAlignments - The alignment settings to validate.
- * @throws {MarkdownTableError} if validation fails.
- */
-export declare function validateColumnAlignments(
-  columnAlignments?: readonly ('left' | 'right' | 'center' | 'none')[]
-): void;
-/**
- * Validates the input parameters for generating the Markdown table syntax.
- * Throws an error if validation fails.
- * @param options - The input parameters to validate.
- * @throws {MarkdownTableError} if validation fails.
- */
-export declare function validateCreateMarkdownTableOptions(
-  options: CreateMarkdownTableOptions
-): void;