@bentoboxes/nova-utils/src/utils/date-utils.js

This set of utilities are intended to

import moment from "moment";
import "moment-timezone";

const INPUT_FORMATS = {
  SIMPLE_ISO: "YYYY-MM-DD HH:mm:ss",
  ORDINAL_DATE: "YYYY-DDD",
  MILLIS: "x",
  ISO: "YYYY-MM-DDTHH:mm:ss.sssZ",
  CALENDAR_DATE: "YYYY-MM-DD"
};

const DEFAULT_INPUT_FORMAT = INPUT_FORMATS.SIMPLE_ISO;
const DEFAULT_OUTPUT_FORMAT = "DD/MM/YYYY";
const DEFAULT_TIME_ZONE_INPUT = "";
const DEFAULT_TIME_ZONE_OUTPUT = "";

/** Class with static methods related to dates' management */
class DateUtils {
  /**
   * Formats a string or milliseconds date using an output format and input format
   * @static
   * @param {string|number} date - The date string to be formatted
   * @param {string} outputFormat='DD/MM/YYYY' - The desired output format
   * @param {string} inputFormat='YYYY-MM-DD HH:mm:ss' - The format of the input string, it is used to parse the date parameter
   * @param {string} inputTimeZone='America/Los_Angeles' - The desired input time zone format
   * @param {boolean} showTimeZone=true - Used to define if the time zone should be displayed
   * @param {string} outputTimeZone='z' - The desired output time zone format
   * @retun {string} The formatted date
   */
  static formatDate(
    date,
    outputFormat = DEFAULT_OUTPUT_FORMAT,
    inputFormat = DEFAULT_INPUT_FORMAT,
    outputTimeZone = DEFAULT_TIME_ZONE_OUTPUT,
    inputTimeZone = DEFAULT_TIME_ZONE_INPUT,
    showTimeZone = false
  ) {
    let dateParsed =
      inputFormat === INPUT_FORMATS.SIMPLE_ISO
        ? moment(date, inputFormat)
        : moment(date, INPUT_FORMATS[inputFormat]);

    dateParsed.tz(inputTimeZone);

    const formattedDate = showTimeZone
      ? dateParsed.format(`${outputFormat}, ${outputTimeZone}`)
      : dateParsed.format(outputFormat); // It uses the format() of moment.js
    return dateParsed.isValid()
      ? formattedDate // The formatted date
      : date;
  }

  static formatDateByObj(params) {
    const {
      date,
      outputFormat,
      inputFormat,
      outputTimeZone,
      inputTimeZone,
      showTimeZone
    } = params;

    return DateUtils.formatDate(
      date,
      outputFormat,
      inputFormat,
      outputTimeZone,
      inputTimeZone,
      showTimeZone
    );
  }

  static formatCustomDate(
    date,
    outputFormat = DEFAULT_OUTPUT_FORMAT,
    inputFormat = DEFAULT_INPUT_FORMAT,
    outputTimeZone = DEFAULT_TIME_ZONE_OUTPUT,
    inputTimeZone = DEFAULT_TIME_ZONE_INPUT,
    showTimeZone = false
  ) {
    let dateParsed = moment(date, inputFormat);

    if(showTimeZone){
      dateParsed.tz(inputTimeZone);
    }

    const formattedDate = showTimeZone
      ? dateParsed.format(`${outputFormat}, ${outputTimeZone}`)
      : dateParsed.format(outputFormat); // It uses the format() of moment.js
    return dateParsed.isValid()
      ? formattedDate // The formatted date
      : date;
  }

  /**
   * Parses a string date to a JavaScript Date object
   * @static
   * @param {string} date - The date string to be parsed
   * @param {string} inputFormat='YYYY-MM-DD HH:mm:ss' - The format of the input string, it is used to parse the date parameter
   * @retun {string} The JavaScript Date object
   */
  static parseDate(date, inputFormat = DEFAULT_INPUT_FORMAT) {
    let dateParsed =
      inputFormat === INPUT_FORMATS.SIMPLE_ISO
        ? moment(date, inputFormat)
        : moment(date, INPUT_FORMATS[inputFormat]);

    return dateParsed.toDate();
  }

  /**
   * Returns a relative date using an start date, end date and input formats
   * @static
   * @param {string|number} startDate - The start date string
   * @param {string|number} endDate - The end date string
   * @param {string} inputFormat='YYYY-MM-DD HH:mm:ss' - The format of the input string, it is used to parse the startDate parameter and validate it.
   * @retun {string} The relative date
   */
  static relativeDateFromInterval(
    startDate,
    endDate,
    inputFormat = DEFAULT_INPUT_FORMAT
  ) {
    let startDateParsed = null;
    let endDateParsed = null;

    if (inputFormat === INPUT_FORMATS.SIMPLE_ISO) {
      startDateParsed = moment(startDate, inputFormat);
      endDateParsed = moment(endDate, inputFormat);
    } else {
      let existingInputFormat = INPUT_FORMATS[inputFormat];

      if (!existingInputFormat) {
        existingInputFormat = inputFormat;
      }
      startDateParsed = moment(startDate, existingInputFormat);
      endDateParsed = moment(endDate, existingInputFormat);
    }

    return startDateParsed.isValid() && endDateParsed.isValid()
      ? moment(endDateParsed).from(startDateParsed, true)
      : startDate + " - " + endDate;
  }

  /**
   * Returns a relative date using an start date, end date and input formats
   * @static
   * @return {Object} Moment
   */
  static getMomentJS() {
    return moment;
  }
}

export { DateUtils, INPUT_FORMATS };