@dhis2/analytics 29.2.1 → 29.3.1

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

@@ -0,0 +1,179 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.filterEnabledRelativePeriodTypes = exports.filterEnabledFixedPeriodTypes = exports.applyPeriodNameOverrides = exports.applyFixedPeriodTypeDisplayLabels = exports.applyDisplayLabelOverrides = exports.SERVER_PT_TO_MULTI_CALENDAR_PT = exports.RP_CATEGORY_TO_FP_DEPENDENCIES = void 0;
+// Mapping from server period type names to multi-calendar-dates constants
+const SERVER_PT_TO_MULTI_CALENDAR_PT = exports.SERVER_PT_TO_MULTI_CALENDAR_PT = {
+  Daily: 'DAILY',
+  Weekly: 'WEEKLY',
+  WeeklyWednesday: 'WEEKLYWED',
+  WeeklyThursday: 'WEEKLYTHU',
+  WeeklyFriday: 'WEEKLYFRI',
+  WeeklySaturday: 'WEEKLYSAT',
+  WeeklySunday: 'WEEKLYSUN',
+  BiWeekly: 'BIWEEKLY',
+  Monthly: 'MONTHLY',
+  BiMonthly: 'BIMONTHLY',
+  Quarterly: 'QUARTERLY',
+  QuarterlyNov: 'QUARTERLYNOV',
+  SixMonthly: 'SIXMONTHLY',
+  SixMonthlyApril: 'SIXMONTHLYAPR',
+  SixMonthlyNov: 'SIXMONTHLYNOV',
+  Yearly: 'YEARLY',
+  FinancialFeb: 'FYFEB',
+  FinancialApril: 'FYAPR',
+  FinancialJuly: 'FYJUL',
+  FinancialAug: 'FYAUG',
+  FinancialSep: 'FYSEP',
+  FinancialOct: 'FYOCT',
+  FinancialNov: 'FYNOV'
+};
+
+// Mapping from relative period categories to their corresponding fixed period types
+const RP_CATEGORY_TO_FP_DEPENDENCIES = exports.RP_CATEGORY_TO_FP_DEPENDENCIES = {
+  DAILY: ['Daily'],
+  WEEKLY: ['Weekly', 'WeeklyWednesday', 'WeeklyThursday', 'WeeklyFriday', 'WeeklySaturday', 'WeeklySunday'],
+  BIWEEKLY: ['BiWeekly'],
+  MONTHLY: ['Monthly'],
+  BIMONTHLY: ['BiMonthly'],
+  QUARTERLY: ['Quarterly', 'QuarterlyNov'],
+  SIXMONTHLY: ['SixMonthly', 'SixMonthlyApril', 'SixMonthlyNov'],
+  YEARLY: ['Yearly']
+};
+
+/**
+ * Filter fixed period types based on enabled server period types
+ * @param {Array} allFixedPeriodOptions - All available fixed period options
+ * @param {Array} enabledServerPeriodTypes - Enabled period types from server
+ * @returns {Array} Filtered fixed period options
+ */
+const filterEnabledFixedPeriodTypes = (allFixedPeriodOptions, enabledServerPeriodTypes) => {
+  if (!enabledServerPeriodTypes || enabledServerPeriodTypes.length === 0) {
+    return [];
+  }
+  const enabledServerPtNames = new Set(enabledServerPeriodTypes.map(pt => pt.name));
+  const enabledMultiCalendarPts = new Set();
+
+  // Map server PT names to multi-calendar-dates constants
+  enabledServerPtNames.forEach(serverPtName => {
+    const multiCalendarPt = SERVER_PT_TO_MULTI_CALENDAR_PT[serverPtName];
+    if (multiCalendarPt) {
+      enabledMultiCalendarPts.add(multiCalendarPt);
+    }
+  });
+
+  // Filter fixed period options to only include enabled ones
+  return allFixedPeriodOptions.filter(option => enabledMultiCalendarPts.has(option.id));
+};
+
+/**
+ * Apply displayLabel overrides to fixed period type names
+ * v43-only: in v44 the API provides these names directly
+ */
+exports.filterEnabledFixedPeriodTypes = filterEnabledFixedPeriodTypes;
+const applyFixedPeriodTypeDisplayLabels = (filteredFixedOptions, enabledServerPeriodTypes) => {
+  if (!enabledServerPeriodTypes) {
+    return filteredFixedOptions;
+  }
+  const displayLabelMap = new Map();
+  enabledServerPeriodTypes.forEach(pt => {
+    if (pt.displayLabel) {
+      const multiCalendarPt = SERVER_PT_TO_MULTI_CALENDAR_PT[pt.name];
+      if (multiCalendarPt) {
+        displayLabelMap.set(multiCalendarPt, pt.displayLabel);
+      }
+    }
+  });
+  if (displayLabelMap.size === 0) {
+    return filteredFixedOptions;
+  }
+  return filteredFixedOptions.map(option => {
+    const displayLabel = displayLabelMap.get(option.id);
+    return displayLabel ? {
+      ...option,
+      name: displayLabel
+    } : option;
+  });
+};
+
+/**
+ * Filter relative period categories based on enabled server period types
+ * @param {Array} allRelativePeriodOptions - All available relative period options
+ * @param {Array} enabledServerPeriodTypes - Enabled period types from server
+ * @param {string|null} financialYearStart - Financial year start setting (if enabled)
+ * @returns {Array} Filtered relative period options
+ */
+/**
+ * Apply metaData name overrides to a list of periods
+ * v43-only: in v44 the API provides these names directly
+ */
+exports.applyFixedPeriodTypeDisplayLabels = applyFixedPeriodTypeDisplayLabels;
+const applyPeriodNameOverrides = (periods, metaData) => {
+  if (!metaData) {
+    return periods;
+  }
+  return periods.map(period => metaData[period.id] ? {
+    ...period,
+    name: metaData[period.id].name
+  } : period);
+};
+
+/**
+ * Apply display label overrides to relative period options
+ * v43-only: in v44 the API provides these names directly
+ */
+exports.applyPeriodNameOverrides = applyPeriodNameOverrides;
+const applyDisplayLabelOverrides = (filteredRelativeOptions, {
+  financialYearDisplayLabel,
+  weeklyDisplayLabel,
+  metaData
+}) => {
+  const overrides = {};
+  if (financialYearDisplayLabel) {
+    overrides['FINANCIAL'] = {
+      name: financialYearDisplayLabel
+    };
+  }
+  if (weeklyDisplayLabel) {
+    overrides['WEEKLY'] = {
+      name: weeklyDisplayLabel
+    };
+  }
+  if (Object.keys(overrides).length === 0) {
+    return filteredRelativeOptions;
+  }
+  return filteredRelativeOptions.map(option => {
+    const override = overrides[option.id];
+    if (!override) {
+      return option;
+    }
+    return {
+      ...option,
+      name: override.name,
+      getPeriods: () => applyPeriodNameOverrides(option.getPeriods(), metaData)
+    };
+  });
+};
+exports.applyDisplayLabelOverrides = applyDisplayLabelOverrides;
+const filterEnabledRelativePeriodTypes = (allRelativePeriodOptions, enabledServerPeriodTypes, financialYearStart = null) => {
+  if (!enabledServerPeriodTypes || enabledServerPeriodTypes.length === 0) {
+    return [];
+  }
+  const enabledServerPtNames = new Set(enabledServerPeriodTypes.map(pt => pt.name));
+  return allRelativePeriodOptions.filter(option => {
+    // Special handling for financial years
+    if (option.id === 'FINANCIAL') {
+      return financialYearStart !== null;
+    }
+
+    // Check if any of the required FP dependencies are enabled
+    const requiredFpTypes = RP_CATEGORY_TO_FP_DEPENDENCIES[option.id];
+    if (!requiredFpTypes) {
+      return true; // Show if no dependency mapping (shouldn't happen)
+    }
+    return requiredFpTypes.some(fpType => enabledServerPtNames.has(fpType));
+  });
+};
+exports.filterEnabledRelativePeriodTypes = filterEnabledRelativePeriodTypes;

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

@@ -9,40 +9,48 @@ var _index = _interopRequireDefault(require("../../../locales/index.js"));
 var _index2 = require("./index.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const PERIOD_TYPE_REGEX = exports.PERIOD_TYPE_REGEX = {
-  [_index2.DAILY]: /^([0-9]{4})([0-9]{2})([0-9]{2})$/,
+  [_index2.DAILY]: /^(\d{4})(\d{2})(\d{2})$/,
   // YYYYMMDD
-  [_index2.WEEKLY]: /^([0-9]{4})()W([0-9]{1,2})$/,
+  [_index2.WEEKLY]: /^(\d{4})W(\d{1,2})$/,
   // YYYY"W"[1-53]
-  [_index2.BIWEEKLY]: /^([0-9]{4})BiW([0-9]{1,2})$/,
+  [_index2.BIWEEKLY]: /^(\d{4})BiW(\d{1,2})$/,
   // YYYY"BiW"[1-27]
-  [_index2.WEEKLYWED]: /^([0-9]{4})(Wed)W([0-9]{1,2})$/,
+  [_index2.WEEKLYWED]: /^(\d{4})(Wed)W(\d{1,2})$/,
   // YYYY"WedW"[1-53]
-  [_index2.WEEKLYTHU]: /^([0-9]{4})(Thu)W([0-9]{1,2})$/,
+  [_index2.WEEKLYTHU]: /^(\d{4})(Thu)W(\d{1,2})$/,
   // YYYY"ThuW"[1-53]
-  [_index2.WEEKLYSAT]: /^([0-9]{4})(Sat)W([0-9]{1,2})$/,
+  [_index2.WEEKLYFRI]: /^(\d{4})(Fri)W(\d{1,2})$/,
+  // YYYY"FriW"[1-53]
+  [_index2.WEEKLYSAT]: /^(\d{4})(Sat)W(\d{1,2})$/,
   // YYYY"SatW"[1-53]
-  [_index2.WEEKLYSUN]: /^([0-9]{4})(Sun)W([0-9]{1,2})$/,
+  [_index2.WEEKLYSUN]: /^(\d{4})(Sun)W(\d{1,2})$/,
   // YYYY"SunW"[1-53]
-  [_index2.MONTHLY]: /^([0-9]{4})([0-9]{2})$/,
+  [_index2.MONTHLY]: /^(\d{4})(\d{2})$/,
   // YYYYMM
-  [_index2.BIMONTHLY]: /^([0-9]{4})([0-9]{2})B$/,
+  [_index2.BIMONTHLY]: /^(\d{4})(\d{2})B$/,
   // YYYY0[1-6]"B"
-  [_index2.QUARTERLY]: /^([0-9]{4})Q([1234])$/,
+  [_index2.QUARTERLY]: /^(\d{4})Q([1234])$/,
   // YYYY"Q"[1-4]
-  [_index2.SIXMONTHLY]: /^([0-9]{4})S([12])$/,
+  [_index2.SIXMONTHLY]: /^(\d{4})S([12])$/,
   // YYYY"S"[1/2]
-  [_index2.SIXMONTHLYAPR]: /^([0-9]{4})AprilS([12])$/,
+  [_index2.SIXMONTHLYAPR]: /^(\d{4})AprilS([12])$/,
   // YYYY"AprilS"[1/2]
-  // [SIXMONTHLYNOV]: /^([0-9]{4})NovS([12])$/, // YYYY"NovS"[1/2] Not supported?
-  [_index2.YEARLY]: /^([0-9]{4})$/,
+  // [SIXMONTHLYNOV]: /^(\d{4})NovS([12])$/, // YYYY"NovS"[1/2] Not supported?
+  [_index2.YEARLY]: /^(\d{4})$/,
   // YYYY
-  [_index2.FYNOV]: /^([0-9]{4})Nov$/,
-  // YYYY"Nov"
-  [_index2.FYOCT]: /^([0-9]{4})Oct$/,
-  // YYYY"Oct"
-  [_index2.FYJUL]: /^([0-9]{4})July$/,
+  [_index2.FYFEB]: /^(\d{4})Feb$/,
+  // YYYY"Feb"
+  [_index2.FYAPR]: /^(\d{4})April$/,
+  // YYYY"April"
+  [_index2.FYJUL]: /^(\d{4})July$/,
   // YYYY"July"
-  [_index2.FYAPR]: /^([0-9]{4})April$/ // YYYY"April"
+  [_index2.FYAUG]: /^(\d{4})Aug$/,
+  // YYYY"Aug"
+  [_index2.FYSEP]: /^(\d{4})Sep$/,
+  // YYYY"Sep"
+  [_index2.FYOCT]: /^(\d{4})Oct$/,
+  // YYYY"Oct"
+  [_index2.FYNOV]: /^(\d{4})Nov$/ // YYYY"Nov"
 };
 const getPeriods = ({
   periodType,
@@ -164,40 +172,10 @@ const getYearlyPeriodType = (fnFilter, periodSettings) => {
     });
   };
 };
-const getFinancialOctoberPeriodType = (fnFilter, periodSettings) => {
-  return config => {
-    return getPeriods({
-      periodType: 'FYOCT',
-      config,
-      fnFilter,
-      periodSettings
-    });
-  };
-};
-const getFinancialNovemberPeriodType = (fnFilter, periodSettings) => {
-  return config => {
-    return getPeriods({
-      periodType: 'FYNOV',
-      config,
-      fnFilter,
-      periodSettings
-    });
-  };
-};
-const getFinancialJulyPeriodType = (fnFilter, periodSettings) => {
-  return config => {
-    return getPeriods({
-      periodType: 'FYJUL',
-      config,
-      fnFilter,
-      periodSettings
-    });
-  };
-};
-const getFinancialAprilPeriodType = (fnFilter, periodSettings) => {
+const getFinancialPeriodType = (periodType, fnFilter, periodSettings) => {
   return config => {
     return getPeriods({
-      periodType: 'FYAPR',
+      periodType,
       config,
       fnFilter,
       periodSettings
@@ -237,6 +215,12 @@ const getOptions = periodSettings => {
       startDay: 4
     }, filterFuturePeriods, periodSettings),
     name: _index.default.t('Weekly (Start Thursday)')
+  }, {
+    id: _index2.WEEKLYFRI,
+    getPeriods: getWeeklyPeriodType({
+      startDay: 5
+    }, filterFuturePeriods, periodSettings),
+    name: _index.default.t('Weekly (Start Friday)')
   }, {
     id: _index2.WEEKLYSAT,
     getPeriods: getWeeklyPeriodType({
@@ -278,21 +262,33 @@ const getOptions = periodSettings => {
     getPeriods: getYearlyPeriodType(filterFuturePeriods, periodSettings),
     name: _index.default.t('Yearly')
   }, {
-    id: _index2.FYNOV,
-    getPeriods: getFinancialNovemberPeriodType(filterFuturePeriods, periodSettings),
-    name: _index.default.t('Financial year (Start November)')
+    id: _index2.FYFEB,
+    getPeriods: getFinancialPeriodType('FYFEB', filterFuturePeriods, periodSettings),
+    name: _index.default.t('Financial year (Start February)')
   }, {
-    id: _index2.FYOCT,
-    getPeriods: getFinancialOctoberPeriodType(filterFuturePeriods, periodSettings),
-    name: _index.default.t('Financial year (Start October)')
+    id: _index2.FYAPR,
+    getPeriods: getFinancialPeriodType('FYAPR', filterFuturePeriods, periodSettings),
+    name: _index.default.t('Financial year (Start April)')
   }, {
     id: _index2.FYJUL,
-    getPeriods: getFinancialJulyPeriodType(filterFuturePeriods, periodSettings),
+    getPeriods: getFinancialPeriodType('FYJUL', filterFuturePeriods, periodSettings),
     name: _index.default.t('Financial year (Start July)')
   }, {
-    id: _index2.FYAPR,
-    getPeriods: getFinancialAprilPeriodType(filterFuturePeriods, periodSettings),
-    name: _index.default.t('Financial year (Start April)')
+    id: _index2.FYAUG,
+    getPeriods: getFinancialPeriodType('FYAUG', filterFuturePeriods, periodSettings),
+    name: _index.default.t('Financial year (Start August)')
+  }, {
+    id: _index2.FYSEP,
+    getPeriods: getFinancialPeriodType('FYSEP', filterFuturePeriods, periodSettings),
+    name: _index.default.t('Financial year (Start September)')
+  }, {
+    id: _index2.FYOCT,
+    getPeriods: getFinancialPeriodType('FYOCT', filterFuturePeriods, periodSettings),
+    name: _index.default.t('Financial year (Start October)')
+  }, {
+    id: _index2.FYNOV,
+    getPeriods: getFinancialPeriodType('FYNOV', filterFuturePeriods, periodSettings),
+    name: _index.default.t('Financial year (Start November)')
   }];
 };
 const getFixedPeriodsOptionsById = (id, periodSettings) => {

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

@@ -3,11 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.filterPeriodTypesById = exports.YEARLY = exports.WEEKS_THIS_YEAR = exports.WEEKLYWED = exports.WEEKLYTHU = exports.WEEKLYSUN = exports.WEEKLYSAT = exports.WEEKLY = exports.SIXMONTHLYAPR = exports.SIXMONTHLY = exports.QUARTERLY = exports.MONTHLY = exports.FYOCT = exports.FYNOV = exports.FYJUL = exports.FYAPR = exports.FINANCIAL = exports.DAILY = exports.BIWEEKLY = exports.BIMONTHLY = void 0;
+exports.filterPeriodTypesById = exports.YEARLY = exports.WEEKS_THIS_YEAR = exports.WEEKLYWED = exports.WEEKLYTHU = exports.WEEKLYSUN = exports.WEEKLYSAT = exports.WEEKLYFRI = exports.WEEKLY = exports.SIXMONTHLYAPR = exports.SIXMONTHLY = exports.QUARTERLY = exports.MONTHLY = exports.FYSEP = exports.FYOCT = exports.FYNOV = exports.FYJUL = exports.FYFEB = exports.FYAUG = exports.FYAPR = exports.FINANCIAL = exports.DAILY = exports.BIWEEKLY = exports.BIMONTHLY = void 0;
 const DAILY = exports.DAILY = 'DAILY';
 const WEEKLY = exports.WEEKLY = 'WEEKLY';
 const WEEKLYWED = exports.WEEKLYWED = 'WEEKLYWED';
 const WEEKLYTHU = exports.WEEKLYTHU = 'WEEKLYTHU';
+const WEEKLYFRI = exports.WEEKLYFRI = 'WEEKLYFRI';
 const WEEKLYSAT = exports.WEEKLYSAT = 'WEEKLYSAT';
 const WEEKLYSUN = exports.WEEKLYSUN = 'WEEKLYSUN';
 const WEEKS_THIS_YEAR = exports.WEEKS_THIS_YEAR = 'WEEKS_THIS_YEAR';
@@ -19,9 +20,12 @@ const SIXMONTHLY = exports.SIXMONTHLY = 'SIXMONTHLY';
 const SIXMONTHLYAPR = exports.SIXMONTHLYAPR = 'SIXMONTHLYAPR';
 const YEARLY = exports.YEARLY = 'YEARLY';
 const FINANCIAL = exports.FINANCIAL = 'FINANCIAL';
-const FYNOV = exports.FYNOV = 'FYNOV';
-const FYOCT = exports.FYOCT = 'FYOCT';
-const FYJUL = exports.FYJUL = 'FYJUL';
+const FYFEB = exports.FYFEB = 'FYFEB';
 const FYAPR = exports.FYAPR = 'FYAPR';
+const FYJUL = exports.FYJUL = 'FYJUL';
+const FYAUG = exports.FYAUG = 'FYAUG';
+const FYSEP = exports.FYSEP = 'FYSEP';
+const FYOCT = exports.FYOCT = 'FYOCT';
+const FYNOV = exports.FYNOV = 'FYNOV';
 const filterPeriodTypesById = (allPeriodTypes = [], excludedPeriodTypes = []) => allPeriodTypes.filter(period => !excludedPeriodTypes.includes(period.id));
 exports.filterPeriodTypesById = filterPeriodTypesById;

package/build/cjs/index.js

@@ -7,6 +7,7 @@ var _exportNames = {
   DataDimension: true,
   PeriodDimension: true,
   FixedPeriodSelect: true,
+  useDataOutputPeriodTypes: true,
   OrgUnitDimension: true,
   DynamicDimension: true,
   ALL_DYNAMIC_DIMENSION_ITEMS: true,
@@ -1912,6 +1913,12 @@ Object.defineProperty(exports, "useCachedDataQuery", {
     return _CachedDataQueryProvider.useCachedDataQuery;
   }
 });
+Object.defineProperty(exports, "useDataOutputPeriodTypes", {
+  enumerable: true,
+  get: function () {
+    return _useDataOutputPeriodTypes.useDataOutputPeriodTypes;
+  }
+});
 Object.defineProperty(exports, "valueTypeDisplayNames", {
   enumerable: true,
   get: function () {
@@ -1934,6 +1941,7 @@ require("./locales/index.js");
 var _DataDimension = _interopRequireDefault(require("./components/DataDimension/DataDimension.js"));
 var _PeriodDimension = _interopRequireDefault(require("./components/PeriodDimension/PeriodDimension.js"));
 var _FixedPeriodSelect = _interopRequireDefault(require("./components/PeriodDimension/FixedPeriodSelect.js"));
+var _useDataOutputPeriodTypes = require("./components/PeriodDimension/useDataOutputPeriodTypes.js");
 var _OrgUnitDimension = _interopRequireDefault(require("./components/OrgUnitDimension/OrgUnitDimension.js"));
 var _DynamicDimension = _interopRequireWildcard(require("./components/DynamicDimension/DynamicDimension.js"));
 var _DimensionsPanel = _interopRequireDefault(require("./components/DimensionsPanel/DimensionsPanel.js"));

package/build/cjs/locales/en/translations.json

@@ -256,6 +256,8 @@
     "Select year": "Select year",
     "Period": "Period",
     "Selected Periods": "Selected Periods",
+    "No period types available": "No period types available",
+    "No period types are enabled in the system. Please contact your system administrator.": "No period types are enabled in the system. Please contact your system administrator.",
     "Relative periods": "Relative periods",
     "Fixed periods": "Fixed periods",
     "No periods selected": "No periods selected",
@@ -263,6 +265,7 @@
     "Weekly": "Weekly",
     "Weekly (Start Wednesday)": "Weekly (Start Wednesday)",
     "Weekly (Start Thursday)": "Weekly (Start Thursday)",
+    "Weekly (Start Friday)": "Weekly (Start Friday)",
     "Weekly (Start Saturday)": "Weekly (Start Saturday)",
     "Weekly (Start Sunday)": "Weekly (Start Sunday)",
     "Bi-weekly": "Bi-weekly",
@@ -272,10 +275,13 @@
     "Six-monthly": "Six-monthly",
     "Six-monthly April": "Six-monthly April",
     "Yearly": "Yearly",
-    "Financial year (Start November)": "Financial year (Start November)",
-    "Financial year (Start October)": "Financial year (Start October)",
-    "Financial year (Start July)": "Financial year (Start July)",
+    "Financial year (Start February)": "Financial year (Start February)",
     "Financial year (Start April)": "Financial year (Start April)",
+    "Financial year (Start July)": "Financial year (Start July)",
+    "Financial year (Start August)": "Financial year (Start August)",
+    "Financial year (Start September)": "Financial year (Start September)",
+    "Financial year (Start October)": "Financial year (Start October)",
+    "Financial year (Start November)": "Financial year (Start November)",
     "Today": "Today",
     "Yesterday": "Yesterday",
     "Last 3 days": "Last 3 days",

package/build/cjs/visualizations/util/getFilterText.js

@@ -28,7 +28,7 @@ function _default(filters, metaData) {
       const relativePeriodNames = (0, _relativePeriods.getRelativePeriodsName)();
       titleFragments.push((0, _dimensionGetItemIds.dimensionGetItemIds)(filter).map(id => {
         var _metaData$items$id;
-        return relativePeriodNames[id] || ((_metaData$items$id = metaData.items[id]) === null || _metaData$items$id === void 0 ? void 0 : _metaData$items$id.name) || id;
+        return ((_metaData$items$id = metaData.items[id]) === null || _metaData$items$id === void 0 ? void 0 : _metaData$items$id.name) || relativePeriodNames[id] || id;
       }).join(', '));
     } else {
       const filterItems = metaData.dimensions[filter.dimension];

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

@@ -4,19 +4,15 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import i18n from '../../locales/index.js';
 import styles from './styles/PeriodFilter.style.js';
-import { getFixedPeriodsOptions } from './utils/fixedPeriods.js';
-import { filterPeriodTypesById } from './utils/index.js';
-const EXCLUDED_PERIOD_TYPES_PROP_DEFAULT = [];
 const FixedPeriodFilter = ({
-  allowedPeriodTypes,
-  excludedPeriodTypes = EXCLUDED_PERIOD_TYPES_PROP_DEFAULT,
+  availableOptions,
   currentPeriodType,
   currentYear,
   onSelectPeriodType,
   onSelectYear,
   dataTest
 }) => {
-  const onlyAllowedTypeIsSelected = Array.isArray(allowedPeriodTypes) && allowedPeriodTypes.length === 1 && allowedPeriodTypes[0] === currentPeriodType;
+  const onlyAllowedTypeIsSelected = availableOptions.length === 1 && availableOptions[0].id === currentPeriodType;
   return /*#__PURE__*/React.createElement(React.Fragment, null, /*#__PURE__*/React.createElement("div", {
     "data-test": dataTest,
     className: `jsx-${styles.__hash}` + " " + "leftSection"
@@ -30,7 +26,7 @@ const FixedPeriodFilter = ({
     disabled: onlyAllowedTypeIsSelected,
     className: "filterElement",
     dataTest: `${dataTest}-period-type`
-  }, (allowedPeriodTypes ? getFixedPeriodsOptions().filter(option => allowedPeriodTypes.some(type => type === option.id)) : filterPeriodTypesById(getFixedPeriodsOptions(), excludedPeriodTypes)).map(option => /*#__PURE__*/React.createElement(SingleSelectOption, {
+  }, availableOptions.map(option => /*#__PURE__*/React.createElement(SingleSelectOption, {
     key: option.id,
     value: option.id,
     label: option.name,
@@ -53,12 +49,11 @@ const FixedPeriodFilter = ({
   }, styles));
 };
 FixedPeriodFilter.propTypes = {
+  availableOptions: PropTypes.array.isRequired,
   currentPeriodType: PropTypes.string.isRequired,
   currentYear: PropTypes.string.isRequired,
   onSelectPeriodType: PropTypes.func.isRequired,
   onSelectYear: PropTypes.func.isRequired,
-  allowedPeriodTypes: PropTypes.arrayOf(PropTypes.string),
-  dataTest: PropTypes.string,
-  excludedPeriodTypes: PropTypes.arrayOf(PropTypes.string)
+  dataTest: PropTypes.string
 };
 export default FixedPeriodFilter;

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

@@ -8,7 +8,7 @@ import React, { Component } from 'react';
 import i18n from '../../locales/index.js';
 import FixedPeriodFilter from './FixedPeriodFilter.js';
 import styles from './styles/FixedPeriodSelect.style.js';
-import { parsePeriodCode, getFixedPeriodsOptionsById as getPeriodById, getYearOffsetFromNow } from './utils/fixedPeriods.js';
+import { parsePeriodCode, getFixedPeriodsOptionsById as getPeriodById, getFixedPeriodsOptions, getYearOffsetFromNow } from './utils/fixedPeriods.js';
 class FixedPeriodSelect extends Component {
   constructor(...args) {
     super(...args);
@@ -61,13 +61,15 @@ class FixedPeriodSelect extends Component {
     });
   }
   render() {
+    const allOptions = getFixedPeriodsOptions();
+    const availableOptions = this.props.allowedPeriodTypes ? allOptions.filter(option => this.props.allowedPeriodTypes.includes(option.id)) : allOptions;
     return /*#__PURE__*/React.createElement("div", {
       "data-test": this.props.dataTest,
       className: `jsx-${styles.__hash}` + " " + (this.props.className || "")
     }, /*#__PURE__*/React.createElement("div", {
       className: `jsx-${styles.__hash}` + " " + "row"
     }, /*#__PURE__*/React.createElement(FixedPeriodFilter, {
-      allowedPeriodTypes: this.props.allowedPeriodTypes,
+      availableOptions: availableOptions,
       currentPeriodType: this.state.periodType,
       currentYear: this.state.year,
       onSelectPeriodType: this.onSelectPeriodType,

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

@@ -3,6 +3,8 @@ import PropTypes from 'prop-types';
 import React from 'react';
 import { DIMENSION_ID_PERIOD } from '../../modules/predefinedDimensions.js';
 import PeriodTransfer from './PeriodTransfer.js';
+import { useDataOutputPeriodTypes } from './useDataOutputPeriodTypes.js';
+import { applyPeriodNameOverrides } from './utils/enabledPeriodTypes.js';
 const userSettingsQuery = {
   userSettings: {
     resource: 'userSettings',
@@ -20,10 +22,15 @@ const PeriodDimension = ({
   infoBoxMessage,
   height
 }) => {
+  const config = useConfig();
   const {
     systemInfo
-  } = useConfig();
-  const result = useDataQuery(userSettingsQuery);
+  } = config;
+  const userSettingsResult = useDataQuery(userSettingsQuery);
+  const {
+    supportsEnabledPeriodTypes,
+    enabledPeriodTypesData
+  } = useDataOutputPeriodTypes();
   const {
     calendar = 'gregory'
   } = systemInfo;
@@ -33,7 +40,7 @@ const PeriodDimension = ({
         keyUiLocale: locale
       } = {}
     } = {}
-  } = result;
+  } = userSettingsResult;
   const periodsSettings = {
     calendar,
     locale
@@ -44,15 +51,18 @@ const PeriodDimension = ({
       items: periods
     });
   };
+  const selectedPeriodsWithCustomDisplayNames = applyPeriodNameOverrides(selectedPeriods, enabledPeriodTypesData === null || enabledPeriodTypesData === void 0 ? void 0 : enabledPeriodTypesData.metaData);
   return /*#__PURE__*/React.createElement(PeriodTransfer, {
     onSelect: selectPeriods,
-    selectedItems: selectedPeriods,
+    selectedItems: selectedPeriodsWithCustomDisplayNames,
     infoBoxMessage: infoBoxMessage,
     rightFooter: rightFooter,
     dataTest: 'period-dimension',
     excludedPeriodTypes: excludedPeriodTypes,
     periodsSettings: periodsSettings,
-    height: height
+    height: height,
+    enabledPeriodTypesData: enabledPeriodTypesData,
+    supportsEnabledPeriodTypes: supportsEnabledPeriodTypes
   });
 };
 PeriodDimension.propTypes = {