@dhis2/analytics 24.8.0 → 24.9.0

package/CHANGELOG.md

@@ -1,8 +1,48 @@
-# [24.8.0](https://github.com/dhis2/analytics/compare/v24.7.0...v24.8.0) (2023-02-16)
+# [24.9.0](https://github.com/dhis2/analytics/compare/v24.8.0...v24.9.0) (2023-02-24)
+
+
+### Features
+
+* merge multi-calendar support from alpha to master ([#1434](https://github.com/dhis2/analytics/issues/1434)) ([3cdac8f](https://github.com/dhis2/analytics/commit/3cdac8fdefc7a15a3fef0940183ca92f03b0f57c))
+
+# [24.9.0-alpha.1](https://github.com/dhis2/analytics/compare/v24.8.0...v24.9.0-alpha.1) (2023-02-23)
+
+
+### Bug Fixes
+
+* bump multi-calendar-dates to avoid jest config change ([3e5892a](https://github.com/dhis2/analytics/commit/3e5892aa88a087dde3405a518625f4c6e637d17e))
+* ensure date falls back to year if no eraYear present ([2a197d5](https://github.com/dhis2/analytics/commit/2a197d57be8ac2af6dbe331dd8f11ab9069afa5d))
+
+
+### Features
+
+* localise fixed periods according to user settings ([c640c90](https://github.com/dhis2/analytics/commit/c640c90ce2d1944a14706507284af43c7480fa2a))
+* use multi-calendar-dates library to generate fixed periods ([acc3801](https://github.com/dhis2/analytics/commit/acc380156092f888cfa55f70b4bade1c6516d034))
+
+# [24.5.0-alpha.3](https://github.com/dhis2/analytics/compare/v24.5.0-alpha.2...v24.5.0-alpha.3) (2023-02-23)
 
 
 ### Features
 
+* localise fixed periods according to user settings ([c640c90](https://github.com/dhis2/analytics/commit/c640c90ce2d1944a14706507284af43c7480fa2a))
+
+# [24.5.0-alpha.2](https://github.com/dhis2/analytics/compare/v24.5.0-alpha.1...v24.5.0-alpha.2) (2023-02-14)
+
+
+### Bug Fixes
+
+* bump multi-calendar-dates to avoid jest config change ([3e5892a](https://github.com/dhis2/analytics/commit/3e5892aa88a087dde3405a518625f4c6e637d17e))
+
+# [24.5.0-alpha.1](https://github.com/dhis2/analytics/compare/v24.4.2...v24.5.0-alpha.1) (2023-02-07)
+
+
+### Bug Fixes
+
+* ensure date falls back to year if no eraYear present ([2a197d5](https://github.com/dhis2/analytics/commit/2a197d57be8ac2af6dbe331dd8f11ab9069afa5d))
+
+# [24.8.0](https://github.com/dhis2/analytics/compare/v24.7.0...v24.8.0) (2023-02-16)
+
+
 * add prop for controlling user org unit selector DHIS2-14744 ([#1430](https://github.com/dhis2/analytics/issues/1430)) ([02d3057](https://github.com/dhis2/analytics/commit/02d3057c7c090e293ba7c3057720f491e71457ec))
 
 # [24.7.0](https://github.com/dhis2/analytics/compare/v24.6.0...v24.7.0) (2023-02-15)

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

@@ -5,6 +5,8 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 
+var _appRuntime = require("@dhis2/app-runtime");
+
 var _propTypes = _interopRequireDefault(require("prop-types"));
 
 var _react = _interopRequireDefault(require("react"));
@@ -15,6 +17,15 @@ var _PeriodTransfer = _interopRequireDefault(require("./PeriodTransfer.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+const userSettingsQuery = {
+  userSettings: {
+    resource: 'userSettings',
+    params: {
+      key: ['keyUiLocale']
+    }
+  }
+};
+
 const PeriodDimension = _ref => {
   let {
     onSelect,
@@ -22,6 +33,24 @@ const PeriodDimension = _ref => {
     rightFooter,
     excludedPeriodTypes
   } = _ref;
+  const {
+    systemInfo
+  } = (0, _appRuntime.useConfig)();
+  const result = (0, _appRuntime.useDataQuery)(userSettingsQuery);
+  const {
+    calendar = 'gregory'
+  } = systemInfo;
+  const {
+    data: {
+      userSettings: {
+        keyUiLocale: locale
+      } = {}
+    } = {}
+  } = result;
+  const periodsSettings = {
+    calendar,
+    locale
+  };
 
   const selectPeriods = periods => {
     onSelect({
@@ -35,7 +64,8 @@ const PeriodDimension = _ref => {
     initialSelectedPeriods: selectedPeriods,
     rightFooter: rightFooter,
     dataTest: 'period-dimension',
-    excludedPeriodTypes: excludedPeriodTypes
+    excludedPeriodTypes: excludedPeriodTypes,
+    periodsSettings: periodsSettings
   });
 };
 

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

@@ -7,6 +7,8 @@ exports.default = void 0;
 
 var _style = _interopRequireDefault(require("styled-jsx/style"));
 
+var _multiCalendarDates = require("@dhis2/multi-calendar-dates");
+
 var _ui = require("@dhis2/ui");
 
 var _propTypes = _interopRequireDefault(require("prop-types"));
@@ -47,11 +49,15 @@ const PeriodTransfer = _ref => {
     dataTest,
     initialSelectedPeriods,
     rightFooter,
-    excludedPeriodTypes
+    excludedPeriodTypes,
+    periodsSettings
   } = _ref;
   const defaultRelativePeriodType = excludedPeriodTypes.includes(_index2.MONTHLY) ? (0, _relativePeriods.getRelativePeriodsOptionsById)(_index2.QUARTERLY) : (0, _relativePeriods.getRelativePeriodsOptionsById)(_index2.MONTHLY);
-  const defaultFixedPeriodType = excludedPeriodTypes.includes(_index2.MONTHLY) ? (0, _fixedPeriods.getFixedPeriodsOptionsById)(_index2.QUARTERLY) : (0, _fixedPeriods.getFixedPeriodsOptionsById)(_index2.MONTHLY);
-  const defaultFixedPeriodYear = new Date().getFullYear();
+  const defaultFixedPeriodType = excludedPeriodTypes.includes(_index2.MONTHLY) ? (0, _fixedPeriods.getFixedPeriodsOptionsById)(_index2.QUARTERLY, periodsSettings) : (0, _fixedPeriods.getFixedPeriodsOptionsById)(_index2.MONTHLY, periodsSettings);
+  const now = (0, _multiCalendarDates.getNowInCalendar)(periodsSettings.calendar); // use ".eraYear" rather than ".year" because in Ethiopian calendar, eraYear is what our users expect to see (for other calendars, it doesn't matter)
+  // there is still a pending decision in Temporal regarding which era to use by default: https://github.com/js-temporal/temporal-polyfill/blob/9350ee7dd0d29f329fc097debf923a517c32f813/lib/calendar.ts#L1964
+
+  const defaultFixedPeriodYear = now.eraYear || now.year;
 
   const fixedPeriodConfig = year => ({
     offset: year - defaultFixedPeriodYear,
@@ -73,7 +79,7 @@ const PeriodTransfer = _ref => {
   const onIsRelativeClick = state => {
     if (state !== isRelative) {
       setIsRelative(state);
-      setAllPeriods(state ? (0, _relativePeriods.getRelativePeriodsOptionsById)(relativeFilter.periodType).getPeriods() : (0, _fixedPeriods.getFixedPeriodsOptionsById)(fixedFilter.periodType).getPeriods(fixedPeriodConfig(Number(fixedFilter.year))));
+      setAllPeriods(state ? (0, _relativePeriods.getRelativePeriodsOptionsById)(relativeFilter.periodType).getPeriods() : (0, _fixedPeriods.getFixedPeriodsOptionsById)(fixedFilter.periodType, periodsSettings).getPeriods(fixedPeriodConfig(Number(fixedFilter.year))));
     }
   };
 
@@ -126,7 +132,7 @@ const PeriodTransfer = _ref => {
 
   const onSelectFixedPeriods = filter => {
     setFixedFilter(filter);
-    setAllPeriods((0, _fixedPeriods.getFixedPeriodsOptionsById)(filter.periodType).getPeriods(fixedPeriodConfig(Number(filter.year))));
+    setAllPeriods((0, _fixedPeriods.getFixedPeriodsOptionsById)(filter.periodType, periodsSettings).getPeriods(fixedPeriodConfig(Number(filter.year)), periodsSettings));
   };
 
   const renderEmptySelection = () => /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("p", {
@@ -176,7 +182,11 @@ const PeriodTransfer = _ref => {
 
 PeriodTransfer.defaultProps = {
   initialSelectedPeriods: [],
-  excludedPeriodTypes: []
+  excludedPeriodTypes: [],
+  periodsSettings: {
+    calendar: 'gregory',
+    locale: 'en'
+  }
 };
 PeriodTransfer.propTypes = {
   onSelect: _propTypes.default.func.isRequired,
@@ -186,6 +196,10 @@ PeriodTransfer.propTypes = {
     id: _propTypes.default.string,
     name: _propTypes.default.string
   })),
+  periodsSettings: _propTypes.default.shape({
+    calendar: _propTypes.default.string,
+    locale: _propTypes.default.string
+  }),
   rightFooter: _propTypes.default.node
 };
 var _default = PeriodTransfer;

package/build/cjs/components/PeriodDimension/__tests__/PeriodDimension.spec.js

@@ -8,6 +8,19 @@ var _PeriodDimension = _interopRequireDefault(require("../PeriodDimension.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
+jest.mock('@dhis2/app-runtime', () => ({
+  useConfig: () => ({
+    systemInfo: {}
+  }),
+  useDataQuery: () => ({
+    data: {
+      userSettings: {
+        keyUiLocale: 'en'
+      }
+    }
+  })
+}));
+afterEach(jest.clearAllMocks);
 describe('The Period Dimension component', () => {
   let props;
   let shallowPeriodDimension;

package/build/cjs/components/PeriodDimension/__tests__/__snapshots__/PeriodDimension.spec.js.snap

@@ -6,6 +6,12 @@ exports[`The Period Dimension component matches the snapshot 1`] = `
   excludedPeriodTypes={Array []}
   initialSelectedPeriods={Array []}
   onSelect={[Function]}
+  periodsSettings={
+    Object {
+      "calendar": "gregory",
+      "locale": "en",
+    }
+  }
   rightFooter={<React.Fragment />}
 />
 `;