@adaptabletools/adaptable-cjs 20.0.6 → 20.0.7-canary.0

package/package.json

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

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -1,5 +1,5 @@
 import { Column } from 'ag-grid-enterprise';
-import { AdaptableColumnGroup, BaseContext } from '../types';
+import { AdaptableColumnGroup, BaseContext, Layout } from '../types';
 /**
  * Options related to managing Columns in Adaptable.
  */
@@ -9,6 +9,10 @@ export interface ColumnOptions {
      * @defaultValue  undefined
      */
     columnFriendlyName?: (columnFriendlyNameContext: ColumnFriendlyNameContext) => string | undefined;
+    /**
+     * Provide a custom Header Name for a Table or Pivot Column
+     */
+    columnHeader?: (context: ColumnHeaderContext) => string;
     /**
      * Optional list of Column Types - used for Scope and creating Special Columns
      * @defaultValue Empty Array
@@ -31,10 +35,177 @@ export interface ColumnOptions {
      */
     addColumnGroupToColumnFriendlyName?: boolean;
 }
+/**
+ * Common properties for Column Header Context
+ */
+export type BaseColumnHeaderContext = {
+    /**
+     * The default header name for the column
+     */
+    defaultHeaderName: string;
+    /**
+     * The mame of the current Layout
+     */
+    currentLayoutName: string;
+    /**
+     * The type (table/pivot) of the current Layout
+     */
+    currentLayoutType: 'table' | 'pivot';
+    /**
+     * The current Layout
+     */
+    currentLayout: Layout;
+} & BaseContext;
+export type ColumnHeaderContext = BaseColumnHeaderContext & ({
+    /**
+     * Auto-generated Group Column when GroupDisplayType is `single` column
+     */
+    columnType: 'autoGroupColumn';
+    /**
+     * Technical ID of the Column
+     */
+    columnId: string;
+    /**
+     * IDs of the Columns that are grouped
+     */
+    groupedColumnIds: string[];
+} | {
+    /**
+     * Group Columns - see `TableLayout.RowGroupedColumns` or `PivotLayout.PivotGroupedColumns`
+     */
+    columnType: 'groupColumn';
+    /**
+     * Technical ID of the Column
+     */
+    columnId: string;
+    /**
+     * ID of the grouped Column
+     */
+    groupColumnId: string;
+} | {
+    /**
+     *  Table Column - see `TableLayout.TableColumns`
+     */
+    columnType: 'tableColumn';
+    /**
+     * Technical ID of the Column
+     */
+    columnId: string;
+    /**
+     * Optional Aggregation function of the Column - see `TableLayout.TableAggregationColumns`
+     */
+    aggregation?: string;
+} | {
+    /**
+     * Column Group - see https://www.ag-grid.com/javascript-data-grid/column-groups/
+     */
+    columnType: 'tableColumnGroup';
+    /**
+     * Technical ID of the Column Group - see `ColGroupDef.groupId`
+     */
+    groupId: string;
+    /**
+     * IDs of the Column Group children - see `ColGroupDef.children`
+     */
+    childrenColumnIds: string[];
+    /**
+     * State of the Column Group
+     */
+    state: 'expanded' | 'collapsed';
+} | {
+    /**
+     * Pivot Column - see `PivotLayout.PivotColumns`
+     */
+    columnType: 'pivotColumnGroup';
+    /**
+     * Technical ID of the generated Column Group
+     */
+    groupId: string;
+    /**
+     * Pivot Keys for the current Column Group
+     */
+    pivotKeys: string[];
+    /**
+     * State of the Column Group
+     */
+    state: 'expanded' | 'collapsed';
+} | {
+    /**
+     * Pivot Aggregation Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    columnType: 'pivotAggregationColumn';
+    /**
+     * Technical ID of the generated Column
+     */
+    columnId: string;
+    /**
+     * Current Pivot Keys
+     */
+    pivotKeys: string[];
+    /**
+     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    aggregatedColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+} | {
+    /**
+     * Grand Total Column - see `PivotLayout.GrandTotalColumn`
+     */
+    columnType: 'pivotGrandTotal';
+    /**
+     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    aggregatedColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+} | {
+    /**
+     * Pivot Group Total Column - see `PivotLayout.PivotGroupTotalColumn`
+     */
+    columnType: 'pivotGroupTotal';
+    /**
+     * Current Pivot Keys
+     */
+    pivotKey: string;
+    /**
+     * ID of the Pivot Column - see `PivotLayout.PivotColumns`
+     */
+    pivotColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+} | {
+    /**
+     * Pivot Aggregation Total Column - see `PivotLayout.PivotAggregationColumns.TotalColumn`
+     */
+    columnType: 'pivotAggregationTotal';
+    /**
+     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     */
+    aggregatedColumnId: string;
+    /**
+     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     */
+    aggregation: string;
+    /**
+     * ID of the Pivot Column - see `PivotLayout.PivotColumns`
+     */
+    pivotColumnId: string;
+    /**
+     * Current Pivot Keys
+     */
+    pivotKey: string;
+});
 /**
  * Context used when setting a Column Friendly Name
  */
-export interface ColumnFriendlyNameContext {
+export interface ColumnFriendlyNameContext extends BaseContext {
     /**
      * Id of the Column
      */

package/src/AdaptableState/Common/AggregationColumns.d.ts

@@ -12,7 +12,14 @@ export type TableAggregationColumns = {
 /**
  * Defines an Aggregated Column in a Pivot Layout
  */
-export type PivotAggregationColumns = TableAggregationColumns;
+export type PivotAggregationColumns = {
+    ColumnId: string;
+    AggFunc: AggregationColumnValue;
+    TotalColumn?: boolean | 'before' | 'after' | {
+        PivotColumnId: string;
+        ShowTotal?: boolean | 'before' | 'after';
+    }[];
+}[];
 export declare const WEIGHTED_AVERAGE_AGG_FN_NAME = "weightedAvg";
 /**
  * Defines a Weighted Average Agg

package/src/AdaptableState/LayoutState.d.ts

@@ -148,6 +148,18 @@ export interface PivotLayout extends LayoutBase {
      * Row Grouped Columns Columns - must NOT be provided
      */
     RowGroupedColumns?: never;
+    /**
+     * Display Grand Total Row at the top or bottom of the Pivot Table
+     */
+    GrandTotalRow?: 'top' | 'bottom' | boolean;
+    /**
+     * Display automatically calculated Totals of all Pivot Columns, in the position specified
+     */
+    GrandTotalColumn?: 'before' | 'after' | boolean;
+    /**
+     * Display automatically calculated Totals within EACH Pivot Column Group, in the position specified
+     */
+    PivotGroupTotalColumn?: 'before' | 'after' | boolean;
 }
 /**
  * Manages how (and which) Row Group values are stored

package/src/Api/Implementation/ColumnApiImpl.d.ts

@@ -11,6 +11,7 @@ export declare function generateAutoTreeSingleColumn(): AdaptableColumn;
 export declare function generateAutoRowGroupColumnForColumn(column: AdaptableColumn): AdaptableColumn;
 export declare function getFriendlyNameForPivotResultColumn(columnId: string): string;
 export declare function isPivotResultColumn(columnId: string): boolean;
+export declare function isPivotGrandTotalColumn(columnId: string): boolean;
 export declare class ColumnApiImpl extends ApiBase implements ColumnApi {
     internalApi: ColumnInternalApi;
     constructor(_adaptable: IAdaptable);

package/src/Api/Implementation/ColumnApiImpl.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColumnApiImpl = exports.isPivotResultColumn = exports.getFriendlyNameForPivotResultColumn = exports.generateAutoRowGroupColumnForColumn = exports.generateAutoTreeSingleColumn = exports.generateAutoRowGroupSingleColumn = exports.isAutoRowGroupColumn = void 0;
+exports.ColumnApiImpl = exports.isPivotGrandTotalColumn = exports.isPivotResultColumn = exports.getFriendlyNameForPivotResultColumn = exports.generateAutoRowGroupColumnForColumn = exports.generateAutoTreeSingleColumn = exports.generateAutoRowGroupSingleColumn = exports.isAutoRowGroupColumn = void 0;
 const tslib_1 = require("tslib");
 const ApiBase_1 = require("./ApiBase");
 const GeneralConstants = tslib_1.__importStar(require("../../Utilities/Constants/GeneralConstants"));
@@ -71,6 +71,13 @@ function generateAutoRowGroupColumnForColumn(column) {
 }
 exports.generateAutoRowGroupColumnForColumn = generateAutoRowGroupColumnForColumn;
 function getFriendlyNameForPivotResultColumn(columnId) {
+    if (isPivotGrandTotalColumn(columnId)) {
+        return `[Grand Total] ${columnId
+            .split('_')
+            .slice(2)
+            .map((word) => word.charAt(0).toUpperCase() + word.slice(1))
+            .join(' ')}`;
+    }
     return `[Pivot] ${columnId
         .split('_')
         .slice(1)
@@ -83,6 +90,10 @@ function isPivotResultColumn(columnId) {
     return columnId?.startsWith(GeneralConstants.AG_GRID_PIVOT_COLUMN);
 }
 exports.isPivotResultColumn = isPivotResultColumn;
+function isPivotGrandTotalColumn(columnId) {
+    return columnId?.startsWith(GeneralConstants.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN);
+}
+exports.isPivotGrandTotalColumn = isPivotGrandTotalColumn;
 class ColumnApiImpl extends ApiBase_1.ApiBase {
     constructor(_adaptable) {
         super(_adaptable);
@@ -146,7 +157,7 @@ class ColumnApiImpl extends ApiBase_1.ApiBase {
         return isAutoRowGroupColumn(columnId);
     }
     isPivotResultColumn(columnId) {
-        return isPivotResultColumn(columnId);
+        return isPivotResultColumn(columnId) || isPivotGrandTotalColumn(columnId);
     }
     isAutoRowGroupColumnForSingle(columnId) {
         return columnId === normalizeLayoutModel_1.GROUP_COLUMN_ID__SINGLE;

package/src/Api/Implementation/LayoutHelpers.js

@@ -209,12 +209,16 @@ const pivotLayoutToPivotLayoutModel = (pivotLayout) => {
         ColumnPinning: pivotLayout.ColumnPinning,
         PivotColumns: pivotLayout.PivotColumns,
         PivotExpandLevel: pivotLayout.PivotExpandLevel,
-        PivotAggregationColumns: (pivotLayout.PivotAggregationColumns || []).map(({ ColumnId, AggFunc }) => {
+        PivotAggregationColumns: (pivotLayout.PivotAggregationColumns || []).map(({ ColumnId, AggFunc, TotalColumn }) => {
             return {
                 ColumnId,
                 AggFunc: toAggFunc(AggFunc),
+                TotalColumn,
             };
         }),
+        GrandTotalRow: pivotLayout.GrandTotalRow,
+        GrandTotalColumn: pivotLayout.GrandTotalColumn,
+        PivotGroupTotalColumn: pivotLayout.PivotGroupTotalColumn,
         RowGroupValues: pivotLayout.RowGroupValues
             ? pivotLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-collapsed' ||
                 pivotLayout.RowGroupValues.RowGroupDefaultBehavior === 'always-expanded'
@@ -340,10 +344,29 @@ const pivotLayoutModelToPivotLayout = (layoutModel, defaults) => {
     else {
         delete pivotLayout.RowGroupValues;
     }
+    if (layoutModel.GrandTotalRow) {
+        pivotLayout.GrandTotalRow = layoutModel.GrandTotalRow;
+    }
+    else {
+        delete pivotLayout.GrandTotalRow;
+    }
+    if (layoutModel.GrandTotalColumn) {
+        pivotLayout.GrandTotalColumn = layoutModel.GrandTotalColumn;
+    }
+    else {
+        delete pivotLayout.GrandTotalColumn;
+    }
+    if (layoutModel.PivotGroupTotalColumn) {
+        pivotLayout.PivotGroupTotalColumn = layoutModel.PivotGroupTotalColumn;
+    }
+    else {
+        delete pivotLayout.PivotGroupTotalColumn;
+    }
     if (layoutModel.PivotAggregationColumns) {
-        pivotLayout.PivotAggregationColumns = (layoutModel.PivotAggregationColumns || []).map(({ ColumnId, AggFunc }) => ({
+        pivotLayout.PivotAggregationColumns = (layoutModel.PivotAggregationColumns || []).map(({ ColumnId, AggFunc, TotalColumn }) => ({
             ColumnId,
             AggFunc: toAggregationColumnValue(AggFunc),
+            TotalColumn,
         }));
     }
     else {

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

@@ -1,5 +1,5 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import { Column, IRowNode } from 'ag-grid-enterprise';
+import { Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
 import { CustomSort } from '../../AdaptableState/CustomSortState';
 import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
 import { AdaptableColumn } from '../../types';
@@ -31,4 +31,6 @@ export declare class ColumnInternalApi extends ApiBase {
     getAgGridColumnForAdaptableColumn(columnId: string): Column;
     getActiveColumnComparator(columnId: string, customSort?: CustomSort, customSortComparer?: ColumnValuesComparer): (valueA: any, valueB: any, nodeA?: IRowNode, nodeB?: IRowNode, isInverted?: boolean) => number | undefined;
     isSpecialColumn(columnId: string, column?: AdaptableColumn): boolean;
+    getColumnHeaderName(params: HeaderValueGetterParams): string;
+    private buildColumnHeaderContext;
 }

package/src/Api/Internal/ColumnInternalApi.js

@@ -6,6 +6,10 @@ const ApiBase_1 = require("../Implementation/ApiBase");
 const GeneralConstants_1 = require("../../Utilities/Constants/GeneralConstants");
 const uniq_1 = tslib_1.__importDefault(require("lodash/uniq"));
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
+const ColumnApiImpl_1 = require("../Implementation/ColumnApiImpl");
+const destructurePivotColumnId_1 = require("../../layout-manager/src/destructurePivotColumnId");
+const isPivotGroupTotalColumn_1 = require("../../layout-manager/src/isPivotGroupTotalColumn");
+const isPivotTotalColumn_1 = require("../../layout-manager/src/isPivotTotalColumn");
 function getAutoRowGroupColumnIdFor(columnId) {
     return `${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-${columnId}`;
 }
@@ -86,5 +90,202 @@ class ColumnInternalApi extends ApiBase_1.ApiBase {
                 this.getColumnApi().isActionColumn(columnId) ||
                 this.getColumnApi().isFdc3Column(columnId));
     }
+    getColumnHeaderName(params) {
+        // this is the same object, but casting it makes it easier to work with
+        const isColumn = !params.columnGroup;
+        const columnParams = params;
+        const isColumnGroup = !!params.columnGroup;
+        const columnGroupParams = params;
+        const defaultHeaderName = params.colDef?.headerName ??
+            (isColumn ? StringExtensions_1.default.CamelCaseToHumanText(columnParams.colDef?.field) : '') ??
+            '';
+        // for now we override ONLY the header names
+        if (params.location !== 'header') {
+            return defaultHeaderName;
+        }
+        // 1. Layout specific header has the highest priority
+        const layoutSpecificCustomHeader = this.getLayoutApi().getCurrentLayout().ColumnHeaders?.[isColumn ? columnParams.column.getColId() : columnGroupParams.columnGroup.getGroupId()];
+        if (layoutSpecificCustomHeader) {
+            return layoutSpecificCustomHeader;
+        }
+        // 2. check for custom ColumnOptions.columnHeader
+        if (typeof this.getColumnOptions().columnHeader === 'function') {
+            const columnHeaderContext = this.buildColumnHeaderContext(params, defaultHeaderName);
+            if (columnHeaderContext === 'skip') {
+                return defaultHeaderName;
+            }
+            const customHeader = this.getColumnOptions().columnHeader(columnHeaderContext);
+            return customHeader;
+        }
+        // 3. fallback to default header name
+        return defaultHeaderName;
+    }
+    buildColumnHeaderContext(params, defaultHeaderName) {
+        const currentLayoutType = this.getLayoutApi().isCurrentLayoutPivot() ? 'pivot' : 'table';
+        const currentLayout = this.getLayoutApi().getCurrentLayout();
+        const baseContext = {
+            ...this.getAdaptableApi().internalApi.buildBaseContext(),
+            defaultHeaderName,
+            currentLayout,
+            currentLayoutName: currentLayout.Name,
+            currentLayoutType: currentLayoutType,
+        };
+        // makes it easier to work with
+        const currentTableLayout = currentLayout;
+        const currentPivotLayout = currentLayout;
+        if (params.column?.getColId() === GeneralConstants_1.AG_GRID_GROUPED_COLUMN) {
+            const columnType = 'autoGroupColumn';
+            return {
+                ...baseContext,
+                columnType,
+                columnId: params.column.getColId(),
+                groupedColumnIds: currentLayoutType === 'table'
+                    ? currentTableLayout.RowGroupedColumns ?? []
+                    : currentPivotLayout.PivotGroupedColumns ?? [],
+            };
+        }
+        if (params.column?.getColId().startsWith(`${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-`)) {
+            const columnType = 'groupColumn';
+            const columnId = params.column.getColId();
+            // remove `${AG_GRID_GROUPED_COLUMN}-` from beginning of columnId
+            const groupColumnId = columnId.substring(`${GeneralConstants_1.AG_GRID_GROUPED_COLUMN}-`.length);
+            return {
+                ...baseContext,
+                columnType,
+                columnId,
+                groupColumnId,
+            };
+        }
+        if (baseContext.currentLayoutType === 'table') {
+            if (params.columnGroup) {
+                const columnType = 'tableColumnGroup';
+                if (!params.colDef?.children) {
+                    // AG Grid created virtual column groups for all columns
+                    // we want to skip those
+                    return 'skip';
+                }
+                return {
+                    ...baseContext,
+                    columnType,
+                    groupId: params.columnGroup?.getGroupId(),
+                    childrenColumnIds: params.columnGroup
+                        ?.getChildren()
+                        .map((col) => {
+                        if (col.isColumn) {
+                            return col.getColId();
+                        }
+                    })
+                        .filter(Boolean),
+                    state: params.columnGroup?.isExpandable() && !params.columnGroup?.isExpanded()
+                        ? 'collapsed'
+                        : 'expanded',
+                };
+            }
+            if (params.column) {
+                const columnType = 'tableColumn';
+                return {
+                    ...baseContext,
+                    columnType,
+                    columnId: params.column?.getColId(),
+                    aggregation: params.column.getAggFunc(),
+                };
+            }
+        }
+        if (baseContext.currentLayoutType === 'pivot') {
+            if (params.columnGroup) {
+                if (!params.colDef?.pivotKeys) {
+                    // we might have user defined colGroups, but we are not interested in them in pivot mode
+                    return 'skip';
+                }
+                const columnType = 'pivotColumnGroup';
+                return {
+                    ...baseContext,
+                    columnType,
+                    groupId: params.columnGroup?.getGroupId(),
+                    pivotKeys: params.colDef.pivotKeys,
+                    state: params.columnGroup?.isExpandable() && !params.columnGroup?.isExpanded()
+                        ? 'collapsed'
+                        : 'expanded',
+                };
+            }
+            if (params.column) {
+                let columnId = params.column.getColId();
+                if ((0, ColumnApiImpl_1.isPivotGrandTotalColumn)(columnId)) {
+                    const columnType = 'pivotGrandTotal';
+                    const pivotValueCol = params.colDef.pivotValueColumn;
+                    const aggregatedColumnId = pivotValueCol?.getColId();
+                    const currentLayoutAggCols = currentPivotLayout.PivotAggregationColumns?.map((col) => col.ColumnId);
+                    if (!currentLayoutAggCols?.includes(aggregatedColumnId)) {
+                        // this column is not an aggregation column
+                        return 'skip';
+                    }
+                    return {
+                        ...baseContext,
+                        columnType,
+                        aggregatedColumnId,
+                        aggregation: pivotValueCol.getAggFunc(),
+                    };
+                }
+                if ((0, isPivotGroupTotalColumn_1.isPivotGroupTotalColumn)(params.colDef)) {
+                    const columnType = 'pivotGroupTotal';
+                    const pivotColInfo = (0, destructurePivotColumnId_1.destructurePivotColumnId)(params.colDef, {
+                        pivotColIds: currentPivotLayout.PivotColumns,
+                        aggColIds: currentPivotLayout.PivotAggregationColumns.map((col) => col.ColumnId),
+                    }, (message) => this.logWarn(message));
+                    if (pivotColInfo === '!unknown!') {
+                        return 'skip';
+                    }
+                    const pivotKey = pivotColInfo.pivotKeys[pivotColInfo.pivotKeys.length - 1];
+                    return {
+                        ...baseContext,
+                        columnType,
+                        pivotKey,
+                        pivotColumnId: pivotColInfo.pivotColumnId,
+                        aggregation: params.colDef?.pivotValueColumn?.getAggFunc(),
+                    };
+                }
+                if ((0, isPivotTotalColumn_1.isPivotTotalColumn)(params.colDef)) {
+                    const columnType = 'pivotAggregationTotal';
+                    const pivotValueCol = params.colDef.pivotValueColumn;
+                    const pivotColInfo = (0, destructurePivotColumnId_1.destructurePivotColumnId)(params.colDef, {
+                        pivotColIds: currentPivotLayout.PivotColumns,
+                        aggColIds: currentPivotLayout.PivotAggregationColumns.map((col) => col.ColumnId),
+                    }, (message) => this.logWarn(message));
+                    if (pivotColInfo === '!unknown!') {
+                        return 'skip';
+                    }
+                    const pivotKey = pivotColInfo.pivotKeys[pivotColInfo.pivotKeys.length - 1];
+                    return {
+                        ...baseContext,
+                        columnType,
+                        aggregatedColumnId: pivotValueCol?.getColId(),
+                        aggregation: pivotValueCol.getAggFunc(),
+                        pivotColumnId: pivotColInfo.pivotColumnId,
+                        pivotKey,
+                    };
+                }
+                if ((0, ColumnApiImpl_1.isPivotResultColumn)(columnId)) {
+                    const columnType = 'pivotAggregationColumn';
+                    const pivotValueCol = params.colDef.pivotValueColumn;
+                    const aggregatedColumnId = pivotValueCol?.getColId();
+                    const currentLayoutAggCols = currentPivotLayout.PivotAggregationColumns?.map((col) => col.ColumnId);
+                    if (!currentLayoutAggCols?.includes(aggregatedColumnId)) {
+                        // this column is not an aggregation column
+                        return 'skip';
+                    }
+                    return {
+                        ...baseContext,
+                        columnType,
+                        columnId,
+                        pivotKeys: params.colDef.pivotKeys,
+                        aggregatedColumnId,
+                        aggregation: pivotValueCol.getAggFunc(),
+                    };
+                }
+            }
+        }
+        // if nothing matched, we skip this column[group]
+        return 'skip';
+    }
 }
 exports.ColumnInternalApi = ColumnInternalApi;

package/src/Utilities/Constants/GeneralConstants.d.ts

@@ -24,6 +24,7 @@ export declare const GROUP_PATH_SEPARATOR: string;
 export declare const AG_GRID_GROUPED_COLUMN: string;
 export declare const AG_GRID_SELECTION_COLUMN: string;
 export declare const AG_GRID_PIVOT_COLUMN: string;
+export declare const AG_GRID_PIVOT_GRAND_TOTAL_COLUMN: string;
 export declare const AG_GRID_CHART_WINDOW = "AG Grid Window";
 export declare const ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = "(FDC3ActionColumn)";
 export declare const DEFAULT_DATE_FORMAT_PATTERN = "dd-MM-yyyy";

package/src/Utilities/Constants/GeneralConstants.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LAYOUT_NEW_PIVOT_TOOLTIP = exports.LAYOUT_NEW_TABLE_TOOLTIP = exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_SELECTION_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
-exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = void 0;
+exports.LAYOUT_NEW_TABLE_TOOLTIP = exports.THEME_STYLE = exports.SYSTEM_EXPORT_DESTINATIONS = exports.CLIPBOARD_EXPORT_DESTINATION = exports.DOWNLOAD_EXPORT_DESTINATION = exports.SELECT_REPORT_FORMAT_STRING = exports.SELECT_REPORT_STRING = exports.SYSTEM_REPORT_FORMATS = exports.JSON_FORMAT_REPORT = exports.CSV_FORMAT_REPORT = exports.VISUAL_EXCEL_FORMAT_REPORT = exports.EXCEL_FORMAT_REPORT = exports.SYSTEM_REPORT_NAMES = exports.SELECTED_DATA_REPORT = exports.CURRENT_LAYOUT_REPORT = exports.ALL_DATA_REPORT = exports.SERVER_VALIDATION_MESSAGE_TYPE = exports.SERVER_VALIDATION_HEADER = exports.DEFAULT_LIVE_REPORT_THROTTLE_TIME = exports.MENU_SEPARATOR = exports.QUICK_SEARCH_DEBOUNCE_TIME = exports.DEFAULT_DOUBLE_DISPLAY_VALUE = exports.DEFAULT_INTEGER_DISPLAY_VALUE = exports.DEFAULT_STRING_DISPLAY_VALUE = exports.DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME = exports.DEFAULT_DATE_FORMAT_PATTERN = exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = exports.AG_GRID_CHART_WINDOW = exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = exports.AG_GRID_PIVOT_COLUMN = exports.AG_GRID_SELECTION_COLUMN = exports.AG_GRID_GROUPED_COLUMN = exports.GROUP_PATH_SEPARATOR = exports.QUARTER_SECOND = exports.HALF_SECOND = exports.EMPTY_ARRAY = exports.EMPTY_STRING = exports.READ_ONLY_STYLE = exports.AGGRID_TOOLPANEL_COLUMNS = exports.AGGRID_TOOLPANEL_FILTERS = exports.ADAPTABLE_TOOLPANEL_COMPONENT = exports.ADAPTABLE_TOOLPANEL_ID = exports.ADAPTABLE_ID = exports.ADAPTABLE = exports.ERROR_LAYOUT = exports.OS_THEME = exports.DARK_THEME = exports.LIGHT_THEME = exports.MISSING_COLUMN = exports.AUTOGENERATED_PK_COLUMN = void 0;
+exports.OBSERVABLE_EXPRESSION_ROW_REMOVED = exports.OBSERVABLE_EXPRESSION_ROW_ADDED = exports.STANDALONE_MODULE_POPUPS = exports.LAYOUT_DELETE_TOOLTIP = exports.LAYOUT_CLONE_TOOLTIP = exports.LAYOUT_EDIT_TOOLTIP = exports.LAYOUT_SAVE_TOOLTIP = exports.LAYOUT_NEW_TABLE_OR_PIVOT_TOOLTIP = exports.LAYOUT_NEW_PIVOT_TOOLTIP = void 0;
 exports.AUTOGENERATED_PK_COLUMN = '__ADAPTABLE_PK__';
 exports.MISSING_COLUMN = ' [MISSING]';
 exports.LIGHT_THEME = 'light';
@@ -27,6 +27,7 @@ exports.GROUP_PATH_SEPARATOR = '/';
 exports.AG_GRID_GROUPED_COLUMN = 'ag-Grid-AutoColumn';
 exports.AG_GRID_SELECTION_COLUMN = 'ag-Grid-SelectionColumn';
 exports.AG_GRID_PIVOT_COLUMN = 'pivot_';
+exports.AG_GRID_PIVOT_GRAND_TOTAL_COLUMN = 'PivotRowTotal_pivot_';
 exports.AG_GRID_CHART_WINDOW = 'AG Grid Window';
 exports.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME = '(FDC3ActionColumn)';
 // FIXME AFL - load this from DateInputOptions

package/src/Utilities/Extensions/StringExtensions.js

@@ -35,13 +35,21 @@ function IsNotNullOrEmptyOrWhiteSpace(stringToCheck) {
     return !IsNullOrEmptyOrWhiteSpace(stringToCheck);
 }
 exports.IsNotNullOrEmptyOrWhiteSpace = IsNotNullOrEmptyOrWhiteSpace;
-// from https://stackoverflow.com/questions/15369566/putting-space-in-camel-case-string-using-regular-expression
+// clone of A Grid's implementation
+// https://github.com/ag-grid/ag-grid/blob/a5c3d9f56350271ab7e8d42d72aaf5314672719a/packages/ag-grid-community/src/columns/columnNameService.ts#L14
 function CamelCaseToHumanText(camelCase) {
     if (!camelCase || camelCase == null) {
         return null;
     }
-    const rex = /([A-Z])([A-Z])([a-z])|([a-z])([A-Z])/g;
-    const words = camelCase.replace(rex, '$1$4 $2$3$5').replace('.', ' ').split(' ');
+    // either split on a lowercase followed by uppercase ie  asHereTo -> as Here To
+    const rex = /([a-z])([A-Z])/g;
+    // or starts with uppercase and we take all expect the last which is assumed to be part of next word if followed by lowercase HEREToThere -> HERE To There
+    const rexCaps = /([A-Z]+)([A-Z])([a-z])/g;
+    const words = camelCase
+        .replace(rex, '$1 $2')
+        .replace(rexCaps, '$1 $2$3')
+        .replace(/\./g, ' ')
+        .split(' ');
     return words
         .map((word) => word.substring(0, 1).toUpperCase() + (word.length > 1 ? word.substring(1, word.length) : ''))
         .join(' ');

package/src/Utilities/adaptableOverrideCheck.d.ts

@@ -0,0 +1,2 @@
+export declare function tagProvidedByAdaptable(fn: any): any;
+export declare function isProvidedByAdaptable(fn: any): boolean;

package/src/Utilities/adaptableOverrideCheck.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isProvidedByAdaptable = exports.tagProvidedByAdaptable = void 0;
+const PROVIDED_BY_ADAPTABLE = Symbol('isProvidedByAdaptable');
+function tagProvidedByAdaptable(fn) {
+    fn[PROVIDED_BY_ADAPTABLE] = true;
+    return fn;
+}
+exports.tagProvidedByAdaptable = tagProvidedByAdaptable;
+function isProvidedByAdaptable(fn) {
+    return fn && !!fn[PROVIDED_BY_ADAPTABLE];
+}
+exports.isProvidedByAdaptable = isProvidedByAdaptable;