@dhis2/analytics 26.7.0 → 26.7.2

package/README.md

@@ -3,23 +3,8 @@
 **master**
 [![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
 
-**21.x**
-[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=21.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=21.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
-
-**20.x**
-[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=20.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=20.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
-
-**16.x**
-[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=16.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=16.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
-
-**11.0.x**
-[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=11.0.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=11.0.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
-
-**4.x**
-[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=4.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=4.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
-
-**2.4.x**
-[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=2.4.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=2.4.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
+**24.x**
+[![Test](https://github.com/dhis2/analytics/actions/workflows/node-test.yml/badge.svg?branch=24.x)](https://github.com/dhis2/analytics/actions/workflows/node-test.yml) [![DHIS2: Release](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml/badge.svg?branch=24.x)](https://github.com/dhis2/analytics/actions/workflows/node-publish.yml)
 
 ## Overview
 
@@ -28,6 +13,7 @@ The analytics library contains components and modules that are used in DHIS 2 an
 -   [dhis2/dashboards-app](https://github.com/dhis2/dashboards-app)
 -   [dhis2/data-visualizer-app](https://github.com/dhis2/data-visualizer-app)
 -   [dhis2/maps-app](https://github.com/dhis2/maps-app)
+-   [dhis2/line-listing-app](https://github.com/dhis2/line-listing-app)
 
 [Module layout documentation](./docs/module-layout.md)
 
@@ -35,7 +21,7 @@ The analytics library contains components and modules that are used in DHIS 2 an
 
 The analytics package is published to npm as @dhis2/analytics.
 
-To publish, simply mark the commit using [semantic release terminology](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) (see notes below for branch-specific restrictions). Once committed, github actions will take care of publishing the new version to npm.
+To publish, mark the commit using [semantic release terminology](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines) (see notes below for branch-specific restrictions). Once committed, github actions will take care of publishing the new version to npm.
 
 ### master branch
 
@@ -43,7 +29,31 @@ The master branch follows semantic versioning according to spec.
 
 ### .x branches
 
-Commits to .x branches (e.g. 16.x) cannot trigger a major version bump, even if it is technically a breaking change. This is because the next version has already been published. Additionally, branches that use .x for the patch version (e.g. 11.0.x, 2.4.x), cannot trigger a minor version bump. In the unlikely case that you need to commit a change that would trigger a version bump that's not possible, you will have to mark it to only trigger a patch or minor bump respectively, then make sure to update the apps that are locked to the .x version of analytics
+Commits to .x branches (e.g. 24.x) cannot trigger a major version bump, even if it is technically a breaking change. This is because the next version has already been published. Additionally, branches that use .x for the patch version (e.g. 11.0.x, 2.4.x), cannot trigger a minor version bump. In the unlikely case that you need to commit a change that would trigger a version bump that's not possible, you will have to mark it to only trigger a patch or minor bump respectively, then make sure to update the apps that are locked to the .x version of analytics
+
+## Publishing pre-release versions during app development
+
+Builds for all non-production branches are automatically copied to [d2-ci/analytics](https://github.com/d2-ci/analytics) for use during development and testing, prior to production release.
+
+To test changes in a development branch, change the analytics dependency of package.json of the app you are testing with. There are a few options:
+
+1. point to a specific commit:
+
+```
+"dependencies": {
+        "@dhis2/analytics": "git+https://github.com/d2-ci/analytics.git#70249ebe8be39051fa10142f850de449e1ec488c",
+        ...
+}
+```
+
+2. point to a branch:
+
+```
+"dependencies": {
+        "@dhis2/analytics": "git+https://github.com/d2-ci/analytics.git#chore/some-chore",
+        ...
+}
+```
 
 ## Report an issue
 

package/build/cjs/locales/ne/translations.json

@@ -134,17 +134,6 @@
     "Manage sharing": "",
     "Could not update interpretation": "",
     "Enter interpretation text": "",
-    "Bold text": "",
-    "Italic text": "",
-    "Link to a URL": "",
-    "Mention a user": "",
-    "Add emoji": "",
-    "Preview": "",
-    "Back to write mode": "",
-    "Too many results. Try refining the search.": "",
-    "Search for a user": "",
-    "Searching for \"{{- searchText}}\"": "",
-    "No results found": "कुनै पनि नतिजा भेटिएन",
     "Not available offline": "",
     "Created by": "",
     "Anyone": "",
@@ -203,12 +192,12 @@
     "Period type": "",
     "Year": "",
     "Select year": "",
-    "Period": "",
+    "Period": "अबधि",
     "Selected Periods": "",
     "Relative periods": "",
     "Fixed periods": "",
     "No periods selected": "",
-    "Daily": "",
+    "Daily": "दैनिक",
     "Weekly": "",
     "Weekly (Start Wednesday)": "",
     "Weekly (Start Thursday)": "",
@@ -225,8 +214,8 @@
     "Financial year (Start October)": "",
     "Financial year (Start July)": "",
     "Financial year (Start April)": "",
-    "Today": "",
-    "Yesterday": "",
+    "Today": "आज",
+    "Yesterday": "हिजो",
     "Last 3 days": "",
     "Last 7 days": "",
     "Last 14 days": "",
@@ -276,6 +265,13 @@
     "Six-months": "",
     "Financial Years": "",
     "Years": "",
+    "Bold text": "",
+    "Italic text": "",
+    "Link to a URL": "",
+    "Mention a user": "",
+    "Add emoji": "",
+    "Preview": "",
+    "Back to write mode": "",
     "Interpretations and details": "",
     "Translating to": "",
     "Choose a locale": "",
@@ -286,6 +282,10 @@
     "Cannot save while offline": "",
     "Could not load translations": "",
     "Retry": "",
+    "Too many results. Try refining the search.": "",
+    "Search for a user": "",
+    "Searching for \"{{- searchText}}\"": "",
+    "No results found": "कुनै पनि नतिजा भेटिएन",
     "Series": "",
     "Category": "",
     "Filter": "",

package/build/cjs/modules/renderValue.js

@@ -3,12 +3,12 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.renderValue = void 0;
+exports.separateDigitGroups = exports.renderValue = void 0;
 var _pivotTableConstants = require("./pivotTable/pivotTableConstants.js");
 var _valueTypes = require("./valueTypes.js");
 const trimTrailingZeros = stringValue => stringValue.replace(/\.?0+$/, '');
-const decimalSeparator = '.';
-const separateDigitGroups = (stringValue, decimalSeparator) => {
+const separateDigitGroups = function (stringValue) {
+  let decimalSeparator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '.';
   const isNegative = stringValue[0] === '-';
   const [integer, remainder] = stringValue.replace(/^-/, '').split('.');
   const groups = [];
@@ -26,6 +26,7 @@ const separateDigitGroups = (stringValue, decimalSeparator) => {
   }
   return groups;
 };
+exports.separateDigitGroups = separateDigitGroups;
 const getSeparator = visualization => {
   switch (visualization.digitGroupSeparator) {
     case 'SPACE':
@@ -51,10 +52,10 @@ const renderValue = (value, valueType, visualization) => {
   }
   if (visualization.numberType === _pivotTableConstants.NUMBER_TYPE_ROW_PERCENTAGE || visualization.numberType === _pivotTableConstants.NUMBER_TYPE_COLUMN_PERCENTAGE) {
     const stringValue = trimTrailingZeros(toFixedPrecisionString(value * 100, visualization.skipRounding));
-    return separateDigitGroups(stringValue, decimalSeparator).join(getSeparator(visualization)) + '%';
+    return separateDigitGroups(stringValue).join(getSeparator(visualization)) + '%';
   } else {
     const stringValue = toFixedPrecisionString(value, visualization.skipRounding);
-    return separateDigitGroups(stringValue, decimalSeparator).join(getSeparator(visualization));
+    return separateDigitGroups(stringValue).join(getSeparator(visualization));
   }
 };
 exports.renderValue = renderValue;

package/build/cjs/visualizations/config/adapters/dhis_highcharts/series/__tests__/pie.spec.js

@@ -0,0 +1,41 @@
+"use strict";
+
+var _pie = require("../pie.js");
+describe('formatDataLabel', () => {
+  it('should format data label correctly with integers', () => {
+    const result = (0, _pie.formatDataLabel)('Test', 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+  it('should format data label correctly with decimals', () => {
+    const result = (0, _pie.formatDataLabel)('Test', 1000.123456789, 50.1234);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000.123456789<span style="font-weight:normal"> (50.1%)</span>');
+  });
+  it('should handle large numbers correctly', () => {
+    const result = (0, _pie.formatDataLabel)('Test', 1000000, 75.5678);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000 000<span style="font-weight:normal"> (75.6%)</span>');
+  });
+  it('should handle small percentages correctly', () => {
+    const result = (0, _pie.formatDataLabel)('Test', 1000.000001, 0.09);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000.000001<span style="font-weight:normal"> (0.1%)</span>');
+  });
+  it('should handle zero correctly', () => {
+    const result = (0, _pie.formatDataLabel)('Test', 0, 0);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>0<span style="font-weight:normal"> (0%)</span>');
+  });
+  it('should handle negative numbers correctly', () => {
+    const result = (0, _pie.formatDataLabel)('Test', -1000, -50);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>-1 000<span style="font-weight:normal"> (-50%)</span>');
+  });
+  it('should handle empty string as name correctly', () => {
+    const result = (0, _pie.formatDataLabel)('', 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal"></span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+  it('should handle undefined as name correctly', () => {
+    const result = (0, _pie.formatDataLabel)(undefined, 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal"></span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+  it('should handle special characters in name correctly', () => {
+    const result = (0, _pie.formatDataLabel)('Test&Test', 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal">Test&Test</span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+});

package/build/cjs/visualizations/config/adapters/dhis_highcharts/series/pie.js

@@ -4,6 +4,16 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = _default;
+exports.formatDataLabel = void 0;
+var _renderValue = require("../../../../../modules/renderValue.js");
+const formatDataLabel = function () {
+  let name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  let y = arguments.length > 1 ? arguments[1] : undefined;
+  let percentage = arguments.length > 2 ? arguments[2] : undefined;
+  const value = (0, _renderValue.separateDigitGroups)(y.toString()).join(' ');
+  return '<span style="font-weight:normal">' + name + '</span><br/>' + value + '<span style="font-weight:normal"> (' + parseFloat(percentage.toFixed(1)) + '%)</span>';
+};
+exports.formatDataLabel = formatDataLabel;
 function _default(series, colors) {
   return [{
     colorByPoint: true,
@@ -14,7 +24,7 @@ function _default(series, colors) {
     dataLabels: {
       enabled: true,
       formatter: function () {
-        return '<span style="font-weight:normal">' + this.point.name + '</span><br/>' + this.y + '<span style="font-weight:normal"> (' + this.percentage.toFixed(1) + ' %)</span>';
+        return formatDataLabel(this.point.name, this.y, this.percentage);
       }
     },
     tooltip: {

package/build/es/locales/ne/translations.json

@@ -134,17 +134,6 @@
     "Manage sharing": "",
     "Could not update interpretation": "",
     "Enter interpretation text": "",
-    "Bold text": "",
-    "Italic text": "",
-    "Link to a URL": "",
-    "Mention a user": "",
-    "Add emoji": "",
-    "Preview": "",
-    "Back to write mode": "",
-    "Too many results. Try refining the search.": "",
-    "Search for a user": "",
-    "Searching for \"{{- searchText}}\"": "",
-    "No results found": "कुनै पनि नतिजा भेटिएन",
     "Not available offline": "",
     "Created by": "",
     "Anyone": "",
@@ -203,12 +192,12 @@
     "Period type": "",
     "Year": "",
     "Select year": "",
-    "Period": "",
+    "Period": "अबधि",
     "Selected Periods": "",
     "Relative periods": "",
     "Fixed periods": "",
     "No periods selected": "",
-    "Daily": "",
+    "Daily": "दैनिक",
     "Weekly": "",
     "Weekly (Start Wednesday)": "",
     "Weekly (Start Thursday)": "",
@@ -225,8 +214,8 @@
     "Financial year (Start October)": "",
     "Financial year (Start July)": "",
     "Financial year (Start April)": "",
-    "Today": "",
-    "Yesterday": "",
+    "Today": "आज",
+    "Yesterday": "हिजो",
     "Last 3 days": "",
     "Last 7 days": "",
     "Last 14 days": "",
@@ -276,6 +265,13 @@
     "Six-months": "",
     "Financial Years": "",
     "Years": "",
+    "Bold text": "",
+    "Italic text": "",
+    "Link to a URL": "",
+    "Mention a user": "",
+    "Add emoji": "",
+    "Preview": "",
+    "Back to write mode": "",
     "Interpretations and details": "",
     "Translating to": "",
     "Choose a locale": "",
@@ -286,6 +282,10 @@
     "Cannot save while offline": "",
     "Could not load translations": "",
     "Retry": "",
+    "Too many results. Try refining the search.": "",
+    "Search for a user": "",
+    "Searching for \"{{- searchText}}\"": "",
+    "No results found": "कुनै पनि नतिजा भेटिएन",
     "Series": "",
     "Category": "",
     "Filter": "",

package/build/es/modules/renderValue.js

@@ -1,8 +1,8 @@
 import { NUMBER_TYPE_ROW_PERCENTAGE, NUMBER_TYPE_COLUMN_PERCENTAGE } from './pivotTable/pivotTableConstants.js';
 import { isNumericValueType } from './valueTypes.js';
 const trimTrailingZeros = stringValue => stringValue.replace(/\.?0+$/, '');
-const decimalSeparator = '.';
-const separateDigitGroups = (stringValue, decimalSeparator) => {
+export const separateDigitGroups = function (stringValue) {
+  let decimalSeparator = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : '.';
   const isNegative = stringValue[0] === '-';
   const [integer, remainder] = stringValue.replace(/^-/, '').split('.');
   const groups = [];
@@ -45,9 +45,9 @@ export const renderValue = (value, valueType, visualization) => {
   }
   if (visualization.numberType === NUMBER_TYPE_ROW_PERCENTAGE || visualization.numberType === NUMBER_TYPE_COLUMN_PERCENTAGE) {
     const stringValue = trimTrailingZeros(toFixedPrecisionString(value * 100, visualization.skipRounding));
-    return separateDigitGroups(stringValue, decimalSeparator).join(getSeparator(visualization)) + '%';
+    return separateDigitGroups(stringValue).join(getSeparator(visualization)) + '%';
   } else {
     const stringValue = toFixedPrecisionString(value, visualization.skipRounding);
-    return separateDigitGroups(stringValue, decimalSeparator).join(getSeparator(visualization));
+    return separateDigitGroups(stringValue).join(getSeparator(visualization));
   }
 };

package/build/es/visualizations/config/adapters/dhis_highcharts/series/__tests__/pie.spec.js

@@ -0,0 +1,39 @@
+import { formatDataLabel } from '../pie.js';
+describe('formatDataLabel', () => {
+  it('should format data label correctly with integers', () => {
+    const result = formatDataLabel('Test', 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+  it('should format data label correctly with decimals', () => {
+    const result = formatDataLabel('Test', 1000.123456789, 50.1234);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000.123456789<span style="font-weight:normal"> (50.1%)</span>');
+  });
+  it('should handle large numbers correctly', () => {
+    const result = formatDataLabel('Test', 1000000, 75.5678);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000 000<span style="font-weight:normal"> (75.6%)</span>');
+  });
+  it('should handle small percentages correctly', () => {
+    const result = formatDataLabel('Test', 1000.000001, 0.09);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>1 000.000001<span style="font-weight:normal"> (0.1%)</span>');
+  });
+  it('should handle zero correctly', () => {
+    const result = formatDataLabel('Test', 0, 0);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>0<span style="font-weight:normal"> (0%)</span>');
+  });
+  it('should handle negative numbers correctly', () => {
+    const result = formatDataLabel('Test', -1000, -50);
+    expect(result).toEqual('<span style="font-weight:normal">Test</span><br/>-1 000<span style="font-weight:normal"> (-50%)</span>');
+  });
+  it('should handle empty string as name correctly', () => {
+    const result = formatDataLabel('', 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal"></span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+  it('should handle undefined as name correctly', () => {
+    const result = formatDataLabel(undefined, 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal"></span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+  it('should handle special characters in name correctly', () => {
+    const result = formatDataLabel('Test&Test', 1000, 50);
+    expect(result).toEqual('<span style="font-weight:normal">Test&Test</span><br/>1 000<span style="font-weight:normal"> (50%)</span>');
+  });
+});

package/build/es/visualizations/config/adapters/dhis_highcharts/series/pie.js

@@ -1,3 +1,11 @@
+import { separateDigitGroups } from '../../../../../modules/renderValue.js';
+export const formatDataLabel = function () {
+  let name = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : '';
+  let y = arguments.length > 1 ? arguments[1] : undefined;
+  let percentage = arguments.length > 2 ? arguments[2] : undefined;
+  const value = separateDigitGroups(y.toString()).join(' ');
+  return '<span style="font-weight:normal">' + name + '</span><br/>' + value + '<span style="font-weight:normal"> (' + parseFloat(percentage.toFixed(1)) + '%)</span>';
+};
 export default function (series, colors) {
   return [{
     colorByPoint: true,
@@ -8,7 +16,7 @@ export default function (series, colors) {
     dataLabels: {
       enabled: true,
       formatter: function () {
-        return '<span style="font-weight:normal">' + this.point.name + '</span><br/>' + this.y + '<span style="font-weight:normal"> (' + this.percentage.toFixed(1) + ' %)</span>';
+        return formatDataLabel(this.point.name, this.y, this.percentage);
       }
     },
     tooltip: {

package/package.json

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