@dhis2/analytics 26.0.8 → 26.0.9

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

@@ -4,19 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 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"));
-
 var _AnalyticsResponse = _interopRequireDefault(require("./AnalyticsResponse.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @module analytics
  */
@@ -64,6 +57,7 @@ class Analytics {
     this.request = request;
     this.response = response;
   }
+
   /**
    * @static
    *
@@ -76,8 +70,6 @@ class Analytics {
    * @example
    * const analytics = Analytics.getAnalytics();
    */
-
-
   static getAnalytics(dataEngine) {
     if (!Analytics.getAnalytics.analytics) {
       Analytics.getAnalytics.analytics = new Analytics({
@@ -88,11 +80,8 @@ class Analytics {
         response: _AnalyticsResponse.default
       });
     }
-
     return Analytics.getAnalytics.analytics;
   }
-
 }
-
 var _default = Analytics;
 exports.default = _default;

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

@@ -4,11 +4,8 @@ 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
  *
@@ -40,6 +37,7 @@ class AnalyticsAggregate extends _AnalyticsBase.default {
   getDataValueSet(req) {
     return this.fetch(req.withPath('dataValueSet'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -58,11 +56,10 @@ class AnalyticsAggregate extends _AnalyticsBase.default {
    *  analytics.aggregate.getRawData(req)
    *  .then(console.log);
    */
-
-
   getRawData(req) {
     return this.fetch(req.withPath('rawData'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -80,13 +77,9 @@ class AnalyticsAggregate extends _AnalyticsBase.default {
    *  analytics.aggregate.getDebugSql(req);
    *  .then(console.log);
    */
-
-
   getDebugSql(req) {
     return this.fetch(req.withPath('debug/sql'));
   }
-
 }
-
 var _default = AnalyticsAggregate;
 exports.default = _default;

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

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _sortBy = _interopRequireDefault(require("lodash/sortBy"));
-
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 const analyticsQuery = {
   resource: 'analytics',
   id: _ref => {
@@ -82,32 +78,27 @@ const analyticsMetaDataQuery = {
     };
   }
 };
-
 const generateDimensionStrings = function () {
   let dimensions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
   let options = arguments.length > 1 ? arguments[1] : undefined;
-
   if (options && options.sorted) {
     dimensions = (0, _sortBy.default)(dimensions, 'dimension');
   }
-
   return dimensions.map(_ref7 => {
     let {
       dimension,
       items
     } = _ref7;
-
     if (Array.isArray(items) && items.length) {
       if (options && options.sorted) {
         items.sort();
       }
-
-      return "".concat(dimension, ":").concat(items.join(';'));
+      return `${dimension}:${items.join(';')}`;
     }
-
     return dimension;
   });
 };
+
 /**
  * @private
  * @description
@@ -119,12 +110,11 @@ const generateDimensionStrings = function () {
  * @memberof module:analytics
  * @abstract
  */
-
-
 class AnalyticsBase {
   constructor(dataEngine) {
     this.dataEngine = dataEngine;
   }
+
   /**
    * Loads the analytics data and returns them as an object from the promise.
    * Two parallel requests are made against the analytics api.
@@ -149,13 +139,12 @@ class AnalyticsBase {
    *
    * // { metaData: { ... }, rows: [ ... ], headers: [ ... ], height: 0, width: 0 }
    */
-
-
   async get(req) {
     // keep metaData and data requests separate for caching purposes
     const metaDataReq = new _AnalyticsRequest.default(req).withSkipMeta(false).withSkipData(true).withIncludeMetadataDetails(true);
-    const dataReq = new _AnalyticsRequest.default(req).withSkipData(false).withSkipMeta(true); // but run them in parallel
+    const dataReq = new _AnalyticsRequest.default(req).withSkipData(false).withSkipMeta(true);
 
+    // but run them in parallel
     const response = await this.dataEngine.query({
       data: analyticsDataQuery,
       metaData: analyticsMetaDataQuery
@@ -170,10 +159,12 @@ class AnalyticsBase {
         metaDataParams: metaDataReq.parameters
       }
     });
-    return { ...response.data,
+    return {
+      ...response.data,
       metaData: response.metaData.metaData
     };
   }
+
   /**
    * @private
    * @description
@@ -196,8 +187,6 @@ class AnalyticsBase {
    *
    * // { metaData: { ... }, rows: [], height: 0, width: 0 }
    */
-
-
   async fetch(req, options) {
     const response = await this.dataEngine.query({
       data: analyticsQuery
@@ -212,8 +201,6 @@ class AnalyticsBase {
     });
     return response.data;
   }
-
 }
-
 var _default = AnalyticsBase;
 exports.default = _default;

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

@@ -4,11 +4,8 @@ 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
  *
@@ -41,8 +38,6 @@ class AnalyticsEnrollments extends _AnalyticsBase.default {
   getQuery(req) {
     return this.fetch(req.withPath('enrollments/query'));
   }
-
 }
-
 var _default = AnalyticsEnrollments;
 exports.default = _default;

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

@@ -4,11 +4,8 @@ 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
  *
@@ -41,6 +38,7 @@ class AnalyticsEvents extends _AnalyticsBase.default {
   getAggregate(req) {
     return this.fetch(req.withPath('events/aggregate'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -59,11 +57,10 @@ class AnalyticsEvents extends _AnalyticsBase.default {
    *  analytics.events.getCount(req)
    *  .then(console.log);
    */
-
-
   getCount(req) {
     return this.fetch(req.withPath('events/count'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    * Must contain clusterSize and bbox parameters.
@@ -85,11 +82,10 @@ class AnalyticsEvents extends _AnalyticsBase.default {
    *  analytics.events.getCluster(req)
    *  .then(console.log);
    */
-
-
   getCluster(req) {
     return this.fetch(req.withPath('events/cluster'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -108,13 +104,9 @@ class AnalyticsEvents extends _AnalyticsBase.default {
    *  analytics.events.getQuery(req)
    *  .then(console.log);
    */
-
-
   getQuery(req) {
     return this.fetch(req.withPath('events/query'));
   }
-
 }
-
 var _default = AnalyticsEvents;
 exports.default = _default;

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

@@ -4,21 +4,13 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _hash = require("../../modules/hash.js");
-
 var _predefinedDimensions = require("../../modules/predefinedDimensions.js");
-
 var _AnalyticsRequestBase = _interopRequireDefault(require("./AnalyticsRequestBase.js"));
-
 var _AnalyticsRequestDimensionsMixin = _interopRequireDefault(require("./AnalyticsRequestDimensionsMixin.js"));
-
 var _AnalyticsRequestFiltersMixin = _interopRequireDefault(require("./AnalyticsRequestFiltersMixin.js"));
-
 var _AnalyticsRequestPropertiesMixin = _interopRequireDefault(require("./AnalyticsRequestPropertiesMixin.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @description
  * Class for constructing a request object to use for communicating with the analytics API endpoint.
@@ -54,79 +46,68 @@ class AnalyticsRequest extends (0, _AnalyticsRequestDimensionsMixin.default)((0,
    */
   fromVisualization(visualization) {
     let passFilterAsDimension = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
-    let request = this; // extract dimensions from visualization
+    let request = this;
 
+    // extract dimensions from visualization
     const columns = visualization.columns || [];
     const rows = visualization.rows || [];
     columns.concat(rows).forEach(d => {
       var _d$legendSet, _d$programStage, _d$repetition, _d$repetition$indexes;
-
       let dimension = d.dimension;
-
       if ((_d$legendSet = d.legendSet) !== null && _d$legendSet !== void 0 && _d$legendSet.id) {
-        dimension += "-".concat(d.legendSet.id);
+        dimension += `-${d.legendSet.id}`;
       }
-
       if ((_d$programStage = d.programStage) !== null && _d$programStage !== void 0 && _d$programStage.id) {
-        dimension = "".concat(d.programStage.id, ".").concat(dimension);
+        dimension = `${d.programStage.id}.${dimension}`;
       }
-
       if (d.filter) {
-        dimension += ":".concat(d.filter);
+        dimension += `:${d.filter}`;
       }
-
       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(/\./, "[".concat(index, "].")));
+          request = request.addDimension(dimension.replace(/\./, `[${index}].`));
         });
       } 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));
       }
-    }); // extract filters from visualization
+    });
 
-    const filters = visualization.filters || []; // only pass dx/pe/ou as dimension
+    // extract filters from visualization
+    const filters = visualization.filters || [];
 
+    // only pass dx/pe/ou as dimension
     const fixedIds = Object.keys((0, _predefinedDimensions.getFixedDimensions)());
     filters.forEach(f => {
       if (passFilterAsDimension && fixedIds.includes(f.dimension)) {
         var _f$items;
-
         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 ? "".concat(f.programStage.id, ".").concat(f.dimension) : f.dimension;
-
+        let filterString = (_f$programStage = f.programStage) !== null && _f$programStage !== void 0 && _f$programStage.id ? `${f.programStage.id}.${f.dimension}` : f.dimension;
         if (f.filter) {
-          filterString += ":".concat(f.filter);
+          filterString += `:${f.filter}`;
         }
-
         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(/\./, "[".concat(index, "].")));
+            request = request.addFilter(filterString.replace(/\./, `[${index}].`));
           });
         } 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));
         }
       }
-    }); // add cache param for expression dimension items
+    });
 
+    // add cache param for expression dimension items
     const expressionHash = (0, _hash.getExpressionHashFromVisualization)(visualization);
-
     if (expressionHash) {
       request.withParameters({
         edi_cache: expressionHash
       });
     }
-
     return request;
   }
-
 }
-
 var _default = AnalyticsRequest;
 exports.default = _default;

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

@@ -4,13 +4,9 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _sortBy = _interopRequireDefault(require("lodash/sortBy"));
-
 var _utils = require("./utils.js");
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @private
  * @description
@@ -38,9 +34,11 @@ class AnalyticsRequestBase {
     this.program = program;
     this.dimensions = dimensions;
     this.filters = filters;
-    this.parameters = { ...parameters
+    this.parameters = {
+      ...parameters
     };
   }
+
   /**
    * @private
    * @description
@@ -52,37 +50,30 @@ class AnalyticsRequestBase {
    *
    * @returns {String} URL URL for the request with dimensions included
    */
-
-
   buildUrl(options) {
     // at least 1 dimension is required
     let dimensions = this.dimensions;
-
     if (options && options.sorted) {
       dimensions = (0, _sortBy.default)(dimensions, 'dimension');
     }
-
     const encodedDimensions = dimensions.map(_ref => {
       let {
         dimension,
         items
       } = _ref;
-
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(_utils.customEncodeURIComponent);
-
         if (options && options.sorted) {
           encodedItems.sort();
         }
-
-        return "".concat(dimension, ":").concat(encodedItems.join(';'));
+        return `${dimension}:${encodedItems.join(';')}`;
       }
-
       return dimension;
     });
     const endPoint = [this.endPoint, this.path, this.program].filter(e => !!e).join('/');
-    return "".concat(endPoint, ".").concat(this.format, "?dimension=").concat(encodedDimensions.join('&dimension='));
+    return `${endPoint}.${this.format}?dimension=${encodedDimensions.join('&dimension=')}`;
   }
+
   /**
    * @private
    * @description
@@ -96,42 +87,30 @@ class AnalyticsRequestBase {
    *
    * @returns {Object} Query parameters
    */
-
-
   buildQuery(options) {
     let filters = this.filters;
-
     if (options && options.sorted) {
       filters = (0, _sortBy.default)(filters, 'dimension');
     }
-
     const encodedFilters = filters.map(_ref2 => {
       let {
         dimension,
         items
       } = _ref2;
-
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(_utils.customEncodeURIComponent);
-
         if (options && options.sorted) {
           encodedItems.sort();
         }
-
-        return "".concat(dimension, ":").concat(encodedItems.join(';'));
+        return `${dimension}:${encodedItems.join(';')}`;
       }
-
       return dimension;
     });
-
     if (filters.length) {
       this.parameters.filter = encodedFilters;
     }
-
     return this.parameters;
   }
-
 }
-
 var _default = AnalyticsRequestBase;
 exports.default = _default;

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

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @private
  * @description
@@ -44,6 +41,7 @@ class extends base {
   addDataDimension(items) {
     return this.addDimension('dx', items);
   }
+
   /**
    * Adds/updates the pe dimension to use in the request.
    *
@@ -58,11 +56,10 @@ class extends base {
    *
    * // dimension=pe:201701;201702;LAST_4_QUARTERS
    */
-
-
   addPeriodDimension(items) {
     return this.addDimension('pe', items);
   }
+
   /**
    * Adds/updates the ou dimension to use in the request.
    *
@@ -77,11 +74,10 @@ class extends base {
    *
    * // dimension=ou:O6uvpzGd5pu;lc3eMKXaEfw;OU_GROUP-w0gFTTmsUcF
    */
-
-
   addOrgUnitDimension(items) {
     return this.addDimension('ou', items);
   }
+
   /**
    * Adds a new dimension or updates an existing one to use in the request.
    *
@@ -97,8 +93,6 @@ class extends base {
    *
    * // dimension=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&dimension=qrur9Dvnyt5-Yf6UHoPkdS6
    */
-
-
   addDimension(dimension, items) {
     let dimensionIndex = 0;
     const existingDimension = this.dimensions.find((item, index) => {
@@ -106,22 +100,18 @@ class extends base {
         dimensionIndex = index;
         return item;
       }
-
       return false;
     });
     let updatedItems = [];
     let existingItems = [];
-
     if (existingDimension) {
       existingItems = existingDimension.items || [];
     }
-
     if (typeof items === 'string') {
       updatedItems = [...new Set([...existingItems, items])];
     } else if (Array.isArray(items)) {
       updatedItems = [...new Set([...existingItems, ...items])];
     }
-
     if (existingDimension) {
       this.dimensions.splice(dimensionIndex, 1, {
         dimension,
@@ -137,11 +127,8 @@ class extends base {
         })
       });
     }
-
     return new _AnalyticsRequest.default(this);
   }
-
 };
-
 var _default = AnalyticsRequestDimensionsMixin;
 exports.default = _default;

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

@@ -4,11 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-
 var _AnalyticsRequest = _interopRequireDefault(require("./AnalyticsRequest.js"));
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
 /**
  * @private
  * @description
@@ -44,6 +41,7 @@ class extends base {
   addDataFilter(items) {
     return this.addFilter('dx', items);
   }
+
   /**
    * Adds/updates the pe dimension filter to use in the request.
    *
@@ -58,11 +56,10 @@ class extends base {
    *
    * // filter=pe:201701;201702;LAST_4_QUARTERS
    */
-
-
   addPeriodFilter(items) {
     return this.addFilter('pe', items);
   }
+
   /**
    * Adds/updates the ou dimension filter to use in the request.
    *
@@ -77,11 +74,10 @@ class extends base {
    *
    * // filter=ou:O6uvpzGd5pu;lc3eMKXaEfw;OU_GROUP-w0gFTTmsUcF
    */
-
-
   addOrgUnitFilter(items) {
     return this.addFilter('ou', items);
   }
+
   /**
    * Adds a filter to the request.
    *
@@ -97,8 +93,6 @@ class extends base {
    *
    * // filter=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&filter=qrur9Dvnyt5-Yf6UHoPkdS6
    */
-
-
   addFilter(dimension, items) {
     let filterIndex = 0;
     const existingFilter = this.filters.find((item, index) => {
@@ -106,22 +100,18 @@ class extends base {
         filterIndex = index;
         return item;
       }
-
       return false;
     });
     let updatedItems = [];
     let existingItems = [];
-
     if (existingFilter) {
       existingItems = existingFilter.items || [];
     }
-
     if (typeof items === 'string') {
       updatedItems = [...new Set([...existingItems, items])];
     } else if (Array.isArray(items)) {
       updatedItems = [...new Set([...existingItems, ...items])];
     }
-
     if (existingFilter) {
       this.filters.splice(filterIndex, 1, {
         dimension,
@@ -133,11 +123,8 @@ class extends base {
         items: updatedItems
       });
     }
-
     return new _AnalyticsRequest.default(this);
   }
-
 };
-
 var _default = AnalyticsRequestFiltersMixin;
 exports.default = _default;