@adaptabletools/adaptable 17.0.5 → 17.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "17.0.5",
+  "version": "17.0.7",
   "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: 1707035112774;
+declare const _default: 1709713890982;
 export default _default;

package/publishTimestamp.js

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

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/Events/CalculatedColumnChanged.d.ts

@@ -5,8 +5,15 @@ import { BaseEventInfo } from './BaseEventInfo';
  */
 export interface CalculatedColumnChangedInfo extends BaseEventInfo {
     /**
-     * What caused CalculatedColumn State to change
+     * 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/Internal/CalculatedColumnInternalApi.d.ts

@@ -25,5 +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,12 +74,17 @@ 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(),
         };

package/src/Strategy/ChartingModule.js

@@ -10,6 +10,7 @@ const ChartingRedux = tslib_1.__importStar(require("../Redux/ActionsReducers/Cha
 const ChartingStatusBarPopover_1 = require("../View/Charting/ChartingStatusBarPopover");
 const getObjectTagsViewItems_1 = require("./Utilities/getObjectTagsViewItems");
 const ChartingState_1 = require("../PredefinedConfig/ChartingState");
+const Helper_1 = tslib_1.__importDefault(require("../Utilities/Helpers/Helper"));
 class ChartingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ChartingModuleId, ModuleConstants.ChartingFriendlyName, 'chart', 'ChartPopup', 'Create AG Grid Charts in order to see Adaptable Data visually', api);
@@ -37,7 +38,7 @@ class ChartingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     }
     isModuleAvailable() {
         const agChartsAvailable = this.api.chartingApi.isChartingEnabled() && super.isModuleAvailable();
-        const externalChartsAvailable = this.api.optionsApi.getChartingOptions().externalChartingOptions;
+        const externalChartsAvailable = Helper_1.default.objectHasKeys(this.api.optionsApi.getChartingOptions().externalChartingOptions);
         return Boolean(agChartsAvailable || externalChartsAvailable);
     }
     getModuleAdaptableObjects() {

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -15,4 +15,4 @@ exports.PredicateDocsLink = `${exports.HOST_URL_DOCS}/guide/adaptable-predicate`
 exports.PrimaryKeyDocsLink = `${exports.HOST_URL_DOCS}/guide/getting-started-primary-key`;
 exports.LicenseDocsLink = `${exports.HOST_URL_DOCS}/guide/licensing`;
 exports.AdaptableOptionsDocsLink = `${exports.HOST_URL_DOCS}/guide/reference-options-overview`;
-exports.AgGridModulesDocsLink = `${exports.HOST_URL_DOCS}/TODO_TODO_TODO`;
+exports.AgGridModulesDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-aggrid-modules-overview`;

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/Utilities/Helpers/Helper.d.ts

@@ -1,5 +1,6 @@
 export declare function objectExists(item: any): boolean;
 export declare function objectNotExists(item: any): boolean;
+export declare function objectHasKeys(item: any): boolean;
 export declare function getStringRepresentionFromKey(event: KeyboardEvent | any): string;
 export declare function cloneObject<T extends any>(obj: T): T;
 export declare const arrayToKeyMap: <T extends string | number | symbol>(arr?: T[]) => Record<T, boolean>;
@@ -20,6 +21,7 @@ export declare function clamp(value: any, boundOne: number, boundTwo: number): n
 export declare const Helper: {
     objectExists: typeof objectExists;
     objectNotExists: typeof objectNotExists;
+    objectHasKeys: typeof objectHasKeys;
     getStringRepresentionFromKey: typeof getStringRepresentionFromKey;
     cloneObject: typeof cloneObject;
     convertArrayToCsv: typeof convertArrayToCsv;

package/src/Utilities/Helpers/Helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Helper = exports.clamp = exports.modeNumberArray = exports.medianNumberArray = exports.meanNumberArray = exports.standardDeviationNumberArray = exports.sumNumberArray = exports.roundNumberTo4dp = exports.roundNumber = exports.isInputNotNullOrEmpty = exports.isInputNullOrEmpty = exports.returnItemCount = exports.copyToClipboard = exports.createDownloadedFile = exports.convertArrayToCsv = exports.arrayToKeyMap = exports.cloneObject = exports.getStringRepresentionFromKey = exports.objectNotExists = exports.objectExists = void 0;
+exports.Helper = exports.clamp = exports.modeNumberArray = exports.medianNumberArray = exports.meanNumberArray = exports.standardDeviationNumberArray = exports.sumNumberArray = exports.roundNumberTo4dp = exports.roundNumber = exports.isInputNotNullOrEmpty = exports.isInputNullOrEmpty = exports.returnItemCount = exports.copyToClipboard = exports.createDownloadedFile = exports.convertArrayToCsv = exports.arrayToKeyMap = exports.cloneObject = exports.getStringRepresentionFromKey = exports.objectHasKeys = exports.objectNotExists = exports.objectExists = void 0;
 const StringExtensions_1 = require("../Extensions/StringExtensions");
 const AdaptableLogger_1 = require("../../agGrid/AdaptableLogger");
 function objectExists(item) {
@@ -11,6 +11,10 @@ function objectNotExists(item) {
     return !objectExists(item);
 }
 exports.objectNotExists = objectNotExists;
+function objectHasKeys(item) {
+    return Object.keys(item).length > 0;
+}
+exports.objectHasKeys = objectHasKeys;
 function getStringRepresentionFromKey(event) {
     if (event.key == null) {
         return event.char; // IE
@@ -249,6 +253,7 @@ exports.clamp = clamp;
 exports.Helper = {
     objectExists,
     objectNotExists,
+    objectHasKeys,
     getStringRepresentionFromKey,
     cloneObject,
     convertArrayToCsv,

package/src/Utilities/Services/AggregatedScalarLiveValue.js

@@ -41,7 +41,9 @@ class AggregatedScalarLiveValue {
     getAggregatedValueForRow(rowNode) {
         const aggregationValue = this.getAggregationValue(rowNode);
         if (aggregationValue == undefined) {
-            logOnce(`${this.aggregatedScalarExpression} :: aggregation value is NOT available!`, this.adaptableApi.logWarn);
+            logOnce(`${this.aggregatedScalarExpression} :: aggregation value is NOT available!`, (message) => {
+                this.adaptableApi.internalApi.getAdaptableInstance().logger.warn(message);
+            });
             return;
         }
         if (this.expressionEvaluation.rowValueGetter) {

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;