feat: data output period types (DHIS2-21001)

package.json

@@ -48,7 +48,7 @@
         "typescript-eslint": "^8.35.0"
     },
     "dependencies": {
-        "@dhis2/analytics": "^29.1.0",
+        "@dhis2/analytics": "^29.3.0",
         "@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/Visualization/Visualization.jsx

@@ -1,10 +1,11 @@
 import debounce from 'lodash-es/debounce'
+import { useDataOutputPeriodTypes } from '@dhis2/analytics'
 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 +217,13 @@
     )
     const { setChart } = useChartContext()
 
+    const { enabledPeriodTypesData } = useDataOutputPeriodTypes()
+    useEffect(() => {
+        if (enabledPeriodTypesData?.metaData) {
+            dispatch(acOverrideMetadata(enabledPeriodTypesData.metaData))
+        }
+    }, [dispatch, enabledPeriodTypesData])
+
     const visualization = useMemo(
         () => getVisualizationWithFilteredOptionsByType(current),
         [current]

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,7 @@
             .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/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.0":
+  version "29.3.0"
+  resolved "https://registry.yarnpkg.com/@dhis2/analytics/-/analytics-29.3.0.tgz#f34f53ff4c80e3f95169cbc7307a2f252043dabe"
+  integrity sha512-V5QchXBOv6rbv/HWYKiJDKHp84kY6xjuNwKHs5SHz7LwTgEd9DZhtDkbKQaNvOyTiR18XNG8qweZx9Y9PL0hng==
   dependencies:
     "@dhis2/multi-calendar-dates" "^1.2.2"
     "@dnd-kit/core" "^6.0.7"