@adaptabletools/adaptable 14.0.2 → 14.0.4

package/src/Utilities/Constants/ModuleConstants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShortcutFriendlyName = exports.ShortcutModuleId = exports.ScheduleFriendlyName = exports.ScheduleModuleId = exports.QuickSearchFriendlyName = exports.QuickSearchModuleId = exports.QueryFriendlyName = exports.QueryModuleId = exports.PlusMinusFriendlyName = exports.PlusMinusModuleId = exports.OpenFinFriendlyName = exports.OpenFinModuleId = exports.LayoutFriendlyName = exports.LayoutModuleId = exports.IPushPullFriendlyName = exports.IPushPullModuleId = exports.GridInfoFriendlyName = exports.GridInfoModuleId = exports.Glue42FriendlyName = exports.Glue42ModuleId = exports.FreeTextColumnFriendlyName = exports.FreeTextColumnModuleId = exports.FormatColumnFriendlyName = exports.FormatColumnModuleId = exports.FilterFriendlyName = exports.FilterModuleId = exports.ExportFriendlyName = exports.ExportModuleId = exports.DataSetFriendlyName = exports.DataSetModuleId = exports.DataChangeHistoryFriendlyName = exports.DataChangeHistoryModuleId = exports.DashboardFriendlyName = exports.DashboardModuleId = exports.CustomSortFriendlyName = exports.CustomSortModuleId = exports.ConditionalStyleFriendlyName = exports.ConditionalStyleModuleId = exports.ChartingFriendlyName = exports.ChartingModuleId = exports.CellSummaryFriendlyName = exports.CellSummaryModuleId = exports.CalculatedColumnFriendlyName = exports.CalculatedColumnModuleId = exports.BulkUpdateFriendlyName = exports.BulkUpdateModuleId = exports.FlashingCellFriendlyName = exports.FlashingCellModuleId = exports.AlertModuleFriendlyName = exports.AlertModuleId = void 0;
-exports.ADAPTABLE_MODULE_MAP = exports.StatusBarFriendlyName = exports.StatusBarModuleId = exports.SettingsPanelFriendlyName = exports.SettingsPanelModuleId = exports.ToolPanelFriendlyName = exports.ToolPanelModuleId = exports.ThemeFriendlyName = exports.ThemeModuleId = exports.TeamSharingFriendlyName = exports.TeamSharingModuleId = exports.SystemStatusFriendlyName = exports.SystemStatusModuleId = exports.StateManagementFriendlyName = exports.StateManagementModuleId = exports.StyledColumnFriendlyName = exports.StyledColumnModuleId = exports.SmartEditFriendlyName = exports.SmartEditModuleId = void 0;
+exports.SmartEditFriendlyName = exports.SmartEditModuleId = exports.ShortcutFriendlyName = exports.ShortcutModuleId = exports.ScheduleFriendlyName = exports.ScheduleModuleId = exports.QuickSearchFriendlyName = exports.QuickSearchModuleId = exports.QueryFriendlyName = exports.QueryModuleId = exports.PlusMinusFriendlyName = exports.PlusMinusModuleId = exports.OpenFinFriendlyName = exports.OpenFinModuleId = exports.LayoutFriendlyName = exports.LayoutModuleId = exports.IPushPullFriendlyName = exports.IPushPullModuleId = exports.GridInfoFriendlyName = exports.GridInfoModuleId = exports.Glue42FriendlyName = exports.Glue42ModuleId = exports.FreeTextColumnFriendlyName = exports.FreeTextColumnModuleId = exports.FormatColumnFriendlyName = exports.FormatColumnModuleId = exports.FilterFriendlyName = exports.FilterModuleId = exports.ExportFriendlyName = exports.ExportModuleId = exports.DataSetFriendlyName = exports.DataSetModuleId = exports.DataChangeHistoryFriendlyName = exports.DataChangeHistoryModuleId = exports.DashboardFriendlyName = exports.DashboardModuleId = exports.CustomSortFriendlyName = exports.CustomSortModuleId = exports.ChartingFriendlyName = exports.ChartingModuleId = exports.CellSummaryFriendlyName = exports.CellSummaryModuleId = exports.CalculatedColumnFriendlyName = exports.CalculatedColumnModuleId = exports.BulkUpdateFriendlyName = exports.BulkUpdateModuleId = exports.FlashingCellFriendlyName = exports.FlashingCellModuleId = exports.AlertModuleFriendlyName = exports.AlertModuleId = void 0;
+exports.ADAPTABLE_MODULE_MAP = exports.StatusBarFriendlyName = exports.StatusBarModuleId = exports.SettingsPanelFriendlyName = exports.SettingsPanelModuleId = exports.ToolPanelFriendlyName = exports.ToolPanelModuleId = exports.ThemeFriendlyName = exports.ThemeModuleId = exports.TeamSharingFriendlyName = exports.TeamSharingModuleId = exports.SystemStatusFriendlyName = exports.SystemStatusModuleId = exports.StateManagementFriendlyName = exports.StateManagementModuleId = exports.StyledColumnFriendlyName = exports.StyledColumnModuleId = void 0;
 exports.AlertModuleId = 'Alert';
 exports.AlertModuleFriendlyName = 'Alert';
 exports.FlashingCellModuleId = 'FlashingCell';
@@ -14,8 +14,6 @@ exports.CellSummaryModuleId = 'CellSummary';
 exports.CellSummaryFriendlyName = 'Cell Summary';
 exports.ChartingModuleId = 'Charting';
 exports.ChartingFriendlyName = 'Charts';
-exports.ConditionalStyleModuleId = 'ConditionalStyle';
-exports.ConditionalStyleFriendlyName = 'Conditional Style';
 exports.CustomSortModuleId = 'CustomSort';
 exports.CustomSortFriendlyName = 'Custom Sort';
 exports.DashboardModuleId = 'Dashboard';
@@ -77,7 +75,6 @@ exports.ADAPTABLE_MODULE_MAP = {
     [exports.CalculatedColumnModuleId]: exports.CalculatedColumnFriendlyName,
     [exports.CellSummaryModuleId]: exports.CellSummaryFriendlyName,
     [exports.ChartingModuleId]: exports.ChartingFriendlyName,
-    [exports.ConditionalStyleModuleId]: exports.ConditionalStyleFriendlyName,
     [exports.CustomSortModuleId]: exports.CustomSortFriendlyName,
     [exports.DashboardModuleId]: exports.DashboardFriendlyName,
     [exports.DataChangeHistoryModuleId]: exports.DataChangeHistoryFriendlyName,

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -135,6 +135,7 @@ exports.DefaultAdaptableOptions = {
             Enums_1.ExportDestination.CSV,
             Enums_1.ExportDestination.Clipboard,
             Enums_1.ExportDestination.JSON,
+            Enums_1.ExportDestination.Table,
         ],
         systemReportNames: [
             GeneralConstants.ALL_DATA_REPORT,
@@ -252,7 +253,7 @@ exports.DefaultAdaptableOptions = {
         editLookUpItems: undefined,
         customDisplayFormatters: undefined,
         showDocumentationLinks: true,
-        gridInfoSections: ['GridSummary', 'AdaptableOptions', 'ColumnInfo', 'AdaptableObjectsSummary'],
+        gridInfoSections: ['GridSummary', 'AdaptableOptions', 'ColumnInfo', 'AdaptableObjects'],
         showAdapTableVersion: true,
     },
     toolPanelOptions: {

package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.d.ts

@@ -5,7 +5,7 @@ import { AggregatedScalarExpressionEvaluation } from './aggregatedScalarExpressi
  * List of all the Aggregation Functions available in AdaptableQL
  */
 export declare type AggregatedBooleanFunctionName = 'WHERE' | 'COL' | 'GROUP_BY' | 'WEIGHT' | AggregationFunction | ComparisonFunction;
-declare type AggregationFunction = 'SUM' | 'MIN' | 'MAX' | 'AVG';
+declare type AggregationFunction = 'SUM' | 'MIN' | 'MAX' | 'AVG' | 'COUNT';
 declare type ComparisonFunction = 'EQ' | 'NEQ' | 'LT' | 'GT' | 'LTE' | 'GTE';
 export interface BooleanAggregationParameter extends BaseParameter<'aggregationBoolean', AggregationFunction> {
     scalarAggregation: ScalarAggregationOperand;

package/src/Utilities/ExpressionFunctions/aggregatedBooleanExpressionFunctions.js

@@ -7,12 +7,13 @@ const ExpressionEvaluationError_1 = require("../../parser/src/ExpressionEvaluati
 const expressionFunctionUtils_1 = require("./expressionFunctionUtils");
 const aggregatedScalarExpressionFunctions_1 = require("./aggregatedScalarExpressionFunctions");
 const TypeExtensions_1 = require("../Extensions/TypeExtensions");
-const SUPPORTED_AGGREGATION_FNS = ['SUM', 'MIN', 'MAX', 'AVG'];
+const SUPPORTED_AGGREGATION_FNS = ['SUM', 'MIN', 'MAX', 'AVG', 'COUNT'];
 const aggregationScalarOperandMap = {
     SUM: ['string', 'number'],
     MIN: ['string', 'number'],
     MAX: ['string', 'number'],
     AVG: ['string', 'number'],
+    COUNT: ['string', 'number'],
 };
 // 0. optional non-capturing block of empty spaces
 // 1. block containing a numeric value (any digits) (required)
@@ -35,6 +36,7 @@ exports.aggregatedBooleanExpressionFunctions = {
     MAX: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['MAX'],
     AVG: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['AVG'],
     WEIGHT: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['WEIGHT'],
+    COUNT: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['COUNT'],
     GROUP_BY: aggregatedScalarExpressionFunctions_1.aggregatedScalarExpressionFunctions['GROUP_BY'],
     EQ: {
         handler(args, context) {

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.d.ts

@@ -6,7 +6,7 @@ import { AggregateParams } from './scalarAggregationHelper';
  * List of all the AggregatedScalar Functions available in AdaptableQL
  */
 export declare type AggregatedScalarFunctionName = ScalarAggregationFunction | OperandFunction;
-export declare type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'AVG' | 'MIN' | 'MAX' | 'CUMUL';
+export declare type ScalarAggregationFunction = 'SUM' | 'PERCENTAGE' | 'QUANT' | 'AVG' | 'MIN' | 'MAX' | 'COUNT' | 'CUMUL';
 declare type OperandFunction = 'COL' | 'OVER' | 'GROUP_BY' | 'WEIGHT';
 export interface ScalarAggregationParameter extends BaseParameter<'aggregationScalar', ScalarAggregationFunction> {
     value: AggregatedScalarExpressionEvaluation;

package/src/Utilities/ExpressionFunctions/aggregatedScalarExpressionFunctions.js

@@ -12,6 +12,7 @@ exports.cumulativeAggregatedExpressionFunctions = [
     'MIN',
     'MAX',
     'AVG',
+    'COUNT',
     'WEIGHT',
     'COL',
     'GROUP_BY',
@@ -23,6 +24,7 @@ exports.aggregatedExpressionFunctions = [
     'MAX',
     'QUANT',
     'AVG',
+    'COUNT',
     'WEIGHT',
     'COL',
     'GROUP_BY',
@@ -30,7 +32,7 @@ exports.aggregatedExpressionFunctions = [
 exports.aggregatedScalarExpressionFunctions = {
     CUMUL: {
         handler(args, context) {
-            const aggregationParameter = (0, expressionFunctionUtils_1.extractParameter)('CUMUL', 'aggregationScalar', ['SUM', 'PERCENTAGE', 'AVG', 'MIN', 'MAX'], args);
+            const aggregationParameter = (0, expressionFunctionUtils_1.extractParameter)('CUMUL', 'aggregationScalar', ['SUM', 'PERCENTAGE', 'AVG', 'MIN', 'MAX', 'COUNT'], args);
             const overColumnParameter = (0, expressionFunctionUtils_1.extractParameter)('CUMUL', 'operand', ['OVER'], args);
             const groupByParameter = (0, expressionFunctionUtils_1.extractParameter)('MAX', 'operand', ['GROUP_BY'], args, {
                 isOptional: true,
@@ -474,6 +476,49 @@ exports.aggregatedScalarExpressionFunctions = {
         ],
         category: 'aggregation',
     },
+    COUNT: {
+        handler(args, context) {
+            const countColumnParameter = (0, expressionFunctionUtils_1.extractColumnParameter)('COUNT', args);
+            const countColumnName = countColumnParameter.value;
+            const groupByParameter = (0, expressionFunctionUtils_1.extractParameter)('COUNT', 'operand', ['GROUP_BY'], args, {
+                isOptional: true,
+            });
+            const aggregationExpressionEvaluation = {
+                aggregationParams: {
+                    reducers: {
+                        COUNT: {
+                            name: 'COUNT',
+                            field: countColumnName,
+                            initialValue: 0,
+                            reducer: (totalSum, rowValue) => {
+                                if (isUndefinedValue(rowValue)) {
+                                    return totalSum;
+                                }
+                                return totalSum + 1;
+                            },
+                        },
+                    },
+                },
+                rowFilterFn: context.filterFn,
+            };
+            addGroupByParams(groupByParameter === null || groupByParameter === void 0 ? void 0 : groupByParameter.value, aggregationExpressionEvaluation);
+            const result = {
+                name: 'COUNT',
+                type: 'aggregationScalar',
+                value: aggregationExpressionEvaluation,
+            };
+            return result;
+        },
+        description: 'Counts the number of non-null (i.e. not empty) values in a given column.\nOptionally the aggregation may be computed within provided individual groups',
+        signatures: [
+            'COUNT( [colName] )',
+            'COUNT( COL(name: string))',
+            'COUNT( [colNameA], GROUP_BY( [colNameB] ))',
+            'COUNT( COL(nameA: string), GROUP_BY( COL(nameB: string)))',
+        ],
+        examples: ['COUNT([colA])', 'COUNT([colA], GROUP_BY([colB]))'],
+        category: 'aggregation',
+    },
     OVER: {
         handler(args, context) {
             const columnParameter = (0, expressionFunctionUtils_1.extractColumnParameter)('OVER', args);
@@ -641,7 +686,23 @@ const mapAggregationToCumulation = (aggregationParameter, overColumnParameter, c
                                 return cumulationBag;
                             },
                         }
-                        : null;
+                        : aggregationParameter.name === 'COUNT'
+                            ? {
+                                name: 'CUMUL_COUNT',
+                                field: aggregationReducer.field,
+                                initialValue: {
+                                    currentValue: aggregationReducer.initialValue,
+                                    cumulatedValues: {},
+                                },
+                                reducer: (cumulationBag, rowValue, rowNode) => {
+                                    if (isDefinedValue(rowValue)) {
+                                        cumulationBag.currentValue = cumulationBag.currentValue + 1;
+                                    }
+                                    cumulationBag.cumulatedValues[rowNode.id] = cumulationBag.currentValue;
+                                    return cumulationBag;
+                                },
+                            }
+                            : null;
     const rowValueGetter = aggregationParameter.name === 'PERCENTAGE'
         ? (rowNode, cumulationBag) => {
             const cumulatedSum = cumulationBag.cumulatedValues[rowNode.id];
@@ -674,7 +735,7 @@ const addGroupByParams = (groupByColumnNames, expressionEvaluation) => {
     }
 };
 const isUndefinedValue = (input) => {
-    return input == undefined || input === '';
+    return input == undefined || (typeof input === 'string' && input.trim() === '');
 };
 const isDefinedValue = (input) => {
     return !isUndefinedValue(input);

package/src/Utilities/Interface/MessagePopups.d.ts

@@ -63,6 +63,7 @@ export interface WindowPopup {
          * - used to identify the 'Component' name, to know what to instantiate
          */
         Id: string;
+        FactoryId: string;
         Title: string;
         PopupProps?: any;
         Icon?: string;

package/src/Utilities/Services/AggregatedScalarLiveValue.js

@@ -2,6 +2,15 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AggregatedScalarLiveValue = void 0;
 const scalarAggregationHelper_1 = require("../ExpressionFunctions/scalarAggregationHelper");
+const LoggingHelper_1 = require("../Helpers/LoggingHelper");
+const doOnceFlags = {};
+const logOnce = (message) => {
+    if (doOnceFlags[message]) {
+        return;
+    }
+    (0, LoggingHelper_1.LogAdaptableWarning)(message);
+    doOnceFlags[message] = true;
+};
 class AggregatedScalarLiveValue {
     constructor(source, requestingModule, adaptableApi) {
         this.source = source;
@@ -32,6 +41,10 @@ class AggregatedScalarLiveValue {
     }
     getAggregatedValueForRow(rowNode) {
         const aggregationValue = this.getAggregationValue(rowNode);
+        if (aggregationValue == undefined) {
+            logOnce(`${this.aggregatedScalarExpression} :: aggregation value is NOT available!`);
+            return;
+        }
         if (this.expressionEvaluation.rowValueGetter) {
             return this.expressionEvaluation.rowValueGetter(rowNode, aggregationValue);
         }

package/src/Utilities/Services/ChartingService.d.ts

@@ -5,6 +5,14 @@ export declare class ChartingService implements IChartingService {
     private api;
     constructor(api: AdaptableApi);
     onChartModelChange(models: ChartModel[], eventType: string, params: any): void;
+    /**
+     * Emit events only for adaptable charting definition changes
+     * - an adaptable chart opens
+     * - an adaptable chart closes
+     * - an adaptable chart is created
+     * - an adaptable chart is deleted
+     */
+    emitAdaptableChartDefinitonChange(): void;
     saveNewChart(chartModel: ChartModel): void;
     destroy(): void;
 }

package/src/Utilities/Services/ChartingService.js

@@ -35,6 +35,21 @@ class ChartingService {
                 break;
         }
         this.api.internalApi.dispatchReduxAction(SystemRedux.SystemChartingSetCurrentChartModels(models));
+        this.emitAdaptableChartDefinitonChange();
+    }
+    /**
+     * Emit events only for adaptable charting definition changes
+     * - an adaptable chart opens
+     * - an adaptable chart closes
+     * - an adaptable chart is created
+     * - an adaptable chart is deleted
+     */
+    emitAdaptableChartDefinitonChange() {
+        const chartingOpenState = this.api.chartingApi.getChartingOpenState();
+        this.api.eventApi.emit('ChartsChanged', {
+            chartingOpenState,
+            adaptableApi: this.api,
+        });
     }
     saveNewChart(chartModel) {
         var _a, _b;

package/src/Utilities/Services/ReportService.js

@@ -188,7 +188,7 @@ class ReportService {
     }
     GetReportColumnsForReport(report, includePrimaryKey = false) {
         let reportColumns = [];
-        let gridColumns = this.adaptableApi.columnApi.getColumns();
+        let gridColumns = this.adaptableApi.columnApi.getExportableColumns();
         if (this.adaptableApi.exportApi.isServerReport(report)) {
             return reportColumns;
         }

package/src/View/AdaptableViewFactory.js

@@ -30,7 +30,7 @@ const DataChangeHistoryPopup_1 = require("./DataChangeHistory/DataChangeHistoryP
 const DataChangeHistoryViewPanel_1 = require("./DataChangeHistory/DataChangeHistoryViewPanel");
 const StateManagementViewPanel_1 = require("./StateManagement/StateManagementViewPanel");
 const StatusBarPopup_1 = require("./StatusBar/StatusBarPopup");
-const ChartingViewPanel_1 = require("./Components/Charting/ChartingViewPanel");
+const ChartingViewPanel_1 = require("./Charting/ChartingViewPanel");
 exports.AdaptableViewFactory = {
     BulkUpdatePopup: BulkUpdatePopup_1.BulkUpdatePopup,
     DashboardPopup: DashboardPopup_1.DashboardPopup,

package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/ConfigurationWizard.js

@@ -11,8 +11,8 @@ const GridOptionsForm_1 = tslib_1.__importDefault(require("./GridOptionsForm"));
 const EntitlementsForm_1 = tslib_1.__importDefault(require("./EntitlementsForm"));
 const UiOptionsForm_1 = require("./UIOptions/UiOptionsForm");
 const FinanceForm_1 = require("./FinanceForm");
-const DefaultAdaptableOptions_1 = require("../../../Utilities/Defaults/DefaultAdaptableOptions");
 const AdaptableOptionsForm_1 = require("./AdaptableOptionsForm");
+const AdaptableHelper_1 = tslib_1.__importDefault(require("../../../Utilities/Helpers/AdaptableHelper"));
 const ConfigurationWizard = (props) => {
     var _a, _b;
     const [isPrimaryKeySelected, setIsValid] = React.useState(true);
@@ -23,7 +23,8 @@ const ConfigurationWizard = (props) => {
                 toolPanels: ['columns', 'filters', 'adaptable'],
             },
         };
-        return Object.assign(Object.assign(Object.assign({}, DefaultAdaptableOptions_1.DefaultAdaptableOptions), props.adaptableOptions), { gridOptions: Object.assign(Object.assign({}, gridOptionDefaults), (_a = props === null || props === void 0 ? void 0 : props.adaptableOptions) === null || _a === void 0 ? void 0 : _a.gridOptions) });
+        const preparedAdaptableOptions = Object.assign(Object.assign({}, props.adaptableOptions), { gridOptions: Object.assign(Object.assign({}, gridOptionDefaults), (_a = props === null || props === void 0 ? void 0 : props.adaptableOptions) === null || _a === void 0 ? void 0 : _a.gridOptions) });
+        return AdaptableHelper_1.default.assignAdaptableOptions(preparedAdaptableOptions);
     });
     const [selectedColumns, setSelectedColumns] = (0, react_1.useState)(() => {
         return props.adaptableOptions.gridOptions.columnDefs.reduce((acc, col) => {
@@ -75,13 +76,13 @@ const ConfigurationWizard = (props) => {
             render: () => (React.createElement(ConfigurationWizardColumnsStep_1.ConfigurationWizardColumnsStep, { adaptableOptions: adaptableOptions, setPrimaryKeyIsNotSelected: handlePrimaryKeyColumnIsNotSelected, onChange: setAdaptableOptions, selectedColumns: selectedColumns, onSelectionChange: handleColumnSelectionChange, onColumnChange: handleColumnsChange, columnsHandle: columnsHandle })),
         },
         {
-            title: 'Adaptable Options',
+            title: 'AdapTable Options',
             details: 'Configure Adaptable Options',
             isValid: () => (adaptableOptions.adaptableId ? true : 'Adaptable ID is required'),
             render: () => (React.createElement(AdaptableOptionsForm_1.AdaptableOptionsForm, { adaptableOptions: adaptableOptions, onChangeadAptableOptions: setAdaptableOptions })),
         },
         {
-            title: 'Grid Options',
+            title: 'AG Grid Options',
             details: 'Configure AG Grid Options',
             render: () => (React.createElement(GridOptionsForm_1.default, { adaptableOptions: adaptableOptions, onChangeadAptableOptions: setAdaptableOptions })),
         },

package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/UIOptions/UIOptionsActionColumnsForm.js

@@ -29,7 +29,7 @@ const UIOptionsActionColumnsForm = (props) => {
         props.onChange(Object.assign(Object.assign({}, props.abOptions), { actionOptions: Object.assign(Object.assign({}, (_a = props.abOptions) === null || _a === void 0 ? void 0 : _a.actionOptions), { actionRowButtons: newActionRowButtons }) }));
     };
     return (React.createElement(rebass_1.Box, null,
-        React.createElement(HelpBlock_1.default, null, "Row Action Buttons"),
+        React.createElement(HelpBlock_1.default, null, "Action Row Buttons"),
         React.createElement(rebass_1.Flex, { width: "100%", m: 2 }, options.map((option) => (React.createElement(CheckBox_1.CheckBox, { mr: 3, key: option.value, checked: actionRowButtons.some((buttonName) => buttonName === option.value), onChange: (check) => handleCheckChange(option.value, check) }, option.label))))));
 };
 exports.UIOptionsActionColumnsForm = UIOptionsActionColumnsForm;

package/src/View/AdaptableWizardView/AdaptableConfigurationDialog/UIOptions/UiOptionsForm.js

@@ -12,14 +12,15 @@ const UIElementsForm = (props) => {
     let abOptions = props.adaptableOptions;
     return (React.createElement(rebass_1.Box, { p: 2 },
         React.createElement(Tabs_1.Tabs, null,
+            React.createElement(Tabs_1.Tabs.Tab, null, "Tool Panel"),
+            React.createElement(Tabs_1.Tabs.Tab, null, "Status Bar"),
             React.createElement(Tabs_1.Tabs.Tab, null, "Action Rows"),
-            React.createElement(Tabs_1.Tabs.Tab, null, "Sidebar"),
-            React.createElement(Tabs_1.Tabs.Tab, null, "Statusbar"),
-            React.createElement(Tabs_1.Tabs.Content, null,
-                React.createElement(UIOptionsActionColumnsForm_1.UIOptionsActionColumnsForm, { abOptions: abOptions, onChange: props.onChangeadAptableOptions })),
             React.createElement(Tabs_1.Tabs.Content, null,
                 React.createElement(UIOptionsSidebarForm_1.UIOptionsSidebarForm, { abOptions: abOptions, onChange: props.onChangeadAptableOptions })),
             React.createElement(Tabs_1.Tabs.Content, null,
-                React.createElement(UIOptionsStatusbarForm_1.UIOptionsStatusbarForm, { abOptions: abOptions, onChange: props.onChangeadAptableOptions })))));
+                React.createElement(UIOptionsStatusbarForm_1.UIOptionsStatusbarForm, { abOptions: abOptions, onChange: props.onChangeadAptableOptions })),
+            ' ',
+            React.createElement(Tabs_1.Tabs.Content, null,
+                React.createElement(UIOptionsActionColumnsForm_1.UIOptionsActionColumnsForm, { abOptions: abOptions, onChange: props.onChangeadAptableOptions })))));
 };
 exports.UIElementsForm = UIElementsForm;

package/src/View/Alert/Utilities/getAlertType.d.ts

@@ -0,0 +1,15 @@
+import { AlertDefinition } from '../../../types';
+export declare enum AlertType {
+    DataChange = "DataChange",
+    RowChange = "RowChange",
+    Aggregation = "Aggregation",
+    Observable = "Observable"
+}
+/**
+ * Based on alert shape the type is derived.
+ * In the future the alert will get a type property.
+ *
+ * @param alert
+ */
+export declare const getAlertType: (alert: AlertDefinition) => AlertType | null;
+export declare const getAlertTypeText: (alertType: AlertType) => string;

package/src/View/Alert/Utilities/getAlertType.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAlertTypeText = exports.getAlertType = exports.AlertType = void 0;
+var AlertType;
+(function (AlertType) {
+    AlertType["DataChange"] = "DataChange";
+    AlertType["RowChange"] = "RowChange";
+    AlertType["Aggregation"] = "Aggregation";
+    AlertType["Observable"] = "Observable";
+})(AlertType = exports.AlertType || (exports.AlertType = {}));
+/**
+ * Based on alert shape the type is derived.
+ * In the future the alert will get a type property.
+ *
+ * @param alert
+ */
+const getAlertType = (alert) => {
+    if (alert.Rule.ObservableExpression) {
+        return AlertType.Observable;
+    }
+    if (alert.Rule.AggregatedBooleanExpression) {
+        return AlertType.Aggregation;
+    }
+    if (alert.Rule.BooleanExpression) {
+        return AlertType.DataChange;
+    }
+    const predicates = alert.Rule.Predicates;
+    if (predicates) {
+        if (predicates.some((predicate) => ['AddedRow', 'RemovedRow'].includes(predicate.PredicateId))) {
+            return AlertType.RowChange;
+        }
+        else {
+            return AlertType.DataChange;
+        }
+    }
+    // the object is not a valid alert
+    return null;
+};
+exports.getAlertType = getAlertType;
+const getAlertTypeText = (alertType) => {
+    let text = '';
+    switch (alertType) {
+        case AlertType.DataChange:
+            text = 'Data Change';
+            break;
+        case AlertType.RowChange:
+            text = 'Row Change';
+            break;
+        case AlertType.Aggregation:
+            text = 'Aggregation';
+            break;
+        case AlertType.Observable:
+            text = 'Observable';
+            break;
+    }
+    return text;
+};
+exports.getAlertTypeText = getAlertTypeText;

package/src/View/Alert/Utilities/getAvailablePredicates.d.ts

@@ -0,0 +1,3 @@
+import { AdaptableApi, AdaptablePredicateDef, AdaptableScope } from '../../../types';
+import { AlertType } from './getAlertType';
+export declare const getAvailablePredicateDefinitions: (api: AdaptableApi, scope: AdaptableScope, alertType: AlertType) => AdaptablePredicateDef[];

package/src/View/Alert/Utilities/getAvailablePredicates.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAvailablePredicateDefinitions = void 0;
+const getAvailablePredicateDefinitions = (api, scope, alertType) => {
+    let predicateDefs = [];
+    if (alertType === 'DataChange') {
+        predicateDefs = api.alertApi.internalApi
+            .getAlertPredicateDefsForScope(scope)
+            .filter((predicateDef) => !['AddedRow', 'RemovedRow'].includes(predicateDef.id));
+        predicateDefs = [...predicateDefs].sort((a, b) => a.id === 'Any' ? -1 : b.id === 'Any' ? 1 : 0);
+    }
+    else if (alertType === 'RowChange') {
+        predicateDefs = api.alertApi.internalApi
+            .getAlertPredicateDefsForScope(scope)
+            .filter((predicateDef) => ['AddedRow', 'RemovedRow'].includes(predicateDef.id));
+    }
+    return predicateDefs;
+};
+exports.getAvailablePredicateDefinitions = getAvailablePredicateDefinitions;

package/src/View/Alert/Utilities/getDefaultAlertDefinition.d.ts

@@ -0,0 +1,37 @@
+import { AlertDefinition } from '../../../types';
+import { AlertType } from './getAlertType';
+/**
+ * This logic should be moved into Object factory once we have types on alert definitions
+ * @param type AlertType
+ */
+export declare const getDefaultAlertDefinition: (alertDefinition: AlertDefinition, type: AlertType) => {
+    Uuid: string;
+    Scope: import("../../../types").AdaptableScope<import("../../../PredefinedConfig/Common/AdaptableScope").ScopeDataType>;
+    Rule: ({
+        Predicates?: never;
+    } & (({
+        BooleanExpression?: never;
+    } & (({
+        ObservableExpression?: never;
+    } & import("../../../types").AdaptableAggregatedBooleanQuery) | ({
+        AggregatedBooleanExpression?: never;
+    } & import("../../../types").AdaptableObservableQuery))) | ({
+        AggregatedBooleanExpression?: never;
+        ObservableExpression?: never;
+    } & import("../../../types").AdaptableBooleanQuery))) | ({
+        AggregatedBooleanExpression?: never;
+        ObservableExpression?: never;
+        BooleanExpression?: never;
+    } & {
+        Predicates: import("../../../types").AlertDefinitionPredicate[];
+    });
+    MessageType: import("../../../types").AdaptableMessageType;
+    MessageHeader?: string;
+    MessageText?: string;
+    AlertProperties?: import("../../../types").AlertProperties;
+    AlertForm?: string | import("../../../types").AlertButtonForm;
+    IsSuspended?: boolean;
+    Source?: "Config" | "User";
+    IsReadOnly?: boolean;
+    Tags?: string[];
+};

package/src/View/Alert/Utilities/getDefaultAlertDefinition.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultAlertDefinition = void 0;
+const tslib_1 = require("tslib");
+const ObjectFactory_1 = tslib_1.__importDefault(require("../../../Utilities/ObjectFactory"));
+const getAlertType_1 = require("./getAlertType");
+/**
+ * This logic should be moved into Object factory once we have types on alert definitions
+ * @param type AlertType
+ */
+const getDefaultAlertDefinition = (alertDefinition, type) => {
+    const newAlert = Object.assign(Object.assign({}, ObjectFactory_1.default.CreateEmptyAlertDefinition()), { Uuid: alertDefinition.Uuid });
+    // can only be all
+    if (type === getAlertType_1.AlertType.Observable ||
+        type === getAlertType_1.AlertType.Aggregation ||
+        type === getAlertType_1.AlertType.RowChange) {
+        newAlert.Scope = {
+            All: true,
+        };
+    }
+    if (type === getAlertType_1.AlertType.RowChange) {
+        newAlert.Rule = {
+            Predicates: [
+                {
+                    PredicateId: 'AddedRow',
+                },
+            ],
+        };
+    }
+    return newAlert;
+};
+exports.getDefaultAlertDefinition = getDefaultAlertDefinition;

package/src/View/Alert/Utilities/mapAlertDefinition.d.ts

@@ -0,0 +1,2 @@
+import { AdaptableApi, AlertDefinition } from '../../../types';
+export declare const mapAlertDefinition: (api: AdaptableApi, alertDefinition: AlertDefinition) => AlertDefinition;

package/src/View/Alert/Utilities/mapAlertDefinition.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mapAlertDefinition = void 0;
+const mapAlertDefinition = (api, alertDefinition) => {
+    var _a;
+    const isRemovedRowChangeAlert = api.alertApi.internalApi.isAlertDefinitionForRemovedRowChangeEvent(alertDefinition);
+    const mapValidButtonActions = (alertAction) => {
+        if (isRemovedRowChangeAlert) {
+            if (alertAction === 'highlight-row' || alertAction === 'jump-to-row') {
+                return null;
+            }
+            return alertAction;
+        }
+    };
+    // the only case needed is when changing from AddedRow to RemovedRow
+    // map FormButton Actions
+    if (alertDefinition.AlertForm && typeof alertDefinition.AlertForm !== 'string') {
+        const alertButtons = (_a = alertDefinition.AlertForm) === null || _a === void 0 ? void 0 : _a.Buttons;
+        alertButtons === null || alertButtons === void 0 ? void 0 : alertButtons.forEach((alertButton) => {
+            const alertAction = alertButton.Action;
+            if (Array.isArray(alertAction)) {
+                alertButton.Action = alertAction
+                    .map(mapValidButtonActions)
+                    .filter(Boolean);
+            }
+            else {
+                alertButton.Action = mapValidButtonActions(alertAction);
+            }
+        });
+    }
+    // behaviours
+    if (isRemovedRowChangeAlert) {
+        delete alertDefinition.AlertProperties.HighlightRow;
+        delete alertDefinition.AlertProperties.JumpToRow;
+    }
+    return alertDefinition;
+};
+exports.mapAlertDefinition = mapAlertDefinition;

package/src/View/Alert/Wizard/AlertBehaviourWizardSection.d.ts

@@ -1,10 +1,12 @@
 /// <reference types="react" />
 import { AlertDefinition } from '../../../PredefinedConfig/AlertState';
 import { AdaptableApi } from '../../../types';
+import { AlertType } from '../Utilities/getAlertType';
+export declare const renderAlertBehaviourWizardSummary: (alertDefinition: AlertDefinition) => JSX.Element;
+export declare const renderAlertBehaviourSummary: (alert: AlertDefinition, api: AdaptableApi, allowWrap?: boolean) => JSX.Element;
 declare type AlertBehaviourWizardSectionProps = {
     onChange: (data: AlertDefinition) => void;
+    alertType: AlertType;
 };
-export declare const renderAlertBehaviourWizardSummary: (alertDefinition: AlertDefinition) => JSX.Element;
-export declare const renderAlertBehaviourSummary: (alert: AlertDefinition, api: AdaptableApi, allowWrap?: boolean) => JSX.Element;
 export declare const AlertBehaviourWizardSection: (props: AlertBehaviourWizardSectionProps) => JSX.Element;
 export {};