@dhis2/analytics 26.4.1 → 26.6.0

package/build/cjs/__fixtures__/fixtures.js

@@ -93,6 +93,7 @@ var _default = function x() {
   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'));
+  addFixture('/api/analytics/outlierDetection', require('./json/api/analytics/outlierDetection.json'));
   return {
     get: getFixture,
     add: addFixture

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

@@ -0,0 +1,213 @@
+{
+  "headers": [
+    {
+      "name": "dxname",
+      "column": "Data name",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "ouname",
+      "column": "Organisation unit name",
+      "valueType": "TEXT",
+      "type": "java.lang.String",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "value",
+      "column": "Value",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "absdev",
+      "column": "Absolute deviation",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "modifiedzscore",
+      "column": "Modified zScore",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "median",
+      "column": "Median",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "lowerbound",
+      "column": "Lower boundary",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": false
+    },
+    {
+      "name": "upperbound",
+      "column": "Upper boundary",
+      "valueType": "NUMBER",
+      "type": "java.lang.Double",
+      "hidden": false,
+      "meta": false
+    }
+  ],
+  "metaData": {
+    "maxResults": 100,
+    "count": 13,
+    "orderBy": "mean_abs_dev",
+    "threshold": 3.0,
+    "algorithm": "MOD_Z_SCORE"
+  },
+  "rowContext": {
+
+  },
+  "rows": [
+    [
+      "ANC 2nd visit",
+      "UMC (Urban Centre) Hospital",
+      "1669.0",
+      "920.0",
+      "3.902767295597484",
+      "749.0",
+      "-290.93013894085743",
+      "1788.9301389408574"
+    ],
+    [
+      "ANC 1st visit",
+      "Charlotte CHP",
+      "49.0",
+      "39.0",
+      "7.515857142857143",
+      "10.0",
+      "-23.948490393535913",
+      "43.94849039353591"
+    ],
+    [
+      "ANC 2nd visit",
+      "Charlotte CHP",
+      "40.0",
+      "33.0",
+      "22.258499999999998",
+      "7.0",
+      "-30.86489139031037",
+      "44.86489139031037"
+    ],
+    [
+      "ANC 2nd visit",
+      "Wilberforce CHC",
+      "56.0",
+      "24.5",
+      "3.004590909090909",
+      "31.5",
+      "-1.3890179239210454",
+      "64.38901792392105"
+    ],
+    [
+      "ANC 1st visit",
+      "Deep Eye water MCHP",
+      "40.0",
+      "16.0",
+      "3.5973333333333333",
+      "24.0",
+      "4.850913859925324",
+      "43.14908614007467"
+    ],
+    [
+      "ANC 2nd visit",
+      "Lion for Lion Clinic",
+      "30.0",
+      "16.0",
+      "3.5973333333333333",
+      "14.0",
+      "-5.620896815302167",
+      "33.62089681530217"
+    ],
+    [
+      "ANC 2nd visit",
+      "Deep Eye water MCHP",
+      "33.0",
+      "14.5",
+      "3.9121",
+      "18.5",
+      "-3.4245866551686603",
+      "40.42458665516866"
+    ],
+    [
+      "ANC 2nd visit",
+      "Blessed Mokaka East Clinic",
+      "2.0",
+      "13.0",
+      "4.38425",
+      "15.0",
+      "-3.417043736713012",
+      "33.41704373671301"
+    ],
+    [
+      "ANC 2nd visit",
+      "Malambay CHP",
+      "15.0",
+      "12.0",
+      "5.396",
+      "3.0",
+      "-13.770509831248425",
+      "19.770509831248425"
+    ],
+    [
+      "ANC 2nd visit",
+      "Wellbody MCHP",
+      "20.0",
+      "10.0",
+      "3.3725",
+      "10.0",
+      "-10.999999999999996",
+      "30.999999999999996"
+    ],
+    [
+      "ANC 1st visit",
+      "Blessed Mokaka East Clinic",
+      "26.0",
+      "10.0",
+      "4.496666666666667",
+      "16.0",
+      "1.6734512181055958",
+      "30.326548781894402"
+    ],
+    [
+      "ANC 1st visit",
+      "Murray Town CHC",
+      "18.0",
+      "9.0",
+      "6.0705",
+      "9.0",
+      "-2.43571205496543",
+      "20.43571205496543"
+    ],
+    [
+      "ANC 2nd visit",
+      "Thompson Bay MCHP",
+      "11.0",
+      "6.0",
+      "4.047",
+      "5.0",
+      "-2.038266127580332",
+      "12.038266127580332"
+    ]
+  ],
+  "headerWidth": 8,
+  "width": 8,
+  "height": 13
+}

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

@@ -9,6 +9,7 @@ var _AnalyticsEnrollments = _interopRequireDefault(require("./AnalyticsEnrollmen
 var _AnalyticsEvents = _interopRequireDefault(require("./AnalyticsEvents.js"));
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
 var _AnalyticsResponse = _interopRequireDefault(require("./AnalyticsResponse.js"));
+var _AnalyticsTrackedEntities = _interopRequireDefault(require("./AnalyticsTrackedEntities.js"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * @module analytics
@@ -19,6 +20,8 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * Analytics class used to request analytics data from Web API.
  *
  * @requires analytics.AnalyticsAggregate
+ * @requires analytics.AnalyticsTrackedEntities
+ * @requires analytics.AnalyticsEnrollments
  * @requires analytics.AnalyticsEvents
  * @requires analytics.AnalyticsRequest
  * @requires analytics.AnalyticsResponse
@@ -38,6 +41,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 class Analytics {
   /**
    * @param {!module:analytics.AnalyticsAggregate} analyticsAggregate The AnalyticsAggregate instance
+   * @param {!module:analytics.AnalyticsTrackedEntities} analyticsTrackedEntities The AnalyticsTrackedEntities 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
@@ -46,12 +50,14 @@ class Analytics {
   constructor(_ref) {
     let {
       aggregate,
+      trackedEntities,
       enrollments,
       events,
       request,
       response
     } = _ref;
     this.aggregate = aggregate;
+    this.trackedEntities = trackedEntities;
     this.enrollments = enrollments;
     this.events = events;
     this.request = request;
@@ -74,6 +80,7 @@ class Analytics {
     if (!Analytics.getAnalytics.analytics) {
       Analytics.getAnalytics.analytics = new Analytics({
         aggregate: new _AnalyticsAggregate.default(dataEngine),
+        trackedEntities: new _AnalyticsTrackedEntities.default(dataEngine),
         enrollments: new _AnalyticsEnrollments.default(dataEngine),
         events: new _AnalyticsEvents.default(dataEngine),
         request: _AnalyticsRequest.default,

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

@@ -74,12 +74,38 @@ class AnalyticsAggregate extends _AnalyticsBase.default {
    *  .withStartDate('2017-10-01')
    *  .withEndDate('2017-10-31');
    *
-   *  analytics.aggregate.getDebugSql(req);
+   *  analytics.aggregate.getDebugSql(req)
    *  .then(console.log);
    */
   getDebugSql(req) {
     return this.fetch(req.withPath('debug/sql'));
   }
+
+  /**
+   * @param {!AnalyticsRequest} req Request object
+   *
+   * @returns {Promise} Promise that resolves with the SQL statement used to query the database.
+   *
+   * @example
+   * const req = new analytics.request()
+   *  .withParameters({
+   *    dx: 'fbfJHSPpUQD,cYeuwXTCPkU',
+   *    pe: 'THIS_YEAR',
+   *    ou: 'USER_ORGUNIT,USER_ORGUNIT_CHILDREN',
+   *    headers: 'dxname,pename,ouname,value,absdev,modifiedzscore,median,lowerbound,upperbound',
+   *    algorithm: 'MODIFIED_Z_SCORE',
+   *    maxResults: 100,
+   *    threshold: 3,
+        orderBy: 'value',
+        sortOrder: 'desc',
+   *  });
+   *
+   *  analytics.aggregate.getOutliersData(req)
+   *  .then(console.log);
+   */
+  getOutliersData(req) {
+    return this.fetch(req.withPath('outlierDetection'));
+  }
 }
 var _default = AnalyticsAggregate;
 exports.default = _default;

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

@@ -3,18 +3,24 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.default = void 0;
+exports.generateDimensionStrings = exports.default = void 0;
 var _sortBy = _interopRequireDefault(require("lodash/sortBy"));
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
+var _utils = require("./utils.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 const analyticsQuery = {
   resource: 'analytics',
   id: _ref => {
     let {
       path,
-      program
+      program,
+      trackedEntityType
     } = _ref;
-    return [path, program].filter(Boolean).join('/');
+    return (0, _utils.formatRequestPath)({
+      path,
+      program,
+      trackedEntityType
+    });
   },
   params: _ref2 => {
     let {
@@ -23,8 +29,8 @@ const analyticsQuery = {
       parameters
     } = _ref2;
     return {
-      dimension: dimensions,
-      filter: filters,
+      dimension: dimensions.length ? dimensions : undefined,
+      filter: filters.length ? filters : undefined,
       ...parameters
     };
   }
@@ -34,9 +40,14 @@ const analyticsDataQuery = {
   id: _ref3 => {
     let {
       path,
-      program
+      program,
+      trackedEntityType
     } = _ref3;
-    return [path, program].filter(Boolean).join('/');
+    return (0, _utils.formatRequestPath)({
+      path,
+      program,
+      trackedEntityType
+    });
   },
   params: _ref4 => {
     let {
@@ -45,8 +56,8 @@ const analyticsDataQuery = {
       parameters
     } = _ref4;
     return {
-      dimension: dimensions,
-      filter: filters,
+      dimension: dimensions.length ? dimensions : undefined,
+      filter: filters.length ? filters : undefined,
       ...parameters,
       skipMeta: true,
       skipData: false
@@ -58,9 +69,14 @@ const analyticsMetaDataQuery = {
   id: _ref5 => {
     let {
       path,
-      program
+      program,
+      trackedEntityType
     } = _ref5;
-    return [path, program].filter(Boolean).join('/');
+    return (0, _utils.formatRequestPath)({
+      path,
+      program,
+      trackedEntityType
+    });
   },
   params: _ref6 => {
     let {
@@ -69,8 +85,8 @@ const analyticsMetaDataQuery = {
       parameters
     } = _ref6;
     return {
-      dimension: dimensions,
-      filter: filters,
+      dimension: dimensions.length ? dimensions : undefined,
+      filter: filters.length ? filters : undefined,
       ...parameters,
       skipMeta: false,
       skipData: true,
@@ -110,6 +126,7 @@ const generateDimensionStrings = function () {
  * @memberof module:analytics
  * @abstract
  */
+exports.generateDimensionStrings = generateDimensionStrings;
 class AnalyticsBase {
   constructor(dataEngine) {
     this.dataEngine = dataEngine;
@@ -152,6 +169,7 @@ class AnalyticsBase {
       variables: {
         path: req.path,
         program: req.program,
+        trackedEntityType: req.trackedEntityType,
         dimensions: generateDimensionStrings(req.dimensions),
         filters: generateDimensionStrings(req.filters),
         parameters: req.parameters,
@@ -194,6 +212,7 @@ class AnalyticsBase {
       variables: {
         path: req.path,
         program: req.program,
+        trackedEntityType: req.trackedEntityType,
         dimensions: generateDimensionStrings(req.dimensions, options),
         filters: generateDimensionStrings(req.filters, options),
         parameters: req.parameters

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

@@ -10,6 +10,7 @@ var _AnalyticsRequestBase = _interopRequireDefault(require("./AnalyticsRequestBa
 var _AnalyticsRequestDimensionsMixin = _interopRequireDefault(require("./AnalyticsRequestDimensionsMixin.js"));
 var _AnalyticsRequestFiltersMixin = _interopRequireDefault(require("./AnalyticsRequestFiltersMixin.js"));
 var _AnalyticsRequestPropertiesMixin = _interopRequireDefault(require("./AnalyticsRequestPropertiesMixin.js"));
+var _utils = require("./utils.js");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 /**
  * @description
@@ -47,6 +48,7 @@ class AnalyticsRequest extends (0, _AnalyticsRequestDimensionsMixin.default)((0,
   fromVisualization(visualization) {
     let passFilterAsDimension = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     let request = this;
+    const outputType = visualization.outputType;
 
     // extract dimensions from visualization
     const columns = visualization.columns || [];
@@ -57,19 +59,28 @@ class AnalyticsRequest extends (0, _AnalyticsRequestDimensionsMixin.default)((0,
       if ((_d$legendSet = d.legendSet) !== null && _d$legendSet !== void 0 && _d$legendSet.id) {
         dimension += `-${d.legendSet.id}`;
       }
-      if ((_d$programStage = d.programStage) !== null && _d$programStage !== void 0 && _d$programStage.id) {
-        dimension = `${d.programStage.id}.${dimension}`;
-      }
       if (d.filter) {
         dimension += `:${d.filter}`;
       }
+      const programStageId = (_d$programStage = d.programStage) === null || _d$programStage === void 0 ? void 0 : _d$programStage.id;
       if ((_d$repetition = d.repetition) !== null && _d$repetition !== void 0 && (_d$repetition$indexes = _d$repetition.indexes) !== null && _d$repetition$indexes !== void 0 && _d$repetition$indexes.length) {
         d.repetition.indexes.forEach(index => {
-          request = request.addDimension(dimension.replace(/\./, `[${index}].`));
+          var _d$program;
+          request = request.addDimension((0, _utils.formatDimension)({
+            programId: (_d$program = d.program) === null || _d$program === void 0 ? void 0 : _d$program.id,
+            programStageId: `${programStageId}[${index}]`,
+            dimension,
+            outputType
+          }));
         });
       } else {
-        var _d$items;
-        request = request.addDimension(dimension, (_d$items = d.items) === null || _d$items === void 0 ? void 0 : _d$items.map(item => item.id));
+        var _d$program2, _d$items;
+        request = request.addDimension((0, _utils.formatDimension)({
+          programId: (_d$program2 = d.program) === null || _d$program2 === void 0 ? void 0 : _d$program2.id,
+          programStageId,
+          dimension,
+          outputType
+        }), (_d$items = d.items) === null || _d$items === void 0 ? void 0 : _d$items.map(item => item.id));
       }
     });
 
@@ -84,17 +95,29 @@ class AnalyticsRequest extends (0, _AnalyticsRequestDimensionsMixin.default)((0,
         request = request.addDimension(f.dimension, (_f$items = f.items) === null || _f$items === void 0 ? void 0 : _f$items.map(item => item.id));
       } else {
         var _f$programStage, _f$repetition, _f$repetition$indexes;
-        let filterString = (_f$programStage = f.programStage) !== null && _f$programStage !== void 0 && _f$programStage.id ? `${f.programStage.id}.${f.dimension}` : f.dimension;
+        let filterString = f.dimension;
         if (f.filter) {
           filterString += `:${f.filter}`;
         }
+        const programStageId = (_f$programStage = f.programStage) === null || _f$programStage === void 0 ? void 0 : _f$programStage.id;
         if ((_f$repetition = f.repetition) !== null && _f$repetition !== void 0 && (_f$repetition$indexes = _f$repetition.indexes) !== null && _f$repetition$indexes !== void 0 && _f$repetition$indexes.length) {
           f.repetition.indexes.forEach(index => {
-            request = request.addFilter(filterString.replace(/\./, `[${index}].`));
+            var _f$program;
+            request = request.addFilter((0, _utils.formatDimension)({
+              programId: (_f$program = f.program) === null || _f$program === void 0 ? void 0 : _f$program.id,
+              programStageId: `${programStageId}[${index}]`,
+              dimension: filterString,
+              outputType
+            }));
           });
         } else {
-          var _f$items2;
-          request = request.addFilter(filterString, (_f$items2 = f.items) === null || _f$items2 === void 0 ? void 0 : _f$items2.map(item => item.id));
+          var _f$program2, _f$items2;
+          request = request.addFilter((0, _utils.formatDimension)({
+            programId: (_f$program2 = f.program) === null || _f$program2 === void 0 ? void 0 : _f$program2.id,
+            programStageId,
+            dimension: filterString,
+            outputType
+          }), (_f$items2 = f.items) === null || _f$items2 === void 0 ? void 0 : _f$items2.map(item => item.id));
         }
       }
     });

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

@@ -24,6 +24,7 @@ class AnalyticsRequestBase {
       format = 'json',
       path,
       program,
+      trackedEntityType,
       dimensions = [],
       filters = [],
       parameters = {}
@@ -32,6 +33,7 @@ class AnalyticsRequestBase {
     this.format = format.toLowerCase();
     this.path = path;
     this.program = program;
+    this.trackedEntityType = trackedEntityType;
     this.dimensions = dimensions;
     this.filters = filters;
     this.parameters = {
@@ -53,7 +55,7 @@ class AnalyticsRequestBase {
   buildUrl(options) {
     // at least 1 dimension is required
     let dimensions = this.dimensions;
-    if (options && options.sorted) {
+    if (dimensions.length && options !== null && options !== void 0 && options.sorted) {
       dimensions = (0, _sortBy.default)(dimensions, 'dimension');
     }
     const encodedDimensions = dimensions.map(_ref => {
@@ -63,15 +65,19 @@ class AnalyticsRequestBase {
       } = _ref;
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(_utils.customEncodeURIComponent);
-        if (options && options.sorted) {
+        if (options !== null && options !== void 0 && options.sorted) {
           encodedItems.sort();
         }
         return `${dimension}:${encodedItems.join(';')}`;
       }
       return dimension;
     });
-    const endPoint = [this.endPoint, this.path, this.program].filter(e => !!e).join('/');
-    return `${endPoint}.${this.format}?dimension=${encodedDimensions.join('&dimension=')}`;
+    const endPoint = [this.endPoint, this.path, this.program, this.trackedEntityType].filter(Boolean).join('/');
+    let url = `${endPoint}.${this.format}`;
+    if (encodedDimensions.length) {
+      url += `?dimension=${encodedDimensions.join('&dimension=')}`;
+    }
+    return url;
   }
 
   /**
@@ -89,7 +95,7 @@ class AnalyticsRequestBase {
    */
   buildQuery(options) {
     let filters = this.filters;
-    if (options && options.sorted) {
+    if (filters.length && options !== null && options !== void 0 && options.sorted) {
       filters = (0, _sortBy.default)(filters, 'dimension');
     }
     const encodedFilters = filters.map(_ref2 => {
@@ -99,7 +105,7 @@ class AnalyticsRequestBase {
       } = _ref2;
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(_utils.customEncodeURIComponent);
-        if (options && options.sorted) {
+        if (options !== null && options !== void 0 && options.sorted) {
           encodedItems.sort();
         }
         return `${dimension}:${encodedItems.join(';')}`;

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

@@ -497,6 +497,25 @@ class extends base {
     return new _AnalyticsRequest.default(this);
   }
 
+  /**
+   * Sets the tracked entity type for the request.
+   * It appends the tracked entity type id to the request's path.
+   *
+   * @param {!String} trackedEntityType The tracked entity type id
+   *
+   * @returns {AnalyticsRequest} A new instance of the class for chaining purposes
+   *
+   * @example
+   * const req = new analytics.request()
+   *    .withTrackedEntityType('nEenWmSyUEp');
+   */
+  withTrackedEntityType(trackedEntityType) {
+    if (trackedEntityType) {
+      this.trackedEntityType = trackedEntityType;
+    }
+    return new _AnalyticsRequest.default(this);
+  }
+
   /**
    * Sets the program for the request.
    * It appends the program id to the request's path.