kinvey-cli/lib/CommandResult.js

/**
 * Copyright (c) 2018, Kinvey, Inc. All rights reserved.
 *
 * This software is licensed to you under the Kinvey terms of service located at
 * http://www.kinvey.com/terms-of-use. By downloading, accessing and/or using this
 * software, you hereby accept such terms of service  (and any agreement referenced
 * therein) and agree that you have read, understand and agree to be bound by such
 * terms of service and are of legal age to agree to such terms with Kinvey.
 *
 * This software contains valuable confidential and proprietary information of
 * KINVEY, INC and is subject to applicable licensing agreements.
 * Unauthorized reproduction, transmission or distribution of this file and its
 * contents is a violation of applicable laws.
 */

const consoleTable = require('console.table');

const { EOL } = require('os');

const { OperationMessage, OperationType, OutputFormat } = require('./Constants');
const { isEmpty, isNullOrUndefined, isStringWhitespace } = require('./Utils');

/**
 * Defines the result from the successful execution of a command.
 */
class CommandResult {
  /**
   * Creates CommandResult object.
   */
  constructor() {
    this.rawData = null;
    this.tableData = null;
    this.humanReadableFormat = {
      userFriendlyMsg: ''
    };
  }

  /**
   * Sets raw data that will be used for building formatted result as JSON or to construct a table.
   * @param data
   * @returns {CommandResult}
   */
  setRawData(data) {
    this.rawData = data;
    return this;
  }

  _getTableData() {
    return this.tableData || this.rawData;
  }

  /**
   * Set table data that will be used to build a table.
   * @param {Array|Object} data
   * @returns {CommandResult}
   */
  setTableData(data) {
    this.tableData = data;
    return this;
  }

  /**
   * Get human-readable result: either table or a basic string.
   * @returns {String}
   * @private
   */
  _getHumanReadableResult() {
    if (this._humanReadableFormatIsTable()) {
      const tableData = this._getTableData();
      const formattedTableData = consoleTable.getTable(tableData);
      return Array.isArray(tableData) ? `Count: ${tableData.length}${EOL}${EOL}${formattedTableData}` : formattedTableData;
    }

    return this._getUserFriendlyMsg();
  }

  /**
   * Get result in JSON format: { "result": data }
   * @private
   */
  _getJSONResult() {
    const result = {
      result: this.rawData
    };

    const stringifiedResult = JSON.stringify(result, null, 2);
    return stringifiedResult;
  }

  /**
   * Get result in the chosen format.
   * @param {Constants.OutputFormat} format
   * @returns {*}
   */
  getFormattedResult(format) {
    let result;

    if (format === OutputFormat.JSON) {
      result = this._getJSONResult();
    } else {
      result = this._getHumanReadableResult();
    }

    return result;
  }

  _getUserFriendlyMsg() {
    return this.humanReadableFormat.userFriendlyMsg;
  }

  /**
   * Sets a basic user-friendly message based on the operation type and entity.
   * @param {Constants.OperationType} operationType
   * @param {Constants.EntityType} entityType
   * @param [entityId]
   */
  setBasicMsg(operationType, entityType, entityId) {
    const id = entityId || (this.rawData && this.rawData.id);
    const skipId = operationType === OperationType.SAVE || isNullOrUndefined(id);
    const msgLastPart = skipId ? '.' : `: ${id}`;
    this.humanReadableFormat.userFriendlyMsg = `${OperationMessage[operationType]} ${entityType}${msgLastPart}`;
    return this;
  }

  /**
   * Appends an additional message to the user friendly message.
   * @param {String} msg
   * @param {String} [separator]
   */
  setAdditionalMsg(msg, separator = EOL) {
    this.humanReadableFormat.userFriendlyMsg = `${this.humanReadableFormat.userFriendlyMsg}${separator}${msg}`;
    return this;
  }

  /**
   * Sets a custom user-friendly message.
   * @param {String} msg
   * @returns {CommandResult}
   */
  setCustomMsg(msg) {
    this.humanReadableFormat.userFriendlyMsg = msg;
    return this;
  }

  /**
   * Returns true if userFriendlyMsg is not available or if there is sufficient data to build a table. Otherwise, false.
   * @returns {boolean}
   */
  _humanReadableFormatIsTable() {
    const isTable = isStringWhitespace(this.humanReadableFormat.userFriendlyMsg) && (!isNullOrUndefined(this.tableData) || !isNullOrUndefined(this.rawData));
    return isTable;
  }
}

module.exports = CommandResult;