@cubejs-client/core 0.36.2 → 1.0.0

package/dist/cubejs-client-core.js

@@ -51,11 +51,16 @@ require('core-js/modules/es.set.js');
 require('core-js/modules/es.array.index-of.js');
 require('core-js/modules/es.string.trim.js');
 var dayjs = require('dayjs');
-var quarterOfYear = require('dayjs/plugin/quarterOfYear');
-var en = require('dayjs/locale/en');
 var ramda = require('ramda');
 require('core-js/modules/es.array.every.js');
 require('core-js/modules/es.array.splice.js');
+require('core-js/modules/es.parse-int.js');
+require('core-js/modules/es.string.ends-with.js');
+require('core-js/modules/es.array.slice.js');
+var quarterOfYear = require('dayjs/plugin/quarterOfYear');
+var duration = require('dayjs/plugin/duration');
+var isoWeek = require('dayjs/plugin/isoWeek');
+var en = require('dayjs/locale/en');
 require('core-js/modules/es.function.name.js');
 require('core-js/modules/es.array.sort.js');
 require('core-js/modules/web.url-search-params.js');
@@ -80,6 +85,8 @@ var _objectWithoutProperties__default = /*#__PURE__*/_interopDefaultLegacy(_obje
 var _toConsumableArray__default = /*#__PURE__*/_interopDefaultLegacy(_toConsumableArray);
 var dayjs__default = /*#__PURE__*/_interopDefaultLegacy(dayjs);
 var quarterOfYear__default = /*#__PURE__*/_interopDefaultLegacy(quarterOfYear);
+var duration__default = /*#__PURE__*/_interopDefaultLegacy(duration);
+var isoWeek__default = /*#__PURE__*/_interopDefaultLegacy(isoWeek);
 var en__default = /*#__PURE__*/_interopDefaultLegacy(en);
 var fetch__default = /*#__PURE__*/_interopDefaultLegacy(fetch);
 var _inherits__default = /*#__PURE__*/_interopDefaultLegacy(_inherits);
@@ -87,10 +94,11 @@ var _possibleConstructorReturn__default = /*#__PURE__*/_interopDefaultLegacy(_po
 var _getPrototypeOf__default = /*#__PURE__*/_interopDefaultLegacy(_getPrototypeOf);
 var _wrapNativeSuper__default = /*#__PURE__*/_interopDefaultLegacy(_wrapNativeSuper);
 
-var _excluded$2 = ["query"];
-function ownKeys$3(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
-function _objectSpread$3(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$3(Object(t), !0).forEach(function (r) { _defineProperty__default['default'](e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$3(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-var DEFAULT_GRANULARITY = 'day';
+function ownKeys$4(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$4(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$4(Object(t), !0).forEach(function (r) { _defineProperty__default['default'](e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$4(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+dayjs__default['default'].extend(quarterOfYear__default['default']);
+dayjs__default['default'].extend(duration__default['default']);
+dayjs__default['default'].extend(isoWeek__default['default']);
 var GRANULARITIES = [{
   name: undefined,
   title: 'w/o grouping'
@@ -119,6 +127,267 @@ var GRANULARITIES = [{
   name: 'year',
   title: 'Year'
 }];
+var DEFAULT_GRANULARITY = 'day';
+
+// When granularity is week, weekStart Value must be 1. However, since the client can change it globally
+// (https://day.js.org/docs/en/i18n/changing-locale) So the function below has been added.
+var internalDayjs = function internalDayjs() {
+  return dayjs__default['default'].apply(void 0, arguments).locale(_objectSpread$4(_objectSpread$4({}, en__default['default']), {}, {
+    weekStart: 1
+  }));
+};
+var TIME_SERIES = {
+  day: function day(range) {
+    return range.by('d').map(function (d) {
+      return d.format('YYYY-MM-DDT00:00:00.000');
+    });
+  },
+  month: function month(range) {
+    return range.snapTo('month').by('M').map(function (d) {
+      return d.format('YYYY-MM-01T00:00:00.000');
+    });
+  },
+  year: function year(range) {
+    return range.snapTo('year').by('y').map(function (d) {
+      return d.format('YYYY-01-01T00:00:00.000');
+    });
+  },
+  hour: function hour(range) {
+    return range.by('h').map(function (d) {
+      return d.format('YYYY-MM-DDTHH:00:00.000');
+    });
+  },
+  minute: function minute(range) {
+    return range.by('m').map(function (d) {
+      return d.format('YYYY-MM-DDTHH:mm:00.000');
+    });
+  },
+  second: function second(range) {
+    return range.by('s').map(function (d) {
+      return d.format('YYYY-MM-DDTHH:mm:ss.000');
+    });
+  },
+  week: function week(range) {
+    return range.snapTo('week').by('w').map(function (d) {
+      return d.startOf('week').format('YYYY-MM-DDT00:00:00.000');
+    });
+  },
+  quarter: function quarter(range) {
+    return range.snapTo('quarter').by('quarter').map(function (d) {
+      return d.startOf('quarter').format('YYYY-MM-DDT00:00:00.000');
+    });
+  }
+};
+var isPredefinedGranularity = function isPredefinedGranularity(granularity) {
+  return !!TIME_SERIES[granularity];
+};
+var DateRegex = /^\d\d\d\d-\d\d-\d\d$/;
+var LocalDateRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z?$/;
+var dayRange = function dayRange(from, to) {
+  return {
+    by: function by(value) {
+      var results = [];
+      var start = internalDayjs(from);
+      var end = internalDayjs(to);
+      while (start.isBefore(end) || start.isSame(end)) {
+        results.push(start);
+        start = start.add(1, value);
+      }
+      return results;
+    },
+    snapTo: function snapTo(value) {
+      return dayRange(internalDayjs(from).startOf(value), internalDayjs(to).endOf(value));
+    },
+    start: internalDayjs(from),
+    end: internalDayjs(to)
+  };
+};
+
+/**
+ * Parse PostgreSQL-like interval string into object
+ * E.g. '2 years 15 months 100 weeks 99 hours 15 seconds'
+ * Negative units are also supported
+ * E.g. '-2 months 5 days -10 hours'
+ *
+ * TODO: It's copy/paste of parseSqlInterval from @cubejs-backend/shared [time.ts]
+ * It's not referenced to omit imports of moment.js staff.
+ * Probably one day we should choose one implementation and reuse it in other places.
+ */
+function parseSqlInterval(intervalStr) {
+  var interval = {};
+  var parts = intervalStr.split(/\s+/);
+  for (var i = 0; i < parts.length; i += 2) {
+    var value = parseInt(parts[i], 10);
+    var unit = parts[i + 1];
+
+    // Remove ending 's' (e.g., 'days' -> 'day')
+    var singularUnit = unit.endsWith('s') ? unit.slice(0, -1) : unit;
+    interval[singularUnit] = value;
+  }
+  return interval;
+}
+
+/**
+ * Adds interval to provided date.
+ * TODO: It's copy/paste of addInterval from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ * @param {dayjs} date
+ * @param interval
+ * @returns {dayjs}
+ */
+function addInterval(date, interval) {
+  var res = date.clone();
+  Object.entries(interval).forEach(function (_ref) {
+    var _ref2 = _slicedToArray__default['default'](_ref, 2),
+      key = _ref2[0],
+      value = _ref2[1];
+    res = res.add(value, key);
+  });
+  return res;
+}
+
+/**
+ * Adds interval to provided date.
+ * TODO: It's copy/paste of subtractInterval from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ * @param {dayjs} date
+ * @param interval
+ * @returns {dayjs}
+ */
+function subtractInterval(date, interval) {
+  var res = date.clone();
+  Object.entries(interval).forEach(function (_ref3) {
+    var _ref4 = _slicedToArray__default['default'](_ref3, 2),
+      key = _ref4[0],
+      value = _ref4[1];
+    res = res.subtract(value, key);
+  });
+  return res;
+}
+
+/**
+ * Returns the closest date prior to date parameter aligned with the origin point
+ * TODO: It's copy/paste of alignToOrigin from @cubejs-backend/shared [time.ts]
+ * but operates with dayjs instead of moment.js
+ */
+function alignToOrigin(startDate, interval, origin) {
+  var alignedDate = startDate.clone();
+  var intervalOp;
+  var isIntervalNegative = false;
+  var offsetDate = addInterval(origin, interval);
+
+  // The easiest way to check the interval sign
+  if (offsetDate.isBefore(origin)) {
+    isIntervalNegative = true;
+  }
+  offsetDate = origin.clone();
+  if (startDate.isBefore(origin)) {
+    intervalOp = isIntervalNegative ? addInterval : subtractInterval;
+    while (offsetDate.isAfter(startDate)) {
+      offsetDate = intervalOp(offsetDate, interval);
+    }
+    alignedDate = offsetDate;
+  } else {
+    intervalOp = isIntervalNegative ? subtractInterval : addInterval;
+    while (offsetDate.isBefore(startDate)) {
+      alignedDate = offsetDate.clone();
+      offsetDate = intervalOp(offsetDate, interval);
+    }
+    if (offsetDate.isSame(startDate)) {
+      alignedDate = offsetDate;
+    }
+  }
+  return alignedDate;
+}
+
+/**
+ * Returns the time series points for the custom interval
+ * TODO: It's almost a copy/paste of timeSeriesFromCustomInterval from
+ * @cubejs-backend/shared [time.ts] but operates with dayjs instead of moment.js
+ */
+var timeSeriesFromCustomInterval = function timeSeriesFromCustomInterval(from, to, granularity) {
+  var intervalParsed = parseSqlInterval(granularity.interval);
+  var start = internalDayjs(from);
+  var end = internalDayjs(to);
+  var origin = granularity.origin ? internalDayjs(granularity.origin) : internalDayjs().startOf('year');
+  if (granularity.offset) {
+    origin = addInterval(origin, parseSqlInterval(granularity.offset));
+  }
+  var alignedStart = alignToOrigin(start, intervalParsed, origin);
+  var dates = [];
+  while (alignedStart.isBefore(end) || alignedStart.isSame(end)) {
+    dates.push(alignedStart.format('YYYY-MM-DDTHH:mm:ss.000'));
+    alignedStart = addInterval(alignedStart, intervalParsed);
+  }
+  return dates;
+};
+
+/**
+ * Returns the lowest time unit for the interval
+ * @protected
+ * @param {string} interval
+ * @returns {string}
+ */
+var diffTimeUnitForInterval = function diffTimeUnitForInterval(interval) {
+  if (/second/i.test(interval)) {
+    return 'second';
+  } else if (/minute/i.test(interval)) {
+    return 'minute';
+  } else if (/hour/i.test(interval)) {
+    return 'hour';
+  } else if (/day/i.test(interval)) {
+    return 'day';
+  } else if (/week/i.test(interval)) {
+    return 'day';
+  } else if (/month/i.test(interval)) {
+    return 'month';
+  } else if (/quarter/i.test(interval)) {
+    return 'month';
+  } else /* if (/year/i.test(interval)) */{
+      return 'year';
+    }
+};
+var granularityOrder = ['year', 'quarter', 'month', 'week', 'day', 'hour', 'minute', 'second'];
+var minGranularityForIntervals = function minGranularityForIntervals(i1, i2) {
+  var g1 = diffTimeUnitForInterval(i1);
+  var g2 = diffTimeUnitForInterval(i2);
+  var g1pos = granularityOrder.indexOf(g1);
+  var g2pos = granularityOrder.indexOf(g2);
+  if (g1pos > g2pos) {
+    return g1;
+  }
+  return g2;
+};
+var granularityFor = function granularityFor(dateStr) {
+  var dayjsDate = internalDayjs(dateStr);
+  var month = dayjsDate.month();
+  var date = dayjsDate.date();
+  var hours = dayjsDate.hour();
+  var minutes = dayjsDate.minute();
+  var seconds = dayjsDate.second();
+  var milliseconds = dayjsDate.millisecond();
+  var weekDay = dayjsDate.isoWeekday();
+  if (month === 0 && date === 1 && hours === 0 && minutes === 0 && seconds === 0 && milliseconds === 0) {
+    return 'year';
+  } else if (date === 1 && hours === 0 && minutes === 0 && seconds === 0 && milliseconds === 0) {
+    return 'month';
+  } else if (weekDay === 1 && hours === 0 && minutes === 0 && seconds === 0 && milliseconds === 0) {
+    return 'week';
+  } else if (hours === 0 && minutes === 0 && seconds === 0 && milliseconds === 0) {
+    return 'day';
+  } else if (minutes === 0 && seconds === 0 && milliseconds === 0) {
+    return 'hour';
+  } else if (seconds === 0 && milliseconds === 0) {
+    return 'minute';
+  } else if (milliseconds === 0) {
+    return 'second';
+  }
+  return 'second'; // TODO return 'millisecond';
+};
+
+var _excluded$2 = ["query"];
+function ownKeys$3(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread$3(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$3(Object(t), !0).forEach(function (r) { _defineProperty__default['default'](e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$3(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function removeEmptyQueryFields(_query) {
   var query = _query || {};
   return ramda.fromPairs(ramda.toPairs(query).map(function (_ref) {
@@ -389,59 +658,6 @@ var _excluded$1 = ["x"],
   _excluded3 = ["title", "shortTitle"];
 function ownKeys$2(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread$2(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys$2(Object(t), !0).forEach(function (r) { _defineProperty__default['default'](e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys$2(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
-dayjs__default['default'].extend(quarterOfYear__default['default']);
-
-// When granularity is week, weekStart Value must be 1. However, since the client can change it globally (https://day.js.org/docs/en/i18n/changing-locale)
-// So the function below has been added.
-var internalDayjs = function internalDayjs() {
-  return dayjs__default['default'].apply(void 0, arguments).locale(_objectSpread$2(_objectSpread$2({}, en__default['default']), {}, {
-    weekStart: 1
-  }));
-};
-var TIME_SERIES = {
-  day: function day(range) {
-    return range.by('d').map(function (d) {
-      return d.format('YYYY-MM-DDT00:00:00.000');
-    });
-  },
-  month: function month(range) {
-    return range.snapTo('month').by('M').map(function (d) {
-      return d.format('YYYY-MM-01T00:00:00.000');
-    });
-  },
-  year: function year(range) {
-    return range.snapTo('year').by('y').map(function (d) {
-      return d.format('YYYY-01-01T00:00:00.000');
-    });
-  },
-  hour: function hour(range) {
-    return range.by('h').map(function (d) {
-      return d.format('YYYY-MM-DDTHH:00:00.000');
-    });
-  },
-  minute: function minute(range) {
-    return range.by('m').map(function (d) {
-      return d.format('YYYY-MM-DDTHH:mm:00.000');
-    });
-  },
-  second: function second(range) {
-    return range.by('s').map(function (d) {
-      return d.format('YYYY-MM-DDTHH:mm:ss.000');
-    });
-  },
-  week: function week(range) {
-    return range.snapTo('week').by('w').map(function (d) {
-      return d.startOf('week').format('YYYY-MM-DDT00:00:00.000');
-    });
-  },
-  quarter: function quarter(range) {
-    return range.snapTo('quarter').by('quarter').map(function (d) {
-      return d.startOf('quarter').format('YYYY-MM-DDT00:00:00.000');
-    });
-  }
-};
-var DateRegex = /^\d\d\d\d-\d\d-\d\d$/;
-var LocalDateRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z?$/;
 var groupByToPairs = function groupByToPairs(keyFn) {
   var acc = new Map();
   return function (data) {
@@ -464,25 +680,6 @@ var unnest = function unnest(arr) {
   });
   return res;
 };
-var dayRange = function dayRange(from, to) {
-  return {
-    by: function by(value) {
-      var results = [];
-      var start = internalDayjs(from);
-      var end = internalDayjs(to);
-      while (start.isBefore(end) || start.isSame(end)) {
-        results.push(start);
-        start = start.add(1, value);
-      }
-      return results;
-    },
-    snapTo: function snapTo(value) {
-      return dayRange(internalDayjs(from).startOf(value), internalDayjs(to).endOf(value));
-    },
-    start: internalDayjs(from),
-    end: internalDayjs(to)
-  };
-};
 var QUERY_TYPE = {
   REGULAR_QUERY: 'regularQuery',
   COMPARE_DATE_RANGE_QUERY: 'compareDateRangeQuery',
@@ -680,7 +877,7 @@ var ResultSet = /*#__PURE__*/function () {
     }
   }, {
     key: "timeSeries",
-    value: function timeSeries(timeDimension, resultIndex) {
+    value: function timeSeries(timeDimension, resultIndex, annotations) {
       if (!timeDimension.granularity) {
         return null;
       }
@@ -707,10 +904,13 @@ var ResultSet = /*#__PURE__*/function () {
         start = _dateRange2[0],
         end = _dateRange2[1];
       var range = dayRange(start, end);
-      if (!TIME_SERIES[timeDimension.granularity]) {
-        throw new Error("Unsupported time granularity: ".concat(timeDimension.granularity));
+      if (isPredefinedGranularity(timeDimension.granularity)) {
+        return TIME_SERIES[timeDimension.granularity](padToDay ? range.snapTo('d') : range);
+      }
+      if (!annotations["".concat(timeDimension.dimension, ".").concat(timeDimension.granularity)]) {
+        throw new Error("Granularity \"".concat(timeDimension.granularity, "\" not found in time dimension \"").concat(timeDimension.dimension, "\""));
       }
-      return TIME_SERIES[timeDimension.granularity](padToDay ? range.snapTo('d') : range);
+      return timeSeriesFromCustomInterval(start, end, annotations["".concat(timeDimension.dimension, ".").concat(timeDimension.granularity)].granularity);
     }
   }, {
     key: "pivot",
@@ -733,7 +933,7 @@ var ResultSet = /*#__PURE__*/function () {
           return ResultSet.timeDimensionMember(td);
         }))) {
           var series = _this2.loadResponses.map(function (loadResponse) {
-            return _this2.timeSeries(loadResponse.query.timeDimensions[0], resultIndex);
+            return _this2.timeSeries(loadResponse.query.timeDimensions[0], resultIndex, loadResponse.annotation.timeDimensions);
           });
           if (series[0]) {
             groupByXAxis = function groupByXAxis(rows) {
@@ -2155,22 +2355,35 @@ var index = (function (apiToken, options) {
 
 exports.CubeApi = CubeApi;
 exports.DEFAULT_GRANULARITY = DEFAULT_GRANULARITY;
+exports.DateRegex = DateRegex;
 exports.GRANULARITIES = GRANULARITIES;
 exports.HttpTransport = HttpTransport;
+exports.LocalDateRegex = LocalDateRegex;
 exports.Meta = Meta;
 exports.RequestError = RequestError;
 exports.ResultSet = ResultSet;
+exports.TIME_SERIES = TIME_SERIES;
+exports.addInterval = addInterval;
 exports.aliasSeries = aliasSeries;
 exports.areQueriesEqual = areQueriesEqual;
+exports.dayRange = dayRange;
 exports.default = index;
 exports.defaultHeuristics = defaultHeuristics;
 exports.defaultOrder = defaultOrder;
+exports.diffTimeUnitForInterval = diffTimeUnitForInterval;
 exports.flattenFilters = flattenFilters;
 exports.getOrderMembersFromOrder = getOrderMembersFromOrder;
 exports.getQueryMembers = getQueryMembers;
+exports.granularityFor = granularityFor;
+exports.internalDayjs = internalDayjs;
+exports.isPredefinedGranularity = isPredefinedGranularity;
 exports.isQueryPresent = isQueryPresent;
+exports.minGranularityForIntervals = minGranularityForIntervals;
 exports.moveItemInArray = moveItemInArray;
 exports.movePivotItem = movePivotItem;
+exports.parseSqlInterval = parseSqlInterval;
 exports.removeEmptyQueryFields = removeEmptyQueryFields;
+exports.subtractInterval = subtractInterval;
+exports.timeSeriesFromCustomInterval = timeSeriesFromCustomInterval;
 exports.validateQuery = validateQuery;
 //# sourceMappingURL=cubejs-client-core.js.map