@adaptabletools/adaptable 20.0.0-canary.18 → 20.0.0-canary.19

package/package.json

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

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -218,7 +218,7 @@ const DefaultAdaptableOptions = {
     quickSearchOptions: {
         clearQuickSearchOnStartUp: false,
         quickSearchPlaceholder: 'Search',
-        filterResultsAfterQuickSearch: false,
+        filterGridAfterQuickSearch: false,
         isQuickSearchCaseSensitive: false,
         runCustomQuickSearch: undefined,
     },

package/src/AdaptableOptions/QuickSearchOptions.d.ts

@@ -30,13 +30,13 @@ export interface QuickSearchOptions<TData = any> {
      */
     clearQuickSearchOnStartUp?: boolean;
     /**
-     * Filters quick search results so only matching rows are displayed
+     * Filters Grid after quick search so only matching rows are displayed
      *
      * @defaultValue false
      * @gridInfoItem
      * @noCodeItem
      */
-    filterResultsAfterQuickSearch?: boolean;
+    filterGridAfterQuickSearch?: boolean;
     /**
      * Run Quick Search using Case Sensitivity
      *

package/src/Api/Implementation/ColumnFilterApiImpl.js

@@ -115,7 +115,7 @@ export class ColumnFilterApiImpl extends ApiBase {
         return ('[' +
             friendlyName +
             '] ' +
-            this.getPredicateApi().predicatesToString(columnFilter.Predicates, columnFilter.PredicatesLogic));
+            this.getPredicateApi().predicatesToString(columnFilter.Predicates, columnFilter.PredicatesOperator));
     }
     columnFiltersToString(columnFilters) {
         return columnFilters.map((cf) => this.columnFilterToString(cf)).join(', ');

package/src/Api/Implementation/PredicateApiImpl.js

@@ -117,7 +117,7 @@ export class PredicateApiImpl extends ApiBase {
         if (predicates === undefined || predicates === null || predicates?.length === 0) {
             return this.handlePredicate(undefined, params, defaultReturn);
         }
-        if (params.predicatesLogic && params.predicatesLogic === 'OR') {
+        if (params.predicatesOperator && params.predicatesOperator === 'OR') {
             return predicates?.some((p) => this.handlePredicate(p, params, defaultReturn));
         }
         return predicates?.every((p) => this.handlePredicate(p, params, defaultReturn));

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -92,7 +92,7 @@ export class ColumnFilterInternalApi extends ApiBase {
             displayValue: gridCell.displayValue,
             node,
             column,
-            predicatesLogic: columnFilter.PredicatesLogic,
+            predicatesOperator: columnFilter.PredicatesOperator,
             ...this.getAdaptableInternalApi().buildBaseContext(),
         };
         return this.getPredicateApi().handlePredicates(columnFilter.Predicates, predicateDefHandlerContext, true);

package/src/PredefinedConfig/Common/AdaptablePredicate.d.ts

@@ -104,7 +104,7 @@ export interface PredicateDefHandlerContext extends BaseContext {
      * Any (optional) inputs required to perform evaluation
      */
     inputs?: any[];
-    predicatesLogic?: ColumnFilter['PredicatesLogic'];
+    predicatesOperator?: ColumnFilter['PredicatesOperator'];
 }
 /**
  * Inputs required for a Predicate

package/src/PredefinedConfig/Common/ColumnFilter.d.ts

@@ -13,10 +13,10 @@ export interface ColumnFilter extends SuspendableObject {
      */
     Predicates: ColumnFilterPredicate[];
     /**
-     * The Logic to use when combining multiple Predicates
+     * Logic used when combining multiple Predicates ('AND'|'OR')
      * @defaultValue 'AND'
      */
-    PredicatesLogic?: 'AND' | 'OR';
+    PredicatesOperator?: PredicatesOperator;
 }
 /**
  * A Predicate used in Column Filtering
@@ -24,6 +24,10 @@ export interface ColumnFilter extends SuspendableObject {
 export interface ColumnFilterPredicate extends AdaptablePredicate {
     PredicateId: TypeHint<string, SystemFilterPredicateId>;
 }
+/**
+ * Logic used to join multiple Predicates
+ */
+export type PredicatesOperator = 'AND' | 'OR';
 /**
  * Array containing all System Filter Predicates
  */

package/src/PredefinedConfig/LayoutState.d.ts

@@ -125,7 +125,7 @@ export interface PivotLayout extends LayoutBase {
      */
     PivotColumns: string[];
     /**
-     * How deep to expand Pivots
+     * How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all)
      */
     PivotExpandLevel?: number;
     /**

package/src/Redux/ActionsReducers/LayoutRedux.d.ts

@@ -180,7 +180,7 @@ export declare const getCurrentLayoutSelector: (state: AdaptableState) => Layout
 export declare const getColumnFilterSelector: (state: AdaptableState, columnId: string) => {
     ColumnId: string;
     Predicates: import("../../types").ColumnFilterPredicate[];
-    PredicatesLogic?: "AND" | "OR";
+    PredicatesOperator?: import("../../types").PredicatesOperator;
     IsSuspended?: boolean;
     Uuid?: string;
     Source?: "Config" | "User";

package/src/Redux/Store/AdaptableStore.js

@@ -500,7 +500,7 @@ const adaptableMiddleware = (adaptable) => (function(middlewareAPI) {
                     let returnAction = next(action);
                     adaptable.api.gridApi.refreshAllCells(true);
                     // if set then return a query on the text
-                    if (adaptable.adaptableOptions.quickSearchOptions.filterResultsAfterQuickSearch) {
+                    if (adaptable.adaptableOptions.quickSearchOptions.filterGridAfterQuickSearch) {
                         const actionTyped = action;
                         const searchText = actionTyped.quickSearchText;
                         if (StringExtensions.IsNotNullOrEmpty(searchText)) {

package/src/Utilities/Helpers/FormatHelper.js

@@ -3,6 +3,7 @@ import { format as dateFnsFormat } from 'date-fns';
 import { sentenceCase } from 'sentence-case';
 import { DEFAULT_DATE_FORMAT_PATTERN } from '../Constants/GeneralConstants';
 import Helper from './Helper';
+import StringExtensions from '../Extensions/StringExtensions';
 export function NumberFormatter(input, options = {}, rowNode, column, api) {
     let preparedInput;
     if (options.Content) {
@@ -110,20 +111,33 @@ export function DateFormatter(input, options, strictFormatting = false) {
     }
 }
 export function StringFormatter(input, options = {}, rowNode, column, api) {
+    let normalisedTextInput = input;
+    if (input != undefined && typeof input !== 'string') {
+        const warningMessage = column
+            ? `StringFormatter: input '${input}' from column ${column.columnId} (${column.dataType}) is not a string, but a ${typeof input}`
+            : `StringFormatter: input '${input}' is not a string, received ${typeof input}`;
+        if (api) {
+            api.logWarn(warningMessage);
+        }
+        else {
+            console.warn(warningMessage);
+        }
+        normalisedTextInput = `${input}`;
+    }
     let preparedInput;
     if (options.Content) {
         const context = {
             column,
             rowNode,
-            input,
+            input: normalisedTextInput,
             api,
         };
         preparedInput = formatPlaceholder(options.Content, context);
     }
     else {
-        preparedInput = input;
+        preparedInput = normalisedTextInput;
     }
-    if (preparedInput == null || preparedInput == undefined) {
+    if (StringExtensions.IsNullOrEmptyOrWhiteSpace(preparedInput)) {
         return undefined;
     }
     if (options.Empty) {

package/src/View/Components/ColumnFilter/LayoutColumnFilter.js

@@ -17,7 +17,7 @@ export const LayoutColumnFilter = (props) => {
             ...props.columnFilter,
             ColumnId: props.columnFilter.ColumnId,
             Predicates: newAdaptablePredicates,
-            PredicatesLogic: newPredicate.operator,
+            PredicatesOperator: newPredicate.operator,
         };
         props.onColumnFilterChange(newFilter);
     };

package/src/View/Components/ColumnFilter/useAdaptableFilterWrapper.js

@@ -31,7 +31,7 @@ export const useAdaptableFilterWrapper = (columnId, handleOnChangeOverride) => {
             ...columnFilter,
             ColumnId: columnId,
             Predicates: adaptablePredicate,
-            PredicatesLogic: logic,
+            PredicatesOperator: logic,
         };
         if (handleOnChangeOverride) {
             handleOnChangeOverride(newFilter);

package/src/View/Components/ColumnFilter/utils.js

@@ -76,7 +76,7 @@ export const isPredicateEmpty = (predicate, predicateDef) => {
         predicate.args.every((arg) => arg == undefined));
 };
 export const mapColumnFilterToQlPredicate = (columnFilter, abColumn, qlPredicateDefs, columnFilterOptions) => {
-    const combinator = columnFilter?.PredicatesLogic ?? 'AND';
+    const combinator = columnFilter?.PredicatesOperator ?? 'AND';
     const qlPredicate = {
         operator: combinator,
         args: (columnFilter?.Predicates ?? []).map?.(mapAdaptablePredicateToQlPredicate),

package/src/View/QuickSearch/QuickSearchPopup.js

@@ -14,7 +14,7 @@ import { useQuickSearchDebounced } from './useQuickSearchDebounced';
 const QuickSearchPopupComponent = (props) => {
     const [searchText, search] = useQuickSearchDebounced(props);
     const [state, setState] = useState({
-        RunQueryAfterQuickSearch: props.api.optionsApi.getQuickSearchOptions().filterResultsAfterQuickSearch,
+        RunQueryAfterQuickSearch: props.api.optionsApi.getQuickSearchOptions().filterGridAfterQuickSearch,
         EditedStyle: props.QuickSearchStyle,
     });
     const onUpdateStyle = (style) => {
@@ -23,7 +23,7 @@ const QuickSearchPopupComponent = (props) => {
     };
     const onQuickSearchBehaviourChange = (checked) => {
         setState({ ...state, RunQueryAfterQuickSearch: checked });
-        props.api.optionsApi.getAdaptableOptions().quickSearchOptions.filterResultsAfterQuickSearch =
+        props.api.optionsApi.getAdaptableOptions().quickSearchOptions.filterGridAfterQuickSearch =
             checked;
     };
     return (React.createElement(PopupPanel, { headerText: props.moduleInfo.FriendlyName, glyphicon: props.moduleInfo.Glyph, infoLink: props.moduleInfo.HelpPage, infoLinkDisabled: !props.api.internalApi.isDocumentationLinksDisplayed() },

package/src/View/StatusBar/AdaptableStatusBar.js

@@ -1,12 +1,18 @@
 import * as React from 'react';
+import { useEffect } from 'react';
 import { useDispatch, useSelector } from 'react-redux';
 import { Flex } from 'rebass';
 import { getStatusPanelsSelector } from '../../Redux/ActionsReducers/StatusBarRedux';
 import { useAdaptable } from '../AdaptableContext';
 import { StatusBarPanel } from './StatusBarPanel';
+import { useRerender } from '../../components/utils/useRerender';
 export const AdaptableStatusBar = (props) => {
-    const statusPanels = useSelector(getStatusPanelsSelector);
     const adaptable = useAdaptable();
+    const rerender = useRerender();
+    useEffect(() => {
+        return adaptable.api.eventApi.on('AdaptableStateChanged', rerender);
+    }, [adaptable]);
+    const statusPanels = useSelector(getStatusPanelsSelector);
     const dispatch = useDispatch();
     const statusSubPanels = statusPanels.find((statusPanel) => statusPanel.Key === props.context.Key);
     const allMenuItems = useSelector((state) => state?.Internal?.SettingsPanelModuleEntries);

package/src/agGrid/AdaptableAgGrid.js

@@ -100,6 +100,11 @@ import { mapOldTypeToDataType } from '../migration/VersionUpgrade20';
 const LocalEventService_Prototype = LocalEventService.prototype;
 const LocalEventService_dispatchEvent = LocalEventService_Prototype.dispatchEvent;
 LocalEventService_Prototype.dispatchEvent = function (event) {
+    const agGridApi = event.api;
+    if (agGridApi?.isDestroyed()) {
+        // do nothing if AG Grid was destroyed in the meantime
+        return;
+    }
     LocalEventService_dispatchEvent.apply(this, arguments);
     if (event.type === 'cellChanged' || event.type === 'dataChanged') {
         const eventRowNode = event.node;
@@ -119,6 +124,10 @@ LocalEventService_Prototype.dispatchEvent = function (event) {
                     // so IGNORE IT
                     return;
                 }
+                if (adaptable.isDestroyed) {
+                    // do nothing if adaptable is destroyed (this is a rare case and happens when Adaptable is quickly destroyed and recreated)
+                    return;
+                }
                 // we're on the correct instance, so do this
                 //@ts-ignore
                 const fn = adaptable.rowListeners ? adaptable.rowListeners[event.type] : null;
@@ -354,7 +363,7 @@ export class AdaptableAgGrid {
         this.lifecycleState = 'initAgGrid';
         this.agGridAdapter.initialGridOptions = gridOptions;
         const perfInitAgGrid = this.logger.beginPerf(`initAgGrid()`);
-        // AG Grid evaluates early on the floatingFilter params, so we need to "suppres" the floating filter temporarily
+        // AG Grid evaluates early on the floatingFilter params, so we need to "suppress" the floating filter temporarily
         // we will reset it once Adaptable is ready
         this.agGridColumnAdapter.setupColumnFloatingFilterTemporarily(gridOptions);
         this.validateColumnDefTypes(gridOptions.columnDefs);

package/src/env.js

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

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

@@ -1856,12 +1856,14 @@ export declare const ADAPTABLE_METAMODEL: {
             desc: string;
             isOpt?: undefined;
             defVal?: undefined;
+            ref?: undefined;
         } | {
             name: string;
             kind: string;
             desc: string;
             isOpt: boolean;
             defVal: string;
+            ref: string;
         })[];
     };
     ColumnFilterDef: {
@@ -4466,6 +4468,11 @@ export declare const ADAPTABLE_METAMODEL: {
             gridInfo?: undefined;
         })[];
     };
+    PredicatesOperator: {
+        name: string;
+        kind: string;
+        desc: string;
+    };
     PreProcessExportContext: {
         name: string;
         kind: string;