@adaptabletools/adaptable 17.0.0-canary.6 → 17.0.0-canary.7

package/package.json

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

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1704985790545;
+declare const _default: 1705046977618;
 export default _default;

package/publishTimestamp.js

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -295,6 +295,7 @@ export interface IAdaptable {
         destroyApi?: boolean;
     }): void;
     setRowGroupColumns(columnIds: string[]): void;
+    getAgGridAllGridColumns(): Column<any>[];
     clearRowGroupColumns(): void;
     expandAllRowGroups(): void;
     closeAllRowGroups(): void;

package/src/AdaptableOptions/EditOptions.d.ts

@@ -9,7 +9,7 @@ export interface EditOptions<TData = any> {
     /**
      * Function to validate AdapTable data edits on Server
      */
-    validateOnServer?: (serverValidationContext: ServerValidationContext<TData>) => Promise<ValidationResult>;
+    validateOnServer?: (serverValidationContext: ServerValidationContext<TData>) => Promise<ServerValidationResult>;
     /**
      * Whether to display message after Server Validation runs
      *
@@ -29,26 +29,26 @@ export interface EditOptions<TData = any> {
 /**
  * Used for Server Validation ie. after an edit in AG Grid which must be checked on Server
  */
-export interface ValidationResult {
+export interface ServerValidationResult {
     /**
      * Header to diplay with validation
      * @defaultValue 'Server Validation Message',
      */
-    ValidationHeader?: string;
+    validationHeader?: string;
     /**
      * Message to diplay with validation
      */
-    ValidationMessage?: string;
+    validationMessage?: string;
     /**
      * Cell Value to use for after Server Validation
      */
-    NewValue?: any;
+    newCellValue?: any;
     /**
      * Type of Message to Display
      * @defaultValue Info
      *
      */
-    MessageType?: AdaptableMessageType;
+    messageType?: AdaptableMessageType;
 }
 /**
  * Custom Operation used in Smart Edit Module

package/src/AdaptableOptions/GridFilterOptions.d.ts

@@ -3,11 +3,11 @@
  */
 export interface GridFilterOptions<TData = any> {
     /**
-     * Where Grid Filter can be edited - Expression Editor, Query Builder or Both
+     * Which UI Components can be used to edit a Grid Filter: Expression Editor, Query Builder or Both
      *
-     * @defaultValue 'Both'
+     * @defaultValue ['ExpressionEditor', 'QueryBuilder']
      */
-    availableFilterEditors?: 'ExpressionEditor' | 'QueryBuilder' | 'Both';
+    availableFilterEditors?: GridFilterEditors;
     /**
    * Clears a saved Grid Filter when AdapTable loads
    *
@@ -16,3 +16,8 @@ export interface GridFilterOptions<TData = any> {
    */
     clearGridFilterOnStartUp?: boolean;
 }
+export type GridFilterEditors = GridFilterEditor[];
+/**
+ * List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button
+ */
+export type GridFilterEditor = 'ExpressionEditor' | 'QueryBuilder';

package/src/Api/GridFilterApi.d.ts

@@ -23,11 +23,11 @@ export interface GridFilterApi {
      */
     clearGridFilter(): void;
     /**
-     * Opens the Expression Editor
+     * Opens the AdapTableQL UI Components (Expression Editor & Query Builder)
      *
      * @param expression current Grid Filter expression
      */
-    openExpressionEditorForGridFilter(expression?: string): void;
+    openUIEditorForGridFilter(expression?: string): void;
     /**
      * Suspends the Grid Filter
      */

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

@@ -10,7 +10,7 @@ export declare class GridFilterApiImpl extends ApiBase implements GridFilterApi
     getCurrentGridFilterExpression(): string | undefined;
     setGridFilterExpression(filter: string): void;
     clearGridFilter(): void;
-    openExpressionEditorForGridFilter(expression?: string): void;
+    openUIEditorForGridFilter(expression?: string): void;
     suspendGridFilter(): void;
     unSuspendGridFilter(): void;
 }

package/src/Api/Implementation/GridFilterApiImpl.js

@@ -26,7 +26,7 @@ class GridFilterApiImpl extends ApiBase_1.ApiBase {
     clearGridFilter() {
         this.dispatchAction(LayoutRedux.LayoutGridFilterClear());
     }
-    openExpressionEditorForGridFilter(expression) {
+    openUIEditorForGridFilter(expression) {
         const preparedQuery = expression !== null && expression !== void 0 ? expression : this.getCurrentGridFilterExpression();
         this.getAdaptableApi().internalApi.showPopupWindow({
             id: windowFactory_1.WINDOW_GRID_FILTER_EDITOR,

package/src/Api/Internal/LayoutInternalApi.js

@@ -62,16 +62,15 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         let layoutState = this.getLayoutApi().getLayoutState();
         const isLayoutDefined = (layoutName) => !!layoutState.Layouts.filter((layout) => layout.Name === layoutName)[0];
         let defaultLayoutColumns = gridState.Columns.filter((column) => column.visible);
-        const columnsMap = gridState.Columns.reduce((acc, col) => {
-            acc[col.columnId] = col;
-            return acc;
-        }, {});
         let shouldCreateDefaultLayout = this.getLayoutOptions().createDefaultLayout;
         if (!layoutState.Layouts || !layoutState.Layouts.length) {
             shouldCreateDefaultLayout = true;
         }
         if (shouldCreateDefaultLayout) {
             if (!layoutState.Layouts || !isLayoutDefined(GeneralConstants_1.DEFAULT_LAYOUT)) {
+                // augogroup columns are not in columns list
+                // the code that adds column ok grid state explicitly ignores autoColumns
+                const allGridColumns = this.adaptable.getAgGridAllGridColumns();
                 let defaultLayout = ObjectFactory_1.default.CreateEmptyLayout({
                     Name: GeneralConstants_1.DEFAULT_LAYOUT,
                     Columns: defaultLayoutColumns.map((c) => c.columnId),
@@ -81,9 +80,10 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
                         }
                         return acc;
                     }, {}),
-                    PinnedColumnsMap: defaultLayoutColumns.reduce((acc, col) => {
-                        if (col.pinned) {
-                            acc[col.columnId] = col.pinned;
+                    PinnedColumnsMap: allGridColumns.reduce((acc, col) => {
+                        const pinned = col.getPinned();
+                        if (pinned) {
+                            acc[col.getColId()] = pinned === true ? 'left' : pinned;
                         }
                         return acc;
                     }, {}),

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -225,7 +225,7 @@ exports.DefaultAdaptableOptions = {
         showSuspendFilterButton: false,
     },
     gridFilterOptions: {
-        availableFilterEditors: 'Both',
+        availableFilterEditors: ['ExpressionEditor', 'QueryBuilder'],
         clearGridFilterOnStartUp: false,
     },
     predicateOptions: {

package/src/Utilities/Services/ValidationService.js

@@ -99,29 +99,29 @@ class ValidationService {
                 .validateOnServer(serverValidationContext)
                 .then((validationResult) => {
                 var _a, _b;
-                if (validationResult.NewValue === undefined) {
-                    validationResult.NewValue = cellDataChangedInfo.newValue;
+                if (validationResult.newCellValue === undefined) {
+                    validationResult.newCellValue = cellDataChangedInfo.newValue;
                 }
                 // If they have changed the return value then we should update the grid, log the function change
                 // otherwise the value will persist
-                if (validationResult.NewValue !== cellDataChangedInfo.newValue) {
-                    cellDataChangedInfo.newValue = validationResult.NewValue;
+                if (validationResult.newCellValue !== cellDataChangedInfo.newValue) {
+                    cellDataChangedInfo.newValue = validationResult.newCellValue;
                     // this.adaptable.setValue(cellDataChangedInfo, false);
                     const row = (_a = cellDataChangedInfo.rowNode) === null || _a === void 0 ? void 0 : _a.data;
                     if (!row) {
                         return;
                     }
-                    row[(_b = this.adaptableApi.columnApi.internalApi.getAgGridColumnFieldForAdaptableColumn(cellDataChangedInfo.column.columnId)) !== null && _b !== void 0 ? _b : cellDataChangedInfo.column.columnId] = validationResult.NewValue;
+                    row[(_b = this.adaptableApi.columnApi.internalApi.getAgGridColumnFieldForAdaptableColumn(cellDataChangedInfo.column.columnId)) !== null && _b !== void 0 ? _b : cellDataChangedInfo.column.columnId] = validationResult.newCellValue;
                     this.adaptableApi.gridApi.updateGridData([row]);
-                    if (StringExtensions_1.default.IsNotNullOrEmpty(validationResult.ValidationMessage) &&
+                    if (StringExtensions_1.default.IsNotNullOrEmpty(validationResult.validationMessage) &&
                         this.adaptableApi.optionsApi.getEditOptions().displayServerValidationMessages) {
-                        const validationHeader = validationResult.ValidationHeader
-                            ? validationResult.ValidationHeader
+                        const validationHeader = validationResult.validationHeader
+                            ? validationResult.validationHeader
                             : GeneralConstants_1.SERVER_VALIDATION_HEADER;
-                        const messageType = validationResult.MessageType
-                            ? validationResult.MessageType
+                        const messageType = validationResult.messageType
+                            ? validationResult.messageType
                             : GeneralConstants_1.SERVER_VALIDATION_MESSAGE_TYPE;
-                        this.adaptableApi.alertApi.showAlert(validationHeader, validationResult.ValidationMessage, messageType);
+                        this.adaptableApi.alertApi.showAlert(validationHeader, validationResult.validationMessage, messageType);
                     }
                 }
                 config.onServerValidationCompleted();

package/src/View/GridFilter/GridFilterViewPanel.js

@@ -8,6 +8,7 @@ const DropdownButton_1 = tslib_1.__importDefault(require("../../components/Dropd
 const FieldWrap_1 = tslib_1.__importDefault(require("../../components/FieldWrap"));
 const icons_1 = require("../../components/icons");
 const Input_1 = tslib_1.__importDefault(require("../../components/Input"));
+const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const ButtonClear_1 = require("../Components/Buttons/ButtonClear");
 const ButtonExpand_1 = require("../Components/Buttons/ButtonExpand");
 const ButtonInvalid_1 = require("../Components/Buttons/ButtonInvalid");
@@ -33,9 +34,10 @@ const QueryViewPanelComponent = (props) => {
         return props.viewType === 'Toolbar' ? (React.createElement(FieldWrap_1.default, { marginRight: 1, width: 500 },
             buttonExpand,
             React.createElement(Input_1.default, { disabled: isSuspended || gridFilterAccessLevel == 'ReadOnly', type: "text", "data-name": "grid-filter-input", placeholder: "Grid Filter", spellCheck: false, value: expression, onChange: (x) => setExpression(x.target.value), style: { fontFamily: 'monospace', fontSize: 12 } }),
-            isExpressionValid ? (React.createElement(ButtonPlay_1.ButtonPlay, { onClick: () => runQuery(), tooltip: '', accessLevel: gridFilterAccessLevel, variant: "text", tone: "neutral", disabled: isSuspended || expression == '' || expression == (gridFilter === null || gridFilter === void 0 ? void 0 : gridFilter.Expression), marginRight: 1 })) : (React.createElement(ButtonInvalid_1.ButtonInvalid, { variant: "text", tone: "neutral", tooltip: "Invalid Grid Filter", marginRight: 1 })),
+            isExpressionValid && (React.createElement(ButtonPlay_1.ButtonPlay, { onClick: () => runQuery(), tooltip: '', accessLevel: gridFilterAccessLevel, variant: "text", tone: "neutral", disabled: isSuspended || expression == '' || expression == (gridFilter === null || gridFilter === void 0 ? void 0 : gridFilter.Expression), marginRight: 1 })),
+            gridFilter && !isExpressionValid && (React.createElement(ButtonInvalid_1.ButtonInvalid, { variant: "text", tone: "neutral", tooltip: "Invalid Grid Filter", marginRight: 1 })),
             ' ',
-            (gridFilter === null || gridFilter === void 0 ? void 0 : gridFilter.Expression) !== '' && (React.createElement(ButtonClear_1.ButtonClear, { onClick: () => clearQuery(), tooltip: "Clear Grid Filter", accessLevel: gridFilterAccessLevel })))) : (React.createElement(FieldWrap_1.default, null,
+            StringExtensions_1.default.IsNotNullOrEmpty(expression) && (React.createElement(ButtonClear_1.ButtonClear, { onClick: () => clearQuery(), tooltip: "Clear Grid Filter", accessLevel: gridFilterAccessLevel })))) : (React.createElement(FieldWrap_1.default, null,
             ' ',
             buttonExpand,
             React.createElement(Input_1.default, { disabled: isSuspended || gridFilterAccessLevel == 'ReadOnly', type: "text", "data-name": "grid-filter-input", placeholder: "Grid Filter", spellCheck: false, value: expression, onChange: (x) => setExpression(x.target.value), style: { width: '100%' } })));

package/src/View/GridFilter/useGridFilterExpressionEditor.js

@@ -115,7 +115,7 @@ const useGridFilterExpressionEditor = () => {
         availableColumns,
         runQuery,
         clearQuery,
-        onExpand: () => adaptable.api.gridFilterApi.openExpressionEditorForGridFilter(expression),
+        onExpand: () => adaptable.api.gridFilterApi.openUIEditorForGridFilter(expression),
         saveQuery,
         suspendGridFilter,
         unSuspendGridFilter,

package/src/View/GridFilter/useGridFilterOptionsForExpressionEditor.js

@@ -4,28 +4,10 @@ exports.useGridFilterOptionsForExpressionEditorProps = void 0;
 const AdaptableContext_1 = require("../AdaptableContext");
 const useGridFilterOptionsForExpressionEditorProps = () => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
-    const gridfilterOptions = adaptable.api.optionsApi.getGridFilterOptions();
-    switch (gridfilterOptions.availableFilterEditors) {
-        case 'Both':
-            return {
-                showQueryBuilder: true,
-                showExpressionEditor: true,
-            };
-        case 'QueryBuilder':
-            return {
-                showQueryBuilder: true,
-                showExpressionEditor: false,
-            };
-        case 'ExpressionEditor':
-            return {
-                showQueryBuilder: false,
-                showExpressionEditor: true,
-            };
-        default:
-            return {
-                showQueryBuilder: true,
-                showExpressionEditor: true,
-            };
-    }
+    const gridFilterEditors = adaptable.api.optionsApi.getGridFilterOptions().availableFilterEditors;
+    return {
+        showQueryBuilder: gridFilterEditors.includes('QueryBuilder'),
+        showExpressionEditor: gridFilterEditors.includes('ExpressionEditor'),
+    };
 };
 exports.useGridFilterOptionsForExpressionEditorProps = useGridFilterOptionsForExpressionEditorProps;

package/src/View/Layout/Wizard/sections/GridFilterSection.js

@@ -34,11 +34,11 @@ const GridFilterSection = (props) => {
     const { data: layout } = (0, OnePageAdaptableWizard_1.useOnePageAdaptableWizardContext)();
     const initialData = React.useMemo(() => api.internalApi.getQueryPreviewData(), []);
     const expressionEditorProps = (0, useGridFilterOptionsForExpressionEditor_1.useGridFilterOptionsForExpressionEditorProps)();
+    const expressionEditorContent = (React.createElement(ExpressionEditor_1.ExpressionEditor, Object.assign({}, expressionEditorProps, { allowSaveNamedQuery: false, type: 'boolean', module: ModuleConstants_1.GridFilterModuleId, value: (_b = (_a = layout === null || layout === void 0 ? void 0 : layout.GridFilter) === null || _a === void 0 ? void 0 : _a.Expression) !== null && _b !== void 0 ? _b : '', onChange: (expression) => {
+            props.onChange(Object.assign(Object.assign({}, layout), { GridFilter: Object.assign(Object.assign({}, layout.GridFilter), { Expression: expression }) }));
+        }, initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.namedQueryApi.getNamedQueries(), api: api })));
     return (React.createElement(Tabs_1.Tabs, { style: { height: '100%' } },
         React.createElement(Tabs_1.Tabs.Tab, null, "Grid Filters"),
-        React.createElement(Tabs_1.Tabs.Content, null,
-            React.createElement(ExpressionEditor_1.ExpressionEditor, Object.assign({}, expressionEditorProps, { allowSaveNamedQuery: false, type: 'boolean', module: ModuleConstants_1.GridFilterModuleId, value: (_b = (_a = layout === null || layout === void 0 ? void 0 : layout.GridFilter) === null || _a === void 0 ? void 0 : _a.Expression) !== null && _b !== void 0 ? _b : '', onChange: (expression) => {
-                    props.onChange(Object.assign(Object.assign({}, layout), { GridFilter: Object.assign(Object.assign({}, layout.GridFilter), { Expression: expression }) }));
-                }, initialData: initialData, columns: api.columnApi.getQueryableColumns(), namedQueries: api.namedQueryApi.getNamedQueries(), api: api })))));
+        React.createElement(Tabs_1.Tabs.Content, null, expressionEditorContent)));
 };
 exports.GridFilterSection = GridFilterSection;

package/src/View/NamedQuery/EditCurrentQueryButton.js

@@ -9,7 +9,7 @@ const EditGridFilterButton = () => {
     const adaptable = (0, AdaptableContext_1.useAdaptable)();
     const handleClick = React.useCallback((event) => {
         event.stopPropagation();
-        adaptable.api.gridFilterApi.openExpressionEditorForGridFilter();
+        adaptable.api.gridFilterApi.openUIEditorForGridFilter();
     }, []);
     return React.createElement(SimpleButton_1.default, { variant: "text", iconSize: 15, onClick: handleClick, icon: "edit" });
 };

package/src/agGrid/Adaptable.d.ts

@@ -41,6 +41,9 @@ import { AdaptableLogger } from './AdaptableLogger';
 import { Fdc3Service } from '../Utilities/Services/Fdc3Service';
 type RuntimeConfig = {
     waitForAgGrid?: boolean;
+    /**
+     * @deprecated
+     */
     renderReactRoot?: RenderReactRootFn;
     variant?: AdaptableVariant;
     gridOptions: AgGridConfig['gridOptions'];
@@ -361,6 +364,7 @@ export declare class Adaptable implements IAdaptable {
     closeAllRowGroups(): void;
     expandRowGroupsForValues(columnValues: any[]): void;
     getAgGridColumnForColumnId(columnId: string): Column;
+    getAgGridAllGridColumns(): Column<any>[];
     setRowGroupColumns(columnIds: string[]): void;
     clearRowGroupColumns(): void;
     getExpandRowGroupsKeys(): any[];

package/src/agGrid/Adaptable.js

@@ -361,24 +361,6 @@ class Adaptable {
     async init(adaptableOptions, runtimeConfig, _staticInit) {
         this.logger = new AdaptableLogger_1.AdaptableLogger(adaptableOptions.adaptableId || String(Date.now()));
         const perfAdaptableInit = this.logger.beginPerf(`Adaptable init()`);
-        if (runtimeConfig.renderReactRoot) {
-            this.renderReactRoot = (el, container) => {
-                const unmount = runtimeConfig.renderReactRoot(el, container);
-                return () => {
-                    // we used to capture here because of FloatingFilters/Filters - see FloatingFilterWrapper and FilterWrapper
-                    // as we didn't have a native React implementation for our React wrapper
-                    // but we might need to do this again in the future for some other components that are not native React
-                    // captureReactWarnings();
-                    if (typeof unmount === 'function') {
-                        // rAF is required, otherwise the unmount would be performed during the rendering phase and React doesn't like that
-                        requestAnimationFrame(() => {
-                            unmount();
-                        });
-                    }
-                    // releaseReactWarnings();
-                };
-            };
-        }
         if (runtimeConfig.variant) {
             this.variant = runtimeConfig.variant;
         }
@@ -4179,6 +4161,9 @@ class Adaptable {
     getAgGridColumnForColumnId(columnId) {
         return this.gridOptions.columnApi.getColumn(columnId);
     }
+    getAgGridAllGridColumns() {
+        return this.gridOptions.columnApi.getAllGridColumns();
+    }
     setRowGroupColumns(columnIds) {
         this.gridOptions.columnApi.setRowGroupColumns(columnIds);
     }

package/src/metamodel/adaptable.metamodel.d.ts

@@ -3558,6 +3558,11 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    GridFilterEditor: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     GridFilterOptions: {
         name: string;
         kind: string;
@@ -3568,6 +3573,7 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
             isOpt: boolean;
             defVal: string;
+            ref: string;
             gridInfo?: undefined;
         } | {
             name: string;
@@ -3576,6 +3582,7 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
             gridInfo: string;
             defVal: string;
+            ref?: undefined;
         })[];
     };
     GridRow: {
@@ -4819,6 +4826,33 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
         }[];
     };
+    ServerValidationResult: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            ref: string;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal?: undefined;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+            ref?: undefined;
+        })[];
+    };
     SetPrimaryKeyValueContext: {
         name: string;
         kind: string;
@@ -5463,33 +5497,6 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt?: undefined;
         })[];
     };
-    ValidationResult: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: ({
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            defVal: string;
-            ref: string;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            defVal?: undefined;
-            ref?: undefined;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            defVal: string;
-            ref?: undefined;
-        })[];
-    };
     ValuationContext: {
         name: string;
         kind: string;