@adaptabletools/adaptable 19.2.4 → 20.0.0-canary.0

package/src/Api/Internal/RowFormInternalApi.js

@@ -0,0 +1,200 @@
+import { ApiBase } from '../Implementation/ApiBase';
+export class RowFormInternalApi extends ApiBase {
+    // Row Form Methods
+    buildRowEditForm(rowNode) {
+        return this.buildRowForm('rowEdited', rowNode);
+    }
+    buildRowCreateForm(clonedRowNode) {
+        return this.buildRowForm('rowCreated', clonedRowNode);
+    }
+    buildRowForm(type, rowNode) {
+        const formFields = this.buildRowFormFields(type, rowNode);
+        const formButtons = this.buidRowFormButtons(type, rowNode, formFields);
+        const formTitle = this.getFormTitle(type, rowNode);
+        const formDescription = this.getFormDescription(type, rowNode);
+        const rowForm = {
+            title: formTitle,
+            description: formDescription,
+            fields: formFields,
+            buttons: formButtons,
+        };
+        return rowForm;
+    }
+    getFormTitle(type, rowNode) {
+        const rowFormOptions = this.getRowFormOptions();
+        if (rowFormOptions.rowFormTitle == undefined) {
+            return type === 'rowCreated' ? 'Create New Row' : 'Edit Row';
+        }
+        return typeof rowFormOptions.rowFormTitle === 'function'
+            ? rowFormOptions.rowFormTitle(this.buildFormParamContext(type, rowNode))
+            : rowFormOptions.rowFormTitle;
+    }
+    buildFormParamContext(type, rowNode) {
+        return {
+            rowNode,
+            ...this.getAdaptableInternalApi().buildBaseContext(),
+            type: type,
+        };
+    }
+    getFormDescription(type, rowNode) {
+        const rowFormOptions = this.getRowFormOptions();
+        return typeof rowFormOptions.rowFormDescription === 'function'
+            ? rowFormOptions.rowFormDescription(this.buildFormParamContext(type, rowNode))
+            : rowFormOptions.rowFormDescription;
+    }
+    buidRowFormButtons(type, rowNode, formFields) {
+        // 1. check if there are custom user provided buttons
+        if (Array.isArray(this.getRowFormOptions().rowFormButtons)) {
+            return this.getRowFormOptions().rowFormButtons;
+        }
+        // 2. else return the standard ones
+        const cancelButton = {
+            label: 'Cancel',
+            buttonStyle: {
+                variant: 'raised',
+                tone: 'neutral',
+            },
+        };
+        const saveButton = {
+            label: 'Save',
+            buttonStyle: {
+                variant: 'raised',
+                tone: 'success',
+            },
+            onClick: (button, context) => {
+                // textOutput should not be saved, their values are set to display values
+                // we need to filter out the textOutput fields and add the primaryKey
+                const eventInfo = type === 'rowCreated'
+                    ? {
+                        type: 'rowCreated',
+                        formData: this.prepareCreateData(formFields, context),
+                        ...this.getAdaptableInternalApi().buildBaseContext(),
+                        clonedRowNode: rowNode,
+                    }
+                    : {
+                        type: 'rowEdited',
+                        formData: this.prepareEditData(formFields, context),
+                        rowNode: rowNode,
+                        ...this.getAdaptableInternalApi().buildBaseContext(),
+                    };
+                this.getEventApi().internalApi.fireRowFormSubmittedEvent(eventInfo);
+                this.getRowFormOptions()?.onRowFormSubmit?.(eventInfo);
+            },
+        };
+        return [cancelButton, saveButton];
+    }
+    prepareCreateData(formFields, context) {
+        // when creating we just omit values that are not set
+        const dataToSave = { ...context.formData };
+        for (const formField of formFields) {
+            if (dataToSave[formField.name] === '') {
+                delete dataToSave[formField.name];
+            }
+        }
+        return dataToSave;
+    }
+    prepareEditData(formFields, context) {
+        const dataToSave = { ...context.formData };
+        for (const formField of formFields) {
+            if (formField.fieldType === 'textOutput') {
+                delete dataToSave[formField.name];
+            }
+        }
+        const pkValue = this.getGridApi().getPrimaryKeyValueForRowNode(context.rowNode);
+        dataToSave[this.getOptions().primaryKey] = pkValue;
+        return dataToSave;
+    }
+    buildRowFormFields(rowFormType, rowNode) {
+        const relevantColumns = this.getColumnApi()
+            .getColumns()
+            .filter((column) => {
+            // if there is NO rowNode, do NOT display the non-editable fields as they will be empty
+            return !!rowNode || this.isCellEditable(column, rowNode);
+        })
+            .filter((column) => this.showColumnInRowForm(column, rowFormType));
+        return relevantColumns.map((column) => this.buildRowFormField(rowFormType, column, rowNode));
+    }
+    showColumnInRowForm(adaptableColumn, rowFormType) {
+        const showColumnFn = this.getRowFormOptions()?.includeColumnInRowForm;
+        if (typeof showColumnFn === 'function') {
+            return showColumnFn({
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+                adaptableColumn,
+                rowFormType: rowFormType,
+            });
+        }
+        return true;
+    }
+    isCellEditable(column, rowNode) {
+        if (!rowNode) {
+            return !column.readOnly;
+        }
+        const gridCell = this.getGridApi().getGridCellFromRowNode(rowNode, column.columnId);
+        return this.getGridApi().isCellEditable(gridCell);
+    }
+    buildRowFormField(type, column, rowNode) {
+        const isCellEditable = this.isCellEditable(column, rowNode);
+        const fieldValueOptions = this.getFieldValueOptions(column, rowNode);
+        const fieldType = isCellEditable
+            ? !!fieldValueOptions?.length
+                ? 'select'
+                : this.getFieldTypeFromColumnType(column)
+            : 'textOutput';
+        const defaultValue = rowNode
+            ? isCellEditable
+                ? this.getGridApi().getRawValueFromRowNode(rowNode, column.columnId)
+                : this.getGridApi().getDisplayValueFromRowNode(rowNode, column.columnId)
+            : null;
+        return {
+            label: this.getRowFormFieldLabel(type, column, rowNode),
+            name: column.columnId,
+            defaultValue,
+            fieldType,
+            options: fieldValueOptions,
+        };
+    }
+    getRowFormFieldLabel(type, column, rowNode) {
+        const customFieldLabel = typeof this.getRowFormOptions().rowFormFieldLabel === 'function'
+            ? this.getRowFormOptions().rowFormFieldLabel(this.buildFormFieldLabelContext(type, column, rowNode))
+            : undefined;
+        return customFieldLabel ?? column.friendlyName;
+    }
+    buildFormFieldLabelContext(type, column, rowNode) {
+        return {
+            rowNode,
+            column,
+            ...this.getAdaptableInternalApi().buildBaseContext(),
+            type: type,
+        };
+    }
+    getFieldTypeFromColumnType(column) {
+        switch (column.dataType) {
+            case 'boolean':
+                return 'checkbox';
+            case 'date':
+                return 'date';
+            case 'number':
+                return 'number';
+            default:
+                // everything else is a plain text input
+                return 'text';
+        }
+    }
+    getFieldValueOptions(column, rowNode) {
+        const shouldShowSelectCellEditor = this.getUserInterfaceApi().internalApi.shouldShowSelectCellEditor(column);
+        if (!shouldShowSelectCellEditor) {
+            return;
+        }
+        const returnValues = this.getGridApi().internalApi.getDistinctDisplayValuesForColumnOld(column.columnId);
+        // FIXME add support for asynchronous custom select cell editor values
+        // it involves refactoring the AdaptableForm & AdapatableFormComponent
+        // await this.getSelectCellEditorValuesForColumn(
+        //   column,
+        //   gridCell
+        // );
+        return returnValues?.map((value) => ({
+            value,
+            label: value,
+        }));
+    }
+}

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

@@ -1,8 +1 @@
-import { ApiBase } from '../Implementation/ApiBase';
-import { BaseSchedule } from '../../PredefinedConfig/Common/Schedule';
-export declare class ScheduleInternalApi extends ApiBase {
-    /**
-     * Fires Schedule Triggered event
-     */
-    fireScheduleTriggeredEvent(schedule: BaseSchedule): void;
-}
+export {};

package/src/Api/Internal/ScheduleInternalApi.js

@@ -1,11 +1 @@
-import { ApiBase } from '../Implementation/ApiBase';
-export class ScheduleInternalApi extends ApiBase {
-    /**
-     * Fires Schedule Triggered event
-     */
-    fireScheduleTriggeredEvent(schedule) {
-        const adaptableApi = this.getAdaptableApi();
-        const scheduleTriggeredInfo = Object.assign(Object.assign({}, this.getAdaptableInternalApi().buildBaseContext()), { schedule: schedule });
-        adaptableApi.eventApi.emit('ScheduleTriggered', scheduleTriggeredInfo);
-    }
-}
+export {};

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

@@ -1,7 +1,7 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
 import { BadgeStyle, BadgeStyleDefinition, CellColorRange, ColumnComparison, NumericStyledColumn, StyledColumn } from '../../PredefinedConfig/StyledColumnState';
-import { IRowNode } from '@ag-grid-community/core';
+import { IRowNode } from 'ag-grid-enterprise';
 import { PredicateDefHandlerContext } from '../../types';
 export declare class StyledColumnInternalApi extends ApiBase {
     getMinValueForNumericColumn(column: AdaptableColumn): number | undefined;

package/src/Api/Internal/StyledColumnInternalApi.js

@@ -2,13 +2,13 @@ import { ApiBase } from '../Implementation/ApiBase';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 export class StyledColumnInternalApi extends ApiBase {
     getMinValueForNumericColumn(column) {
-        if (column.dataType !== 'Number') {
+        if (column.dataType !== 'number') {
             return undefined;
         }
         return this._adaptable.getMinMaxCachedValueForColumn(column, 'min');
     }
     getMaxValueForNumericColumn(column) {
-        if (column.dataType !== 'Number') {
+        if (column.dataType !== 'number') {
             return undefined;
         }
         return this._adaptable.getMinMaxCachedValueForColumn(column, 'max');
@@ -20,10 +20,9 @@ export class StyledColumnInternalApi extends ApiBase {
      * @param cellValue current Cell Value
      */
     getNumericStyleMinValue(styledColumn, column, rowNode, cellValue) {
-        var _a, _b;
         const columnComparison = styledColumn.GradientStyle
             ? styledColumn.GradientStyle.ColumnComparison
-            : (_a = styledColumn.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
+            : styledColumn.PercentBarStyle?.ColumnComparison;
         if (columnComparison) {
             if (!isNaN(Number(columnComparison.MinValue))) {
                 return Number(columnComparison.MinValue);
@@ -45,7 +44,7 @@ export class StyledColumnInternalApi extends ApiBase {
         }
         // for percentbar we want to get the whole Ranges
         if (styledColumn.PercentBarStyle) {
-            const ranges = (_b = styledColumn.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
+            const ranges = styledColumn.PercentBarStyle?.CellRanges;
             if (ranges) {
                 return this.getCellColorRangeMinValue(ranges[0], column, styledColumn.PercentBarStyle.RangeValueType);
             }
@@ -83,10 +82,9 @@ export class StyledColumnInternalApi extends ApiBase {
      * @param cellValue current Cell Value
      */
     getNumericStyleMaxValue(styledColumn, column, rowNode, cellValue) {
-        var _a, _b;
         const columnComparison = styledColumn.GradientStyle
             ? styledColumn.GradientStyle.ColumnComparison
-            : (_a = styledColumn.PercentBarStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison;
+            : styledColumn.PercentBarStyle?.ColumnComparison;
         if (columnComparison) {
             if (!isNaN(Number(columnComparison.MaxValue))) {
                 return Number(columnComparison.MaxValue);
@@ -106,7 +104,7 @@ export class StyledColumnInternalApi extends ApiBase {
             return this.getCellColorRangeMaxValue(range, column, styledColumn.GradientStyle.RangeValueType);
         }
         if (styledColumn.PercentBarStyle) {
-            const ranges = (_b = styledColumn.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.CellRanges;
+            const ranges = styledColumn.PercentBarStyle?.CellRanges;
             if (ranges) {
                 return this.getCellColorRangeMaxValue(ranges[ranges.length - 1], column, styledColumn.PercentBarStyle.RangeValueType);
             }
@@ -171,14 +169,13 @@ export class StyledColumnInternalApi extends ApiBase {
      * @param styledColumn Styled Column to Add
      */
     getColumnComparisonForStyledColumn(styledColumn) {
-        var _a, _b;
         if (styledColumn.GradientStyle) {
-            if ((_a = styledColumn.GradientStyle) === null || _a === void 0 ? void 0 : _a.ColumnComparison) {
+            if (styledColumn.GradientStyle?.ColumnComparison) {
                 return styledColumn.GradientStyle.ColumnComparison;
             }
         }
         if (styledColumn.PercentBarStyle) {
-            if ((_b = styledColumn.PercentBarStyle) === null || _b === void 0 ? void 0 : _b.ColumnComparison) {
+            if (styledColumn.PercentBarStyle?.ColumnComparison) {
                 return styledColumn.PercentBarStyle.ColumnComparison;
             }
         }
@@ -217,29 +214,29 @@ export class StyledColumnInternalApi extends ApiBase {
      * @param styledColumn Styled Column to Add
      */
     hasStyledColumnRelativeCellRange(styledColumn) {
-        var _a, _b, _c, _d, _e;
         let cellColorRange = null;
         let rangeValueType = 'Number';
         if (styledColumn.GradientStyle) {
-            if ((_a = styledColumn.GradientStyle) === null || _a === void 0 ? void 0 : _a.CellRanges) {
+            if (styledColumn.GradientStyle?.CellRanges) {
                 cellColorRange = styledColumn.GradientStyle.CellRanges;
             }
-            if ((_b = styledColumn.GradientStyle) === null || _b === void 0 ? void 0 : _b.RangeValueType) {
+            if (styledColumn.GradientStyle?.RangeValueType) {
                 rangeValueType = styledColumn.GradientStyle.RangeValueType;
             }
         }
         if (styledColumn.PercentBarStyle) {
-            if ((_c = styledColumn.PercentBarStyle) === null || _c === void 0 ? void 0 : _c.CellRanges) {
+            if (styledColumn.PercentBarStyle?.CellRanges) {
                 cellColorRange = styledColumn.PercentBarStyle.CellRanges;
             }
-            if ((_d = styledColumn.PercentBarStyle) === null || _d === void 0 ? void 0 : _d.RangeValueType) {
+            if (styledColumn.PercentBarStyle?.RangeValueType) {
                 rangeValueType = styledColumn.PercentBarStyle.RangeValueType;
             }
         }
-        return ((_e = (rangeValueType === 'Percentage' ||
-            (cellColorRange === null || cellColorRange === void 0 ? void 0 : cellColorRange.some((cellColorRange) => {
+        return ((rangeValueType === 'Percentage' ||
+            cellColorRange?.some((cellColorRange) => {
                 return cellColorRange.Min == 'Col-Min' || cellColorRange.Max == 'Col-Max';
-            })))) !== null && _e !== void 0 ? _e : false);
+            })) ??
+            false);
     }
     getApplicableBadge(badgeStyle, context) {
         if (!badgeStyle.Badges.length) {
@@ -262,7 +259,7 @@ export class StyledColumnInternalApi extends ApiBase {
             }
         }
         const [firstBadgeWithAll] = badgesWithAll;
-        return firstBadgeWithAll !== null && firstBadgeWithAll !== void 0 ? firstBadgeWithAll : null;
+        return firstBadgeWithAll ?? null;
     }
     getBadgePredicateDefsForColumn(columnId) {
         const column = this.getColumnApi().getColumnWithColumnId(columnId);
@@ -272,8 +269,8 @@ export class StyledColumnInternalApi extends ApiBase {
         const scope = {
             ColumnIds: [column.columnId],
         };
-        return this.getAdaptableApi()
-            .predicateApi.internalApi.getBadgeStylePredicateDefs(scope)
+        return this.getPredicateApi()
+            .internalApi.getBadgeStylePredicateDefs(scope)
             .filter((predicate) => this.getColumnScopeApi().isColumnInScope(column, predicate.columnScope));
     }
 }

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

@@ -1,11 +1,6 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { SystemStatusMessageInfo } from '../../PredefinedConfig/Common/SystemStatusMessageInfo';
 export declare class SystemStatusInternalApi extends ApiBase {
-    /**
-     * Fires SystemStatusMessageDisplayed Event
-     * @param systemStatusMessageInfo Info about new System Status Message
-     */
-    fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo: SystemStatusMessageInfo): void;
     addSystemStatusMessageInfo(systemStatusMessageInfo: SystemStatusMessageInfo): void;
     getSystemStatusMessageInfos(): SystemStatusMessageInfo[];
 }

package/src/Api/Internal/SystemStatusInternalApi.js

@@ -1,19 +1,11 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import * as SystemRedux from '../../Redux/ActionsReducers/SystemRedux';
+import * as InternalRedux from '../../Redux/ActionsReducers/InternalRedux';
 export class SystemStatusInternalApi extends ApiBase {
-    /**
-     * Fires SystemStatusMessageDisplayed Event
-     * @param systemStatusMessageInfo Info about new System Status Message
-     */
-    fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo) {
-        const systemStatusMessageDisplayedInfo = Object.assign({ systemStatusMessageInfo: systemStatusMessageInfo }, this.getAdaptableInternalApi().buildBaseContext());
-        this.getEventApi().emit('SystemStatusMessageDisplayed', systemStatusMessageDisplayedInfo);
-    }
     addSystemStatusMessageInfo(systemStatusMessageInfo) {
         const maxMessagesInStore = this.getNotificationsOptions().maxSystemMessagesInStore;
-        this.dispatchAction(SystemRedux.SystemStatusMessageInfoAdd(systemStatusMessageInfo, maxMessagesInStore));
+        this.dispatchAction(InternalRedux.SystemStatusMessageInfoAdd(systemStatusMessageInfo, maxMessagesInStore));
     }
     getSystemStatusMessageInfos() {
-        return this.getAdaptableState().System.SystemStatusMessages;
+        return this.getAdaptableState().Internal.SystemStatusMessages;
     }
 }

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

@@ -1,11 +1,6 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptableSharedEntity } from '../../PredefinedConfig/TeamSharingState';
 export declare class TeamSharingInternalApi extends ApiBase {
-    /**
-     * Fires the Team Sharing Entity Changed Event
-     * @param sharedEntity Entity that has been changed
-     */
-    fireTeamSharingEntityChangedEvent(sharedEntity: AdaptableSharedEntity): void;
     /**
      * Retrieves shared entry dependencies.
      */

package/src/Api/Internal/TeamSharingInternalApi.js

@@ -1,22 +1,11 @@
 import { ApiBase } from '../Implementation/ApiBase';
 export class TeamSharingInternalApi extends ApiBase {
-    /**
-     * Fires the Team Sharing Entity Changed Event
-     * @param sharedEntity Entity that has been changed
-     */
-    fireTeamSharingEntityChangedEvent(sharedEntity) {
-        if (this.isAdapTableReady()) {
-            const teamSharingEntityChangedInfo = Object.assign(Object.assign({}, this.getAdaptableInternalApi().buildBaseContext()), { sharedEntity: sharedEntity });
-            this.getEventApi().emit('TeamSharingEntityChanged', teamSharingEntityChangedInfo);
-        }
-    }
     /**
      * Retrieves shared entry dependencies.
      */
     getSharedEntryDependencies(sharedEntity) {
-        var _a;
         const allEntities = this.getTeamSharingApi().getLoadedAdaptableSharedEntities();
-        return ((_a = sharedEntity === null || sharedEntity === void 0 ? void 0 : sharedEntity.EntityDependencyIds) !== null && _a !== void 0 ? _a : []).map((id) => allEntities.find((entity) => entity.Uuid === id));
+        return (sharedEntity?.EntityDependencyIds ?? []).map((id) => allEntities.find((entity) => entity.Uuid === id));
     }
     waitForTeamSharingImportEnd() {
         // we have no deterministic means to ensure the teamsharing import is finished (because the import actions are opaque and may have side-effects)
@@ -28,7 +17,7 @@ export class TeamSharingInternalApi extends ApiBase {
             let pollTimer;
             // stop the poll after `waitThreshold` ms, if the state hasn't stabilised until now, it probably never will...
             let breakTimer = setTimeout(() => {
-                unsubscribe === null || unsubscribe === void 0 ? void 0 : unsubscribe();
+                unsubscribe?.();
                 clearTimeout(pollTimer);
                 reject(false);
             }, waitThreshold);

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

@@ -1,5 +1,6 @@
-import { AdaptableIcon } from '../../types';
+import { AdaptableColumn, AdaptableIcon } from '../../types';
 import { ApiBase } from '../Implementation/ApiBase';
 export declare class UserInterfaceInternalApi extends ApiBase {
     prepareAdaptableIconDef(icon: AdaptableIcon): AdaptableIcon;
+    shouldShowSelectCellEditor(column: AdaptableColumn): boolean;
 }

package/src/Api/Internal/UserInterfaceInternalApi.js

@@ -11,4 +11,15 @@ export class UserInterfaceInternalApi extends ApiBase {
         }
         return icon;
     }
+    shouldShowSelectCellEditor(column) {
+        const showSelectCellEditor = this.getEditOptions().showSelectCellEditor;
+        if (showSelectCellEditor) {
+            const columnColumnContext = {
+                column,
+                ...this.getAdaptableInternalApi().buildBaseContext(),
+            };
+            return showSelectCellEditor(columnColumnContext);
+        }
+        return false;
+    }
 }

package/src/Api/LayoutApi.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableColumn, ColumnSort } from '../../types';
+import { AdaptableColumn, ColumnSort, PivotLayout, TableLayout } from '../../types';
 import { ExtendedLayoutInfo } from '../PredefinedConfig/Common/ExtendedLayoutInfo';
 import { LayoutState, Layout } from '../PredefinedConfig/LayoutState';
 /**
@@ -9,11 +9,6 @@ export interface LayoutApi {
      * Retrieves Layout section from Adaptable State
      */
     getLayoutState(): LayoutState;
-    /**
-     * Whether Layouts are auto saved (based on Layout Options)
-     * @returns boolean
-     */
-    shouldAutoSaveLayouts(): boolean;
     /**
      * Sets (i.e. selects) the Layout
      * @param layoutName Layout to set (has to be name of existing Layout)
@@ -25,7 +20,7 @@ export interface LayoutApi {
      */
     getCurrentLayout(): Layout;
     /**
-     * Returns true if the current layout is a pivot layout
+     * Returns true if current Layout is a Pivot Layout
      */
     isCurrentLayoutPivot(): boolean;
     /**
@@ -36,13 +31,13 @@ export interface LayoutApi {
     /**
      * Retrieves map with visible columns in current Layout
      */
-    getCurrentVisibleColumnIdsMap(): {
+    getCurrentVisibleColumnIdsMapForTableLayout(): {
         [key: string]: boolean;
     };
     /**
      * Retrieves array of visible ColumnIds in current Layout
      */
-    getCurrentVisibleColumnIds(): string[];
+    getCurrentVisibleColumnIdsForTableLayout(): string[];
     /**
      * Retrieves array of visible ColumnIds in current Layout
      */
@@ -84,7 +79,12 @@ export interface LayoutApi {
      */
     createOrUpdateLayout(layout: Layout): void;
     /**
-     * Creates new Layout in the state
+     * Updates current Layout using the partial Layout props provided in a function
+     * @param updateFn a function which returns a full Layout
+     */
+    updateCurrentLayout(updateFn: (layout: TableLayout | PivotLayout) => TableLayout | PivotLayout): void;
+    /**
+     * Creates new Layout in Adaptable State
      * @param layoutToCreate Layout to create
      * @returns created Layout object or `false` if Layout with the same name/Uuid already exists
      */
@@ -123,7 +123,7 @@ export interface LayoutApi {
      * @param layoutName Name of Layout to be edited or cloned; if not specified, uses Current Layout
      * @param action Whether to edit, clone, or create a new Layout
      */
-    showLayoutEditor(layoutName?: string, 
+    showLayoutEditor(layoutName?: string, layoutType?: 'table' | 'pivot', 
     /**
      * @defaultValue 'Edit'
      */
@@ -153,15 +153,6 @@ export interface LayoutApi {
      * @param column Column to open Popup for
      */
     showChangeColumnCaption(column: AdaptableColumn): void;
-    /**
-     * Checks if the given Layout is Default Layout
-     * @param layout Layout to Check
-     */
-    isDefaultLayout(layout: Layout): boolean;
-    /**
-     * Checks if the Current Layout is Default Layout
-     */
-    isCurrentLayoutDefault(): boolean;
     /**
      * Removes a Column from the Current Layout
      * @param columnId Column to remove
@@ -179,14 +170,14 @@ export interface LayoutApi {
      */
     removeColumnFromLayout(columnId: string, layoutName: string): void;
     /**
-     * Adds a Column to a given Layout
+     * Adds a Column to a given Table Layout
      * @param columnId Column to add
      * @param layoutName layout to which to add Column
      */
-    addColumnToLayout(columnId: string, layoutName: string): void;
+    addColumnToTableLayout(columnId: string, layoutName: string): void;
     /**
      * Adds a Column to Current Layout
      * @param columnId Column to add
      */
-    addColumnToCurrentLayout(columnId: string): void;
+    addColumnToCurrentTableLayout(columnId: string): void;
 }

package/src/Api/OptionsApi.d.ts

@@ -1,7 +1,6 @@
 import { CustomSortOptions } from '../AdaptableOptions/CustomSortOptions';
 import { DataSetOptions } from '../AdaptableOptions/DataSetOptions';
-import { GroupingOptions } from '../AdaptableOptions/GroupingOptions';
-import { ActionColumnOptions, ActionRowOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnFilterOptions, ColumnMenuOptions, ColumnOptions, ContainerOptions, ContextMenuOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FlashingCellOptions, FormatColumnOptions, GridFilterOptions, LayoutOptions, NoteOptions, NotificationsOptions, QuickSearchOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
+import { ActionColumnOptions, AdaptableOptions, AlertOptions, CalendarOptions, CellSummaryOptions, ChartingOptions, ColumnMenuOptions, ColumnOptions, ContainerOptions, ContextMenuOptions, DashboardOptions, DataChangeHistoryOptions, EditOptions, EntitlementOptions, ExportOptions, FilterOptions, FlashingCellOptions, FormatColumnOptions, LayoutOptions, NoteOptions, NotificationsOptions, PredicateOptions, QuickSearchOptions, RowFormOptions, SettingsPanelOptions, StateOptions, TeamSharingOptions, ToolPanelOptions, UserInterfaceOptions } from '../types';
 import { Fdc3Options } from '../AdaptableOptions/Fdc3Options';
 import { ExpressionOptions } from '../AdaptableOptions/ExpressionOptions';
 import { DataImportOptions } from '../AdaptableOptions/DataImportOptions';
@@ -21,7 +20,7 @@ export interface OptionsApi {
     /**
      * Returns `AdaptableOptions.autogeneratePrimaryKey`
      */
-    getAutogeneratePrimaryKey(): boolean;
+    isAutogeneratePrimaryKey(): boolean;
     /**
      * Returns `AdaptableOptions.licenseKey`
      */
@@ -42,10 +41,6 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.actionColumnOptions`
      */
     getActionColumnOptions(): Readonly<ActionColumnOptions>;
-    /**
-     * Returns `AdaptableOptions.actionRowOptions`
-     */
-    getActionRowOptions(): Readonly<ActionRowOptions>;
     /**
      * Returns `AdaptableOptions.alertOptions`
      */
@@ -107,21 +102,13 @@ export interface OptionsApi {
      */
     getExportOptions(): Readonly<ExportOptions>;
     /**
-     * Returns `AdaptableOptions.columnFilterOptions`
+     * Returns `AdaptableOptions.filterOptions`
      */
-    getColumnFilterOptions(): Readonly<ColumnFilterOptions>;
-    /**
-     * Returns `AdaptableOptions.gridFilterOptions`
-     */
-    getGridFilterOptions(): Readonly<GridFilterOptions>;
+    getFilterOptions(): Readonly<FilterOptions>;
     /**
      * Returns `AdaptableOptions.flashingCellOptions`
      */
     getFlashingCellOptions(): Readonly<FlashingCellOptions>;
-    /**
-     * Returns `AdaptableOptions.groupingOptions`
-     */
-    getGroupingOptions(): Readonly<GroupingOptions>;
     /**
      * Returns `AdaptableOptions.layoutOptions`
      */
@@ -138,6 +125,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.notificationsOptions`
      */
     getNotificationsOptions(): Readonly<NotificationsOptions>;
+    /**
+     * Returns `AdaptableOptions.rowFormOptions`
+     */
+    getRowFormOptions(): Readonly<RowFormOptions>;
     /**
      * Returns `AdaptableOptions.quickSearchOptions`
      */
@@ -150,6 +141,10 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.noteOptions`
      */
     getNoteOptions(): Readonly<NoteOptions>;
+    /**
+     * Returns `AdaptableOptions.predicateOptions`
+     */
+    getPredicateOptions(): Readonly<PredicateOptions>;
     /**
      * Returns `AdaptableOptions.settingsPanelOptions`
      */
@@ -178,4 +173,23 @@ export interface OptionsApi {
      * Returns `AdaptableOptions.dataImportOptions`
      */
     getDataImportOptions(): Readonly<DataImportOptions>;
+    /**
+     * Returns `AdaptableOptions.adaptableContext`
+     */
+    getAdaptableContext<TContext = Record<string, any>>(): TContext;
+    /**
+     * Adds a key-value pair to the AdaptableContext
+     * @param key - The key to add
+     * @param value - The value to add
+     */
+    addToAdaptableContext<TContext = Record<string, any>>(key: keyof TContext, value: TContext[keyof TContext]): void;
+    /**
+     * Removes a key from the AdaptableContext
+     * @param key - The key to remove
+     */
+    removeFromAdaptableContext<TContext = Record<string, any>>(key: keyof TContext): void;
+    /**
+     * Clears all key-value pairs from the AdaptableContext
+     */
+    clearAdaptableContext(): void;
 }