react-markdown-table-ts 0.1.0 → 0.1.1

package/package.json

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

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/helpers.d.ts

@@ -1,46 +0,0 @@
-/**
- * @fileoverview Contains helper functions for formatting Markdown table syntax and calculating column widths.
- */
-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;
-}): 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[];
-}): 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[];
-}): 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;