@dhis2/analytics 28.0.5 → 28.1.0

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

@@ -0,0 +1,86 @@
+import i18n from '@dhis2/d2-i18n';
+import { DIMENSION_ID_ORGUNIT, DIMENSION_ID_PERIOD } from '../../predefinedDimensions.js';
+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';
+export const PREFIX_SEPARATOR = '_';
+export const NA_VALUE = '';
+export const NA_VALUE_ITEM = {
+  name: i18n.t('No value'),
+  style: {
+    fontStyle: 'italic',
+    color: '#6C7787',
+    fontFamily: 'monospace',
+    letterSpacing: '-0.3px'
+  }
+};
+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];
+export const getItemFormatterByValueType = valueType => {
+  switch (valueType) {
+    case VALUE_TYPE_AGE:
+    case VALUE_TYPE_DATE:
+      return name => name.replace(/ 00:00:00\.0$/, '');
+    case VALUE_TYPE_BOOLEAN:
+    case VALUE_TYPE_TRUE_ONLY:
+      return name => name === '1' ? i18n.t('Yes') : i18n.t('No');
+    case VALUE_TYPE_DATETIME:
+      return name => name.replace(/:00\.0$/, '');
+    case VALUE_TYPE_PERCENTAGE:
+      return name => name.endsWith('.0') ? name.slice(0, -2) : name;
+    default:
+      return undefined;
+  }
+};
+export const transformResponse = (response, {
+  hideNaData = false
+} = {}) => {
+  // Do not modify the original response
+  // Rows is mapped by the handlers
+  let transformedResponse = {
+    ...response,
+    metaData: {
+      ...response.metaData,
+      items: {
+        ...response.metaData.items
+      },
+      dimensions: {
+        ...response.metaData.dimensions
+      }
+    }
+  };
+
+  // Add index to all headers
+  // Include only headers that are "meta" and skip "pe" and "ou"
+  const metaHeaders = response.headers.map((header, index) => ({
+    ...header,
+    index
+  })).filter(header => Boolean(header.meta) && ![DIMENSION_ID_PERIOD, DIMENSION_ID_ORGUNIT].includes(header.name));
+
+  // Legendsets use uids and do not need transformation
+  // Skip unsupported value types
+  // Option set and Boolean have separate handlers
+  // All other types use default handler with specific item formatter
+  metaHeaders.forEach(header => {
+    if (!(header.legendSet || UNSUPPORTED_VALUE_TYPES.includes(header.valueType))) {
+      if (header.optionSet) {
+        transformedResponse = applyOptionSetHandler(transformedResponse, header.index);
+      } else {
+        transformedResponse = applyDefaultHandler(transformedResponse, header.index, {
+          itemFormatter: getItemFormatterByValueType(header.valueType)
+        });
+      }
+    }
+  });
+
+  // Add "No value" dimension item if "Hide NA data" option is disabled
+  // Only add if there is at least one empty value
+  if (!hideNaData) {
+    metaHeaders.forEach(header => {
+      if (response.rows.map(row => row[header.index]).includes(NA_VALUE)) {
+        transformedResponse.metaData.dimensions[header.name] = [...transformedResponse.metaData.dimensions[header.name], NA_VALUE];
+        transformedResponse.metaData.items[NA_VALUE] = NA_VALUE_ITEM;
+      }
+    });
+  }
+  return transformedResponse;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/analytics",
-    "version": "28.0.5",
+    "version": "28.1.0",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "exports": {