@datarailsshared/dr_renderer 1.2.428 → 1.2.429

package/package.json

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

package/src/highcharts_renderer.js

@@ -449,6 +449,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         }
         filtOb.show_in_graph = value.show_in_graph || false;
         filtOb.override_global_filter = value.override_global_filter || false;
+        filtOb.allow_nulls = value.allow_nulls || false;
         filtOb.field = value.id;
         filtOb.name = highchartsRenderer.decodeFunc(value.name);
         return filtOb;
@@ -491,6 +492,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         filtOb.id = value.id;
         filtOb.type = value.type;
         filtOb.name = value.name;
+        filtOb.allow_nulls = value.allow_nulls;
         return filtOb;
     };
 
@@ -5506,6 +5508,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     fieldOb.includes = filterObj.values;
                 }
             }
+            if (filterObj.allow_nulls && fieldOb) {
+                fieldOb.allow_nulls = filterObj.allow_nulls;
+            }
         });
 
         // // fill selected fields
@@ -5557,6 +5562,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     fieldOb.includes = filterObj.values;
                 }
             }
+            if (filterObj.allow_nulls && fieldOb) {
+                fieldOb.allow_nulls = filterObj.allow_nulls;
+            }
         });
 
         // fill selected fields
@@ -5754,6 +5762,10 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             if (filterObj.override_global_filter && fieldOb) {
                 fieldOb.override_global_filter = filterObj.override_global_filter;
             }
+
+            if (filterObj.allow_nulls && fieldOb) {
+                fieldOb.allow_nulls = filterObj.allow_nulls;
+            }
         });
 
         // // fill calculated values
@@ -5808,6 +5820,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         var otherFields = [];
         var includes = {};
         var date_aggregation_configs = lodash.get(options, "date_aggregation_configs");
+        var fields_allow_null_in_filters = lodash.get(options, "fields_allow_null_in_filters");
+        //var tempIncludeExcludeOb;
+        //var needSort = [];
         var sorters = function () {
         };
 
@@ -5848,6 +5863,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 if (temp_date_aggregation_config) {
                     fieldOb.date_aggregation_config = temp_date_aggregation_config;
                 }
+                fieldOb.allow_nulls = lodash.includes(fields_allow_null_in_filters, fieldOb.id);
                 lodash.remove(fields, {id: fieldOb.id});
             }
         });
@@ -5861,6 +5877,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 if (temp_date_aggregation_config) {
                     fieldOb.date_aggregation_config = temp_date_aggregation_config;
                 }
+                fieldOb.allow_nulls = lodash.includes(fields_allow_null_in_filters, fieldOb.id);
                 lodash.remove(fields, {id: fieldOb.id});
             }
         });
@@ -5874,6 +5891,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 if (temp_date_aggregation_config) {
                     fieldOb.date_aggregation_config = temp_date_aggregation_config;
                 }
+                fieldOb.allow_nulls = lodash.includes(fields_allow_null_in_filters, fieldOb.id);
                 if (!doNotRemoveFilters)
                     lodash.remove(fields, {id: fieldOb.id});
             }
@@ -5932,6 +5950,10 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         if (filterObj.override_global_filter && fieldOb) {
             fieldOb.override_global_filter = filterObj.override_global_filter;
         }
+
+        if (filterObj.allow_nulls && fieldOb) {
+            fieldOb.allow_nulls = filterObj.allow_nulls;
+        }
     }
 
     highchartsRenderer.getChartOptionsBySubType = function (subTypeChart) {
@@ -8136,6 +8158,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     all_vals = lodash.clone(fieldFilter.includes);
                 }
                 if (all_vals) {
+                    if (fieldFilter.allow_nulls && all_vals.length > 1) {
+                      all_vals = all_vals.filter(x => x !== '[null]')
+                    }
                     all_vals = all_vals.join(', ');
                     tooltip = ' (' + all_vals + ')';
                     if (all_vals.split(',').length > highchartsRenderer.MAX_SELECTED_ITEMS_BEFORE_COLLAPSING && isGlobalFilter
@@ -8177,6 +8202,9 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 }
 
                 if (all_vals) {
+                    if (fieldFilter.allow_nulls && all_vals.length > 1) {
+                      all_vals = all_vals.filter(x => x !== '[null]')
+                    }
                     all_vals = all_vals.join(', ');
                     tooltip = ' (Exclusions: ' + all_vals + ')';
                     if (all_vals.split(',').length > highchartsRenderer.MAX_SELECTED_ITEMS_BEFORE_COLLAPSING && isGlobalFilter
@@ -8326,6 +8354,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                 }) : ret['values'];
             }
             ret['is_excluded'] = element.hasOwnProperty('excludes') && element.excludes != null;
+            ret['allow_nulls'] = element.hasOwnProperty('allow_nulls') ? element.allow_nulls : false;
             ret['inject_only'] = element.hasOwnProperty('inject_only') ? element.inject_only : false;
             return ret;
         });
@@ -8395,6 +8424,16 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
             dashboardsFilters = dashboardsFilters.concat(highchartsRenderer.getRelevantFilters(local_current_dashboard.filters));
         }
 
+        lodash.forEach(dashboardsFilters, function (filter) {
+            if (filter.allow_nulls) {
+                if (filter.values && Array.isArray(filter.values)) {
+                    if (!lodash.includes(filter.values, "[null]")) {
+                        filter.values.push("[null]");
+                    }
+                }
+            }
+        });
+
         if (remove_filters_from_global) {
             dashboardsFilters = highchartsRenderer.objectCopyJsonMethod(dashboardsFilters);
             lodash.forEach(remove_filters_from_global, function (field) {
@@ -8669,6 +8708,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
                     "includes": null,
                     "show_in_graph": false,
                     "override_global_filter": false,
+                    "allow_nulls": false,
                 });
                 temp.values = [row_value];
                 temp.values.label = row_value;
@@ -8792,6 +8832,7 @@ let getHighchartsRenderer = function ($, document, Highcharts, default_colors, h
         filtOb.is_excluded = false;
         filtOb.values = [value] || null;
         filtOb.show_in_graph = field.show_in_graph || false;
+        filtOb.allow_nulls = field.allow_nulls || false;
         filtOb.override_global_filter = false;
         filtOb.field = field.id;
         filtOb.name = highchartsRenderer.decodeFunc(field.name);

package/tests/highcharts_renderer.test.js

@@ -106,12 +106,14 @@ describe('highcharts_renderer', () => {
                 includes: ['test'],
                 show_in_graph: true,
                 override_global_filter: true,
+                allow_nulls: true,
             };
             expect(highchartsRenderer.createFilterObject(field)).toEqual({
                 is_excluded: false,
                 values: ['test'],
                 show_in_graph: true,
                 override_global_filter: true,
+                allow_nulls: true,
                 field: 1,
                 name: 'name',
             });
@@ -128,6 +130,7 @@ describe('highcharts_renderer', () => {
                 values: null,
                 show_in_graph: false,
                 override_global_filter: false,
+                allow_nulls: false,
                 field: 1,
                 name: 'name',
             });
@@ -144,6 +147,7 @@ describe('highcharts_renderer', () => {
                 values: ['test'],
                 show_in_graph: false,
                 override_global_filter: false,
+                allow_nulls: false,
                 field: 1,
                 name: 'name',
             });
@@ -162,6 +166,7 @@ describe('highcharts_renderer', () => {
                 values: field.values,
                 show_in_graph: false,
                 override_global_filter: false,
+                allow_nulls: false,
                 field: 1,
                 name: 'name',
             });
@@ -180,6 +185,7 @@ describe('highcharts_renderer', () => {
                 values: field.datetypevalues,
                 show_in_graph: false,
                 override_global_filter: false,
+                allow_nulls: false,
                 field: 1,
                 name: 'name',
             });
@@ -198,6 +204,7 @@ describe('highcharts_renderer', () => {
                 values: field.values,
                 show_in_graph: false,
                 override_global_filter: false,
+                allow_nulls: false,
                 field: 1,
                 name: 'name',
             });
@@ -266,6 +273,7 @@ describe('highcharts_renderer', () => {
                 type: 'Float',
                 name: 'name',
                 fields: [1,3,4],
+                allow_nulls: true,
             }
         });
 
@@ -1654,6 +1662,7 @@ describe('highcharts_renderer', () => {
                 is_excluded: false,
                 show_in_graph: true,
                 override_global_filter: true,
+                allow_nulls: true
             };
             fieldOb = {
                 name: 'fieldName',
@@ -1672,6 +1681,7 @@ describe('highcharts_renderer', () => {
             });
             expect(fieldOb.show_in_graph).toBe(true);
             expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBe(true);
         });
 
         it('should set excludes array for field when filter is excluded', () => {
@@ -1686,6 +1696,7 @@ describe('highcharts_renderer', () => {
             });
             expect(fieldOb.show_in_graph).toBe(true);
             expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBe(true);
         });
 
         it('should set values on field when datetype is not list', () => {
@@ -1702,6 +1713,7 @@ describe('highcharts_renderer', () => {
             expect(fieldOb.values).toEqual(filterObj.values);
             expect(fieldOb.show_in_graph).toBe(true);
             expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBe(true);
         });
 
         it('should set values.val on filterObj when datetype is list', () => {
@@ -1718,6 +1730,7 @@ describe('highcharts_renderer', () => {
             expect(filterObj.values).toEqual(values);
             expect(fieldOb.show_in_graph).toBe(true);
             expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBe(true);
         });
 
         it('should set values on field when type is advanced', () => {
@@ -1733,6 +1746,7 @@ describe('highcharts_renderer', () => {
             expect(fieldOb.values).toEqual(filterObj.values);
             expect(fieldOb.show_in_graph).toBe(true);
             expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBe(true);
         });
 
         it('should set show_in_graph to false on field when filterObj.show_in_graph is false', () => {
@@ -1741,6 +1755,7 @@ describe('highcharts_renderer', () => {
 
             expect(fieldOb.show_in_graph).toBeUndefined();
             expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBe(true);
         });
 
         it('should set override_global_filter to false on field when filterObj.override_global_filter is false', () => {
@@ -1750,6 +1765,17 @@ describe('highcharts_renderer', () => {
 
             expect(fieldOb.show_in_graph).toBe(true);
             expect(fieldOb.override_global_filter).toBeUndefined();
+            expect(fieldOb.allow_nulls).toBe(true);
+        });
+
+
+        it('should set allow_nulls to false on field when filterObj.allow_nulls is false', () => {
+            filterObj.allow_nulls = false;
+            highchartsRenderer.addFilterDataToField(filterObj, fieldOb, includes);
+
+            expect(fieldOb.show_in_graph).toBe(true);
+            expect(fieldOb.override_global_filter).toBe(true);
+            expect(fieldOb.allow_nulls).toBeUndefined();
         });
     });
 
@@ -3581,6 +3607,22 @@ describe('highcharts_renderer', () => {
                 expect(res.tooltip).toEqual('test:  (Exclusions: ' + fieldFilter.excludes.join(', ') + ')');
             });
 
+            it('Should exclude "[null]" from includes if allow_nulls enabled', () => {
+                fieldFilter.allow_nulls = true;
+                fieldFilter.includes = ['value 1', '[null]'];
+                let res = highchartsRenderer.getFilterLabel(fieldFilter, false);
+                expect(res.label).toEqual('test (value 1)');
+                expect(res.tooltip).toEqual('test (' + fieldFilter.includes[0] + ')');
+            });
+
+            it('Should exclude "[null]" from excludes if allow_nulls enabled', () => {
+                fieldFilter.allow_nulls = true;
+                fieldFilter.excludes = ['value 1', '[null]'];
+                let res = highchartsRenderer.getFilterLabel(fieldFilter, false);
+                expect(res.label).toEqual('test (Exclusions: value 1)');
+                expect(res.tooltip).toEqual('test (Exclusions: ' + fieldFilter.excludes[0] + ')');
+            });
+
             it('Should present formatted dates in includes. Get formatted value from invertValueFormatMap object if exist ', () => {
                 fieldFilter.includes = [1682063884, 1682060884, 1682013884];
                 fieldFilter.type = 'Date';
@@ -3745,18 +3787,21 @@ describe('highcharts_renderer', () => {
                 fields: ['field2'],
                 values: [1, 2, 3],
                 is_excluded: false,
+                allow_nulls: false,
                 inject_only: false
             });
             expect(relevantFilters).toContainEqual({
                 fields: ['field3'],
                 values: ['abc'],
                 is_excluded: true,
+                allow_nulls: false,
                 inject_only: false
             });
             expect(relevantFilters).toContainEqual({
                 fields: ['field4'],
                 values: {datetype: 'date', start: '2022-01-01', end: '2022-01-31'},
                 is_excluded: false,
+                allow_nulls: false,
                 inject_only: false
             });
         });
@@ -3808,6 +3853,7 @@ describe('highcharts_renderer', () => {
                         to: null
                     },
                     is_excluded: false,
+                    allow_nulls: false,
                     inject_only: false
                 }
             ];
@@ -3987,6 +4033,36 @@ describe('highcharts_renderer', () => {
             const result = highchartsRenderer.getDashboardFilters(data_model, remove_filters_from_global, data_model.current_dashboard);
             expect(result.length).toEqual(1);
         });
+
+        it('should add "[null]" to values array for filters with "allow_nulls" flag', () => {
+            const currentDashboardWithNull = {
+                filters: [
+                    {
+                        fields: [{ id: 'field1', name: 'Field 1' }],
+                        includes: ['value1', 'value2'],
+                        allow_nulls: false,
+                    },
+                ],
+            };
+            const dataModelWithNull = { current_dashboard: currentDashboardWithNull };
+            const result = highchartsRenderer.getDashboardFilters(dataModelWithNull);
+            expect(result[0].values).toEqual(['value1', 'value2']);
+        });
+
+        it('should not add "[null]" to values array if it is already present', () => {
+            const currentDashboardWithNull = {
+                filters: [
+                    {
+                        fields: [{ id: 'field1', name: 'Field 1' }],
+                        includes: ['value1'],
+                        allow_nulls: true,
+                    },
+                ],
+            };
+            const dataModelWithNull = { current_dashboard: currentDashboardWithNull };
+            const result = highchartsRenderer.getDashboardFilters(dataModelWithNull);
+            expect(result[0].values).toEqual(['value1', '[null]']);
+        });
     });
 
     describe('function getPresentationTagType', () => {
@@ -5753,6 +5829,7 @@ describe('highcharts_renderer', () => {
                     name: "Month",
                     values: [1682812800, 1680220800, "[null]"],
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: true,
                     type: "Date",
                     override_global_filter: false,
@@ -5762,6 +5839,7 @@ describe('highcharts_renderer', () => {
                     name: "AccountCode",
                     values: null,
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: true,
                     type: "Text",
                     override_global_filter: false,
@@ -5780,6 +5858,7 @@ describe('highcharts_renderer', () => {
                     name: "Data Type",
                     values: ["Activity"],
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: false,
                     type: "Text",
                     override_global_filter: false,
@@ -5796,6 +5875,7 @@ describe('highcharts_renderer', () => {
                         }, ],
                     },
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: false,
                     type: "Text",
                     override_global_filter: false,
@@ -6062,6 +6142,7 @@ describe('highcharts_renderer', () => {
                     name: "Month",
                     values: [1682812800, 1680220800, "[null]", null, 0, "", 1680220800],
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: true,
                     type: "Date",
                     override_global_filter: false,
@@ -6077,6 +6158,7 @@ describe('highcharts_renderer', () => {
                     name: "VT_Month",
                     values: [1682812800, 1680220800, "[null]", null, 0, "", 1680220800],
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: true,
                     type: "Date",
                     override_global_filter: false,
@@ -6092,6 +6174,7 @@ describe('highcharts_renderer', () => {
                     name: "Month",
                     values: [100, 200, "[null]", null, "Text", 0],
                     is_excluded: false,
+                    allow_nulls: false,
                     show_in_graph: true,
                     type: "Number",
                     override_global_filter: false,

package/tests/mock/add-in-dynamic-ranges.json

@@ -54,6 +54,7 @@
         "Income"
       ],
       "is_excluded": false,
+      "allow_nulls": true,
       "type": "Text",
       "override_global_filter": false
     },
@@ -64,6 +65,7 @@
         "Auto"
       ],
       "is_excluded": true,
+      "allow_nulls": false,
       "type": "Text",
       "override_global_filter": false
     },
@@ -81,6 +83,7 @@
         ]
       },
       "is_excluded": false,
+      "allow_nulls": false,
       "type": "Text",
       "override_global_filter": false
     },
@@ -92,6 +95,7 @@
         1643587200
       ],
       "is_excluded": false,
+      "allow_nulls": false,
       "type": "Date",
       "override_global_filter": false
     },
@@ -105,6 +109,7 @@
         ]
       },
       "is_excluded": true,
+      "allow_nulls": false,
       "type": "Date",
       "override_global_filter": false
     },
@@ -119,6 +124,7 @@
         }
       },
       "is_excluded": false,
+      "allow_nulls": false,
       "type": "Date",
       "override_global_filter": false
     }

package/tests/mock/add-in-functions.json

@@ -15,6 +15,7 @@
         ],
         "is_excluded": false,
         "show_in_graph": true,
+        "allow_nulls ": true,
         "type": "Text",
         "override_global_filter": true
       },
@@ -85,6 +86,7 @@
           ]
         },
         "is_excluded": true,
+        "allow_nulls": true,
         "type": "Date",
         "override_global_filter": false
       }

package/tests/mock/add-in-tables.json

@@ -21,6 +21,7 @@
         ],
         "is_excluded": false,
         "show_in_graph": false,
+        "allow_nulls": true,
         "type": "Text",
         "override_global_filter": false
       },

package/tests/mock/widgets.json

@@ -166,6 +166,7 @@
           "Other Income"
         ],
         "is_excluded": false,
+        "allow_nulls": true,
         "show_in_graph": true,
         "type": "Text",
         "override_global_filter": true
@@ -181,6 +182,7 @@
           }
         },
         "is_excluded": false,
+        "allow_nulls": false,
         "show_in_graph": false,
         "type": "Date",
         "override_global_filter": false
@@ -193,6 +195,7 @@
           1643587200
         ],
         "is_excluded": false,
+        "allow_nulls": true,
         "show_in_graph": true,
         "type": "Date",
         "override_global_filter": true
@@ -372,6 +375,10 @@
           "is_formatting_by_aggregation_method": true
         }
       ],
+      "fields_allow_null_in_filters": [
+        161918,
+        161924
+      ],
       "error_has_occurred": false
     },
     "vals": [