@dhis2/analytics 26.2.0 → 26.3.0-alpha.1

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/AnalyticsBase.js

@@ -6,15 +6,21 @@ Object.defineProperty(exports, "__esModule", {
 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 {
@@ -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 {
@@ -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 {
@@ -152,6 +168,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 +211,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 = {
@@ -70,7 +72,7 @@ class AnalyticsRequestBase {
       }
       return dimension;
     });
-    const endPoint = [this.endPoint, this.path, this.program].filter(e => !!e).join('/');
+    const endPoint = [this.endPoint, this.path, this.program, this.trackedEntityType].filter(Boolean).join('/');
     return `${endPoint}.${this.format}?dimension=${encodedDimensions.join('&dimension=')}`;
   }
 

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.

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/utils.js

@@ -3,10 +3,31 @@
 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 [
+  // XXX it would be clearer to have this consistent with what is sent in the request as for EVENT/ENROLLMENT
+  outputType === 'TRACKED_ENTITY' ? programId : undefined, programStageId, dimension].filter(Boolean).join('.');
+};
+exports.formatDimension = formatDimension;

package/build/cjs/modules/layout/dimension.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.DIMENSION_PROP_REPETITION = exports.DIMENSION_PROP_PROGRAM_STAGE = exports.DIMENSION_PROP_LEGEND_SET = exports.DIMENSION_PROP_ITEMS = exports.DIMENSION_PROP_ID = exports.DIMENSION_PROP_FILTER = exports.DIMENSION_PROPS = exports.DIMENSION = void 0;
+exports.DIMENSION_PROP_REPETITION = exports.DIMENSION_PROP_PROGRAM_STAGE = exports.DIMENSION_PROP_PROGRAM = exports.DIMENSION_PROP_LEGEND_SET = exports.DIMENSION_PROP_ITEMS = exports.DIMENSION_PROP_ID = exports.DIMENSION_PROP_FILTER = exports.DIMENSION_PROPS = exports.DIMENSION = void 0;
 var _isObject = _interopRequireDefault(require("lodash/isObject"));
 var _isString = _interopRequireDefault(require("lodash/isString"));
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -43,6 +43,13 @@ const DIMENSION_PROP_LEGEND_SET = {
   isValid: prop => (0, _isString.default)(prop)
 };
 exports.DIMENSION_PROP_LEGEND_SET = DIMENSION_PROP_LEGEND_SET;
+const DIMENSION_PROP_PROGRAM = {
+  name: 'program',
+  defaultValue: {},
+  required: false,
+  isValid: prop => (0, _isObject.default)(prop)
+};
+exports.DIMENSION_PROP_PROGRAM = DIMENSION_PROP_PROGRAM;
 const DIMENSION_PROP_PROGRAM_STAGE = {
   name: 'programStage',
   defaultValue: {},
@@ -57,5 +64,5 @@ const DIMENSION_PROP_REPETITION = {
   isValid: prop => Array.isArray(prop)
 };
 exports.DIMENSION_PROP_REPETITION = DIMENSION_PROP_REPETITION;
-const DIMENSION_PROPS = [DIMENSION_PROP_ID, DIMENSION_PROP_ITEMS, DIMENSION_PROP_FILTER, DIMENSION_PROP_LEGEND_SET, DIMENSION_PROP_PROGRAM_STAGE, DIMENSION_PROP_REPETITION];
+const DIMENSION_PROPS = [DIMENSION_PROP_ID, DIMENSION_PROP_ITEMS, DIMENSION_PROP_FILTER, DIMENSION_PROP_LEGEND_SET, DIMENSION_PROP_PROGRAM, DIMENSION_PROP_PROGRAM_STAGE, DIMENSION_PROP_REPETITION];
 exports.DIMENSION_PROPS = DIMENSION_PROPS;

package/build/cjs/modules/layout/dimensionCreate.js

@@ -21,6 +21,9 @@ const dimensionCreate = function (dimensionId) {
     ...(args.legendSet && {
       [_dimension.DIMENSION_PROP_LEGEND_SET.name]: args.legendSet
     }),
+    ...(args.program && {
+      [_dimension.DIMENSION_PROP_PROGRAM.name]: args.program
+    }),
     ...(args.programStage && {
       [_dimension.DIMENSION_PROP_PROGRAM_STAGE.name]: args.programStage
     }),

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

@@ -6,12 +6,15 @@ import AnalyticsEnrollments from './AnalyticsEnrollments.js';
 import AnalyticsEvents from './AnalyticsEvents.js';
 import AnalyticsRequest from './AnalyticsRequest.js';
 import AnalyticsResponse from './AnalyticsResponse.js';
+import AnalyticsTrackedEntities from './AnalyticsTrackedEntities.js';
 
 /**
  * @description
  * 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
@@ -31,6 +34,7 @@ import AnalyticsResponse from './AnalyticsResponse.js';
 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
@@ -39,12 +43,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;
@@ -67,6 +73,7 @@ class Analytics {
     if (!Analytics.getAnalytics.analytics) {
       Analytics.getAnalytics.analytics = new Analytics({
         aggregate: new AnalyticsAggregate(dataEngine),
+        trackedEntities: new AnalyticsTrackedEntities(dataEngine),
         enrollments: new AnalyticsEnrollments(dataEngine),
         events: new AnalyticsEvents(dataEngine),
         request: AnalyticsRequest,

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

@@ -1,13 +1,19 @@
 import sortBy from 'lodash/sortBy';
 import AnalyticsRequest from './AnalyticsRequest.js';
+import { formatRequestPath } from './utils.js';
 const analyticsQuery = {
   resource: 'analytics',
   id: _ref => {
     let {
       path,
-      program
+      program,
+      trackedEntityType
     } = _ref;
-    return [path, program].filter(Boolean).join('/');
+    return formatRequestPath({
+      path,
+      program,
+      trackedEntityType
+    });
   },
   params: _ref2 => {
     let {
@@ -27,9 +33,14 @@ const analyticsDataQuery = {
   id: _ref3 => {
     let {
       path,
-      program
+      program,
+      trackedEntityType
     } = _ref3;
-    return [path, program].filter(Boolean).join('/');
+    return formatRequestPath({
+      path,
+      program,
+      trackedEntityType
+    });
   },
   params: _ref4 => {
     let {
@@ -51,9 +62,14 @@ const analyticsMetaDataQuery = {
   id: _ref5 => {
     let {
       path,
-      program
+      program,
+      trackedEntityType
     } = _ref5;
-    return [path, program].filter(Boolean).join('/');
+    return formatRequestPath({
+      path,
+      program,
+      trackedEntityType
+    });
   },
   params: _ref6 => {
     let {
@@ -145,6 +161,7 @@ class AnalyticsBase {
       variables: {
         path: req.path,
         program: req.program,
+        trackedEntityType: req.trackedEntityType,
         dimensions: generateDimensionStrings(req.dimensions),
         filters: generateDimensionStrings(req.filters),
         parameters: req.parameters,
@@ -187,6 +204,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/es/api/analytics/AnalyticsRequest.js

@@ -4,6 +4,7 @@ import AnalyticsRequestBase from './AnalyticsRequestBase.js';
 import AnalyticsRequestDimensionsMixin from './AnalyticsRequestDimensionsMixin.js';
 import AnalyticsRequestFiltersMixin from './AnalyticsRequestFiltersMixin.js';
 import AnalyticsRequestPropertiesMixin from './AnalyticsRequestPropertiesMixin.js';
+import { formatDimension } from './utils.js';
 
 /**
  * @description
@@ -41,6 +42,7 @@ class AnalyticsRequest extends AnalyticsRequestDimensionsMixin(AnalyticsRequestF
   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 || [];
@@ -51,19 +53,28 @@ class AnalyticsRequest extends AnalyticsRequestDimensionsMixin(AnalyticsRequestF
       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(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(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));
       }
     });
 
@@ -78,17 +89,29 @@ class AnalyticsRequest extends AnalyticsRequestDimensionsMixin(AnalyticsRequestF
         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(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(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/es/api/analytics/AnalyticsRequestBase.js

@@ -18,6 +18,7 @@ class AnalyticsRequestBase {
       format = 'json',
       path,
       program,
+      trackedEntityType,
       dimensions = [],
       filters = [],
       parameters = {}
@@ -26,6 +27,7 @@ class AnalyticsRequestBase {
     this.format = format.toLowerCase();
     this.path = path;
     this.program = program;
+    this.trackedEntityType = trackedEntityType;
     this.dimensions = dimensions;
     this.filters = filters;
     this.parameters = {
@@ -64,7 +66,7 @@ class AnalyticsRequestBase {
       }
       return dimension;
     });
-    const endPoint = [this.endPoint, this.path, this.program].filter(e => !!e).join('/');
+    const endPoint = [this.endPoint, this.path, this.program, this.trackedEntityType].filter(Boolean).join('/');
     return `${endPoint}.${this.format}?dimension=${encodedDimensions.join('&dimension=')}`;
   }
 

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

@@ -491,6 +491,25 @@ class extends base {
     return new AnalyticsRequest(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(this);
+  }
+
   /**
    * Sets the program for the request.
    * It appends the program id to the request's path.

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

@@ -0,0 +1,24 @@
+import AnalyticsBase from './AnalyticsBase.js';
+
+/**
+ * @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 {
+  /**
+   * @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'));
+  }
+}
+export default AnalyticsTrackedEntities;

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

@@ -2,4 +2,23 @@
 const whitelistURI = ',&$=/;:';
 const whitelistURICodes = whitelistURI.split('').map(c => encodeURIComponent(c));
 const whitelistRegExp = new RegExp(`(?:${whitelistURICodes.join('|')})`, 'g');
-export const customEncodeURIComponent = uri => encodeURIComponent(uri).replace(whitelistRegExp, decodeURIComponent);
+export const customEncodeURIComponent = uri => encodeURIComponent(uri).replace(whitelistRegExp, decodeURIComponent);
+export const formatRequestPath = _ref => {
+  let {
+    path,
+    program,
+    trackedEntityType
+  } = _ref;
+  return [path, program, trackedEntityType].filter(Boolean).join('/');
+};
+export const formatDimension = _ref2 => {
+  let {
+    outputType,
+    programId,
+    programStageId,
+    dimension
+  } = _ref2;
+  return [
+  // XXX it would be clearer to have this consistent with what is sent in the request as for EVENT/ENROLLMENT
+  outputType === 'TRACKED_ENTITY' ? programId : undefined, programStageId, dimension].filter(Boolean).join('.');
+};

package/build/es/modules/layout/dimension.js

@@ -33,6 +33,12 @@ export const DIMENSION_PROP_LEGEND_SET = {
   required: false,
   isValid: prop => isString(prop)
 };
+export const DIMENSION_PROP_PROGRAM = {
+  name: 'program',
+  defaultValue: {},
+  required: false,
+  isValid: prop => isObject(prop)
+};
 export const DIMENSION_PROP_PROGRAM_STAGE = {
   name: 'programStage',
   defaultValue: {},
@@ -45,4 +51,4 @@ export const DIMENSION_PROP_REPETITION = {
   required: false,
   isValid: prop => Array.isArray(prop)
 };
-export const DIMENSION_PROPS = [DIMENSION_PROP_ID, DIMENSION_PROP_ITEMS, DIMENSION_PROP_FILTER, DIMENSION_PROP_LEGEND_SET, DIMENSION_PROP_PROGRAM_STAGE, DIMENSION_PROP_REPETITION];
+export const DIMENSION_PROPS = [DIMENSION_PROP_ID, DIMENSION_PROP_ITEMS, DIMENSION_PROP_FILTER, DIMENSION_PROP_LEGEND_SET, DIMENSION_PROP_PROGRAM, DIMENSION_PROP_PROGRAM_STAGE, DIMENSION_PROP_REPETITION];

package/build/es/modules/layout/dimensionCreate.js

@@ -1,4 +1,4 @@
-import { DIMENSION_PROP_ID, DIMENSION_PROP_ITEMS, DIMENSION_PROP_FILTER, DIMENSION_PROP_LEGEND_SET, DIMENSION_PROP_PROGRAM_STAGE, DIMENSION_PROP_REPETITION } from './dimension.js';
+import { DIMENSION_PROP_ID, DIMENSION_PROP_ITEMS, DIMENSION_PROP_FILTER, DIMENSION_PROP_LEGEND_SET, DIMENSION_PROP_PROGRAM, DIMENSION_PROP_PROGRAM_STAGE, DIMENSION_PROP_REPETITION } from './dimension.js';
 export const dimensionCreate = function (dimensionId) {
   let itemIds = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
   let args = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
@@ -15,6 +15,9 @@ export const dimensionCreate = function (dimensionId) {
     ...(args.legendSet && {
       [DIMENSION_PROP_LEGEND_SET.name]: args.legendSet
     }),
+    ...(args.program && {
+      [DIMENSION_PROP_PROGRAM.name]: args.program
+    }),
     ...(args.programStage && {
       [DIMENSION_PROP_PROGRAM_STAGE.name]: args.programStage
     }),

package/package.json

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