pomeranian-durations/lib/transformations.js

An immutable duration library based on the ISO-8601 format for durations.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.unitNamesDesc = exports.unitNamesAsc = exports.toFragments = exports.toIso = void 0;

var _constants = require("./constants");

var _find = require("./find");

function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }

function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }

function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }

function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }

function _iterableToArrayLimit(arr, i) { var _i = arr && (typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]); if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }

function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }

var inArray = function inArray(array, element) {
  return array.indexOf(element) !== -1;
};

var hasKey = function hasKey(object, keyName) {
  return inArray(Object.keys(object), keyName);
};

var buildIsoComponent = function buildIsoComponent(fragments, units, includeZeroValues) {
  return Object.keys(fragments).filter(function (unitName) {
    return hasKey(units, unitName);
  }).sort(function (a, b) {
    var sortedUnitNames = Object.keys(_constants.UNITS);
    return sortedUnitNames.indexOf(b) - sortedUnitNames.indexOf(a);
  }).reduce(function (prev, name) {
    if (!includeZeroValues && fragments[name] === 0) {
      return prev;
    }

    var unit = units[name];
    var value = parseFloat(fragments[name]);
    return "".concat(prev).concat(value).concat(unit);
  }, '');
};

var buildDateComponent = function buildDateComponent(fragments, includeZeroValues) {
  var dateComponent = buildIsoComponent(fragments, _constants.DATE_UNITS, includeZeroValues);
  return "".concat(_constants.DURATION_DESIGNATOR).concat(dateComponent);
};

var buildTimeComponent = function buildTimeComponent(fragments, includeZeroValues) {
  var timeComponent = buildIsoComponent(fragments, _constants.TIME_UNITS, includeZeroValues);
  return timeComponent ? "".concat(_constants.TIME_DESIGNATOR).concat(timeComponent) : '';
};
/**
 * Converts an object to an ISO duration.
 * @param fragments {object} - object containing the unit as key.
 *    (available keys: seconds, minutes, hours, days, weeks, months, years)
 * @returns {string}
 * @example
 * toIso({ seconds: 1, hours: 2 }) // => 'PT2H1S'
 */


var toIso = function toIso(fragments) {
  var _ref = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
      _ref$includeZeroValue = _ref.includeZeroValues,
      includeZeroValues = _ref$includeZeroValue === void 0 ? false : _ref$includeZeroValue;

  var dateComponent = buildDateComponent(fragments, includeZeroValues);
  var timeComponent = buildTimeComponent(fragments, includeZeroValues);
  return "".concat(dateComponent).concat(timeComponent);
};
/**
 * Splits all components of an ISO8601 duration into its units.
 * @param isoString {string|undefined|null}
 * @returns {object}
 * @example
 * toFragments('PT1H1S') // => ({ seconds: 1, minutes: 0, hours: 1, days: 0, weeks: 0, months: 0, years: 0 })
 */


exports.toIso = toIso;

var toFragments = function toFragments(isoString) {
  var _ref2 = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {},
      _ref2$defaultValue = _ref2.defaultValue,
      defaultValue = _ref2$defaultValue === void 0 ? 0 : _ref2$defaultValue;

  return {
    seconds: (0, _find.findSeconds)(isoString) || defaultValue,
    minutes: (0, _find.findMinutes)(isoString) || defaultValue,
    hours: (0, _find.findHours)(isoString) || defaultValue,
    days: (0, _find.findDays)(isoString) || defaultValue,
    weeks: (0, _find.findWeeks)(isoString) || defaultValue,
    months: (0, _find.findMonths)(isoString) || defaultValue,
    years: (0, _find.findYears)(isoString) || defaultValue
  };
};
/**
 * Returns all non 0 unit names from a given ISO8601 duration ordered from lowest to highest
 * @param isoString {string|undefined|null}
 * @returns {String[]}
 * @example
 * unitNamesAsc('PT1H1S') // => ['seconds', 'hours']
 */


exports.toFragments = toFragments;

var unitNamesAsc = function unitNamesAsc(isoString) {
  var unitNames = Object.entries(toFragments(isoString)).filter(function (entry) {
    return entry[1] !== 0;
  }).map(function (_ref3) {
    var _ref4 = _slicedToArray(_ref3, 1),
        unitName = _ref4[0];

    return unitName;
  });
  return _constants.UNIT_NAMES_LIST.filter(function (unitName) {
    return unitNames.includes(unitName);
  });
};
/**
 * Returns all non 0 unit names from a given ISO8601 duration ordered from highest to lowest
 * @param isoString {string|undefined|null}
 * @returns {String[]}
 * @example
 * unitNamesDesc('PT1H1S') // => ['hours', 'seconds']
 */


exports.unitNamesAsc = unitNamesAsc;

var unitNamesDesc = function unitNamesDesc(isoString) {
  return unitNamesAsc(isoString).reverse();
};

exports.unitNamesDesc = unitNamesDesc;