feat: data output period types (DHIS2-21001)

i18n/en.pot

@@ -5,8 +5,8 @@ msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
-"POT-Creation-Date: 2025-10-28T16:10:03.307Z\n"
-"PO-Revision-Date: 2025-10-28T16:10:03.308Z\n"
+"POT-Creation-Date: 2026-03-11T11:54:22.309Z\n"
+"PO-Revision-Date: 2026-03-11T11:54:22.310Z\n"
 
 msgid "All items"
 msgstr "All items"

package.json

@@ -48,7 +48,7 @@
         "typescript-eslint": "^8.35.0"
     },
     "dependencies": {
-        "@dhis2/analytics": "^29.1.0",
+        "@dhis2/analytics": "^29.3.2",
         "@dhis2/app-runtime": "^3.14.1",
         "@dhis2/app-service-datastore": "^1.0.0-beta.3",
         "@dhis2/d2-i18n": "^1.1.0",

src/actions/metadata.js

@@ -1,6 +1,11 @@
-import { ADD_METADATA } from '../reducers/metadata.js'
+import { ADD_METADATA, OVERRIDE_METADATA } from '../reducers/metadata.js'
 
 export const acAddMetadata = (value) => ({
     type: ADD_METADATA,
     value,
 })
+
+export const acOverrideMetadata = (value) => ({
+    type: OVERRIDE_METADATA,
+    value,
+})

src/components/DimensionsPanel/Dialogs/DialogManager.jsx

@@ -19,6 +19,7 @@ import {
     WEEKLY,
     WEEKLYWED,
     WEEKLYTHU,
+    WEEKLYFRI,
     WEEKLYSAT,
     WEEKLYSUN,
     BIWEEKLY,
@@ -85,7 +86,14 @@ const getExcludedPeriodTypes = (settings = {}) => {
         types.push(DAILY)
     }
     if (settings['keyHideWeeklyPeriods']) {
-        types.push(WEEKLY, WEEKLYWED, WEEKLYTHU, WEEKLYSAT, WEEKLYSUN)
+        types.push(
+            WEEKLY,
+            WEEKLYWED,
+            WEEKLYTHU,
+            WEEKLYFRI,
+            WEEKLYSAT,
+            WEEKLYSUN
+        )
     }
     if (settings['keyHideBiWeeklyPeriods']) {
         types.push(BIWEEKLY)

src/components/Visualization/Visualization.jsx

@@ -1,10 +1,17 @@
+import { useDataOutputPeriodTypes } from '@dhis2/analytics'
 import debounce from 'lodash-es/debounce'
 import PropTypes from 'prop-types'
-import React, { Component, Fragment, useCallback, useMemo } from 'react'
+import React, {
+    Component,
+    Fragment,
+    useCallback,
+    useEffect,
+    useMemo,
+} from 'react'
 import { useDispatch, useSelector } from 'react-redux'
 import { tSetCurrentFromUi } from '../../actions/current.js'
 import { acSetPluginLoading } from '../../actions/loader.js'
-import { acAddMetadata } from '../../actions/metadata.js'
+import { acAddMetadata, acOverrideMetadata } from '../../actions/metadata.js'
 import {
     acSetUiItems,
     acSetUiDataSorting,
@@ -216,6 +223,13 @@ export const Visualization = (props) => {
     )
     const { setChart } = useChartContext()
 
+    const { enabledPeriodTypesData } = useDataOutputPeriodTypes()
+    useEffect(() => {
+        if (enabledPeriodTypesData?.metaData) {
+            dispatch(acOverrideMetadata(enabledPeriodTypesData.metaData))
+        }
+    }, [dispatch, enabledPeriodTypesData])
+
     const visualization = useMemo(
         () => getVisualizationWithFilteredOptionsByType(current),
         [current]

src/components/Visualization/__tests__/Visualization.spec.jsx

@@ -6,6 +6,14 @@ import { __setChart as setChart } from '../../ChartProvider.jsx' // eslint-disab
 import { VisualizationPlugin } from '../../VisualizationPlugin/VisualizationPlugin.jsx'
 import { Visualization } from '../Visualization.jsx'
 
+jest.mock('@dhis2/analytics', () => ({
+    ...jest.requireActual('@dhis2/analytics'),
+    useDataOutputPeriodTypes: () => ({
+        supportsEnabledPeriodTypes: false,
+        enabledPeriodTypesData: null,
+    }),
+}))
+
 jest.mock('../../ChartProvider.jsx', () => {
     const setChart = jest.fn()
     return {

src/components/VisualizationPlugin/VisualizationPlugin.jsx

@@ -15,6 +15,7 @@
     USER_ORG_UNIT_CHILDREN,
     USER_ORG_UNIT_GRANDCHILDREN,
     VIS_TYPE_SINGLE_VALUE,
+    useDataOutputPeriodTypes,
 } from '@dhis2/analytics'
 import { useConfig, useDataEngine } from '@dhis2/app-runtime'
 import { Button, IconLegend24, Layer } from '@dhis2/ui'
@@ -79,6 +80,8 @@
     const [size, setSize] = useState({ width: 0, height: 0 })
     const resizeObserverRef = useRef(null)
     const { baseUrl } = useConfig()
+    const { supportsEnabledPeriodTypes, enabledPeriodTypesData } =
+        useDataOutputPeriodTypes()
 
     useEffect(() => {
         resizeObserverRef.current = new window.ResizeObserver((entries) => {
@@ -278,6 +281,11 @@
     }, [engine])
 
     useEffect(() => {
+        // Wait for period type data to load when supported
+        if (supportsEnabledPeriodTypes && !enabledPeriodTypesData) {
+            return
+        }
+
         setError(null)
         setFetchResult(null)
         setVisualization(null)
@@ -394,6 +402,15 @@
 
             const legendSets = await doFetchLegendSets(legendSetIds)
 
+            if (enabledPeriodTypesData?.metaData) {
+                responses.forEach((response) => {
+                    Object.assign(
+                        response.metaData.items,
+                        enabledPeriodTypesData.metaData
+                    )
+                })
+            }
+
             setFetchResult({
                 visualization: filteredVisualization,
                 legendSets,
@@ -407,7 +424,13 @@
             .catch((error) => setError(error))
             // since errors are rendered here, always call loading complete
             .finally(() => onLoadingComplete())
-    }, [originalVisualization, filters, forDashboard])
+    }, [
+        originalVisualization,
+        filters,
+        forDashboard,
+        supportsEnabledPeriodTypes,
+        enabledPeriodTypesData,
+    ])
 
     useEffect(() => {
         if (fetchResult?.visualization && ouLevels) {

src/components/VisualizationPlugin/__tests__/VisualizationPlugin.spec.jsx

@@ -25,6 +25,10 @@ jest.mock('@dhis2/analytics', () => ({
                 id: '2nd-floor',
             },
         ]),
+    useDataOutputPeriodTypes: () => ({
+        supportsEnabledPeriodTypes: false,
+        enabledPeriodTypesData: null,
+    }),
 }))
 global.ResizeObserver = jest.fn().mockImplementation(() => ({
     observe: jest.fn(),

src/reducers/metadata.js

@@ -1,6 +1,7 @@
 import getDefaultMetadata from '../modules/metadata.js'
 
 export const ADD_METADATA = 'ADD_METADATA'
+export const OVERRIDE_METADATA = 'OVERRIDE_METADATA'
 
 export const DEFAULT_METADATA = getDefaultMetadata()
 
@@ -18,6 +19,13 @@ export default (state = DEFAULT_METADATA, action) => {
             })
             return result
         }
+        case OVERRIDE_METADATA: {
+            const result = { ...state }
+            Object.entries(action.value).forEach(([key, value]) => {
+                result[key] = { ...result[key], ...value }
+            })
+            return result
+        }
         default:
             return state
     }

yarn.lock

@@ -1906,10 +1906,10 @@
     classnames "^2.3.1"
     prop-types "^15.7.2"
 
-"@dhis2/analytics@^29.1.0":
-  version "29.1.0"
-  resolved "https://registry.yarnpkg.com/@dhis2/analytics/-/analytics-29.1.0.tgz#aaef83cab9edd3a59c891ee1e6a59a195059704b"
-  integrity sha512-A+c8O8uUc3omOa7PTBIyJsA1+9oIZw0AXZwSMdTYl6KZHiIiTkrLZvV8hLpMldKH4s7WMPeRiZxXt9F8ls57BA==
+"@dhis2/analytics@^29.3.2":
+  version "29.3.2"
+  resolved "https://registry.yarnpkg.com/@dhis2/analytics/-/analytics-29.3.2.tgz#9cd598d5542a7c2885e58506059566d884476818"
+  integrity sha512-EKZ2uHxpaDsore+fYsswclTLhOgn2iJUDZ05hSGNg8LxW53dqECN2JWgFsG54FVeZ9+lYFJkrFxpsc7mcjdkfg==
   dependencies:
     "@dhis2/multi-calendar-dates" "^1.2.2"
     "@dnd-kit/core" "^6.0.7"