@dhis2/analytics 26.4.1 → 26.6.0

package/build/cjs/api/analytics/AnalyticsResponse.js

@@ -58,7 +58,8 @@ class AnalyticsResponse {
     }
   }
   extractHeaders() {
-    const dimensions = this.response.metaData.dimensions;
+    // some endpoints (ie. outlierDetection) don't return dimensions in metaData
+    const dimensions = this.response.metaData.dimensions || {};
     const headers = this.response.headers || [];
     return headers.map((header, index) => new _AnalyticsResponseHeader.default(header, {
       isPrefix: isPrefixHeader(header, dimensions[header.name]),
@@ -94,48 +95,50 @@ class AnalyticsResponse {
       items
     } = metaData;
 
-    // populate metaData dimensions and items
-    this.headers.filter(header => !DEFAULT_COLLECT_IGNORE_HEADERS.includes(header.name)).forEach(header => {
-      let ids;
+    // some endpoints (ie. outlierDetection) don't return dimensions or items
+    if (dimensions && items) {
+      this.headers.filter(header => !DEFAULT_COLLECT_IGNORE_HEADERS.includes(header.name)).forEach(header => {
+        let ids;
 
-      // collect row values
-      if (header.isCollect) {
-        ids = this.getSortedUniqueRowIdStringsByHeader(header);
-        dimensions[header.name] = ids;
-      } else {
-        ids = dimensions[header.name];
-      }
-      if (header.isPrefix) {
-        // create prefixed dimensions array
-        dimensions[header.name] = ids.map(id => getPrefixedId(id, header.name));
-
-        // create items
-        dimensions[header.name].forEach((prefixedId, index) => {
-          const id = ids[index];
-          const valueType = header.valueType;
-          const name = getNameByIdsByValueType(id, valueType);
-          items[prefixedId] = {
-            name
-          };
-        });
-      }
-    });
+        // collect row values
+        if (header.isCollect) {
+          ids = this.getSortedUniqueRowIdStringsByHeader(header);
+          dimensions[header.name] = ids;
+        } else {
+          ids = dimensions[header.name];
+        }
+        if (header.isPrefix) {
+          // create prefixed dimensions array
+          dimensions[header.name] = ids.map(id => getPrefixedId(id, header.name));
 
-    // for events, add items from 'ouname'
-    if (this.hasHeader(OUNAME) && this.hasHeader(OU)) {
-      const ouNameHeaderIndex = this.getHeader(OUNAME).getIndex();
-      const ouHeaderIndex = this.getHeader(OU).getIndex();
-      let ouId;
-      let ouName;
-      this.rows.forEach(row => {
-        ouId = row[ouHeaderIndex];
-        if (items[ouId] === undefined) {
-          ouName = row[ouNameHeaderIndex];
-          items[ouId] = {
-            name: ouName
-          };
+          // create items
+          dimensions[header.name].forEach((prefixedId, index) => {
+            const id = ids[index];
+            const valueType = header.valueType;
+            const name = getNameByIdsByValueType(id, valueType);
+            items[prefixedId] = {
+              name
+            };
+          });
         }
       });
+
+      // for events, add items from 'ouname'
+      if (this.hasHeader(OUNAME) && this.hasHeader(OU)) {
+        const ouNameHeaderIndex = this.getHeader(OUNAME).getIndex();
+        const ouHeaderIndex = this.getHeader(OU).getIndex();
+        let ouId;
+        let ouName;
+        this.rows.forEach(row => {
+          ouId = row[ouHeaderIndex];
+          if (items[ouId] === undefined) {
+            ouName = row[ouNameHeaderIndex];
+            items[ouId] = {
+              name: ouName
+            };
+          }
+        });
+      }
     }
     return metaData;
   }

package/build/cjs/api/analytics/AnalyticsTrackedEntities.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _AnalyticsBase = _interopRequireDefault(require("./AnalyticsBase.js"));
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+/**
+ * @extends module:analytics.AnalyticsBase
+ *
+ * @description
+ * Analytics tracked entities class used to request analytics tracked entities data from Web API.
+ *
+ * @memberof module:analytics
+ */
+class AnalyticsTrackedEntities extends _AnalyticsBase.default {
+  /**
+   * @param {!AnalyticsRequest} req Request object
+   *
+   * @returns {Promise} Promise that resolves with the analytics query data from the api.
+   *
+   * @example
+      // TODO: provide working example
+   */
+  getQuery(req) {
+    return this.fetch(req.withPath('trackedEntities/query'));
+  }
+}
+var _default = AnalyticsTrackedEntities;
+exports.default = _default;

package/build/cjs/api/analytics/__tests__/Analytics.spec.js

@@ -2,6 +2,7 @@
 
 var _Analytics = _interopRequireDefault(require("../Analytics.js"));
 var _AnalyticsAggregate = _interopRequireDefault(require("../AnalyticsAggregate.js"));
+var _AnalyticsEnrollments = _interopRequireDefault(require("../AnalyticsEnrollments.js"));
 var _AnalyticsEvents = _interopRequireDefault(require("../AnalyticsEvents.js"));
 var _AnalyticsRequest = _interopRequireDefault(require("../AnalyticsRequest.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -10,6 +11,7 @@ describe('Analytics', () => {
   beforeEach(() => {
     analytics = new _Analytics.default({
       aggregate: new _AnalyticsAggregate.default(),
+      enrollments: new _AnalyticsEnrollments.default(),
       events: new _AnalyticsEvents.default(),
       request: _AnalyticsRequest.default
     });
@@ -23,6 +25,9 @@ describe('Analytics', () => {
   it('should contain an instance of AnalyticsAggregate', () => {
     expect(analytics.aggregate).toBeInstanceOf(_AnalyticsAggregate.default);
   });
+  it('should contain an instance of AnalyticsEnrollments', () => {
+    expect(analytics.enrollments).toBeInstanceOf(_AnalyticsEnrollments.default);
+  });
   it('should contain an instance of AnalyticsEvents', () => {
     expect(analytics.events).toBeInstanceOf(_AnalyticsEvents.default);
   });

package/build/cjs/api/analytics/__tests__/AnalyticsAggregate.spec.js

@@ -87,4 +87,33 @@ describe('Analytics.aggregate', () => {
       expect(data.height).toEqual(0);
     }));
   });
+  describe('.getOutliersData', () => {
+    beforeEach(() => {
+      aggregate = new _AnalyticsAggregate.default(new _DataEngine.default());
+      request = new _AnalyticsRequest.default();
+      request.withParameters({
+        dx: 'fbfJHSPpUQD,cYeuwXTCPkU',
+        pe: 'THIS_YEAR',
+        ou: 'at6UHUQatSo',
+        headers: 'dxname,pename,ouname,value,absdev,modifiedzscore,median,lowerbound,upperbound',
+        algorithm: 'MOD_Z_SCORE',
+        maxResults: 100,
+        threshold: 3
+      });
+      fixture = _fixtures.default.get('/api/analytics/outlierDetection');
+      dataEngineMock.query.mockReturnValue(Promise.resolve({
+        data: fixture
+      }));
+    });
+    it('should be a function', () => {
+      expect(aggregate.getOutliersData).toBeInstanceOf(Function);
+    });
+    it('should resolve a promise with data', () => aggregate.getOutliersData(request).then(data => {
+      expect(data.metaData.items).toEqual(fixture.metaData.items);
+      expect(data.metaData.dimensions).toEqual(fixture.metaData.dimensions);
+      expect(data.headers).toEqual(fixture.headers);
+      expect(data.width).toEqual(8);
+      expect(data.height).toEqual(13);
+    }));
+  });
 });

package/build/cjs/api/analytics/__tests__/AnalyticsBase.spec.js

@@ -1,7 +1,8 @@
 "use strict";
 
-var _AnalyticsBase = _interopRequireDefault(require("../AnalyticsBase.js"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+var _AnalyticsBase = _interopRequireWildcard(require("../AnalyticsBase.js"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 let base;
 describe('constructor', () => {
   beforeEach(() => {
@@ -15,4 +16,37 @@ describe('constructor', () => {
     base = new _AnalyticsBase.default(dataEngineMock);
     expect(base.dataEngine).toBe(dataEngineMock);
   });
+});
+describe('generateDimensionString', () => {
+  const tests = [{
+    input: [{
+      dimension: 'dim2',
+      items: ['item2', 'item1']
+    }, {
+      dimension: 'dim1',
+      items: ['item1']
+    }],
+    output: ['dim2:item2;item1', 'dim1:item1'],
+    outputSorted: ['dim1:item1', 'dim2:item1;item2']
+  }];
+  it('should return dimension strings correctly formatted', () => {
+    tests.forEach(_ref => {
+      let {
+        input,
+        output
+      } = _ref;
+      expect((0, _AnalyticsBase.generateDimensionStrings)(input)).toEqual(output);
+    });
+  });
+  it('should return dimension strings correctly formatted and sorted', () => {
+    tests.forEach(_ref2 => {
+      let {
+        input,
+        outputSorted
+      } = _ref2;
+      expect((0, _AnalyticsBase.generateDimensionStrings)(input, {
+        sorted: true
+      })).toEqual(outputSorted);
+    });
+  });
 });

package/build/cjs/api/analytics/utils.js

@@ -3,10 +3,29 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.customEncodeURIComponent = void 0;
+exports.formatRequestPath = exports.formatDimension = exports.customEncodeURIComponent = void 0;
 // Define our very own special list of characters that we don't want to encode in the URI
 const whitelistURI = ',&$=/;:';
 const whitelistURICodes = whitelistURI.split('').map(c => encodeURIComponent(c));
 const whitelistRegExp = new RegExp(`(?:${whitelistURICodes.join('|')})`, 'g');
 const customEncodeURIComponent = uri => encodeURIComponent(uri).replace(whitelistRegExp, decodeURIComponent);
-exports.customEncodeURIComponent = customEncodeURIComponent;
+exports.customEncodeURIComponent = customEncodeURIComponent;
+const formatRequestPath = _ref => {
+  let {
+    path,
+    program,
+    trackedEntityType
+  } = _ref;
+  return [path, program, trackedEntityType].filter(Boolean).join('/');
+};
+exports.formatRequestPath = formatRequestPath;
+const formatDimension = _ref2 => {
+  let {
+    outputType,
+    programId,
+    programStageId,
+    dimension
+  } = _ref2;
+  return [outputType === 'TRACKED_ENTITY_INSTANCE' ? programId : undefined, programStageId, dimension].filter(Boolean).join('.');
+};
+exports.formatDimension = formatDimension;

package/build/cjs/components/DataDimension/DataDimension.js

@@ -3,25 +3,40 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.useDataDimensionContext = exports.default = void 0;
 var _appRuntime = require("@dhis2/app-runtime");
 var _propTypes = _interopRequireDefault(require("prop-types"));
-var _react = _interopRequireDefault(require("react"));
+var _react = _interopRequireWildcard(require("react"));
+var _dataTypes = require("../../modules/dataTypes.js");
 var _predefinedDimensions = require("../../modules/predefinedDimensions.js");
 var _ItemSelector = _interopRequireDefault(require("./ItemSelector.js"));
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+const DataDimensionCtx = /*#__PURE__*/(0, _react.createContext)({});
 const DataDimension = _ref => {
   let {
     onSelect,
     selectedDimensions,
     displayNameProp,
+    enabledDataTypes,
     infoBoxMessage,
-    onCalculationSave
+    onCalculationSave,
+    visType
   } = _ref;
   const {
     serverVersion
   } = (0, _appRuntime.useConfig)();
-  const supportsEDI = `${serverVersion.major}.${serverVersion.minor}.${serverVersion.patch || 0}` >= '2.40.0';
+  const filterDataTypesByVersion = (0, _react.useCallback)(dataTypes => dataTypes.filter(_ref2 => {
+    let {
+      id
+    } = _ref2;
+    return (
+      // Calculations only available from 2.40
+      id !== _dataTypes.DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM || serverVersion.minor >= 40
+    );
+  }), [serverVersion.minor]);
+  const [dataTypes, setDataTypes] = (0, _react.useState)(filterDataTypesByVersion(enabledDataTypes || Object.values(_dataTypes.dataTypeMap)));
   const onSelectItems = selectedItem => onSelect({
     dimensionId: _predefinedDimensions.DIMENSION_ID_DATA,
     items: selectedItem.map(item => ({
@@ -31,7 +46,12 @@ const DataDimension = _ref => {
       expression: item.expression
     }))
   });
-  return /*#__PURE__*/_react.default.createElement(_ItemSelector.default, {
+  (0, _react.useEffect)(() => enabledDataTypes && setDataTypes(filterDataTypesByVersion(enabledDataTypes)), [enabledDataTypes, filterDataTypesByVersion]);
+  return /*#__PURE__*/_react.default.createElement(DataDimensionCtx.Provider, {
+    value: {
+      visType
+    }
+  }, /*#__PURE__*/_react.default.createElement(_ItemSelector.default, {
     selectedItems: selectedDimensions.map(item => ({
       value: item.id,
       label: item.name,
@@ -44,9 +64,9 @@ const DataDimension = _ref => {
     displayNameProp: displayNameProp,
     infoBoxMessage: infoBoxMessage,
     dataTest: 'data-dimension',
-    supportsEDI: supportsEDI,
+    dataTypes: dataTypes,
     onEDISave: onCalculationSave
-  });
+  }));
 };
 DataDimension.propTypes = {
   displayNameProp: _propTypes.default.string.isRequired,
@@ -58,12 +78,16 @@ DataDimension.propTypes = {
     type: _propTypes.default.string
   })).isRequired,
   onSelect: _propTypes.default.func.isRequired,
+  enabledDataTypes: _propTypes.default.array,
   infoBoxMessage: _propTypes.default.string,
+  visType: _propTypes.default.string,
   onCalculationSave: _propTypes.default.func
 };
 DataDimension.defaultProps = {
   selectedDimensions: [],
   onSelect: Function.prototype
 };
+const useDataDimensionContext = () => (0, _react.useContext)(DataDimensionCtx);
+exports.useDataDimensionContext = useDataDimensionContext;
 var _default = DataDimension;
 exports.default = _default;

package/build/cjs/components/DataDimension/DataTypeSelector.js

@@ -10,22 +10,43 @@ var _propTypes = _interopRequireDefault(require("prop-types"));
 var _react = _interopRequireDefault(require("react"));
 var _index = _interopRequireDefault(require("../../locales/index.js"));
 var _dataTypes = require("../../modules/dataTypes.js");
+var _visTypes = require("../../modules/visTypes.js");
+var _DataDimension = require("./DataDimension.js");
 var _DataTypeSelectorStyle = _interopRequireDefault(require("./styles/DataTypeSelector.style.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const DataTypeSelector = _ref => {
-  var _dataTypes$currentDat;
   let {
     currentDataType,
+    dataTypes,
     onChange,
-    dataTest,
-    includeCalculations
+    dataTest
   } = _ref;
+  const {
+    visType
+  } = (0, _DataDimension.useDataDimensionContext)();
+  const label = _index.default.t('Data Type');
   return /*#__PURE__*/_react.default.createElement("div", {
     className: `jsx-${_DataTypeSelectorStyle.default.__hash}` + " " + "container"
-  }, /*#__PURE__*/_react.default.createElement(_ui.SingleSelectField, {
-    label: _index.default.t('Data Type'),
+  }, dataTypes.length === 1 ? /*#__PURE__*/_react.default.createElement(_ui.SingleSelectField, {
+    label: label,
     dataTest: dataTest,
-    selected: ((_dataTypes$currentDat = _dataTypes.dataTypeMap[currentDataType]) === null || _dataTypes$currentDat === void 0 ? void 0 : _dataTypes$currentDat.id) || _dataTypes.DIMENSION_TYPE_ALL,
+    selected: dataTypes[0].id,
+    onChange: ref => onChange(ref.selected),
+    dense: true,
+    disabled: true,
+    helpText: visType ? _index.default.t('Only {{dataType}} can be used in {{visType}}', {
+      dataType: _dataTypes.dataTypeMap[dataTypes[0].id].getName(),
+      visType: (0, _visTypes.getDisplayNameByVisType)(visType)
+    }) : ''
+  }, dataTypes.map(type => /*#__PURE__*/_react.default.createElement(_ui.SingleSelectOption, {
+    value: type.id,
+    key: type.id,
+    label: type.getName(),
+    dataTest: `${dataTest}-option-${type.id}`
+  }))) : /*#__PURE__*/_react.default.createElement(_ui.SingleSelectField, {
+    label: label,
+    dataTest: dataTest,
+    selected: currentDataType || _dataTypes.DIMENSION_TYPE_ALL,
     onChange: ref => onChange(ref.selected),
     dense: true
   }, /*#__PURE__*/_react.default.createElement(_ui.SingleSelectOption, {
@@ -33,7 +54,7 @@ const DataTypeSelector = _ref => {
     key: _dataTypes.DIMENSION_TYPE_ALL,
     label: _index.default.t('All types'),
     dataTest: `${dataTest}-option-all`
-  }), Object.values(_dataTypes.dataTypeMap).filter(type => type.id !== _dataTypes.DIMENSION_TYPE_EXPRESSION_DIMENSION_ITEM || includeCalculations).map(type => /*#__PURE__*/_react.default.createElement(_ui.SingleSelectOption, {
+  }), dataTypes.map(type => /*#__PURE__*/_react.default.createElement(_ui.SingleSelectOption, {
     value: type.id,
     key: type.id,
     label: type.getName(),
@@ -46,7 +67,7 @@ DataTypeSelector.propTypes = {
   currentDataType: _propTypes.default.string.isRequired,
   onChange: _propTypes.default.func.isRequired,
   dataTest: _propTypes.default.string,
-  includeCalculations: _propTypes.default.bool
+  dataTypes: _propTypes.default.array
 };
 var _default = DataTypeSelector;
 exports.default = _default;

package/build/cjs/components/DataDimension/GroupSelector.js

@@ -34,15 +34,15 @@ const GroupSelector = _ref => {
   const [isLoading, setIsLoading] = (0, _react.useState)(true);
   const defaultGroup = (_dataTypes$dataType = _dataTypes.dataTypeMap[dataType]) === null || _dataTypes$dataType === void 0 ? void 0 : _dataTypes$dataType.defaultGroup;
   const subGroupType = (_dataTypes$dataType2 = _dataTypes.dataTypeMap[dataType]) === null || _dataTypes$dataType2 === void 0 ? void 0 : _dataTypes$dataType2.subGroup;
-  const fetchGroups = async () => {
-    setIsLoading(true);
-    const result = await (0, _dimensions.apiFetchGroups)(dataEngine, dataType, displayNameProp);
-    setGroups(result);
-    setIsLoading(false);
-  };
   (0, _react.useEffect)(() => {
+    const fetchGroups = async () => {
+      setIsLoading(true);
+      const result = await (0, _dimensions.apiFetchGroups)(dataEngine, dataType, displayNameProp);
+      setGroups(result);
+      setIsLoading(false);
+    };
     fetchGroups();
-  }, [dataType]);
+  }, [dataEngine, dataType, displayNameProp]);
   return /*#__PURE__*/_react.default.createElement("div", {
     className: `jsx-${_GroupSelectorStyle.default.__hash}` + " " + "container"
   }, /*#__PURE__*/_react.default.createElement(_style.default, {