@dhis2/analytics 24.10.1 → 25.0.0

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

@@ -0,0 +1,88 @@
+import { DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM } from '../dataTypes.js';
+import { getExpressionHashFromVisualization, getHash } from '../hash.js';
+describe('getHash', () => {
+  const textInput = 'Raymond Luxury Yacht';
+  it('accepts a string and returns a hash', () => {
+    const hash = getHash(textInput);
+    expect(typeof hash).toBe('string');
+    expect(hash).not.toBe(textInput);
+  });
+  it('is deterministic', () => {
+    expect(getHash(textInput)).toBe(getHash(textInput));
+  });
+  it('returns undefined for invalid input', () => {
+    const unsupportedTypes = ['', 1, true, null, undefined, {}, []];
+    unsupportedTypes.forEach(type => expect(getHash(type)).toBe(undefined));
+  });
+});
+describe('getExpressionHashFromVisualization', () => {
+  const edi1 = {
+    id: 'OdiHJayrsKo',
+    dimensionItemType: DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM,
+    expression: '#{abc} * 10'
+  };
+  const edi2 = {
+    id: 'Uvn6LCg7dVU',
+    dimensionItemType: DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM,
+    expression: '#{abc} * 20'
+  };
+  const dxWithEdi = {
+    dimension: 'dx',
+    items: [edi1, edi2]
+  };
+  it('generates a hash (columns)', () => {
+    expect(typeof getExpressionHashFromVisualization({
+      columns: [dxWithEdi],
+      rows: [],
+      filters: []
+    })).toBe('string');
+  });
+  it('generates a hash (rows)', () => {
+    expect(typeof getExpressionHashFromVisualization({
+      columns: [],
+      rows: [dxWithEdi],
+      filters: []
+    })).toBe('string');
+  });
+  it('generates a hash (filters)', () => {
+    expect(typeof getExpressionHashFromVisualization({
+      columns: [],
+      rows: [],
+      filters: [dxWithEdi]
+    })).toBe('string');
+  });
+  it('does not generate a hash when there are no dimensions', () => {
+    expect(getExpressionHashFromVisualization({
+      columns: [],
+      rows: [],
+      filters: []
+    })).toBe(undefined);
+  });
+  it('does not generate a hash when there are no EDI dimensions', () => {
+    expect(getExpressionHashFromVisualization({
+      columns: [{
+        id: 'OdiHJayrsKo',
+        dimensionItemType: 'INDICATOR'
+      }],
+      rows: [],
+      filters: []
+    })).toBe(undefined);
+  });
+  it('sorts the edi objects by id before generating the hash to optimize caching', () => {
+    expect(getExpressionHashFromVisualization({
+      columns: [{
+        dimension: 'dx',
+        items: [edi1, edi2]
+      }],
+      rows: [],
+      filters: []
+    })).toBe(getExpressionHashFromVisualization({
+      columns: [{
+        dimension: 'dx',
+        items: [edi2, edi1]
+      }],
+      rows: [],
+      filters: []
+    }));
+  });
+});

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

@@ -0,0 +1,43 @@
+import { parseExpression } from '../expressions.js';
+test('matches numbers and operators', () => {
+  expect(parseExpression('1+2-3*4/5')).toEqual(['1', '+', '2', '-', '3', '*', '4', '/', '5']);
+});
+test('matches #{} with letters, numbers and operators', () => {
+  expect(parseExpression('#{abc123}+100-200*300/400')).toEqual(['#{abc123}', '+', '100', '-', '200', '*', '300', '/', '400']);
+});
+test('matches numbers and operators with brackets', () => {
+  expect(parseExpression('1+(2-3)*4/5')).toEqual(['1', '+', '(', '2', '-', '3', ')', '*', '4', '/', '5']);
+});
+test('matches #{} with letters, numbers and operators with brackets', () => {
+  expect(parseExpression('(100-200)+#{abc123}*300/400')).toEqual(['(', '100', '-', '200', ')', '+', '#{abc123}', '*', '300', '/', '400']);
+});
+test('matches #{} with numbers and operators with brackets', () => {
+  expect(parseExpression('#{123}+(10-200)*3000/40000')).toEqual(['#{123}', '+', '(', '10', '-', '200', ')', '*', '3000', '/', '40000']);
+});
+test('matches #{} with letters and numbers only', () => {
+  expect(parseExpression('#{abc123}')).toEqual(['#{abc123}']);
+});
+test('matches #{} with numbers only', () => {
+  expect(parseExpression('#{123}')).toEqual(['#{123}']);
+});
+test('matches #{} with letters only', () => {
+  expect(parseExpression('#{abc}')).toEqual(['#{abc}']);
+});
+test('matches #{} with no input', () => {
+  expect(parseExpression('')).toEqual([]);
+});
+test('matches multiple #{} with operators', () => {
+  expect(parseExpression('#{abc123}+#{def456}')).toEqual(['#{abc123}', '+', '#{def456}']);
+});
+test('matches multiple #{} containing dots with operators', () => {
+  expect(parseExpression('#{abc123.xyz999}+#{def456.xyz999}')).toEqual(['#{abc123.xyz999}', '+', '#{def456.xyz999}']);
+});
+test('matches multiple #{} with operators with brackets', () => {
+  expect(parseExpression('(#{abc123}/#{def456})*#{ghi789}')).toEqual(['(', '#{abc123}', '/', '#{def456}', ')', '*', '#{ghi789}']);
+});
+test('matches on decimal numbers', () => {
+  expect(parseExpression('#{abc123}*1.2/#{def456}')).toEqual(['#{abc123}', '*', '1.2', '/', '#{def456}']);
+});
+test('matches on decimal numbers with #{} containing dots', () => {
+  expect(parseExpression('1.2+#{abc123.xyz999}')).toEqual(['1.2', '+', '#{abc123.xyz999}']);
+});

package/build/es/modules/dataTypes.js

@@ -15,6 +15,7 @@ export const DIMENSION_TYPE_DATA = 'DATA_X';
 export const DIMENSION_TYPE_PERIOD = 'PERIOD';
 export const DIMENSION_TYPE_ORGANISATION_UNIT = 'ORGANISATION_UNIT';
 export const DIMENSION_TYPE_ORGANISATION_UNIT_GROUP_SET = 'ORGANISATION_UNIT_GROUP_SET';
+export const DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM = 'EXPRESSION_DIMENSION_ITEM';
 export const TOTALS = 'totals';
 export const DETAIL = 'detail';
 export const SUB_GROUP_DETAIL = 'DETAIL';
@@ -88,6 +89,11 @@ export const dataTypeMap = {
     getItemName: () => i18n.t('Program indicator'),
     getGroupEmptyLabel: () => i18n.t('No programs found'),
     getGroupLoadingLabel: () => i18n.t('Loading programs')
+  },
+  [DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM]: {
+    id: DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM,
+    getName: () => i18n.t('Calculations'),
+    getItemName: () => i18n.t('Calculation')
   }
 };
 export function defaultGroupId(dataType) {

package/build/es/modules/dimensionListItem.js

@@ -0,0 +1,61 @@
+import { IconDimensionDataSet16, IconDimensionIndicator16, IconDimensionEventDataItem16, IconDimensionProgramIndicator16 } from '@dhis2/ui';
+import React from 'react';
+import DataElementIcon from '../assets/DimensionItemIcons/DataElementIcon.js';
+import GenericIcon from '../assets/DimensionItemIcons/GenericIcon.js';
+import CalculationIcon from './../assets/DimensionItemIcons/CalculationIcon.js';
+import { REPORTING_RATE } from './dataSets.js';
+import { DIMENSION_TYPE_DATA_ELEMENT, DIMENSION_TYPE_DATA_ELEMENT_OPERAND, DIMENSION_TYPE_DATA_SET, DIMENSION_TYPE_EVENT_DATA_ITEM, DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM, DIMENSION_TYPE_PROGRAM_ATTRIBUTE, DIMENSION_TYPE_PROGRAM_DATA_ELEMENT, dataTypeMap as dataTypes, DIMENSION_TYPE_INDICATOR, DIMENSION_TYPE_PROGRAM_INDICATOR } from './dataTypes.js';
+export const getTooltipText = _ref => {
+  var _dataTypes$type;
+
+  let {
+    type,
+    expression
+  } = _ref;
+
+  if (type === DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM && expression) {
+    return dataTypes[DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM].getItemName();
+  }
+
+  switch (type) {
+    case DIMENSION_TYPE_DATA_ELEMENT_OPERAND:
+      return dataTypes[DIMENSION_TYPE_DATA_ELEMENT].getItemName();
+
+    case REPORTING_RATE:
+      return dataTypes[DIMENSION_TYPE_DATA_SET].getItemName();
+
+    case DIMENSION_TYPE_PROGRAM_DATA_ELEMENT:
+    case DIMENSION_TYPE_PROGRAM_ATTRIBUTE:
+      return dataTypes[DIMENSION_TYPE_EVENT_DATA_ITEM].getItemName();
+
+    default:
+      return (_dataTypes$type = dataTypes[type]) === null || _dataTypes$type === void 0 ? void 0 : _dataTypes$type.getItemName();
+  }
+};
+export const getIcon = type => {
+  switch (type) {
+    case DIMENSION_TYPE_INDICATOR:
+      return /*#__PURE__*/React.createElement(IconDimensionIndicator16, null);
+
+    case DIMENSION_TYPE_DATA_ELEMENT_OPERAND:
+    case DIMENSION_TYPE_DATA_ELEMENT:
+      return DataElementIcon;
+
+    case REPORTING_RATE:
+      return /*#__PURE__*/React.createElement(IconDimensionDataSet16, null);
+
+    case DIMENSION_TYPE_EVENT_DATA_ITEM:
+    case DIMENSION_TYPE_PROGRAM_DATA_ELEMENT:
+    case DIMENSION_TYPE_PROGRAM_ATTRIBUTE:
+      return /*#__PURE__*/React.createElement(IconDimensionEventDataItem16, null);
+
+    case DIMENSION_TYPE_PROGRAM_INDICATOR:
+      return /*#__PURE__*/React.createElement(IconDimensionProgramIndicator16, null);
+
+    case DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM:
+      return CalculationIcon;
+
+    default:
+      return GenericIcon;
+  }
+};

package/build/es/modules/expressions.js

@@ -0,0 +1,131 @@
+import i18n from '../locales/index.js';
+export const EXPRESSION_TYPE_NUMBER = 'EXPRESSION_TYPE_NUMBER';
+export const EXPRESSION_TYPE_OPERATOR = 'EXPRESSION_TYPE_OPERATOR';
+export const EXPRESSION_TYPE_DATA = 'EXPRESSION_TYPE_DATA';
+export const VALID_EXPRESSION = 'OK';
+export const INVALID_EXPRESSION = 'ERROR';
+export const getOperators = () => [{
+  value: '+',
+  label: '+',
+  type: EXPRESSION_TYPE_OPERATOR
+}, {
+  value: '-',
+  label: '-',
+  type: EXPRESSION_TYPE_OPERATOR
+}, {
+  value: '*',
+  label: '×',
+  type: EXPRESSION_TYPE_OPERATOR
+}, {
+  value: '/',
+  label: '/',
+  type: EXPRESSION_TYPE_OPERATOR
+}, {
+  value: '(',
+  label: '(',
+  type: EXPRESSION_TYPE_OPERATOR
+}, {
+  value: ')',
+  label: ')',
+  type: EXPRESSION_TYPE_OPERATOR
+}, {
+  value: '',
+  label: i18n.t('Number'),
+  type: EXPRESSION_TYPE_NUMBER
+}];
+export const parseExpression = input => {
+  const regex = /(#{[a-zA-Z0-9#.]+}|[+\-*/()])|(\d+(\.\d+)?)/g;
+  return input.match(regex) || [];
+};
+export const parseExpressionToArray = function () {
+  let expression = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  let metadata = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
+  return parseExpression(expression).map(value => {
+    if (value.startsWith('#{') && value.endsWith('}')) {
+      var _metadata$find;
+
+      const id = value.slice(2, -1);
+      const label = ((_metadata$find = metadata.find(item => item.id === id)) === null || _metadata$find === void 0 ? void 0 : _metadata$find.name) || id;
+      return {
+        value,
+        label,
+        type: EXPRESSION_TYPE_DATA
+      };
+    }
+
+    if (isNaN(value)) {
+      return {
+        value,
+        label: getOperators().find(op => op.value === value).label,
+        type: EXPRESSION_TYPE_OPERATOR
+      };
+    }
+
+    return {
+      value,
+      label: value,
+      type: EXPRESSION_TYPE_NUMBER
+    };
+  }) || [];
+};
+export const parseArrayToExpression = function () {
+  let input = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
+  return input.map(item => item.value).join('');
+};
+export const validateExpression = expression => {
+  let result;
+  const leftParenthesisCount = expression.split('(').length - 1;
+  const rightParenthesisCount = expression.split(')').length - 1;
+
+  if (!expression) {
+    // empty formula
+    result = {
+      status: INVALID_EXPRESSION,
+      message: i18n.t('Formula is empty. Add items to the formula from the lists on the left.')
+    }; // TODO: reimplement this but allow negative values, e.g. 10 / -5
+    // } else if (/[-+/*]{2,}/.test(expression)) {
+    //     // two math operators next to each other
+    //     result = {
+    //         status: INVALID_EXPRESSION,
+    //         message: i18n.t('Consecutive math operators'),
+    //     }
+  } else if (/}#/.test(expression)) {
+    // two data elements next to each other
+    result = {
+      status: INVALID_EXPRESSION,
+      message: i18n.t('Consecutive data elements')
+    };
+  } else if (/^[+\-*/]|[+\-*/]$/.test(expression)) {
+    // starting or ending with a math operator
+    result = {
+      status: INVALID_EXPRESSION,
+      message: i18n.t('Starts or ends with a math operator')
+    };
+  } else if (/\(\)/.test(expression)) {
+    // contains an empty set of parentheses
+    result = {
+      status: INVALID_EXPRESSION,
+      message: i18n.t('Empty parentheses')
+    };
+  } else if (leftParenthesisCount > rightParenthesisCount) {
+    // ( but no )
+    result = {
+      status: INVALID_EXPRESSION,
+      message: i18n.t('Missing right parenthesis )')
+    };
+  } else if (rightParenthesisCount > leftParenthesisCount) {
+    // ) but no (
+    result = {
+      status: INVALID_EXPRESSION,
+      message: i18n.t('Missing left parenthesis (')
+    };
+  }
+
+  return result;
+};
+export const getItemIdsFromExpression = function () {
+  let expression = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  const regex = /#{([a-zA-Z0-9#]+.*?)}/g;
+  const matches = expression.match(regex);
+  return matches ? matches.map(match => match.slice(2, -1)) : [];
+};

package/build/es/modules/hash.js

@@ -0,0 +1,12 @@
+import SHA1 from 'crypto-js/sha1';
+import { DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM } from './dataTypes.js';
+import { layoutGetAllItems } from './layout/layoutGetAllItems.js';
+
+const isValidValue = value => typeof value === 'string' && value.length;
+
+export const getHash = value => isValidValue(value) ? SHA1(value).toString() : undefined;
+export const getExpressionHashFromVisualization = visualization => {
+  var _layoutGetAllItems;
+
+  return getHash((_layoutGetAllItems = layoutGetAllItems(visualization)) === null || _layoutGetAllItems === void 0 ? void 0 : _layoutGetAllItems.filter(item => item.dimensionItemType === DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM && isValidValue(item.expression)).sort((i1, i2) => i1.id < i2.id ? -1 : i1.id > i2.id ? 1 : 0).map(edi => edi.expression).join(''));
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/analytics",
-    "version": "24.10.1",
+    "version": "25.0.0",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "exports": {
@@ -60,7 +60,12 @@
     "dependencies": {
         "@dhis2/d2-ui-rich-text": "^7.4.0",
         "@dhis2/multi-calendar-dates": "1.0.0",
+        "@dnd-kit/core": "^6.0.7",
+        "@dnd-kit/sortable": "^7.0.2",
+        "@dnd-kit/utilities": "^3.2.1",
+        "@react-hook/debounce": "^4.0.0",
         "classnames": "^2.3.1",
+        "crypto-js": "^4.1.1",
         "d2-utilizr": "^0.2.16",
         "d3-color": "^1.2.3",
         "highcharts": "^10.2.0",