@dhis2/analytics 26.13.3 → 27.0.0

package/build/es/components/FileMenu/utils.js

@@ -1,4 +1,5 @@
 import i18n from '@dhis2/d2-i18n';
+import { getDisplayNameByVisType, getApiEndpointByVisType } from '../../modules/visTypes.js';
 export const FILE_TYPE_EVENT_REPORT = 'eventReport';
 export const FILE_TYPE_VISUALIZATION = 'visualization';
 export const FILE_TYPE_MAP = 'map';
@@ -34,11 +35,65 @@ export const appPathFor = (fileType, id, apiVersion) => {
 };
 export const preparePayloadForSaveAs = _ref => {
   let {
-    ...visualization
+    visualization,
+    name,
+    description
   } = _ref;
   delete visualization.id;
   delete visualization.created;
   delete visualization.createdBy;
   delete visualization.user;
+  visualization.name = name || visualization.name || i18n.t('Untitled {{visualizationType}}, {{date}}', {
+    visualizationType: getDisplayNameByVisType(visualization.type),
+    date: new Date().toLocaleDateString(undefined, {
+      year: 'numeric',
+      month: 'short',
+      day: '2-digit'
+    })
+  });
+  visualization.description = description !== undefined ? description : visualization.description;
+  return visualization;
+};
+const getSubscriberQuery = type => ({
+  ao: {
+    resource: getApiEndpointByVisType(type),
+    id: _ref2 => {
+      let {
+        id
+      } = _ref2;
+      return id;
+    },
+    params: {
+      fields: 'subscribers'
+    }
+  }
+});
+const apiFetchAOSubscribers = (dataEngine, id, type) => {
+  return dataEngine.query(getSubscriberQuery(type), {
+    variables: {
+      id
+    }
+  });
+};
+export const preparePayloadForSave = async _ref3 => {
+  let {
+    visualization,
+    name,
+    description,
+    engine
+  } = _ref3;
+  const {
+    ao
+  } = await apiFetchAOSubscribers(engine, visualization.id, visualization.type);
+  visualization.subscribers = ao.subscribers;
+  visualization.name = name || visualization.name || i18n.t('Untitled {{visualizationType}}, {{date}}', {
+    visualizationType: getDisplayNameByVisType(visualization.type),
+    date: new Date().toLocaleDateString(undefined, {
+      year: 'numeric',
+      month: 'short',
+      day: '2-digit'
+    })
+  });
+  visualization.description = description !== undefined ? description : visualization.description;
   return visualization;
 };

package/build/es/index.js

@@ -12,7 +12,7 @@ export { default as DimensionFilter } from './components/Filter/Filter.js';
 export { default as DimensionMenu } from './components/DimensionMenu.js';
 export { default as PivotTable } from './components/PivotTable/PivotTable.js';
 export { default as FileMenu } from './components/FileMenu/FileMenu.js';
-export { preparePayloadForSaveAs } from './components/FileMenu/utils.js';
+export { preparePayloadForSaveAs, preparePayloadForSave } from './components/FileMenu/utils.js';
 export { default as VisTypeIcon } from './components/VisTypeIcon.js';
 export { default as LegendKey } from './components/LegendKey/LegendKey.js';
 export { default as AboutAOUnit } from './components/AboutAOUnit/AboutAOUnit.js';
@@ -99,7 +99,7 @@ export { getLayoutTypeByVisType } from './modules/visTypeToLayoutType.js';
 
 // Modules: visTypes
 
-export { VIS_TYPE_GROUP_ALL, VIS_TYPE_GROUP_CHARTS, VIS_TYPE_COLUMN, VIS_TYPE_STACKED_COLUMN, VIS_TYPE_BAR, VIS_TYPE_STACKED_BAR, VIS_TYPE_LINE, VIS_TYPE_AREA, VIS_TYPE_STACKED_AREA, VIS_TYPE_PIE, VIS_TYPE_RADAR, VIS_TYPE_GAUGE, VIS_TYPE_BUBBLE, VIS_TYPE_YEAR_OVER_YEAR_LINE, VIS_TYPE_YEAR_OVER_YEAR_COLUMN, VIS_TYPE_SINGLE_VALUE, VIS_TYPE_PIVOT_TABLE, VIS_TYPE_SCATTER, VIS_TYPE_LINE_LIST, VIS_TYPE_OUTLIER_TABLE, visTypeDisplayNames, visTypeIcons, getDisplayNameByVisType, defaultVisType, isStacked, isMultiType, isYearOverYear, isDualAxisType, isSingleValue, isOutlierTable, isTwoCategoryChartType, isLegendSetType, isColumnBasedType, isVerticalType } from './modules/visTypes.js';
+export { VIS_TYPE_GROUP_ALL, VIS_TYPE_GROUP_CHARTS, VIS_TYPE_COLUMN, VIS_TYPE_STACKED_COLUMN, VIS_TYPE_BAR, VIS_TYPE_STACKED_BAR, VIS_TYPE_LINE, VIS_TYPE_AREA, VIS_TYPE_STACKED_AREA, VIS_TYPE_PIE, VIS_TYPE_RADAR, VIS_TYPE_GAUGE, VIS_TYPE_BUBBLE, VIS_TYPE_YEAR_OVER_YEAR_LINE, VIS_TYPE_YEAR_OVER_YEAR_COLUMN, VIS_TYPE_SINGLE_VALUE, VIS_TYPE_PIVOT_TABLE, VIS_TYPE_SCATTER, VIS_TYPE_LINE_LIST, VIS_TYPE_OUTLIER_TABLE, VIS_TYPE_MAP, visTypeDisplayNames, visTypeIcons, getDisplayNameByVisType, defaultVisType, isStacked, isMultiType, isYearOverYear, isDualAxisType, isSingleValue, isOutlierTable, isTwoCategoryChartType, isLegendSetType, isColumnBasedType, isVerticalType } from './modules/visTypes.js';
 
 // Modules: layoutTypes
 

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

@@ -162,6 +162,7 @@
     "line list": "line list",
     "map": "map",
     "visualization": "visualization",
+    "Untitled {{visualizationType}}, {{date}}": "Untitled {{visualizationType}}, {{date}}",
     "Edit": "Edit",
     "Write a reply": "Write a reply",
     "Post reply": "Post reply",
@@ -451,6 +452,7 @@
     "Single value": "Single value",
     "Outlier table": "Outlier table",
     "All charts": "All charts",
+    "Map": "Map",
     "{{seriesName}} (trend)": "{{seriesName}} (trend)",
     "Trend": "Trend",
     "No legend for this series": "No legend for this series",

package/build/es/modules/visTypes.js

@@ -20,6 +20,7 @@ export const VIS_TYPE_BUBBLE = 'BUBBLE';
 export const VIS_TYPE_GROUP_ALL = 'ALL';
 export const VIS_TYPE_GROUP_CHARTS = 'CHARTS';
 export const VIS_TYPE_OUTLIER_TABLE = 'OUTLIER_TABLE';
+export const VIS_TYPE_MAP = 'MAP';
 export const visTypeDisplayNames = {
   [VIS_TYPE_PIVOT_TABLE]: i18n.t('Pivot table'),
   [VIS_TYPE_AREA]: i18n.t('Area'),
@@ -39,7 +40,8 @@ export const visTypeDisplayNames = {
   [VIS_TYPE_SINGLE_VALUE]: i18n.t('Single value'),
   [VIS_TYPE_OUTLIER_TABLE]: i18n.t('Outlier table'),
   [VIS_TYPE_GROUP_ALL]: i18n.t('All types'),
-  [VIS_TYPE_GROUP_CHARTS]: i18n.t('All charts')
+  [VIS_TYPE_GROUP_CHARTS]: i18n.t('All charts'),
+  [VIS_TYPE_MAP]: i18n.t('Map')
 };
 export const visTypeIcons = {
   [VIS_TYPE_PIVOT_TABLE]: IconVisualizationPivotTable24,
@@ -60,6 +62,26 @@ export const visTypeIcons = {
   [VIS_TYPE_SINGLE_VALUE]: IconVisualizationSingleValue24,
   [VIS_TYPE_OUTLIER_TABLE]: IconVisualizationOutlierTable24
 };
+const visTypeApiEndpoints = {
+  [VIS_TYPE_PIVOT_TABLE]: 'visualizations',
+  [VIS_TYPE_AREA]: 'visualizations',
+  [VIS_TYPE_STACKED_AREA]: 'visualizations',
+  [VIS_TYPE_BAR]: 'visualizations',
+  [VIS_TYPE_STACKED_BAR]: 'visualizations',
+  [VIS_TYPE_COLUMN]: 'visualizations',
+  [VIS_TYPE_YEAR_OVER_YEAR_COLUMN]: 'visualizations',
+  [VIS_TYPE_STACKED_COLUMN]: 'visualizations',
+  [VIS_TYPE_GAUGE]: 'visualizations',
+  [VIS_TYPE_LINE]: 'visualizations',
+  [VIS_TYPE_YEAR_OVER_YEAR_LINE]: 'visualizations',
+  [VIS_TYPE_PIE]: 'visualizations',
+  [VIS_TYPE_RADAR]: 'visualizations',
+  [VIS_TYPE_SCATTER]: 'visualizations',
+  [VIS_TYPE_SINGLE_VALUE]: 'visualizations',
+  [VIS_TYPE_OUTLIER_TABLE]: 'visualizations',
+  [VIS_TYPE_LINE_LIST]: 'eventVisualizations',
+  [VIS_TYPE_MAP]: 'maps'
+};
 export const getDisplayNameByVisType = visType => {
   const displayName = visTypeDisplayNames[visType];
   if (!displayName) {
@@ -67,6 +89,13 @@ export const getDisplayNameByVisType = visType => {
   }
   return displayName;
 };
+export const getApiEndpointByVisType = visType => {
+  const apiEndpoint = visTypeApiEndpoints[visType];
+  if (!apiEndpoint) {
+    throw new Error(`${visType} is not a valid visualization type`);
+  }
+  return apiEndpoint;
+};
 const stackedTypes = [VIS_TYPE_STACKED_COLUMN, VIS_TYPE_STACKED_BAR, VIS_TYPE_STACKED_AREA];
 const yearOverYearTypes = [VIS_TYPE_YEAR_OVER_YEAR_LINE, VIS_TYPE_YEAR_OVER_YEAR_COLUMN];
 const dualAxisTypes = [VIS_TYPE_COLUMN, VIS_TYPE_BAR, VIS_TYPE_LINE, VIS_TYPE_AREA];

package/build/es/visualizations/util/__tests__/getFilterText.spec.js

@@ -111,24 +111,20 @@ describe('getFilterText', () => {
       filters.push({
         dimension: 'pe',
         items: [{
-          id: '_LAST_2_MONTHS_',
-          name: 'Last 2 months'
+          id: '201801'
+        }, {
+          id: 'LAST_3_MONTHS'
+        }, {
+          id: 'LAST_MONTH'
         }]
       });
-      metaData.dimensions.pe = ['_201801_', '_201802_'];
-      metaData.items._LAST_2_MONTHS_ = {
-        name: 'Last 2 months',
-        uid: '_LAST_2_MONTHS_'
-      };
-      metaData.items._201801_ = {
-        name: '01 of 2018',
-        uid: '_201801_'
-      };
-      metaData.items._201802_ = {
-        name: '02 of 2018',
-        uid: '_201802_'
+      metaData.dimensions.pe = ['202501', '202502', '202503', '202504', '201801'];
+      metaData.items['201801'] = {
+        name: 'January 2018'
       };
-      expect(getFilterText(filters, metaData)).toEqual('Clinics, Hospital - 01 of 2018, 02 of 2018');
+
+      // Relative period names come from relativePeriods.js
+      expect(getFilterText(filters, metaData)).toEqual('Clinics, Hospital - January 2018, Last 3 months, Last month');
     });
   });
 });

package/build/es/visualizations/util/getFilterText.js

@@ -1,8 +1,10 @@
+import { getRelativePeriodsName } from '../../components/PeriodDimension/utils/relativePeriods.js';
 import { getOuLevelAndGroupText } from '../../modules/getOuLevelAndGroupText.js';
+import { dimensionGetItemIds } from '../../modules/layout/dimensionGetItemIds.js';
 import { dimensionGetItems } from '../../modules/layout/dimensionGetItems.js';
 import { dimensionIs } from '../../modules/layout/dimensionIs.js';
 import { ouIdHelper } from '../../modules/ouIdHelper/index.js';
-import { DIMENSION_ID_ORGUNIT } from '../../modules/predefinedDimensions.js';
+import { DIMENSION_ID_ORGUNIT, DIMENSION_ID_PERIOD } from '../../modules/predefinedDimensions.js';
 export default function (filters, metaData) {
   if (!Array.isArray(filters) || !filters.length) {
     return '';
@@ -19,6 +21,12 @@ export default function (filters, metaData) {
       return ouIdHelper.hasGroupPrefix(id) || ouIdHelper.hasLevelPrefix(id);
     })) {
       titleFragments.push(getOuLevelAndGroupText(filter, metaData));
+    } else if (dimensionIs(filter, DIMENSION_ID_PERIOD)) {
+      const relativePeriodNames = getRelativePeriodsName();
+      titleFragments.push(dimensionGetItemIds(filter).map(id => {
+        var _metaData$items$id;
+        return relativePeriodNames[id] || ((_metaData$items$id = metaData.items[id]) === null || _metaData$items$id === void 0 ? void 0 : _metaData$items$id.name) || id;
+      }).join(', '));
     } else {
       const filterItems = metaData.dimensions[filter.dimension];
       if (Array.isArray(filterItems)) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/analytics",
-    "version": "26.13.3",
+    "version": "27.0.0",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "exports": {
@@ -39,8 +39,8 @@
         "@storybook/preset-create-react-app": "^8.3.6",
         "@storybook/react": "^8.3.6",
         "@storybook/react-webpack5": "^8.3.6",
-        "@testing-library/jest-dom": "^5.16.5",
-        "@testing-library/react": "^12.1.5",
+        "@testing-library/jest-dom": "6.6.3",
+        "@testing-library/react": "^12",
         "enzyme": "^3.9.0",
         "enzyme-adapter-react-16": "^1.15.6",
         "fs-extra": "^10.1.0",