npm - @adaptabletools/adaptable - Versions diffs - 16.2.3 → 17.0.0-canary.0 - Mend

@adaptabletools/adaptable 16.2.3 → 17.0.0-canary.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1343) hide show

package/src/agGrid/agGridHelper.js CHANGED Viewed

@@ -1,52 +1,49 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.agGridHelper = void 0;
-const tslib_1 = require("tslib");
-const Uuid_1 = require("../PredefinedConfig/Uuid");
-const AlertModule_1 = require("../Strategy/AlertModule");
-const BulkUpdateModule_1 = require("../Strategy/BulkUpdateModule");
-const CalculatedColumnModule_1 = require("../Strategy/CalculatedColumnModule");
-const CellSummaryModule_1 = require("../Strategy/CellSummaryModule");
-const ChartingModule_1 = require("../Strategy/ChartingModule");
-const ColumnInfoModule_1 = require("../Strategy/ColumnInfoModule");
-const NotesModule_1 = require("../Strategy/NotesModule");
-const CustomSortModule_1 = require("../Strategy/CustomSortModule");
-const DashboardModule_1 = require("../Strategy/DashboardModule");
-const DataChangeHistoryModule_1 = require("../Strategy/DataChangeHistoryModule");
-const DataSetModule_1 = require("../Strategy/DataSetModule");
-const ExportModule_1 = require("../Strategy/ExportModule");
-const Fdc3Module_1 = require("../Strategy/Fdc3Module");
-const FilterModule_1 = require("../Strategy/FilterModule");
-const FlashingCellModule_1 = require("../Strategy/FlashingCellModule");
-const FormatColumnModule_1 = require("../Strategy/FormatColumnModule");
-const FreeTextColumnModule_1 = require("../Strategy/FreeTextColumnModule");
-const GridInfoModule_1 = require("../Strategy/GridInfoModule");
-const LayoutModule_1 = require("../Strategy/LayoutModule");
-const PlusMinusModule_1 = require("../Strategy/PlusMinusModule");
-const QueryModule_1 = require("../Strategy/QueryModule");
-const QuickSearchModule_1 = require("../Strategy/QuickSearchModule");
-const ScheduleModule_1 = require("../Strategy/ScheduleModule");
-const SettingsPanelModule_1 = require("../Strategy/SettingsPanelModule");
-const ShortcutModule_1 = require("../Strategy/ShortcutModule");
-const SmartEditModule_1 = require("../Strategy/SmartEditModule");
-const StateManagementModule_1 = require("../Strategy/StateManagementModule");
-const StatusBarModule_1 = require("../Strategy/StatusBarModule");
-const StyledColumnModule_1 = require("../Strategy/StyledColumnModule");
-const SystemStatusModule_1 = require("../Strategy/SystemStatusModule");
-const TeamSharingModule_1 = require("../Strategy/TeamSharingModule");
-const ThemeModule_1 = require("../Strategy/ThemeModule");
-const ToolPanelModule_1 = require("../Strategy/ToolPanelModule");
-const GeneralConstants = tslib_1.__importStar(require("../Utilities/Constants/GeneralConstants"));
-const GeneralConstants_1 = require("../Utilities/Constants/GeneralConstants");
-const ModuleConstants = tslib_1.__importStar(require("../Utilities/Constants/ModuleConstants"));
-const ArrayExtensions_1 = require("../Utilities/Extensions/ArrayExtensions");
-const StringExtensions_1 = require("../Utilities/Extensions/StringExtensions");
-const Helper_1 = require("../Utilities/Helpers/Helper");
-const UIHelper_1 = tslib_1.__importDefault(require("../View/UIHelper"));
-const BadgeRenderer_1 = require("./BadgeRenderer");
-const CheckboxRenderer_1 = require("./CheckboxRenderer");
-const PercentBarRenderer_1 = require("./PercentBarRenderer");
-const DataImportModule_1 = require("../Strategy/DataImportModule");
+import { createUuid } from '../PredefinedConfig/Uuid';
+import { AlertModule } from '../Strategy/AlertModule';
+import { BulkUpdateModule } from '../Strategy/BulkUpdateModule';
+import { CalculatedColumnModule } from '../Strategy/CalculatedColumnModule';
+import { CellSummaryModule } from '../Strategy/CellSummaryModule';
+import { ChartingModule } from '../Strategy/ChartingModule';
+import { ColumnInfoModule } from '../Strategy/ColumnInfoModule';
+import { CustomSortModule } from '../Strategy/CustomSortModule';
+import { DashboardModule } from '../Strategy/DashboardModule';
+import { DataChangeHistoryModule } from '../Strategy/DataChangeHistoryModule';
+import { DataImportModule } from '../Strategy/DataImportModule';
+import { DataSetModule } from '../Strategy/DataSetModule';
+import { ExportModule } from '../Strategy/ExportModule';
+import { Fdc3Module } from '../Strategy/Fdc3Module';
+import { ColumnFilterModule } from '../Strategy/ColumnFilterModule';
+import { FlashingCellModule } from '../Strategy/FlashingCellModule';
+import { FormatColumnModule } from '../Strategy/FormatColumnModule';
+import { FreeTextColumnModule } from '../Strategy/FreeTextColumnModule';
+import { GridFilterModule } from '../Strategy/GridFilterModule';
+import { GridInfoModule } from '../Strategy/GridInfoModule';
+import { LayoutModule } from '../Strategy/LayoutModule';
+import { NamedQueryModule } from '../Strategy/NamedQueryModule';
+import { NotesModule } from '../Strategy/NotesModule';
+import { PlusMinusModule } from '../Strategy/PlusMinusModule';
+import { QuickSearchModule } from '../Strategy/QuickSearchModule';
+import { ScheduleModule } from '../Strategy/ScheduleModule';
+import { SettingsPanelModule } from '../Strategy/SettingsPanelModule';
+import { ShortcutModule } from '../Strategy/ShortcutModule';
+import { SmartEditModule } from '../Strategy/SmartEditModule';
+import { StateManagementModule } from '../Strategy/StateManagementModule';
+import { StatusBarModule } from '../Strategy/StatusBarModule';
+import { StyledColumnModule } from '../Strategy/StyledColumnModule';
+import { SystemStatusModule } from '../Strategy/SystemStatusModule';
+import { TeamSharingModule } from '../Strategy/TeamSharingModule';
+import { ThemeModule } from '../Strategy/ThemeModule';
+import { ToolPanelModule } from '../Strategy/ToolPanelModule';
+import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
+import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME, ADAPTABLE_ROW_ACTION_BUTTONS, ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME, } from '../Utilities/Constants/GeneralConstants';
+import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
+import { ArrayExtensions } from '../Utilities/Extensions/ArrayExtensions';
+import { StringExtensions } from '../Utilities/Extensions/StringExtensions';
+import { Helper } from '../Utilities/Helpers/Helper';
+import UIHelper from '../View/UIHelper';
+import { getBadgeRendererForColumn } from './BadgeRenderer';
+import { getCheckboxRendererForColumn } from './CheckboxRenderer';
+import { getPercentBarRendererForColumn } from './PercentBarRenderer';
 const tinycolor = require('tinycolor2');
 /**
  * Adaptable AG Grid implementation is getting really big and unwieldy
@@ -54,7 +51,7 @@ const tinycolor = require('tinycolor2');
  * This is a bit crap - it should take a GridOptions object...
  */
 // tslint:disable-next-line: class-name
-class agGridHelper {
+export class agGridHelper {
     constructor(adaptable, gridOptions) {
         this.adaptable = adaptable;
         this.gridOptions = gridOptions;
@@ -78,48 +75,49 @@ class agGridHelper {
         const api = this.adaptable.api;
         // this is order is semi important as it currently decides the order of the  items in the Column Menu
         // so we put Dashboard first and then the rest in alphabetical order with Grid Info last
-        modules.set(ModuleConstants.DashboardModuleId, new DashboardModule_1.DashboardModule(api));
-        modules.set(ModuleConstants.AlertModuleId, new AlertModule_1.AlertModule(api));
-        modules.set(ModuleConstants.FlashingCellModuleId, new FlashingCellModule_1.FlashingCellModule(api));
-        modules.set(ModuleConstants.BulkUpdateModuleId, new BulkUpdateModule_1.BulkUpdateModule(api));
-        modules.set(ModuleConstants.CalculatedColumnModuleId, new CalculatedColumnModule_1.CalculatedColumnModule(api));
-        modules.set(ModuleConstants.CellSummaryModuleId, new CellSummaryModule_1.CellSummaryModule(api));
-        modules.set(ModuleConstants.CustomSortModuleId, new CustomSortModule_1.CustomSortModule(api));
-        modules.set(ModuleConstants.DataChangeHistoryModuleId, new DataChangeHistoryModule_1.DataChangeHistoryModule(api));
-        modules.set(ModuleConstants.DataImportModuleId, new DataImportModule_1.DataImportModule(api));
-        modules.set(ModuleConstants.DataSetModuleId, new DataSetModule_1.DataSetModule(api));
-        modules.set(ModuleConstants.ExportModuleId, new ExportModule_1.ExportModule(api));
-        modules.set(ModuleConstants.FilterModuleId, new FilterModule_1.FilterModule(api));
-        modules.set(ModuleConstants.FormatColumnModuleId, new FormatColumnModule_1.FormatColumnModule(api));
-        modules.set(ModuleConstants.FreeTextColumnModuleId, new FreeTextColumnModule_1.FreeTextColumnModule(api));
-        modules.set(ModuleConstants.LayoutModuleId, new LayoutModule_1.LayoutModule(api));
-        modules.set(ModuleConstants.PlusMinusModuleId, new PlusMinusModule_1.PlusMinusModule(api));
-        modules.set(ModuleConstants.QueryModuleId, new QueryModule_1.QueryModule(api));
-        modules.set(ModuleConstants.QuickSearchModuleId, new QuickSearchModule_1.QuickSearchModule(api));
-        modules.set(ModuleConstants.ScheduleModuleId, new ScheduleModule_1.ScheduleModule(api));
-        modules.set(ModuleConstants.SmartEditModuleId, new SmartEditModule_1.SmartEditModule(api));
-        modules.set(ModuleConstants.ShortcutModuleId, new ShortcutModule_1.ShortcutModule(api));
-        modules.set(ModuleConstants.StateManagementModuleId, new StateManagementModule_1.StateManagementModule(api));
-        modules.set(ModuleConstants.TeamSharingModuleId, new TeamSharingModule_1.TeamSharingModule(api));
-        modules.set(ModuleConstants.ToolPanelModuleId, new ToolPanelModule_1.ToolPanelModule(api));
-        modules.set(ModuleConstants.SystemStatusModuleId, new SystemStatusModule_1.SystemStatusModule(api));
-        modules.set(ModuleConstants.ThemeModuleId, new ThemeModule_1.ThemeModule(api));
-        modules.set(ModuleConstants.GridInfoModuleId, new GridInfoModule_1.GridInfoModule(api));
-        modules.set(ModuleConstants.ColumnInfoModuleId, new ColumnInfoModule_1.ColumnInfoModule(api));
-        modules.set(ModuleConstants.SettingsPanelModuleId, new SettingsPanelModule_1.SettingsPanelModule(api));
-        modules.set(ModuleConstants.StatusBarModuleId, new StatusBarModule_1.StatusBarModule(api));
-        modules.set(ModuleConstants.ChartingModuleId, new ChartingModule_1.ChartingModule(api));
-        modules.set(ModuleConstants.NotesModuleId, new NotesModule_1.NotesModule(api));
-        modules.set(ModuleConstants.StyledColumnModuleId, new StyledColumnModule_1.StyledColumnModule(api));
-        modules.set(ModuleConstants.Fdc3ModuleId, new Fdc3Module_1.Fdc3Module(api));
+        modules.set(ModuleConstants.DashboardModuleId, new DashboardModule(api));
+        modules.set(ModuleConstants.AlertModuleId, new AlertModule(api));
+        modules.set(ModuleConstants.FlashingCellModuleId, new FlashingCellModule(api));
+        modules.set(ModuleConstants.BulkUpdateModuleId, new BulkUpdateModule(api));
+        modules.set(ModuleConstants.CalculatedColumnModuleId, new CalculatedColumnModule(api));
+        modules.set(ModuleConstants.CellSummaryModuleId, new CellSummaryModule(api));
+        modules.set(ModuleConstants.CustomSortModuleId, new CustomSortModule(api));
+        modules.set(ModuleConstants.DataChangeHistoryModuleId, new DataChangeHistoryModule(api));
+        modules.set(ModuleConstants.DataImportModuleId, new DataImportModule(api));
+        modules.set(ModuleConstants.DataSetModuleId, new DataSetModule(api));
+        modules.set(ModuleConstants.ExportModuleId, new ExportModule(api));
+        modules.set(ModuleConstants.ColumnFilterModuleId, new ColumnFilterModule(api));
+        modules.set(ModuleConstants.FormatColumnModuleId, new FormatColumnModule(api));
+        modules.set(ModuleConstants.FreeTextColumnModuleId, new FreeTextColumnModule(api));
+        modules.set(ModuleConstants.LayoutModuleId, new LayoutModule(api));
+        modules.set(ModuleConstants.PlusMinusModuleId, new PlusMinusModule(api));
+        modules.set(ModuleConstants.QuickSearchModuleId, new QuickSearchModule(api));
+        modules.set(ModuleConstants.ScheduleModuleId, new ScheduleModule(api));
+        modules.set(ModuleConstants.SmartEditModuleId, new SmartEditModule(api));
+        modules.set(ModuleConstants.ShortcutModuleId, new ShortcutModule(api));
+        modules.set(ModuleConstants.StateManagementModuleId, new StateManagementModule(api));
+        modules.set(ModuleConstants.TeamSharingModuleId, new TeamSharingModule(api));
+        modules.set(ModuleConstants.ToolPanelModuleId, new ToolPanelModule(api));
+        modules.set(ModuleConstants.SystemStatusModuleId, new SystemStatusModule(api));
+        modules.set(ModuleConstants.ThemeModuleId, new ThemeModule(api));
+        modules.set(ModuleConstants.GridInfoModuleId, new GridInfoModule(api));
+        modules.set(ModuleConstants.ColumnInfoModuleId, new ColumnInfoModule(api));
+        modules.set(ModuleConstants.SettingsPanelModuleId, new SettingsPanelModule(api));
+        modules.set(ModuleConstants.StatusBarModuleId, new StatusBarModule(api));
+        modules.set(ModuleConstants.ChartingModuleId, new ChartingModule(api));
+        modules.set(ModuleConstants.NotesModuleId, new NotesModule(api));
+        modules.set(ModuleConstants.StyledColumnModuleId, new StyledColumnModule(api));
+        modules.set(ModuleConstants.Fdc3ModuleId, new Fdc3Module(api));
+        modules.set(ModuleConstants.GridFilterModuleId, new GridFilterModule(api));
+        modules.set(ModuleConstants.NamedQueryModuleId, new NamedQueryModule(api));
         return modules;
     }
     TrySetUpNodeIds(hasAutogeneratedPrimaryKey) {
-        if (StringExtensions_1.StringExtensions.IsNullOrEmpty(this.adaptable.adaptableOptions.primaryKey)) {
+        if (StringExtensions.IsNullOrEmpty(this.adaptable.adaptableOptions.primaryKey)) {
             // if no valid pk then always false
             return false;
         }
-        if (Helper_1.Helper.objectExists(this.gridOptions.getRowId)) {
+        if (Helper.objectExists(this.gridOptions.getRowId)) {
             return true;
         }
         const primaryKey = this.adaptable.adaptableOptions.primaryKey;
@@ -129,8 +127,8 @@ class agGridHelper {
                 // this should be taken care of in the Adaptable.[loadDataSource/setDataSource/updateRows]() methods, but the users will always make silly decisions
                 // so just to be safe we'll check here and add a PK value is missing
                 // thus adding a side-effect in a getter, but what can we do against it?! :)
-                if (Helper_1.Helper.objectNotExists(params.data[primaryKey])) {
-                    params.data[primaryKey] = (0, Uuid_1.createUuid)();
+                if (Helper.objectNotExists(params.data[primaryKey])) {
+                    params.data[primaryKey] = createUuid();
                 }
                 return params.data[primaryKey];
             };
@@ -153,13 +151,13 @@ class agGridHelper {
         return true;
     }
     createCheckboxRendererComp(columnId, isColumnReadOnly) {
-        return (0, CheckboxRenderer_1.getCheckboxRendererForColumn)(columnId, isColumnReadOnly, this.adaptable.api);
+        return getCheckboxRendererForColumn(columnId, isColumnReadOnly, this.adaptable.api);
     }
     createPercentBarRendererComp(styledColumn, abColumn) {
-        return (0, PercentBarRenderer_1.getPercentBarRendererForColumn)(styledColumn, abColumn, this.adaptable.api);
+        return getPercentBarRendererForColumn(styledColumn, abColumn, this.adaptable.api);
     }
     createBadgeRendererComp(styledColumn, abColumn) {
-        return (0, BadgeRenderer_1.getBadgeRendererForColumn)(styledColumn, abColumn, this.adaptable.api);
+        return getBadgeRendererForColumn(styledColumn, abColumn, this.adaptable.api);
     }
     getCleanValue(value) {
         if (typeof value === 'string') {
@@ -206,9 +204,9 @@ class agGridHelper {
                 : null;
             friendlyName =
                 customFriendlyName !== null && customFriendlyName !== void 0 ? customFriendlyName : (isActionRowButtonColumn
-                    ? GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME
+                    ? ADAPTABLE_ROW_ACTION_BUTTONS_FRIENDLY_NAME
                     : isFdc3MainActionColumn
-                        ? GeneralConstants_1.ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME
+                        ? ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME
                         : displayName);
             // Add Column Group;s friendlyname to the Column Friendly Name if its in a legitimate Column Group
             if (this.adaptable.adaptableOptions.columnOptions.addColumnGroupToColumnFriendlyName &&
@@ -223,7 +221,7 @@ class agGridHelper {
         }
         const dataType = this.getColumnDataType(agGridColumn, false);
         const abColumn = {
-            Uuid: (0, Uuid_1.createUuid)(),
+            Uuid: createUuid(),
             columnId: ColumnId,
             field: colDef.field,
             friendlyName: friendlyName,
@@ -232,6 +230,7 @@ class agGridHelper {
             visible: agGridColumn.isVisible(),
             readOnly: this.isColumnReadonly(colDef),
             columnGroup: ColumnGroup,
+            fieldOnly: this.isColumnFieldonly(colDef),
             sortable: this.isColumnSortable(colDef),
             filterable: this.isColumnFilterable(colDef),
             groupable: this.isColumnRowGroupable(colDef),
@@ -271,8 +270,8 @@ class agGridHelper {
             labelDefault: GeneralConstants.ADAPTABLE,
             labelKey: 'adaptable',
             iconKey: 'menu',
-            width: UIHelper_1.default.getAdaptableToolPanelWidth(),
-            minWidth: UIHelper_1.default.getAdaptableToolPanelWidth(),
+            width: UIHelper.getAdaptableToolPanelWidth(),
+            minWidth: UIHelper.getAdaptableToolPanelWidth(),
             // maxWidth = undefined,
         };
     }
@@ -290,7 +289,7 @@ class agGridHelper {
     // We do this by gettng the selected cells, clearing the selection and then re-applying
     reselectSelectedCells() {
         const selectedCellRanges = this.gridOptions.api.getCellRanges();
-        if (ArrayExtensions_1.ArrayExtensions.CorrectLength(selectedCellRanges, 1)) {
+        if (ArrayExtensions.CorrectLength(selectedCellRanges, 1)) {
             const selectedCellRange = selectedCellRanges[0];
             const cellRangeParams = {
                 rowStartIndex: selectedCellRange.startRow.rowIndex,
@@ -319,6 +318,12 @@ class agGridHelper {
         // otherwise we evaluate the colDef.editable property (columns are NOT editable by default)
         return !colDef.editable;
     }
+    isColumnFieldonly(colDef) {
+        if (colDef.hide == true && colDef.initialHide == true && colDef.lockVisible == true) {
+            return true;
+        }
+        return false;
+    }
     isColumnSortable(colDef) {
         if (colDef && colDef.sortable != null) {
             return colDef.sortable;
@@ -362,7 +367,7 @@ class agGridHelper {
         if (!colDef) {
             return false;
         }
-        if (colDef.colId === GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS) {
+        if (colDef.colId === ADAPTABLE_ROW_ACTION_BUTTONS) {
             return false;
         }
         const abColumnBase = {
@@ -376,7 +381,7 @@ class agGridHelper {
         if (!colDef) {
             return false;
         }
-        if (colDef.colId === GeneralConstants_1.ADAPTABLE_ROW_ACTION_BUTTONS) {
+        if (colDef.colId === ADAPTABLE_ROW_ACTION_BUTTONS) {
             return false;
         }
         const abColumnBase = {
@@ -478,7 +483,7 @@ class agGridHelper {
         // if it's a group we need the content of the group
         if (row.group) {
             const childNodes = row.childrenAfterGroup;
-            if (ArrayExtensions_1.ArrayExtensions.IsNullOrEmpty(childNodes)) {
+            if (ArrayExtensions.IsNullOrEmpty(childNodes)) {
                 this.adaptable.logger.warn(`No data in grid so returning type "Unknown" for Column: "${column.getColId()}"`);
                 return 'Unknown';
             }
@@ -570,20 +575,20 @@ class agGridHelper {
     }
     checkShouldClearExistingFiltersOrSearches() {
         // if they have selected to clear column filters on startup then do it
-        if (this.adaptable.adaptableOptions.filterOptions.clearFiltersOnStartUp) {
-            if (ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.filterApi.getColumnFilters())) {
+        if (this.adaptable.adaptableOptions.columnFilterOptions.clearFiltersOnStartUp) {
+            if (ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.columnFilterApi.getColumnFilters())) {
                 this.adaptable.logger.warn('Clearing existing Column Filters as "clearFiltersOnStartUp" is true');
-                this.adaptable.api.filterApi.clearColumnFilters();
+                this.adaptable.api.columnFilterApi.clearColumnFilters();
             }
         }
         // if they have selected to clear searches on startup then do it
         if (this.adaptable.adaptableOptions.quickSearchOptions.clearSearchesOnStartUp) {
-            if (StringExtensions_1.StringExtensions.IsNotNullOrEmpty(this.adaptable.api.quickSearchApi.getQuickSearchState().QuickSearchText) ||
-                StringExtensions_1.StringExtensions.IsNotNullOrEmpty(this.adaptable.api.queryApi.getCurrentQuery()) ||
-                ArrayExtensions_1.ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.dataSetApi.getDataSets())) {
+            if (StringExtensions.IsNotNullOrEmpty(this.adaptable.api.quickSearchApi.getQuickSearchState().QuickSearchText) ||
+                StringExtensions.IsNotNullOrEmpty(this.adaptable.api.gridFilterApi.getCurrentGridFilterExpression()) ||
+                ArrayExtensions.IsNotNullOrEmpty(this.adaptable.api.dataSetApi.getDataSets())) {
                 this.adaptable.logger.warn('Clearing existing Searches as "clearSearchesOnStartUp" is true');
                 this.adaptable.api.quickSearchApi.clearQuickSearch();
-                this.adaptable.api.queryApi.clearCurrentQuery();
+                this.adaptable.api.gridFilterApi.setGridFilterExpression('');
                 this.adaptable.api.dataSetApi.clearCurrentDataSet();
             }
         }
@@ -665,4 +670,3 @@ class agGridHelper {
         };
     }
 }
-exports.agGridHelper = agGridHelper;