@adaptabletools/adaptable 17.0.4 → 17.0.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "17.0.4",
+  "version": "17.0.6",
   "description": "Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1706885118631;
+declare const _default: 1707305637365;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1706885118631;
+exports.default = 1707305637365;

package/src/AdaptableOptions/GroupingOptions.d.ts

@@ -12,9 +12,9 @@ export interface GroupingOptions<TData = any> {
     */
     showGroupingTotalsAsHeader?: boolean;
     /**
-    * Value to use for 'Unbalanced Groups' (string columns)
+    * Value to use for 'Balanced Groups' (string columns only)
     */
-    unbalancedGroupsKey?: string | ((context: UnbalancedGroupsKeyContext<TData>) => string);
+    balancedGroupsKey?: string | ((context: BalancedGroupsKeyContext<TData>) => string);
     /**
      * Places ungrouped columns at pre-grouping indexed position
      * @defaultValue false
@@ -31,9 +31,9 @@ export interface GroupingOptions<TData = any> {
     autoOrderGroupedColumns?: boolean;
 }
 /**
- * Context used when setting a value for Unbalanced Row Groups
+ * Context used when setting a value for Balanced Row Groups
  */
-export interface UnbalancedGroupsKeyContext<TData = any> extends BaseContext {
+export interface BalancedGroupsKeyContext<TData = any> extends BaseContext {
     /**
      * AdapTable Column being grouped
      */

package/src/Api/EventApi.d.ts

@@ -1,4 +1,5 @@
 import { CellSelectionChangedInfo, RowSelectionChangedInfo, LiveDataChangedInfo, DashboardChangedInfo, ThemeChangedInfo, AlertFiredInfo, LayoutChangedInfo, AdaptableReadyInfo, CustomToolbarConfiguredInfo, CellChangedInfo, SystemStatusMessageDisplayedInfo, AdaptableStateChangedInfo, FlashingCellDisplayedInfo, GridDataChangedInfo, TeamSharingEntityChangedInfo, ActionRowSubmittedInfo, DataSetSelectedInfo, AdaptableStateReloadedInfo, GridSortedInfo, ScheduleTriggeredInfo, ChartChangedInfo, ThemeEditedInfo, Fdc3MessageInfo, DataImportedInfo, ColumnFilterAppliedInfo, GridFilterAppliedInfo } from '../types';
+import { CalculatedColumnChangedInfo } from './Events/CalculatedColumnChanged';
 /**
  * Responsible for publishing the many Events that AdapTable fires
  */
@@ -182,14 +183,25 @@ export interface EventApi {
      * @param callback LayoutChanged which includes just the name of the currently selected Layout.
      * @returns the unsubscribe function
      */
-    on(eventName: 'LayoutChanged', callback: (LayoutChangedInfo: LayoutChangedInfo) => void): VoidFunction;
+    on(eventName: 'LayoutChanged', callback: (layoutChangedInfo: LayoutChangedInfo) => void): VoidFunction;
     /**
      * Unsubscribe from LayoutChanged
      */
-    off(eventName: 'LayoutChanged', callback: (LayoutChangedInfo: LayoutChangedInfo) => void): void;
+    off(eventName: 'LayoutChanged', callback: (layoutChangedInfo: LayoutChangedInfo) => void): void;
+    /**
+     * Event fired whenever a Calculated Columns is created / updated / deleted in AdapTable
+     * @param eventName CalculatedColumnChanged
+     * @param callback CalculatedColumnChanged which includes the action and details of the Calculated Column
+     * @returns the unsubscribe function
+     */
+    on(eventName: 'CalculatedColumnChanged', callback: (calculatedColumnChangedInfo: CalculatedColumnChangedInfo) => void): VoidFunction;
+    /**
+     * Unsubscribe from CalculatedColumnChanged
+     */
+    off(eventName: 'CalculatedColumnChanged', callback: (calculatedColumnChangedInfo: CalculatedColumnChangedInfo) => void): void;
     /**
      * Event fired whenever **Configure Button is clicked in a Custom Toolbar**
-     * @param eventName DashboardChanged
+     * @param eventName CustomToolbarConfigured
      * @param callback CustomToolbarConfiguredInfo which contains the Custom Toolbar
      * @returns the unsubscribe function
      */
@@ -327,6 +339,6 @@ export interface EventApi {
     emitSync(eventName: 'DashboardChanged', data?: any): any[];
     emitSync(eventName: 'FlashingCellDisplayed', data?: any): any[];
     emitSync(eventName: 'AdaptableDestroy'): any[];
-    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited' | 'GridFilterApplied', data?: any): Promise<any>;
+    emit(eventName: 'ActionRowSubmitted' | 'AdaptableReady' | 'AlertFired' | 'AdaptableStateChanged' | 'AdaptableStateReloaded' | 'CellChanged' | 'ChartChanged' | 'CheckboxColumnClicked' | 'CustomToolbarConfigured' | 'DashboardChanged' | 'DataImported' | 'DataSetSelected' | 'ColumnFilterApplied' | 'Fdc3Message' | 'GridDataChanged' | 'GridSorted' | 'LayoutChanged' | 'CalculatedColumnChanged' | 'LiveDataChanged' | 'ScheduleTriggered' | 'SearchChanged' | 'CellSelectionChanged' | 'RowSelectionChanged' | 'SystemStatusMessageDisplayed' | 'TeamSharingEntityChanged' | 'ThemeChanged' | 'ThemeEdited' | 'GridFilterApplied', data?: any): Promise<any>;
     destroy(): void;
 }

package/src/Api/Events/CalculatedColumnChanged.d.ts

@@ -0,0 +1,19 @@
+import { CalculatedColumn } from '../../PredefinedConfig/CalculatedColumnState';
+import { BaseEventInfo } from './BaseEventInfo';
+/**
+ * EventInfo returned by CalculatedColumnChanged event
+ */
+export interface CalculatedColumnChangedInfo extends BaseEventInfo {
+    /**
+     * What caused CalculatedColumn State to change (i.e. Add, Edit, Delete)
+     */
+    actionName: string;
+    /**
+     * Calculated Column that has been added, edited or deleted
+     */
+    calculatedColumn: CalculatedColumn;
+    /**
+     * AST for Current Calculated Column Expression
+     */
+    calculatedColumnExpressionAST: any;
+}

package/src/Api/Events/CalculatedColumnChanged.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/Api/Internal/CalculatedColumnInternalApi.d.ts

@@ -25,4 +25,6 @@ export declare class CalculatedColumnInternalApi extends ApiBase {
     getCalculatedColumnsDependentOnColumn(column: AdaptableColumn): string[];
     isCumulativeAggregatedExpression(input: string): boolean;
     isQuantileAggregatedExpression(input: string): boolean;
+    getExpressionFromCalculatedColumn(calculatedColumn: CalculatedColumn): string;
+    fireCalculatedColumnChangedEvent(trigger: string, calculatedColumn: CalculatedColumn): void;
 }

package/src/Api/Internal/CalculatedColumnInternalApi.js

@@ -74,5 +74,21 @@ class CalculatedColumnInternalApi extends ApiBase_1.ApiBase {
             .internalApi.getQueryLanguageService()
             .getNodesFromExpression(input, 'QUANT')) === null || _a === void 0 ? void 0 : _a.length);
     }
+    getExpressionFromCalculatedColumn(calculatedColumn) {
+        var _a;
+        return ((_a = calculatedColumn.Query.ScalarExpression) !== null && _a !== void 0 ? _a : calculatedColumn.Query.AggregatedScalarExpression);
+    }
+    fireCalculatedColumnChangedEvent(trigger, calculatedColumn) {
+        const adaptableApi = this.getAdaptableApi();
+        const calculatedColumnChangedInfo = {
+            adaptableApi: adaptableApi,
+            actionName: trigger,
+            calculatedColumn: calculatedColumn,
+            calculatedColumnExpressionAST: adaptableApi.expressionApi.getASTForExpression(this.getExpressionFromCalculatedColumn(calculatedColumn)),
+            userName: adaptableApi.optionsApi.getUserName(),
+            adaptableId: adaptableApi.optionsApi.getAdaptableId(),
+        };
+        this.adaptable.api.eventApi.emit('CalculatedColumnChanged', calculatedColumnChangedInfo);
+    }
 }
 exports.CalculatedColumnInternalApi = CalculatedColumnInternalApi;

package/src/Redux/Store/AdaptableStore.js

@@ -598,6 +598,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                         adaptable.api.internalApi
                             .getCalculatedColumnExpressionService()
                             .createAggregatedScalarLiveValue(returnAction.calculatedColumn);
+                        adaptable.api.calculatedColumnApi.internalApi.fireCalculatedColumnChangedEvent(action.type, actionTyped.calculatedColumn);
                     }
                     adaptable.updateColDefsForSpecialColumns();
                     return returnAction;
@@ -623,6 +624,7 @@ const adaptableMiddleware = (adaptable) => function (middlewareAPI) {
                     adaptable.api.internalApi
                         .getCalculatedColumnExpressionService()
                         .destroyAggregatedScalarLiveValue(returnAction.calculatedColumn);
+                    adaptable.api.calculatedColumnApi.internalApi.fireCalculatedColumnChangedEvent(action.type, actionTyped.calculatedColumn);
                     adaptable.updateColDefsForSpecialColumns();
                     return returnAction;
                 }

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -148,7 +148,7 @@ exports.DefaultAdaptableOptions = {
     dataSetOptions: { dataSets: GeneralConstants_1.EMPTY_ARRAY },
     groupingOptions: {
         showGroupingTotalsAsHeader: false,
-        unbalancedGroupsKey: undefined,
+        balancedGroupsKey: undefined,
         restoreUngroupedColumns: false,
         autoOrderGroupedColumns: true,
     },

package/src/agGrid/Adaptable.js

@@ -3625,20 +3625,23 @@ class Adaptable {
                     return userPropertyValue(params);
                 }
                 const value = params.value;
-                const unbalancedGroupsKey = (_a = adaptableOptions.groupingOptions) === null || _a === void 0 ? void 0 : _a.unbalancedGroupsKey;
-                if (!unbalancedGroupsKey) {
+                if (this.gridOptions.groupAllowUnbalanced) {
                     return value;
                 }
-                let groupUnbalancedGroupsUnderKeyValue = typeof unbalancedGroupsKey === 'function'
-                    ? unbalancedGroupsKey({
+                const balancedGroupsKey = (_a = adaptableOptions.groupingOptions) === null || _a === void 0 ? void 0 : _a.balancedGroupsKey;
+                if (!balancedGroupsKey) {
+                    return value;
+                }
+                let groupBalancedGroupsUnderKeyValue = typeof balancedGroupsKey === 'function'
+                    ? balancedGroupsKey({
                         adaptableApi: adaptableApi,
                         userName: this.adaptableOptions.userName,
                         adaptableId: this.adaptableOptions.adaptableId,
                         adaptableColumn: abColumn,
                         params,
                     })
-                    : unbalancedGroupsKey;
-                return value === null || value === undefined ? groupUnbalancedGroupsUnderKeyValue : value;
+                    : balancedGroupsKey;
+                return value === null || value === undefined ? groupBalancedGroupsUnderKeyValue : value;
             };
         });
     }

package/src/metamodel/adaptable.metamodel.d.ts

@@ -1320,6 +1320,16 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
+    BalancedGroupsKeyContext: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+        }[];
+    };
     BaseContext: {
         name: string;
         kind: string;
@@ -3626,25 +3636,25 @@ export declare const ADAPTABLE_METAMODEL: {
             kind: string;
             desc: string;
             isOpt: boolean;
-            noCode: string;
-            defVal: string;
             gridInfo?: undefined;
+            noCode?: undefined;
+            defVal?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-            gridInfo: string;
+            noCode: string;
             defVal: string;
-            noCode?: undefined;
+            gridInfo?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
-            gridInfo?: undefined;
+            gridInfo: string;
+            defVal: string;
             noCode?: undefined;
-            defVal?: undefined;
         })[];
     };
     HandleFdc3Context: {
@@ -5354,16 +5364,6 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         }[];
     };
-    UnbalancedGroupsKeyContext: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: {
-            name: string;
-            kind: string;
-            desc: string;
-        }[];
-    };
     UserColumnMenuItem: {
         name: string;
         kind: string;