@contentstack/cli-utilities/lib/inquirer-table-prompt.js

Utilities for contentstack projects

"use strict";
const chalk = require('chalk');
const figures = require('figures');
const Table = require('cli-table');
const cliCursor = require('cli-cursor');
const Base = require('inquirer/lib/prompts/base');
const observe = require('inquirer/lib/utils/events');
const { map, takeUntil } = require('rxjs/operators');
const Choices = require('inquirer/lib/objects/choices');
class TablePrompt extends Base {
    /**
     * Initialise the prompt
     *
     * @param  {Object} questions
     * @param  {Object} rl
     * @param  {Object} answers
     */
    constructor(questions, rl, answers) {
        super(questions, rl, answers);
        this.selectAll = this.opt.selectAll || false;
        const formattedRows = this.selectAll
            ? [
                {
                    name: 'Select All',
                    value: 'selectAll',
                },
                ...(this.opt.rows || []),
            ]
            : [];
        this.columns = new Choices(this.opt.columns, []);
        this.pointer = 0;
        this.horizontalPointer = 0;
        this.rows = new Choices(formattedRows, []);
        this.values = this.columns.filter(() => true).map(() => undefined);
        this.pageSize = this.opt.pageSize || 5;
    }
    /**
     * Start the inquirer session
     *
     * @param  {Function} callback
     * @return {TablePrompt}
     */
    _run(callback) {
        this.done = callback;
        const events = observe(this.rl);
        const validation = this.handleSubmitEvents(events.line.pipe(map(this.getCurrentValue.bind(this))));
        validation.success.forEach(this.onEnd.bind(this));
        validation.error.forEach(this.onError.bind(this));
        events.keypress.forEach(({ key }) => {
            switch (key.name) {
                case 'left':
                    return this.onLeftKey();
                case 'right':
                    return this.onRightKey();
            }
        });
        events.normalizedUpKey.pipe(takeUntil(validation.success)).forEach(this.onUpKey.bind(this));
        events.normalizedDownKey.pipe(takeUntil(validation.success)).forEach(this.onDownKey.bind(this));
        events.spaceKey.pipe(takeUntil(validation.success)).forEach(this.onSpaceKey.bind(this));
        if (this.rl.line) {
            this.onKeypress();
        }
        cliCursor.hide();
        this.render();
        return this;
    }
    getCurrentValue() {
        const currentValue = [];
        this.rows.forEach((row, rowIndex) => {
            currentValue.push(this.values[rowIndex]);
        });
        return currentValue;
    }
    onDownKey() {
        const length = this.rows.realLength;
        this.pointer = this.pointer < length - 1 ? this.pointer + 1 : this.pointer;
        this.render();
    }
    onEnd(state) {
        this.status = 'answered';
        this.spaceKeyPressed = true;
        this.render();
        this.screen.done();
        cliCursor.show();
        if (this.selectAll) {
            // remove select all row
            const [, ...truncatedValue] = state.value;
            this.done(truncatedValue);
        }
        else {
            this.done(state.value);
        }
    }
    onError(state) {
        this.render(state.isValid);
    }
    onLeftKey() {
        const length = this.columns.realLength;
        this.horizontalPointer = this.horizontalPointer > 0 ? this.horizontalPointer - 1 : length - 1;
        this.render();
    }
    onRightKey() {
        const length = this.columns.realLength;
        this.horizontalPointer = this.horizontalPointer < length - 1 ? this.horizontalPointer + 1 : 0;
        this.render();
    }
    selectAllValues(value) {
        let values = [];
        for (let i = 0; i < this.rows.length; i++) {
            values.push(value);
        }
        this.values = values;
    }
    onSpaceKey() {
        var _a;
        const value = this.columns.get(this.horizontalPointer).value;
        const rowValue = ((_a = this.rows.get(this.pointer)) === null || _a === void 0 ? void 0 : _a.value) || '';
        if (rowValue === 'selectAll') {
            this.selectAllValues(value);
        }
        else {
            this.values[this.pointer] = value;
        }
        this.spaceKeyPressed = true;
        this.render();
    }
    onUpKey() {
        this.pointer = this.pointer > 0 ? this.pointer - 1 : this.pointer;
        this.render();
    }
    paginate() {
        const middleOfPage = Math.floor(this.pageSize / 2);
        const firstIndex = Math.max(0, this.pointer - middleOfPage);
        const lastIndex = Math.min(firstIndex + this.pageSize - 1, this.rows.realLength - 1);
        const lastPageOffset = this.pageSize - 1 - lastIndex + firstIndex;
        return [Math.max(0, firstIndex - lastPageOffset), lastIndex];
    }
    render(error) {
        let message = this.getQuestion();
        let bottomContent = '';
        if (!this.spaceKeyPressed) {
            message +=
                '(Press ' +
                    chalk.cyan.bold('<space>') +
                    ' to select, ' +
                    chalk.cyan.bold('<Up and Down>') +
                    ' to move rows, ' +
                    chalk.cyan.bold('<Left and Right>') +
                    ' to move columns)';
        }
        const [firstIndex, lastIndex] = this.paginate();
        const table = new Table({
            head: [chalk.reset.dim(`${firstIndex + 1}-${lastIndex} of ${this.rows.realLength - 1}`)].concat(this.columns.pluck('name').map((name) => chalk.reset.bold(name))),
        });
        this.rows.forEach((row, rowIndex) => {
            if (rowIndex < firstIndex || rowIndex > lastIndex)
                return;
            const columnValues = [];
            this.columns.forEach((column, columnIndex) => {
                const isSelected = this.status !== 'answered' && this.pointer === rowIndex && this.horizontalPointer === columnIndex;
                const value = column.value === this.values[rowIndex] ? figures.radioOn : figures.radioOff;
                columnValues.push(`${isSelected ? '[' : ' '} ${value} ${isSelected ? ']' : ' '}`);
            });
            const chalkModifier = this.status !== 'answered' && this.pointer === rowIndex ? chalk.reset.bold.cyan : chalk.reset;
            table.push({
                [chalkModifier(row.name)]: columnValues,
            });
        });
        message += '\n\n' + table.toString();
        if (error) {
            bottomContent = chalk.red('>> ') + error;
        }
        this.screen.render(message, bottomContent);
    }
}
module.exports = TablePrompt;