@dhis2/analytics 28.0.3 → 28.0.5

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

@@ -1,8 +1,7 @@
 import { dimensionsQuery, apiFetchDimensions } from '../dimensions.js';
 let mockDataEngine;
 let mockQueryFn;
-const asyncCheckMatches = (_ref, done) => {
-  let [queryDefinition, queryVariables, callCount = 1, callIndex = 0] = _ref;
+const asyncCheckMatches = ([queryDefinition, queryVariables, callCount = 1, callIndex = 0], done) => {
   setTimeout(() => {
     expect(mockQueryFn).toHaveBeenCalledTimes(callCount);
     expect(mockQueryFn.mock.calls[callIndex][0]).toEqual(queryDefinition);

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

@@ -40,15 +40,14 @@ class Analytics {
    * @param {!module:analytics.AnalyticsRequest} analyticsRequest The AnalyticsRequest class
    * @param {!module:analytics.AnalyticsResponse} analyticsResponse The AnalyticsResponse class
    */
-  constructor(_ref) {
-    let {
-      aggregate,
-      trackedEntities,
-      enrollments,
-      events,
-      request,
-      response
-    } = _ref;
+  constructor({
+    aggregate,
+    trackedEntities,
+    enrollments,
+    events,
+    request,
+    response
+  }) {
     this.aggregate = aggregate;
     this.trackedEntities = trackedEntities;
     this.enrollments = enrollments;

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

@@ -3,51 +3,41 @@ import AnalyticsRequest from './AnalyticsRequest.js';
 import { formatRequestPath } from './utils.js';
 const analyticsQuery = {
   resource: 'analytics',
-  id: _ref => {
-    let {
-      path,
-      program,
-      trackedEntityType
-    } = _ref;
-    return formatRequestPath({
-      path,
-      program,
-      trackedEntityType
-    });
-  },
-  params: _ref2 => {
-    let {
-      dimensions,
-      filters,
-      parameters
-    } = _ref2;
-    return {
-      dimension: dimensions.length ? dimensions : undefined,
-      filter: filters.length ? filters : undefined,
-      ...parameters
-    };
-  }
+  id: ({
+    path,
+    program,
+    trackedEntityType
+  }) => formatRequestPath({
+    path,
+    program,
+    trackedEntityType
+  }),
+  params: ({
+    dimensions,
+    filters,
+    parameters
+  }) => ({
+    dimension: dimensions.length ? dimensions : undefined,
+    filter: filters.length ? filters : undefined,
+    ...parameters
+  })
 };
 const analyticsDataQuery = {
   resource: 'analytics',
-  id: _ref3 => {
-    let {
-      path,
-      program,
-      trackedEntityType
-    } = _ref3;
-    return formatRequestPath({
-      path,
-      program,
-      trackedEntityType
-    });
-  },
-  params: _ref4 => {
-    let {
-      dimensions,
-      filters,
-      parameters
-    } = _ref4;
+  id: ({
+    path,
+    program,
+    trackedEntityType
+  }) => formatRequestPath({
+    path,
+    program,
+    trackedEntityType
+  }),
+  params: ({
+    dimensions,
+    filters,
+    parameters
+  }) => {
     return {
       dimension: dimensions.length ? generateDimensionStrings(dimensions, {
         sorted: true
@@ -63,43 +53,34 @@ const analyticsDataQuery = {
 };
 const analyticsMetaDataQuery = {
   resource: 'analytics',
-  id: _ref5 => {
-    let {
-      path,
-      program,
-      trackedEntityType
-    } = _ref5;
-    return formatRequestPath({
-      path,
-      program,
-      trackedEntityType
-    });
-  },
-  params: _ref6 => {
-    let {
-      dimensions,
-      filters,
-      parameters
-    } = _ref6;
-    return {
-      dimension: dimensions.length ? generateDimensionStrings(dimensions) : undefined,
-      filter: filters.length ? generateDimensionStrings(filters) : undefined,
-      ...parameters,
-      skipMeta: false,
-      skipData: true,
-      includeMetadataDetails: true
-    };
-  }
+  id: ({
+    path,
+    program,
+    trackedEntityType
+  }) => formatRequestPath({
+    path,
+    program,
+    trackedEntityType
+  }),
+  params: ({
+    dimensions,
+    filters,
+    parameters
+  }) => ({
+    dimension: dimensions.length ? generateDimensionStrings(dimensions) : undefined,
+    filter: filters.length ? generateDimensionStrings(filters) : undefined,
+    ...parameters,
+    skipMeta: false,
+    skipData: true,
+    includeMetadataDetails: true
+  })
 };
-export const generateDimensionStrings = function () {
-  let dimensions = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
-  let options = arguments.length > 1 ? arguments[1] : undefined;
+export const generateDimensionStrings = (dimensions = [], options) => {
   const sortedDimensions = sortBy(dimensions, 'dimension');
-  return sortedDimensions.map(_ref7 => {
-    let {
-      dimension,
-      items
-    } = _ref7;
+  return sortedDimensions.map(({
+    dimension,
+    items
+  }) => {
     if (Array.isArray(items) && items.length) {
       if (options && options.sorted) {
         items = items.slice().sort();

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

@@ -39,8 +39,7 @@ class AnalyticsRequest extends AnalyticsRequestDimensionsMixin(AnalyticsRequestF
    *
    * // dimension=pe:last_12_month&dimension=dx:fbfjhsppuqd;cyeuwxtcpku;jtf34knzhzp;hfdmmspbglg&dimension=ou:imsptqpwcqd
    */
-  fromVisualization(visualization) {
-    let passFilterAsDimension = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
+  fromVisualization(visualization, passFilterAsDimension = false) {
     let request = this;
     const outputType = visualization.outputType;
 

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

@@ -12,17 +12,16 @@ import { customEncodeURIComponent } from './utils.js';
  * @abstract
  */
 class AnalyticsRequestBase {
-  constructor() {
-    let {
-      endPoint = 'analytics',
-      format = 'json',
-      path,
-      program,
-      trackedEntityType,
-      dimensions = [],
-      filters = [],
-      parameters = {}
-    } = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  constructor({
+    endPoint = 'analytics',
+    format = 'json',
+    path,
+    program,
+    trackedEntityType,
+    dimensions = [],
+    filters = [],
+    parameters = {}
+  } = {}) {
     this.endPoint = endPoint;
     this.format = format.toLowerCase();
     this.path = path;
@@ -52,11 +51,10 @@ class AnalyticsRequestBase {
     if (dimensions.length && options !== null && options !== void 0 && options.sorted) {
       dimensions = sortBy(dimensions, 'dimension');
     }
-    const encodedDimensions = dimensions.map(_ref => {
-      let {
-        dimension,
-        items
-      } = _ref;
+    const encodedDimensions = dimensions.map(({
+      dimension,
+      items
+    }) => {
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(customEncodeURIComponent);
         if (options !== null && options !== void 0 && options.sorted) {
@@ -92,11 +90,10 @@ class AnalyticsRequestBase {
     if (filters.length && options !== null && options !== void 0 && options.sorted) {
       filters = sortBy(filters, 'dimension');
     }
-    const encodedFilters = filters.map(_ref2 => {
-      let {
-        dimension,
-        items
-      } = _ref2;
+    const encodedFilters = filters.map(({
+      dimension,
+      items
+    }) => {
       if (Array.isArray(items) && items.length) {
         const encodedItems = items.map(customEncodeURIComponent);
         if (options !== null && options !== void 0 && options.sorted) {

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

@@ -71,8 +71,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withFormat('xml');
    */
-  withFormat() {
-    let format = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'json';
+  withFormat(format = 'json') {
     this.format = format;
     return new AnalyticsRequest(this);
   }
@@ -147,8 +146,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withSkipMeta();
    */
-  withSkipMeta() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withSkipMeta(flag = true) {
     this.parameters.skipMeta = flag;
     return new AnalyticsRequest(this);
   }
@@ -164,8 +162,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withSkipData();
    */
-  withSkipData() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withSkipData(flag = true) {
     this.parameters.skipData = flag;
     return new AnalyticsRequest(this);
   }
@@ -181,8 +178,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withHierarchyMeta();
    */
-  withHierarchyMeta() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withHierarchyMeta(flag = true) {
     this.parameters.hierarchyMeta = flag;
     return new AnalyticsRequest(this);
   }
@@ -198,8 +194,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withIgnoreLimit();
    */
-  withIgnoreLimit() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withIgnoreLimit(flag = true) {
     this.parameters.ignoreLimit = flag;
     return new AnalyticsRequest(this);
   }
@@ -215,8 +210,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withTableLayout();
    */
-  withTableLayout() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withTableLayout(flag = true) {
     this.parameters.tableLayout = flag;
     return new AnalyticsRequest(this);
   }
@@ -232,8 +226,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withHideEmptyRows();
    */
-  withHideEmptyRows() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withHideEmptyRows(flag = true) {
     this.parameters.hideEmptyRows = flag;
     return new AnalyticsRequest(this);
   }
@@ -249,8 +242,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withHideEmptyColumns();
    */
-  withHideEmptyColumns() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withHideEmptyColumns(flag = true) {
     this.parameters.hideEmptyColumns = flag;
     return new AnalyticsRequest(this);
   }
@@ -266,8 +258,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withShowHierarchy();
    */
-  withShowHierarchy() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withShowHierarchy(flag = true) {
     this.parameters.showHierarchy = flag;
     return new AnalyticsRequest(this);
   }
@@ -283,8 +274,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withIncludeNumDen();
    */
-  withIncludeNumDen() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withIncludeNumDen(flag = true) {
     this.parameters.includeNumDen = flag;
     return new AnalyticsRequest(this);
   }
@@ -300,8 +290,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withIncludeMetadataDetails();
    */
-  withIncludeMetadataDetails() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withIncludeMetadataDetails(flag = true) {
     this.parameters.includeMetadataDetails = flag;
     return new AnalyticsRequest(this);
   }
@@ -663,8 +652,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withCoordinatesOnly();
    */
-  withCoordinatesOnly() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withCoordinatesOnly(flag = true) {
     this.parameters.coordinatesOnly = flag;
     return new AnalyticsRequest(this);
   }
@@ -680,8 +668,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withPage(2);
    */
-  withPage() {
-    let page = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 1;
+  withPage(page = 1) {
     this.parameters.page = page;
     return new AnalyticsRequest(this);
   }
@@ -697,8 +684,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withPageSize(10);
    */
-  withPageSize() {
-    let size = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 50;
+  withPageSize(size = 50) {
     this.parameters.pageSize = size;
     return new AnalyticsRequest(this);
   }
@@ -798,8 +784,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withCollapseDataDimensions();
    */
-  withCollapseDataDimensions() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withCollapseDataDimensions(flag = true) {
     this.parameters.collapseDataDimensions = flag;
     return new AnalyticsRequest(this);
   }
@@ -815,8 +800,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withSkipRounding();
    */
-  withSkipRounding() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withSkipRounding(flag = true) {
     this.parameters.skipRounding = flag;
     return new AnalyticsRequest(this);
   }
@@ -832,8 +816,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withAggregateData();
    */
-  withAggregateData() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withAggregateData(flag = true) {
     this.parameters.aggregateData = flag;
     return new AnalyticsRequest(this);
   }
@@ -867,8 +850,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withCoordinateField('<attribute-id>');
    */
-  withCoordinateField() {
-    let field = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'EVENT';
+  withCoordinateField(field = 'EVENT') {
     // EVENT, <attribute-id>, <dataelement-id>
     this.parameters.coordinateField = field;
     return new AnalyticsRequest(this);
@@ -903,8 +885,7 @@ class extends base {
    * const req = new analytics.request()
    *    .withIncludeClusterPoints();
    */
-  withIncludeClusterPoints() {
-    let flag = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : true;
+  withIncludeClusterPoints(flag = true) {
     this.parameters.includeClusterPoints = flag;
     return new AnalyticsRequest(this);
   }

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

@@ -1,11 +1,9 @@
 class AnalyticsResponseHeader {
-  constructor() {
-    let header = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
-    let options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {
-      isPrefix: false,
-      isCollect: false,
-      index: undefined
-    };
+  constructor(header = {}, options = {
+    isPrefix: false,
+    isCollect: false,
+    index: undefined
+  }) {
     Object.assign(this, header, options);
   }
   getIndex() {

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

@@ -26,20 +26,18 @@ describe('generateDimensionString', () => {
     outputSorted: ['dim1:item1', 'dim2:item1;item2']
   }];
   it('should return dimension strings correctly formatted', () => {
-    tests.forEach(_ref => {
-      let {
-        input,
-        output
-      } = _ref;
+    tests.forEach(({
+      input,
+      output
+    }) => {
       expect(generateDimensionStrings(input)).toEqual(output);
     });
   });
   it('should return dimension strings correctly formatted and sorted', () => {
-    tests.forEach(_ref2 => {
-      let {
-        input,
-        outputSorted
-      } = _ref2;
+    tests.forEach(({
+      input,
+      outputSorted
+    }) => {
       expect(generateDimensionStrings(input, {
         sorted: true
       })).toEqual(outputSorted);

package/build/es/api/analytics/__tests__/AnalyticsRequest.spec.js

@@ -2,11 +2,18 @@ import fixtures from '../../../__fixtures__/fixtures.js';
 import AnalyticsRequest from '../AnalyticsRequest.js';
 let request;
 let expectedParameters;
+let warnMock;
 const getFuncName = parameter => `with${parameter.charAt(0).toUpperCase()}${parameter.slice(1)}`;
 describe('AnalyticsRequest', () => {
   beforeEach(() => {
     request = new AnalyticsRequest();
     expectedParameters = {};
+    // Prevent console warnings like below from cluttering the test output:
+    // "analytics.request.withAggregationType(): "new-constant" not listed as possible value"
+    warnMock = jest.spyOn(console, 'warn').mockImplementation(() => {});
+  });
+  afterEach(() => {
+    warnMock.mockReset();
   });
   describe('constructor', () => {
     it('should not be allowed to be called without new', () => {
@@ -280,8 +287,7 @@ describe('AnalyticsRequest', () => {
         page: 1,
         pageSize: 50
       };
-      Object.entries(params).forEach(_ref => {
-        let [key, value] = _ref;
+      Object.entries(params).forEach(([key, value]) => {
         const parameter = key;
         const funcName = getFuncName(parameter);
         it(`should add the ${parameter} parameter with the default value`, () => {

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

@@ -3,20 +3,14 @@ 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 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 [outputType === 'TRACKED_ENTITY_INSTANCE' ? programId : undefined, programStageId, dimension].filter(Boolean).join('.');
-};
+export const formatRequestPath = ({
+  path,
+  program,
+  trackedEntityType
+}) => [path, program, trackedEntityType].filter(Boolean).join('/');
+export const formatDimension = ({
+  outputType,
+  programId,
+  programStageId,
+  dimension
+}) => [outputType === 'TRACKED_ENTITY_INSTANCE' ? programId : undefined, programStageId, dimension].filter(Boolean).join('.');