@adaptabletools/adaptable-cjs 20.3.0 → 21.0.0-canary.1

package/src/Strategy/StyledColumnModule.d.ts

@@ -6,11 +6,10 @@ import { AdaptableModuleView, AdaptableObjectView, IModule } from './Interface/I
 import { AdaptableApi } from '../Api/AdaptableApi';
 import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { StyledColumn } from '../AdaptableState/StyledColumnState';
+import { LayoutExtendedConfig } from '../types';
 export declare class StyledColumnModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    getModuleAdaptableObjects(config?: {
-        includeLayoutNotAssociatedObjects?: boolean;
-    }): AdaptableObject[];
+    getModuleAdaptableObjects(config?: LayoutExtendedConfig): AdaptableObject[];
     getExplicitlyReferencedColumnIds(styledColumn: StyledColumn): string[];
     hasNamedQueryReferences(): boolean;
     createColumnMenuItems(column: AdaptableColumn): AdaptableMenuItem<"separator" | "calculated-column-edit" | "cell-summary-show" | "chart-show" | "column-group" | "column-filter-group" | "column-filter-bar-hide" | "column-filter-bar-show" | "column-filter-clear" | "column-filter-suspend" | "column-filter-unsuspend" | "column-info-show" | "custom-sort-add" | "custom-sort-edit" | "dashboard-group" | "dashboard-collapse" | "dashboard-configure" | "dashboard-dock" | "dashboard-expand" | "dashboard-float" | "dashboard-hide" | "dashboard-show" | "data-import" | "flashing-cell-add" | "flashing-cell-delete" | "format-column-add" | "format-column-edit" | "free-text-column-edit" | "grid-group" | "grid-info-show" | "layout-column-caption-change" | "layout-column-hide" | "layout-edit" | "layout-column-select" | "layout-column-select-preserve" | "layout-column-select-reset" | "layout-grid-select" | "plus-minus-add" | "settings-panel-open" | "styling-group" | "styled-column-badge-add" | "styled-column-badge-edit" | "styled-column-gradient-add" | "styled-column-gradient-edit" | "styled-column-percent-bar-add" | "styled-column-percent-bar-edit" | "styled-column-sparkline-add" | "styled-column-sparkline-edit" | "system-status-show" | "_navbar">[];
@@ -19,7 +18,7 @@ export declare class StyledColumnModule extends AdaptableModuleBase implements I
     toView(styledColumn: StyledColumn): AdaptableObjectView;
     toViewAll(): AdaptableObjectView[];
     getViewProperties(): AdaptableModuleView;
-    canBeAssociatedWithLayouts(): boolean;
+    containsLayoutExtensions(): boolean;
     private getTypeLabel;
     private getTypeName;
 }

package/src/Strategy/StyledColumnModule.js

@@ -230,7 +230,7 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     }
     toViewAll() {
         return this.getModuleAdaptableObjects({
-            includeLayoutNotAssociatedObjects: this.showLayoutNotAssociatedObjects(),
+            includeLayoutNotExtendedObjects: this.showLayoutNonExtendedObjects(),
         }).map((styledColumn) => this.toView(styledColumn));
     }
     getViewProperties() {
@@ -246,7 +246,7 @@ class StyledColumnModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             },
         };
     }
-    canBeAssociatedWithLayouts() {
+    containsLayoutExtensions() {
         return true;
     }
     getTypeLabel(styledColumn) {

package/src/Strategy/SystemStatusModule.js

@@ -10,7 +10,7 @@ class SystemStatusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         super(ModuleConstants.SystemStatusModuleId, ModuleConstants.SystemStatusFriendlyName, 'traffic-lights', 'SystemStatusPopup', 'Provide messages about the Status of your application', api);
     }
     createColumnMenuItems(column) {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             return [
                 this.createMenuItemShowPopup('system-status-show', 'Show System Status', this.moduleInfo.Popup, this.moduleInfo.Glyph, {
                     source: 'ColumnMenu',
@@ -19,7 +19,7 @@ class SystemStatusModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
     }
     createContextMenuItems(menuContext) {
-        if (this.isModuleAvailable()) {
+        if (this.isModuleVisible()) {
             let popUpParams = {
                 source: 'ContextMenu',
             };

package/src/Strategy/TeamSharingModule.d.ts

@@ -6,7 +6,7 @@ export declare class TeamSharingModule extends AdaptableModuleBase implements IM
     private SKIP_TEAMSHARING_UPDATE_ACTIONS;
     constructor(api: AdaptableApi);
     onAdaptableReady(): void;
-    isModuleAvailable(): boolean;
+    isModuleEnabled(): boolean;
     isModuleObjectsShareable(): boolean;
     getPopupMaxWidth(): number | undefined;
     private handleStateChanged;

package/src/Strategy/TeamSharingModule.js

@@ -36,8 +36,11 @@ class TeamSharingModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
         this.api.eventApi.on('AdaptableStateChanged', (adaptableStateChangedInfo) => this.handleStateChanged(adaptableStateChangedInfo));
     }
-    isModuleAvailable() {
-        return super.isModuleAvailable() && this.api.teamSharingApi.isTeamSharingAvailable();
+    isModuleEnabled() {
+        const teamSharingOptions = this.api.optionsApi.getTeamSharingOptions();
+        return (teamSharingOptions?.enableTeamSharing &&
+            typeof teamSharingOptions?.loadSharedEntities === 'function' &&
+            typeof teamSharingOptions?.persistSharedEntities === 'function');
     }
     isModuleObjectsShareable() {
         return false;

package/src/Strategy/ToolPanelModule.d.ts

@@ -3,5 +3,5 @@ import { IModule } from './Interface/IModule';
 import { AdaptableApi } from '../Api/AdaptableApi';
 export declare class ToolPanelModule extends AdaptableModuleBase implements IModule {
     constructor(api: AdaptableApi);
-    isModuleAvailable(): boolean;
+    isModuleEnabled(): boolean;
 }

package/src/Strategy/ToolPanelModule.js

@@ -8,10 +8,7 @@ class ToolPanelModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ToolPanelModuleId, ModuleConstants.ToolPanelFriendlyName, 'clipboard', 'ToolPanelPopup', 'An alternative to using the Dashboard is the AdapTable Tool Panel, the Tool Panel is the collapsible area to the right of the Grid.', api);
     }
-    isModuleAvailable() {
-        if (!super.isModuleAvailable()) {
-            return false;
-        }
+    isModuleEnabled() {
         return this.api.internalApi.getAdaptableInstance().hasAdaptableToolPanel;
     }
 }

package/src/Strategy/Utilities/Layout/getLayoutFilterViewItems.js

@@ -10,7 +10,7 @@ const getFilterPreview = (columnFilter, api) => {
     const columnType = api.columnApi.getColumnDataTypeForColumnId(columnFilter.ColumnId);
     const qlDataType = (0, adaptableQlUtils_1.mapColumnDataTypeToExpressionFunctionType)(columnType);
     const qlPredicateDefs = predicateDefs.map((pd) => (0, utils_1.mapAdaptablePredicateDefToQlPredicateDef)(pd, qlDataType));
-    const qlPredicate = (0, utils_1.mapColumnFilterToQlPredicate)(columnFilter, column, qlPredicateDefs, columnFilterOptions, api);
+    const qlPredicate = (0, utils_1.mapColumnFilterToQlPredicate)(columnFilter, column, qlPredicateDefs, columnFilterOptions, 'FilterForm', api);
     return `[${(0, utils_1.qlPredicateToString)(qlPredicate, qlPredicateDefs)}]`;
 };
 exports.getFilterPreview = getFilterPreview;

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

@@ -14,3 +14,4 @@ export declare const AdaptableOptionsDocsLink = "https://docs.adaptabletools.com
 export declare const AgGridModulesDocsLink = "https://docs.adaptabletools.com/guide/dev-guide-aggrid-modules-overview";
 export declare const AlertMessageDocsLink = "https://docs.adaptabletools.com/guide/handbook-alerting-message";
 export declare const FormatColumnPlaceholderDocsLink = "https://docs.adaptabletools.com/guide/handbook-column-formatting-display-format-placeholder";
+export declare const AgGridRequiredModulesDocsLink = "https://docs.adaptabletools.com/guide/dev-guide-aggrid-modules-overview#mandatory-modules";

package/src/Utilities/Constants/DocumentationLinkConstants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormatColumnPlaceholderDocsLink = exports.AlertMessageDocsLink = exports.AgGridModulesDocsLink = exports.AdaptableOptionsDocsLink = exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.QuantileAggregatedScalarQueryDocsLink = exports.CumulativeAggregatedScalarQueryDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
+exports.AgGridRequiredModulesDocsLink = exports.FormatColumnPlaceholderDocsLink = exports.AlertMessageDocsLink = exports.AgGridModulesDocsLink = exports.AdaptableOptionsDocsLink = exports.LicenseDocsLink = exports.PrimaryKeyDocsLink = exports.PredicateDocsLink = exports.QuantileAggregatedScalarQueryDocsLink = exports.CumulativeAggregatedScalarQueryDocsLink = exports.AggregatedScalarQueryDocsLink = exports.AggregatedBooleanQueryDocsLink = exports.ObservableQueryDocsLink = exports.ScalarQueryDocsLink = exports.BooleanQueryDocsLink = exports.ExpressionEditorDocsLink = exports.HOST_URL_DOCS = void 0;
 exports.HOST_URL_DOCS = 'https://docs.adaptabletools.com';
 //export const HOST_URL_DOCS = 'http://localhost:3000';
 exports.ExpressionEditorDocsLink = `${exports.HOST_URL_DOCS}/guide/ui-expression-editor`;
@@ -18,3 +18,4 @@ exports.AdaptableOptionsDocsLink = `${exports.HOST_URL_DOCS}/guide/reference-opt
 exports.AgGridModulesDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-aggrid-modules-overview`;
 exports.AlertMessageDocsLink = `${exports.HOST_URL_DOCS}/guide/handbook-alerting-message`;
 exports.FormatColumnPlaceholderDocsLink = `${exports.HOST_URL_DOCS}/guide/handbook-column-formatting-display-format-placeholder`;
+exports.AgGridRequiredModulesDocsLink = `${exports.HOST_URL_DOCS}/guide/dev-guide-aggrid-modules-overview#mandatory-modules`;

package/src/Utilities/Extensions/ArrayExtensions.d.ts

@@ -25,11 +25,23 @@ export declare function moveArray(array: any[], from: number, to: number): void;
 export declare function areArraysEqual(arr1: any[], arr2: any[]): boolean;
 export declare function areArraysNotEqual(arr1: any[], arr2: any[]): boolean;
 export declare function areArraysEqualWithOrder(arr1: any[], arr2: any[]): boolean;
-export declare function areArraysEqualWithOrderandProperties(value: any[], other: any[]): boolean;
+/**
+ * Checks if two arrays contain the same elements (order-independent).
+ *
+ * @param arr1 First array to compare
+ * @param arr2 Second array to compare
+ * @param equalityFn Optional function to determine if two elements are equal
+ * @returns True if arrays contain the same elements, false otherwise
+ */
+export declare function areArraysEqualWithCustomComparator<T>(arr1: T[] | null | undefined, arr2: T[] | null | undefined, equalityFn?: (a: T, b: T) => boolean): boolean;
+export declare function areArraysEqualWithOrderAndProperties(value: any[], other: any[]): boolean;
 export declare function sortArrayWithProperty(sortOrder: SortOrder, values: any[], sortProperty?: string): any[];
 export declare function sortArray(values: any[], sortOrder?: SortOrder): any[];
+export declare const getGenericComparatorForGridCell: (sortOrder: SortOrder) => (a: GridCell, b: GridCell) => number;
 export declare function sortCellValueArray<T extends GridCell>(cellValues: T[], sortOrder?: SortOrder): T[];
+export declare const getNumericComparatorForGridCell: (sortOrder: SortOrder) => (a: GridCell, b: GridCell) => number;
 export declare function sortCellValueArrayNumeric<T extends GridCell>(cellValues: T[], sortOrder?: SortOrder): T[];
+export declare const getDateComparatorForGridCell: (sortOrder: SortOrder) => (a: GridCell, b: GridCell) => number;
 export declare function sortCellValueArrayDates<T extends GridCell>(cellValues: T[], sortOrder?: SortOrder): T[];
 export declare function groupArrayBy(array: Array<any>, prop: string): Array<any>;
 export declare function createCommaSeparatedString(values: any[]): string;
@@ -72,7 +84,8 @@ export declare const ArrayExtensions: {
     areArraysEqual: typeof areArraysEqual;
     areArraysNotEqual: typeof areArraysNotEqual;
     areArraysEqualWithOrder: typeof areArraysEqualWithOrder;
-    areArraysEqualWithOrderandProperties: typeof areArraysEqualWithOrderandProperties;
+    areArraysEqualWithOrderAndProperties: typeof areArraysEqualWithOrderAndProperties;
+    areArraysEqualWithCustomComparator: typeof areArraysEqualWithCustomComparator;
     sortArray: typeof sortArray;
     sortCellValueArray: typeof sortCellValueArray;
     sortCellValueArrayNumeric: typeof sortCellValueArrayNumeric;

package/src/Utilities/Extensions/ArrayExtensions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArrayExtensions = exports.sortArrayWithOrder = exports.reorderArray = exports.SumArray = exports.createCommaSeparatedString = exports.groupArrayBy = exports.sortCellValueArrayDates = exports.sortCellValueArrayNumeric = exports.sortCellValueArray = exports.sortArray = exports.sortArrayWithProperty = exports.areArraysEqualWithOrderandProperties = exports.areArraysEqualWithOrder = exports.areArraysNotEqual = exports.areArraysEqual = exports.moveArray = exports.hasItemsOfCount = exports.hasOneItem = exports.getOccurrence = exports.HasSingleEmptyValue = exports.IsNotNullOrEmptyNorContainsSingleEmptyValue = exports.IsNullOrEmptyOrContainsSingleEmptyValue = exports.IsNotNullOrEmpty = exports.IsNullOrEmpty = exports.IsNotEmpty = exports.IsEmpty = exports.IsNotNull = exports.IsNull = exports.RetrieveDistinct = exports.NotContainsItem = exports.ContainsAnyItem = exports.ContainsItem = exports.AddItem = exports.NotCorrectLength = exports.CorrectLength = exports.GetLength = void 0;
+exports.ArrayExtensions = exports.sortArrayWithOrder = exports.reorderArray = exports.SumArray = exports.createCommaSeparatedString = exports.groupArrayBy = exports.sortCellValueArrayDates = exports.getDateComparatorForGridCell = exports.sortCellValueArrayNumeric = exports.getNumericComparatorForGridCell = exports.sortCellValueArray = exports.getGenericComparatorForGridCell = exports.sortArray = exports.sortArrayWithProperty = exports.areArraysEqualWithOrderAndProperties = exports.areArraysEqualWithCustomComparator = exports.areArraysEqualWithOrder = exports.areArraysNotEqual = exports.areArraysEqual = exports.moveArray = exports.hasItemsOfCount = exports.hasOneItem = exports.getOccurrence = exports.HasSingleEmptyValue = exports.IsNotNullOrEmptyNorContainsSingleEmptyValue = exports.IsNullOrEmptyOrContainsSingleEmptyValue = exports.IsNotNullOrEmpty = exports.IsNullOrEmpty = exports.IsNotEmpty = exports.IsEmpty = exports.IsNotNull = exports.IsNull = exports.RetrieveDistinct = exports.NotContainsItem = exports.ContainsAnyItem = exports.ContainsItem = exports.AddItem = exports.NotCorrectLength = exports.CorrectLength = exports.GetLength = void 0;
 const Enums_1 = require("../../AdaptableState/Common/Enums");
 function GetLength(arrayToCheck) {
     return IsNotNull(arrayToCheck) ? arrayToCheck.length : 0;
@@ -141,7 +141,43 @@ function areArraysEqualWithOrder(arr1, arr2) {
     return arr1.every((x, index) => arr2.indexOf(x) == index);
 }
 exports.areArraysEqualWithOrder = areArraysEqualWithOrder;
-function areArraysEqualWithOrderandProperties(value, other) {
+/**
+ * Checks if two arrays contain the same elements (order-independent).
+ *
+ * @param arr1 First array to compare
+ * @param arr2 Second array to compare
+ * @param equalityFn Optional function to determine if two elements are equal
+ * @returns True if arrays contain the same elements, false otherwise
+ */
+function areArraysEqualWithCustomComparator(arr1, arr2, equalityFn) {
+    // Handle null/undefined cases
+    if (!arr1 && !arr2) {
+        return true;
+    }
+    if (!arr1 || !arr2) {
+        return false;
+    }
+    // Check length
+    if (arr1.length !== arr2.length) {
+        return false;
+    }
+    // Use default equality comparison if no custom function provided
+    const compareElements = equalityFn || ((a, b) => a === b);
+    // For each element in arr1, find a matching element in arr2
+    const arr2Copy = [...arr2];
+    for (let i = 0; i < arr1.length; i++) {
+        const element = arr1[i];
+        const matchIndex = arr2Copy.findIndex((el) => compareElements(element, el));
+        if (matchIndex === -1) {
+            return false;
+        }
+        // Remove the matched element to prevent duplicate matches
+        arr2Copy.splice(matchIndex, 1);
+    }
+    return true;
+}
+exports.areArraysEqualWithCustomComparator = areArraysEqualWithCustomComparator;
+function areArraysEqualWithOrderAndProperties(value, other) {
     const type = Object.prototype.toString.call(value);
     // If the two objects are not the same type, return false
     if (type !== Object.prototype.toString.call(other)) {
@@ -163,7 +199,7 @@ function areArraysEqualWithOrderandProperties(value, other) {
         const itemType = Object.prototype.toString.call(item1);
         // If an object or array, compare recursively
         if (['[object Array]', '[object Object]'].indexOf(itemType) >= 0) {
-            if (!areArraysEqualWithOrderandProperties(item1, item2)) {
+            if (!areArraysEqualWithOrderAndProperties(item1, item2)) {
                 return false;
             }
         }
@@ -207,7 +243,7 @@ function areArraysEqualWithOrderandProperties(value, other) {
     // If nothing failed, return true
     return true;
 }
-exports.areArraysEqualWithOrderandProperties = areArraysEqualWithOrderandProperties;
+exports.areArraysEqualWithOrderAndProperties = areArraysEqualWithOrderAndProperties;
 function sortArrayWithProperty(sortOrder, values, sortProperty) {
     if (sortProperty) {
         let newValues = [].concat(values);
@@ -241,16 +277,22 @@ function sortArray(values, sortOrder = Enums_1.SortOrder.Asc) {
     return newValues.sort((a, b) => (a < b ? -1 * direction : a > b ? 1 * direction : 0));
 }
 exports.sortArray = sortArray;
+const getGenericComparatorForGridCell = (sortOrder) => {
+    const direction = sortOrder == Enums_1.SortOrder.Asc ? 1 : -1;
+    return (a, b) => {
+        return a.rawValue < b.rawValue ? -1 * direction : a.rawValue > b.rawValue ? 1 * direction : 0;
+    };
+};
+exports.getGenericComparatorForGridCell = getGenericComparatorForGridCell;
 function sortCellValueArray(cellValues, sortOrder = Enums_1.SortOrder.Asc) {
     const newValues = [].concat(cellValues);
-    const direction = sortOrder == Enums_1.SortOrder.Asc ? 1 : -1;
-    return newValues.sort((a, b) => a.rawValue < b.rawValue ? -1 * direction : a.rawValue > b.rawValue ? 1 * direction : 0);
+    const comparator = (0, exports.getGenericComparatorForGridCell)(sortOrder);
+    return newValues.sort(comparator);
 }
 exports.sortCellValueArray = sortCellValueArray;
-function sortCellValueArrayNumeric(cellValues, sortOrder = Enums_1.SortOrder.Asc) {
+const getNumericComparatorForGridCell = (sortOrder) => {
     const direction = sortOrder == Enums_1.SortOrder.Asc ? 1 : -1;
-    const newValues = [].concat(cellValues);
-    return newValues.sort((a, b) => {
+    return (a, b) => {
         const valueAAsNumber = Number(a.rawValue);
         const valueBAsNumber = Number(b.rawValue);
         if (isNaN(valueAAsNumber)) {
@@ -264,16 +306,26 @@ function sortCellValueArrayNumeric(cellValues, sortOrder = Enums_1.SortOrder.Asc
             : valueAAsNumber > valueBAsNumber
                 ? 1 * direction
                 : 0;
-    });
+    };
+};
+exports.getNumericComparatorForGridCell = getNumericComparatorForGridCell;
+function sortCellValueArrayNumeric(cellValues, sortOrder = Enums_1.SortOrder.Asc) {
+    const newValues = [].concat(cellValues);
+    const comparator = (0, exports.getNumericComparatorForGridCell)(sortOrder);
+    return newValues.sort(comparator);
 }
 exports.sortCellValueArrayNumeric = sortCellValueArrayNumeric;
-function sortCellValueArrayDates(cellValues, sortOrder = Enums_1.SortOrder.Asc) {
-    cellValues.sort((a, b) => {
+const getDateComparatorForGridCell = (sortOrder) => {
+    return (a, b) => {
         return sortOrder == Enums_1.SortOrder.Asc
             ? +new Date(a.rawValue) - +new Date(b.rawValue)
             : +new Date(b.rawValue) - +new Date(a.rawValue);
-    });
-    return cellValues;
+    };
+};
+exports.getDateComparatorForGridCell = getDateComparatorForGridCell;
+function sortCellValueArrayDates(cellValues, sortOrder = Enums_1.SortOrder.Asc) {
+    const comparator = (0, exports.getDateComparatorForGridCell)(sortOrder);
+    return [].concat(cellValues).sort(comparator);
 }
 exports.sortCellValueArrayDates = sortCellValueArrayDates;
 function groupArrayBy(array, prop) {
@@ -384,7 +436,8 @@ exports.ArrayExtensions = {
     areArraysEqual,
     areArraysNotEqual,
     areArraysEqualWithOrder,
-    areArraysEqualWithOrderandProperties,
+    areArraysEqualWithOrderAndProperties,
+    areArraysEqualWithCustomComparator,
     sortArray,
     sortCellValueArray,
     sortCellValueArrayNumeric,

package/src/Utilities/Helpers/AdaptableHelper.d.ts

@@ -14,6 +14,7 @@ export declare const AdaptableHelper: {
     addAdaptableObjectPrimitives: typeof addAdaptableObjectPrimitives;
     removeAdaptableObjectPrimitives: typeof removeAdaptableObjectPrimitives;
     removeAdaptableObjectPrimitivesInline: typeof removeAdaptableObjectPrimitivesInline;
+    removeAdaptableObjectPrimitivesInlineDeep: typeof removeAdaptableObjectPrimitivesInlineDeep;
     isAdaptableObject: typeof isAdaptableObject;
 };
 export default AdaptableHelper;

package/src/Utilities/Helpers/AdaptableHelper.js

@@ -117,6 +117,7 @@ exports.AdaptableHelper = {
     addAdaptableObjectPrimitives,
     removeAdaptableObjectPrimitives,
     removeAdaptableObjectPrimitivesInline,
+    removeAdaptableObjectPrimitivesInlineDeep,
     isAdaptableObject,
 };
 exports.default = exports.AdaptableHelper;

package/src/Utilities/ObjectFactory.d.ts

@@ -23,7 +23,7 @@ import { NotificationsOptions } from '../AdaptableOptions/NotificationsOptions';
 import { CellSummmaryInfo } from '../AdaptableState/Common/CellSummary';
 import { AdaptableTheme, ChartDefinition, ColumnFilter, CommentThread, CustomDisplayFormatterContext, FlashingCellDefinition, RowDataChangedInfo, SpecialColumnSettings, SystemFilterPredicateId } from '../types';
 import { IRowNode } from 'ag-grid-enterprise';
-import { AdaptableApi, AdaptableComment, BadgeStyleDefinition, CellAddress, NamedQuery, PivotLayout } from '../../types';
+import { AdaptableApi, AdaptableComment, BadgeStyleDefinition, CellAddress, NamedQuery, PivotLayout, TableLayout } from '../../types';
 import { ToastOptions } from '../components/Toastify';
 import { StyledColumn } from '../AdaptableState/StyledColumnState';
 export declare function CreateEmptyCustomSort(): CustomSort;
@@ -51,12 +51,15 @@ export declare function CreateEmptySchedule(): Schedule;
 export declare function CreateEmptyShortcut(): Shortcut;
 export declare function CreateEmptyFormatColumn(): FormatColumn;
 export declare function CreateEmptyFreeTextColumn(defaultSpecialColumnSettings: Partial<SpecialColumnSettings>): FreeTextColumn;
-export declare function CreateEmptyPivotLayout(layout?: Partial<PivotLayout> & {
+export declare function CreateEmptyPivotLayout(pivotLayout?: Partial<PivotLayout> & {
     Name: string;
 }): PivotLayout;
+export declare function CreateEmptyTableLayout(tableLayout?: Partial<TableLayout> & {
+    Name: string;
+}): TableLayout;
 export declare function CreateEmptyLayout(layout?: Partial<Layout> & {
     Name: string;
-}, adaptableColumns?: AdaptableColumn[]): Layout;
+}): Layout;
 export declare function CreateEmptyStyle(): AdaptableStyle;
 export declare function CreateSystemStatusMessageInfo(message: string, type: AdaptableMessageType, furtherInfo?: string): SystemStatusMessageInfo;
 export declare function CreateEmptyCellSummmary(): CellSummmaryInfo;
@@ -100,6 +103,7 @@ export declare const ObjectFactory: {
     CreateEmptyFreeTextColumn: typeof CreateEmptyFreeTextColumn;
     CreateEmptyLayout: typeof CreateEmptyLayout;
     CreateEmptyPivotLayout: typeof CreateEmptyPivotLayout;
+    CreateEmptyTableLayout: typeof CreateEmptyTableLayout;
     CreateColumnFilter: typeof CreateColumnFilter;
     CreateEmptyStyle: typeof CreateEmptyStyle;
     CreateEmptyCellSummmary: typeof CreateEmptyCellSummmary;

package/src/Utilities/ObjectFactory.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectFactory = exports.CreateToastOptions = exports.CreateEmptyCommentThread = exports.CreateEmptyTheme = exports.CreateCustomDisplayFormatterContext = exports.CreateEmptyChartDefinition = exports.CreateDefaultStyledColumnBadge = exports.CreateEmptyStyledColumn = exports.CreateColumnFilter = exports.CreateEmptyCellSummmary = exports.CreateSystemStatusMessageInfo = exports.CreateEmptyStyle = exports.CreateEmptyLayout = exports.CreateEmptyPivotLayout = exports.CreateEmptyFreeTextColumn = exports.CreateEmptyFormatColumn = exports.CreateEmptyShortcut = exports.CreateEmptySchedule = exports.CreateReportSchedule = exports.CreateIPushPullSchedule = exports.CreateEmptyOpenFinSchedule = exports.CreateEmptyIPushPullSchedule = exports.CreateEmptyOpenFinReport = exports.CreateEmptyIPushPullReport = exports.CreateEmptyReportSchedule = exports.CreateEmptyReminderSchedule = exports.CreateEmptyBaseSchedule = exports.CreateEmptyReport = exports.CreateInternalAlertDefinitionForMessages = exports.CreateEmptyFlashingCellDefinition = exports.CreateEmptyAlertDefinition = exports.CreateRowChangedAlert = exports.CreateCellChangedAlert = exports.CreateGenericAlert = exports.CreateEmptyPlusMinusNudge = exports.CreateEmptyNamedQuery = exports.CreateEmptyCalculatedColumn = exports.CreateAdaptableComment = exports.CreateEmptyCustomSort = void 0;
+exports.ObjectFactory = exports.CreateToastOptions = exports.CreateEmptyCommentThread = exports.CreateEmptyTheme = exports.CreateCustomDisplayFormatterContext = exports.CreateEmptyChartDefinition = exports.CreateDefaultStyledColumnBadge = exports.CreateEmptyStyledColumn = exports.CreateColumnFilter = exports.CreateEmptyCellSummmary = exports.CreateSystemStatusMessageInfo = exports.CreateEmptyStyle = exports.CreateEmptyLayout = exports.CreateEmptyTableLayout = exports.CreateEmptyPivotLayout = exports.CreateEmptyFreeTextColumn = exports.CreateEmptyFormatColumn = exports.CreateEmptyShortcut = exports.CreateEmptySchedule = exports.CreateReportSchedule = exports.CreateIPushPullSchedule = exports.CreateEmptyOpenFinSchedule = exports.CreateEmptyIPushPullSchedule = exports.CreateEmptyOpenFinReport = exports.CreateEmptyIPushPullReport = exports.CreateEmptyReportSchedule = exports.CreateEmptyReminderSchedule = exports.CreateEmptyBaseSchedule = exports.CreateEmptyReport = exports.CreateInternalAlertDefinitionForMessages = exports.CreateEmptyFlashingCellDefinition = exports.CreateEmptyAlertDefinition = exports.CreateRowChangedAlert = exports.CreateCellChangedAlert = exports.CreateGenericAlert = exports.CreateEmptyPlusMinusNudge = exports.CreateEmptyNamedQuery = exports.CreateEmptyCalculatedColumn = exports.CreateAdaptableComment = exports.CreateEmptyCustomSort = void 0;
 const Enums_1 = require("../AdaptableState/Common/Enums");
 const Uuid_1 = require("../AdaptableState/Uuid");
 const GeneralConstants_1 = require("./Constants/GeneralConstants");
@@ -256,7 +256,7 @@ function CreateEmptyFormatColumn() {
         DisplayFormat: undefined,
         CellAlignment: undefined,
         RowScope: undefined,
-        Target: 'cell'
+        Target: 'cell',
     };
 }
 exports.CreateEmptyFormatColumn = CreateEmptyFormatColumn;
@@ -274,37 +274,45 @@ function CreateEmptyFreeTextColumn(defaultSpecialColumnSettings) {
     };
 }
 exports.CreateEmptyFreeTextColumn = CreateEmptyFreeTextColumn;
-function CreateEmptyPivotLayout(layout) {
+function CreateEmptyPivotLayout(pivotLayout) {
     const result = {
-        Name: layout.Name,
-        ColumnSorts: layout.ColumnSorts || [],
-        ColumnFilters: layout.ColumnFilters || [],
+        ...pivotLayout,
         Uuid: (0, Uuid_1.createUuid)(),
-        PivotColumns: layout.PivotColumns || [],
-        PivotAggregationColumns: layout.PivotAggregationColumns || [],
-        PivotGroupedColumns: layout.PivotGroupedColumns || [],
-        ColumnWidths: layout.ColumnWidths || {},
+        ColumnSizing: pivotLayout.ColumnSizing || {},
+        ColumnHeaders: pivotLayout.ColumnHeaders || {},
+        ColumnPinning: pivotLayout.ColumnPinning || {},
+        ColumnSorts: pivotLayout.ColumnSorts || [],
+        ColumnFilters: pivotLayout.ColumnFilters || [],
+        PivotColumns: pivotLayout.PivotColumns || [],
+        PivotAggregationColumns: pivotLayout.PivotAggregationColumns || [],
+        PivotGroupedColumns: pivotLayout.PivotGroupedColumns || [],
     };
     return result;
 }
 exports.CreateEmptyPivotLayout = CreateEmptyPivotLayout;
-function CreateEmptyLayout(layout, adaptableColumns) {
-    if ((0, LayoutHelpers_1.isPivotLayout)(layout)) {
-        return CreateEmptyPivotLayout(layout);
-    }
-    const tableLayout = layout;
+function CreateEmptyTableLayout(tableLayout) {
     const result = {
         ...tableLayout,
         Uuid: (0, Uuid_1.createUuid)(),
-        TableColumns: tableLayout.TableColumns || [],
+        ColumnSizing: tableLayout.ColumnSizing || {},
+        ColumnHeaders: tableLayout.ColumnHeaders || {},
+        ColumnPinning: tableLayout.ColumnPinning || {},
         ColumnSorts: tableLayout.ColumnSorts || [],
         ColumnFilters: tableLayout.ColumnFilters || [],
-        ColumnWidths: tableLayout.ColumnWidths || {},
-        RowGroupedColumns: tableLayout.RowGroupedColumns ||
-            (adaptableColumns ? adaptableColumns.filter((c) => c.isGrouped).map((c) => c.columnId) : []),
+        TableColumns: tableLayout.TableColumns || [],
+        RowGroupedColumns: tableLayout.RowGroupedColumns || [],
     };
     return result;
 }
+exports.CreateEmptyTableLayout = CreateEmptyTableLayout;
+function CreateEmptyLayout(layout) {
+    if ((0, LayoutHelpers_1.isPivotLayout)(layout)) {
+        return CreateEmptyPivotLayout(layout);
+    }
+    else {
+        return CreateEmptyTableLayout(layout);
+    }
+}
 exports.CreateEmptyLayout = CreateEmptyLayout;
 function CreateEmptyStyle() {
     return {
@@ -485,6 +493,7 @@ exports.ObjectFactory = {
     CreateEmptyFreeTextColumn,
     CreateEmptyLayout,
     CreateEmptyPivotLayout,
+    CreateEmptyTableLayout,
     CreateColumnFilter,
     CreateEmptyStyle,
     CreateEmptyCellSummmary,

package/src/Utilities/Services/AnnotationsService.js

@@ -45,7 +45,7 @@ class AnnotationsService {
     shouldListenToEvents() {
         // Listen to events if we either have Notes in state or if Comments have been set up
         return (ArrayExtensions_1.default.IsNotNullOrEmpty(this.api.noteApi.getAllNotes()) ||
-            this.api.internalApi.getModuleService().isModuleAvailable('Comment'));
+            this.api.internalApi.getModuleService().isAdapTableModulePresent('Comment'));
     }
     setUpEventListeners() {
         this.adaptable._on('MouseEnter', (event) => this.handleMouseEnter(event));

package/src/Utilities/Services/Interface/IModuleService.d.ts

@@ -4,7 +4,8 @@ import { AdaptableObject } from '../../../AdaptableState/Common/AdaptableObject'
 import { IAdaptableService } from './IAdaptableService';
 import { AdaptableModule } from '../../../AdaptableState/Common/Types';
 export interface IModuleService extends IAdaptableService {
-    isModuleAvailable(adaptableModule: AdaptableModule): boolean;
+    logMissingAgGridDepsInfos(): void;
+    isAdapTableModulePresent(adaptableModule: AdaptableModule): boolean;
     isModuleEditable(adaptableModule: AdaptableModule): boolean;
     createModuleUIItems(): void;
     getTeamSharingAction(adaptableModule: AdaptableModule): TeamSharingImportInfo<AdaptableObject> | undefined;

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

@@ -1,5 +1,5 @@
 import { AdaptableModule } from '../../types';
-import { IModule, ModuleInfo, IModuleCollection } from '../../Strategy/Interface/IModule';
+import { IModule, IModuleCollection, ModuleInfo } from '../../Strategy/Interface/IModule';
 import { TeamSharingImportInfo } from '../../AdaptableState/TeamSharingState';
 import { AdaptableObject } from '../../AdaptableState/Common/AdaptableObject';
 import { IModuleService } from './Interface/IModuleService';
@@ -7,9 +7,9 @@ import { AdaptableApi } from '../../../types';
 export declare class ModuleService implements IModuleService {
     private adaptableApi;
     constructor(adaptableApi: AdaptableApi);
-    isModuleAvailable(adaptableModule: AdaptableModule): boolean;
-    isModuleName(adaptableModule: string): adaptableModule is AdaptableModule;
+    isAdapTableModulePresent(adaptableModule: AdaptableModule): boolean;
     isModuleEditable(adaptableModule: AdaptableModule): boolean;
+    logMissingAgGridDepsInfos(): void;
     getModuleFriendlyName(adaptableModule: AdaptableModule): string;
     createModuleUIItems(): void;
     private createSettingsPanelItems;

package/src/Utilities/Services/ModuleService.js

@@ -4,21 +4,17 @@ exports.ModuleService = void 0;
 const tslib_1 = require("tslib");
 const Helper_1 = tslib_1.__importDefault(require("../Helpers/Helper"));
 const DocumentationLinkConstants_1 = require("../Constants/DocumentationLinkConstants");
-const Types_1 = require("../../AdaptableState/Common/Types");
 class ModuleService {
     constructor(adaptableApi) {
         this.adaptableApi = adaptableApi;
         this.adaptableApi = adaptableApi;
     }
-    isModuleAvailable(adaptableModule) {
+    isAdapTableModulePresent(adaptableModule) {
         let module = this.getModuleCollection().get(adaptableModule);
         if (!module) {
             return false;
         }
-        return module.isModuleAvailable();
-    }
-    isModuleName(adaptableModule) {
-        return Types_1.ALL_MODULES.includes(adaptableModule);
+        return module.isModuleVisible();
     }
     isModuleEditable(adaptableModule) {
         let module = this.getModuleCollection().get(adaptableModule);
@@ -27,6 +23,22 @@ class ModuleService {
         }
         return module.isModuleEditable();
     }
+    logMissingAgGridDepsInfos() {
+        // log missing core (required) AG Grid dependencies
+        const agGridModulesAdapter = this.adaptableApi.internalApi.getAgGridModulesAdapter();
+        const mandatoryAgGridModuleNames = agGridModulesAdapter.getMandatoryAgGridModuleNames();
+        const registeredAgGridModuleNames = agGridModulesAdapter.getAgGridRegisteredModuleNames();
+        const missingAgGridModuleNames = mandatoryAgGridModuleNames.filter((moduleName) => !registeredAgGridModuleNames.includes(moduleName));
+        if (missingAgGridModuleNames.length) {
+            this.adaptableApi.consoleError(`AdapTable requires the following AG Grid modules to be registered: ${missingAgGridModuleNames.join(', ')}.
+
+        See for more information: ${DocumentationLinkConstants_1.AgGridRequiredModulesDocsLink}`);
+        }
+        // log optional missing AG Grid dependencies for all modules
+        this.getModuleCollection().forEach((adaptableModule) => {
+            adaptableModule.logMissingAgGridDepsInfos();
+        });
+    }
     getModuleFriendlyName(adaptableModule) {
         return this.getModuleInfoByModule(adaptableModule)?.FriendlyName ?? adaptableModule;
     }

package/src/View/AdaptableView.js

@@ -24,7 +24,9 @@ class AdaptableView extends React.Component {
         return (React.createElement("div", null,
             React.createElement(GridCellPopup_1.GridCellPopup, null),
             React.createElement(FloatingQuickSearch_1.QuickSearchDrawer, null),
-            this.props.AdaptableApi.internalApi.getModuleService().isModuleAvailable('Dashboard') && (React.createElement(Dashboard_1.Dashboard, { api: this.props.AdaptableApi })),
+            this.props.AdaptableApi.internalApi
+                .getModuleService()
+                .isAdapTableModulePresent('Dashboard') && React.createElement(Dashboard_1.Dashboard, { api: this.props.AdaptableApi }),
             this.props.PopupState.PromptPopup.ShowPromptPopup && (React.createElement(AdaptablePopupPrompt_1.AdaptablePopupPrompt, { message: this.props.PopupState.PromptPopup.Message, header: this.props.PopupState.PromptPopup.Header, onClose: this.props.onClosePromptPopup, onConfirm: this.props.onConfirmPromptPopup, onConfirmActionCreator: this.props.PopupState.PromptPopup.ConfirmActionCreator, defaultValue: this.props.PopupState.PromptPopup.DefaultValue })),
             Boolean(this.props.PopupState.ConfirmationPopup.ShowConfirmationPopup) && (React.createElement(AdaptablePopupConfirmation_1.AdaptablePopupConfirmation, { header: this.props.PopupState.ConfirmationPopup.Header, messsage: this.props.PopupState.ConfirmationPopup.Msg, showPopup: this.props.PopupState.ConfirmationPopup.ShowConfirmationPopup, cancelButtonText: this.props.PopupState.ConfirmationPopup.CancelButtonText, confirmButtonText: this.props.PopupState.ConfirmationPopup.ConfirmButtonText, onCancel: this.props.onCancelConfirmationPopup, onConfirm: this.props.onConfirmConfirmationPopup, showInputBox: this.props.PopupState.ConfirmationPopup.ShowInputBox, messageType: this.props.PopupState.ConfirmationPopup.MessageType, api: this.props.AdaptableApi })),
             Boolean(this.props.PopupState.ScreenPopup.ShowScreenPopup) && (React.createElement(AdaptablePopup_1.AdaptablePopup, { componentName: this.props.PopupState.ScreenPopup.ComponentName, componentModule: this.props.PopupState.ScreenPopup.ComponentModule, onHide: this.props.onCloseScreenPopup, api: this.props.AdaptableApi, onClearParams: () => this.props.onClearPopupParams(), moduleParams: this.props.PopupState.ScreenPopup.Params, moduleProps: this.props.PopupState.ScreenPopup.PopupProps })),

package/src/View/ColumnInfo/ColumnInfo.js

@@ -44,6 +44,8 @@ const MODULES_WITH_SCOPE = [
 const ColumnDefPreview = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
     if (props.column) {
+        const api = adaptable.api;
+        const summary = api.columnApi.getColumnSummaryForColumnId(props.column.columnId);
         const keyValuePairs = [
             {
                 Key: 'Column Id',
@@ -116,7 +118,7 @@ const ColumnDefPreview = (props) => {
             {
                 Key: 'Column Filter',
                 Value: props.column.filterable
-                    ? adaptable.api.filterApi.columnFilterApi.columnFilterToString(adaptable.api.filterApi.columnFilterApi.getColumnFilterForColumn(props.column.columnId))
+                    ? api.filterApi.columnFilterApi.columnFilterToString(summary.columnFilter)
                     : 'Ignore',
             },
             {
@@ -147,6 +149,10 @@ const ColumnDefPreview = (props) => {
                 Key: 'Sortable',
                 Value: props.column.sortable ? 'Yes' : 'No',
             },
+            {
+                Key: 'No. Distinct Values',
+                Value: summary.uniqueGridCells.length,
+            },
         ]
             .map((keyValuePair) => {
             return {
@@ -166,7 +172,7 @@ const ColumnDefPreview = (props) => {
 const ModuleView = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
     const module = adaptable.ModuleService.getModuleById(props.moduleName);
-    if (!module || !module.isModuleAvailable()) {
+    if (!module?.isModuleVisible()) {
         return null;
     }
     const moduleInfo = module.moduleInfo;
@@ -217,7 +223,7 @@ const ColumnInfo = (props) => {
         React.createElement(rebass_1.Box, { mb: 3 },
             React.createElement(FormLayout_1.default, null,
                 React.createElement(FormLayout_1.FormRow, { label: "Select Column" },
-                    React.createElement(ColumnSelector_1.ColumnSelector, { filterColumn: (column) => !column.alwaysHidden, value: selectedColumnId, onChange: (columnId) => setSelectedColumnId(columnId) })))),
+                    React.createElement(ColumnSelector_1.ColumnSelector, { value: selectedColumnId, onChange: (columnId) => setSelectedColumnId(columnId) })))),
         selectedColumnId && (React.createElement(Tabs_1.Tabs, { mb: 3 },
             React.createElement(Tabs_1.Tabs.Tab, null, "Column Summary"),
             React.createElement(Tabs_1.Tabs.Tab, null, "Column State"),

package/src/View/Components/AdaptableIconSelector/index.js

@@ -10,8 +10,7 @@ const AdaptableContext_1 = require("../../AdaptableContext");
  */
 const AdaptableIconSelector = (props) => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
-    const userInterfaceOptions = adaptable.api.optionsApi.getAdaptableOptions()?.userInterfaceOptions;
-    const customDefinedIcons = userInterfaceOptions.customIcons ?? [];
-    return React.createElement(IconSelector_1.IconSelector, { customIcons: customDefinedIcons, ...props });
+    const customIcons = adaptable.api.userInterfaceApi.getCustomIcons();
+    return React.createElement(IconSelector_1.IconSelector, { customIcons: customIcons, ...props });
 };
 exports.AdaptableIconSelector = AdaptableIconSelector;