@adaptabletools/adaptable 23.0.4-canary.0 → 23.0.5-canary.0

package/agGrid.js

@@ -1,4 +1,3 @@
-// TODO: remove this file in v23
 import Adaptable, { AdaptableNoCodeWizard as ABWizard, AdaptableWizardView, AdaptableLogger as ABLogger, } from './src/agGrid';
 import { AdaptableAgGrid } from './src/agGrid/AdaptableAgGrid';
 import { booleanExpressionFunctionsNames } from './src/Utilities/ExpressionFunctions/booleanExpressionFunctions';
@@ -27,45 +26,15 @@ export const AdaptableQL = {
     getAbstractSyntaxTree: getAbstractSyntaxTree,
     getTokens: getTokens,
 };
-/**
- * AdapTable Column Types
- */
 export const AdaptableColumnType = {
-    /**
-     * A column that is never displayed in the UI, but it's still available programmatically.
-     */
     HiddenColumn: HIDDEN_COLUMN_TYPE,
-    /**
-     * A column that is calculated based on other columns in the table.
-     */
     CalculatedColumn: CALCULATED_COLUMN_TYPE,
-    /**
-     * A column that is NOT stored in the grid but in the state, allowing run-time users to "attach" custom data
-     */
     FreeTextColumn: FREE_TEXT_COLUMN_TYPE,
-    /**
-     * A column that is used to display an action button or link.
-     */
     ActionColumn: ACTION_COLUMN_TYPE,
-    /**
-     * A column that is used to display FDC3 data/actions.
-     */
     Fdc3Column: FDC3_COLUMN_TYPE,
-    /**
-     * Any column that is used to display Pivot Totals: PivotGrandTotal, PivotGroupTotal or PivotAggregationTotal
-     */
     PivotAnyTotal: PIVOT_ANY_TOTAL_COLUMN_TYPE,
-    /**
-     * A column that is used to display the Grand Total of ALL Pivot Columns.
-     */
     PivotGrandTotal: PIVOT_GRAND_TOTAL_COLUMN_TYPE,
-    /**
-     * A column that is used to display a single Total for EACH Pivot Column Group.
-     */
     PivotColumnTotal: PIVOT_COLUMN_TOTAL_COLUMN_TYPE,
-    /**
-     * A column that is used to display the Totals of Pivot Aggregation Columns.
-     */
     PivotAggregationTotal: PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE,
 };
 export { iconToString as getIconSVG, AdaptableReactPercentageEditor, AdaptableReactNumberEditor, AdaptableReactDateEditor, AdaptablePercentageEditor, AdaptableNumberEditor, AdaptableDateEditor, AdaptableWizardView, AdaptableUpgradeHelper, };

package/index.js

@@ -14,7 +14,6 @@ import { AdaptableUpgradeHelper } from './src/migration/AdaptableUpgradeHelper';
 import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE, PIVOT_GRAND_TOTAL_COLUMN_TYPE, PIVOT_COLUMN_TOTAL_COLUMN_TYPE, PIVOT_ANY_TOTAL_COLUMN_TYPE, HIDDEN_COLUMN_TYPE, } from './src/AdaptableState/Common/AdaptableColumn';
 import { iconToString } from './src/components/icons';
 export * from './src/types';
-// TODO remove default export in v23
 export default Adaptable;
 export { Adaptable };
 export const _AdaptableAgGrid = AdaptableAgGrid;
@@ -29,45 +28,15 @@ export const AdaptableQL = {
     getAbstractSyntaxTree: getAbstractSyntaxTree,
     getTokens: getTokens,
 };
-/**
- * AdapTable Column Types
- */
 export const AdaptableColumnType = {
-    /**
-     * A column that is used to display an action button or link.
-     */
     ActionColumn: ACTION_COLUMN_TYPE,
-    /**
-     * A column that is calculated based on other columns in the table.
-     */
     CalculatedColumn: CALCULATED_COLUMN_TYPE,
-    /**
-     * A column that is used to display FDC3 data/actions.
-     */
     Fdc3Column: FDC3_COLUMN_TYPE,
-    /**
-     * A column that is NOT stored in the grid but in the state, allowing run-time users to "attach" custom data
-     */
     FreeTextColumn: FREE_TEXT_COLUMN_TYPE,
-    /**
-     * A column that is never displayed in the UI, but it's still available programmatically.
-     */
     HiddenColumn: HIDDEN_COLUMN_TYPE,
-    /**
-     * Any column that is used to display Pivot Totals: PivotGrandTotal, PivotGroupTotal or PivotAggregationTotal
-     */
     PivotAnyTotal: PIVOT_ANY_TOTAL_COLUMN_TYPE,
-    /**
-     * A column that is used to display the Grand Total of ALL Pivot Columns.
-     */
     PivotGrandTotal: PIVOT_GRAND_TOTAL_COLUMN_TYPE,
-    /**
-     * A column that is used to display a single Total for EACH Pivot Column Group.
-     */
     PivotColumnTotal: PIVOT_COLUMN_TOTAL_COLUMN_TYPE,
-    /**
-     * A column that is used to display the Totals of Pivot Aggregation Columns.
-     */
     PivotAggregationTotal: PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE,
 };
 export { iconToString as getIconSVG, AdaptableReactPercentageEditor, AdaptableReactNumberEditor, AdaptableReactDateEditor, AdaptablePercentageEditor, AdaptableNumberEditor, AdaptableDateEditor, AdaptableWizardView, AdaptableUpgradeHelper, };

package/package.json

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

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -20,7 +20,6 @@ import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLan
 import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
 import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';
 import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
-import { IMetamodelService } from '../Utilities/Services/Interface/IMetamodelService';
 import { RenderReactRootFn } from '../renderReactRoot';
 import { AdaptableLogger } from '../agGrid/AdaptableLogger';
 import { Fdc3Service } from '../Utilities/Services/Fdc3Service';
@@ -86,7 +85,6 @@ export interface IAdaptable {
     QueryLanguageService: IQueryLanguageService;
     AlertService: IAlertService;
     TeamSharingService: ITeamSharingService;
-    MetamodelService: IMetamodelService;
     RowFormService: RowFormService;
     Fdc3Service: Fdc3Service;
     AnnotationsService: AnnotationsService;

package/src/AdaptableOptions/AdaptablePlugin.js

@@ -1,6 +1,3 @@
-/**
- * Base class for all AdapTable Plugins
- */
 export class AdaptablePlugin {
     options;
     values;
@@ -25,11 +22,7 @@ export class AdaptablePlugin {
     hasProperty(name) {
         return !!this.values[name];
     }
-    // plugin lifecycle methods, executed in this exact order
-    // wondering if this is better?
-    beforeInit(adaptableOptions, 
-    // adding a nested object allows plugins to modify gridOptions
-    agGridOptions) { }
+    beforeInit(adaptableOptions, agGridOptions) { }
     afterInitOptions(adaptable, adaptableOptions) { }
     afterInitApi(adaptable, api) { }
     afterInitServices(adaptable) { }
@@ -37,7 +30,6 @@ export class AdaptablePlugin {
     afterInitModules(adaptable, strategies) { }
     afterInitStore(adaptable) { }
     afterInit(ab) { }
-    // hook executed after each layout update (Adaptable.setLayout())
     afterSetLayout(adaptable, layout) { }
     onBeforeStoreEvent(eventName, data, adaptableStore) { }
     onStoreEvent(eventName, data, adaptableStore) { }

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -134,7 +134,7 @@ const DefaultAdaptableOptions = {
         systemAggregatedScalarFunctions: undefined,
         moduleExpressionFunctions: undefined,
         performExpressionValidation: true,
-        maxTimeframeSize: 28800000, // 8 hours
+        maxTimeframeSize: 28800000,
         caseSensitiveExpressions: false,
         customAggregatedFunctions: undefined,
         customBooleanFunctions: undefined,
@@ -159,7 +159,6 @@ const DefaultAdaptableOptions = {
             },
         },
         uiControlsDefaultConfiguration: {
-            // default config is set in FDC3 Service, to make it easier to overview
             contexts: {},
             intents: {},
         },
@@ -192,10 +191,10 @@ const DefaultAdaptableOptions = {
         defaultFlashDuration: 500,
         defaultFlashTarget: 'cell',
         defaultDownChangeStyle: {
-            BackColor: getSwatchColorVar(18), // red by default (for flashing down changes)
+            BackColor: getSwatchColorVar(18),
         },
         defaultUpChangeStyle: {
-            BackColor: getSwatchColorVar(7), // green by default (for flashing up changes)    
+            BackColor: getSwatchColorVar(7),
         },
         defaultNeutralChangeStyle: {
             BackColor: getGraySwatchColor(),
@@ -318,7 +317,6 @@ const DefaultAdaptableOptions = {
         dateInputOptions: {
             useNativeInput: false,
             dateFormat: 'yyyy-MM-dd',
-            // locale is not explicitly defaulted to 'en-US' as this is already done by the react-day-picker
             showWeekNumber: false,
             showOutsideDays: true,
             datepickerButtons: ['close', 'today'],
@@ -336,82 +334,48 @@ export function applyDefaultAdaptableOptions(adaptableOptions) {
     const adaptableOptsWithDefaults = Object.assign({}, DefaultAdaptableOptions, adaptableOptions);
     adaptableOptsWithDefaults.adaptableStateKey =
         adaptableOptsWithDefaults.adaptableStateKey ?? adaptableOptsWithDefaults.adaptableId;
-    // action column options
     adaptableOptsWithDefaults.actionColumnOptions = Object.assign({}, DefaultAdaptableOptions.actionColumnOptions, adaptableOptions.actionColumnOptions);
-    // action column options
     adaptableOptsWithDefaults.rowFormOptions = Object.assign({}, DefaultAdaptableOptions.rowFormOptions, adaptableOptions.rowFormOptions);
-    // alert options
     adaptableOptsWithDefaults.alertOptions = Object.assign({}, DefaultAdaptableOptions.alertOptions, adaptableOptions.alertOptions);
-    // calendar options
     adaptableOptsWithDefaults.calendarOptions = Object.assign({}, DefaultAdaptableOptions.calendarOptions, adaptableOptions.calendarOptions);
-    // cell summary options
     adaptableOptsWithDefaults.cellSummaryOptions = Object.assign({}, DefaultAdaptableOptions.cellSummaryOptions, adaptableOptions.cellSummaryOptions);
-    // charting options
     adaptableOptsWithDefaults.chartingOptions = Object.assign({}, DefaultAdaptableOptions.chartingOptions, adaptableOptions.chartingOptions);
     adaptableOptsWithDefaults.chartingOptions.externalChartingOptions = Object.assign({}, DefaultAdaptableOptions.chartingOptions.externalChartingOptions, adaptableOptsWithDefaults.chartingOptions.externalChartingOptions);
-    // column options
     adaptableOptsWithDefaults.columnOptions = Object.assign({}, DefaultAdaptableOptions.columnOptions, adaptableOptions.columnOptions);
-    // TEMP filter options
     adaptableOptsWithDefaults.filterOptions = Object.assign({}, DefaultAdaptableOptions.filterOptions, adaptableOptions.filterOptions);
     adaptableOptsWithDefaults.filterOptions.columnFilterOptions = Object.assign({}, DefaultAdaptableOptions.filterOptions.columnFilterOptions, adaptableOptsWithDefaults.filterOptions.columnFilterOptions);
     adaptableOptsWithDefaults.filterOptions.gridFilterOptions = Object.assign({}, DefaultAdaptableOptions.filterOptions.gridFilterOptions, adaptableOptsWithDefaults.filterOptions.gridFilterOptions);
-    // column menu options
     adaptableOptsWithDefaults.columnMenuOptions = Object.assign({}, DefaultAdaptableOptions.columnMenuOptions, adaptableOptions.columnMenuOptions);
-    // comment options
     adaptableOptsWithDefaults.commentOptions = Object.assign({}, DefaultAdaptableOptions.commentOptions, adaptableOptions.commentOptions);
-    // container options
     adaptableOptsWithDefaults.containerOptions = Object.assign({}, DefaultAdaptableOptions.containerOptions, adaptableOptions.containerOptions);
-    // context menu options
     adaptableOptsWithDefaults.contextMenuOptions = Object.assign({}, DefaultAdaptableOptions.contextMenuOptions, adaptableOptions.contextMenuOptions);
-    // custom sort options
     adaptableOptsWithDefaults.customSortOptions = Object.assign({}, DefaultAdaptableOptions.customSortOptions, adaptableOptions.customSortOptions);
-    // dashboard options
     adaptableOptsWithDefaults.dashboardOptions = Object.assign({}, DefaultAdaptableOptions.dashboardOptions, adaptableOptions.dashboardOptions);
-    // data import options
     adaptableOptsWithDefaults.dataImportOptions = Object.assign({}, DefaultAdaptableOptions.dataImportOptions, adaptableOptions.dataImportOptions);
-    // data change history options
     adaptableOptsWithDefaults.dataChangeHistoryOptions = Object.assign({}, DefaultAdaptableOptions.dataChangeHistoryOptions, adaptableOptions.dataChangeHistoryOptions);
-    // data set options
     adaptableOptsWithDefaults.dataSetOptions = Object.assign({}, DefaultAdaptableOptions.dataSetOptions, adaptableOptions.dataSetOptions);
-    // edit options
     adaptableOptsWithDefaults.editOptions = Object.assign({}, DefaultAdaptableOptions.editOptions, adaptableOptions.editOptions);
     adaptableOptsWithDefaults.editOptions.plusMinusOptions = Object.assign({}, DefaultAdaptableOptions.editOptions.plusMinusOptions, adaptableOptsWithDefaults.editOptions.plusMinusOptions);
     adaptableOptsWithDefaults.editOptions.smartEditOptions = Object.assign({}, DefaultAdaptableOptions.editOptions.smartEditOptions, adaptableOptsWithDefaults.editOptions.smartEditOptions);
-    // entitlement options
     adaptableOptsWithDefaults.entitlementOptions = Object.assign({}, DefaultAdaptableOptions.entitlementOptions, adaptableOptions.entitlementOptions);
-    // export options
     adaptableOptsWithDefaults.exportOptions = Object.assign({}, DefaultAdaptableOptions.exportOptions, adaptableOptions.exportOptions);
-    // expression options
     adaptableOptsWithDefaults.expressionOptions = Object.assign({}, DefaultAdaptableOptions.expressionOptions, adaptableOptions.expressionOptions);
-    // fdc3 options
     adaptableOptsWithDefaults.fdc3Options = Object.assign({}, DefaultAdaptableOptions.fdc3Options, adaptableOptions.fdc3Options);
     adaptableOptsWithDefaults.fdc3Options.actionColumnDefaultConfiguration = Object.assign({}, DefaultAdaptableOptions.fdc3Options.actionColumnDefaultConfiguration, adaptableOptsWithDefaults.fdc3Options.actionColumnDefaultConfiguration);
     adaptableOptsWithDefaults.fdc3Options.uiControlsDefaultConfiguration = Object.assign({}, DefaultAdaptableOptions.fdc3Options.uiControlsDefaultConfiguration, adaptableOptsWithDefaults.fdc3Options.uiControlsDefaultConfiguration);
-    // flashing cell options
     adaptableOptsWithDefaults.flashingCellOptions = Object.assign({}, DefaultAdaptableOptions.flashingCellOptions, adaptableOptions.flashingCellOptions);
-    // format column options
     adaptableOptsWithDefaults.formatColumnOptions = Object.assign({}, DefaultAdaptableOptions.formatColumnOptions, adaptableOptions.formatColumnOptions);
-    // layout options
     adaptableOptsWithDefaults.layoutOptions = Object.assign({}, DefaultAdaptableOptions.layoutOptions, adaptableOptions.layoutOptions);
     adaptableOptsWithDefaults.layoutOptions.layoutTagOptions = Object.assign({}, DefaultAdaptableOptions.layoutOptions.layoutTagOptions, adaptableOptsWithDefaults.layoutOptions.layoutTagOptions);
     adaptableOptsWithDefaults.layoutOptions.layoutViewOptions = Object.assign({}, DefaultAdaptableOptions.layoutOptions.layoutViewOptions, adaptableOptsWithDefaults.layoutOptions.layoutViewOptions);
-    // note options
     adaptableOptsWithDefaults.noteOptions = Object.assign({}, DefaultAdaptableOptions.noteOptions, adaptableOptions.noteOptions);
-    // notification options
     adaptableOptsWithDefaults.notificationsOptions = Object.assign({}, DefaultAdaptableOptions.notificationsOptions, adaptableOptions.notificationsOptions);
-    // predicate options
     adaptableOptsWithDefaults.predicateOptions = Object.assign({}, DefaultAdaptableOptions.predicateOptions, adaptableOptsWithDefaults.predicateOptions);
-    // quick search options
     adaptableOptsWithDefaults.quickSearchOptions = Object.assign({}, DefaultAdaptableOptions.quickSearchOptions, adaptableOptions.quickSearchOptions);
-    // settings panel options
     adaptableOptsWithDefaults.settingsPanelOptions = Object.assign({}, DefaultAdaptableOptions.settingsPanelOptions, adaptableOptions.settingsPanelOptions);
-    // state optoins
     adaptableOptsWithDefaults.stateOptions = Object.assign({}, DefaultAdaptableOptions.stateOptions, adaptableOptions.stateOptions);
-    // team sharing options
     adaptableOptsWithDefaults.teamSharingOptions = Object.assign({}, DefaultAdaptableOptions.teamSharingOptions, adaptableOptions.teamSharingOptions);
-    // tool panel
     adaptableOptsWithDefaults.toolPanelOptions = Object.assign({}, DefaultAdaptableOptions.toolPanelOptions, adaptableOptions.toolPanelOptions);
-    // user interface options
     adaptableOptsWithDefaults.userInterfaceOptions = Object.assign({}, DefaultAdaptableOptions.userInterfaceOptions, adaptableOptions.userInterfaceOptions);
     adaptableOptsWithDefaults.userInterfaceOptions.loadingScreenOptions = Object.assign({}, DefaultAdaptableOptions.userInterfaceOptions.loadingScreenOptions, adaptableOptsWithDefaults.userInterfaceOptions.loadingScreenOptions);
     adaptableOptsWithDefaults.userInterfaceOptions.dateInputOptions = Object.assign({}, DefaultAdaptableOptions.userInterfaceOptions.dateInputOptions, adaptableOptsWithDefaults.userInterfaceOptions.dateInputOptions);

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -35,33 +35,22 @@ export interface SettingsPanelOptions {
      */
     alwaysShowInToolPanel?: boolean;
     /**
-     * Configure grouped navigation for the Settings Panel.
+     * Configure grouped navigation for the Settings Panel; use SettingsPanelNavigationConfigurer but backwards compatibility via the deprecated LegacyFlatSettingsPanelNavigation is supported
      *
-     * Receives the default grouped navigation and AdapTable context; return an amended copy.
-     * Groups with no visible modules (e.g. due to entitlements) are omitted automatically.
-     * Group headings are omitted when every module in the group is hidden.
-     *
-     * @defaultValue all available AdapTable modules in the default grouped order
-     */
-    navigation?: SettingsPanelNavigationConfigurer;
+     * @defaultValue all available AdapTable modules in the default grouped order   */
+    navigation?: SettingsPanelNavigationConfigurer | LegacyFlatSettingsPanelNavigation;
     /**
      * Initial position of Settings Panel — pixel offset of top-left corner from top-left of viewport (requires `popupType` to be `'window'`)
      *
      * @defaultValue Middle of Screen
      */
-    position?: {
-        x: number;
-        y: number;
-    };
+    position?: SettingsPanelPosition;
     /**
      * Initial size (in pixels) of Settings Panel (requires `popupType` to be `'window'`)
      *
      * @defaultValue Computed based on size of screen
      */
-    size?: {
-        width: number;
-        height: number;
-    };
+    size?: SettingsPanelSize;
     /**
      * How the Settings Panel is rendered: `'modal'` (centred and unmovable and resizable) or `'window'` (supports size, position, drag and resize)
      *
@@ -79,6 +68,32 @@ export interface SettingsPanelOptions {
      */
     gridInfoTabs?: GridInfoTabs;
 }
+/**
+ * Pixel offset of Settings Panel's top-left corner from top-left of the viewport
+ */
+export interface SettingsPanelPosition {
+    /**
+     * Distance from the left edge of the viewport, in pixels.
+     */
+    x: number;
+    /**
+     * Distance from the top edge of the viewport, in pixels.
+     */
+    y: number;
+}
+/**
+ * Initial dimensions (in pixels) of the Settings Panel
+ */
+export interface SettingsPanelSize {
+    /**
+     * Width of the Settings Panel, in pixels.
+     */
+    width: number;
+    /**
+     * Height of the Settings Panel, in pixels.
+     */
+    height: number;
+}
 /**
  * A labelled group of Settings Panel navigation entries.
  */
@@ -107,6 +122,19 @@ export interface SettingsPanelNavigationContext extends BaseContext {
  * Function used to customise Settings Panel navigation.
  */
 export type SettingsPanelNavigationConfigurer = (context: SettingsPanelNavigationContext, defaultNavigation: SettingsPanelNavigation) => SettingsPanelNavigation;
+/**
+ * Legacy (v22) flat Settings Panel navigation shape.
+ *
+ * Items are listed in a single ordered array, with the literal string `'-'` acting as a
+ * group separator. Internally converted to the grouped {@link SettingsPanelNavigation}
+ * shape — each chunk between separators becomes a group with no heading.
+ *
+ * @deprecated Provide a {@link SettingsPanelNavigationConfigurer} function instead. Will be
+ * removed in the next major release.
+ */
+export interface LegacyFlatSettingsPanelNavigation {
+    items?: (AdaptableSettingsPanel | string | '-')[];
+}
 /**
  * Definition of a Custom Panel to add to the Adaptable Settings Panel
  */

package/src/AdaptableState/Aggregations/only.js

@@ -8,16 +8,6 @@ function createOnlyResult(distinctValues) {
         },
     };
 }
-/**
- * AG Grid aggFunc that returns the column value only when all rows in the group
- * share the same value. Returns null when values differ (or when there are no values).
- *
- * params.values already respects suppressAggFilteredOnly, containing either:
- * - Raw cell values (string | number) for leaf children
- * - OnlyAggResult objects for sub-group children (with pre-computed distinct values)
- *
- * Bails out early as soon as two distinct values are found.
- */
 export const only = (params) => {
     const { values } = params;
     const distinctValues = new Set();
@@ -27,7 +17,6 @@ export const only = (params) => {
             distinctValues.add(value);
         }
         else if (value != null && typeof value === 'object' && 'distinctValues' in value) {
-            // sub-group: merge pre-computed distinct values (set has at most 2 elements)
             for (const v of value.distinctValues) {
                 distinctValues.add(v);
             }

package/src/AdaptableState/Aggregations/weightedAverage.js

@@ -6,40 +6,22 @@ export const getNumericValue = (input) => {
     const numericValue = toNumber(input);
     return isNaN(numericValue) ? null : numericValue;
 };
-/**
- * Computes a weighted average aggregation: Σ(value × weight) / Σ(weight)
- *
- * AG Grid calls agg functions bottom-up through the group hierarchy. For each group:
- * - Leaf children contribute their raw value × weight
- * - Sub-group children already have partial sums from a previous pass,
- *   so we combine those directly instead of re-traversing to leaves
- *
- * The returned object stores partial sums ([columnId] and [weightColumnId])
- * so parent groups can combine sub-group results correctly.
- */
 export const weightedAverage = (params, columnId, weightColumnId) => {
     const { api: gridApi, rowNode: groupRowNode, values } = params;
-    // numerator: Σ(value × weight)
     let weightedValueSum = 0;
-    // denominator: Σ(weight)
     let totalWeight = 0;
-    // params.values already respects suppressAggFilteredOnly.
-    // We need the matching child nodes only for leaf rows (to look up weight column values).
     const childNodes = getMatchingChildNodes(groupRowNode, values.length);
     for (let i = 0; i < values.length; i++) {
         const value = values[i];
         if (value != null && typeof value === 'object') {
-            // sub-group: partial sums already computed by a previous aggregation pass
             weightedValueSum += value[columnId] ?? 0;
             totalWeight += value[weightColumnId] ?? 0;
         }
         else {
-            // leaf row: compute value × weight from cell data
             const childNode = childNodes[i];
             if (!childNode) {
                 continue;
             }
-            // values might be strings during editing
             const columnValue = getNumericValue(value);
             const weightValue = getNumericValue(gridApi.getCellValue({ colKey: weightColumnId, rowNode: childNode }));
             if (weightValue !== null) {
@@ -52,20 +34,12 @@ export const weightedAverage = (params, columnId, weightColumnId) => {
     }
     const result = totalWeight !== 0 ? weightedValueSum / totalWeight : 0;
     return {
-        // toString/toNumber let AG Grid's default cell renderer display and sort the value
         toString: () => String(result),
         toNumber: () => result,
-        // partial sums stored so parent groups can combine sub-group results
         [columnId]: weightedValueSum,
         [weightColumnId]: totalWeight,
     };
 };
-/**
- * Returns the child node list that corresponds to params.values.
- * When suppressAggFilteredOnly is false, params.values comes from childrenAfterFilter.
- * When true, it comes from childrenAfterGroup (all children).
- * We match by length to pick the right list without checking the grid option directly.
- */
 function getMatchingChildNodes(groupRowNode, valueCount) {
     if (groupRowNode.childrenAfterFilter?.length === valueCount) {
         return groupRowNode.childrenAfterFilter;

package/src/AdaptableState/Common/AdaptableColumn.js

@@ -36,7 +36,6 @@ export function getColumnTypeFriendlyName(columnType) {
             return columnType;
     }
 }
-// this is only implemented for 1 level groups
 export const isValidOrderForColumnGroups = ({ oldColumns, newColumns, }) => {
     const getGroups = (columns) => {
         let prevGroup = '';

package/src/AdaptableState/Common/AdaptableForm.js

@@ -1,15 +1,6 @@
-/**
- * Returns true if the supplied entry from a form's `fields` array is a
- * group rather than a single field or an inline-row array of fields.
- */
 export function isAdaptableFormFieldGroup(entry) {
     return !!entry && !Array.isArray(entry) && entry.kind === 'group';
 }
-/**
- * Flattens a form's `fields` array (which may contain field groups and
- * inline-row arrays) into a single flat list of fields. Useful when
- * computing defaults, validation or per-field lookups.
- */
 export function flattenAdaptableFormFields(formDef) {
     const out = [];
     for (const entry of formDef?.fields ?? []) {
@@ -66,10 +57,6 @@ export function resolveSelectPlaceholder(field, options) {
 export function getDefaultAdaptableFormData(formDef) {
     return flattenAdaptableFormFields(formDef).reduce((data, field) => {
         if (field.fieldType === 'select' && field.multi) {
-            // Multi-selects always work in terms of arrays. Allow the consumer to
-            // supply an explicit defaultValue (which may already be an array) but
-            // fall back to an empty array rather than '' so downstream code never
-            // has to guard against a string value.
             data[field.name] = Array.isArray(field.defaultValue)
                 ? field.defaultValue
                 : field.defaultValue == null || field.defaultValue === ''
@@ -82,15 +69,6 @@ export function getDefaultAdaptableFormData(formDef) {
         return data;
     }, {});
 }
-/**
- * Resolves a field's `options` to the current array of options.
- *
- * - When `options` is already an array, it's returned as-is.
- * - When it's a synchronous function, the function is invoked.
- * - When the function returns a Promise this helper returns `undefined` -
- *   asynchronous resolution is the caller's responsibility (the
- *   `AdaptableFormComponent` resolves promises via internal state).
- */
 export function resolveAdaptableFormFieldOptionsSync(field, formData, context) {
     const opts = field.options;
     if (!opts)
@@ -102,45 +80,24 @@ export function resolveAdaptableFormFieldOptionsSync(field, formData, context) {
         return undefined;
     return result;
 }
-/**
- * Returns true if the given field should be hidden given the current form
- * data and context. Resolves both boolean and function forms of `hidden`.
- */
 export function isAdaptableFormFieldHidden(field, formData, context) {
     if (typeof field.hidden === 'function') {
         return !!field.hidden(formData, context);
     }
     return !!field.hidden;
 }
-/**
- * Returns true if the given group should be hidden given the current
- * form data and context.
- */
 export function isAdaptableFormFieldGroupHidden(group, formData, context) {
     if (typeof group.hidden === 'function') {
         return !!group.hidden(formData, context);
     }
     return !!group.hidden;
 }
-/**
- * Returns true if the given field should be disabled given the current
- * form data and context. Resolves both boolean and function forms of
- * `disabled`.
- */
 export function isAdaptableFormFieldDisabled(field, formData, context) {
     if (typeof field.disabled === 'function') {
         return !!field.disabled(formData, context);
     }
     return !!field.disabled;
 }
-/**
- * Validates an entire AdaptableForm. Hidden fields and fields inside
- * hidden groups are skipped. Returns a map of field-name to error
- * message; fields without entries are valid.
- *
- * Validation order per field: `required` -> built-in (min/max/length/
- * pattern) -> custom `validate`. The first failing check wins.
- */
 export function validateAdaptableForm(formDef, formData, context) {
     const errors = {};
     for (const entry of formDef?.fields ?? []) {
@@ -175,11 +132,9 @@ function validateOne(field, formData, context, errors) {
 }
 function validateAdaptableFormField(field, formData, context) {
     const value = formData[field.name];
-    // textOutput is read-only; never produces validation errors
     if (field.fieldType === 'textOutput') {
         return null;
     }
-    // 1) required
     if (field.required) {
         const isEmpty = value == null ||
             value === '' ||
@@ -189,9 +144,7 @@ function validateAdaptableFormField(field, formData, context) {
             return `${field.label} is required`;
         }
     }
-    // empty optional values skip subsequent built-ins
     const isProvided = value != null && value !== '';
-    // 2) built-in numeric / length / pattern checks
     if (isProvided) {
         if (field.fieldType === 'number' || field.fieldType === 'slider') {
             const numValue = Number(value);
@@ -230,12 +183,10 @@ function validateAdaptableFormField(field, formData, context) {
                     }
                 }
                 catch {
-                    // invalid pattern - silently ignore so we don't crash the form
                 }
             }
         }
     }
-    // 3) custom validation
     if (field.validate) {
         const customError = field.validate(value, formData, context);
         if (customError) {

package/src/AdaptableState/Common/AdaptableFormatPresets.js

@@ -1,7 +1,3 @@
-/**
- * Concrete options associated with each numeric preset. The wizard and
- * runtime resolver both pull from this single source of truth.
- */
 export const NUMERIC_FORMAT_PRESETS = {
     Percentage: {
         FractionDigits: 2,
@@ -155,18 +151,9 @@ export const NUMERIC_FORMAT_PRESETS = {
         Notation: 'scientific',
     },
 };
-/**
- * Type guard: `true` if the value is a known numeric preset name.
- */
 export const isAdaptableNumericFormatPreset = (value) => {
     return typeof value === 'string' && value in NUMERIC_FORMAT_PRESETS;
 };
-/**
- * Resolve a `DisplayFormat` (preset name or concrete object) into a
- * concrete `AdaptableFormat`. Returns `undefined` if the input is
- * `undefined`. A bare preset name is expanded into a `NumberFormatter`
- * with the corresponding options.
- */
 export const resolveDisplayFormat = (displayFormat) => {
     if (displayFormat == null) {
         return undefined;