@dhis2/analytics 26.0.8 → 26.0.10

package/build/es/__fixtures__/fixtures.js

@@ -1,15 +1,12 @@
 export default (function x() {
   const fixtures = {};
-
   function getFixture(fixtureName) {
     if (fixtures && fixtures[fixtureName]) {
       // Make sure we return a new object
       return JSON.parse(JSON.stringify(fixtures[fixtureName]));
     }
-
     throw new Error(['Fixture', fixtureName, 'does not exist'].join(' '));
   }
-
   function addFixture(fixtureName, fixtureData) {
     if (fixtureName && fixtureData && typeof fixtureName === 'string') {
       fixtures[fixtureName] = fixtureData;
@@ -81,8 +78,6 @@ export default (function x() {
       require('./json/api/legendSets/k1JHPfXsJND.json')
   )
   */
-
-
   addFixture('/chartAllFields', require('./json/chartAllFields.json'));
   addFixture('/api/analytics/dataValueSet', require('./json/api/analytics/dataValueSet.json'));
   addFixture('/api/analytics/rawData', require('./json/api/analytics/rawData.json'));

package/build/es/api/__tests__/dimensions.spec.js

@@ -1,7 +1,6 @@
 import { dimensionsQuery, apiFetchDimensions } from '../dimensions.js';
 let mockDataEngine;
 let mockQueryFn;
-
 const asyncCheckMatches = (_ref, done) => {
   let [queryDefinition, queryVariables, callCount = 1, callIndex = 0] = _ref;
   setTimeout(() => {
@@ -11,7 +10,6 @@ const asyncCheckMatches = (_ref, done) => {
     done();
   });
 };
-
 describe('api: dimensions', () => {
   beforeEach(() => {
     mockQueryFn = jest.fn().mockResolvedValue({

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

@@ -6,6 +6,7 @@ import AnalyticsEnrollments from './AnalyticsEnrollments.js';
 import AnalyticsEvents from './AnalyticsEvents.js';
 import AnalyticsRequest from './AnalyticsRequest.js';
 import AnalyticsResponse from './AnalyticsResponse.js';
+
 /**
  * @description
  * Analytics class used to request analytics data from Web API.
@@ -27,7 +28,6 @@ import AnalyticsResponse from './AnalyticsResponse.js';
  * @see {@link https://docs.dhis2.org/master/en/developer/html/webapi_analytics.html} Analytics API documentation
  * @see {@link https://docs.dhis2.org/master/en/developer/html/webapi_event_analytics.html} Event analytics API documentation
  */
-
 class Analytics {
   /**
    * @param {!module:analytics.AnalyticsAggregate} analyticsAggregate The AnalyticsAggregate instance
@@ -50,6 +50,7 @@ class Analytics {
     this.request = request;
     this.response = response;
   }
+
   /**
    * @static
    *
@@ -62,8 +63,6 @@ class Analytics {
    * @example
    * const analytics = Analytics.getAnalytics();
    */
-
-
   static getAnalytics(dataEngine) {
     if (!Analytics.getAnalytics.analytics) {
       Analytics.getAnalytics.analytics = new Analytics({
@@ -74,10 +73,7 @@ class Analytics {
         response: AnalyticsResponse
       });
     }
-
     return Analytics.getAnalytics.analytics;
   }
-
 }
-
 export default Analytics;

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

@@ -1,4 +1,5 @@
 import AnalyticsBase from './AnalyticsBase.js';
+
 /**
  * @extends module:analytics.AnalyticsBase
  *
@@ -9,7 +10,6 @@ import AnalyticsBase from './AnalyticsBase.js';
  *
  * @see https://docs.dhis2.org/master/en/developer/html/webapi_analytics.html
  */
-
 class AnalyticsAggregate extends AnalyticsBase {
   /**
    * @param {!AnalyticsRequest} req Request object
@@ -31,6 +31,7 @@ class AnalyticsAggregate extends AnalyticsBase {
   getDataValueSet(req) {
     return this.fetch(req.withPath('dataValueSet'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -49,11 +50,10 @@ class AnalyticsAggregate extends AnalyticsBase {
    *  analytics.aggregate.getRawData(req)
    *  .then(console.log);
    */
-
-
   getRawData(req) {
     return this.fetch(req.withPath('rawData'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -71,12 +71,8 @@ class AnalyticsAggregate extends AnalyticsBase {
    *  analytics.aggregate.getDebugSql(req);
    *  .then(console.log);
    */
-
-
   getDebugSql(req) {
     return this.fetch(req.withPath('debug/sql'));
   }
-
 }
-
 export default AnalyticsAggregate;

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

@@ -71,32 +71,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 = sortBy(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
@@ -108,12 +103,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.
@@ -138,13 +132,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(req).withSkipMeta(false).withSkipData(true).withIncludeMetadataDetails(true);
-    const dataReq = new AnalyticsRequest(req).withSkipData(false).withSkipMeta(true); // but run them in parallel
+    const dataReq = new AnalyticsRequest(req).withSkipData(false).withSkipMeta(true);
 
+    // but run them in parallel
     const response = await this.dataEngine.query({
       data: analyticsDataQuery,
       metaData: analyticsMetaDataQuery
@@ -159,10 +152,12 @@ class AnalyticsBase {
         metaDataParams: metaDataReq.parameters
       }
     });
-    return { ...response.data,
+    return {
+      ...response.data,
       metaData: response.metaData.metaData
     };
   }
+
   /**
    * @private
    * @description
@@ -185,8 +180,6 @@ class AnalyticsBase {
    *
    * // { metaData: { ... }, rows: [], height: 0, width: 0 }
    */
-
-
   async fetch(req, options) {
     const response = await this.dataEngine.query({
       data: analyticsQuery
@@ -201,7 +194,5 @@ class AnalyticsBase {
     });
     return response.data;
   }
-
 }
-
 export default AnalyticsBase;

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

@@ -1,4 +1,5 @@
 import AnalyticsBase from './AnalyticsBase.js';
+
 /**
  * @extends module:analytics.AnalyticsBase
  *
@@ -9,7 +10,6 @@ import AnalyticsBase from './AnalyticsBase.js';
  *
  * @see https://docs.dhis2.org/en/develop/using-the-api/dhis-core-version-236/analytics.html#webapi_enrollment_analytics
  */
-
 class AnalyticsEnrollments extends AnalyticsBase {
   /**
    * @param {!AnalyticsRequest} req Request object
@@ -32,7 +32,5 @@ class AnalyticsEnrollments extends AnalyticsBase {
   getQuery(req) {
     return this.fetch(req.withPath('enrollments/query'));
   }
-
 }
-
 export default AnalyticsEnrollments;

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

@@ -1,4 +1,5 @@
 import AnalyticsBase from './AnalyticsBase.js';
+
 /**
  * @extends module:analytics.AnalyticsBase
  *
@@ -9,7 +10,6 @@ import AnalyticsBase from './AnalyticsBase.js';
  *
  * @see https://docs.dhis2.org/master/en/developer/html/webapi_event_analytics.html
  */
-
 class AnalyticsEvents extends AnalyticsBase {
   /**
    * @param {!AnalyticsRequest} req Request object
@@ -32,6 +32,7 @@ class AnalyticsEvents extends AnalyticsBase {
   getAggregate(req) {
     return this.fetch(req.withPath('events/aggregate'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -50,11 +51,10 @@ class AnalyticsEvents extends AnalyticsBase {
    *  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.
@@ -76,11 +76,10 @@ class AnalyticsEvents extends AnalyticsBase {
    *  analytics.events.getCluster(req)
    *  .then(console.log);
    */
-
-
   getCluster(req) {
     return this.fetch(req.withPath('events/cluster'));
   }
+
   /**
    * @param {!AnalyticsRequest} req Request object
    *
@@ -99,12 +98,8 @@ class AnalyticsEvents extends AnalyticsBase {
    *  analytics.events.getQuery(req)
    *  .then(console.log);
    */
-
-
   getQuery(req) {
     return this.fetch(req.withPath('events/query'));
   }
-
 }
-
 export default AnalyticsEvents;

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';
+
 /**
  * @description
  * Class for constructing a request object to use for communicating with the analytics API endpoint.
@@ -17,7 +18,6 @@ import AnalyticsRequestPropertiesMixin from './AnalyticsRequestPropertiesMixin.j
  * @extends module:analytics.AnalyticsRequestPropertiesMixin
  * @extends module:analytics.AnalyticsRequestBase
  */
-
 class AnalyticsRequest extends AnalyticsRequestDimensionsMixin(AnalyticsRequestFiltersMixin(AnalyticsRequestPropertiesMixin(AnalyticsRequestBase))) {
   /**
    * Extracts dimensions and filters from an analytic object visualization and add them to the request
@@ -40,78 +40,67 @@ class AnalyticsRequest extends AnalyticsRequestDimensionsMixin(AnalyticsRequestF
    */
   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(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 = getExpressionHashFromVisualization(visualization);
-
     if (expressionHash) {
       request.withParameters({
         edi_cache: expressionHash
       });
     }
-
     return request;
   }
-
 }
-
 export default AnalyticsRequest;

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

@@ -1,5 +1,6 @@
 import sortBy from 'lodash/sortBy';
 import { customEncodeURIComponent } from './utils.js';
+
 /**
  * @private
  * @description
@@ -10,7 +11,6 @@ import { customEncodeURIComponent } from './utils.js';
  * @memberof module:analytics
  * @abstract
  */
-
 class AnalyticsRequestBase {
   constructor() {
     let {
@@ -28,9 +28,11 @@ class AnalyticsRequestBase {
     this.program = program;
     this.dimensions = dimensions;
     this.filters = filters;
-    this.parameters = { ...parameters
+    this.parameters = {
+      ...parameters
     };
   }
+
   /**
    * @private
    * @description
@@ -42,37 +44,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 = sortBy(dimensions, 'dimension');
     }
-
     const encodedDimensions = dimensions.map(_ref => {
       let {
         dimension,
         items
       } = _ref;
-
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(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
@@ -86,41 +81,29 @@ class AnalyticsRequestBase {
    *
    * @returns {Object} Query parameters
    */
-
-
   buildQuery(options) {
     let filters = this.filters;
-
     if (options && options.sorted) {
       filters = sortBy(filters, 'dimension');
     }
-
     const encodedFilters = filters.map(_ref2 => {
       let {
         dimension,
         items
       } = _ref2;
-
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(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;
   }
-
 }
-
 export default AnalyticsRequestBase;

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

@@ -1,4 +1,5 @@
 import AnalyticsRequest from './AnalyticsRequest.js';
+
 /**
  * @private
  * @description
@@ -7,7 +8,6 @@ import AnalyticsRequest from './AnalyticsRequest.js';
  * @param {*} base The base class to mix onto
  * @return {module:analytics.AnalyticsRequestDimensionsMixin} The mixin class
  */
-
 const AnalyticsRequestDimensionsMixin = base =>
 /**
  * @private
@@ -35,6 +35,7 @@ class extends base {
   addDataDimension(items) {
     return this.addDimension('dx', items);
   }
+
   /**
    * Adds/updates the pe dimension to use in the request.
    *
@@ -49,11 +50,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.
    *
@@ -68,11 +68,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.
    *
@@ -88,8 +87,6 @@ class extends base {
    *
    * // dimension=Bpx0589u8y0:oRVt7g429ZO;MAs88nJc9nL&dimension=qrur9Dvnyt5-Yf6UHoPkdS6
    */
-
-
   addDimension(dimension, items) {
     let dimensionIndex = 0;
     const existingDimension = this.dimensions.find((item, index) => {
@@ -97,22 +94,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,
@@ -128,10 +121,7 @@ class extends base {
         })
       });
     }
-
     return new AnalyticsRequest(this);
   }
-
 };
-
 export default AnalyticsRequestDimensionsMixin;