@dhis2/analytics 29.4.2 → 29.5.0

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

@@ -0,0 +1,40 @@
+import { transformEventVisualization } from '../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 = 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 = transformEventVisualization(testVis);
+      expect(newVis.columns[0].dimension).toBe('A03MvHHogjR.eventdate');
+    });
+    it('applies program to id', () => {
+      const newVis = transformEventVisualization(testVis);
+      expect(newVis.rows[0].dimension).toBe('IpHINAT79UW.enrollmentdate');
+    });
+  });
+});

package/build/es/modules/eventVisualization/eventVisualization.js

@@ -0,0 +1,25 @@
+import { getHeaderByVis } from '../dimensions.js';
+import { layoutGetAllDimensions } from '../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
+}));
+export const transformEventVisualization = vis => {
+  // Do not modify the original visualization
+  const transformedVis = {
+    ...vis,
+    columns: cloneAxis(vis.columns),
+    rows: cloneAxis(vis.rows),
+    filters: cloneAxis(vis.filters)
+  };
+  layoutGetAllDimensions(transformedVis).forEach(dim => {
+    var _dim$program$id, _dim$program, _dim$programStage;
+    const headerName = 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;
+};

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

@@ -10,6 +10,9 @@ import responseDatetimeOrg from '../../../../__demo__/data/event/datetime.data.o
 import responseTextHideNa from '../../../../__demo__/data/event/email.data.hidena.json';
 import responseText from '../../../../__demo__/data/event/email.data.json';
 import responseTextOrg from '../../../../__demo__/data/event/email.data.org.json';
+import responseEventstatusHideNa from '../../../../__demo__/data/event/eventstatus.data.hidena.json';
+import responseEventstatus from '../../../../__demo__/data/event/eventstatus.data.json';
+import responseEventstatusOrg from '../../../../__demo__/data/event/eventstatus.data.org.json';
 import responseNumericHideNa from '../../../../__demo__/data/event/integer.data.hidena.json';
 import responseNumeric from '../../../../__demo__/data/event/integer.data.json';
 import responseNumericOrg from '../../../../__demo__/data/event/integer.data.org.json';
@@ -23,8 +26,18 @@ import responseYesOnlyHideNa from '../../../../__demo__/data/event/yesonly.data.
 import responseYesOnly from '../../../../__demo__/data/event/yesonly.data.json';
 import responseYesOnlyOrg from '../../../../__demo__/data/event/yesonly.data.org.json';
 import { VALUE_TYPE_AGE, VALUE_TYPE_BOOLEAN, VALUE_TYPE_DATE, VALUE_TYPE_DATETIME, VALUE_TYPE_PERCENTAGE, VALUE_TYPE_TRUE_ONLY } from '../../../valueTypes.js';
-import { getItemFormatterByValueType, transformResponse } from '../response.js';
+import { getItemFormatterByHeaderName, getItemFormatterByValueType, transformResponse } from '../response.js';
 describe('response', () => {
+  describe('getItemFormatterByHeaderName', () => {
+    it('should return the correct formatter and format correctly', () => {
+      expect(getItemFormatterByHeaderName('eventstatus')('ACTIVE')).toBe('Active');
+      expect(getItemFormatterByHeaderName('eventstatus')('COMPLETED')).toBe('Completed');
+      expect(getItemFormatterByHeaderName('eventstatus')('SCHEDULE')).toBe('Scheduled');
+      expect(getItemFormatterByHeaderName('programstatus')('ACTIVE')).toBe('Active');
+      expect(getItemFormatterByHeaderName('programstatus')('COMPLETED')).toBe('Completed');
+      expect(getItemFormatterByHeaderName('programstatus')('CANCELLED')).toBe('Cancelled');
+    });
+  });
   describe('getItemFormatterByValueType', () => {
     it('should return the correct formatter and format correctly', () => {
       expect(getItemFormatterByValueType(VALUE_TYPE_BOOLEAN)('1')).toBe('Yes');
@@ -118,5 +131,15 @@ describe('response', () => {
         })).toEqual(responseYesOnlyHideNa);
       });
     });
+    describe('eventstatus', () => {
+      it('transforms response', () => {
+        expect(transformResponse(responseEventstatusOrg)).toEqual(responseEventstatus);
+      });
+      it('transforms response and hides N/A data', () => {
+        expect(transformResponse(responseEventstatusOrg, {
+          hideNaData: true
+        })).toEqual(responseEventstatusHideNa);
+      });
+    });
   });
 });

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

@@ -3,6 +3,12 @@ import { DIMENSION_ID_ORGUNIT, DIMENSION_ID_PERIOD } from '../../predefinedDimen
 import { VALUE_TYPE_AGE, VALUE_TYPE_BOOLEAN, VALUE_TYPE_COORDINATE, VALUE_TYPE_DATE, VALUE_TYPE_DATETIME, VALUE_TYPE_FILE_RESOURCE, VALUE_TYPE_GEOJSON, VALUE_TYPE_IMAGE, VALUE_TYPE_MULTI_TEXT, VALUE_TYPE_PERCENTAGE, VALUE_TYPE_REFERENCE, VALUE_TYPE_TRUE_ONLY } from '../../valueTypes.js';
 import { applyDefaultHandler } from './default.js';
 import { applyOptionSetHandler } from './optionSet.js';
+
+// Responses coming from these endpoints need transformation
+// before we can pass it to the pivot table engine:
+// - analytics/events/aggregate
+// - analytics/enrollments/aggregate
+
 export const PREFIX_SEPARATOR = '_';
 export const NA_VALUE = '';
 export const NA_VALUE_ITEM = {
@@ -15,6 +21,18 @@ export const NA_VALUE_ITEM = {
   }
 };
 export const UNSUPPORTED_VALUE_TYPES = [VALUE_TYPE_COORDINATE, VALUE_TYPE_GEOJSON, VALUE_TYPE_FILE_RESOURCE, VALUE_TYPE_IMAGE, VALUE_TYPE_MULTI_TEXT, VALUE_TYPE_REFERENCE];
+const STATUSES = {
+  ACTIVE: i18n.t('Active'),
+  COMPLETED: i18n.t('Completed'),
+  SCHEDULE: i18n.t('Scheduled'),
+  CANCELLED: i18n.t('Cancelled')
+};
+const formatStatus = value => STATUSES[value] || value;
+export const getItemFormatter = ({
+  name,
+  valueType
+}) => getItemFormatterByHeaderName(name) || getItemFormatterByValueType(valueType);
+export const getItemFormatterByHeaderName = name => name.endsWith('eventstatus') || name.endsWith('programstatus') ? formatStatus : undefined;
 export const getItemFormatterByValueType = valueType => {
   switch (valueType) {
     case VALUE_TYPE_AGE:
@@ -31,6 +49,9 @@ export const getItemFormatterByValueType = valueType => {
       return undefined;
   }
 };
+const EXCLUDED_HEADER_NAMES = new Set([DIMENSION_ID_PERIOD, 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));
 export const transformResponse = (response, {
   hideNaData = false
 } = {}) => {
@@ -54,7 +75,7 @@ export const transformResponse = (response, {
   const metaHeaders = response.headers.map((header, index) => ({
     ...header,
     index
-  })).filter(header => Boolean(header.meta) && ![DIMENSION_ID_PERIOD, DIMENSION_ID_ORGUNIT].includes(header.name));
+  })).filter(isIncludedHeader);
 
   // Legendsets use uids and do not need transformation
   // Skip unsupported value types
@@ -66,7 +87,7 @@ export const transformResponse = (response, {
         transformedResponse = applyOptionSetHandler(transformedResponse, header.index);
       } else {
         transformedResponse = applyDefaultHandler(transformedResponse, header.index, {
-          itemFormatter: getItemFormatterByValueType(header.valueType)
+          itemFormatter: getItemFormatter(header)
         });
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/analytics",
-    "version": "29.4.2",
+    "version": "29.5.0",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "exports": {
@@ -35,10 +35,8 @@
         "@dhis2/cli-style": "^10.7.9",
         "@dhis2/d2-i18n": "^1.1.0",
         "@dhis2/ui": "^10.12.7",
-        "@mihkeleidast/storybook-addon-source": "^1.0.1",
-        "@storybook/preset-create-react-app": "^8.3.6",
-        "@storybook/react": "^8.3.6",
-        "@storybook/react-webpack5": "^8.3.6",
+        "@storybook/preset-create-react-app": "^10.3.4",
+        "@storybook/react-webpack5": "^10.3.4",
         "@testing-library/dom": "^10.4.0",
         "@testing-library/jest-dom": "^6.6.3",
         "@testing-library/react": "^16.3.0",
@@ -48,8 +46,9 @@
         "react": "^18.3.1",
         "react-dom": "^18.3.1",
         "react-scripts": "^5.0.1",
-        "storybook": "^8.3.6",
-        "styled-jsx": "^4.0.1"
+        "storybook": "^10.3.4",
+        "styled-jsx": "^4.0.1",
+        "eslint-plugin-storybook": "10.3.4"
     },
     "peerDependencies": {
         "@dhis2/app-runtime": "^3",
@@ -80,5 +79,8 @@
     "files": [
         "build"
     ],
+    "resolutions": {
+        "i18next": "^23.0.0"
+    },
     "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }