@dhis2/analytics 26.10.2 → 26.11.0

package/build/cjs/components/PeriodDimension/utils/relativePeriods.js

@@ -3,144 +3,242 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getRelativePeriodsOptionsById = exports.getRelativePeriodsOptions = exports.getRelativePeriodIds = void 0;
+exports.getRelativePeriodsOptionsById = exports.getRelativePeriodsOptions = exports.getRelativePeriodsName = exports.getRelativePeriodsDetails = exports.getRelativePeriodIds = void 0;
 var _index = _interopRequireDefault(require("../../../locales/index.js"));
 var _index2 = require("./index.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/* 
+In getDaysPeriodType, getWeeksPeriodType, getBiWeeksPeriodType,
+getBiWeeksPeriodType, getMonthsPeriodType, getBiMonthsPeriodType,
+getQuartersPeriodType, getSixMonthsPeriodType,
+getFinancialYearsPeriodType, and getYearsPeriodType:
+-   duration: The number of individual periods in the preset
+    (the maximum when the duration is variable).
+    eg: LAST_14_DAYS duration is 14
+-   offset: The position of the most recent individual period
+    relative to THIS period in the preset, earlier periods are
+    negative (the maximum when the offset is variable).
+    eg: LAST_BIMONTH offset is -1
+*/
+
 const getDaysPeriodType = () => [{
   id: 'TODAY',
-  name: _index.default.t('Today')
+  name: _index.default.t('Today'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'YESTERDAY',
-  name: _index.default.t('Yesterday')
+  name: _index.default.t('Yesterday'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_3_DAYS',
-  name: _index.default.t('Last 3 days')
+  name: _index.default.t('Last 3 days'),
+  offset: -1,
+  duration: 3
 }, {
   id: 'LAST_7_DAYS',
-  name: _index.default.t('Last 7 days')
+  name: _index.default.t('Last 7 days'),
+  offset: -1,
+  duration: 7
 }, {
   id: 'LAST_14_DAYS',
-  name: _index.default.t('Last 14 days')
+  name: _index.default.t('Last 14 days'),
+  offset: -1,
+  duration: 14
 }, {
   id: 'LAST_30_DAYS',
-  name: _index.default.t('Last 30 days')
+  name: _index.default.t('Last 30 days'),
+  offset: -1,
+  duration: 30
 }, {
   id: 'LAST_60_DAYS',
-  name: _index.default.t('Last 60 days')
+  name: _index.default.t('Last 60 days'),
+  offset: -1,
+  duration: 60
 }, {
   id: 'LAST_90_DAYS',
-  name: _index.default.t('Last 90 days')
+  name: _index.default.t('Last 90 days'),
+  offset: -1,
+  duration: 90
 }, {
   id: 'LAST_180_DAYS',
-  name: _index.default.t('Last 180 days')
+  name: _index.default.t('Last 180 days'),
+  offset: -1,
+  duration: 180
 }];
 const getWeeksPeriodType = () => [{
   id: 'THIS_WEEK',
-  name: _index.default.t('This week')
+  name: _index.default.t('This week'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_WEEK',
-  name: _index.default.t('Last week')
+  name: _index.default.t('Last week'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_4_WEEKS',
-  name: _index.default.t('Last 4 weeks')
+  name: _index.default.t('Last 4 weeks'),
+  offset: -1,
+  duration: 4
 }, {
   id: 'LAST_12_WEEKS',
-  name: _index.default.t('Last 12 weeks')
+  name: _index.default.t('Last 12 weeks'),
+  offset: -1,
+  duration: 12
 }, {
   id: 'LAST_52_WEEKS',
-  name: _index.default.t('Last 52 weeks')
+  name: _index.default.t('Last 52 weeks'),
+  offset: -1,
+  duration: 52
 }, {
   id: _index2.WEEKS_THIS_YEAR,
-  name: _index.default.t('Weeks this year')
+  name: _index.default.t('Weeks this year'),
+  offset: 51,
+  duration: 52
 }];
 const getBiWeeksPeriodType = () => [{
   id: 'THIS_BIWEEK',
-  name: _index.default.t('This bi-week')
+  name: _index.default.t('This bi-week'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_BIWEEK',
-  name: _index.default.t('Last bi-week')
+  name: _index.default.t('Last bi-week'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_4_BIWEEKS',
-  name: _index.default.t('Last 4 bi-weeks')
+  name: _index.default.t('Last 4 bi-weeks'),
+  offset: -1,
+  duration: 4
 }];
 const getMonthsPeriodType = () => [{
   id: 'THIS_MONTH',
-  name: _index.default.t('This month')
+  name: _index.default.t('This month'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_MONTH',
-  name: _index.default.t('Last month')
+  name: _index.default.t('Last month'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_3_MONTHS',
-  name: _index.default.t('Last 3 months')
+  name: _index.default.t('Last 3 months'),
+  offset: -1,
+  duration: 3
 }, {
   id: 'LAST_6_MONTHS',
-  name: _index.default.t('Last 6 months')
+  name: _index.default.t('Last 6 months'),
+  offset: -1,
+  duration: 6
 }, {
   id: 'LAST_12_MONTHS',
-  name: _index.default.t('Last 12 months')
+  name: _index.default.t('Last 12 months'),
+  offset: -1,
+  duration: 12
 }, {
   id: 'MONTHS_THIS_YEAR',
-  name: _index.default.t('Months this year')
+  name: _index.default.t('Months this year'),
+  offset: 11,
+  duration: 12
 }];
 const getBiMonthsPeriodType = () => [{
   id: 'THIS_BIMONTH',
-  name: _index.default.t('This bi-month')
+  name: _index.default.t('This bi-month'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_BIMONTH',
-  name: _index.default.t('Last bi-month')
+  name: _index.default.t('Last bi-month'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_6_BIMONTHS',
-  name: _index.default.t('Last 6 bi-months')
+  name: _index.default.t('Last 6 bi-months'),
+  offset: -1,
+  duration: 6
 }, {
   id: 'BIMONTHS_THIS_YEAR',
-  name: _index.default.t('Bi-months this year')
+  name: _index.default.t('Bi-months this year'),
+  offset: 5,
+  duration: 6
 }];
 const getQuartersPeriodType = () => [{
   id: 'THIS_QUARTER',
-  name: _index.default.t('This quarter')
+  name: _index.default.t('This quarter'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_QUARTER',
-  name: _index.default.t('Last quarter')
+  name: _index.default.t('Last quarter'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_4_QUARTERS',
-  name: _index.default.t('Last 4 quarters')
+  name: _index.default.t('Last 4 quarters'),
+  offset: -1,
+  duration: 4
 }, {
   id: 'QUARTERS_THIS_YEAR',
-  name: _index.default.t('Quarters this year')
+  name: _index.default.t('Quarters this year'),
+  offset: 3,
+  duration: 4
 }];
 const getSixMonthsPeriodType = () => [{
   id: 'THIS_SIX_MONTH',
-  name: _index.default.t('This six-month')
+  name: _index.default.t('This six-month'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_SIX_MONTH',
-  name: _index.default.t('Last six-month')
+  name: _index.default.t('Last six-month'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_2_SIXMONTHS',
-  name: _index.default.t('Last 2 six-month')
+  name: _index.default.t('Last 2 six-month'),
+  offset: -1,
+  duration: 2
 }];
 const getFinancialYearsPeriodType = () => [{
   id: 'THIS_FINANCIAL_YEAR',
-  name: _index.default.t('This financial year')
+  name: _index.default.t('This financial year'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_FINANCIAL_YEAR',
-  name: _index.default.t('Last financial year')
+  name: _index.default.t('Last financial year'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_5_FINANCIAL_YEARS',
-  name: _index.default.t('Last 5 financial years')
+  name: _index.default.t('Last 5 financial years'),
+  offset: -1,
+  duration: 5
 }];
 const getYearsPeriodType = () => [{
   id: 'THIS_YEAR',
-  name: _index.default.t('This year')
+  name: _index.default.t('This year'),
+  offset: 0,
+  duration: 1
 }, {
   id: 'LAST_YEAR',
-  name: _index.default.t('Last year')
+  name: _index.default.t('Last year'),
+  offset: -1,
+  duration: 1
 }, {
   id: 'LAST_5_YEARS',
-  name: _index.default.t('Last 5 years')
+  name: _index.default.t('Last 5 years'),
+  offset: -1,
+  duration: 5
 }, {
   id: 'LAST_10_YEARS',
-  name: _index.default.t('Last 10 years')
+  name: _index.default.t('Last 10 years'),
+  offset: -1,
+  duration: 10
 }];
 const getOptions = () => [{
   id: _index2.DAILY,
@@ -184,4 +282,20 @@ exports.getRelativePeriodsOptionsById = getRelativePeriodsOptionsById;
 const getRelativePeriodsOptions = () => getOptions();
 exports.getRelativePeriodsOptions = getRelativePeriodsOptions;
 const getRelativePeriodIds = () => Object.values(getOptions()).map(option => option.getPeriods().map(period => period.id)).flat();
-exports.getRelativePeriodIds = getRelativePeriodIds;
+exports.getRelativePeriodIds = getRelativePeriodIds;
+const getRelativePeriodsDetails = () => Object.values(getOptions()).map(option => option.getPeriods().map(period => ({
+  id: period.id,
+  name: period.name,
+  offset: period.offset,
+  duration: period.duration,
+  type: option.id
+}))).flat().reduce((acc, period) => {
+  acc[period.id] = period;
+  return acc;
+}, {});
+exports.getRelativePeriodsDetails = getRelativePeriodsDetails;
+const getRelativePeriodsName = () => Object.values(getOptions()).map(option => option.getPeriods()).flat().reduce((acc, period) => {
+  acc[period.id] = period.name;
+  return acc;
+}, {});
+exports.getRelativePeriodsName = getRelativePeriodsName;

package/build/cjs/index.js

@@ -242,7 +242,10 @@ var _exportNames = {
   FYJUL: true,
   FYAPR: true,
   getRelativePeriodsOptionsById: true,
+  getRelativePeriodsName: true,
+  getRelativePeriodsDetails: true,
   getFixedPeriodsOptionsById: true,
+  PERIOD_TYPE_REGEX: true,
   VisualizationOptions: true,
   DIMENSION_TYPE_INDICATOR: true,
   DIMENSION_TYPE_DATA_ELEMENT: true,
@@ -839,6 +842,12 @@ Object.defineProperty(exports, "OrgUnitDimension", {
     return _OrgUnitDimension.default;
   }
 });
+Object.defineProperty(exports, "PERIOD_TYPE_REGEX", {
+  enumerable: true,
+  get: function () {
+    return _fixedPeriods.PERIOD_TYPE_REGEX;
+  }
+});
 Object.defineProperty(exports, "PeriodDimension", {
   enumerable: true,
   get: function () {
@@ -1565,6 +1574,18 @@ Object.defineProperty(exports, "getPredefinedDimensions", {
     return _predefinedDimensions.getPredefinedDimensions;
   }
 });
+Object.defineProperty(exports, "getRelativePeriodsDetails", {
+  enumerable: true,
+  get: function () {
+    return _relativePeriods.getRelativePeriodsDetails;
+  }
+});
+Object.defineProperty(exports, "getRelativePeriodsName", {
+  enumerable: true,
+  get: function () {
+    return _relativePeriods.getRelativePeriodsName;
+  }
+});
 Object.defineProperty(exports, "getRelativePeriodsOptionsById", {
   enumerable: true,
   get: function () {

package/build/es/components/PeriodDimension/PeriodDimension.js

@@ -17,7 +17,8 @@ const PeriodDimension = _ref => {
     selectedPeriods,
     rightFooter,
     excludedPeriodTypes,
-    infoBoxMessage
+    infoBoxMessage,
+    height
   } = _ref;
   const {
     systemInfo
@@ -50,12 +51,14 @@ const PeriodDimension = _ref => {
     rightFooter: rightFooter,
     dataTest: 'period-dimension',
     excludedPeriodTypes: excludedPeriodTypes,
-    periodsSettings: periodsSettings
+    periodsSettings: periodsSettings,
+    height: height
   });
 };
 PeriodDimension.propTypes = {
   onSelect: PropTypes.func.isRequired,
   excludedPeriodTypes: PropTypes.arrayOf(PropTypes.string),
+  height: PropTypes.string,
   infoBoxMessage: PropTypes.string,
   rightFooter: PropTypes.node,
   selectedPeriods: PropTypes.array

package/build/es/components/PeriodDimension/PeriodTransfer.js

@@ -41,7 +41,8 @@ const PeriodTransfer = _ref2 => {
     rightFooter,
     excludedPeriodTypes,
     periodsSettings,
-    infoBoxMessage
+    infoBoxMessage,
+    height = TRANSFER_HEIGHT
   } = _ref2;
   const defaultRelativePeriodType = excludedPeriodTypes.includes(MONTHLY) ? getRelativePeriodsOptionsById(QUARTERLY) : getRelativePeriodsOptionsById(MONTHLY);
   const defaultFixedPeriodType = excludedPeriodTypes.includes(MONTHLY) ? getFixedPeriodsOptionsById(QUARTERLY, periodsSettings) : getFixedPeriodsOptionsById(MONTHLY, periodsSettings);
@@ -142,7 +143,7 @@ const PeriodTransfer = _ref2 => {
     selected: selectedItems.map(period => period.id),
     leftHeader: renderLeftHeader(),
     enableOrderChange: true,
-    height: TRANSFER_HEIGHT,
+    height: height,
     optionsWidth: TRANSFER_OPTIONS_WIDTH,
     selectedWidth: TRANSFER_SELECTED_WIDTH,
     selectedEmptyComponent: renderEmptySelection(),
@@ -187,6 +188,7 @@ PeriodTransfer.propTypes = {
   onSelect: PropTypes.func.isRequired,
   dataTest: PropTypes.string,
   excludedPeriodTypes: PropTypes.arrayOf(PropTypes.string),
+  height: PropTypes.string,
   infoBoxMessage: PropTypes.string,
   periodsSettings: PropTypes.shape({
     calendar: PropTypes.string,