@datarailsshared/dr_renderer 1.2.431 → 1.2.433

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datarailsshared/dr_renderer",
-  "version": "1.2.431",
+  "version": "1.2.433",
   "description": "DataRails charts and tables renderer",
   "keywords": [
     "datarails",

package/src/dataformatter.d.ts

@@ -0,0 +1,6 @@
+declare class DataFormatterImpl {
+    formatValue(type: string, format: string, value: number, overrideFormat?: string): string
+}
+
+declare const DataFormatter: DataFormatterImpl;
+export = DataFormatter;

package/src/highcharts_renderer.js

@@ -153,6 +153,7 @@ const FEATURES = {
     MULTIPLE_DIMENSION_TAGS: 'multiple_dimension_tags',
     USE_NEW_SCENARIO_TAG: 'use_new_scenario_tag',
     ENABLE_SERVER_WIDGET_DATA_SORTING: 'enable_server_widget_data_sorting',
+    CLIENT_WIDGET_SORTING_KEYS_MERGE: 'client_widget_sorting_keys_merge',
 }
 
 const TICKS_COUNT = 5;
@@ -207,6 +208,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         disableAnimation = document.ReportHippo.user.organization && document.ReportHippo.user.organization.settings && document.ReportHippo.user.organization.settings.disable_animation
         highchartsRenderer.enabledNewWidgetValueFormatting = highchartsRenderer.hasFeature(FEATURES.ENABLE_NEW_WIDGET_VALUE_FORMATTING);
         highchartsRenderer.isSortingOnBackendEnabled = highchartsRenderer.hasFeature(FEATURES.ENABLE_SERVER_WIDGET_DATA_SORTING);
+        highchartsRenderer.CLIENT_WIDGET_SORTING_KEYS_MERGE = highchartsRenderer.hasFeature(FEATURES.CLIENT_WIDGET_SORTING_KEYS_MERGE);
     }
 
     // fix issue of use tootip.stickOnContact with tooltip.outside , source: https://github.com/highcharts/highcharts/pull/15960
@@ -9678,7 +9680,6 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         return res;
     }
 
-    // TODO: move this logic to BE (the problem it is solving that BE returns several sorting objects for more than 1 field in Values)
     highchartsRenderer.getAggregatedSortingObjects = function(res) {
         let sortingObjectToReturn = null;
 
@@ -9687,7 +9688,17 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 if (!sortingObjectToReturn) {
                     sortingObjectToReturn = lodash.clone(dataRow);
                 } else {
-                    sortingObjectToReturn.row_keys = lodash.concat(sortingObjectToReturn.row_keys, dataRow.row_keys || []);
+                    if (highchartsRenderer.CLIENT_WIDGET_SORTING_KEYS_MERGE) {
+                        const concatUniqueKeys = (keysA, keysB) => {
+                            if (!Array.isArray(keysB) || !keysB.length) return keysA;
+                            return lodash.chain(keysA).concat(keysB).uniqWith(lodash.isEqual).value();
+                        }
+                        sortingObjectToReturn.row_keys = concatUniqueKeys(sortingObjectToReturn.row_keys, dataRow.row_keys);
+                        sortingObjectToReturn.col_keys = concatUniqueKeys(sortingObjectToReturn.col_keys, dataRow.col_keys);
+                    } else {
+                        sortingObjectToReturn.row_keys = lodash.concat(sortingObjectToReturn.row_keys, dataRow.row_keys || []);
+                    }
+
                 }
                 dataRow.isSortingObject = true;
             }

package/tests/highcharts_renderer.test.js

@@ -5257,8 +5257,41 @@ describe('highcharts_renderer', () => {
             });
         });
 
-        it('should get sort object and remove from data rows (several object encounters - for more than one Values field)', () => {
+        it('should get sort object and remove from data rows (several object encounters - for more than one Values field) with merge cols and rows under FF', () => {
+            highchartsRenderer.CLIENT_WIDGET_SORTING_KEYS_MERGE = true;
+            const expectedObj = {
+                col_keys: [['colKey1'], ['colKey2'], ['colKey3'], ['colKey4'], ['colKey5']],
+                row_keys: [['rowKey1'], ['rowKey2'], ['rowKey1', 'rowKey2'], ['rowKey3']],
+            };
+            const rowData = [
+                { someField1: 'someValue1' },
+                { col_keys: [['colKey1'], ['colKey2']], row_keys: [['rowKey1']] },
+                { someField2: 'someValue2' },
+                { col_keys: [['colKey1'], ['colKey3'], ['colKey4'], ['colKey5']], row_keys: [['rowKey2']] },
+                { someField3: 'someValue3' },
+                { col_keys: [], row_keys: [['rowKey1', 'rowKey2']] },
+                { someField4: 'someValue4' },
+                { col_keys: [], row_keys: [['rowKey1', 'rowKey2']] },
+                { someField4: 'someValue5' },
+                { col_keys: [], row_keys: [] },
+                { someField4: 'someValue6' },
+                { col_keys: [['colKey5']], row_keys: [['rowKey3']] },
+            ];
+
+            const sortObj = highchartsRenderer.getAggregatedSortingObjects(rowData);
 
+            expect(rowData).toEqual([
+                { someField1: 'someValue1' },
+                { someField2: 'someValue2' },
+                { someField3: 'someValue3' },
+                { someField4: 'someValue4' },
+                { someField4: 'someValue5' },
+                { someField4: 'someValue6' },
+            ]);
+            expect(sortObj).toEqual(expectedObj);
+        });
+
+        it('should get sort object and remove from data rows (several object encounters - for more than one Values field)', () => {
             const expectedObj = { col_keys: ['colKey1', 'colKey2'], row_keys: ['rowKey1', 'rowKey2'] };
             const rowData = [
                 { someField1: 'someValue1' },