@adaptabletools/adaptable-cjs 22.1.1 → 23.0.0-canary.1

package/src/Api/Internal/AdaptableInternalApi.js

@@ -164,6 +164,9 @@ class AdaptableInternalApi extends ApiBase_1.ApiBase {
             return button.buttonStyle;
         }
     }
+    getIconPositionForButton(button) {
+        return button.iconPosition === 'end' ? 'end' : 'start';
+    }
     getIconForButton(button, context, defaultWidthHeight) {
         if (!button.icon) {
             return;

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

@@ -20,12 +20,12 @@ export declare class AlertInternalApi extends ApiBase {
      * Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
      * @returns alert definitions
      */
-    getNonReactiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
+    getNonReactiveAlertDefinitions(config?: LayoutExtendedConfig): import('../../AdaptableState/AlertState').RuleBasedAlertDefinition[];
     /**
      * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
      * @returns alert definitions
      */
-    getActiveNonReactiveAlertDefinitions(config?: LayoutExtendedConfig): AlertDefinition[];
+    getActiveNonReactiveAlertDefinitions(config?: LayoutExtendedConfig): import('../../AdaptableState/AlertState').RuleBasedAlertDefinition[];
     /**
      *
      * Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)
@@ -42,12 +42,12 @@ export declare class AlertInternalApi extends ApiBase {
      * Retrieves all Alert Definitions which prevent a Cell Edit
      * @returns alert definitions
      */
-    getAlertDefinitionsWithPreventEdit(config?: LayoutExtendedConfig): AlertDefinition[];
+    getAlertDefinitionsWithPreventEdit(config?: LayoutExtendedConfig): import('../../AdaptableState/AlertState').RuleBasedAlertDefinition[];
     /**
      * Retrieves all Alert Definitions which allow a Cell Edit
      *  @returns alert definitions
      */
-    getAlertDefinitionsWithAllowEdit(config?: LayoutExtendedConfig): AlertDefinition[];
+    getAlertDefinitionsWithAllowEdit(config?: LayoutExtendedConfig): import('../../AdaptableState/AlertState').RuleBasedAlertDefinition[];
     /**
      * Runs after a button in an Alert Form is clicked
      */

package/src/Api/Internal/AlertInternalApi.js

@@ -9,6 +9,7 @@ const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Exten
 const ModuleConstants_1 = require("../../Utilities/Constants/ModuleConstants");
 const IAlertService_1 = require("../../Utilities/Services/Interface/IAlertService");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
+const ScheduledAlertHelper_1 = require("../../Utilities/Helpers/ScheduledAlertHelper");
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const InternalRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/InternalRedux"));
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
@@ -41,7 +42,8 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     getNonReactiveAlertDefinitions(config) {
         return this.getAlertApi()
             .getAlertDefinitions(config)
-            .filter((alertDef) => !(0, AdaptableQuery_1.isReactiveQuery)(alertDef.Rule));
+            .filter((alertDef) => (0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDef) &&
+            !(0, AdaptableQuery_1.isReactiveQuery)(alertDef.Rule));
     }
     /**
      * Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)
@@ -58,7 +60,8 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     getReactiveAlertDefinitions(config) {
         return this.getAlertApi()
             .getAlertDefinitions(config)
-            .filter((alertDef) => (0, AdaptableQuery_1.isReactiveQuery)(alertDef.Rule));
+            .filter((alertDef) => (0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDef) &&
+            (0, AdaptableQuery_1.isReactiveQuery)(alertDef.Rule));
     }
     /**
      *
@@ -243,6 +246,9 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
                 this.logError('Error in getAlertMessageHeader', e);
             }
         }
+        if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
+            return alertDefinition.Name;
+        }
         let scopeDescription = this.getColumnScopeApi().getScopeDescription(alertDefinition.Scope);
         let ruleDescription = this.getAlertRuleDescription(alertDefinition);
         return scopeDescription + ' - ' + ruleDescription;
@@ -368,8 +374,11 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
      * @param alertDefinition Alert Definition to use
      */
     getAlertRuleDescription(alertDefinition) {
-        let ruleDescription = alertDefinition.Rule?.Predicates?.length
-            ? alertDefinition.Rule?.Predicates?.map((predicate) => this.getPredicateApi().predicateToString(predicate)).join(' AND ')
+        if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
+            return '';
+        }
+        let ruleDescription = alertDefinition.Rule.Predicates?.length
+            ? alertDefinition.Rule.Predicates.map((predicate) => this.getPredicateApi().predicateToString(predicate)).join(' AND ')
             : this.getAdaptableInternalApi().getAdaptableQueryExpressionText(alertDefinition.Rule);
         return ruleDescription;
     }
@@ -465,14 +474,14 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
     }
     getAdaptableAlertWithHighlightCell(columnId, rowNode) {
         // only alerts triggered by cell changes are relevant for HighlightCell actions
-        return this.getAdaptableCellChangedAlerts().find((alert) => alert.alertDefinition.AlertProperties?.HighlightCell &&
+        return this.getAdaptableCellChangedAlerts().find((alert) => (0, ScheduledAlertHelper_1.getRuleAlertProperties)(alert.alertDefinition)?.HighlightCell &&
             alert.cellDataChangedInfo?.column?.columnId === columnId &&
             alert.cellDataChangedInfo?.rowNode === rowNode);
     }
     getAdaptableAlertWithHighlightRow(rowNode) {
         let alertWithRowHighlight;
         alertWithRowHighlight = this.getAdaptableRowChangedAlerts().find((alert) => {
-            if (alert.alertDefinition.AlertProperties?.HighlightRow) {
+            if ((0, ScheduledAlertHelper_1.getRuleAlertProperties)(alert.alertDefinition)?.HighlightRow) {
                 if (alert.rowDataChangedInfo?.rowNodes.map((rowNode) => rowNode.id).includes(rowNode.id)) {
                     return alert;
                 }
@@ -482,7 +491,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             return alertWithRowHighlight;
         }
         alertWithRowHighlight = this.getAdaptableCellChangedAlerts().find((alert) => {
-            if (alert.alertDefinition.AlertProperties?.HighlightRow) {
+            if ((0, ScheduledAlertHelper_1.getRuleAlertProperties)(alert.alertDefinition)?.HighlightRow) {
                 if (alert.cellDataChangedInfo?.rowNode.id == rowNode.id) {
                     return alert;
                 }
@@ -491,14 +500,20 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         return alertWithRowHighlight;
     }
     isAlertDefinitionForAddedRowChangeEvent(alertDefinition) {
-        const observableExpression = alertDefinition?.Rule?.ObservableExpression;
+        if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
+            return false;
+        }
+        const observableExpression = alertDefinition.Rule.ObservableExpression;
         if (StringExtensions_1.default.IsNotNullOrEmpty(observableExpression)) {
             return observableExpression.includes(GeneralConstants_1.OBSERVABLE_EXPRESSION_ROW_ADDED);
         }
         return false;
     }
     isAlertDefinitionForRemovedRowChangeEvent(alertDefinition) {
-        const observableExpression = alertDefinition?.Rule?.ObservableExpression;
+        if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
+            return false;
+        }
+        const observableExpression = alertDefinition.Rule.ObservableExpression;
         if (StringExtensions_1.default.IsNotNullOrEmpty(observableExpression)) {
             return observableExpression.includes(GeneralConstants_1.OBSERVABLE_EXPRESSION_ROW_REMOVED);
         }
@@ -582,7 +597,7 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
             column: dataChangedEvent.column,
             ...this.getAdaptableInternalApi().buildBaseContext(),
         };
-        return this.getPredicateApi().handleColumnPredicates(alert.Rule?.Predicates, predicateDefHandlerContext, defaultNoPredicateReturn);
+        return this.getPredicateApi().handleColumnPredicates(alert.Rule.Predicates, predicateDefHandlerContext, defaultNoPredicateReturn);
     }
     isAlertDefinitionForRowChangeEvent(alertDefinition) {
         return (this.isAlertDefinitionForAddedRowChangeEvent(alertDefinition) ||
@@ -610,6 +625,9 @@ class AlertInternalApi extends ApiBase_1.ApiBase {
         });
     }
     shouldFireAlertOnClient(alertDefinition) {
+        if (!(0, ScheduledAlertHelper_1.isRuleBasedAlertDefinition)(alertDefinition)) {
+            return true;
+        }
         const rule = alertDefinition.Rule;
         if (rule) {
             if (rule.Predicates) {

package/src/Api/Internal/ChartingInternalApi.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChartingInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
+const chartingHelper_1 = require("../../Utilities/Helpers/chartingHelper");
 class ChartingInternalApi extends ApiBase_1.ApiBase {
     getContainerElement(chartContainer) {
         const element = typeof chartContainer?.element === 'string'
@@ -19,9 +20,13 @@ class ChartingInternalApi extends ApiBase_1.ApiBase {
         return this.getContainerElement(chartContainer);
     }
     getUniqueChartName() {
-        const charts = this.getChartingApi().getChartDefinitions();
-        const externalCharts = this.getChartingApi().getExternalChartDefinitions();
-        return `Chart ${charts.length + externalCharts.length + 1}`;
+        let index = 1;
+        let candidate = `Chart ${index}`;
+        while ((0, chartingHelper_1.isChartNameTaken)(this.getAdaptableApi(), candidate)) {
+            index += 1;
+            candidate = `Chart ${index}`;
+        }
+        return candidate;
     }
     // External lib charting service
     isExternalChartOpened(chartDefinition) {

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

@@ -1,6 +1,33 @@
 import { DashboardState } from '../../AdaptableState/DashboardState';
 import { ApiBase } from '../Implementation/ApiBase';
 export declare class DashboardInternalApi extends ApiBase {
+    /**
+     * Registry of reset-callbacks keyed by Custom-Toolbar name. Each
+     * `CustomToolbarCmp` registers itself on mount so the public
+     * {@link DashboardApi.resetCustomToolbarFormData} method can ask
+     * a specific instance to roll its `toolbarForm` data back to its
+     * declared `defaultValue`s without re-mounting the component.
+     */
+    private customToolbarFormResetters;
+    /**
+     * Register a reset callback for a Custom Toolbar. Idempotent: a second
+     * registration for the same name overwrites the previous entry, so a
+     * remount of the same toolbar always wins.
+     */
+    registerCustomToolbarFormResetter(toolbarName: string, resetter: () => void): void;
+    /**
+     * Tear down a previously-registered reset callback, but only if it's
+     * still the active one. Guards against a stale unmount clobbering a
+     * registration made by a fresh mount of the same toolbar.
+     */
+    unregisterCustomToolbarFormResetter(toolbarName: string, resetter: () => void): void;
+    /**
+     * Invokes the registered reset callback for the given toolbar (or all
+     * registered toolbars when `toolbarName` is omitted). Silently no-ops
+     * if no toolbar is registered under the given name - this is benign
+     * (e.g. the toolbar has not yet mounted, or it has no `toolbarForm`).
+     */
+    resetCustomToolbarFormData(toolbarName?: string): void;
     isToolbarInActiveTab(toolbarName: string, dashboardState: DashboardState): boolean;
     isToolbarCustom(toolbarName: string): boolean;
     getCustomToolbarRenderContainerId(customToolbarName: string): string;

package/src/Api/Internal/DashboardInternalApi.js

@@ -4,6 +4,47 @@ exports.DashboardInternalApi = void 0;
 const Types_1 = require("../../AdaptableState/Common/Types");
 const ApiBase_1 = require("../Implementation/ApiBase");
 class DashboardInternalApi extends ApiBase_1.ApiBase {
+    /**
+     * Registry of reset-callbacks keyed by Custom-Toolbar name. Each
+     * `CustomToolbarCmp` registers itself on mount so the public
+     * {@link DashboardApi.resetCustomToolbarFormData} method can ask
+     * a specific instance to roll its `toolbarForm` data back to its
+     * declared `defaultValue`s without re-mounting the component.
+     */
+    customToolbarFormResetters = new Map();
+    /**
+     * Register a reset callback for a Custom Toolbar. Idempotent: a second
+     * registration for the same name overwrites the previous entry, so a
+     * remount of the same toolbar always wins.
+     */
+    registerCustomToolbarFormResetter(toolbarName, resetter) {
+        this.customToolbarFormResetters.set(toolbarName, resetter);
+    }
+    /**
+     * Tear down a previously-registered reset callback, but only if it's
+     * still the active one. Guards against a stale unmount clobbering a
+     * registration made by a fresh mount of the same toolbar.
+     */
+    unregisterCustomToolbarFormResetter(toolbarName, resetter) {
+        if (this.customToolbarFormResetters.get(toolbarName) === resetter) {
+            this.customToolbarFormResetters.delete(toolbarName);
+        }
+    }
+    /**
+     * Invokes the registered reset callback for the given toolbar (or all
+     * registered toolbars when `toolbarName` is omitted). Silently no-ops
+     * if no toolbar is registered under the given name - this is benign
+     * (e.g. the toolbar has not yet mounted, or it has no `toolbarForm`).
+     */
+    resetCustomToolbarFormData(toolbarName) {
+        if (toolbarName) {
+            const fn = this.customToolbarFormResetters.get(toolbarName);
+            if (fn)
+                fn();
+            return;
+        }
+        this.customToolbarFormResetters.forEach((fn) => fn());
+    }
     isToolbarInActiveTab(toolbarName, dashboardState) {
         if (!dashboardState) {
             return false;

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

@@ -1,9 +1,8 @@
 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, CreatedRowInfo, DashboardState, DataImportedInfo, DataSet, DeletedRowInfo, EditedRowInfo, LayoutState, RowDataChangedInfo, SystemStatusMessageInfo } from '../../types';
+import { AdaptableAlert, AdaptableFlashingCell, AdaptablePersistentState, AdaptableSharedEntity, AdaptableState, AdaptableTheme, CalculatedColumn, CreatedRowInfo, DashboardState, DataImportedInfo, DataSet, DeletedRowInfo, EditedRowInfo, LayoutState, RowDataChangedInfo, ReportSchedule, SystemStatusMessageInfo } from '../../types';
 import { ApiBase } from '../Implementation/ApiBase';
-import { BaseSchedule } from '../../AdaptableState/Common/Schedule';
 import { LayoutChangedAction } from '../Events/LayoutChanged';
 export declare class EventInternalApi extends ApiBase {
     fireGridSortedEvent(): void;
@@ -13,7 +12,7 @@ export declare class EventInternalApi extends ApiBase {
     fireAlertFiredEvent(alertToFire: AdaptableAlert): void;
     fireThemeChangedEvent(theme: AdaptableTheme, trigger: 'ThemeSelected' | 'ThemeEdited'): void;
     fireLayoutChangedEvent(trigger: LayoutChangedAction, oldState: LayoutState, newState: LayoutState): void;
-    fireScheduleTriggeredEvent(schedule: BaseSchedule): void;
+    fireScheduledReportRanEvent(reportSchedule: ReportSchedule): void;
     fireDataSetSelectedEvent(dataSet: DataSet): void;
     fireSystemStatusMessageDisplayedEvent(systemStatusMessageInfo: SystemStatusMessageInfo): void;
     fireDataImportedEvent(importData: any[], addedRows: IRowNode[], updatedRows: IRowNode[]): DataImportedInfo;

package/src/Api/Internal/EventInternalApi.js

@@ -100,12 +100,12 @@ class EventInternalApi extends ApiBase_1.ApiBase {
         };
         this.getEventApi().emit('LayoutChanged', layoutChangedInfo);
     }
-    fireScheduleTriggeredEvent(schedule) {
-        const scheduleTriggeredInfo = {
+    fireScheduledReportRanEvent(reportSchedule) {
+        const reportScheduleRanInfo = {
             ...this.getAdaptableInternalApi().buildBaseContext(),
-            schedule: schedule,
+            reportSchedule: reportSchedule,
         };
-        this.getEventApi().emit('ScheduleTriggered', scheduleTriggeredInfo);
+        this.getEventApi().emit('ReportScheduleRan', reportScheduleRanInfo);
     }
     fireDataSetSelectedEvent(dataSet) {
         if (this.isAdapTableReady()) {

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

@@ -17,6 +17,12 @@ export declare class FormatColumnInternalApi extends ApiBase {
      * @param column
      * @param config
      * @returns list of FormatColumn
+     *
+     * Precedence rule: a Format Column never **wins** against an active Styled
+     * Column for any property the Styled Column claims (via its `Font` or
+     * `Cell` slot). The slice-level merging is applied downstream in
+     * `AgGridColumnAdapter.getFormatColumnAndStyledColumnCellStyle`; this API
+     * still returns every Format Column whose scope matches the column.
      */
     getFormatColumnsWithStyleForColumn(column: AdaptableColumn, config: FormatColumnConfig): FormatColumn[];
     /**

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -60,6 +60,12 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
      * @param column
      * @param config
      * @returns list of FormatColumn
+     *
+     * Precedence rule: a Format Column never **wins** against an active Styled
+     * Column for any property the Styled Column claims (via its `Font` or
+     * `Cell` slot). The slice-level merging is applied downstream in
+     * `AgGridColumnAdapter.getFormatColumnAndStyledColumnCellStyle`; this API
+     * still returns every Format Column whose scope matches the column.
      */
     getFormatColumnsWithStyleForColumn(column, config) {
         const formatColumns = this.getAllFormatColumnWithStyle()

package/src/Api/Internal/GridInternalApi.js

@@ -7,6 +7,7 @@ const InternalRedux = tslib_1.__importStar(require("../../Redux/ActionsReducers/
 const ArrayExtensions_1 = require("../../Utilities/Extensions/ArrayExtensions");
 const infinite_react_1 = require("@infinite-table/infinite-react");
 const StyleHelper_1 = require("../../Utilities/Helpers/StyleHelper");
+const ScheduledAlertHelper_1 = require("../../Utilities/Helpers/ScheduledAlertHelper");
 const UIHelper_1 = tslib_1.__importDefault(require("../../View/UIHelper"));
 const ApiBase_1 = require("../Implementation/ApiBase");
 class GridInternalApi extends ApiBase_1.ApiBase {
@@ -198,7 +199,7 @@ class GridInternalApi extends ApiBase_1.ApiBase {
     }
     getAlertRowStyle(params) {
         const alert = this.getAlertApi().internalApi.getAdaptableAlertWithHighlightRow(params.node);
-        const highlightRow = alert?.alertDefinition?.AlertProperties?.HighlightRow;
+        const highlightRow = (0, ScheduledAlertHelper_1.getRuleAlertProperties)(alert?.alertDefinition)?.HighlightRow;
         if (highlightRow) {
             return typeof highlightRow === 'object'
                 ? (0, StyleHelper_1.convertAdaptableStyleToCSS)(highlightRow)
@@ -210,7 +211,7 @@ class GridInternalApi extends ApiBase_1.ApiBase {
     }
     getAlertRowClass(params) {
         const alert = this.getAlertApi().internalApi.getAdaptableAlertWithHighlightRow(params.node);
-        const highlightRow = alert?.alertDefinition?.AlertProperties?.HighlightRow;
+        const highlightRow = (0, ScheduledAlertHelper_1.getRuleAlertProperties)(alert?.alertDefinition)?.HighlightRow;
         return typeof highlightRow === 'object' && highlightRow?.ClassName
             ? highlightRow?.ClassName
             : null;

package/src/Api/Internal/LayoutInternalApi.js

@@ -78,7 +78,10 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         }
         const layoutTagOptions = this.getLayoutOptions().layoutTagOptions;
         if (layoutTagOptions?.autoCheckTagsForLayouts == true) {
-            return ArrayExtensions_1.default.IsNullOrEmpty(object.Tags) ? true : object.Tags?.includes(layout.Name);
+            const tags = 'ReportSchedule' in object && object.ReportSchedule
+                ? object.ReportSchedule.Tags
+                : object.Tags;
+            return ArrayExtensions_1.default.IsNullOrEmpty(tags) ? true : tags?.includes(layout.Name);
         }
         const context = {
             adaptableObject: object,

package/src/Api/Internal/RowFormInternalApi.js

@@ -64,6 +64,16 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
                 variant: 'raised',
                 tone: 'success',
             },
+            // The form component enriches every button's context with
+            // `formIsValid`. When no validation is configured this is always
+            // `true`, so the existing UX is unchanged - but consumers who supply
+            // `required` / `validate` / `min` / `max` / `pattern` via
+            // `rowFormField` automatically get a Save button that disables on
+            // invalid input.
+            disabled: (_button, context) => {
+                const formIsValid = context.formIsValid;
+                return formIsValid === false;
+            },
             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
@@ -151,13 +161,25 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
                 ? this.getGridApi().getRawValueFromRowNode(rowNode, column.columnId)
                 : this.getGridApi().getDisplayValueFromRowNode(rowNode, column.columnId)
             : null;
-        return {
+        const baseField = {
             label: this.getRowFormFieldLabel(type, column, rowNode),
             name: column.columnId,
             defaultValue,
             fieldType,
             options: fieldValueOptions,
         };
+        // Allow consumers to override any subset of the auto-built field via
+        // `rowFormOptions.rowFormField`. We deliberately preserve `name` so a
+        // field always identifies itself by its column id - any attempt to
+        // rename would desync the form data from the underlying grid column.
+        const overrideFn = this.getRowFormOptions().rowFormField;
+        if (typeof overrideFn === 'function') {
+            const override = overrideFn(this.buildFormFieldLabelContext(type, column, rowNode));
+            if (override) {
+                return { ...baseField, ...override, name: baseField.name };
+            }
+        }
+        return baseField;
     }
     getRowFormFieldLabel(type, column, rowNode) {
         const customFieldLabel = typeof this.getRowFormOptions().rowFormFieldLabel === 'function'

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

@@ -0,0 +1,10 @@
+import { AdaptablePersistentState, AdaptableState } from '../../types';
+import { ApiBase } from '../Implementation/ApiBase';
+export declare class StateInternalApi extends ApiBase {
+    getAllStateForDevTools(): AdaptableState;
+    /**
+     * Replaces persisted Adaptable state with the supplied snapshot (e.g. from DevTools).
+     * Transient store sections (Internal, Popup, Comment, Plugins) are left unchanged.
+     */
+    restoreState(state: AdaptableState | AdaptablePersistentState): Promise<void>;
+}

package/src/Api/Internal/StateInternalApi.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StateInternalApi = void 0;
+const AdaptableStore_1 = require("../../Redux/Store/AdaptableStore");
+const ApiBase_1 = require("../Implementation/ApiBase");
+class StateInternalApi extends ApiBase_1.ApiBase {
+    getAllStateForDevTools() {
+        let allState = this.getAdaptableApi().stateApi.getAllState();
+        if (allState.Layout && Array.isArray(allState.Layout.Layouts)) {
+            /**
+             * For devtools, we want to be able to restore states
+             * but some layouts may not have column sizing defined for
+             * some cols, and they will default to 200px
+             *
+             * but we need to send the state with the sizes computed,
+             * because on restore, in LayoutManager, if ColumnSizing[colId]
+             * has no value, it will leave the column width in the current state
+             * which is not what we want - if in the meantime the column was resized
+             *
+             * Therefore, we need to adjust the state and make sure
+             * all columns have a width set explicitly in the layout
+             *
+             * TODO make sure also pivot layouts are handled
+             */
+            allState = { ...allState };
+            allState.Layout = { ...allState.Layout };
+            allState.Layout.Layouts = allState.Layout.Layouts.map((layout) => {
+                let ColumnSizing = layout.ColumnSizing;
+                if (Array.isArray(layout.TableColumns)) {
+                    layout.TableColumns.forEach((colId) => {
+                        if (!ColumnSizing[colId]) {
+                            ColumnSizing[colId] = {
+                                Width: this._adaptable.getDefaultColumnWidthForCol(colId),
+                            };
+                        }
+                    });
+                }
+                return {
+                    ...layout,
+                    ColumnSizing,
+                };
+            });
+        }
+        return allState;
+    }
+    /**
+     * Replaces persisted Adaptable state with the supplied snapshot (e.g. from DevTools).
+     * Transient store sections (Internal, Popup, Comment, Plugins) are left unchanged.
+     */
+    restoreState(state) {
+        return new Promise((resolve, reject) => {
+            this.getAdaptableInternalApi().executeWithProgressIndicator('Restoring state from DevTools...', () => {
+                try {
+                    const agGridOptions = {
+                        columnDefs: this._adaptable.agGridAdapter.getGridOption('columnDefs'),
+                        autoGroupColumnDef: this._adaptable.agGridAdapter.getGridOption('autoGroupColumnDef'),
+                        rowModelType: this._adaptable.agGridAdapter.getGridOption('rowModelType'),
+                        treeData: this._adaptable.agGridAdapter.getGridOption('treeData'),
+                    };
+                    const clonedState = state.Internal
+                        ? JSON.parse(JSON.stringify(state))
+                        : (0, AdaptableStore_1.getPersistableState)(JSON.parse(JSON.stringify(state)));
+                    let processedState = this._adaptable.normalizeAdaptableState(clonedState, agGridOptions);
+                    // processedState = getPersistableState(
+                    //   this.getOptions().stateOptions.applyState(
+                    //     processedState,
+                    //     buildAdaptableStateFunctionConfig(this._adaptable)
+                    //   )
+                    // );
+                    this.getAdaptableStore().TheStore.dispatch((0, AdaptableStore_1.LoadState)(processedState));
+                    this.getAdaptableStore().TheStore.dispatch((0, AdaptableStore_1.InitState)());
+                    this._adaptable.refreshLayout();
+                    void this.getAdaptableStore()
+                        .saveStateNow(this._adaptable)
+                        .then(() => resolve())
+                        .catch(reject);
+                }
+                catch (error) {
+                    reject(error);
+                }
+                finally {
+                    this.getUserInterfaceApi().hideProgressIndicator();
+                }
+            });
+        });
+    }
+}
+exports.StateInternalApi = StateInternalApi;

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

@@ -6,6 +6,8 @@ import { PredicateDefHandlerContext } from '../../types';
 export declare class StyledColumnInternalApi extends ApiBase {
     getMinValueForNumericColumn(column: AdaptableColumn): number | undefined;
     getMaxValueForNumericColumn(column: AdaptableColumn): number | undefined;
+    getAvgValueForNumericColumn(column: AdaptableColumn): number | undefined;
+    getMedianValueForNumericColumn(column: AdaptableColumn): number | undefined;
     /**
      * Gets the Minimum Value to display for a Styled Column
      * @param styledColumn Styled Column to check