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

package/src/Api/Internal/FormatColumnInternalApi.js

@@ -20,134 +20,70 @@ function getParentGroup(source) {
             return undefined;
         }
         const currentProvidedColumnGroup = current.getProvidedColumnGroup();
-        // for columns that don't belong to groups or belong to a group that doesn't have full depth
-        // there are artificial parent groups created by ag-grid
-        // so for the current column group, lets grab the leaf columns
-        // and if the only leaf column is the source column, then we can continue
-        // and do another iteration where we go up one level
         if (currentProvidedColumnGroup) {
             const leafColumns = current.getLeafColumns();
             if (leafColumns.length === 1 && leafColumns[0] === source) {
                 continue;
             }
-            // otherwise, we have found the parent group corresponding to the source column
             return currentProvidedColumnGroup;
         }
     }
     return undefined;
 }
 class FormatColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Retrieves all Format Columns in Adaptable State with the `Style` property set
-     * @returns format columns
-     */
     getAllFormatColumnWithStyle(config) {
         return this.getFormatColumnApi()
             .getFormatColumns(config)
             .filter((fc) => fc.Style);
     }
-    /**
-     * Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set
-     * @returns format columns
-     */
     getAllFormatColumnWithDisplayFormat(config) {
         return this.getFormatColumnApi()
             .getFormatColumns(config)
             .filter((fc) => fc.DisplayFormat);
     }
-    /**
-     * Get all FormatColumns which are defined for this column and have a custom AdaptableStyle
-     * @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()
             .filter((formatColumn) => {
-            // FormatColumn default target is 'cell', so if no target is specified, we assume 'cell'
             const fcTarget = formatColumn.Target ?? 'cell';
             return fcTarget === config.target;
         })
             .filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
         return this.getFormatColumnWithColumnInScope(formatColumns, column);
     }
-    /**
-     * Gets Format Column if any for given Column which includes Style element with ClassName
-     * @param column The Column for which to retrieve the Format Column
-     * @returns format columns
-     */
     getFormatColumnWithStyleClassNameForColumn(column, config) {
         return this.getFormatColumnsWithStyleForColumn(column, config).filter((formatColumn) => StringExtensions_1.default.IsNotNullOrEmpty(formatColumn?.Style?.ClassName));
     }
     getFormatColumnWithColumnInScope(formatColumns, column) {
         return this.getFormatColumnInColumnScope(formatColumns).filter((scopedFormatColumn) => this.getColumnScopeApi().isColumnInScope(column, scopedFormatColumn.Scope));
     }
-    // TODO is this really needed, I don't think it achieves anything
     getFormatColumnInColumnScope(formatColumns) {
-        // we need to maintain the format columns order, therefore we will extract all 3 scope types in a single iteration
         return formatColumns.filter((fc) => {
-            return (
-                // this.getFormatColumnsWithColumnScope(formatColumns)
-                (this.getColumnScopeApi().scopeHasColumns(fc.Scope) ||
-                    // this.getFormatColumnsWithDataTypeScope(formatColumns)
-                    this.getColumnScopeApi().scopeHasDataType(fc.Scope) ||
-                    // this.getFormatColumnsWithAllScope(formatColumns)
-                    this.getColumnScopeApi().scopeIsAll(fc.Scope) || this.getColumnScopeApi().scopeHasColumnType(fc.Scope))
-            );
+            return (this.getColumnScopeApi().scopeHasColumns(fc.Scope) ||
+                this.getColumnScopeApi().scopeHasDataType(fc.Scope) ||
+                this.getColumnScopeApi().scopeIsAll(fc.Scope) ||
+                this.getColumnScopeApi().scopeHasColumnType(fc.Scope));
         });
     }
-    /**
-     * Get all FormatColumns which are defined for this column and have a custom DisplayFormat
-     * @param column
-     * @param config
-     * @returns list of FormatColumn
-     */
     getFormatColumnsWithDisplayFormatForColumn(column, config) {
         const formatColumns = this.getAllFormatColumnWithDisplayFormat()
             .filter((formatColumn) => {
-            // FormatColumn default target is 'cell', so if no target is specified, we assume 'cell'
             const fcTarget = formatColumn.Target ?? 'cell';
             return fcTarget === config.target;
         })
             .filter((formatColumn) => config?.includeSuspended || !formatColumn.IsSuspended);
         return this.getFormatColumnWithColumnInScope(formatColumns, column);
     }
-    /**
-     * Format value according to format options.
-     *
-     * @param customDisplayFormatterContext context that includes value to format
-     * @param options formatter options
-     */
     getNumberFormattedValue(value, node, column, options) {
         const preparedValue = this.applyCustomFormatters(value, node, column, options);
         return DisplayFormatHelper_1.default.NumberFormatter(preparedValue, options, node, column, this.getAdaptableApi());
     }
-    /**
-     * Format value according to format options.
-     *
-     * @param value  context that includes value to format
-     * @param options formatter options
-     */
     getStringFormattedValue(value, node, column, options) {
         const preparedValue = this.applyCustomFormatters(value, node, column, options);
         return DisplayFormatHelper_1.default.StringFormatter(preparedValue, options, node, column, this.getAdaptableApi());
     }
-    /**
-     * Format value according to format options.
-     *
-     * @param customDisplayFormatterContext  context that includes value to format
-     * @param options formatter options
-     */
     getDateFormattedValue(value, node, abColumn, options) {
         const preparedValue = this.applyCustomFormatters(value, node, abColumn, options);
         const dateFormatterOptions = options;
-        // only use DateFormatter if we have a pattern
         return dateFormatterOptions.Pattern
             ? DisplayFormatHelper_1.default.DateFormatter(preparedValue, options)
             : preparedValue;
@@ -158,7 +94,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return value;
         }
         const customFormattersFromOptions = this.getFormatColumnOptions()?.customDisplayFormatters ?? [];
-        // formatters are applied in the order they are defined in the options
         const customFormatters = customFormattersFromOptions.filter((customFormatterOption) => columnCustomFormatters.includes(customFormatterOption.id));
         const customDisplayFormatterContext = ObjectFactory_1.default.CreateCustomDisplayFormatterContext(value, node, abColumn, this.getAdaptableApi());
         return customFormatters.reduce((context, formatter) => {
@@ -168,10 +103,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return context.cellValue;
         }, customDisplayFormatterContext);
     }
-    /**
-     * Returns all Predicates appropriate for the given Scope
-     * @param scope Scope to check
-     */
     getFormatColumnDefsForScope(scope) {
         return this.getAdaptableApi()
             .predicateApi.internalApi.getFormatColumnPredicateDefs(scope)
@@ -200,7 +131,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             columnGroupLeafColumns.length === 1 &&
             columnGroupLeafColumns[0] === agGridColumn;
         if (columnIsTopLevel) {
-            // for top-level columns don't apply formatColumns that have an explicit ColumnGroupScope defined
             return false;
         }
         if (formatColumn.ColumnGroupScope === 'Both') {
@@ -208,15 +138,7 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         }
         return formatColumn.ColumnGroupScope === columnGroupScope;
     }
-    /**
-     * Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)
-     *
-     * @param formatColumn
-     * @param column
-     * @param params
-     */
     formatColumnShouldRenderInCell(formatColumn, column, rowNode, cellValue, pivotResultColumn) {
-        // suspended is important to be first
         if (formatColumn.IsSuspended) {
             return false;
         }
@@ -250,7 +172,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         if (!formatColumn.Rule) {
             return true;
         }
-        // first run the predicate
         if (formatColumn.Rule.Predicates && formatColumn.Rule?.Predicates?.length) {
             const predicateDefHandlerContext = {
                 value: cellValue,
@@ -262,19 +183,12 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
                 ...this.getAdaptableInternalApi().buildBaseContext(),
             };
             return this.evaluatePredicate(formatColumn, predicateDefHandlerContext);
-        } // then run the Expression
+        }
         else if (formatColumn.Rule.BooleanExpression) {
             return this.evaluateExpression(formatColumn, rowNode, column, pivotResultColumn);
         }
-        // nothing has passed then return false
         return false;
     }
-    /**
-     * Checks if format column is relevant for a given Column Header
-     *
-     * @param formatColumn
-     * @param column
-     */
     formatColumnShouldRenderInHeader(formatColumn, column) {
         if (formatColumn.IsSuspended) {
             return false;
@@ -301,20 +215,9 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             return false;
         }
     }
-    /**
-     * Extract from the given FormatColumns the one which is the most relevant  for a given cell (intersection of given AdaptableColumn and RowNode)
-     *
-     * @param formatColumns
-     * @param column
-     * @param params
-     */
     getMostRelevantFormatColumnForColumn(formatColumns, column, params) {
         return formatColumns.find((formatColumn) => this.formatColumnShouldRenderInCell(formatColumn, column, params.node, params.value));
     }
-    /**
-     * Retrieves all Format Columns which have an Expression
-     * @returns Format Columns with Expression
-     */
     getFormatColumnsWithExpression(config) {
         return this.getFormatColumnApi()
             .getFormatColumns(config)
@@ -325,9 +228,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
             .getFormatColumns(config)
             .filter((fc) => fc.Rule?.Predicates?.some((p) => columnSet.has(p.ColumnId)));
     }
-    /**
-     * Retrieves the columns that need rerendering based on format column predicates.
-     */
     getFormatColumnColumnsDependentOnColumnChange(column) {
         const impactedColumnIds = new Set();
         impactedColumnIds.add(column.columnId);
@@ -347,7 +247,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         return [...columnsThatNeedRefresh];
     }
     formatColumnHeaderName(headerName, params) {
-        // currently we only format the header name for normal columns (NOT column groups)
         if (!params.column) {
             return headerName;
         }
@@ -364,7 +263,6 @@ class FormatColumnInternalApi extends ApiBase_1.ApiBase {
         }
         const resolvedDisplayFormat = (0, AdaptableFormatPresets_1.resolveDisplayFormat)(mostRelevantFormatColumn.DisplayFormat);
         if (resolvedDisplayFormat?.Formatter !== 'StringFormatter') {
-            // headers are always strings, so we can only use StringFormatter
             return headerName;
         }
         const formattedHeaderName = this.getFormatColumnApi().internalApi.getStringFormattedValue(headerName, null, abColumn, resolvedDisplayFormat.Options);

package/src/Api/Internal/FreeTextColumnInternalApi.js

@@ -9,10 +9,6 @@ const AdaptableDateEditor_1 = require("../../agGrid/editors/AdaptableDateEditor"
 const ArrayExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/ArrayExtensions"));
 const AdaptableColumn_1 = require("../../AdaptableState/Common/AdaptableColumn");
 class FreeTextColumnInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Checks if a User Edit was in a Free Text Column
-     * @param cellDataChangedInfo change to check
-     */
     handleFreeTextColumnDataChange(cellDataChangedInfo) {
         let freeTextColumn = this.getFreeTextColumnApi()
             .getFreeTextColumns()
@@ -25,10 +21,6 @@ class FreeTextColumnInternalApi extends ApiBase_1.ApiBase {
             this.getFreeTextColumnApi().setStoredValue(freeTextColumn.ColumnId, freeTextStoredValue);
         }
     }
-    /**
-     * Returns all the references in the AdaptableState of the given FreeTextColumn
-     * @param freeTextColumn FreeTextColumn to be checked
-     */
     getFreeTextColumnModuleReferences(freeTextColumn) {
         const references = [];
         this.getAdaptableInternalApi()

package/src/Api/Internal/GridFilterInternalApi.js

@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.GridFilterInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class GridFilterInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Compares to Grid Filter to see if they are identical
-     */
     isGridFilterDifferent(oldFilter, newFilter) {
         if (oldFilter == undefined && newFilter == undefined) {
             return false;

package/src/Api/Internal/GridInternalApi.js

@@ -11,10 +11,6 @@ const ScheduledAlertHelper_1 = require("../../Utilities/Helpers/Scheduling/Sched
 const UIHelper_1 = tslib_1.__importDefault(require("../../View/UIHelper"));
 const ApiBase_1 = require("../Implementation/ApiBase");
 class GridInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Gets all distinct display values in the Column for given ColumnId
-     * @param columnId Column to check
-     */
     getDistinctDisplayValuesForColumnOld(columnId) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
@@ -25,18 +21,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
             return cv.normalisedValue;
         });
     }
-    /**
-     * Gets all distinct Filter values for the Column with the given ColumnId
-     * used for Floating Filter and Column Header filter
-     * either returns a list of values or al ist a list of values with count
-     *
-     * This is a general method, and it is used in:
-     * - Column Filters
-     * - Query Builder
-     * - Permitted Values
-     *
-     * @param columnId Column to check
-     */
     async getDistinctFilterDisplayValuesForColumn(options) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(options.columnId);
         if (abColumn == undefined) {
@@ -73,10 +57,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         });
         return valueOptions || [];
     }
-    /**
-     * Gets all distinct raw values in Column. Values are sorted.
-     * @param columnId Column to check
-     */
     getDistinctRawValuesForColumn(columnId) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
@@ -86,10 +66,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
             return cv.rawValue;
         });
     }
-    /**
-     * Gets all distinct raw values in Column. Values are un-sorted.
-     * @param columnId Column to check
-     */
     getUnsortedDistinctRawValuesForColumn(columnId) {
         const abColumn = this.getColumnApi().getColumnWithColumnId(columnId);
         if (abColumn == undefined) {
@@ -103,9 +79,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         const columnApi = this.getColumnApi();
         const rowNodesMapToCells = new Map();
         const allRowNodes = [];
-        // for each row node,let's create an object
-        // with only those gridcells that are needed - meaning
-        // for those column that are in the current sort
         const rowNodeCallback = (node) => {
             allRowNodes.push(node);
             const rowNodeCells = {};
@@ -127,15 +100,12 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         }
         const sortInfo = columnSorts.map((columnSort) => {
             const { ColumnId } = columnSort;
-            // NOTE: the comparator we pass to multisort should always sort in ascending order
-            // that's why we pass SortOrder.Asc to the comparators
             const comparator = columnApi.hasNumberDataType(ColumnId)
                 ? (0, ArrayExtensions_1.getNumericComparatorForGridCell)(Enums_1.SortOrder.Asc)
                 : columnApi.hasDateDataType(ColumnId)
                     ? (0, ArrayExtensions_1.getDateComparatorForGridCell)(Enums_1.SortOrder.Asc)
                     : (0, ArrayExtensions_1.getGenericComparatorForGridCell)(Enums_1.SortOrder.Asc);
             return {
-                // but here we pass the actual direction of the column sort
                 dir: columnSort.SortOrder === 'Asc' ? 1 : -1,
                 fn: (rowNodeA, rowNodeB) => {
                     const gridCellA = rowNodesMapToCells.get(rowNodeA)?.[ColumnId];
@@ -150,7 +120,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         return (0, infinite_react_1.multisort)(sortInfo, allRowNodes);
     }
     sortDistinctValues(returnValues, column) {
-        // this does NOT into account Custom Sort - far too hard for now...
         let sortOrder = undefined;
         let columnSort = this.getGridApi().getColumnSortForColumn(column.columnId);
         if (columnSort && columnSort.SortOrder) {
@@ -245,11 +214,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
     hasCellEditableAccordingToEditOptions() {
         return typeof this.getEditOptions()?.isCellEditable === 'function';
     }
-    /**
-     * Returns UNDEFINED if no EditOptions.isCellEditable is provided, otherwise returns the result of the function
-     *
-     * DO NOT USE THIS METHOD DIRECTLY - use `GridApi.isCellEditable` instead
-     */
     isCellEditableAccordingToEditOptions(gridCell, defaultColDefinitionEditableValue) {
         const cellEditable = this.getEditOptions()?.isCellEditable;
         if (cellEditable) {
@@ -263,7 +227,6 @@ class GridInternalApi extends ApiBase_1.ApiBase {
         return undefined;
     }
     isRowFilterable(rowNode) {
-        // first assess if the Row is filterable - if not, then return true so it appears in Grid
         const isRowFilterable = this.getOptionsApi().getFilterOptions().isRowFilterable;
         if (typeof isRowFilterable === 'function') {
             const rowFilterableContext = {

package/src/Api/Internal/LayoutInternalApi.js

@@ -11,18 +11,9 @@ const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectF
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
 const AdaptableHelper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/AdaptableHelper"));
 class LayoutInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Compares 2 Layouts for equality
-     * @param layout1 First Layout
-     * @param layout2 Second Layout
-     */
     areLayoutsEqual(layout1, layout2) {
         return (0, LayoutHelpers_1.areLayoutsEqual)(layout1, layout2);
     }
-    /**
-     * Returns what the layout supports.
-     * This takes into account the data-source.
-     */
     getLayoutSupportedFeatures() {
         const layoutSupportedFeatures = {
             RowGroupedColumns: true,
@@ -35,7 +26,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
             RowSummaries: true,
         };
         if (this.getGridApi().isTreeDataGrid()) {
-            //  layoutSupportedFeatures.RowGroupedColumns = false;
             layoutSupportedFeatures.PivotColumns = false;
         }
         if (this.getGridApi().getAgGridRowModelType() === 'viewport') {
@@ -127,7 +117,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         if (ArrayExtensions_1.default.IsNullOrEmpty(oldSorts) && ArrayExtensions_1.default.IsNullOrEmpty(newSorts)) {
             return [];
         }
-        // If either one is empty but not both, all columns in the non-empty array have changed
         if (ArrayExtensions_1.default.IsNullOrEmpty(oldSorts)) {
             return newSorts.map((sort) => sort.ColumnId);
         }
@@ -135,22 +124,17 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
             return oldSorts.map((sort) => sort.ColumnId);
         }
         const changedColumnIds = [];
-        // Create maps for quick lookup
         const oldSortsMap = new Map();
         oldSorts.forEach((sort) => {
             oldSortsMap.set(sort.ColumnId, sort.SortOrder);
         });
-        // Check columns in new sorts that changed from old sorts
         newSorts.forEach((newSort) => {
             const oldSortOrder = oldSortsMap.get(newSort.ColumnId);
-            // If column wasn't sorted before or sort order changed
             if (oldSortOrder === undefined || oldSortOrder !== newSort.SortOrder) {
                 changedColumnIds.push(newSort.ColumnId);
             }
-            // Remove processed columns from the map
             oldSortsMap.delete(newSort.ColumnId);
         });
-        // Add remaining columns from old sorts (these were removed in new sorts)
         oldSortsMap.forEach((_, columnId) => {
             changedColumnIds.push(columnId);
         });
@@ -197,7 +181,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         return result;
     }
     getCurrentLayout_perfOptimized() {
-        // perf-optimized version of getCurrentLayout()
         const layoutState = this.getAdaptableState().Layout;
         const currentLayoutName = layoutState.CurrentLayout;
         if (!currentLayoutName) {
@@ -213,7 +196,6 @@ class LayoutInternalApi extends ApiBase_1.ApiBase {
         let allHaveFilter = true;
         let allHaveFloatingFilter = true;
         for (const column of groupedAgColumns) {
-            // Early exit: no need to continue if both are already false
             if (!allHaveFilter && !allHaveFloatingFilter) {
                 break;
             }

package/src/Api/Internal/NamedQueryInternalApi.js

@@ -5,10 +5,6 @@ const tslib_1 = require("tslib");
 const ObjectFactory_1 = tslib_1.__importDefault(require("../../Utilities/ObjectFactory"));
 const ApiBase_1 = require("../Implementation/ApiBase");
 class NamedQueryInternalApi extends ApiBase_1.ApiBase {
-    /**
-     * Returns the name of all the referenced Named Queries as an array of strings
-     * @param expression query string
-     */
     getReferencedNamedQueryNames(expression = '') {
         try {
             return this.getAdaptableInternalApi()
@@ -16,16 +12,11 @@ class NamedQueryInternalApi extends ApiBase_1.ApiBase {
                 .getNamedQueryNamesFromExpression(expression);
         }
         catch (error) {
-            // defensive programing, this should happen only if someone botched Initial Adaptable State
             this.logWarn(`QueryApi.getReferencedNamedQueryNames received an invalid expression: ${expression}
                   Error: ${error}`);
             return [];
         }
     }
-    /**
-     * Returns all the references in the AdaptableState of the NamedQuery with the given name
-     * @param namedQueryName namedQuery name
-     */
     getNamedQueryModuleReferences(namedQueryName) {
         const references = [];
         this.getAdaptableInternalApi()

package/src/Api/Internal/PredicateInternalApi.js

@@ -9,9 +9,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
     IsInOrNotInPredicateDef(predicateDef) {
         return predicateDef && ['In', 'NotIn'].includes(predicateDef.id);
     }
-    /**
-     * Get all Filter Predicate Definitions - System and Custom
-     */
     getFilterPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemFilterPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('columnFilter'));
     }
@@ -42,9 +39,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemFilterPredicates;
     }
-    /**
-     * Get all Alert Predicate Definitions - System and Custom
-     */
     getAlertPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemAlertPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('alert'));
     }
@@ -74,9 +68,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemBadgeStylePredicates;
     }
-    /**
-     * Get all Format Column Predicate Definitions - System and Custom
-     */
     getFormatColumnPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemFormatColumnPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('formatColumn'));
     }
@@ -93,9 +84,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemFormatColumnPredicates;
     }
-    /**
-     * Get all Flashing Cell Predicate Definitions - System and Custom
-     */
     getFlashingCellPredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemFlashingCellPredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('flashingcell'));
     }
@@ -112,10 +100,6 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return systemFlashingCellPredicates;
     }
-    /**
-     * Gets the correct Equality-type System Predicate for a particular DataType
-     * @param dataType DataType of Column
-     */
     getEqualityPredicateForDataType(dataType) {
         let predicateId;
         switch (dataType) {
@@ -134,16 +118,9 @@ class PredicateInternalApi extends ApiBase_1.ApiBase {
         }
         return predicateId;
     }
-    /**
-     * Get all Badge Style Predicate Definitions - System and Custom
-     */
     getBadgeStylePredicateDefs(scope) {
         return this.mergeSystemAndCustomPredicates(this.getSystemBadgeStylePredicateIds(scope)?.map((predicateId) => this.getPredicateApi().getPredicateDefById(predicateId)), this.getPredicateApi().getCustomPredicateDefs()).filter((predicateDef) => predicateDef.moduleScope.includes('badgeStyle'));
     }
-    /**
-     * Merges System and Custom Predicate Definitions but ensures that Custom ones take precedence
-     * (i.e. if there is a Custom Predicate with the same Id as a System one, the Custom one is used)
-     */
     mergeSystemAndCustomPredicates(systemDefs, customDefs) {
         const systemDefsToUse = systemDefs.map((systemDef) => {
             const customDef = customDefs.find((customDef) => customDef.id === systemDef.id);

package/src/Api/Internal/RowFormInternalApi.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RowFormInternalApi = void 0;
 const ApiBase_1 = require("../Implementation/ApiBase");
 class RowFormInternalApi extends ApiBase_1.ApiBase {
-    // Row Form Methods
     async buildRowEditForm(rowNode) {
         return this.buildRowForm('rowEdited', rowNode);
     }
@@ -46,11 +45,9 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
             : rowFormOptions.rowFormDescription;
     }
     buidRowFormButtons(type, rowNode, formFields) {
-        // 1. check if there are custom user provided buttons
         if (Array.isArray(this.getRowFormOptions().rowFormButtons)) {
             return this.getRowFormOptions().rowFormButtons;
         }
-        // 2. else return the standard ones
         const cancelButton = {
             label: 'Cancel',
             buttonStyle: {
@@ -64,19 +61,11 @@ 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
                 const eventInfo = type === 'rowCreated'
                     ? {
                         type: 'rowCreated',
@@ -97,7 +86,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
         return [cancelButton, saveButton];
     }
     prepareCreateData(formFields, context) {
-        // when creating we just omit values that are not set
         const dataToSave = { ...context.formData };
         for (const formField of formFields) {
             if (dataToSave[formField.name] === '') {
@@ -121,7 +109,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
         const relevantColumns = this.getColumnApi()
             .getUIAvailableColumns()
             .filter((column) => {
-            // if there is NO rowNode, do NOT display the non-editable fields as they will be empty
             return !!rowNode || this.isCellEditable(column, rowNode);
         })
             .filter((column) => this.showColumnInRowForm(column, rowFormType));
@@ -168,10 +155,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
             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));
@@ -204,7 +187,6 @@ class RowFormInternalApi extends ApiBase_1.ApiBase {
             case 'number':
                 return 'number';
             default:
-                // everything else is a plain text input
                 return 'text';
         }
     }