@adaptabletools/adaptable 21.0.0-canary.2 → 21.0.0-canary.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "21.0.0-canary.2",
+  "version": "21.0.0-canary.3",
   "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/FilterOptions.d.ts

@@ -212,7 +212,7 @@ export type InFilterValueResult = {
     /**
      * List of Items to display in the IN Column Filter
      */
-    values: InFilterValueInfo[];
+    values: InFilterValue[];
     /**
      * When TRUE, displays the provided values without any filtering.
      * When FALSE, the values are filtered based on the current search text.

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

@@ -55,5 +55,6 @@ export declare class ColumnFilterInternalApi extends ApiBase {
         currentSearchValue: string;
     }): Promise<InFilterValueResult>;
     shouldAutoApplyColumnFilter(columnId: string): boolean;
+    getAdaptableFilterHandler(columnId: string): AdaptableFilterHandler | undefined;
     getAllAdaptableFilterHandlers(): AdaptableFilterHandler[];
 }

package/src/Api/Internal/ColumnFilterInternalApi.js

@@ -254,14 +254,14 @@ export class ColumnFilterInternalApi extends ApiBase {
             this.logWarn(`No ColumnFilterHandler found for columnId: ${options.columnId}!`);
             return this.getGridApi().internalApi.getDistinctFilterDisplayValuesForColumn(newOptions);
         }
-        if (typeof columnFilterHandler.getFilterDisplayValuesFromCache !== 'function') {
-            this.logWarn(`ColumnFilterHandler for columnId: ${options.columnId} does not have getFilterDisplayValuesFromCache method!`);
+        if (typeof columnFilterHandler.getFromCacheOrFetchFilterDisplayValues !== 'function') {
+            this.logWarn(`ColumnFilterHandler for columnId: ${options.columnId} does not have getFromCacheOrFetchFilterDisplayValues method!`);
             return this.getGridApi().internalApi.getDistinctFilterDisplayValuesForColumn(newOptions);
         }
         if (filterOptions.customInFilterValues) {
             return columnFilterHandler.fetchFilterDisplayValues(newOptions);
         }
-        return columnFilterHandler.getFilterDisplayValuesFromCache(newOptions);
+        return columnFilterHandler.getFromCacheOrFetchFilterDisplayValues(newOptions);
     }
     shouldAutoApplyColumnFilter(columnId) {
         const autoApplyColumnFilterOpt = this.getOptionsApi().getFilterOptions().columnFilterOptions?.autoApplyColumnFilter;
@@ -279,6 +279,9 @@ export class ColumnFilterInternalApi extends ApiBase {
         // fallback, should never happen
         return true;
     }
+    getAdaptableFilterHandler(columnId) {
+        return this.getAgGridApi().getColumnFilterHandler(columnId);
+    }
     getAllAdaptableFilterHandlers() {
         const allFilterableColumns = this.getColumnApi().getFilterableColumns();
         const filterHandlers = allFilterableColumns

package/src/View/Components/ColumnFilter/components/FloatingFilterValues.d.ts

@@ -37,7 +37,9 @@ export declare function useDistinctFilterColumnValues(options: {
         skipDefaultSearch: boolean;
         searchValueUsedInFilterValue: boolean;
     }>>;
-    triggerValuesLoad: () => void;
+    triggerValuesLoad: (options?: {
+        usePrevious: boolean;
+    }) => void;
 };
 /**
  * This component was ported and modified to not know about colum  filter and predicates.

package/src/View/Components/ColumnFilter/components/FloatingFilterValues.js

@@ -20,7 +20,10 @@ export function useDistinctFilterColumnValues(options) {
     const { columnId, searchValueRef } = options;
     const { api } = useAdaptable();
     const [valuesLoadTrigger, setValuesLoadTrigger] = React.useState(0);
-    const triggerValuesLoad = React.useCallback(() => {
+    const usePreviousValuesProbablyBecauseOfAGGridUnnecessaryFilterRemountRef = React.useRef(false);
+    const triggerValuesLoad = React.useCallback((options) => {
+        usePreviousValuesProbablyBecauseOfAGGridUnnecessaryFilterRemountRef.current =
+            !!options?.usePrevious;
         setValuesLoadTrigger((prev) => prev + 1);
     }, []);
     const [quickFilterValues, setQuickFilterValues] = React.useState({
@@ -38,15 +41,27 @@ export function useDistinctFilterColumnValues(options) {
         let ignore = false;
         setIsDistinctColumnValuesLoading(true);
         let searchValueUsedInFilterValue = false;
-        api.filterApi.columnFilterApi.internalApi
-            .getColumnFilterValues({
-            columnId,
-            get currentSearchValue() {
-                searchValueUsedInFilterValue = true;
-                return searchValueRef ? searchValueRef.current : '';
-            },
-        })
-            .then((distinctFilterDisplayValues) => {
+        const columnFilterinternalApi = api.filterApi.columnFilterApi.internalApi;
+        let promise = undefined;
+        if (usePreviousValuesProbablyBecauseOfAGGridUnnecessaryFilterRemountRef.current) {
+            const previousResult = columnFilterinternalApi
+                .getAdaptableFilterHandler(columnId)
+                ?.getLastCachedFilterDisplayValues();
+            if (previousResult) {
+                promise = Promise.resolve(previousResult);
+            }
+        }
+        usePreviousValuesProbablyBecauseOfAGGridUnnecessaryFilterRemountRef.current = false;
+        if (!promise) {
+            promise = columnFilterinternalApi.getColumnFilterValues({
+                columnId,
+                get currentSearchValue() {
+                    searchValueUsedInFilterValue = true;
+                    return searchValueRef ? searchValueRef.current : '';
+                },
+            });
+        }
+        promise.then((distinctFilterDisplayValues) => {
             if (ignore) {
                 return;
             }
@@ -91,9 +106,15 @@ export const FloatingFilterValues = (props) => {
         if (!value || !Array.isArray(value) || value.length === 0) {
             return;
         }
+        // see 😅 usePreviousValuesProbablyBecauseOfAGGridUnnecessaryFilterRemountRef 😅
+        const usePrevious = !!api.filterApi.columnFilterApi.internalApi
+            .getAdaptableFilterHandler(props.columnId)
+            ?.getLastCachedFilterDisplayValues();
         // however, if the `value` prop is a non-empty array, we need to load the values
         // so we know which labels to show
-        triggerValuesLoad();
+        triggerValuesLoad({
+            usePrevious,
+        });
     }, []);
     const quickFilterValuesRef = React.useRef(quickFilterValues);
     quickFilterValuesRef.current = quickFilterValues;

package/src/View/Components/FilterForm/ListBoxFilterForm.js

@@ -9,7 +9,7 @@ export const ColumnValuesSelect = (props) => {
     const column = props.column;
     const selectedColumnValues = props.value || [];
     const value = [];
-    const options = props.options.filter((distinctValue, index) => {
+    const options = (Array.isArray(props.options) ? props.options : []).filter((distinctValue) => {
         let isActive = selectedColumnValues.indexOf(distinctValue.value) >= 0;
         // special case for date objects, need to check against string values
         if (!isActive && distinctValue.value && distinctValue.value instanceof Date) {

package/src/agGrid/AdaptableFilterHandler.d.ts

@@ -6,9 +6,12 @@ export declare class AdaptableFilterHandler implements FilterHandler {
     private adaptableApi;
     readonly colId: string;
     private filterDisplayValuesResult;
+    private previousFilterDisplayValuesResult;
     constructor(adaptableApi: AdaptableApi, columnSetup: ColumnSetupInfo);
     doesFilterPass(params: DoesFilterPassParams): boolean;
-    getFilterDisplayValuesFromCache(options: {
+    getCachedFilterDisplayValues(): InFilterValueResult | undefined;
+    getLastCachedFilterDisplayValues(): InFilterValueResult | undefined;
+    getFromCacheOrFetchFilterDisplayValues(options: {
         currentSearchValue: string;
     }): Promise<InFilterValueResult>;
     fetchFilterDisplayValues(options: {

package/src/agGrid/AdaptableFilterHandler.js

@@ -27,7 +27,13 @@ export class AdaptableFilterHandler {
             return false;
         }
     }
-    getFilterDisplayValuesFromCache(options) {
+    getCachedFilterDisplayValues() {
+        return this.filterDisplayValuesResult;
+    }
+    getLastCachedFilterDisplayValues() {
+        return this.filterDisplayValuesResult ?? this.previousFilterDisplayValuesResult;
+    }
+    getFromCacheOrFetchFilterDisplayValues(options) {
         if (this.filterDisplayValuesResult) {
             return Promise.resolve(this.filterDisplayValuesResult);
         }
@@ -61,12 +67,15 @@ export class AdaptableFilterHandler {
         this.resetFilterDisplayValues();
     }
     resetFilterDisplayValues() {
+        if (this.filterDisplayValuesResult) {
+            this.previousFilterDisplayValuesResult = this.filterDisplayValuesResult;
+        }
         // Reset the filter display values manually
         this.filterDisplayValuesResult = undefined;
     }
     async refreshFilterDisplayValues() {
         this.resetFilterDisplayValues();
-        return this.getFilterDisplayValuesFromCache({ currentSearchValue: '' });
+        return this.getFromCacheOrFetchFilterDisplayValues({ currentSearchValue: '' });
     }
     refresh(params) {
         // No specific refresh logic needed for this handler
@@ -74,5 +83,6 @@ export class AdaptableFilterHandler {
     }
     destroy() {
         this.filterDisplayValuesResult = undefined;
+        this.previousFilterDisplayValuesResult = undefined;
     }
 }

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: 1756992459408 || Date.now(),
-    VERSION: "21.0.0-canary.2" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1757076026384 || Date.now(),
+    VERSION: "21.0.0-canary.3" || '--current-version--',
 };