@dhis2/analytics 22.0.0-alpha.3 → 23.0.0

package/build/cjs/__demo__/OpenFileDialog.stories.js

@@ -8,6 +8,8 @@ var _react2 = _interopRequireDefault(require("react"));
 
 var _OpenFileDialog = require("../components/OpenFileDialog/OpenFileDialog.js");
 
+var _visTypes = require("../modules/visTypes.js");
+
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const configMock = {
@@ -22,17 +24,30 @@ const user = {
 
 const onFileSelect = id => alert("Opening ".concat(id));
 
-(0, _react.storiesOf)('OpenFileDialog', module).add('List of visualizations', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
+const filterVisTypesWithGroupsAndDivider = [{
+  type: _visTypes.VIS_TYPE_GROUP_ALL
+}, {
+  type: _visTypes.VIS_TYPE_GROUP_CHARTS,
+  insertDivider: true
+}, {
+  type: _visTypes.VIS_TYPE_PIVOT_TABLE
+}, {
+  type: _visTypes.VIS_TYPE_COLUMN
+}, {
+  type: _visTypes.VIS_TYPE_BAR
+}];
+(0, _react.storiesOf)('OpenFileDialog', module).add('List of visualizations with vis type filter and divider (no default vis type)', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
   config: configMock
 }, /*#__PURE__*/_react2.default.createElement(_OpenFileDialog.OpenFileDialog, {
   type: "visualization",
+  filterVisTypes: filterVisTypesWithGroupsAndDivider,
   onClose: Function.prototype,
   onFileSelect: onFileSelect,
   onNew: Function.prototype,
   open: true,
   currentUser: user
 })));
-(0, _react.storiesOf)('OpenFileDialog', module).add('List of maps', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
+(0, _react.storiesOf)('OpenFileDialog', module).add('List of maps (no vis type filter)', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
   config: configMock
 }, /*#__PURE__*/_react2.default.createElement(_OpenFileDialog.OpenFileDialog, {
   type: "map",
@@ -42,20 +57,38 @@ const onFileSelect = id => alert("Opening ".concat(id));
   open: true,
   currentUser: user
 })));
-(0, _react.storiesOf)('OpenFileDialog', module).add('List of event reports (Line list only)', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
+const filterVisTypesWithDisabled = [{
+  type: _visTypes.VIS_TYPE_PIVOT_TABLE,
+  disabled: true
+}, {
+  type: _visTypes.VIS_TYPE_LINE_LIST
+}];
+(0, _react.storiesOf)('OpenFileDialog', module).add('List of event visualizations with vis type filter, disabled type and default vis type', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
   config: configMock
 }, /*#__PURE__*/_react2.default.createElement(_OpenFileDialog.OpenFileDialog, {
-  type: "eventReport",
+  type: "eventVisualization",
+  filterVisTypes: filterVisTypesWithDisabled,
+  defaultFilterVisType: _visTypes.VIS_TYPE_LINE_LIST,
   onClose: Function.prototype,
   onFileSelect: onFileSelect,
   onNew: Function.prototype,
   open: true,
   currentUser: user
 })));
-(0, _react.storiesOf)('OpenFileDialog', module).add('List of a supported type without custom titles/texts', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
+const filterVisTypesWithGroupDividerAndDisabled = [{
+  type: _visTypes.VIS_TYPE_GROUP_ALL
+}, {
+  type: _visTypes.VIS_TYPE_BAR,
+  insertDivider: true
+}, {
+  type: _visTypes.VIS_TYPE_COLUMN,
+  disabled: true
+}];
+(0, _react.storiesOf)('OpenFileDialog', module).add('List of visualizations with vis type filter with group type, divider and disabled option (no default vis type)', () => /*#__PURE__*/_react2.default.createElement(_appRuntime.Provider, {
   config: configMock
 }, /*#__PURE__*/_react2.default.createElement(_OpenFileDialog.OpenFileDialog, {
-  type: "eventChart",
+  type: "visualization",
+  filterVisTypes: filterVisTypesWithGroupDividerAndDisabled,
   onClose: Function.prototype,
   onFileSelect: onFileSelect,
   onNew: Function.prototype,

package/build/cjs/__fixtures__/fixtures.js

@@ -98,6 +98,7 @@ var _default = function x() {
   addFixture('/api/analytics/query', require('./json/api/analytics/query.json'));
   addFixture('/api/analytics/cluster', require('./json/api/analytics/cluster.json'));
   addFixture('/api/analytics/response', require('./json/api/analytics/response.json'));
+  addFixture('/api/analytics/enrollments', require('./json/api/analytics/enrollments.json'));
   return {
     get: getFixture,
     add: addFixture

package/build/cjs/__fixtures__/json/api/analytics/enrollments.json

@@ -0,0 +1,206 @@
+{
+  "headers": [
+    {
+      "name": "pi",
+      "column": "Enrollment",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "tei",
+      "column": "Tracked entity instance",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "enrollmentdate",
+      "column": "Enrollment date",
+      "valueType": "DATE",
+      "type": "java.util.Date",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "incidentdate",
+      "column": "Incident date",
+      "valueType": "DATE",
+      "type": "java.util.Date",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "geometry",
+      "column": "Geometry",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "longitude",
+      "column": "Longitude",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "latitude",
+      "column": "Latitude",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "ouname",
+      "column": "Organisation unit name",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "oucode",
+      "column": "Organisation unit code",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "ou",
+      "column": "Organisation unit",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "de0FEHSIoxh",
+      "column": "WHOMCH Chronic conditions",
+      "valueType": "BOOLEAN",
+      "type": "java.lang.Boolean",
+      "hidden": false,
+      "meta": true
+    },
+    {
+      "name": "sWoqcoByYmD",
+      "column": "WHOMCH Smoking",
+      "valueType": "BOOLEAN",
+      "type": "java.lang.Boolean",
+      "hidden": false,
+      "meta": true
+    }
+  ],
+  "metaData": {
+    "pager": {
+      "page": 2,
+      "total": 163,
+      "pageSize": 4,
+      "pageCount": 41
+    },
+    "items": {
+      "ImspTQPwCqd": {
+        "name": "Sierra Leone"
+      },
+      "PFDfvmGpsR3": {
+        "name": "Care at birth"
+      },
+      "bbKtnxRZKEP": {
+        "name": "Postpartum care visit"
+      },
+      "ou": {
+        "name": "Organisation unit"
+      },
+      "PUZaKR0Jh2k": {
+        "name": "Previous deliveries"
+      },
+      "edqlbukwRfQ": {
+        "name": "Antenatal care visit"
+      },
+      "WZbXY0S00lP": {
+        "name": "First antenatal care visit"
+      },
+      "sWoqcoByYmD": {
+        "name": "WHOMCH Smoking"
+      },
+      "WSGAb5XwJ3Y": {
+        "name": "WHO RMNCH Tracker"
+      },
+      "de0FEHSIoxh": {
+        "name": "WHOMCH Chronic conditions"
+      }
+    },
+    "dimensions": {
+      "pe": [],
+      "ou": ["ImspTQPwCqd"],
+      "sWoqcoByYmD": [],
+      "de0FEHSIoxh": []
+    }
+  },
+  "width": 12,
+  "rows": [
+    [
+      "A0cP533hIQv",
+      "to8G9jAprnx",
+      "2019-02-02 12:05:00.0",
+      "2019-02-02 12:05:00.0",
+      "",
+      "0.0",
+      "0.0",
+      "Tonkomba MCHP",
+      "OU_193264",
+      "xIMxph4NMP1",
+      "0",
+      "1"
+    ],
+    [
+      "ZqiUn2uXmBi",
+      "SJtv0WzoYki",
+      "2019-02-02 12:05:00.0",
+      "2019-02-02 12:05:00.0",
+      "",
+      "0.0",
+      "0.0",
+      "Mawoma MCHP",
+      "OU_254973",
+      "Srnpwq8jKbp",
+      "0",
+      "0"
+    ],
+    [
+      "lE747mUAtbz",
+      "PGzTv2A1xzn",
+      "2019-02-02 12:05:00.0",
+      "2019-02-02 12:05:00.0",
+      "",
+      "0.0",
+      "0.0",
+      "Kunsho CHP",
+      "OU_193254",
+      "tdhB1JXYBx2",
+      "",
+      "0"
+    ],
+    [
+      "nmcqu9QF8ow",
+      "pav3tGLjYuq",
+      "2019-02-03 12:05:00.0",
+      "2019-02-03 12:05:00.0",
+      "",
+      "0.0",
+      "0.0",
+      "Korbu MCHP",
+      "OU_678893",
+      "m73lWmo5BDG",
+      "",
+      "1"
+    ]
+  ],
+  "height": 4
+}

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

@@ -7,6 +7,8 @@ exports.default = void 0;
 
 var _AnalyticsAggregate = _interopRequireDefault(require("./AnalyticsAggregate.js"));
 
+var _AnalyticsEnrollments = _interopRequireDefault(require("./AnalyticsEnrollments.js"));
+
 var _AnalyticsEvents = _interopRequireDefault(require("./AnalyticsEvents.js"));
 
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
@@ -43,17 +45,20 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 class Analytics {
   /**
    * @param {!module:analytics.AnalyticsAggregate} analyticsAggregate The AnalyticsAggregate instance
+   * @param {!module:analytics.AnalyticsEnrollments} analyticsEnrollments The AnalyticsEnrollments instance
    * @param {!module:analytics.AnalyticsEvents} analyticsEvents The AnalyticsEvents instance
    * @param {!module:analytics.AnalyticsRequest} analyticsRequest The AnalyticsRequest class
    * @param {!module:analytics.AnalyticsResponse} analyticsResponse The AnalyticsResponse class
    */
   constructor({
     aggregate,
+    enrollments,
     events,
     request,
     response
   }) {
     this.aggregate = aggregate;
+    this.enrollments = enrollments;
     this.events = events;
     this.request = request;
     this.response = response;
@@ -76,6 +81,7 @@ class Analytics {
     if (!Analytics.getAnalytics.analytics) {
       Analytics.getAnalytics.analytics = new Analytics({
         aggregate: new _AnalyticsAggregate.default(dataEngine),
+        enrollments: new _AnalyticsEnrollments.default(dataEngine),
         events: new _AnalyticsEvents.default(dataEngine),
         request: _AnalyticsRequest.default,
         response: _AnalyticsResponse.default

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

@@ -0,0 +1,48 @@
+"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 enrollments class used to request analytics enrollments data from Web API.
+ *
+ * @memberof module:analytics
+ *
+ * @see https://docs.dhis2.org/en/develop/using-the-api/dhis-core-version-236/analytics.html#webapi_enrollment_analytics
+ */
+class AnalyticsEnrollments extends _AnalyticsBase.default {
+  /**
+   * @param {!AnalyticsRequest} req Request object
+   *
+   * @returns {Promise} Promise that resolves with the analytics query data from the api.
+   *
+   * @example
+   * const req = new analytics.request()
+   *  .withProgram('eBAyeGv0exc')
+   *  .addDataDimension(['Uvn6LCg7dVU','OdiHJayrsKo'])
+   *  .addPeriodDimension('LAST_4_QUARTERS')
+   *  .addOrgUnitDimension(['lc3eMKXaEfw','PMa2VCrupOd'])
+   *  .addOrgUnitFilter('O6uvpzGd5pu')
+   *  .withStartDate('2017-10-01')
+   *  .withEndDate('2017-10-31');
+   *
+   *  analytics.enrollments.getQuery(req)
+   *  .then(console.log);
+   */
+  getQuery(req) {
+    return this.fetch(req.withPath('enrollments/query'));
+  }
+
+}
+
+var _default = AnalyticsEnrollments;
+exports.default = _default;

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

@@ -0,0 +1,50 @@
+"use strict";
+
+var _fixtures = _interopRequireDefault(require("../../../__fixtures__/fixtures.js"));
+
+var _DataEngine = _interopRequireDefault(require("../__mocks__/DataEngine.js"));
+
+var _AnalyticsEnrollments = _interopRequireDefault(require("../AnalyticsEnrollments.js"));
+
+var _AnalyticsRequest = _interopRequireDefault(require("../AnalyticsRequest.js"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+describe('analytics.enrollments', () => {
+  let enrollments;
+  let request;
+  let dataEngineMock;
+  let fixture;
+  beforeEach(() => {
+    dataEngineMock = new _DataEngine.default();
+
+    _DataEngine.default.mockClear();
+
+    enrollments = new _AnalyticsEnrollments.default();
+  });
+  it('should not be allowed to be called without new', () => {
+    expect(() => (0, _AnalyticsEnrollments.default)()).toThrowErrorMatchingSnapshot();
+  });
+  it('should use the dataEngine object when it is passed', () => {
+    const dataEngineMockObject = {};
+    enrollments = new _AnalyticsEnrollments.default(dataEngineMockObject);
+    expect(enrollments.dataEngine).toBe(dataEngineMockObject);
+  });
+  describe('.getQuery()', () => {
+    beforeEach(() => {
+      enrollments = new _AnalyticsEnrollments.default(new _DataEngine.default());
+      request = new _AnalyticsRequest.default().addOrgUnitDimension('ImspTQPwCqd').addDimension('WZbXY0S00lP.de0FEHSIoxh').addDimension('WZbXY0S00lP.sWoqcoByYmD').addPeriodFilter('LAST_MONTH').withProgram('WSGAb5XwJ3Y').withStage('WZbXY0S00lP').withAsc('ENROLLMENTDATE').withOuMode('DESCENDANTS').withColumns('w75KJ2mc4zz').withPage(1).withPageSize(10);
+      fixture = _fixtures.default.get('/api/analytics/enrollments');
+      dataEngineMock.query.mockReturnValue(Promise.resolve({
+        data: fixture
+      }));
+    });
+    it('should be a function', () => {
+      expect(enrollments.getQuery).toBeInstanceOf(Function);
+    });
+    it('should resolve a promise with data', () => enrollments.getQuery(request).then(data => {
+      expect(data.width).toEqual(fixture.width);
+      expect(data.height).toEqual(fixture.height);
+    }));
+  });
+});

package/build/cjs/api/analytics/__tests__/__snapshots__/AnalyticsEnrollments.spec.js.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`analytics.enrollments should not be allowed to be called without new 1`] = `"Class constructor AnalyticsEnrollments cannot be invoked without 'new'"`;

package/build/cjs/components/CachedDataQueryProvider.js

@@ -34,20 +34,14 @@ const CachedDataQueryProvider = ({
   } = (0, _appRuntime.useDataQuery)(query);
   const {
     error,
-    loading,
-    fetching
+    loading
   } = rest;
   const data = rawData && dataTransformation ? dataTransformation(rawData) : rawData;
-  /*
-   * Render loader only when data is unavailable
-   */
 
-  if (loading || fetching) {
-    return /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement(_ui.Layer, {
+  if (loading) {
+    return /*#__PURE__*/_react.default.createElement(_ui.Layer, {
       translucent: true
-    }, /*#__PURE__*/_react.default.createElement(_ui.CenteredContent, null, /*#__PURE__*/_react.default.createElement(_ui.CircularLoader, null))), !loading && /*#__PURE__*/_react.default.createElement(CachedDataQueryCtx.Provider, {
-      value: data
-    }, children));
+    }, /*#__PURE__*/_react.default.createElement(_ui.CenteredContent, null, /*#__PURE__*/_react.default.createElement(_ui.CircularLoader, null)));
   }
 
   if (error) {

package/build/cjs/components/FileMenu/FileMenu.js

@@ -39,8 +39,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 
 const FileMenu = ({
   currentUser,
+  defaultFilterVisType,
   fileType,
   fileObject,
+  filterVisTypes,
   onNew,
   onOpen,
   onSave,
@@ -155,6 +157,8 @@ const FileMenu = ({
   }, _index.default.t('File'))), /*#__PURE__*/_react.default.createElement(_OpenFileDialog.OpenFileDialog, {
     open: currentDialog === 'open',
     type: fileType,
+    filterVisTypes: filterVisTypes,
+    defaultFilterVisType: defaultFilterVisType,
     onClose: onDialogClose,
     onFileSelect: id => {
       onOpen(id);
@@ -265,8 +269,10 @@ FileMenu.defaultProps = {
 };
 FileMenu.propTypes = {
   currentUser: _propTypes.default.object,
+  defaultFilterVisType: _propTypes.default.string,
   fileObject: _propTypes.default.object,
   fileType: _propTypes.default.oneOf(_utils.supportedFileTypes),
+  filterVisTypes: _propTypes.default.array,
   onDelete: _propTypes.default.func,
   onError: _propTypes.default.func,
   onNew: _propTypes.default.func,

package/build/cjs/components/OpenFileDialog/CustomSelectOption.js

@@ -7,6 +7,10 @@ exports.default = exports.CustomSelectOption = void 0;
 
 var _style = _interopRequireDefault(require("styled-jsx/style"));
 
+var _d2I18n = _interopRequireDefault(require("@dhis2/d2-i18n"));
+
+var _ui = require("@dhis2/ui");
+
 var _classnames = _interopRequireDefault(require("classnames"));
 
 var _propTypes = _interopRequireDefault(require("prop-types"));
@@ -17,14 +21,15 @@ var _CustomSelectOptionStyle = _interopRequireDefault(require("./styles/CustomSe
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-const CustomSelectOption = ({
+const CustomSelectOptionItem = ({
   value,
   label,
   icon,
+  insertDivider,
   onClick,
   active,
   disabled
-}) => /*#__PURE__*/_react.default.createElement("div", {
+}) => /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, /*#__PURE__*/_react.default.createElement("div", {
   onClick: e => onClick({}, e),
   "data-value": value,
   "data-label": label,
@@ -33,10 +38,18 @@ const CustomSelectOption = ({
     disabled
   }) || "")
 }, icon, /*#__PURE__*/_react.default.createElement("span", {
-  className: "jsx-".concat(_CustomSelectOptionStyle.default.__hash) + " " + "label"
+  className: "jsx-".concat(_CustomSelectOptionStyle.default.__hash) + " " + ((0, _classnames.default)({
+    label: icon
+  }) || "")
 }, label), /*#__PURE__*/_react.default.createElement(_style.default, {
   id: _CustomSelectOptionStyle.default.__hash
-}, _CustomSelectOptionStyle.default));
+}, _CustomSelectOptionStyle.default)), insertDivider && /*#__PURE__*/_react.default.createElement(_ui.MenuDivider, {
+  dense: true
+}));
+
+const CustomSelectOption = props => props.disabled ? /*#__PURE__*/_react.default.createElement(_ui.Tooltip, {
+  content: _d2I18n.default.t('Not supported by this app yet')
+}, /*#__PURE__*/_react.default.createElement(CustomSelectOptionItem, props)) : /*#__PURE__*/_react.default.createElement(CustomSelectOptionItem, props);
 
 exports.CustomSelectOption = CustomSelectOption;
 CustomSelectOption.propTypes = {
@@ -47,5 +60,6 @@ CustomSelectOption.propTypes = {
   disabled: _propTypes.default.bool,
   onClick: _propTypes.default.func
 };
+CustomSelectOptionItem.propTypes = CustomSelectOption.propTypes;
 var _default = CustomSelectOption;
 exports.default = _default;

package/build/cjs/components/OpenFileDialog/FileList.js

@@ -18,14 +18,14 @@ var _DateField = require("./DateField.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
 const FileList = ({
-  type,
   data,
-  onSelect
+  onSelect,
+  showVisTypeColumn
 }) => /*#__PURE__*/_react.default.createElement(_react.default.Fragment, null, data.map(visualization => /*#__PURE__*/_react.default.createElement(_ui.DataTableRow, {
   key: visualization.id
 }, /*#__PURE__*/_react.default.createElement(_ui.DataTableCell, {
   onClick: () => onSelect(visualization.id)
-}, visualization.displayName), type === 'visualization' && /*#__PURE__*/_react.default.createElement(_ui.DataTableCell, {
+}, visualization.displayName), showVisTypeColumn && /*#__PURE__*/_react.default.createElement(_ui.DataTableCell, {
   align: "center"
 }, /*#__PURE__*/_react.default.createElement(_VisTypeIcon.VisTypeIcon, {
   type: visualization.type,
@@ -46,8 +46,8 @@ FileList.propTypes = {
     lastUpdated: _propTypes.default.string.isRequired,
     type: _propTypes.default.string
   })).isRequired,
-  type: _propTypes.default.string.isRequired,
-  onSelect: _propTypes.default.func.isRequired
+  onSelect: _propTypes.default.func.isRequired,
+  showVisTypeColumn: _propTypes.default.bool
 };
 var _default = FileList;
 exports.default = _default;