@adaptabletools/adaptable 16.2.3 → 17.0.0-canary.0

package/src/Strategy/ColumnFilterModule.js

@@ -0,0 +1,223 @@
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
+import * as LayoutRedux from '../Redux/ActionsReducers/LayoutRedux';
+import * as SystemRedux from '../Redux/ActionsReducers/SystemRedux';
+import { FilterStatusBarSubPanelPopover } from '../View/Filter/FilterStatusBarSubPanelPopover';
+import { getFilterPreview } from './Utilities/Layout/getLayoutFilterViewItems';
+export class ColumnFilterModule extends AdaptableModuleBase {
+    constructor(api) {
+        super(ModuleConstants.ColumnFilterModuleId, ModuleConstants.ColumnFilterFriendlyName, 'filter', 'FilterPopup', 'Advanced filtering capability allows users to see precisely the data they want', api);
+    }
+    getModuleAdaptableObjects() {
+        return this.api.columnFilterApi.getColumnFilters();
+    }
+    getExplicitlyReferencedColumnIds(columnFilter) {
+        return [columnFilter.ColumnId];
+    }
+    hasNamedQueryReferences() {
+        return false;
+    }
+    updateOldConfig() {
+        // Note: have updated Dasbhoard and Status bar but NOT Tool Panels
+        // Update Module Buttons
+        let updateModuleButtons = false;
+        let moduleButtons = this.api.dashboardApi.getModuleButtons();
+        if (!moduleButtons.includes('ColumnFilter')) {
+            moduleButtons = moduleButtons.map((moduleButton) => {
+                if (moduleButton == 'Filter') {
+                    updateModuleButtons = true;
+                    return 'ColumnFilter';
+                }
+                return moduleButton;
+            });
+        }
+        if (updateModuleButtons) {
+            this.api.dashboardApi.setModuleButtons(moduleButtons);
+        }
+        // Update Toolbars
+        let updateTabs = false;
+        const tabs = this.api.dashboardApi.getTabs().map((tab) => {
+            if (tab.Toolbars.includes('Filter') && !tab.Toolbars.includes('ColumnFilter')) {
+                updateTabs = true;
+                return Object.assign(Object.assign({}, tab), { 
+                    // replace with 'GridFilter'
+                    Toolbars: tab.Toolbars.map((t) => (t == 'Filter' ? 'ColumnFilter' : t)) });
+            }
+            return tab;
+        });
+        if (updateTabs) {
+            this.api.dashboardApi.setTabs(tabs);
+        }
+        // - move pinned toolbars
+        let updatePinnedToolbars = false;
+        let pinnedToolbars = this.api.dashboardApi.getPinnedToolbars();
+        if (pinnedToolbars && !(pinnedToolbars === null || pinnedToolbars === void 0 ? void 0 : pinnedToolbars.includes('ColumnFilter'))) {
+            pinnedToolbars = pinnedToolbars.map((pinnedToolbar) => {
+                if (pinnedToolbar == 'Filter') {
+                    updatePinnedToolbars = true;
+                    return 'ColumnFilter';
+                }
+                return pinnedToolbar;
+            });
+        }
+        if (updatePinnedToolbars) {
+            this.api.dashboardApi.setPinnedToolbars(pinnedToolbars);
+        }
+        // Update Status Bar
+        let updateStatusBars = false;
+        const statusBars = this.api.statusBarApi
+            .getAdaptableStatusBars()
+            .map((panel) => {
+            return Object.assign(Object.assign({}, panel), { StatusBarPanels: panel.StatusBarPanels.map((panel) => {
+                    if (panel === 'Filter') {
+                        updateStatusBars = true;
+                        return 'ColumnFilter';
+                    }
+                    return panel;
+                }) });
+        });
+        if (updateStatusBars) {
+            console.log('wat', statusBars);
+            this.api.statusBarApi.setStatusBarPanels(statusBars);
+        }
+    }
+    handleAdaptableReady() {
+        if (this.api.optionsApi.getColumnFilterOptions().showQuickFilter == false) {
+            this.api.columnFilterApi.hideQuickFilterBar();
+        }
+        const columnFilters = this.api.columnFilterApi.getColumnFilters();
+        columnFilters.forEach((cf) => {
+            if (!this.api.columnApi.isColumnInGrid(cf.ColumnId)) {
+                this.api.logError('Column Filter contains missing column: ' + cf.ColumnId);
+            }
+        });
+    }
+    addContextMenuItems(menuContext) {
+        let menuItemClickFunction = undefined;
+        if (!menuContext.isRowGroupColumn && this.isModuleAvailable()) {
+            if (menuContext.adaptableColumn &&
+                menuContext.adaptableColumn.filterable &&
+                menuContext.isSingleSelectedColumn &&
+                menuContext.gridCell != null) {
+                let isMultiple = menuContext.selectedCellInfo.gridCells.length > 1;
+                let clickFunction = isMultiple
+                    ? () => {
+                        this.api.columnFilterApi.internalApi.createValuesColumnFilterForCells(menuContext.selectedCellInfo.gridCells);
+                    }
+                    : () => {
+                        this.api.columnFilterApi.internalApi.createEqualityColumnFilterForCell(menuContext.selectedCellInfo.gridCells[0]);
+                    };
+                menuItemClickFunction = this.createColumnMenuItemClickFunction(isMultiple ? 'Filter on Cell Values' : 'Filter on Cell Value', this.moduleInfo.Glyph, clickFunction);
+            }
+        }
+        return [menuItemClickFunction];
+    }
+    addColumnMenuItems(column) {
+        let filterSubMenuItems = [];
+        if (column && this.api.gridApi.isQuickFilterAvailable()) {
+            const isFilterVisible = this.api.columnFilterApi.isQuickFilterVisible();
+            if (this.isModuleEditable() &&
+                this.api.columnApi.internalApi.usesAdaptableQuickFilter(column.columnId)) {
+                filterSubMenuItems.push(this.createColumnMenuItemReduxAction(isFilterVisible ? 'Hide Filter Bar' : 'Show Filter Bar', isFilterVisible ? 'unchecked' : 'check', isFilterVisible
+                    ? SystemRedux.SystemQuickFilterBarHide()
+                    : SystemRedux.SystemQuickFilterBarShow()));
+            }
+        }
+        if (column && this.canCreateColumnMenuItem(column, 'ReadOnly', 'filter')) {
+            const existingColumnFilter = this.api.columnFilterApi
+                .getColumnFilters()
+                .find((x) => x.ColumnId == column.columnId);
+            if (existingColumnFilter) {
+                filterSubMenuItems.push(this.createColumnMenuItemReduxAction('Clear Filter', 'close', LayoutRedux.LayoutColumnFilterClear(existingColumnFilter)));
+                filterSubMenuItems.push(this.createColumnMenuItemReduxAction(existingColumnFilter.IsSuspended ? 'Unsuspend Filter' : 'Suspend Filter', existingColumnFilter.IsSuspended ? 'play' : 'pause', existingColumnFilter.IsSuspended
+                    ? LayoutRedux.LayoutColumnFilterUnSuspend(existingColumnFilter)
+                    : LayoutRedux.LayoutColumnFilterSuspend(existingColumnFilter)));
+            }
+        }
+        if (ArrayExtensions.IsNotNullOrEmpty(filterSubMenuItems)) {
+            return [
+                {
+                    label: this.moduleInfo.FriendlyName,
+                    isVisible: true,
+                    module: this.moduleInfo.ModuleName,
+                    icon: {
+                        name: this.moduleInfo.Glyph,
+                    },
+                    subItems: filterSubMenuItems,
+                },
+            ];
+        }
+    }
+    getTeamSharingAction() {
+        return {
+            ModuleEntities: this.api.columnFilterApi.getColumnFilters(),
+            AddAction: LayoutRedux.LayoutColumnFilterAdd,
+            EditAction: LayoutRedux.LayoutColumnFilterEdit, //TODO need to change this to ColumnFilterSet
+        };
+    }
+    toViewCompact(filter) {
+        return {
+            item: {
+                values: [this.api.columnFilterApi.internalApi.columnFilterToString(filter)],
+            },
+            abObject: filter,
+        };
+    }
+    toView(filter) {
+        return {
+            items: [
+                {
+                    name: 'Column',
+                    values: [this.api.columnApi.getFriendlyNameForColumnId(filter.ColumnId)],
+                },
+                {
+                    name: 'Filter',
+                    values: [getFilterPreview(filter, this.api)],
+                },
+            ],
+            abObject: filter,
+        };
+    }
+    toViewAll() {
+        return this.getModuleAdaptableObjects().map((filter) => this.toView(filter));
+    }
+    getViewProperties() {
+        const api = this.api;
+        return {
+            getSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterSuspend(columnFilter),
+            getUnSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterUnSuspend(columnFilter),
+            getCompactSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterSuspend(columnFilter),
+            getCompactUnSuspendAction: (columnFilter) => LayoutRedux.LayoutColumnFilterUnSuspend(columnFilter),
+            getSuspendAllAction: () => LayoutRedux.LayoutColumnFilterSuspendAll(),
+            getUnSuspendAllAction: () => LayoutRedux.LayoutColumnFilterUnSuspendAll(),
+            getDeleteAction: LayoutRedux.LayoutColumnFilterClear,
+            getCompactDeleteAction: LayoutRedux.LayoutColumnFilterClear,
+            getDeleteAllAction: LayoutRedux.LayoutColumnFilterClearAll,
+            emptyView: `
+        There are currently no Column Filters applied. \n
+
+        Create Column Filters by using the Filter Bar, the Filter Form (in the Column Header Menu) or by editing a Layout.
+      `,
+            getStatusBarPanelProps() {
+                let text;
+                const filters = api.columnFilterApi.getColumnFilters();
+                if (filters.length === 0) {
+                    text = '0 Filters';
+                }
+                else if (filters.length === 1) {
+                    text = '1 Filter';
+                }
+                else {
+                    text = filters.length + ' Filters';
+                }
+                const popover = filters.length ? FilterStatusBarSubPanelPopover : null;
+                return {
+                    content: text,
+                    popover,
+                    popoverMinWidth: 320,
+                };
+            },
+        };
+    }
+}

package/src/Strategy/ColumnInfoModule.js

@@ -1,10 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ColumnInfoModule = void 0;
-const tslib_1 = require("tslib");
-const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-class ColumnInfoModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+export class ColumnInfoModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.ColumnInfoModuleId, ModuleConstants.ColumnInfoFriendlyName, 'columns', 'ColumnInfoPopup', 'Display information about Columns', api);
     }
@@ -44,4 +40,3 @@ class ColumnInfoModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
     }
 }
-exports.ColumnInfoModule = ColumnInfoModule;

package/src/Strategy/CustomSortModule.js

@@ -1,15 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomSortModule = void 0;
-const tslib_1 = require("tslib");
-const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const CustomSortRedux = tslib_1.__importStar(require("../Redux/ActionsReducers/CustomSortRedux"));
-const CustomSortWizard_1 = require("../View/CustomSort/Wizard/CustomSortWizard");
-const getCustomSortColumnViewItems_1 = require("./Utilities/CustomSort/getCustomSortColumnViewItems");
-const getCustomSortSortOrderViewItems_1 = require("./Utilities/CustomSort/getCustomSortSortOrderViewItems");
-const getObjectTagsViewItems_1 = require("./Utilities/getObjectTagsViewItems");
-class CustomSortModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import * as CustomSortRedux from '../Redux/ActionsReducers/CustomSortRedux';
+import { CustomSortWizard } from '../View/CustomSort/Wizard/CustomSortWizard';
+import { getCustomSortColumnViewItems } from './Utilities/CustomSort/getCustomSortColumnViewItems';
+import { getCustomSortSortOrderViewItems } from './Utilities/CustomSort/getCustomSortSortOrderViewItems';
+import { getObjectTagsViewItems } from './Utilities/getObjectTagsViewItems';
+export class CustomSortModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.CustomSortModuleId, ModuleConstants.CustomSortFriendlyName, 'import-export', 'CustomSortPopup', 'Provide bespoke sorting information for Columns (in place of alphabetical sorting)', api);
     }
@@ -53,9 +49,9 @@ class CustomSortModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     toView(customSort) {
         return {
             items: [
-                (0, getCustomSortColumnViewItems_1.getCustomSortColumnViewItems)(customSort, this.api),
-                (0, getCustomSortSortOrderViewItems_1.getCustomSortSortOrderViewItems)(customSort),
-                (0, getObjectTagsViewItems_1.getObjectTagsViewItems)(customSort, this.api),
+                getCustomSortColumnViewItems(customSort, this.api),
+                getCustomSortSortOrderViewItems(customSort),
+                getObjectTagsViewItems(customSort, this.api),
             ],
             abObject: customSort,
         };
@@ -75,7 +71,7 @@ class CustomSortModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             getUnSuspendAllAction: CustomSortRedux.CustomSortUnSuspendAll,
             emptyView: "Click 'New' to create a custom Sort Order for a selected Column.",
             getEditWizard() {
-                return CustomSortWizard_1.CustomSortWizard;
+                return CustomSortWizard;
             },
         };
     }
@@ -83,4 +79,3 @@ class CustomSortModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return true;
     }
 }
-exports.CustomSortModule = CustomSortModule;

package/src/Strategy/DashboardModule.js

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DashboardModule = void 0;
-const tslib_1 = require("tslib");
-const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const DashboardRedux = tslib_1.__importStar(require("../Redux/ActionsReducers/DashboardRedux"));
-class DashboardModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import * as DashboardRedux from '../Redux/ActionsReducers/DashboardRedux';
+export class DashboardModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.DashboardModuleId, ModuleConstants.DashboardFriendlyName, 'dashboard', 'DashboardPopup', 'The Dashboard - usually placed above the Grid - is designed to provide quick access to commonly required AdapTable functionalty', api);
     }
@@ -72,4 +68,3 @@ class DashboardModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         }
     }
 }
-exports.DashboardModule = DashboardModule;

package/src/Strategy/DataChangeHistoryModule.js

@@ -1,13 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataChangeHistoryModule = void 0;
-const tslib_1 = require("tslib");
-const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const SystemRedux_1 = require("../Redux/ActionsReducers/SystemRedux");
-const DataChangeHistoryStatusBarContent_1 = require("../View/DataChangeHistory/DataChangeHistoryStatusBarContent");
-const core_1 = require("@ag-grid-community/core");
-class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import { SystemDataChangeHistoryAdd } from '../Redux/ActionsReducers/SystemRedux';
+import { DataChangeHistoryStatusBarContent } from '../View/DataChangeHistory/DataChangeHistoryStatusBarContent';
+import { ModuleNames } from '@ag-grid-community/core';
+export class DataChangeHistoryModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.DataChangeHistoryModuleId, ModuleConstants.DataChangeHistoryFriendlyName, 'target', 'DataChangeHistoryPopup', 'Provides an overview of all previous changes, giving the possibility to undo specific changes', api);
         this.api.internalApi
@@ -15,7 +11,7 @@ class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase
             .on('CellDataChanged', (cellDataChangedInfo) => {
             if (cellDataChangedInfo.trigger !== 'undo' && cellDataChangedInfo.trigger !== 'aggChange') {
                 if (this.shouldLogDataChange(cellDataChangedInfo)) {
-                    this.api.internalApi.dispatchReduxAction((0, SystemRedux_1.SystemDataChangeHistoryAdd)(cellDataChangedInfo));
+                    this.api.internalApi.dispatchReduxAction(SystemDataChangeHistoryAdd(cellDataChangedInfo));
                 }
             }
         });
@@ -24,9 +20,9 @@ class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase
         const isAdaptableModuleAvailable = super.isModuleAvailable();
         const isAgGridModuleAvailable = this.api.internalApi
             .getAdaptableInstance()
-            .isAgGridModulePresent(core_1.ModuleNames.ClientSideRowModelModule);
+            .isAgGridModulePresent(ModuleNames.ClientSideRowModelModule);
         if (isAdaptableModuleAvailable && !isAgGridModuleAvailable) {
-            this.api.logWarn(`Data Change History is NOT available due to missing required AG Grid module: ${core_1.ModuleNames.ClientSideRowModelModule}`);
+            this.api.logWarn(`Data Change History is NOT available due to missing required AG Grid module: ${ModuleNames.ClientSideRowModelModule}`);
         }
         return isAdaptableModuleAvailable && isAgGridModuleAvailable;
     }
@@ -51,10 +47,9 @@ class DataChangeHistoryModule extends AdaptableModuleBase_1.AdaptableModuleBase
             getStatusBarPanelProps: () => {
                 return {
                     triggerActionOnWrapperClick: false,
-                    content: DataChangeHistoryStatusBarContent_1.DataChangeHistoryStatusBarContent,
+                    content: DataChangeHistoryStatusBarContent,
                 };
             },
         };
     }
 }
-exports.DataChangeHistoryModule = DataChangeHistoryModule;

package/src/Strategy/DataImportModule.js

@@ -1,10 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataImportModule = void 0;
-const tslib_1 = require("tslib");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
-class DataImportModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+export class DataImportModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.DataImportModuleId, ModuleConstants.DataImportFriendyName, 'import', 'DataImportPopup', 'Import Data', api);
     }
@@ -33,4 +29,3 @@ class DataImportModule extends AdaptableModuleBase_1.AdaptableModuleBase {
         return this.createColumnMenuItemShowPopup('Import Data', this.moduleInfo.Popup, this.moduleInfo.Glyph, moduleParams);
     }
 }
-exports.DataImportModule = DataImportModule;

package/src/Strategy/DataSetModule.js

@@ -1,21 +1,17 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DataSetModule = void 0;
-const tslib_1 = require("tslib");
-const AdaptableModuleBase_1 = require("./AdaptableModuleBase");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const getObjectTagsViewItems_1 = require("./Utilities/getObjectTagsViewItems");
-const DataSetStatusPanelPopover_1 = require("../View/DataSet/DataSetStatusPanelPopover");
-const Uuid_1 = require("../PredefinedConfig/Uuid");
-const DataSetSelector_1 = require("../View/DataSet/DataSetSelector");
-class DataSetModule extends AdaptableModuleBase_1.AdaptableModuleBase {
+import { AdaptableModuleBase } from './AdaptableModuleBase';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import { getObjectTagsViewItems } from './Utilities/getObjectTagsViewItems';
+import { DataSetStatusPanelPopover } from '../View/DataSet/DataSetStatusPanelPopover';
+import { createUuid } from '../PredefinedConfig/Uuid';
+import { DataSetSelector } from '../View/DataSet/DataSetSelector';
+export class DataSetModule extends AdaptableModuleBase {
     constructor(api) {
         super(ModuleConstants.DataSetModuleId, ModuleConstants.DataSetFriendlyName, 'data-set', 'DataSetPopup', 'Update the entire data source in AdapTable using pre-populated data sets', api);
     }
     handleAdaptableReady() {
         this.api.dataSetApi.getDataSets().forEach((ds) => {
             if (!ds.Uuid) {
-                ds.Uuid = (0, Uuid_1.createUuid)();
+                ds.Uuid = createUuid();
             }
         });
     }
@@ -40,7 +36,7 @@ class DataSetModule extends AdaptableModuleBase_1.AdaptableModuleBase {
                     label: 'Description',
                     values: [(_a = dataSet.description) !== null && _a !== void 0 ? _a : 'Not Specified'],
                 },
-                (0, getObjectTagsViewItems_1.getObjectTagsViewItems)(dataSet, this.api),
+                getObjectTagsViewItems(dataSet, this.api),
             ],
             abObject: dataSet,
         };
@@ -50,17 +46,16 @@ class DataSetModule extends AdaptableModuleBase_1.AdaptableModuleBase {
     }
     getViewProperties() {
         return {
-            actions: [DataSetSelector_1.DataSetSelector],
+            actions: [DataSetSelector],
             emptyView: 'No DataSets are provided',
             getStatusBarPanelProps: () => {
                 var _a, _b;
                 const content = (_b = (_a = this.api.dataSetApi.getCurrentDataSet()) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : this.moduleInfo.FriendlyName;
                 return {
                     content: content,
-                    popover: DataSetStatusPanelPopover_1.DataSetStatusPanelPopover,
+                    popover: DataSetStatusPanelPopover,
                 };
             },
         };
     }
 }
-exports.DataSetModule = DataSetModule;