@dhis2/analytics 29.4.3 → 29.5.0

package/build/cjs/modules/dimensions.js

@@ -0,0 +1,68 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getHeaderByVis = void 0;
+// vis: 'dimension' in EventVisualization columns/rows/filters
+// dim: tracker analytics api dimension/filter id
+// header: tracker analytics api header name (query endpoints)
+
+const EVENT_DIMENSIONS = [{
+  vis: 'ou',
+  dim: 'ou',
+  header: 'ouname'
+}, {
+  vis: 'eventDate',
+  dim: 'EVENT_DATE',
+  header: 'eventdate'
+}, {
+  vis: 'enrollmentDate',
+  dim: 'ENROLLMENT_DATE',
+  header: 'enrollmentdate'
+}, {
+  vis: 'scheduledDate',
+  dim: 'SCHEDULED_DATE',
+  header: 'scheduleddate'
+}, {
+  vis: 'incidentDate',
+  dim: 'INCIDENT_DATE',
+  header: 'incidentdate'
+}, {
+  vis: 'lastUpdated',
+  dim: 'LAST_UPDATED',
+  header: 'lastupdated'
+}, {
+  vis: 'created',
+  dim: 'CREATED',
+  header: 'created'
+}, {
+  vis: 'completed',
+  dim: 'COMPLETED',
+  header: 'completed'
+}, {
+  vis: 'eventStatus',
+  dim: 'EVENT_STATUS',
+  header: 'eventstatus'
+}, {
+  vis: 'programStatus',
+  dim: 'PROGRAM_STATUS',
+  header: 'programstatus'
+}, {
+  vis: 'enrollmentOu',
+  dim: 'ENROLLMENT_OU',
+  header: 'enrollmentouname'
+}, {
+  vis: 'createdBy',
+  dim: '',
+  header: 'createdbydisplayname'
+}, {
+  vis: 'lastUpdatedBy',
+  dim: '',
+  header: 'lastupdatedbydisplayname'
+}];
+const getHeaderByVis = vis => {
+  var _EVENT_DIMENSIONS$fin;
+  return (_EVENT_DIMENSIONS$fin = EVENT_DIMENSIONS.find(d => d.vis === vis)) === null || _EVENT_DIMENSIONS$fin === void 0 ? void 0 : _EVENT_DIMENSIONS$fin.header;
+};
+exports.getHeaderByVis = getHeaderByVis;

package/build/cjs/modules/eventVisualization/__tests__/eventVisualization.spec.js

@@ -0,0 +1,42 @@
+"use strict";
+
+var _eventVisualization = require("../eventVisualization.js");
+const testDim1 = {
+  dimension: 'eventDate',
+  programStage: {
+    id: 'A03MvHHogjR'
+  }
+};
+const testDim2 = {
+  dimension: 'enrollmentDate',
+  program: {
+    id: 'IpHINAT79UW'
+  }
+};
+const testDim3 = {
+  dimension: 'created'
+};
+const testAxis = [testDim1];
+const testVis = {
+  columns: testAxis,
+  rows: [testDim2],
+  filters: [testDim3]
+};
+describe('eventVisualization', () => {
+  describe('transformEventVisualization', () => {
+    it('does not modify dimension, axis or vis', () => {
+      const newVis = (0, _eventVisualization.transformEventVisualization)(testVis);
+      expect(newVis).not.toBe(testVis);
+      expect(newVis.columns).not.toBe(testAxis);
+      expect(newVis.columns[0]).not.toBe(testDim1);
+    });
+    it('applies program stage to id', () => {
+      const newVis = (0, _eventVisualization.transformEventVisualization)(testVis);
+      expect(newVis.columns[0].dimension).toBe('A03MvHHogjR.eventdate');
+    });
+    it('applies program to id', () => {
+      const newVis = (0, _eventVisualization.transformEventVisualization)(testVis);
+      expect(newVis.rows[0].dimension).toBe('IpHINAT79UW.enrollmentdate');
+    });
+  });
+});

package/build/cjs/modules/eventVisualization/eventVisualization.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.transformEventVisualization = void 0;
+var _dimensions = require("../dimensions.js");
+var _layoutGetAllDimensions = require("../layout/layoutGetAllDimensions.js");
+// Dimensions saved with program or program stage in an EventVisualization need
+// transformation before we can pass them to the pivot table engine
+
+const cloneAxis = axis => axis === null || axis === void 0 ? void 0 : axis.map(dim => ({
+  ...dim
+}));
+const transformEventVisualization = vis => {
+  // Do not modify the original visualization
+  const transformedVis = {
+    ...vis,
+    columns: cloneAxis(vis.columns),
+    rows: cloneAxis(vis.rows),
+    filters: cloneAxis(vis.filters)
+  };
+  (0, _layoutGetAllDimensions.layoutGetAllDimensions)(transformedVis).forEach(dim => {
+    var _dim$program$id, _dim$program, _dim$programStage;
+    const headerName = (0, _dimensions.getHeaderByVis)(dim.dimension);
+    const prefix = (_dim$program$id = (_dim$program = dim.program) === null || _dim$program === void 0 ? void 0 : _dim$program.id) !== null && _dim$program$id !== void 0 ? _dim$program$id : (_dim$programStage = dim.programStage) === null || _dim$programStage === void 0 ? void 0 : _dim$programStage.id;
+    dim.dimension = prefix ? `${prefix}.${headerName}` : headerName;
+  });
+  return transformedVis;
+};
+exports.transformEventVisualization = transformEventVisualization;

package/build/cjs/modules/response/event/__tests__/response.spec.js

@@ -12,6 +12,9 @@ var _datetimeDataOrg = _interopRequireDefault(require("../../../../__demo__/data
 var _emailDataHidena = _interopRequireDefault(require("../../../../__demo__/data/event/email.data.hidena.json"));
 var _emailData = _interopRequireDefault(require("../../../../__demo__/data/event/email.data.json"));
 var _emailDataOrg = _interopRequireDefault(require("../../../../__demo__/data/event/email.data.org.json"));
+var _eventstatusDataHidena = _interopRequireDefault(require("../../../../__demo__/data/event/eventstatus.data.hidena.json"));
+var _eventstatusData = _interopRequireDefault(require("../../../../__demo__/data/event/eventstatus.data.json"));
+var _eventstatusDataOrg = _interopRequireDefault(require("../../../../__demo__/data/event/eventstatus.data.org.json"));
 var _integerDataHidena = _interopRequireDefault(require("../../../../__demo__/data/event/integer.data.hidena.json"));
 var _integerData = _interopRequireDefault(require("../../../../__demo__/data/event/integer.data.json"));
 var _integerDataOrg = _interopRequireDefault(require("../../../../__demo__/data/event/integer.data.org.json"));
@@ -28,6 +31,16 @@ var _valueTypes = require("../../../valueTypes.js");
 var _response = require("../response.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 describe('response', () => {
+  describe('getItemFormatterByHeaderName', () => {
+    it('should return the correct formatter and format correctly', () => {
+      expect((0, _response.getItemFormatterByHeaderName)('eventstatus')('ACTIVE')).toBe('Active');
+      expect((0, _response.getItemFormatterByHeaderName)('eventstatus')('COMPLETED')).toBe('Completed');
+      expect((0, _response.getItemFormatterByHeaderName)('eventstatus')('SCHEDULE')).toBe('Scheduled');
+      expect((0, _response.getItemFormatterByHeaderName)('programstatus')('ACTIVE')).toBe('Active');
+      expect((0, _response.getItemFormatterByHeaderName)('programstatus')('COMPLETED')).toBe('Completed');
+      expect((0, _response.getItemFormatterByHeaderName)('programstatus')('CANCELLED')).toBe('Cancelled');
+    });
+  });
   describe('getItemFormatterByValueType', () => {
     it('should return the correct formatter and format correctly', () => {
       expect((0, _response.getItemFormatterByValueType)(_valueTypes.VALUE_TYPE_BOOLEAN)('1')).toBe('Yes');
@@ -121,5 +134,15 @@ describe('response', () => {
         })).toEqual(_yesonlyDataHidena.default);
       });
     });
+    describe('eventstatus', () => {
+      it('transforms response', () => {
+        expect((0, _response.transformResponse)(_eventstatusDataOrg.default)).toEqual(_eventstatusData.default);
+      });
+      it('transforms response and hides N/A data', () => {
+        expect((0, _response.transformResponse)(_eventstatusDataOrg.default, {
+          hideNaData: true
+        })).toEqual(_eventstatusDataHidena.default);
+      });
+    });
   });
 });

package/build/cjs/modules/response/event/response.js

@@ -3,13 +3,18 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.transformResponse = exports.getItemFormatterByValueType = exports.UNSUPPORTED_VALUE_TYPES = exports.PREFIX_SEPARATOR = exports.NA_VALUE_ITEM = exports.NA_VALUE = void 0;
+exports.transformResponse = exports.getItemFormatterByValueType = exports.getItemFormatterByHeaderName = exports.getItemFormatter = exports.UNSUPPORTED_VALUE_TYPES = exports.PREFIX_SEPARATOR = exports.NA_VALUE_ITEM = exports.NA_VALUE = void 0;
 var _d2I18n = _interopRequireDefault(require("@dhis2/d2-i18n"));
 var _predefinedDimensions = require("../../predefinedDimensions.js");
 var _valueTypes = require("../../valueTypes.js");
 var _default = require("./default.js");
 var _optionSet = require("./optionSet.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Responses coming from these endpoints need transformation
+// before we can pass it to the pivot table engine:
+// - analytics/events/aggregate
+// - analytics/enrollments/aggregate
+
 const PREFIX_SEPARATOR = exports.PREFIX_SEPARATOR = '_';
 const NA_VALUE = exports.NA_VALUE = '';
 const NA_VALUE_ITEM = exports.NA_VALUE_ITEM = {
@@ -22,6 +27,20 @@ const NA_VALUE_ITEM = exports.NA_VALUE_ITEM = {
   }
 };
 const UNSUPPORTED_VALUE_TYPES = exports.UNSUPPORTED_VALUE_TYPES = [_valueTypes.VALUE_TYPE_COORDINATE, _valueTypes.VALUE_TYPE_GEOJSON, _valueTypes.VALUE_TYPE_FILE_RESOURCE, _valueTypes.VALUE_TYPE_IMAGE, _valueTypes.VALUE_TYPE_MULTI_TEXT, _valueTypes.VALUE_TYPE_REFERENCE];
+const STATUSES = {
+  ACTIVE: _d2I18n.default.t('Active'),
+  COMPLETED: _d2I18n.default.t('Completed'),
+  SCHEDULE: _d2I18n.default.t('Scheduled'),
+  CANCELLED: _d2I18n.default.t('Cancelled')
+};
+const formatStatus = value => STATUSES[value] || value;
+const getItemFormatter = ({
+  name,
+  valueType
+}) => getItemFormatterByHeaderName(name) || getItemFormatterByValueType(valueType);
+exports.getItemFormatter = getItemFormatter;
+const getItemFormatterByHeaderName = name => name.endsWith('eventstatus') || name.endsWith('programstatus') ? formatStatus : undefined;
+exports.getItemFormatterByHeaderName = getItemFormatterByHeaderName;
 const getItemFormatterByValueType = valueType => {
   switch (valueType) {
     case _valueTypes.VALUE_TYPE_AGE:
@@ -39,6 +58,9 @@ const getItemFormatterByValueType = valueType => {
   }
 };
 exports.getItemFormatterByValueType = getItemFormatterByValueType;
+const EXCLUDED_HEADER_NAMES = new Set([_predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ORGUNIT, 'lastupdated', 'created', 'completed']);
+const EXCLUDED_HEADER_SUFFIXES = ['.eventdate', '.enrollmentdate', '.scheduleddate', '.incidentdate', '.ou'];
+const isIncludedHeader = header => Boolean(header.meta) && !EXCLUDED_HEADER_NAMES.has(header.name) && !EXCLUDED_HEADER_SUFFIXES.some(suffix => header.name.endsWith(suffix));
 const transformResponse = (response, {
   hideNaData = false
 } = {}) => {
@@ -62,7 +84,7 @@ const transformResponse = (response, {
   const metaHeaders = response.headers.map((header, index) => ({
     ...header,
     index
-  })).filter(header => Boolean(header.meta) && ![_predefinedDimensions.DIMENSION_ID_PERIOD, _predefinedDimensions.DIMENSION_ID_ORGUNIT].includes(header.name));
+  })).filter(isIncludedHeader);
 
   // Legendsets use uids and do not need transformation
   // Skip unsupported value types
@@ -74,7 +96,7 @@ const transformResponse = (response, {
         transformedResponse = (0, _optionSet.applyOptionSetHandler)(transformedResponse, header.index);
       } else {
         transformedResponse = (0, _default.applyDefaultHandler)(transformedResponse, header.index, {
-          itemFormatter: getItemFormatterByValueType(header.valueType)
+          itemFormatter: getItemFormatter(header)
         });
       }
     }

package/build/es/__demo__/PivotTable.event.stories.js

@@ -13,6 +13,11 @@ import datetimeVisualization from './data/event/datetime.visualization.json';
 import emailDataHideNa from './data/event/email.data.hidena.json';
 import emailData from './data/event/email.data.json';
 import emailVisualization from './data/event/email.visualization.json';
+import eventouData from './data/event/eventou.data.json';
+import eventouVisualization from './data/event/eventou.visualization.json';
+import eventstatusDataHideNa from './data/event/eventstatus.data.hidena.json';
+import eventstatusData from './data/event/eventstatus.data.json';
+import eventstatusVisualization from './data/event/eventstatus.visualization.json';
 import integerDataHideNa from './data/event/integer.data.hidena.json';
 import integerData from './data/event/integer.data.json';
 import integerVisualization from './data/event/integer.visualization.json';
@@ -411,4 +416,61 @@ export const Yesonly = (_, {
     visualization: visualization
   }));
 };
-Yesonly.storyName = 'Yesonly';
+Yesonly.storyName = 'Yesonly';
+export const EventstatusNA = (_, {
+  pivotTableOptions
+}) => {
+  const visualization = {
+    ...eventstatusVisualization,
+    ...visualizationReset,
+    ...pivotTableOptions
+  };
+  return /*#__PURE__*/React.createElement("div", {
+    style: {
+      width: 800,
+      height: 600
+    }
+  }, /*#__PURE__*/React.createElement(PivotTable, {
+    data: eventstatusData,
+    visualization: visualization
+  }));
+};
+EventstatusNA.storyName = 'Eventstatus N/A';
+export const Eventstatus = (_, {
+  pivotTableOptions
+}) => {
+  const visualization = {
+    ...eventstatusVisualization,
+    ...visualizationReset,
+    ...pivotTableOptions
+  };
+  return /*#__PURE__*/React.createElement("div", {
+    style: {
+      width: 800,
+      height: 600
+    }
+  }, /*#__PURE__*/React.createElement(PivotTable, {
+    data: eventstatusDataHideNa,
+    visualization: visualization
+  }));
+};
+Eventstatus.storyName = 'Eventstatus';
+export const Eventou = (_, {
+  pivotTableOptions
+}) => {
+  const visualization = {
+    ...eventouVisualization,
+    ...visualizationReset,
+    ...pivotTableOptions
+  };
+  return /*#__PURE__*/React.createElement("div", {
+    style: {
+      width: 800,
+      height: 600
+    }
+  }, /*#__PURE__*/React.createElement(PivotTable, {
+    data: eventouData,
+    visualization: visualization
+  }));
+};
+Eventou.storyName = 'Event orgunit';

package/build/es/__demo__/data/event/eventou.data.json

@@ -0,0 +1,123 @@
+{
+    "headers": [
+        {
+            "name": "A03MvHHogjR.ou",
+            "column": "Organisation unit",
+            "valueType": "ORGANISATION_UNIT",
+            "type": "org.hisp.dhis.organisationunit.OrganisationUnit",
+            "hidden": false,
+            "meta": true
+        },
+        {
+            "name": "A03MvHHogjR.eventdate",
+            "column": "Report date",
+            "valueType": "DATE",
+            "type": "java.time.LocalDate",
+            "hidden": false,
+            "meta": true
+        },
+        {
+            "name": "value",
+            "column": "Value",
+            "valueType": "NUMBER",
+            "type": "java.lang.Double",
+            "hidden": false,
+            "meta": false
+        }
+    ],
+    "metaData": {
+        "items": {
+            "202510": {
+                "name": "202510"
+            },
+            "202511": {
+                "name": "202511"
+            },
+            "202512": {
+                "name": "202512"
+            },
+            "202601": {
+                "name": "202601"
+            },
+            "202602": {
+                "name": "202602"
+            },
+            "202603": {
+                "name": "202603"
+            },
+            "IpHINAT79UW": {
+                "name": "Child Programme"
+            },
+            "ZzYYXq4fJie": {
+                "name": "Baby Postnatal"
+            },
+            "USER_ORGUNIT": {
+                "organisationUnits": [
+                    "ImspTQPwCqd"
+                ]
+            },
+            "A03MvHHogjR.ou": {
+                "name": "Organisation unit"
+            },
+            "ImspTQPwCqd": {
+                "name": "Sierra Leone"
+            },
+            "A03MvHHogjR.eventdate": {
+                "name": "Report date"
+            },
+            "A03MvHHogjR": {
+                "name": "Birth"
+            }
+        },
+        "dimensions": {
+            "A03MvHHogjR.eventdate": [
+                "202510",
+                "202511",
+                "202512",
+                "202601",
+                "202602",
+                "202603"
+            ],
+            "pe": [],
+            "A03MvHHogjR.ou": [
+                "ImspTQPwCqd"
+            ]
+        }
+    },
+    "rowContext": {},
+    "width": 3,
+    "rows": [
+        [
+            "ImspTQPwCqd",
+            "202510",
+            "973"
+        ],
+        [
+            "ImspTQPwCqd",
+            "202511",
+            "932"
+        ],
+        [
+            "ImspTQPwCqd",
+            "202512",
+            "858"
+        ],
+        [
+            "ImspTQPwCqd",
+            "202601",
+            "694"
+        ],
+        [
+            "ImspTQPwCqd",
+            "202602",
+            "629"
+        ],
+        [
+            "ImspTQPwCqd",
+            "202603",
+            "694"
+        ]
+    ],
+    "headerWidth": 3,
+    "height": 6
+}

package/build/es/__demo__/data/event/eventou.visualization.json

@@ -0,0 +1,139 @@
+{
+    "name": "Event orgunit",
+    "created": "2025-07-02T10:27:50.483",
+    "lastUpdated": "2025-07-02T10:27:50.483",
+    "translations": [],
+    "createdBy": {
+        "id": "xE7jOejl9FI",
+        "code": null,
+        "name": "John Traore",
+        "displayName": "John Traore",
+        "username": "admin"
+    },
+    "favorites": [],
+    "lastUpdatedBy": {
+        "id": "xE7jOejl9FI",
+        "code": null,
+        "name": "John Traore",
+        "displayName": "John Traore",
+        "username": "admin"
+    },
+    "sharing": {
+        "owner": "xE7jOejl9FI",
+        "external": false,
+        "users": {},
+        "userGroups": {},
+        "public": "rw------"
+    },
+    "regressionType": "NONE",
+    "displayDensity": "NORMAL",
+    "fontSize": "NORMAL",
+    "sortOrder": 0,
+    "topLimit": 0,
+    "hideEmptyRows": false,
+    "showHierarchy": false,
+    "completedOnly": false,
+    "skipRounding": false,
+    "dataDimensionItems": [],
+    "dataElementGroupSetDimensions": [],
+    "organisationUnitGroupSetDimensions": [],
+    "categoryDimensions": [],
+    "categoryOptionGroupSetDimensions": [],
+    "attributeDimensions": [],
+    "programIndicatorDimensions": [],
+    "subscribers": [],
+    "digitGroupSeparator": "SPACE",
+    "hideEmptyRowItems": "NONE",
+    "hideLegend": false,
+    "noSpaceBetweenColumns": false,
+    "cumulativeValues": false,
+    "percentStackedValues": false,
+    "showData": false,
+    "colTotals": true,
+    "rowTotals": true,
+    "rowSubTotals": true,
+    "colSubTotals": true,
+    "hideTitle": false,
+    "hideSubtitle": false,
+    "showDimensionLabels": true,
+    "interpretations": [],
+    "program": {
+        "enrollmentDateLabel": "Date of enrollment",
+        "incidentDateLabel": "Date of birth",
+        "id": "IpHINAT79UW",
+        "name": "Child Programme"
+    },
+    "programStage": {
+        "executionDateLabel": "Report date",
+        "id": "A03MvHHogjR",
+        "name": "Birth"
+    },
+    "dataType": "AGGREGATED_VALUES",
+    "outputType": "EVENT",
+    "collapseDataDimensions": false,
+    "hideNaData": false,
+    "simpleDimensions": [
+        {
+            "parent": "COLUMN",
+            "dimension": "ou",
+            "values": [
+                "ImspTQPwCqd"
+            ]
+        }
+    ],
+    "legacy": true,
+    "type": "PIVOT_TABLE",
+    "filters": [],
+    "parentGraphMap": {
+        "ImspTQPwCqd": ""
+    },
+    "columns": [
+        {
+            "items": [
+                {
+                    "name": "Sierra Leone",
+                    "id": "ImspTQPwCqd"
+                }
+            ],
+            "dimension": "A03MvHHogjR.ou",
+            "programStage": {
+                "id": "A03MvHHogjR"
+            }
+        }
+    ],
+    "rows": [
+        {
+            "items": [
+                {
+                    "dimensionItemType": "PERIOD",
+                    "id": "LAST_6_MONTHS"
+                }
+            ],
+            "dimension": "A03MvHHogjR.eventdate",
+            "programStage": {
+                "id": "A03MvHHogjR"
+            }
+        }
+    ],
+    "displayName": "Event orgunit",
+    "access": {
+        "manage": true,
+        "externalize": true,
+        "write": true,
+        "read": true,
+        "update": true,
+        "delete": true
+    },
+    "user": {
+        "id": "xE7jOejl9FI",
+        "code": null,
+        "name": "John Traore",
+        "displayName": "John Traore",
+        "username": "admin"
+    },
+    "favorite": false,
+    "subscribed": false,
+    "displayFormName": "Event orgunit",
+    "id": "xLPn5T11Vd4",
+    "attributeValues": []
+}