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

package/package.json

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

@@ -26,7 +26,7 @@ export interface FilterOptions<TData = any> {
      */
     clearFiltersOnStartUp?: boolean;
     /**
-     * Provide custom values (or sorting / count info) when using the `In` Filter
+     * Provide custom values (or sorting / count info) when using `In` Predicate in Column or Grid Filter
      * @param context
      * @returns
      */
@@ -208,17 +208,16 @@ export interface InFilterValue<ValueType = any> {
 /**
  * Result when providing custom values for the IN Column Filter
  */
-export type InFilterValueResult = {
+export interface 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.
+     * If true, AdapTable will not filter the list using the current search value
      */
     skipDefaultSearch?: boolean;
-};
+}
 /**
  * Information about items in the IN Column Filter
  */
@@ -249,11 +248,11 @@ export interface CustomInFilterValuesContext<TData = any> extends AdaptableColum
      */
     defaultValues: Required<InFilterValueInfo>[];
     /**
-     * Default values but Sorted based on Column's sort
+     * Default values but sorted (if Column is sorted)
      */
     sortedValues: Required<InFilterValueInfo>[];
     /**
-     * Default values but in the order in which they are currently listed in the grid - (after all the sorting has been applied, or, if no sorting, in their natural order)
+     * Default values in order which currently listed in the grid
      */
     orderedValues: Required<InFilterValueInfo>[];
     /**
@@ -261,8 +260,7 @@ export interface CustomInFilterValuesContext<TData = any> extends AdaptableColum
      */
     currentSearchValue: string;
     /**
-     * Memoized result from previous invocation. Helps avoid expensive recomputations,
-     * especially for async operations (e.g. server-side filtering).
+     * Previous filter result; avoids expensive recomputations (e.g for async op or server-side filtering)
      */
     previousFilterResult?: InFilterValueResult;
 }

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/components/Modal/index.d.ts

@@ -5,7 +5,6 @@ export declare const ensureLoadingScreenPortalElement: () => HTMLElement;
 export interface ModalProps extends FlexProps {
     isOpen?: boolean;
     baseZIndex?: number;
-    backdropZIndexOffset?: number;
     onBringToFront?: () => void;
 }
 export declare const Modal: React.FunctionComponent<React.PropsWithChildren<ModalProps>>;

package/src/components/Modal/index.js

@@ -7,6 +7,7 @@ import { Flex } from 'rebass';
 import { baseClassName, default as Backdrop } from './Backdrop';
 import { createUuid } from '../utils/uuid';
 import { isBrowserDocumentAvailable } from '../../View/UIHelper';
+import { useStacking } from '../WindowModal/useStacking';
 let portalElement;
 let loadingScreenPortalElement;
 export const ensurePortalElement = () => {
@@ -38,8 +39,9 @@ export const Modal = (props) => {
     const uuid = useMemo(() => createUuid(), []);
     const counter = useMemo(() => globalCounter++, [isOpen]);
     const openTimestamp = counter;
-    const backdropZIndexOffset = props.backdropZIndexOffset || 1;
-    const zIndex = (props.baseZIndex || 2000) + counter;
+    const backdropZIndexOffset = 1;
+    const stacking = useStacking();
+    const zIndex = stacking.zIndex;
     return createPortal(isOpen ? (React.createElement(React.Fragment, null,
         React.createElement(Backdrop, { timestamp: openTimestamp, uuid: uuid, zIndex: zIndex - backdropZIndexOffset, onBringToFront: onBringToFront }),
         React.createElement(RemoveScroll, null,

package/src/components/OverlayTrigger/index.js

@@ -13,6 +13,7 @@ import contains from '../utils/contains';
 import { isBrowserDocumentAvailable } from '../../View/UIHelper';
 import { useOverlay } from '../InfiniteTable';
 import { useAdaptable } from '../../View/AdaptableContext';
+import { OVERLAY_BASE_Z_INDEX } from '../overlayBaseZIndex';
 export const getConstrainElement = (target, constrainTo) => {
     let el = null;
     if (typeof constrainTo === 'string') {
@@ -31,6 +32,7 @@ export const getConstrainRect = (target, constrainTo) => {
     return getDocRect();
 };
 let portalElement;
+const OVERLAY_TRIGGER_Z_INDEX = OVERLAY_BASE_Z_INDEX;
 const ensurePortalElement = () => {
     if (!isBrowserDocumentAvailable()) {
         return;
@@ -40,7 +42,7 @@ const ensurePortalElement = () => {
     }
     portalElement = document.createElement('div');
     portalElement.style.position = 'absolute';
-    portalElement.style.zIndex = '9999999';
+    portalElement.style.zIndex = OVERLAY_TRIGGER_Z_INDEX.toString();
     portalElement.style.top = '0px';
     portalElement.style.left = '0px';
     document.body.appendChild(portalElement);

package/src/components/Select/Select.js

@@ -9,6 +9,7 @@ import { useCallback, useMemo, useState } from 'react';
 import join from '../utils/join';
 import { Resizable } from 're-resizable';
 import Tooltip from '../Tooltip';
+import { OVERLAY_BASE_Z_INDEX } from '../overlayBaseZIndex';
 const resizableDirections = {
     right: true,
     bottom: true,
@@ -533,7 +534,7 @@ export const Select = function (props) {
             menuPortal: (baseStyle) => {
                 return {
                     ...baseStyle,
-                    zIndex: 999999,
+                    zIndex: OVERLAY_BASE_Z_INDEX,
                     textAlign: 'left',
                 };
             },
@@ -541,7 +542,7 @@ export const Select = function (props) {
             menu: (baseStyle, state) => {
                 return {
                     ...baseStyle,
-                    zIndex: 999999,
+                    zIndex: OVERLAY_BASE_Z_INDEX,
                     boxShadow: 'var(--ab-cmp-select-menu__box-shadow)',
                     minWidth: `var(--ab-cmp-select-menu__min-width)`,
                     width: resizable ? '100%' : `${Math.max(maxLabelLength, 10)}ch`,

package/src/components/WindowModal/useStacking.js

@@ -4,6 +4,15 @@ const setZIndexMap = {};
 const zIndexMap = [];
 // starts with 3000, to be above the default zIndex of the Modal component
 const BASE_Z_INDEX = 3000;
+const Z_INDEX_GAP = 5;
+let GLOBAL_COUNTER = 0;
+const getNewOffset = () => {
+    const counter = GLOBAL_COUNTER++;
+    return counter * Z_INDEX_GAP;
+};
+const getNewZIndex = () => {
+    return BASE_Z_INDEX + getNewOffset();
+};
 /**
  * Used to facilitate the stacking between multiple opened windows.
  * When calling 'bringToFront' brings caller to top.
@@ -11,7 +20,7 @@ const BASE_Z_INDEX = 3000;
  */
 export const useStacking = () => {
     const modalZIndexId = React.useMemo(() => createUuid(), []);
-    const [zIndex, setZIndex] = React.useState(BASE_Z_INDEX);
+    const [zIndex, setZIndex] = React.useState(getNewZIndex);
     React.useEffect(() => {
         setZIndexMap[modalZIndexId] = setZIndex;
         return () => {
@@ -30,8 +39,8 @@ export const useStacking = () => {
         else {
             zIndexMap.push(modalZIndexId);
         }
-        zIndexMap.forEach((id, index) => {
-            setZIndexMap?.[id]?.(BASE_Z_INDEX + index * 10);
+        zIndexMap.forEach((id) => {
+            setZIndexMap?.[id]?.(getNewZIndex());
         });
     }, []);
     return {

package/src/components/overlayBaseZIndex.d.ts

@@ -0,0 +1 @@
+export declare const OVERLAY_BASE_Z_INDEX = 9999999;

package/src/components/overlayBaseZIndex.js

@@ -0,0 +1 @@
+export const OVERLAY_BASE_Z_INDEX = 9999999;

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: 1757087858380 || Date.now(),
+    VERSION: "21.0.0-canary.4" || '--current-version--',
 };

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

@@ -2464,11 +2464,19 @@ export declare const ADAPTABLE_METAMODEL: {
         name: string;
         kind: string;
         desc: string;
-        props: {
+        props: ({
             name: string;
             kind: string;
             desc: string;
-        }[];
+            isOpt?: undefined;
+            ref?: undefined;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+            ref: string;
+        })[];
     };
     CustomQueryVariableContext: {
         name: string;
@@ -4086,6 +4094,22 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt: boolean;
         }[];
     };
+    InFilterValueResult: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: ({
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        } | {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt?: undefined;
+        })[];
+    };
     InitialState: {
         name: string;
         kind: string;