@adaptabletools/adaptable 24.0.0-canary.1 → 24.0.0-canary.10

package/src/Api/Implementation/AlertApiImpl.js

@@ -4,7 +4,7 @@ import * as AlertRedux from '../../Redux/ActionsReducers/AlertRedux';
 import { ApiBase } from './ApiBase';
 import * as ModuleConstants from '../../Utilities/Constants/ModuleConstants';
 import ObjectFactory from '../../Utilities/ObjectFactory';
-import { isAdaptableCellChangedAlert, isAdaptableRowChangedAlert, } from '../../AdaptableState/Common/AdaptableAlert';
+import { getAlertCellDataChangedInfos, isAdaptableCellChangedAlert, isAdaptableRowChangedAlert, } from '../../AdaptableState/Common/AdaptableAlert';
 import StringExtensions from '../../Utilities/Extensions/StringExtensions';
 import { AlertInternalApi } from '../Internal/AlertInternalApi';
 import { resolveContainerElement } from '../../Utilities/resolveContainerElement';
@@ -100,26 +100,29 @@ export class AlertApiImpl extends ApiBase {
                 this.getGridApi().jumpToRow(firstRowNode);
             }
         }
-        if (isAdaptableCellChangedAlert(alertToShow) &&
-            alertToShow.cellDataChangedInfo &&
+        const highlightCellChanges = getAlertCellDataChangedInfos(alertToShow);
+        if (highlightCellChanges.length &&
             (alertProperties.HighlightCell || alertProperties.HighlightRow)) {
-            let alertNode = alertToShow.cellDataChangedInfo.rowNode;
-            if (!alertNode) {
-                alertNode = this.getGridApi().getRowNodeForPrimaryKey(alertToShow.cellDataChangedInfo.primaryKeyValue);
-            }
-            if (alertNode) {
-                if (alertProperties.HighlightRow) {
-                    this.getGridApi().refreshRowNodes([alertNode]);
-                    setTimeout(() => {
-                        this.dispatchAction(InternalRedux.AdaptableAlertRemoveRowHighlight(alertToShow));
-                    }, this.getAlertOptions().rowHighlightDuration);
-                }
-                if (alertProperties.HighlightCell && alertToShow.cellDataChangedInfo.column) {
-                    this.getGridApi().refreshCell(alertNode, alertToShow.cellDataChangedInfo.column.columnId);
-                    setTimeout(() => {
-                        this.dispatchAction(InternalRedux.AdaptableAlertRemoveCellHighlight(alertToShow));
-                    }, this.getAlertOptions().cellHighlightDuration);
+            const highlightNodes = [];
+            highlightCellChanges.forEach((cellChange) => {
+                const alertNode = cellChange.rowNode ?? this.getGridApi().getRowNodeForPrimaryKey(cellChange.primaryKeyValue);
+                if (alertNode) {
+                    highlightNodes.push(alertNode);
+                    if (alertProperties.HighlightCell && cellChange.column) {
+                        this.getGridApi().refreshCell(alertNode, cellChange.column.columnId);
+                    }
                 }
+            });
+            if (alertProperties.HighlightRow && highlightNodes.length) {
+                this.getGridApi().refreshRowNodes(highlightNodes);
+                setTimeout(() => {
+                    this.dispatchAction(InternalRedux.AdaptableAlertRemoveRowHighlight(alertToShow));
+                }, this.getAlertOptions().rowHighlightDuration);
+            }
+            if (alertProperties.HighlightCell) {
+                setTimeout(() => {
+                    this.dispatchAction(InternalRedux.AdaptableAlertRemoveCellHighlight(alertToShow));
+                }, this.getAlertOptions().cellHighlightDuration);
             }
         }
         else if (alertProperties.HighlightRow &&
@@ -188,10 +191,14 @@ export class AlertApiImpl extends ApiBase {
         const message = allSameMessage && StringExtensions.IsNotNullOrEmpty(representative.message)
             ? `${representative.message}\n${summaryMessage}`
             : summaryMessage;
+        const cellDataChangedInfos = group.flatMap((alert) => getAlertCellDataChangedInfos(alert));
         return {
             ...representative,
             occurrenceCount: count,
             message,
+            ...(isAdaptableCellChangedAlert(representative) && cellDataChangedInfos.length
+                ? { cellDataChangedInfos }
+                : {}),
         };
     }
     displayAdaptableAlertNotification(alert) {

package/src/Api/Implementation/ColumnScopeApiImpl.js

@@ -1,6 +1,6 @@
 import { ApiBase } from './ApiBase';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
-import { getGraySwatchColor } from '../../Utilities/Helpers/UIHelper';
+import { getDefaultRangeColor } from '../../Utilities/Helpers/UIHelper';
 export class ColumnScopeApiImpl extends ApiBase {
     isColumnInScope(column, scope) {
         if (!column) {
@@ -238,7 +238,7 @@ export class ColumnScopeApiImpl extends ApiBase {
                 {
                     Min: 0,
                     Max: 0,
-                    Color: getGraySwatchColor(),
+                    Color: getDefaultRangeColor(),
                 },
             ];
         }
@@ -246,7 +246,7 @@ export class ColumnScopeApiImpl extends ApiBase {
             {
                 Min: 'Col-Min',
                 Max: 'Col-Max',
-                Color: getGraySwatchColor(),
+                Color: getDefaultRangeColor(),
             },
         ];
     }

package/src/Api/Implementation/QuickSearchApiImpl.js

@@ -8,10 +8,10 @@ export class QuickSearchApiImpl extends ApiBase {
         return this.getAdaptableState().QuickSearch;
     }
     runQuickSearch(quickSearchText) {
-        this.dispatchAction(QuickSearchRedux.QuickSearchRun(quickSearchText));
+        this.dispatchAction(QuickSearchRedux.QuickSearchTextAction(quickSearchText));
     }
     clearQuickSearch() {
-        this.dispatchAction(QuickSearchRedux.QuickSearchRun(''));
+        this.dispatchAction(QuickSearchRedux.QuickSearchClear());
     }
     gotoNextMatch() {
         this.getAdaptableApi().agGridApi.findNext();

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

@@ -43,7 +43,7 @@ export declare class StateApiImpl extends ApiBase implements StateApi {
         flushCurrentState?: boolean;
         progressIndicatorLabel?: string;
     }): Promise<void>;
-    persistAdaptableState(): Promise<AdaptableState>;
+    persistAdaptableState(): Promise<AdaptablePersistentState>;
     getDescriptionForModule(module: AdaptableModule): string;
     getHelpPageForModule(module: AdaptableModule): string;
     getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): BaseState | string;

package/src/Api/Implementation/StateApiImpl.js

@@ -1,4 +1,6 @@
 import { InitState } from '../../Redux/Store/AdaptableStore';
+import { runAsyncStateFunction } from '../../Redux/Store/StateOptionsGuards';
+import { loadState as defaultLoadState } from '../../Redux/Store/AdaptableReduxLocalStorageEngine';
 import { ApiBase } from './ApiBase';
 import Helper from '../../Utilities/Helpers/Helper';
 import { addUuidsToInitialState } from '../../Utilities/Helpers/AdaptableHelper';
@@ -56,7 +58,7 @@ export class StateApiImpl extends ApiBase {
                 localStorage.removeItem(adaptableOptions.adaptableStateKey);
                 return Promise.resolve(true);
             });
-        const clearStatePromise = clearStateFn(this.internalApi.buildAdaptableStateFunctionConfig());
+        const clearStatePromise = runAsyncStateFunction('clearState', clearStateFn, [this.internalApi.buildAdaptableStateFunctionConfig()], this._adaptable.logger);
         return clearStatePromise.then(() => {
             this.setAdaptableStateKey(adaptableOptions.adaptableStateKey, {
                 initialState: newInitialState || adaptableOptions.initialState,
@@ -82,8 +84,7 @@ export class StateApiImpl extends ApiBase {
     }
     async remergePersistedState() {
         const config = this.internalApi.buildAdaptableStateFunctionConfig();
-        const loadState = this.getOptions().stateOptions.loadState;
-        const userState = await loadState(config);
+        const userState = await runAsyncStateFunction('loadState', this.getOptions().stateOptions.loadState || defaultLoadState, [config], this._adaptable.logger);
         return this.internalApi.applyMergedInitialAndUserState(this.getInitialState(), userState);
     }
     getAllState() {

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

@@ -11,7 +11,6 @@ export declare class UserInterfaceApiImpl extends ApiBase implements UserInterfa
     internalApi: UserInterfaceInternalApi;
     private showProgressIndicatorTimeout;
     constructor(_adaptable: IAdaptable);
-    getColorPalette(): string[];
     getCustomIcons(): CustomIcon[];
     getStyleClassNames(): string[] | undefined;
     getEditableCellStyle(): AdaptableStyle | undefined;

package/src/Api/Implementation/UserInterfaceApiImpl.js

@@ -1,8 +1,6 @@
 import * as PopupRedux from '../../Redux/ActionsReducers/PopupRedux';
 import { ArrayExtensions } from '../../Utilities/Extensions/ArrayExtensions';
 import { resolveValueOrFunction } from '../../Utilities/Helpers/ValueOrFunctionHelper';
-import { logDeprecation } from '../../Utilities/logDeprecation';
-import UIHelper from '../../Utilities/Helpers/UIHelper';
 import { CUSTOM_WINDOW_FACTORY_ID } from '../../View/Components/Popups/WindowPopups/WindowPopups';
 import { UserInterfaceInternalApi } from '../Internal/UserInterfaceInternalApi';
 import { ApiBase } from './ApiBase';
@@ -15,16 +13,6 @@ export class UserInterfaceApiImpl extends ApiBase {
         super(_adaptable);
         this.internalApi = new UserInterfaceInternalApi(_adaptable);
     }
-    getColorPalette() {
-        const colorPalette = this.getUserInterfaceOptions().colorPalette;
-        if (colorPalette != null) {
-            logDeprecation(this._adaptable.logger, 'UserInterfaceOptions', 'colorPalette', undefined, 'Override `--ab-color-swatch-*`, `--ab-color-palette-*`, and semantic `--ab-color-*` variables in your light or dark theme CSS instead. `colorPalette` will be removed in a future major release.');
-            if (typeof colorPalette === 'function' || Array.isArray(colorPalette)) {
-                return resolveValueOrFunction(colorPalette, this.getThemeApi().getCurrentTheme());
-            }
-        }
-        return UIHelper.getDefaultColorPalette();
-    }
     getCustomIcons() {
         return resolveValueOrFunction(this.getUserInterfaceOptions().customIcons) ?? [];
     }
@@ -42,9 +30,15 @@ export class UserInterfaceApiImpl extends ApiBase {
     }
     getAdaptableObjectTags() {
         const objectTags = this.getUserInterfaceOptions().objectTags;
-        const resolvedTags = resolveValueOrFunction(objectTags, this.getAdaptableInternalApi().buildBaseContext());
-        if (resolvedTags && ArrayExtensions.IsNotNullOrEmpty(resolvedTags)) {
-            return resolvedTags;
+        if (typeof objectTags === 'function') {
+            const tags = objectTags(this.getAdaptableInternalApi().buildBaseContext());
+            if (!Array.isArray(tags)) {
+                return;
+            }
+            return tags.filter((tag) => typeof tag === 'string');
+        }
+        if (objectTags && ArrayExtensions.IsNotNullOrEmpty(objectTags)) {
+            return objectTags;
         }
     }
     getAdaptableObjectsWithTag(tag, adaptableModule) {

package/src/Api/Internal/AdaptableInternalApi.js

@@ -276,9 +276,11 @@ export class AdaptableInternalApi extends ApiBase {
             return userInterfaceOptions.objectTags;
         }
         if (typeof userInterfaceOptions.objectTags === 'function') {
-            return userInterfaceOptions
-                .objectTags(this.buildBaseContext())
-                .filter((tag) => typeof tag === 'string');
+            const tags = userInterfaceOptions.objectTags(this.buildBaseContext());
+            if (!Array.isArray(tags)) {
+                return;
+            }
+            return tags.filter((tag) => typeof tag === 'string');
         }
     }
     dispatchReduxAction(action) {

package/src/Api/Internal/AlertInternalApi.js

@@ -1,6 +1,6 @@
 import { ApiBase } from '../Implementation/ApiBase';
 import { expressionKindForAlertType, isRowChangeAlertDefinition, } from '../../AdaptableState/AlertState';
-import { isAdaptableCellChangedAlert, isAdaptableRowChangedAlert, } from '../../AdaptableState/Common/AdaptableAlert';
+import { getAlertCellDataChangedInfos, isAdaptableCellChangedAlert, isAdaptableRowChangedAlert, } from '../../AdaptableState/Common/AdaptableAlert';
 import ArrayExtensions from '../../Utilities/Extensions/ArrayExtensions';
 import { AlertModuleId } from '../../Utilities/Constants/ModuleConstants';
 import ObjectFactory from '../../Utilities/ObjectFactory';
@@ -476,9 +476,16 @@ export class AlertInternalApi extends ApiBase {
         return this.getAdaptableAlerts().filter(isAdaptableRowChangedAlert);
     }
     getAdaptableAlertWithHighlightCell(columnId, rowNode) {
-        return this.getAdaptableCellChangedAlerts().find((alert) => getRuleAlertProperties(alert.alertDefinition)?.HighlightCell &&
-            alert.cellDataChangedInfo?.column?.columnId === columnId &&
-            alert.cellDataChangedInfo?.rowNode === rowNode);
+        const primaryKeyValue = this.getGridApi().getPrimaryKeyValueForRowNode(rowNode);
+        return this.getAdaptableCellChangedAlerts().find((alert) => {
+            if (!getRuleAlertProperties(alert.alertDefinition)?.HighlightCell) {
+                return false;
+            }
+            return getAlertCellDataChangedInfos(alert).some((cellChange) => cellChange.column?.columnId === columnId &&
+                (cellChange.rowNode === rowNode ||
+                    cellChange.rowNode?.id === rowNode.id ||
+                    (primaryKeyValue != null && cellChange.primaryKeyValue === primaryKeyValue)));
+        });
     }
     getAdaptableAlertWithHighlightRow(rowNode) {
         let alertWithRowHighlight;
@@ -494,9 +501,7 @@ export class AlertInternalApi extends ApiBase {
         }
         alertWithRowHighlight = this.getAdaptableCellChangedAlerts().find((alert) => {
             if (getRuleAlertProperties(alert.alertDefinition)?.HighlightRow) {
-                if (alert.cellDataChangedInfo?.rowNode.id == rowNode.id) {
-                    return alert;
-                }
+                return getAlertCellDataChangedInfos(alert).some((cellChange) => cellChange.rowNode?.id == rowNode.id);
             }
         });
         return alertWithRowHighlight;

package/src/Api/Internal/CalculatedColumnInternalApi.js

@@ -221,7 +221,7 @@ export class CalculatedColumnInternalApi extends ApiBase {
             if (calculatedColumnSettings.ShowToolTip != null &&
                 calculatedColumnSettings.ShowToolTip == true) {
                 newColDef.tooltipComponent = TwoLineTooltip;
-                newColDef.tooltipValueGetter = (params) => {
+                newColDef.tooltip = (params) => {
                     const formulaText = this.getAdaptableInternalApi().getAdaptableQueryExpressionText(calculatedColumn.Expression);
                     if (!isPerRowCalculatedColumnType(getCalculatedColumnType(calculatedColumn)) ||
                         !params?.node ||

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

@@ -1,7 +1,7 @@
 import { IRowNode } from 'ag-grid-enterprise';
 import * as Redux from 'redux';
 import { CellDataChangedInfo } from '../../AdaptableState/Common/CellDataChangedInfo';
-import { AdaptableAlert, AdaptableFlashingCell, AdaptablePersistentState, AdaptableSharedEntity, AdaptableState, AdaptableTheme, CalculatedColumn, AdaptableNote, NoteChangedAction, ColumnFilterChangedInfo, CreatedRowInfo, DashboardState, DataImportedInfo, DataSet, DeletedRowInfo, EditedRowInfo, LayoutState, RowDataChangedInfo, ReportSchedule, SystemStatusMessageInfo } from '../../types';
+import { AdaptableAlert, AdaptableFlashingCell, AdaptablePersistentState, AdaptableSharedEntity, AdaptableState, AdaptableTheme, CalculatedColumn, CommentThread, AdaptableNote, NoteChangedAction, ColumnFilterChangedInfo, CreatedRowInfo, DashboardState, DataImportedInfo, DataSet, DeletedRowInfo, EditedRowInfo, LayoutState, RowDataChangedInfo, ReportSchedule, SystemStatusMessageInfo } from '../../types';
 import { SystemThemeName } from '../../AdaptableState/ThemeState';
 import { ApiBase } from '../Implementation/ApiBase';
 import { LayoutChangedAction } from '../Events/LayoutChanged';
@@ -10,6 +10,7 @@ export declare class EventInternalApi extends ApiBase {
     fireCellChangedEvent(cellDataChangedInfo: CellDataChangedInfo): void;
     fireRowChangedEvent(rowDataChangedInfo: RowDataChangedInfo): void;
     fireDashboardChangedEvent(trigger: string, oldDashboardState: DashboardState, newDashboardState: DashboardState): void;
+    fireCommentChangedEvent(commentThreads: CommentThread[]): void;
     fireAlertFiredEvent(alertToFire: AdaptableAlert): void;
     fireThemeSelectedEvent(theme: SystemThemeName): void;
     fireThemeChangedEvent(theme: AdaptableTheme, trigger: 'ThemeSelected' | 'ThemeEdited'): void;

package/src/Api/Internal/EventInternalApi.js

@@ -68,6 +68,13 @@ export class EventInternalApi extends ApiBase {
             });
         }
     }
+    fireCommentChangedEvent(commentThreads) {
+        const commentChangedInfo = {
+            commentThreads: commentThreads ?? [],
+            ...this.getAdaptableInternalApi().buildBaseContext(),
+        };
+        this.getEventApi().emit('CommentChanged', commentChangedInfo);
+    }
     fireAlertFiredEvent(alertToFire) {
         const alertFiredInfo = {
             alert: alertToFire,

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

@@ -7,7 +7,7 @@ export declare class StateInternalApi extends ApiBase {
      * Startup-equivalent merge: Initial State + user state → store, layout/theme/cells, persist.
      * Does not clear persistence and does not call `loadState` (caller supplies user state).
      */
-    applyMergedInitialAndUserState(initialState: InitialState, userState: AdaptablePersistentState | Record<string, unknown> | null | undefined): Promise<void>;
+    applyMergedInitialAndUserState(initialState: InitialState, userState: Partial<AdaptablePersistentState> | null | void): Promise<void>;
     getAllStateForDevTools(): AdaptableState;
     /**
      * Replaces persisted Adaptable state with the supplied snapshot (e.g. from DevTools).

package/src/Api/Internal/StateInternalApi.js

@@ -1,5 +1,6 @@
 import { getPersistableState, LoadState, InitState } from '../../Redux/Store/AdaptableStore';
 import { MergeStateFunction } from '../../Redux/Store/AdaptableReduxMerger';
+import { runSyncStateFunction } from '../../Redux/Store/StateOptionsGuards';
 import { addUuidsToInitialState } from '../../Utilities/Helpers/AdaptableHelper';
 import { ApiBase } from '../Implementation/ApiBase';
 function deepClone(value) {
@@ -23,8 +24,7 @@ export class StateInternalApi extends ApiBase {
                     const initialForMerge = addUuidsToInitialState(deepClone(initialState));
                     const userForMerge = deepClone(userState ?? {});
                     let merged = MergeStateFunction(initialForMerge, userForMerge);
-                    const stateFunctionConfig = this.buildAdaptableStateFunctionConfig();
-                    merged = this.getOptions().stateOptions.applyState(merged, stateFunctionConfig);
+                    merged = runSyncStateFunction('applyState', this.getOptions().stateOptions.applyState, merged, this.buildAdaptableStateFunctionConfig(), this._adaptable.logger);
                     merged = this._adaptable.migrateLoadedAdaptableState(merged);
                     const agGridOptions = {
                         columnDefs: this._adaptable.agGridAdapter.getGridOption('columnDefs'),
@@ -92,14 +92,15 @@ export class StateInternalApi extends ApiBase {
                         rowModelType: this._adaptable.agGridAdapter.getGridOption('rowModelType'),
                         treeData: this._adaptable.agGridAdapter.getGridOption('treeData'),
                     };
-                    const clonedState = state.Internal
-                        ? JSON.parse(JSON.stringify(state))
-                        : getPersistableState(JSON.parse(JSON.stringify(state)));
+                    const clonedState = getPersistableState(JSON.parse(JSON.stringify(state)));
                     let processedState = this._adaptable.migrateLoadedAdaptableState(clonedState);
                     processedState = this._adaptable.normalizeAdaptableState(processedState, agGridOptions);
+                    const oldState = this.getAdaptableApi().stateApi.getPersistentState();
                     this.getAdaptableStore().TheStore.dispatch(LoadState(processedState));
                     this.getAdaptableStore().TheStore.dispatch(InitState());
                     this._adaptable.refreshLayout();
+                    const newState = this.getAdaptableApi().stateApi.getPersistentState();
+                    this.getEventApi().internalApi.fireAdaptableStateReloadedEvent(oldState, newState);
                     void this.getAdaptableStore()
                         .saveStateNow(this._adaptable)
                         .then(() => resolve())

package/src/Api/InteropioPluginApi.d.ts

@@ -1,10 +1,11 @@
 import { InteropioPluginOptions } from '../AdaptableOptions/InteropioPluginOptions';
 /**
- * Provides run-time access to the Interopio Plugin
+ * The interop.io plugin.
  */
 export interface InteropioPluginApi {
     /**
      * Retrieves the InteropioPlugOptions provided in interopio Plugin
+     * @returns The InteropioPlugOptions provided in interopio Plugin
      */
     getPluginOptions(): InteropioPluginOptions;
 }

package/src/Api/LayoutApi.d.ts

@@ -2,11 +2,12 @@ import { AdaptableColumn, ColumnSort, PivotLayout, TableLayout } from '../../typ
 import { ExtendedLayout, LayoutExtensionInfo, LayoutExtensionModule, LayoutExtensionObject } from '../AdaptableState/Common/ExtendedLayout';
 import { LayoutState, Layout } from '../AdaptableState/LayoutState';
 /**
- * Provides run-time access to the Layout Module and associated state
+ * Table and Pivot Layouts: the layout that is selected, its columns, sorts and row groups, and creating, cloning, editing and deleting layouts.
  */
 export interface LayoutApi {
     /**
-     * Retrieves Layout section from Adaptable State
+     * The Layout section of Adaptable State.
+     * @returns Layouts and the name of the current Layout
      */
     getLayoutState(): LayoutState;
     /**
@@ -20,34 +21,41 @@ export interface LayoutApi {
      */
     getCurrentLayout(): Layout;
     /**
-     * Returns true if current Layout is a Pivot Layout
+     * Whether the current Layout is a Pivot Layout.
+     * @returns `true` when the current Layout is a Pivot Layout
      */
     isCurrentLayoutPivot(): boolean;
     /**
-     * Retrieves the sort order of a column from the current layout
-     * @param columnId Column id
+     * The sort direction of a column in the current Layout.
+     * @param columnId Column to read
+     * @returns `'Asc'` or `'Desc'`, or `null` when the column is not sorted in this Layout
      */
     getCurrentLayoutColumnSort(columnId: string): ColumnSort['SortOrder'] | null;
     /**
-     * Retrieves map with visible columns in current Table Layout
+     * Column ids in the current Table Layout.
+     * @returns Each Table Layout column id mapped to `true`. An empty object when the current Layout is a Pivot Layout
      */
     getCurrentVisibleColumnIdsMapForTableLayout(): {
         [key: string]: boolean;
     };
     /**
-     * Retrieves array of visible ColumnIds in current Table Layout
+     * Column ids currently displayed in a Table Layout.
+     * @returns The displayed column ids. Empty when the current Layout is a Pivot Layout
      */
     getCurrentVisibleColumnIdsForTableLayout(): string[];
     /**
-     * Retrieves array of visible ColumnIds in current Pivot Layout
+     * Column ids currently displayed in a Pivot Layout.
+     * @returns The displayed column ids, including pivot result columns. Empty when the current Layout is a Table Layout
      */
     getCurrentVisibleColumnIdsForPivotLayout(): string[];
     /**
-     * Retrieves array of visible ColumnIds in current Layout
+     * Columns that group rows in the current Layout.
+     * @returns `RowGroupedColumns` for a Table Layout, or `PivotGroupedColumns` for a Pivot Layout
      */
     getCurrentRowGroupsColumnIds(): string[];
     /**
-     * Retrieves name of current Layout
+     * Name of the Layout that is selected.
+     * @returns The current Layout name
      */
     getCurrentLayoutName(): string;
     /**
@@ -65,6 +73,7 @@ export interface LayoutApi {
      * Retrieves the Layout with the given name, together with the objects extended into it
      * (global objects, which apply in every Layout, are not included)
      * @param layoutName Layout to retrieve
+     * @returns The Layout and the objects extended into it, or `undefined` when no Layout has that name. Objects that apply in every Layout are not included
      */
     getExtendedLayoutByName(layoutName: string): ExtendedLayout | undefined;
     /**
@@ -77,6 +86,7 @@ export interface LayoutApi {
      * Clones an Extended Layout - the new Layout is extended with the same objects
      * @param extendedLayoutToClone ExtendedLayout to Clone
      * @param layoutName New name for Layout being cloned
+     * @returns The cloned Extended Layout, or `false` when the source does not exist or the new name is already used
      */
     cloneExtendedLayout(extendedLayoutToClone: ExtendedLayout, layoutName: string): ExtendedLayout | false;
     /**
@@ -89,6 +99,7 @@ export interface LayoutApi {
     /**
      * Retrieves the names of the objects, per Module, extended into a Layout
      * @param layoutName Layout to check
+     * @returns Object names grouped by module. Empty when the Layout has no extensions
      */
     getLayoutExtensions(layoutName: string): LayoutExtensionInfo;
     /**
@@ -116,6 +127,7 @@ export interface LayoutApi {
      * Retrieves the names of the Layouts an object is extended into (empty when the object is global)
      * @param object Object to check
      * @param module Module the object belongs to
+     * @returns Layout names the object is extended into. Empty when the object applies in every Layout
      */
     getLayoutsForObject(object: LayoutExtensionObject, module: LayoutExtensionModule): string[];
     /**
@@ -177,8 +189,9 @@ export interface LayoutApi {
      */
     cloneAndSetLayout(layoutToClone: Layout, layoutName: string): Layout | false;
     /**
-     * Checks whether this Layout exists in the Adaptable State (by comparing Uuid property)
+     * Whether this Layout is already in Layout State. Compared by `Uuid`.
      * @param layout Layout to check
+     * @returns `true` when a Layout with the same `Uuid` is in state
      */
     doesLayoutExist(layout: Layout): boolean;
     /**
@@ -187,8 +200,9 @@ export interface LayoutApi {
     openLayoutSettingsPanel(): void;
     /**
      * Opens Layout Editor - for Current or a named Layout
-     * @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
+     * @param layoutName Name of the Layout to edit or clone. Omit it to use the current Layout
+     * @param layoutType `'table'` or `'pivot'`. Used when `action` is `'New'`
+     * @param action `'Edit'`, `'Clone'` or `'New'`. Defaults to `'Edit'`
      */
     showLayoutEditor(layoutName?: string, layoutType?: 'table' | 'pivot', 
     /**
@@ -207,8 +221,8 @@ export interface LayoutApi {
      */
     deleteLayout(layout: Layout): void;
     /**
-     * Deletes an existing Layout provided by Name (if not Default or only existing Layout)
-     * @param layout Name of the Layout to delete
+     * Deletes a Layout by name. Does nothing when it is the only Layout.
+     * @param layoutName Name of the Layout to delete
      */
     deleteLayoutByName(layoutName: string): void;
     /**

package/src/Api/NamedQueryApi.d.ts

@@ -1,35 +1,39 @@
 import { NamedQuery, NamedQueryState } from '../types';
 /**
- * Provides run-time access to Named Queries
+ * Named Queries saved in AdapTable State, and running a query by object or by name.
  */
 export interface NamedQueryApi {
     /**
      * Adds a new Named Query to Adaptable State
-     * @param namedQueries
+     * @param namedQueries Named Query to add
      */
     addNamedQuery(namedQueries: NamedQuery): void;
     /**
-     * Adds multiple new Named Query to Adaptable State
-     * @param namedQueries
+     * Adds several Named Queries to Adaptable State.
+     * @param namedQueries Named Queries to add
      */
     addNamedQueries(namedQueries: NamedQuery[]): void;
     /**
      * Retrieves Query section from Adaptable State
      *
+     * @returns Query section from Adaptable State
      */
     getNamedQueryState(): NamedQueryState;
     /**
      * Gets all Named Queries in Adaptable State
+     * @returns All Named Queries in Adaptable State
      */
     getNamedQueries(): NamedQuery[];
     /**
      * Retrieves Named Query with given name from State
      * @param namedQueryName Name of Named Query
+     * @returns Named Query with given name from State
      */
     getNamedQueryByName(namedQueryName: string): NamedQuery | undefined;
     /**
-     * Checks if the given Named Query has a valid name
-     * @param namedQueryName Named Query
+     * Whether this Named Query can be saved. The name is required and must not already be used.
+     * @param namedQuery Named Query to check
+     * @returns `true` when this Named Query can be saved. The name is required and must not already be used
      */
     isValidNamedQuery(namedQuery: NamedQuery): NamedQueryValidationResult;
     /**

package/src/Api/NoteApi.d.ts

@@ -1,27 +1,27 @@
 import { AdaptableNote, AdaptableNotes, NoteState } from '../AdaptableState/NoteState';
 import { AdaptableMessageType, CellAddress } from '../../types';
 /**
- * Provides run-time access to Notes Module and related State
+ * Notes attached to cells. Each note has text, a type, and the cell it belongs to.
  */
 export interface NoteApi {
     /**
      * Adds a new Note
-     * @param text
-     * @param primaryKeyValue
-     * @param columnId
+     * @param text Note text
+     * @param primaryKeyValue Primary key of the row
+     * @param columnId Column the note belongs to
      * @param extra optional additional Note properties (e.g. `Author`, `Metadata`, `IsReadOnly`);
      *  `Author` and `CreatedAt` are stamped automatically when not supplied
      */
     addNote(text: string, primaryKeyValue: any, columnId: string, extra?: Partial<AdaptableNote>): void;
     /**
-     * Edits a Note
-     * @param note
+     * Replaces a note already in state.
+     * @param note Note to save
      */
     editNote(note: AdaptableNote): void;
     /**
-     * Edits text of a Note
-     * @param text
-     * @param note
+     * Replaces the text of a note.
+     * @param text New note text
+     * @param note Note to update
      */
     updateNoteText(text: string, note: AdaptableNote): void;
     /**
@@ -31,26 +31,30 @@ export interface NoteApi {
      */
     setNoteType(note: AdaptableNote, noteType: AdaptableMessageType): void;
     /**
-     * Deletes a Note
-     * @param note
+     * Removes a note from state.
+     * @param note Note to delete
      */
     deleteNote(note: AdaptableNote): void;
     /**
      * Gets the Note State
+     * @returns The Note State
      */
     getNoteState(): NoteState;
     /**
      * Gets all Notes
+     * @returns All Notes
      */
     getAllNotes(): AdaptableNotes;
     /**
      * Gets all Notes for a cell
      * @param cellAddress note position
+     * @returns All Notes for a cell
      */
     getNoteForCell(cellAddress: CellAddress): AdaptableNote;
     /**
      * Returns a Note by uuid
      * @param uuid note uuid
+     * @returns A Note by uuid
      */
     getNoteByUuid(uuid: string): AdaptableNote | undefined;
 }