table 6.6.0 → 6.7.0

package/dist/getBorderCharacters.js

@@ -16,6 +16,7 @@ const getBorderCharacters = (name) => {
             bodyLeft: '║',
             bodyRight: '║',
             bodyJoin: '│',
+            headerJoin: '┬',
             joinBody: '─',
             joinLeft: '╟',
             joinRight: '╢',
@@ -35,6 +36,7 @@ const getBorderCharacters = (name) => {
             bodyLeft: '│',
             bodyRight: '│',
             bodyJoin: '│',
+            headerJoin: '┬',
             joinBody: '─',
             joinLeft: '├',
             joinRight: '┤',
@@ -54,6 +56,7 @@ const getBorderCharacters = (name) => {
             bodyLeft: '|',
             bodyRight: '|',
             bodyJoin: '|',
+            headerJoin: '+',
             joinBody: '-',
             joinLeft: '|',
             joinRight: '|',
@@ -73,6 +76,7 @@ const getBorderCharacters = (name) => {
             bodyLeft: '',
             bodyRight: '',
             bodyJoin: '',
+            headerJoin: '',
             joinBody: '',
             joinLeft: '',
             joinRight: '',

package/dist/index.js

@@ -11,6 +11,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getBorderCharacters = exports.createStream = exports.table = void 0;
+// import chalk from 'chalk';
 const createStream_1 = require("./createStream");
 Object.defineProperty(exports, "createStream", { enumerable: true, get: function () { return createStream_1.createStream; } });
 const getBorderCharacters_1 = require("./getBorderCharacters");

package/dist/makeStreamConfig.js

@@ -11,13 +11,14 @@ const validateConfig_1 = require("./validateConfig");
  * Creates a configuration for every column using default
  * values for the missing configuration properties.
  */
-const makeColumns = (columnCount, columns = {}, columnDefault) => {
+const makeColumnsConfig = (columnCount, columns = {}, columnDefault) => {
     return Array.from({ length: columnCount }).map((_, index) => {
         return {
             alignment: 'left',
             paddingLeft: 1,
             paddingRight: 1,
             truncate: Number.POSITIVE_INFINITY,
+            verticalAlignment: 'top',
             wrapWord: false,
             ...columnDefault,
             ...columns[index],
@@ -29,20 +30,18 @@ const makeColumns = (columnCount, columns = {}, columnDefault) => {
  * using default values for the missing configuration properties.
  */
 const makeStreamConfig = (userConfig) => {
-    var _a;
     validateConfig_1.validateConfig('streamConfig.json', userConfig);
     const config = lodash_clonedeep_1.default(userConfig);
     if (config.columnDefault.width === undefined) {
         throw new Error('Must provide config.columnDefault.width when creating a stream.');
     }
     return {
-        ...config,
-        border: utils_1.makeBorder(config.border),
-        columnCount: config.columnCount,
-        columns: makeColumns(config.columnCount, config.columns, config.columnDefault),
-        drawVerticalLine: (_a = config.drawVerticalLine) !== null && _a !== void 0 ? _a : (() => {
+        drawVerticalLine: () => {
             return true;
-        }),
+        },
+        ...config,
+        border: utils_1.makeBorderConfig(config.border),
+        columns: makeColumnsConfig(config.columnCount, config.columns, config.columnDefault),
     };
 };
 exports.makeStreamConfig = makeStreamConfig;

package/dist/{makeConfig.d.ts → makeTableConfig.d.ts}

@@ -4,4 +4,4 @@ import type { Row, TableConfig } from './types/internal';
  * Makes a new configuration object out of the userConfig object
  * using default values for the missing configuration properties.
  */
-export declare const makeConfig: (rows: Row[], userConfig?: TableUserConfig) => TableConfig;
+export declare const makeTableConfig: (rows: Row[], userConfig?: TableUserConfig) => TableConfig;

package/dist/{makeConfig.js → makeTableConfig.js}

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeConfig = void 0;
+exports.makeTableConfig = void 0;
 const lodash_clonedeep_1 = __importDefault(require("lodash.clonedeep"));
 const calculateColumnWidths_1 = __importDefault(require("./calculateColumnWidths"));
 const utils_1 = require("./utils");
@@ -12,7 +12,7 @@ const validateConfig_1 = require("./validateConfig");
  * Creates a configuration for every column using default
  * values for the missing configuration properties.
  */
-const makeColumns = (rows, columns, columnDefault) => {
+const makeColumnsConfig = (rows, columns, columnDefault) => {
     const columnWidths = calculateColumnWidths_1.default(rows);
     return rows[0].map((_, columnIndex) => {
         return {
@@ -20,6 +20,7 @@ const makeColumns = (rows, columns, columnDefault) => {
             paddingLeft: 1,
             paddingRight: 1,
             truncate: Number.POSITIVE_INFINITY,
+            verticalAlignment: 'top',
             width: columnWidths[columnIndex],
             wrapWord: false,
             ...columnDefault,
@@ -27,25 +28,39 @@ const makeColumns = (rows, columns, columnDefault) => {
         };
     });
 };
+const makeHeaderConfig = (config) => {
+    if (!config.header) {
+        return undefined;
+    }
+    return {
+        alignment: 'center',
+        paddingLeft: 1,
+        paddingRight: 1,
+        truncate: Number.POSITIVE_INFINITY,
+        wrapWord: false,
+        ...config.header,
+    };
+};
 /**
  * Makes a new configuration object out of the userConfig object
  * using default values for the missing configuration properties.
  */
-const makeConfig = (rows, userConfig = {}) => {
+const makeTableConfig = (rows, userConfig = {}) => {
     var _a, _b, _c;
     validateConfig_1.validateConfig('config.json', userConfig);
     const config = lodash_clonedeep_1.default(userConfig);
     return {
         ...config,
-        border: utils_1.makeBorder(config.border),
-        columns: makeColumns(rows, config.columns, config.columnDefault),
+        border: utils_1.makeBorderConfig(config.border),
+        columns: makeColumnsConfig(rows, config.columns, config.columnDefault),
         drawHorizontalLine: (_a = config.drawHorizontalLine) !== null && _a !== void 0 ? _a : (() => {
             return true;
         }),
         drawVerticalLine: (_b = config.drawVerticalLine) !== null && _b !== void 0 ? _b : (() => {
             return true;
         }),
+        header: makeHeaderConfig(config),
         singleLine: (_c = config.singleLine) !== null && _c !== void 0 ? _c : false,
     };
 };
-exports.makeConfig = makeConfig;
+exports.makeTableConfig = makeTableConfig;

package/dist/mapDataUsingRowHeights.js

@@ -1,11 +1,28 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mapDataUsingRowHeights = void 0;
-const lodash_flatten_1 = __importDefault(require("lodash.flatten"));
 const wrapCell_1 = require("./wrapCell");
+const createEmptyStrings = (length) => {
+    return new Array(length).fill('');
+};
+const padCellVertically = (lines, rowHeight, columnConfig) => {
+    const { verticalAlignment } = columnConfig;
+    const availableLines = rowHeight - lines.length;
+    if (verticalAlignment === 'top') {
+        return [...lines, ...createEmptyStrings(availableLines)];
+    }
+    if (verticalAlignment === 'bottom') {
+        return [...createEmptyStrings(availableLines), ...lines];
+    }
+    return [
+        ...createEmptyStrings(Math.floor(availableLines / 2)),
+        ...lines,
+        ...createEmptyStrings(Math.ceil(availableLines / 2)),
+    ];
+};
+const flatten = (array) => {
+    return [].concat(...array);
+};
 const mapDataUsingRowHeights = (unmappedRows, rowHeights, config) => {
     const tableWidth = unmappedRows[0].length;
     const mappedRows = unmappedRows.map((unmappedRow, unmappedRowIndex) => {
@@ -13,17 +30,15 @@ const mapDataUsingRowHeights = (unmappedRows, rowHeights, config) => {
         const outputRow = Array.from({ length: outputRowHeight }, () => {
             return new Array(tableWidth).fill('');
         });
-        // rowHeight
-        //     [{row index within rowSaw; index2}]
-        //     [{cell index within a virtual row; index1}]
         unmappedRow.forEach((cell, cellIndex) => {
             const cellLines = wrapCell_1.wrapCell(cell, config.columns[cellIndex].width, config.columns[cellIndex].wrapWord);
-            cellLines.forEach((cellLine, cellLineIndex) => {
+            const paddedCellLines = padCellVertically(cellLines, outputRowHeight, config.columns[cellIndex]);
+            paddedCellLines.forEach((cellLine, cellLineIndex) => {
                 outputRow[cellLineIndex][cellIndex] = cellLine;
             });
         });
         return outputRow;
     });
-    return lodash_flatten_1.default(mappedRows);
+    return flatten(mappedRows);
 };
 exports.mapDataUsingRowHeights = mapDataUsingRowHeights;

package/dist/padTableData.d.ts

@@ -1,2 +1,3 @@
 import type { BaseConfig, Row } from './types/internal';
+export declare const padString: (input: string, paddingLeft: number, paddingRight: number) => string;
 export declare const padTableData: (rows: Row[], config: BaseConfig) => Row[];

package/dist/padTableData.js

@@ -1,11 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.padTableData = void 0;
+exports.padTableData = exports.padString = void 0;
+const padString = (input, paddingLeft, paddingRight) => {
+    return ' '.repeat(paddingLeft) + input + ' '.repeat(paddingRight);
+};
+exports.padString = padString;
 const padTableData = (rows, config) => {
     return rows.map((cells) => {
         return cells.map((cell, cellIndex) => {
-            const column = config.columns[cellIndex];
-            return ' '.repeat(column.paddingLeft) + cell + ' '.repeat(column.paddingRight);
+            const { paddingLeft, paddingRight } = config.columns[cellIndex];
+            return exports.padString(cell, paddingLeft, paddingRight);
         });
     });
 };

package/dist/table.js

@@ -5,7 +5,7 @@ const alignTableData_1 = require("./alignTableData");
 const calculateCellWidths_1 = require("./calculateCellWidths");
 const calculateRowHeights_1 = require("./calculateRowHeights");
 const drawTable_1 = require("./drawTable");
-const makeConfig_1 = require("./makeConfig");
+const makeTableConfig_1 = require("./makeTableConfig");
 const mapDataUsingRowHeights_1 = require("./mapDataUsingRowHeights");
 const padTableData_1 = require("./padTableData");
 const stringifyTableData_1 = require("./stringifyTableData");
@@ -14,7 +14,7 @@ const validateTableData_1 = require("./validateTableData");
 const table = (data, userConfig = {}) => {
     validateTableData_1.validateTableData(data);
     let rows = stringifyTableData_1.stringifyTableData(data);
-    const config = makeConfig_1.makeConfig(rows, userConfig);
+    const config = makeTableConfig_1.makeTableConfig(rows, userConfig);
     rows = truncateTableData_1.truncateTableData(rows, config);
     const rowHeights = calculateRowHeights_1.calculateRowHeights(rows, config);
     rows = mapDataUsingRowHeights_1.mapDataUsingRowHeights(rows, rowHeights, config);

package/dist/truncateTableData.d.ts

@@ -1,4 +1,5 @@
 import type { BaseConfig, Row } from './types/internal';
+export declare const truncateString: (input: string, length: number) => string;
 /**
  * @todo Make it work with ASCII content.
  */

package/dist/truncateTableData.js

@@ -3,18 +3,20 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.truncateTableData = void 0;
+exports.truncateTableData = exports.truncateString = void 0;
 const lodash_truncate_1 = __importDefault(require("lodash.truncate"));
+const truncateString = (input, length) => {
+    return lodash_truncate_1.default(input, { length,
+        omission: '…' });
+};
+exports.truncateString = truncateString;
 /**
  * @todo Make it work with ASCII content.
  */
 const truncateTableData = (rows, config) => {
     return rows.map((cells) => {
         return cells.map((cell, cellIndex) => {
-            return lodash_truncate_1.default(cell, {
-                length: config.columns[cellIndex].truncate,
-                omission: '…',
-            });
+            return exports.truncateString(cell, config.columns[cellIndex].truncate);
         });
     });
 };

package/dist/types/api.d.ts

@@ -10,21 +10,27 @@ export declare type BorderUserConfig = {
     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;
+    readonly headerJoin?: string;
+    readonly bodyRight?: string;
+    readonly bodyLeft?: string;
+    readonly bodyJoin?: string;
 };
 export declare type BorderConfig = Required<BorderUserConfig>;
 export declare type Alignment = 'center' | 'justify' | 'left' | 'right';
+export declare type VerticalAlignment = 'bottom' | 'middle' | 'top';
 export declare type ColumnUserConfig = {
     /**
      * Cell content horizontal alignment (default: left)
      */
     readonly alignment?: Alignment;
+    /**
+     * Cell content vertical alignment (default: top)
+     */
+    readonly verticalAlignment?: VerticalAlignment;
     /**
      * Column width (default: auto calculation based on the cell content)
      */
@@ -46,6 +52,9 @@ export declare type ColumnUserConfig = {
      */
     readonly wrapWord?: boolean;
 };
+export declare type HeaderUserConfig = Omit<ColumnUserConfig, 'verticalAlignment' | 'width'> & {
+    readonly content: string;
+};
 export declare type BaseUserConfig = {
     /**
      * Custom border
@@ -67,6 +76,10 @@ export declare type BaseUserConfig = {
     readonly drawVerticalLine?: DrawVerticalLine;
 };
 export declare type TableUserConfig = BaseUserConfig & {
+    /**
+     * The header configuration
+     */
+    readonly header?: HeaderUserConfig;
     /**
      * Used to tell whether to draw a horizontal line.
      * This callback is called for each non-content line of the table.

package/dist/utils.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.distributeUnevenly = exports.countSpaceSequence = exports.groupBySizes = exports.makeBorder = exports.splitAnsi = exports.normalizeString = void 0;
+exports.distributeUnevenly = exports.countSpaceSequence = exports.groupBySizes = exports.makeBorderConfig = exports.splitAnsi = exports.normalizeString = void 0;
 const slice_ansi_1 = __importDefault(require("slice-ansi"));
 const strip_ansi_1 = __importDefault(require("strip-ansi"));
 const getBorderCharacters_1 = require("./getBorderCharacters");
@@ -40,13 +40,13 @@ exports.splitAnsi = splitAnsi;
  *
  * @internal
  */
-const makeBorder = (border) => {
+const makeBorderConfig = (border) => {
     return {
         ...getBorderCharacters_1.getBorderCharacters('honeywell'),
         ...border,
     };
 };
-exports.makeBorder = makeBorder;
+exports.makeBorderConfig = makeBorderConfig;
 /**
  * Groups the array into sub-arrays by sizes.
  *

package/package.json

@@ -7,7 +7,6 @@
   "dependencies": {
     "ajv": "^8.0.1",
     "lodash.clonedeep": "^4.5.0",
-    "lodash.flatten": "^4.4.0",
     "lodash.truncate": "^4.4.2",
     "slice-ansi": "^4.0.0",
     "string-width": "^4.2.0",
@@ -17,7 +16,6 @@
   "devDependencies": {
     "@types/chai": "^4.2.16",
     "@types/lodash.clonedeep": "^4.5.6",
-    "@types/lodash.flatten": "^4.4.6",
     "@types/lodash.mapvalues": "^4.6.6",
     "@types/lodash.truncate": "^4.4.6",
     "@types/mocha": "^8.2.2",
@@ -75,7 +73,8 @@
       "test/**/*.ts"
     ],
     "reporter": [
-      "text-lcov"
+      "text-lcov",
+      "text"
     ]
   },
   "repository": {
@@ -89,7 +88,7 @@
     "create-readme": "gitdown ./.README/README.md --output-file ./README.md",
     "create-validators": "rm -fr ./src/generated && mkdirp ./src/generated && ajv compile --all-errors --inline-refs=false -s src/schemas/config -s src/schemas/streamConfig -r src/schemas/shared -c ajv-keywords/dist/keywords/typeof -o | js-beautify > ./src/generated/validators.js",
     "lint": "eslint --ignore-path .gitignore ./src ./test",
-    "test": "npm run create-validators && mocha --require ts-node/register ./test/**/*.ts"
+    "test": "npm run create-validators && mocha --require ts-node/register \"./test/**/*.ts\""
   },
-  "version": "6.6.0"
+  "version": "6.7.0"
 }