table 6.1.0 → 6.3.2

package/dist/padTableData.js

@@ -1,23 +1,10 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-/**
- * @param {table~row[]} rows
- * @param {object} config
- * @returns {table~row[]}
- */
-const padTableData = (rows, config) => {
-  return rows.map(cells => {
-    return cells.map((value, index1) => {
-      const column = config.columns[index1];
-      return ' '.repeat(column.paddingLeft) + value + ' '.repeat(column.paddingRight);
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (rows, config) => {
+    return rows.map((cells) => {
+        return cells.map((value, index1) => {
+            const column = config.columns[index1];
+            return ' '.repeat(column.paddingLeft) + value + ' '.repeat(column.paddingRight);
+        });
     });
-  });
 };
-
-var _default = padTableData;
-exports.default = _default;

package/dist/stringifyTableData.d.ts

@@ -0,0 +1,3 @@
+import type { Row } from './types/internal';
+declare const _default: (rows: unknown[][]) => Row[];
+export default _default;

package/dist/stringifyTableData.js

@@ -1,21 +1,7 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-/**
- * Casts all cell values to a string.
- *
- * @param {table~row[]} rows
- * @returns {table~row[]}
- */
-const stringifyTableData = rows => {
-  return rows.map(cells => {
-    return cells.map(String);
-  });
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (rows) => {
+    return rows.map((cells) => {
+        return cells.map(String);
+    });
 };
-
-var _default = stringifyTableData;
-exports.default = _default;

package/dist/table.d.ts

@@ -0,0 +1,3 @@
+import type { TableUserConfig } from './types/api';
+declare const _default: (data: unknown[][], userConfig?: TableUserConfig) => string;
+export default _default;

package/dist/table.js

@@ -1,121 +1,27 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _alignTableData = _interopRequireDefault(require("./alignTableData"));
-
-var _calculateCellWidthIndex = _interopRequireDefault(require("./calculateCellWidthIndex"));
-
-var _calculateRowHeightIndex = _interopRequireDefault(require("./calculateRowHeightIndex"));
-
-var _drawTable = _interopRequireDefault(require("./drawTable"));
-
-var _makeConfig = _interopRequireDefault(require("./makeConfig"));
-
-var _mapDataUsingRowHeightIndex = _interopRequireDefault(require("./mapDataUsingRowHeightIndex"));
-
-var _padTableData = _interopRequireDefault(require("./padTableData"));
-
-var _stringifyTableData = _interopRequireDefault(require("./stringifyTableData"));
-
-var _truncateTableData = _interopRequireDefault(require("./truncateTableData"));
-
-var _validateTableData = _interopRequireDefault(require("./validateTableData"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @typedef {string} table~cell
- */
-
-/**
- * @typedef {table~cell[]} table~row
- */
-
-/**
- * @typedef {object} table~columns
- * @property {string} alignment Cell content alignment (enum: left, center, right) (default: left).
- * @property {number} width Column width (default: auto).
- * @property {number} truncate Number of characters are which the content will be truncated (default: Infinity).
- * @property {boolean} wrapWord When true the text is broken at the nearest space or one of the special characters
- * @property {number} paddingLeft Cell content padding width left (default: 1).
- * @property {number} paddingRight Cell content padding width right (default: 1).
- */
-
-/**
- * @typedef {object} table~border
- * @property {string} topBody
- * @property {string} topJoin
- * @property {string} topLeft
- * @property {string} topRight
- * @property {string} bottomBody
- * @property {string} bottomJoin
- * @property {string} bottomLeft
- * @property {string} bottomRight
- * @property {string} bodyLeft
- * @property {string} bodyRight
- * @property {string} bodyJoin
- * @property {string} joinBody
- * @property {string} joinLeft
- * @property {string} joinRight
- * @property {string} joinJoin
- */
-
-/**
- * Used to tell whether to draw a vertical line.
- * This callback is called for each non-content line of the table.
- * The default behavior is to always return true.
- *
- * @typedef {Function} drawVerticalLine
- * @param {number} index
- * @param {number} size
- * @returns {boolean}
- */
-
-/**
- * Used to tell whether to draw a horizontal line.
- * This callback is called for each non-content line of the table.
- * The default behavior is to always return true.
- *
- * @typedef {Function} drawHorizontalLine
- * @param {number} index
- * @param {number} size
- * @returns {boolean}
- */
-
-/**
- * @typedef {object} table~config
- * @property {table~border} border
- * @property {table~columns[]} columns Column specific configuration.
- * @property {table~columns} columnDefault Default values for all columns. Column specific settings overwrite the default values.
- * @property {table~drawVerticalLine} drawVerticalLine
- * @property {table~drawHorizontalLine} drawHorizontalLine
- * @property {table~singleLine} singleLine Horizontal lines inside the table are not drawn.
- */
-
-/**
- * Generates a text table.
- *
- * @param {table~row[]} data
- * @param {table~config} userConfig
- * @returns {string}
- */
-const table = (data, userConfig = {}) => {
-  let rows;
-  (0, _validateTableData.default)(data);
-  rows = (0, _stringifyTableData.default)(data);
-  const config = (0, _makeConfig.default)(rows, userConfig);
-  rows = (0, _truncateTableData.default)(data, config);
-  const rowHeightIndex = (0, _calculateRowHeightIndex.default)(rows, config);
-  rows = (0, _mapDataUsingRowHeightIndex.default)(rows, rowHeightIndex, config);
-  rows = (0, _alignTableData.default)(rows, config);
-  rows = (0, _padTableData.default)(rows, config);
-  const cellWidthIndex = (0, _calculateCellWidthIndex.default)(rows[0]);
-  return (0, _drawTable.default)(rows, cellWidthIndex, rowHeightIndex, config);
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const alignTableData_1 = __importDefault(require("./alignTableData"));
+const calculateCellWidthIndex_1 = __importDefault(require("./calculateCellWidthIndex"));
+const calculateRowHeightIndex_1 = __importDefault(require("./calculateRowHeightIndex"));
+const drawTable_1 = __importDefault(require("./drawTable"));
+const makeConfig_1 = __importDefault(require("./makeConfig"));
+const mapDataUsingRowHeightIndex_1 = __importDefault(require("./mapDataUsingRowHeightIndex"));
+const padTableData_1 = __importDefault(require("./padTableData"));
+const stringifyTableData_1 = __importDefault(require("./stringifyTableData"));
+const truncateTableData_1 = __importDefault(require("./truncateTableData"));
+const validateTableData_1 = __importDefault(require("./validateTableData"));
+exports.default = (data, userConfig = {}) => {
+    validateTableData_1.default(data);
+    let rows = stringifyTableData_1.default(data);
+    const config = makeConfig_1.default(rows, userConfig);
+    rows = truncateTableData_1.default(rows, config);
+    const rowHeightIndex = calculateRowHeightIndex_1.default(rows, config);
+    rows = mapDataUsingRowHeightIndex_1.default(rows, rowHeightIndex, config);
+    rows = alignTableData_1.default(rows, config);
+    rows = padTableData_1.default(rows, config);
+    const cellWidthIndex = calculateCellWidthIndex_1.default(rows[0]);
+    return drawTable_1.default(rows, cellWidthIndex, rowHeightIndex, config);
 };
-
-var _default = table;
-exports.default = _default;

package/dist/truncateTableData.d.ts

@@ -0,0 +1,6 @@
+import type { BaseConfig, Row } from './types/internal';
+declare const _default: (rows: Row[], config: BaseConfig) => Row[];
+/**
+ * @todo Make it work with ASCII content.
+ */
+export default _default;

package/dist/truncateTableData.js

@@ -1,29 +1,19 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _lodash = _interopRequireDefault(require("lodash.truncate"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const lodash_truncate_1 = __importDefault(require("lodash.truncate"));
 /**
  * @todo Make it work with ASCII content.
- * @param {table~row[]} rows
- * @param {object} config
- * @returns {table~row[]}
  */
-const truncateTableData = (rows, config) => {
-  return rows.map(cells => {
-    return cells.map((content, index) => {
-      return (0, _lodash.default)(content, {
-        length: config.columns[index].truncate
-      });
+exports.default = (rows, config) => {
+    return rows.map((cells) => {
+        return cells.map((content, index) => {
+            return lodash_truncate_1.default(content, {
+                length: config.columns[index].truncate,
+                omission: '…',
+            });
+        });
     });
-  });
 };
-
-var _default = truncateTableData;
-exports.default = _default;

package/dist/types/api.d.ts

@@ -0,0 +1,100 @@
+export declare type DrawLinePredicate = (index: number, size: number) => boolean;
+export declare type DrawVerticalLine = DrawLinePredicate;
+export declare type DrawHorizontalLine = DrawLinePredicate;
+export declare type BorderUserConfig = {
+    readonly topLeft?: string;
+    readonly topRight?: string;
+    readonly topBody?: string;
+    readonly topJoin?: string;
+    readonly bottomLeft?: string;
+    readonly bottomRight?: string;
+    readonly bottomBody?: string;
+    readonly bottomJoin?: string;
+    readonly bodyRight?: string;
+    readonly bodyLeft?: string;
+    readonly bodyJoin?: string;
+    readonly joinLeft?: string;
+    readonly joinRight?: string;
+    readonly joinBody?: string;
+    readonly joinJoin?: string;
+};
+export declare type BorderConfig = Required<BorderUserConfig>;
+export declare type ColumnUserConfig = {
+    /**
+     * Cell content horizontal alignment (default: left)
+     */
+    readonly alignment?: 'center' | 'left' | 'right';
+    /**
+     * Column width (default: auto calculation based on the cell content)
+     */
+    readonly width?: number;
+    /**
+     * Number of characters are which the content will be truncated (default: Infinity)
+     */
+    readonly truncate?: number;
+    /**
+     * Cell content padding width left (default: 1)
+     */
+    readonly paddingLeft?: number;
+    /**
+     * Cell content padding width right (default: 1)
+     */
+    readonly paddingRight?: number;
+    /**
+     * If true, the text is broken at the nearest space or one of the special characters: "\|/_.,;-"
+     */
+    readonly wrapWord?: boolean;
+};
+export declare type BaseUserConfig = {
+    /**
+     * Custom border
+     */
+    readonly border?: BorderUserConfig;
+    /**
+     * Default values for all columns. Column specific settings overwrite the default values.
+     */
+    readonly columnDefault?: ColumnUserConfig;
+    /**
+     * Column specific configuration.
+     */
+    readonly columns?: Indexable<ColumnUserConfig>;
+    /**
+     * Used to tell whether to draw a vertical line.
+     * This callback is called for each non-content line of the table.
+     * The default behavior is to always return true.
+     */
+    readonly drawVerticalLine?: DrawVerticalLine;
+};
+export declare type TableUserConfig = BaseUserConfig & {
+    /**
+     * Used to tell whether to draw a horizontal line.
+     * This callback is called for each non-content line of the table.
+     * The default behavior is to always return true.
+     */
+    readonly drawHorizontalLine?: DrawHorizontalLine;
+    /**
+     * Horizontal lines inside the table are not drawn.
+     */
+    readonly singleLine?: boolean;
+};
+export declare type StreamUserConfig = BaseUserConfig & {
+    /**
+     * The number of columns
+     */
+    readonly columnCount: number;
+    /**
+     * Default values for all columns. Column specific settings overwrite the default values.
+     */
+    readonly columnDefault: ColumnUserConfig & {
+        /**
+         * The default width for each column
+         */
+        readonly width: number;
+    };
+};
+export declare type WritableStream = {
+    readonly write: (rows: string[]) => void;
+};
+export declare type Indexable<T> = {
+    readonly [index: number]: T;
+};

package/dist/types/api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/internal.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/internal.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/validateConfig.d.ts

@@ -0,0 +1,3 @@
+import type { TableUserConfig } from './types/api';
+declare const _default: (schemaId: 'config.json' | 'streamConfig.json', config: TableUserConfig) => void;
+export default _default;

package/dist/validateConfig.js

@@ -1,40 +1,24 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _validators = _interopRequireDefault(require("../dist/validators"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * @param {string} schemaId
- * @param {formatData~config} config
- * @returns {undefined}
- */
-const validateConfig = (schemaId, config = {}) => {
-  const validate = _validators.default[schemaId];
-
-  if (!validate(config)) {
-    const errors = validate.errors.map(error => {
-      return {
-        dataPath: error.dataPath,
-        message: error.message,
-        params: error.params,
-        schemaPath: error.schemaPath
-      };
-    });
-    /* eslint-disable no-console */
-
-    console.log('config', config);
-    console.log('errors', errors);
-    /* eslint-enable no-console */
-
-    throw new Error('Invalid config.');
-  }
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const validators_1 = __importDefault(require("./generated/validators"));
+exports.default = (schemaId, config) => {
+    var _a;
+    const validate = validators_1.default[schemaId];
+    if (!validate(config)) {
+        const errors = (_a = validate.errors) === null || _a === void 0 ? void 0 : _a.map((error) => {
+            return {
+                message: error.message,
+                params: error.params,
+                schemaPath: error.schemaPath,
+            };
+        });
+        /* eslint-disable no-console */
+        console.log('config', config);
+        console.log('errors', errors);
+        /* eslint-enable no-console */
+        throw new Error('Invalid config.');
+    }
 };
-
-var _default = validateConfig;
-exports.default = _default;

package/dist/validateTableData.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (rows: unknown[][]) => void;
+export default _default;

package/dist/validateTableData.js

@@ -1,54 +1,28 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-/**
- * @typedef {string} cell
- */
-
-/**
- * @typedef {cell[]} validateData~column
- */
-
-/**
- * @param {column[]} rows
- * @returns {undefined}
- */
-const validateTableData = rows => {
-  if (!Array.isArray(rows)) {
-    throw new TypeError('Table data must be an array.');
-  }
-
-  if (rows.length === 0) {
-    throw new Error('Table must define at least one row.');
-  }
-
-  if (rows[0].length === 0) {
-    throw new Error('Table must define at least one column.');
-  }
-
-  const columnNumber = rows[0].length;
-
-  for (const cells of rows) {
-    if (!Array.isArray(cells)) {
-      throw new TypeError('Table row data must be an array.');
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = (rows) => {
+    if (!Array.isArray(rows)) {
+        throw new TypeError('Table data must be an array.');
     }
-
-    if (cells.length !== columnNumber) {
-      throw new Error('Table must have a consistent number of cells.');
+    if (rows.length === 0) {
+        throw new Error('Table must define at least one row.');
     }
-
-    for (const cell of cells) {
-      // eslint-disable-next-line no-control-regex
-      if (/[\u0001-\u0006\u0008\u0009\u000B-\u001A]/.test(cell)) {
-        throw new Error('Table data must not contain control characters.');
-      }
+    if (rows[0].length === 0) {
+        throw new Error('Table must define at least one column.');
+    }
+    const columnNumber = rows[0].length;
+    for (const row of rows) {
+        if (!Array.isArray(row)) {
+            throw new TypeError('Table row data must be an array.');
+        }
+        if (row.length !== columnNumber) {
+            throw new Error('Table must have a consistent number of cells.');
+        }
+        for (const cell of row) {
+            // eslint-disable-next-line no-control-regex
+            if (/[\u0001-\u0006\u0008\u0009\u000B-\u001A]/.test(cell)) {
+                throw new Error('Table data must not contain control characters.');
+            }
+        }
     }
-  }
 };
-
-var _default = validateTableData;
-exports.default = _default;

package/dist/wrapCell.d.ts

@@ -0,0 +1,9 @@
+declare const _default: (cellValue: string, columnWidth: number, useWrapWord: boolean) => string[];
+/**
+ * Wrap a single cell value into a list of lines
+ *
+ * Always wraps on newlines, for the remainder uses either word or string wrapping
+ * depending on user configuration.
+ *
+ */
+export default _default;

package/dist/wrapCell.js

@@ -1,47 +1,32 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _wrapString = _interopRequireDefault(require("./wrapString"));
-
-var _wrapWord = _interopRequireDefault(require("./wrapWord"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const wrapString_1 = __importDefault(require("./wrapString"));
+const wrapWord_1 = __importDefault(require("./wrapWord"));
 /**
  * Wrap a single cell value into a list of lines
  *
  * Always wraps on newlines, for the remainder uses either word or string wrapping
  * depending on user configuration.
  *
- * @param {string} cellValue
- * @param {number} columnWidth
- * @param {boolean} useWrapWord
- * @returns {Array}
  */
-const wrapCell = (cellValue, columnWidth, useWrapWord) => {
-  // First split on literal newlines
-  const cellLines = cellValue.split('\n'); // Then iterate over the list and word-wrap every remaining line if necessary.
-
-  for (let lineNr = 0; lineNr < cellLines.length;) {
-    let lineChunks;
-
-    if (useWrapWord) {
-      lineChunks = (0, _wrapWord.default)(cellLines[lineNr], columnWidth);
-    } else {
-      lineChunks = (0, _wrapString.default)(cellLines[lineNr], columnWidth);
-    } // Replace our original array element with whatever the wrapping returned
-
-
-    cellLines.splice(lineNr, 1, ...lineChunks);
-    lineNr += lineChunks.length;
-  }
-
-  return cellLines;
+exports.default = (cellValue, columnWidth, useWrapWord) => {
+    // First split on literal newlines
+    const cellLines = cellValue.split('\n');
+    // Then iterate over the list and word-wrap every remaining line if necessary.
+    for (let lineNr = 0; lineNr < cellLines.length;) {
+        let lineChunks;
+        if (useWrapWord) {
+            lineChunks = wrapWord_1.default(cellLines[lineNr], columnWidth);
+        }
+        else {
+            lineChunks = wrapString_1.default(cellLines[lineNr], columnWidth);
+        }
+        // Replace our original array element with whatever the wrapping returned
+        cellLines.splice(lineNr, 1, ...lineChunks);
+        lineNr += lineChunks.length;
+    }
+    return cellLines;
 };
-
-var _default = wrapCell;
-exports.default = _default;

package/dist/wrapString.d.ts

@@ -0,0 +1,10 @@
+declare const _default: (subject: string, size: number) => string[];
+/**
+ * Creates an array of strings split into groups the length of size.
+ * This function works with strings that contain ASCII characters.
+ *
+ * wrapText is different from would-be "chunk" implementation
+ * in that whitespace characters that occur on a chunk size limit are trimmed.
+ *
+ */
+export default _default;