@adaptabletools/adaptable 22.0.3 → 22.0.4

package/package.json

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

package/src/AdaptableState/InitialState.d.ts

@@ -113,97 +113,3 @@ export interface InitialState {
      */
     UserInterface?: UserInterfaceState;
 }
-/**
- * Deprecated initial state object (now replaced by InitialState)
- * @deprecated Use `InitialState` instead - it has the same structure but is more accurately named
- */
-export interface PredefinedConfig {
-    /**
-     * Collection of `AlertDefinitions` which will fire Alerts when the rule is met
-     */
-    Alert?: AlertState;
-    /**
-     * Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
-     */
-    Application?: ApplicationState;
-    /**
-     * Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)
-     */
-    CalculatedColumn?: CalculatedColumnState;
-    /**
-     * Named Charts (wrapping Chart models)
-     */
-    Charting?: ChartingState;
-    /**
-     * Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
-     */
-    CustomSort?: CustomSortState;
-    /**
-     * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section (typically above the grid) with toolbars and buttons
-     */
-    Dashboard?: DashboardState;
-    /**
-     * Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module
-     */
-    Export?: ExportState;
-    /***
-     * Objects which define which cells flash in response to data changes
-     */
-    FlashingCell?: FlashingCellState;
-    /**
-     * Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition
-     */
-    FormatColumn?: FormatColumnState;
-    /**
-     * Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource).  Useful if needing a 'Comments' column.
-     */
-    FreeTextColumn?: FreeTextColumnState;
-    /**
-     * Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
-     */
-    Layout: LayoutState;
-    /**
-     * Named Queries available for use across multiple AdapTable Modules
-     */
-    NamedQuery?: NamedQueryState;
-    /**
-     * Collection of personal Notes that are edited at Cell level
-     */
-    Note?: NoteState;
-    /**
-     * Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
-     */
-    PlusMinus?: PlusMinusState;
-    /**
-     * Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
-     */
-    QuickSearch?: QuickSearchState;
-    /**
-     * Collection of *Schedule* objects
-     */
-    Schedule?: ScheduleState;
-    /**
-     * Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues
-     */
-    Shortcut?: ShortcutState;
-    /**
-     * Configures the Adaptable Status Bar
-     */
-    StatusBar?: StatusBarState;
-    /**
-     * Collection of Special Column Styles
-     */
-    StyledColumn?: StyledColumnState;
-    /**
-     * Specifies the current Theme and lists the User and System themes available for selection.
-     */
-    Theme?: ThemeState;
-    /**
-     * Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
-     */
-    ToolPanel?: ToolPanelState;
-    /**
-     * Controls AdapTable UI including visibility of AdapTable components
-     */
-    UserInterface?: UserInterfaceState;
-}

package/src/Api/AdaptableApi.d.ts

@@ -133,7 +133,7 @@ export interface AdaptableApi {
      */
     entitlementApi: EntitlementApi;
     /**
-     * Used for listenning / subscribing to the various Events published by AdapTable
+     * Used for listening / subscribing to the Events published by AdapTable
      */
     eventApi: EventApi;
     /**

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

@@ -5,8 +5,8 @@ import { RowFormInternalApi } from '../Internal/RowFormInternalApi';
 export declare class RowFormApiImpl extends ApiBase implements RowFormApi {
     internalApi: RowFormInternalApi;
     constructor(_adaptable: IAdaptable);
-    displayEditRowForm(primaryKey: any): void;
-    displayCreateRowForm(): void;
-    displayCloneRowForm(primaryKey?: any): void;
+    displayEditRowForm(primaryKey: any): Promise<void>;
+    displayCreateRowForm(): Promise<void>;
+    displayCloneRowForm(primaryKey?: any): Promise<void>;
     displayDeleteRowForm(primaryKey?: any): void;
 }

package/src/Api/Implementation/RowFormApiImpl.js

@@ -7,12 +7,13 @@ export class RowFormApiImpl extends ApiBase {
         super(_adaptable);
         this.internalApi = new RowFormInternalApi(_adaptable);
     }
-    displayEditRowForm(primaryKey) {
+    async displayEditRowForm(primaryKey) {
         const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKey);
         if (!rowNode) {
             this.logWarn(`Cannot edit row: rowNode not found for primaryKey ${primaryKey}`);
+            return;
         }
-        const editForm = this.internalApi.buildRowEditForm(rowNode);
+        const editForm = await this.internalApi.buildRowEditForm(rowNode);
         this.dispatchAction(PopupShowForm({
             Id: 'edit_row_form',
             Form: editForm,
@@ -22,19 +23,20 @@ export class RowFormApiImpl extends ApiBase {
             },
         }));
     }
-    displayCreateRowForm() {
-        const createForm = this.internalApi.buildRowCreateForm();
+    async displayCreateRowForm() {
+        const createForm = await this.internalApi.buildRowCreateForm();
         this.dispatchAction(PopupShowForm({
             Id: 'create_row_form',
             Form: createForm,
         }));
     }
-    displayCloneRowForm(primaryKey) {
+    async displayCloneRowForm(primaryKey) {
         const rowNode = this.getGridApi().getRowNodeForPrimaryKey(primaryKey);
         if (!rowNode) {
             this.logWarn(`Can NOT clone row: rowNode not found for primaryKey ${primaryKey}`);
+            return;
         }
-        const createForm = this.internalApi.buildRowCreateForm(rowNode);
+        const createForm = await this.internalApi.buildRowCreateForm(rowNode);
         this.dispatchAction(PopupShowForm({
             Id: 'create_row_form',
             Form: createForm,

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

@@ -18,16 +18,13 @@ import { ToolPanelState } from '../../AdaptableState/ToolPanelState';
 import { StateApi } from '../StateApi';
 import { AdaptableModule, AdaptableStateKey } from '../../AdaptableState/Common/Types';
 import { AdaptableFilterState, AdaptableSortState, FlashingCellState, InitialState, NamedQueryState, ScheduleState, StatusBarState, StyledColumnState } from '../../types';
-import { PredefinedConfig } from '../../AdaptableState/InitialState';
 import { ChartingState } from '../../AdaptableState/ChartingState';
 import { NoteState } from '../../AdaptableState/NoteState';
 export declare class StateApiImpl extends ApiBase implements StateApi {
     configInit(): void;
     copyAllStateToClipboard(): void;
     copyUserStateToClipboard(): void;
-    getPredefinedConfig(): PredefinedConfig | any;
     getInitialState(): InitialState | any;
-    reloadPredefinedConfig(newPredefinedConfig?: PredefinedConfig): void;
     reloadInitialState(newInitialState?: InitialState): void;
     getAllState(): AdaptableState;
     getPersistedState(): AdaptablePersistentState;

package/src/Api/Implementation/StateApiImpl.js

@@ -40,17 +40,9 @@ export class StateApiImpl extends ApiBase {
         let stringifiedState = JSON.stringify(state);
         Helper.copyToClipboard(stringifiedState);
     }
-    getPredefinedConfig() {
-        logDeprecation(this.getAdatableLogger(), 'StateApi', 'getPredefinedConfig', 'getInitialState');
-        return this.getInitialState();
-    }
     getInitialState() {
         return this._adaptable.adaptableOptions.initialState;
     }
-    reloadPredefinedConfig(newPredefinedConfig) {
-        logDeprecation(this.getAdatableLogger(), 'StateApi', 'reloadPredefinedConfig', 'reloadInitialState');
-        this.reloadInitialState(newPredefinedConfig);
-    }
     reloadInitialState(newInitialState) {
         const adaptableOptions = this.getOptions();
         const oldState = this.getPersistentState();

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

@@ -34,7 +34,7 @@ export declare class GridInternalApi extends ApiBase {
     getDistinctValuesForColumn(columnId: string): Promise<GridCell[]> | undefined;
     getDistinctEditDisplayValuesForColumn(options: {
         columnId: string;
-        gridCell: GridCell;
+        gridCell?: GridCell;
         currentSearchValue: string;
     }): Promise<EditColumnValueInfo[]> | undefined;
     /**

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

@@ -2,8 +2,8 @@ import { IRowNode } from 'ag-grid-enterprise';
 import { ApiBase } from '../Implementation/ApiBase';
 import { AdaptableForm, EditRowFormContext, CreateRowFormContext } from '../../types';
 export declare class RowFormInternalApi extends ApiBase {
-    buildRowEditForm(rowNode: IRowNode): AdaptableForm<EditRowFormContext>;
-    buildRowCreateForm(clonedRowNode?: IRowNode): AdaptableForm<CreateRowFormContext>;
+    buildRowEditForm(rowNode: IRowNode): Promise<AdaptableForm<EditRowFormContext>>;
+    buildRowCreateForm(clonedRowNode?: IRowNode): Promise<AdaptableForm<CreateRowFormContext>>;
     private buildRowForm;
     private getFormTitle;
     private buildFormParamContext;

package/src/Api/Internal/RowFormInternalApi.js

@@ -1,14 +1,14 @@
 import { ApiBase } from '../Implementation/ApiBase';
 export class RowFormInternalApi extends ApiBase {
     // Row Form Methods
-    buildRowEditForm(rowNode) {
+    async buildRowEditForm(rowNode) {
         return this.buildRowForm('rowEdited', rowNode);
     }
-    buildRowCreateForm(clonedRowNode) {
+    async buildRowCreateForm(clonedRowNode) {
         return this.buildRowForm('rowCreated', clonedRowNode);
     }
-    buildRowForm(type, rowNode) {
-        const formFields = this.buildRowFormFields(type, rowNode);
+    async buildRowForm(type, rowNode) {
+        const formFields = await this.buildRowFormFields(type, rowNode);
         const formButtons = this.buidRowFormButtons(type, rowNode, formFields);
         const formTitle = this.getFormTitle(type, rowNode);
         const formDescription = this.getFormDescription(type, rowNode);
@@ -104,7 +104,7 @@ export class RowFormInternalApi extends ApiBase {
         dataToSave[this.getOptions().primaryKey] = pkValue;
         return dataToSave;
     }
-    buildRowFormFields(rowFormType, rowNode) {
+    async buildRowFormFields(rowFormType, rowNode) {
         const relevantColumns = this.getColumnApi()
             .getUIAvailableColumns()
             .filter((column) => {
@@ -112,7 +112,7 @@ export class RowFormInternalApi extends ApiBase {
             return !!rowNode || this.isCellEditable(column, rowNode);
         })
             .filter((column) => this.showColumnInRowForm(column, rowFormType));
-        return relevantColumns.map((column) => this.buildRowFormField(rowFormType, column, rowNode));
+        return Promise.all(relevantColumns.map((column) => this.buildRowFormField(rowFormType, column, rowNode)));
     }
     showColumnInRowForm(adaptableColumn, rowFormType) {
         if (adaptableColumn.isActionColumn) {
@@ -135,9 +135,9 @@ export class RowFormInternalApi extends ApiBase {
         const gridCell = this.getGridApi().getGridCellFromRowNode(rowNode, column.columnId);
         return this.getGridApi().isCellEditable(gridCell);
     }
-    buildRowFormField(type, column, rowNode) {
+    async buildRowFormField(type, column, rowNode) {
         const isCellEditable = this.isCellEditable(column, rowNode);
-        const fieldValueOptions = this.getFieldValueOptions(column, rowNode);
+        const fieldValueOptions = await this.getFieldValueOptions(column, rowNode);
         const fieldType = isCellEditable
             ? !!fieldValueOptions?.length
                 ? 'select'
@@ -183,21 +183,25 @@ export class RowFormInternalApi extends ApiBase {
                 return 'text';
         }
     }
-    getFieldValueOptions(column, rowNode) {
+    async 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 & adaptableFormComponent
-        // await this.getSelectCellEditorValuesForColumn(
-        //   column,
-        //   gridCell
-        // );
-        return returnValues?.map((value) => ({
-            value,
-            label: value,
+        const gridCell = rowNode
+            ? this.getGridApi().getGridCellFromRowNode(rowNode, column.columnId)
+            : undefined;
+        const valueOptions = await this.getGridApi().internalApi.getDistinctEditDisplayValuesForColumn({
+            columnId: column.columnId,
+            gridCell,
+            currentSearchValue: '',
+        });
+        if (!valueOptions?.length) {
+            return;
+        }
+        return valueOptions.map((opt) => ({
+            value: opt.value,
+            label: opt.label ?? String(opt.value),
         }));
     }
 }

package/src/Api/RowFormApi.d.ts

@@ -6,16 +6,16 @@ export interface RowFormApi {
      * Open edit dialog for row with the given primary key value
      * @param primaryKey - the primary key of the edited row
      */
-    displayEditRowForm(primaryKey: any): void;
+    displayEditRowForm(primaryKey: any): Promise<void>;
     /**
      * Open create dialog for a new row
      */
-    displayCreateRowForm(): void;
+    displayCreateRowForm(): Promise<void>;
     /**
      * Open create dialog for cloning an existing row
      * @param primaryKey - Primary Key of the duplicated row
      */
-    displayCloneRowForm(primaryKey?: any): void;
+    displayCloneRowForm(primaryKey?: any): Promise<void>;
     /**
      * Deletes row from grid (with event fired) - note: no visible Row Form is displayed
      * @param primaryKey - Primary Key of the deleted row

package/src/Api/StateApi.d.ts

@@ -15,7 +15,7 @@ import { AdaptablePersistentState, AdaptableState } from '../AdaptableState/Adap
 import { FreeTextColumnState } from '../AdaptableState/FreeTextColumnState';
 import { ToolPanelState } from '../AdaptableState/ToolPanelState';
 import { AdaptableModule, AdaptableStateKey } from '../AdaptableState/Common/Types';
-import { AdaptableFilterState, AdaptableSortState, ChartingState, FlashingCellState, InitialState, NamedQueryState, NoteState, PredefinedConfig, ScheduleState, StatusBarState, StyledColumnState } from '../types';
+import { AdaptableFilterState, AdaptableSortState, ChartingState, FlashingCellState, InitialState, NamedQueryState, NoteState, ScheduleState, StatusBarState, StyledColumnState } from '../types';
 /**
  * Range of functions to access Initial and Full Adaptable State
  */
@@ -33,18 +33,10 @@ export interface StateApi {
         flushCurrentState?: boolean;
         progressIndicatorLabel?: string;
     }): Promise<void>;
-    /**
-     * @deprecated use `getInitialState()` instead
-     */
-    getPredefinedConfig(): PredefinedConfig | any;
     /**
      * Returns the Initial Adaptable State
      */
     getInitialState(): InitialState | any;
-    /**
-     * @deprecated use `reloadInitialState()` instead
-     */
-    reloadPredefinedConfig(newPredefinedConfig?: PredefinedConfig): void;
     /**
      * Reloads existing (or supplied) Initial State; clears persistent state by calling `StateOptions.clearState`
      * @param newInitialState optional new InitialState to load

package/src/agGrid/AdaptableAgGrid.d.ts

@@ -219,6 +219,7 @@ export declare class AdaptableAgGrid implements IAdaptable {
     private getCleanValue;
     getNormalisedValueFromRawValue(rawValue: any, column: AdaptableColumn): string | number | boolean | Date | unknown;
     private __updateColumnModelAndRefreshGrid_already_called;
+    private __forceUpdateColumnModel;
     updateColumnModelAndRefreshGrid(): void;
     _updateColumnModelAndRefreshGridNow(): void;
     redrawBody(): void;

package/src/agGrid/AdaptableAgGrid.js

@@ -2229,10 +2229,12 @@ export class AdaptableAgGrid {
         return rawValue;
     }
     __updateColumnModelAndRefreshGrid_already_called = false;
+    __forceUpdateColumnModel = false;
     updateColumnModelAndRefreshGrid() {
-        if (this.__updateColumnModelAndRefreshGrid_already_called) {
+        if (this.__updateColumnModelAndRefreshGrid_already_called && !this.__forceUpdateColumnModel) {
             return;
         }
+        this.__forceUpdateColumnModel = false;
         try {
             this._updateColumnModelAndRefreshGridNow();
             this.__updateColumnModelAndRefreshGrid_already_called = true;
@@ -4281,6 +4283,10 @@ export class AdaptableAgGrid {
         // this setGridOption call will also trigger layout.onColumnDefsChanged()
         // which will in turn call updateColumnModelAndRefreshGrid
         this.agGridAdapter.setGridOption('columnDefs', columnDefs);
+        // the setGridOption call above already triggered updateColumnModelAndRefreshGrid,
+        // setting the dedup guard. We force the next call so that the column model
+        // is re-derived after the layout store has been updated.
+        this.__forceUpdateColumnModel = true;
         // this is needed here for when we call setAdaptableStateKey
         // and pass a new config
         this.updateLayoutInManagerAfterStoreHasChanged();

package/src/env.js

@@ -1,5 +1,5 @@
 export default {
     NEXT_PUBLIC_INFINITE_TABLE_LICENSE_KEY: "StartDate=2021-06-29|EndDate=2030-01-01|Owner=Adaptable|Type=distribution|TS=1624971462479|C=137829811,1004007071,2756196225,1839832928,3994409405,636616862" || '',
-    PUBLISH_TIMESTAMP: 1773422081358 || Date.now(),
-    VERSION: "22.0.3" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1773747271741 || Date.now(),
+    VERSION: "22.0.4" || '--current-version--',
 };

package/src/layout-manager/src/index.js

@@ -1279,10 +1279,22 @@ export class LayoutManager extends LMEmitter {
         this.computeColumnSorts(layout, columnState);
         this.computePinnedColumns(layout, columnState);
         this.computePivotAggregations(layout, columnState);
-        // Add pivot result columns to the state for ordering (will be applied with applyOrder: true later)
+        // Add pivot result columns to the state for ordering (will be applied with applyOrder: true later).
+        // Some pivot result columns may already be in the state (e.g. added by computeColumnSorts),
+        // so remove them first and re-add all pivot result columns in the persisted order,
+        // merging any existing state (like sort info) back in.
         if (Array.isArray(layout.PivotResultColumnsOrder)) {
+            const pivotResultColumnsOrderSet = new Set(layout.PivotResultColumnsOrder);
+            const existingPivotResultState = {};
+            columnState.state = columnState.state.filter((colState) => {
+                if (pivotResultColumnsOrderSet.has(colState.colId)) {
+                    existingPivotResultState[colState.colId] = colState;
+                    return false;
+                }
+                return true;
+            });
             layout.PivotResultColumnsOrder.forEach((colId) => {
-                columnState.state.push({ colId });
+                columnState.state.push(existingPivotResultState[colId] || { colId });
             });
         }
         return columnState;

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

@@ -4239,6 +4239,24 @@ export declare const ADAPTABLE_METAMODEL: {
             defVal: string;
         }[];
     };
+    IPushPullConfig: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+            defVal?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal: string;
+        })[];
+    };
     IPushPullDomain: {
         name: string;
         kind: string;
@@ -4259,12 +4277,21 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
             isOpt: boolean;
             defVal: string;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
+            ref: string;
             defVal?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            defVal?: undefined;
+            ref?: undefined;
         })[];
     };
     IPushPullReport: {
@@ -4904,24 +4931,6 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         desc: string;
     };
-    PredefinedConfig: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: ({
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-            ref: string;
-        } | {
-            name: string;
-            kind: string;
-            desc: string;
-            ref: string;
-            isOpt?: undefined;
-        })[];
-    };
     PredicateDefHandlerContext: {
         name: string;
         kind: string;