@adaptabletools/adaptable 20.3.0-canary.0 → 20.3.0-canary.2

package/package.json

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

@@ -153,6 +153,7 @@ const DefaultAdaptableOptions = {
             defaultNumericColumnFilter: 'Equals',
             defaultTextColumnFilter: 'Contains',
             defaultDateColumnFilter: 'On',
+            defaultArrayColumnFilter: 'In',
             hideQuickFilterDropdown: undefined,
             hideQuickFilterInput: undefined,
             quickFilterDebounce: 250,

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -106,6 +106,13 @@ export interface ColumnFilterOptions<TData = any> {
      * @gridInfoItem
      */
     defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext: AdaptableColumnContext<TData>) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>);
+    /**
+     * Default filter type for array Columns ('textArray', 'numberArray', etc.)
+     *
+     * @defaultValue In
+     * @gridInfoItem
+     */
+    defaultArrayColumnFilter?: StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext: AdaptableColumnContext<TData>) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>);
     /**
      * Hides Dropdown in Quick Filter Bar for a given Column
      *

package/src/AdaptableState/Common/AdaptableColumn.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableObject } from './AdaptableObject';
-import { BaseCellDataType } from 'ag-grid-enterprise';
+import { BaseCellDataType, ColDef } from 'ag-grid-enterprise';
 /**
  * Defines data type of a Column; can be an AG Grid BaseCellDataType or an AdapTable array-related one
  */
@@ -9,6 +9,7 @@ export type AdaptableColumnDataType = BaseCellDataType | 'textArray' | 'numberAr
  */
 export type AdaptableColumnType = 'hiddenColumn' | 'calculatedColumn' | 'freeTextColumn' | 'actionColumn' | 'fdc3Column' | 'pivotAnyTotal' | 'pivotGrandTotal' | 'pivotColumnTotal' | 'pivotAggregationTotal';
 export declare const HIDDEN_COLUMN_TYPE: AdaptableColumnType;
+export declare const hiddenColDefConfig: ColDef;
 export declare const CALCULATED_COLUMN_TYPE: AdaptableColumnType;
 export declare const FREE_TEXT_COLUMN_TYPE: AdaptableColumnType;
 export declare const ACTION_COLUMN_TYPE: AdaptableColumnType;

package/src/AdaptableState/Common/AdaptableColumn.js

@@ -1,5 +1,11 @@
 import { PIVOT_AGGREGATION_TOTAL_COL_TYPE, PIVOT_ANY_TOTAL_COL_TYPE, PIVOT_COLUMN_TOTAL_COL_TYPE, PIVOT_GRAND_TOTAL_COL_TYPE, } from '../../layout-manager/src';
 export const HIDDEN_COLUMN_TYPE = 'hiddenColumn';
+export const hiddenColDefConfig = {
+    initialHide: true,
+    hide: true,
+    lockVisible: true,
+    suppressColumnsToolPanel: true,
+};
 export const CALCULATED_COLUMN_TYPE = 'calculatedColumn';
 export const FREE_TEXT_COLUMN_TYPE = 'freeTextColumn';
 export const ACTION_COLUMN_TYPE = 'actionColumn';

package/src/AdaptableState/Common/AdaptableObject.d.ts

@@ -9,11 +9,11 @@ export type AdaptableVersion = `${string}.${string}.${string}`;
  */
 export interface AdaptableObject {
     /**
-     * Unique identifier for the Adaptable Object, generated and used internally by AdapTable
+     * Unique identifier for the Object, generated and used internally by AdapTable
      */
     Uuid?: TypeUuid;
     /**
-     * Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state.
+     * Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state
      */
     Source?: 'InitialState' | 'User';
     /**
@@ -25,7 +25,7 @@ export interface AdaptableObject {
      */
     IsReadOnly?: boolean;
     /**
-     * List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope
+     * List of Tags associated with the Object; often used for extending Layouts
      */
     Tags?: AdaptableObjectTag[];
     /**

package/src/AdaptableState/Common/AdaptablePredicate.js

@@ -95,7 +95,7 @@ export const SystemPredicateDefs = [
         id: 'NotIn',
         label: 'Not In',
         icon: { text: '!IN' },
-        columnScope: { DataTypes: ['text', 'number', 'date'] },
+        columnScope: { DataTypes: ['text', 'number', 'date', 'textArray', 'numberArray'] },
         moduleScope: ['columnFilter', 'flashingcell', 'formatColumn', 'alert', 'badgeStyle'],
         handler: (context) => {
             const { inputs, column, value, adaptableApi } = context;
@@ -139,6 +139,12 @@ export const SystemPredicateDefs = [
             if (column.dataType === 'number') {
                 return !inputs.includes(value);
             }
+            if (column.dataType === 'numberArray') {
+                const arrayValue = Array.isArray(value) ? value : [value];
+                return inputs.every((input) => {
+                    return !arrayValue.includes(input);
+                });
+            }
             if (column.dataType === 'text') {
                 return adaptableApi.predicateApi.useCaseSensitivity()
                     ? !inputs
@@ -148,6 +154,14 @@ export const SystemPredicateDefs = [
                         .includes(value?.toLocaleLowerCase())
                     : !inputs.includes(value);
             }
+            if (column.dataType === 'textArray') {
+                const arrayValue = Array.isArray(value) ? value : [value];
+                return inputs.every((input) => {
+                    return adaptableApi.predicateApi.useCaseSensitivity()
+                        ? !arrayValue.map((v) => v?.toLocaleLowerCase()).includes(input?.toLocaleLowerCase())
+                        : !arrayValue.includes(input);
+                });
+            }
             return true;
         },
         toString: ({ inputs }) => `Exclude (${inputs.join(', ')})`,
@@ -158,7 +172,12 @@ export const SystemPredicateDefs = [
         icon: { name: 'unfilled-circle' },
         columnScope: { All: true },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
-        handler: ({ value }) => Helper.isInputNullOrEmpty(value),
+        handler: ({ value, column, adaptableApi }) => {
+            if (adaptableApi.columnApi.internalApi.hasArrayDataType(column)) {
+                return value == undefined || value.length === 0;
+            }
+            return Helper.isInputNullOrEmpty(value);
+        },
     },
     {
         id: 'NonBlanks',
@@ -166,7 +185,12 @@ export const SystemPredicateDefs = [
         icon: { name: 'filled-circle' },
         columnScope: { All: true },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn', 'badgeStyle'],
-        handler: ({ value }) => Helper.isInputNotNullOrEmpty(value),
+        handler: ({ value, column, adaptableApi }) => {
+            if (adaptableApi.columnApi.internalApi.hasArrayDataType(column)) {
+                return value == undefined || value.length === 0;
+            }
+            return Helper.isInputNotNullOrEmpty(value);
+        },
     },
     // Numeric System Filters
     {

package/src/Api/Implementation/ColumnApiImpl.js

@@ -501,6 +501,9 @@ export class ColumnApiImpl extends ApiBase {
         return this.getAgGridApi().getColumn(columnId);
     }
     hasColumnType(columnIdentifier, columnType) {
+        if (!columnIdentifier) {
+            return false;
+        }
         const colDef = typeof columnIdentifier === 'string'
             ? this.getAgGridApi().getColumnDef(columnIdentifier)
             : columnIdentifier;

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

@@ -1,5 +1,5 @@
 import { ApiBase } from '../Implementation/ApiBase';
-import { Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
+import { ColDef, Column, HeaderValueGetterParams, IRowNode } from 'ag-grid-enterprise';
 import { CustomSort } from '../../AdaptableState/CustomSortState';
 import { ColumnValuesComparer } from '../../AdaptableOptions/CustomSortOptions';
 import { AdaptableColumn } from '../../types';
@@ -33,6 +33,7 @@ export declare class ColumnInternalApi extends ApiBase {
     isSpecialColumn(columnId: string, column?: AdaptableColumn): boolean;
     getColumnHeaderName(params: HeaderValueGetterParams): string;
     private buildColumnHeaderContext;
-    getQueryableColumnsForUIEditor(): AdaptableColumn[];
     hasArrayDataType(column: AdaptableColumn): boolean;
+    getQueryableColumnsForUIEditor(): AdaptableColumn[];
+    isAlwaysHiddenColumn(columnIdentifier: string | ColDef): boolean;
 }

package/src/Api/Internal/ColumnInternalApi.js

@@ -6,6 +6,7 @@ import { isPivotGrandTotal, isPivotResultColumn } from '../Implementation/Column
 import { destructurePivotColumnId } from '../../layout-manager/src/destructurePivotColumnId';
 import { isPivotColumnTotal } from '../../layout-manager/src/isPivotColumnTotal';
 import { isPivotAggTotalColumn } from '../../layout-manager/src/isPivotAggTotalColumn';
+import { HIDDEN_COLUMN_TYPE } from '../../AdaptableState/Common/AdaptableColumn';
 export function getAutoRowGroupColumnIdFor(columnId) {
     return `${AG_GRID_GROUPED_COLUMN}-${columnId}`;
 }
@@ -282,12 +283,15 @@ export class ColumnInternalApi extends ApiBase {
         // if nothing matched, we skip this column[group]
         return 'skip';
     }
+    hasArrayDataType(column) {
+        return ['textArray', 'numberArray', 'tupleArray', 'objectArray'].includes(column.dataType);
+    }
     getQueryableColumnsForUIEditor() {
         return this.getColumnApi()
             .getQueryableColumns()
             .filter((column) => !column.isGeneratedPivotResultColumn && !column.isGeneratedRowGroupColumn);
     }
-    hasArrayDataType(column) {
-        return ['textArray', 'numberArray', 'tupleArray', 'objectArray'].includes(column.dataType);
+    isAlwaysHiddenColumn(columnIdentifier) {
+        return this.getColumnApi().hasColumnType(columnIdentifier, HIDDEN_COLUMN_TYPE);
     }
 }

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

@@ -169,12 +169,16 @@ export declare const getColumnFilterSelector: (state: AdaptableState, columnId:
     PredicatesOperator?: import("../../types").PredicatesOperator;
     IsSuspended?: boolean;
     Uuid?: string;
+    /**
+     * @ReduxAction Layout Module is ready
+     */
     Source?: "InitialState" | "User";
+    /**
+     * @ReduxAction A Layout has been edited
+     */
     AdaptableVersion?: `${string}.${string}.${string}`;
     IsReadOnly?: boolean;
     Tags?: string[];
-    Metadata?: any; /**
-     * @ReduxAction A Column Filter has been edited
-     */
+    Metadata?: any;
 };
 export declare const LayoutReducer: Redux.Reducer<LayoutState>;

package/src/Utilities/Services/ModuleService.js

@@ -103,7 +103,7 @@ export class ModuleService {
             case 'ColumnFilter':
                 return learnUrl + 'handbook-column-filter';
             case 'ColumnInfo':
-                return learnUrl + 'dev-guide-tutorial-grid-column-info';
+                return learnUrl + 'dev-guide-column-grid-column-info';
             case 'Comment':
                 return learnUrl + 'handbook-comments';
             case 'CustomSort':
@@ -129,7 +129,7 @@ export class ModuleService {
             case 'GridFilter':
                 return learnUrl + 'handbook-grid-filter';
             case 'GridInfo':
-                return learnUrl + 'dev-guide-tutorial-grid-column-info';
+                return learnUrl + 'dev-guide-column-grid-column-info';
             case 'Layout':
                 return learnUrl + 'handbook-layouts';
             case 'NamedQuery':

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

@@ -152,6 +152,26 @@ export const mapColumnFilterToQlPredicate = (columnFilter, abColumn, qlPredicate
             case 'boolean':
                 defaultQlPredicate = { operator: 'BooleanToggle', args: [] };
                 break;
+            case 'textArray':
+            case 'numberArray':
+                let defaultQlArrayPredicate;
+                const defaultArrayColumnFilter = columnFilterOptions.defaultArrayColumnFilter;
+                if (defaultArrayColumnFilter) {
+                    if (typeof defaultArrayColumnFilter === 'function') {
+                        const context = {
+                            column: abColumn,
+                            ...api.internalApi.buildBaseContext(),
+                        };
+                        defaultQlArrayPredicate = defaultArrayColumnFilter(context);
+                    }
+                    else {
+                        defaultQlArrayPredicate = defaultArrayColumnFilter;
+                    }
+                }
+                defaultQlPredicate = defaultQlArrayPredicate
+                    ? { operator: defaultQlArrayPredicate, args: [] }
+                    : { operator: 'In', args: [] };
+                break;
         }
         if (defaultQlPredicate === null) {
             // take the firstavailable one

package/src/View/Layout/Wizard/sections/ColumnsSection.js

@@ -355,7 +355,8 @@ export const ColumnsSection = (props) => {
     };
     const visibleIds = layout.TableColumns.filter((colId) => {
         return (layout.ColumnVisibility?.[colId] !== false &&
-            adaptable.api.columnApi.isSelectionColumn(colId) === false);
+            adaptable.api.columnApi.isSelectionColumn(colId) === false &&
+            !adaptable.api.columnApi.internalApi.isAlwaysHiddenColumn(colId));
     });
     const toLabel = (colId) => adaptable.api.columnApi.getFriendlyNameForColumnId(colId, layout);
     const toIdentifier = (colId) => colId;

package/src/agGrid/AdaptableAgGrid.js

@@ -93,7 +93,7 @@ import { AgGridExportAdapter } from './AgGridExportAdapter';
 import { checkForDuplicateColumns, getLayoutRowGroupValuesExceptionGroupKeys, isPivotLayout, layoutModelToLayoutState, layoutStateToLayoutModel, normalizeLayout, } from '../Api/Implementation/LayoutHelpers';
 import { LayoutManager } from '../layout-manager/src';
 import { isPivotLayoutModel } from '../layout-manager/src/isPivotLayoutModel';
-import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE, PIVOT_ANY_TOTAL_COLUMN_TYPE, PIVOT_COLUMN_TOTAL_COLUMN_TYPE, PIVOT_GRAND_TOTAL_COLUMN_TYPE, } from '../AdaptableState/Common/AdaptableColumn';
+import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, HIDDEN_COLUMN_TYPE, hiddenColDefConfig, PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE, PIVOT_ANY_TOTAL_COLUMN_TYPE, PIVOT_COLUMN_TOTAL_COLUMN_TYPE, PIVOT_GRAND_TOTAL_COLUMN_TYPE, } from '../AdaptableState/Common/AdaptableColumn';
 import { agGridDataTypeDefinitions } from './agGridDataTypeDefinitions';
 import { AgGridThemeAdapter } from './AgGridThemeAdapter';
 import { mapOldTypeToDataType } from '../migration/VersionUpgrade20';
@@ -1090,6 +1090,7 @@ You need to define at least one Layout!`);
         this.agGridOptionsService.setGridOptionsProperty(gridOptions, 'columnTypes', (original_columnTypes) => {
             const providedColumnTypes = original_columnTypes || {};
             const adaptableSpecialColumnTypes = {
+                [HIDDEN_COLUMN_TYPE]: hiddenColDefConfig,
                 [CALCULATED_COLUMN_TYPE]: {},
                 [FREE_TEXT_COLUMN_TYPE]: {},
                 [ACTION_COLUMN_TYPE]: {},

package/src/agGrid/AgGridAdapter.js

@@ -1,5 +1,5 @@
 import { ColumnApiModule, } from 'ag-grid-enterprise';
-import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, HIDDEN_COLUMN_TYPE, } from '../AdaptableState/Common/AdaptableColumn';
+import { ACTION_COLUMN_TYPE, CALCULATED_COLUMN_TYPE, FDC3_COLUMN_TYPE, FREE_TEXT_COLUMN_TYPE, } from '../AdaptableState/Common/AdaptableColumn';
 import { ADAPTABLE_FDC3_ACTION_COLUMN_FRIENDLY_NAME } from '../Utilities/Constants/GeneralConstants';
 import { createUuid } from '../AdaptableState/Uuid';
 import ArrayExtensions from '../Utilities/Extensions/ArrayExtensions';
@@ -459,7 +459,7 @@ export class AgGridAdapter {
             ? 'number'
             : this.deriveAdaptableColumnDataType(agGridColumn, false);
         const isTreeColumn = this.isTreeColumn(isGeneratedRowGroupColumn);
-        const alwaysHidden = this.adaptableApi.columnApi.hasColumnType(colDef, HIDDEN_COLUMN_TYPE);
+        const alwaysHidden = this.adaptableApi.columnApi.internalApi.isAlwaysHiddenColumn(colDef);
         const visible = !alwaysHidden || agGridColumn.isVisible();
         const isGenerated = isGeneratedRowGroupColumn || isGeneratedPivotResultColumn || isGeneratedSelectionColumn;
         const abColumn = {

package/src/agGrid/AgGridColumnAdapter.js

@@ -328,8 +328,10 @@ export class AgGridColumnAdapter {
     setupColumnHeaderStyle({ col }) {
         this.setColDefProperty(col, 'headerStyle', (userHeaderStyle) => {
             const headerStyleFunc = (params) => {
+                let baseStyles = {};
                 // inherit styles from user provided colDef property
-                const baseStyles = typeof userHeaderStyle === 'function' ? userHeaderStyle(params) : userHeaderStyle;
+                baseStyles =
+                    typeof userHeaderStyle === 'function' ? userHeaderStyle(params) : userHeaderStyle;
                 if (params.floatingFilter) {
                     // we NEVER style floating filters
                     return baseStyles;

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: 1752676413621 || Date.now(),
-    VERSION: "20.3.0-canary.0" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1752841742262 || Date.now(),
+    VERSION: "20.3.0-canary.2" || '--current-version--',
 };