@adaptabletools/adaptable 20.0.0-canary.21 → 20.0.0-canary.23

package/package.json

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

package/src/AdaptableInterfaces/AdaptableNoCodeWizard.d.ts

@@ -42,7 +42,7 @@ export interface AdaptableNoCodeWizardOptions {
  * const adaptableOptions: AdaptableOptions = {
  *
  *  userName: 'Demo User',
- *  predefinedConfig: demoConfig,
+ *  initialState: demoConfig,
  *
  *  // note we don't need any agGrid info, since that's set by the wizard, when
  *  // the user configured the columns

package/src/AdaptableInterfaces/IAdaptable.d.ts

@@ -1,13 +1,13 @@
 /// <reference types="react" />
 import { ChartModel, ChartRef, Column, GridApi, GridOptions, IRowNode, Module, RowModelType, StatusPanelDef } from 'ag-grid-enterprise';
 import { AdaptableApi, DestroyConfig } from '../Api/AdaptableApi';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { ColumnSort } from '../PredefinedConfig/Common/ColumnSort';
-import { DataUpdateConfig } from '../PredefinedConfig/Common/DataUpdateConfig';
-import { Layout } from '../PredefinedConfig/LayoutState';
-import { GridCell } from '../PredefinedConfig/Selection/GridCell';
-import { SelectedCellInfo } from '../PredefinedConfig/Selection/SelectedCellInfo';
-import { AdaptableTheme } from '../PredefinedConfig/ThemeState';
+import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
+import { ColumnSort } from '../AdaptableState/Common/ColumnSort';
+import { DataUpdateConfig } from '../AdaptableState/Common/DataUpdateConfig';
+import { Layout } from '../AdaptableState/LayoutState';
+import { GridCell } from '../AdaptableState/Selection/GridCell';
+import { SelectedCellInfo } from '../AdaptableState/Selection/SelectedCellInfo';
+import { AdaptableTheme } from '../AdaptableState/ThemeState';
 import { IAdaptableStore } from '../Redux/Store/Interface/IAdaptableStore';
 import { IModuleCollection } from '../Strategy/Interface/IModule';
 import { AdaptableMenuItem, AdaptableOptions, AdaptablePlugin, AdaptableState, ChartDefinition, SelectedRowInfo } from '../types';
@@ -16,7 +16,7 @@ import { IDataService } from '../Utilities/Services/Interface/IDataService';
 import { AnnotationsService } from '../Utilities/Services/AnnotationsService';
 import { IValidationService } from '../Utilities/Services/Interface/IValidationService';
 import { IModuleService } from '../Utilities/Services/Interface/IModuleService';
-import { ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { ContextMenuContext } from '../AdaptableState/Common/Menu';
 import { IQueryLanguageService } from '../Utilities/Services/Interface/IQueryLanguageService';
 import { IAlertService } from '../Utilities/Services/Interface/IAlertService';
 import { ITeamSharingService } from '../Utilities/Services/Interface/ITeamSharingService';

package/src/AdaptableOptions/ActionColumnOptions.d.ts

@@ -1,5 +1,5 @@
 import { IRowNode } from 'ag-grid-enterprise';
-import { RowScope } from '../PredefinedConfig/Common/RowScope';
+import { RowScope } from '../AdaptableState/Common/RowScope';
 import { AdaptableButton, AdaptableObject, BaseContext } from '../types';
 /**
  * Options related to Action Columns in AdapTable

package/src/AdaptableOptions/AdaptableOptions.d.ts

@@ -1,6 +1,6 @@
 import { ContainerOptions } from './ContainerOptions';
 import { LayoutOptions } from './LayoutOptions';
-import { PredefinedConfig } from '../PredefinedConfig/PredefinedConfig';
+import { InitialState } from '../AdaptableState/InitialState';
 import { EditOptions } from './EditOptions';
 import { StateOptions } from './StateOptions';
 import { UserInterfaceOptions } from './UserInterfaceOptions';
@@ -69,11 +69,11 @@ export interface AdaptableOptions<TData = any, TContext = Record<string, any>> {
      */
     adaptableContext?: TContext;
     /**
-     * User State set at design-time and shipped with AdapTable for first use; must include at least one Layout
+     * Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout
      *
      * @defaultValue undefined
      */
-    predefinedConfig: PredefinedConfig;
+    initialState: InitialState;
     /**
      * Name of Column in AdapTable guaranteed to contain unique values
      *

package/src/AdaptableOptions/AdaptablePlugin.d.ts

@@ -3,12 +3,12 @@ import { AdaptableOptions } from './AdaptableOptions';
 import { AgGridConfig, IAdaptable } from '../AdaptableInterfaces/IAdaptable';
 import { IAdaptableStore } from '../Redux/Store/Interface/IAdaptableStore';
 import { AdaptableApi } from '../types';
-import { AdaptableState } from '../PredefinedConfig/AdaptableState';
-import { AdaptableModule } from '../PredefinedConfig/Common/Types';
+import { AdaptableState } from '../AdaptableState/AdaptableState';
+import { AdaptableModule } from '../AdaptableState/Common/Types';
 import { IModule } from '../Strategy/Interface/IModule';
-import { ColumnSetupInfo } from '../PredefinedConfig/Common/ColumnSetupInfo';
+import { ColumnSetupInfo } from '../AdaptableState/Common/ColumnSetupInfo';
 import { ColDef } from 'ag-grid-enterprise';
-import { Layout } from '../PredefinedConfig/LayoutState';
+import { Layout } from '../AdaptableState/LayoutState';
 type AdaptableReducerObject = {
     [key: string]: (...args: any[]) => any;
 };

package/src/AdaptableOptions/AlertOptions.d.ts

@@ -1,7 +1,7 @@
 import { FormContext, RowDataChangedInfo } from '../../types';
-import { AlertButton, AlertDefinition } from '../PredefinedConfig/AlertState';
-import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
-import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
+import { AlertButton, AlertDefinition } from '../AdaptableState/AlertState';
+import { AdaptableAlert } from '../AdaptableState/Common/AdaptableAlert';
+import { AdaptableForm } from '../AdaptableState/Common/AdaptableForm';
 import { CellDataChangedInfo } from '../types';
 /**
  * Options related to Alerts in Adaptable.

package/src/AdaptableOptions/CellSummaryOptions.d.ts

@@ -1,4 +1,4 @@
-import { CustomCellSummaryOperation } from '../PredefinedConfig/Common/CellSummary';
+import { CustomCellSummaryOperation } from '../AdaptableState/Common/CellSummary';
 import { AdaptableColumnContext, NumberFormatterOptions } from '../types';
 /**
  * Options to provide custom Cell Summary Operations & Display Formats

package/src/AdaptableOptions/ChartingOptions.d.ts

@@ -1,4 +1,4 @@
-import { ExternalChartDefinition } from '../PredefinedConfig/ChartingState';
+import { ExternalChartDefinition } from '../AdaptableState/ChartingState';
 import { BaseContext } from '../types';
 /**
  * Options for managing AG Grid's Charts

package/src/AdaptableOptions/ColumnMenuOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableColumnMenuItemName, AdaptableMenuItem, AgGridMenuItem, ColumnMenuContext, MenuSeparator } from '../PredefinedConfig/Common/Menu';
+import { AdaptableColumnMenuItemName, AdaptableMenuItem, AgGridMenuItem, ColumnMenuContext, MenuSeparator } from '../AdaptableState/Common/Menu';
 import { AdaptableIcon } from '../types';
 /**
  * Options for managing menus in AdapTable – provided using 2 collections

package/src/AdaptableOptions/ContextMenuOptions.d.ts

@@ -1,5 +1,5 @@
 import { MenuSeparator } from '@infinite-table/infinite-react';
-import { AdaptableContextMenuItemName, AdaptableMenuItem, AgGridMenuItem, ContextMenuContext } from '../PredefinedConfig/Common/Menu';
+import { AdaptableContextMenuItemName, AdaptableMenuItem, AgGridMenuItem, ContextMenuContext } from '../AdaptableState/Common/Menu';
 import { AdaptableIcon } from '../types';
 /**
  * Options for managing menus in AdapTable – provided using 2 collections

package/src/AdaptableOptions/CustomSortOptions.d.ts

@@ -1,5 +1,5 @@
 import { ColumnScope } from '../../types';
-import { AdaptableComparerFunction } from '../PredefinedConfig/Common/AdaptableComparerFunction';
+import { AdaptableComparerFunction } from '../AdaptableState/Common/AdaptableComparerFunction';
 /**
  * Used to provide Custom Sorts comparers
  */

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -1,6 +1,6 @@
-import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
-import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
-import { DashboardState } from '../PredefinedConfig/DashboardState';
+import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
+import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
+import { DashboardState } from '../AdaptableState/DashboardState';
 import { BaseContext, CustomRenderContext } from '../types';
 import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
 /**

package/src/AdaptableOptions/DataChangeHistoryOptions.d.ts

@@ -1,4 +1,4 @@
-import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
+import { CellDataChangedInfo } from '../AdaptableState/Common/CellDataChangedInfo';
 import { ActionColumnContext, AdaptableApi, AdaptableButton } from '../types';
 /**
  * Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes

package/src/AdaptableOptions/DataSetOptions.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableForm, AdaptableObject } from '../../types';
-import { FormContext } from '../PredefinedConfig/Common/FormContext';
+import { FormContext } from '../AdaptableState/Common/FormContext';
 /**
  * Options to provide Data Sets
  */

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -1,16 +1,16 @@
 import * as GeneralConstants from '../Utilities/Constants/GeneralConstants';
 import UIHelper, { getHexForName, GRAY, GREEN, RED } from '../View/UIHelper';
 import { EMPTY_STRING, EMPTY_ARRAY, DEFAULT_DATE_FORMAT_PATTERN_WITH_TIME, SYSTEM_REPORT_NAMES, SYSTEM_REPORT_FORMATS, SYSTEM_EXPORT_DESTINATIONS, } from '../Utilities/Constants/GeneralConstants';
-import { SystemAlertPredicateIds, SystemBadgeStylePredicateIds, SystemFilterPredicateIds, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateIds, } from '../PredefinedConfig/Common/AdaptablePredicate';
+import { SystemAlertPredicateIds, SystemBadgeStylePredicateIds, SystemFilterPredicateIds, SystemFlashingCellPredicateIds, SystemFormatColumnPredicateIds, } from '../AdaptableState/Common/AdaptablePredicate';
 import * as ModuleConstants from '../Utilities/Constants/ModuleConstants';
-import { initPredefinedConfigWithUuids } from '../Utilities/Helpers/AdaptableHelper';
+import { addUuidsToInitialState } from '../Utilities/Helpers/AdaptableHelper';
 const DefaultAdaptableOptions = {
     adaptableId: GeneralConstants.ADAPTABLE_ID,
     adaptableStateKey: undefined,
     primaryKey: EMPTY_STRING,
     autogeneratePrimaryKey: false,
     userName: 'anonymous',
-    predefinedConfig: undefined,
+    initialState: undefined,
     adaptableContext: {},
     actionColumnOptions: {
         actionColumns: undefined,
@@ -94,7 +94,7 @@ const DefaultAdaptableOptions = {
         exportDataFormat: 'rawValue',
         exportDateFormat: undefined,
         customDestinations: undefined,
-        externalReports: undefined,
+        processExport: undefined,
         appendFileTimestamp: false,
         systemReportNames: SYSTEM_REPORT_NAMES,
         systemReportFormats: SYSTEM_REPORT_FORMATS,
@@ -378,8 +378,8 @@ export function applyDefaultAdaptableOptions(adaptableOptions) {
     adaptableOptsWithDefaults.userInterfaceOptions = Object.assign({}, DefaultAdaptableOptions.userInterfaceOptions, adaptableOptions.userInterfaceOptions);
     adaptableOptsWithDefaults.userInterfaceOptions.loadingScreenOptions = Object.assign({}, DefaultAdaptableOptions.userInterfaceOptions.loadingScreenOptions, adaptableOptsWithDefaults.userInterfaceOptions.loadingScreenOptions);
     adaptableOptsWithDefaults.userInterfaceOptions.dateInputOptions = Object.assign({}, DefaultAdaptableOptions.userInterfaceOptions.dateInputOptions, adaptableOptsWithDefaults.userInterfaceOptions.dateInputOptions);
-    const { predefinedConfig } = adaptableOptsWithDefaults;
-    adaptableOptsWithDefaults.predefinedConfig = initPredefinedConfigWithUuids(predefinedConfig);
+    const { initialState } = adaptableOptsWithDefaults;
+    adaptableOptsWithDefaults.initialState = addUuidsToInitialState(initialState);
     return adaptableOptsWithDefaults;
 }
 export const getDefaultAdaptableOptions = () => DefaultAdaptableOptions;

package/src/AdaptableOptions/EditOptions.d.ts

@@ -1,7 +1,7 @@
 import { AdaptableMessageType, BaseContext, AdaptableColumnContext } from '../../types';
-import { CellDataChangedInfo } from '../PredefinedConfig/Common/CellDataChangedInfo';
-import { MathOperation } from '../PredefinedConfig/Common/Enums';
-import { GridCell } from '../PredefinedConfig/Selection/GridCell';
+import { CellDataChangedInfo } from '../AdaptableState/Common/CellDataChangedInfo';
+import { MathOperation } from '../AdaptableState/Common/Enums';
+import { GridCell } from '../AdaptableState/Selection/GridCell';
 /**
  * Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Cell Editabiility
  */

package/src/AdaptableOptions/EntitlementOptions.d.ts

@@ -1,5 +1,5 @@
-import { AdaptableModule } from '../PredefinedConfig/Common/Types';
-import { AccessLevel, Entitlement } from '../PredefinedConfig/Common/Entitlement';
+import { AdaptableModule } from '../AdaptableState/Common/Types';
+import { AccessLevel, Entitlement } from '../AdaptableState/Common/Entitlement';
 import { BaseContext } from '../types';
 /**
  * Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*.

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -1,8 +1,8 @@
-import { AdaptableForm } from '../PredefinedConfig/Common/AdaptableForm';
-import { FormContext } from '../PredefinedConfig/Common/FormContext';
-import { Report, ReportColumn, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../PredefinedConfig/ExportState';
+import { AdaptableForm } from '../AdaptableState/Common/AdaptableForm';
+import { FormContext } from '../AdaptableState/Common/FormContext';
+import { Report, ReportColumn, ReportData, ReportFormatType, ReportNameType, SystemReportFormat, SystemReportName } from '../AdaptableState/ExportState';
 import { AdaptableColumn, BaseContext, AdaptableColumnContext } from '../types';
-import { TypeHint } from '../PredefinedConfig/Common/Types';
+import { TypeHint } from '../AdaptableState/Common/Types';
 import { CsvCell, ExcelCell, ExcelDataType, ExcelRow, IRowNode } from 'ag-grid-enterprise';
 /**
  * Options regarding Exporting data from AdapTable
@@ -25,10 +25,6 @@ export interface ExportOptions<TData = any> {
      * User-provided Report Destinations (in addition to those shipped in AdapTable)
      */
     customDestinations?: CustomDestination[];
-    /**
-     * Reports generated entirely by users (and not evaluated AdapTable)
-     */
-    externalReports?: ExternalReport[];
     /**
      * System Reports to use; leave blank for all, empty array for none
      *
@@ -67,10 +63,6 @@ export interface ExportOptions<TData = any> {
      * @defaultValue true
      */
     isColumnExportable?: (context: AdaptableColumnContext) => boolean;
-    /**
-     * Function invoked before a Report is run, enabling users to preload the data before it is exported
-     */
-    preProcessExport?: (preProcessExportContext: PreProcessExportContext) => boolean | Promise<ReportData | boolean>;
     /**
      * Separator for CSV exports
      *
@@ -87,6 +79,15 @@ export interface ExportOptions<TData = any> {
      * Function to provide the Detail Rows when exporting in Master-Detail grids. This function will be invoked for each master row node.
      */
     getDetailRows?: (context: GetDetailRowsContext<TData>) => CsvDetailRow[] | ExcelDetailRow[] | undefined;
+    /**
+     * Provides custom handling of the Export process before the default export is executed.
+     *
+     * @returns A Promise resolving to one of:
+     *   - `true` - Continue with the default export process
+     *   - `false` - Cancel the export process
+     *   - `ExportResultData` - Custom export data (useful for server-side data)
+     */
+    processExport?: (processExportContext: ProcessExportContext) => Promise<ExportResultData | boolean>;
 }
 /**
  * Detail Row Data in a CSV format; technically an array of AG Grid {@link https://www.ag-grid.com/javascript-data-grid/csv-export/#csvcell | CsvCell}s
@@ -129,43 +130,10 @@ export interface GetDetailRowsContext<TData = any> extends BaseExportContext {
      */
     createCellExcel: (cellContent: any, cellType: ExcelDataType) => ExcelCell;
 }
-/**
- * Context provided to `ExportOptions.processExport()` callback used when pre-processing Export
- */
-export interface PreProcessExportContext extends BaseContext {
-    /**
-     * Report being exported
-     */
-    report: Report;
-    /**
-     * Returns Columns to export based on Report's `ReportColumnScope`
-     * @param includePrimaryKey - whether to include the primary key column (defaults to `false`)
-     */
-    getReportColumns: (includePrimaryKey?: boolean) => AdaptableColumn[];
-    /**
-     * Returns row data which would typically be exported based on the Report's `ReportRowScope`
-     * @param reportColumns - the columns to include in the report
-     * @param includePrimaryKey - whether to include the primary key column (defaults to `false`)
-     */
-    getReportRowData: (reportColumns: AdaptableColumn[], includePrimaryKey?: boolean) => Record<string, any>[];
-}
 /**
  * Format of exported Data - 'rawValue' or 'formattedValue'
  */
 export type DataFormatType = 'rawValue' | 'formattedValue';
-/**
- * Defines a Report where all the data is provided entirely by the user
- */
-export interface ExternalReport {
-    /**
-     * Name of the Report
-     */
-    name: string;
-    /**
-     * Function invoked to return the data (in the form of a `ExportResultData` object)
-     */
-    onExport: (context: ExternalReportContext) => Promise<ExportResultData>;
-}
 /**
  * Defines a custom Export destination
  */
@@ -226,7 +194,6 @@ export type SystemExportDestination =
  */
  | 'Clipboard';
 export type ExportDestinationType = TypeHint<string, SystemExportDestination>;
-export type ExportDestination = SystemExportDestination | CustomDestination;
 /**
  * Context information available in all Export-related functions
  */
@@ -235,6 +202,10 @@ export interface BaseExportContext extends BaseContext {
      * Name of the Report being run
      */
     reportName: ReportNameType;
+    /**
+     * The Report Configuration being run
+     */
+    report: Report;
     /**
      * Format of the Report being run
      */
@@ -248,18 +219,23 @@ export interface BaseExportContext extends BaseContext {
  * Report Context sent when using Custom Export Destinations
  */
 export interface ReportContext extends BaseExportContext {
-    /**
-     * Definition of Report being Run
-     */
-    report: Report;
     /**
      * Export Data for the Report
      */
     reportData: ExportResultData;
 }
-export interface ExternalReportContext extends BaseExportContext {
-    getGridReportColumns: () => ReportColumn[];
+export interface ProcessExportContext extends BaseExportContext {
+    /**
+     * Returns Columns to export based on Report's `ReportColumnScope`
+     */
+    getReportColumns: () => ReportColumn[];
+    /**
+     * Converts the Report Data to Excel format
+     */
     convertToExcel: (reportData: ReportData) => Blob;
+    /**
+     * Converts the Report Data to CSV format
+     */
     convertToCsv: (reportData: ReportData) => string;
 }
 /**

package/src/AdaptableOptions/ExpressionOptions.d.ts

@@ -1,7 +1,7 @@
-import { AdaptablePredicate } from '../PredefinedConfig/Common/AdaptablePredicate';
-import { AdaptableModule, AdaptableQLModule } from '../PredefinedConfig/Common/Types';
-import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { AdaptablePredicate } from '../AdaptableState/Common/AdaptablePredicate';
+import { AdaptableModule, AdaptableQLModule } from '../AdaptableState/Common/Types';
+import { BaseContext } from '../AdaptableState/Common/BaseContext';
+import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { AdaptableObject, AggregatedBooleanFunctionName, AggregatedExpressionFunction, AggregatedScalarFunctionName, BooleanFunctionName, ExpressionFunction, ObservableFunctionName, ScalarFunctionName, AdaptableField, AdaptableColumnContext } from '../types';
 /**
  * Options for managing Expressions in AdapTable's Query Language

package/src/AdaptableOptions/Fdc3Options.d.ts

@@ -1,8 +1,8 @@
-import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
+import { BaseContext } from '../AdaptableState/Common/BaseContext';
 import { IRowNode } from 'ag-grid-enterprise';
 import { Action, Chart, ChatInitSettings, ChatMessage, ChatRoom, ChatSearchCriteria, Contact, ContactList, Context, ContextMetadata, ContextType, Country, Currency, Email, Instrument, InstrumentList, Intent, IntentResolution, IntentResult, Interaction, Message, Organization, Portfolio, Position, StandardContextType, StandardIntent, TimeRange, TransactionResult, Valuation } from '@finos/fdc3';
-import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
-import { ButtonStyle } from '../PredefinedConfig/Common/ButtonStyle';
+import { AdaptableIcon } from '../AdaptableState/Common/AdaptableIcon';
+import { ButtonStyle } from '../AdaptableState/Common/ButtonStyle';
 import { RowScope } from '../types';
 /**
  * Options for configuring FDC3 in AdapTable

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,9 +1,9 @@
-import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
+import { FilterActionOnDataChange } from '../AdaptableState/Common/FilterActionOnDataChange';
 import { BaseContext } from '../../types';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { SystemAlertPredicateId, SystemFilterPredicateId } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
-import { AdaptableColumnContext } from '../PredefinedConfig/Common/AdaptableColumnContext';
+import { AdaptableColumnContext } from '../AdaptableState/Common/AdaptableColumnContext';
 import { IRowNode } from 'ag-grid-enterprise';
 /**
  * Options for managing Column & Grid Filters in AdapTable

package/src/AdaptableOptions/FlashingCellOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+import { AdaptableStyle } from '../AdaptableState/Common/AdaptableStyle';
 /**
  * Properties for Flashing Cell
  */

package/src/AdaptableOptions/FormatColumnOptions.d.ts

@@ -1,5 +1,5 @@
-import { ColumnScope } from '../PredefinedConfig/Common/ColumnScope';
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
+import { ColumnScope } from '../AdaptableState/Common/ColumnScope';
+import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { BaseContext } from '../../types';
 import { IRowNode } from 'ag-grid-enterprise';
 /**

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -1,14 +1,14 @@
-import { AlertDefinition } from '../PredefinedConfig/AlertState';
-import { CustomSort } from '../PredefinedConfig/CustomSortState';
-import { FlashingCellDefinition } from '../PredefinedConfig/FlashingCellState';
-import { FormatColumn } from '../PredefinedConfig/FormatColumnState';
-import { PlusMinusNudge } from '../PredefinedConfig/PlusMinusState';
-import { Shortcut } from '../PredefinedConfig/ShortcutState';
-import { StyledColumn } from '../PredefinedConfig/StyledColumnState';
-import { BaseSchedule } from '../PredefinedConfig/Common/Schedule';
-import { Layout } from '../PredefinedConfig/LayoutState';
-import { AdaptableModule } from '../PredefinedConfig/Common/Types';
-import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
+import { AlertDefinition } from '../AdaptableState/AlertState';
+import { CustomSort } from '../AdaptableState/CustomSortState';
+import { FlashingCellDefinition } from '../AdaptableState/FlashingCellState';
+import { FormatColumn } from '../AdaptableState/FormatColumnState';
+import { PlusMinusNudge } from '../AdaptableState/PlusMinusState';
+import { Shortcut } from '../AdaptableState/ShortcutState';
+import { StyledColumn } from '../AdaptableState/StyledColumnState';
+import { BaseSchedule } from '../AdaptableState/Common/Schedule';
+import { Layout } from '../AdaptableState/LayoutState';
+import { AdaptableModule } from '../AdaptableState/Common/Types';
+import { AdaptableObjectTag } from '../AdaptableState/Common/AdaptableObject';
 import { BaseContext } from '../../types';
 /**
  * Options for configuring Layouts; these manage Column visibility, order, sorting, grouping, width etc.

package/src/AdaptableOptions/OpenFinPluginOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableAlert } from '../PredefinedConfig/Common/AdaptableAlert';
+import { AdaptableAlert } from '../AdaptableState/Common/AdaptableAlert';
 /**
  * Options required for when using the OpenFin plugin
  */

package/src/AdaptableOptions/SettingsPanelOptions.d.ts

@@ -1,5 +1,5 @@
 import { AdaptableFrameworkComponent, AdaptableIcon } from '../../types';
-import { AdaptableSettingsPanel } from '../PredefinedConfig/Common/Types';
+import { AdaptableSettingsPanel } from '../AdaptableState/Common/Types';
 import { CustomRenderContext } from '../agGrid/AdaptableFrameworkComponent';
 /**
  * Options for managing the AdapTable Settings Panel

package/src/AdaptableOptions/StateOptions.d.ts

@@ -1,4 +1,4 @@
-import { AdaptableState } from '../PredefinedConfig/AdaptableState';
+import { AdaptableState } from '../AdaptableState/AdaptableState';
 /**
  * Options related to Adaptable State hydration / dehydration; allows users to intercept state persistence and loading with custom functionality
  */
@@ -72,7 +72,7 @@ export interface AdaptablePersistStateFunction {
 }
 /**
  * Allows clearing state when a custom persistState is used.
- * Only called by configApi.reloadPredefinedConfig
+ * Only called by configApi.reloadInitialState
  */
 export interface AdaptableClearStateFunction {
     (adaptableStateFunctionConfig: AdaptableStateFunctionConfig): Promise<any>;

package/src/AdaptableOptions/TeamSharingOptions.d.ts

@@ -1,5 +1,5 @@
-import { CustomSharedEntity, SharedEntity } from '../PredefinedConfig/TeamSharingState';
-import { BaseContext } from '../PredefinedConfig/Common/BaseContext';
+import { CustomSharedEntity, SharedEntity } from '../AdaptableState/TeamSharingState';
+import { BaseContext } from '../AdaptableState/Common/BaseContext';
 /**
  * Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues
  */

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -1,7 +1,7 @@
-import { AdaptableObject } from '../PredefinedConfig/Common/AdaptableObject';
+import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
-import { AdaptableButton } from '../PredefinedConfig/Common/AdaptableButton';
-import { ToolPanelState } from '../PredefinedConfig/ToolPanelState';
+import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
+import { ToolPanelState } from '../AdaptableState/ToolPanelState';
 import { BaseContext, CustomRenderContext } from '../types';
 /**
  * Options related to managing the AdapTable ToolPanel Component

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -1,7 +1,7 @@
-import { AdaptableIcon } from '../PredefinedConfig/Common/AdaptableIcon';
+import { AdaptableIcon } from '../AdaptableState/Common/AdaptableIcon';
 import { DateInputOptions } from './DateInputOptions';
-import { AdaptableObjectTag } from '../PredefinedConfig/Common/AdaptableObject';
-import { AdaptableStyle } from '../PredefinedConfig/Common/AdaptableStyle';
+import { AdaptableObjectTag } from '../AdaptableState/Common/AdaptableObject';
+import { AdaptableStyle } from '../AdaptableState/Common/AdaptableStyle';
 import { AlternativeModuleName, BaseContext } from '../../types';
 /**
  * Options for managing the User Interface of AdapTable

package/src/{PredefinedConfig → AdaptableState}/AlertState.d.ts

@@ -12,7 +12,7 @@ import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObserv
 import { ButtonStyle } from './Common/ButtonStyle';
 import { AlertFormContext, BaseContext, NotificationsOptions } from '../types';
 /**
- * Predefined Configuration for Alert Module
+ * Adaptable State section for Alert Module
  */
 export interface AlertState extends ConfigState {
     /**

package/src/{PredefinedConfig → AdaptableState}/ApplicationState.d.ts

@@ -1,6 +1,6 @@
 import { ConfigState } from './ConfigState';
 /**
- * Predefined Configuration for the Application Module
+ * Adaptable State Section for the Application Module
  **/
 export interface ApplicationState extends ConfigState {
     /**

package/src/{PredefinedConfig → AdaptableState}/CalculatedColumnState.d.ts

@@ -4,7 +4,7 @@ import { AdaptableAggregatedScalarQuery, AdaptableScalarQuery } from './Common/A
 import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 /**
- * Predefined Configuration for Calculated Column Module
+ * Adaptable State Section for Calculated Column Module
  **/
 export interface CalculatedColumnState extends ConfigState {
     /**

package/src/{PredefinedConfig → AdaptableState}/Common/AdaptableObject.d.ts

@@ -10,7 +10,7 @@ export interface AdaptableObject {
      */
     Uuid?: TypeUuid;
     /**
-     * Source of state object: 'Config' if provided via `AdaptableOptions.predefinedConfig`, 'User' or undefined for runtime state.
+     * Source of state object: 'Config' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state.
      */
     Source?: 'Config' | 'User';
     AdaptableVersion?: AdaptableVersion;

package/src/{PredefinedConfig → AdaptableState}/Common/AdaptablePredicate.js

@@ -25,8 +25,8 @@ export const SystemPredicateDefs = [
         columnScope: { DataTypes: ['text', 'number', 'date'] },
         moduleScope: ['columnFilter', 'flashingcell', 'formatColumn', 'alert', 'badgeStyle'],
         handler: (context) => {
-            const { inputs, column, value, adaptableApi } = context;
-            const predicateInputs = context.inputs.reduce((acc, input) => {
+            const { inputs = [], column, value, adaptableApi } = context;
+            const predicateInputs = (context.inputs || []).reduce((acc, input) => {
                 const predicate = adaptableApi.predicateApi.getPredicateDefById(input);
                 if (predicate) {
                     acc.push(predicate);

package/src/{PredefinedConfig → AdaptableState}/Common/Types.d.ts

@@ -32,7 +32,7 @@ export type AdaptableModuleButton = 'Alert' | 'BulkUpdate' | 'CalculatedColumn'
 export type AdaptableStateKeys = AdaptableStateKey[];
 export type AdaptableStateKey = keyof AdaptablePersistentState | 'OpenFin' | 'IPushPull';
 /**
- * Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config
+ * Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State
  */
 export type AdaptableModule = 'Alert' | 'BulkUpdate' | 'CalculatedColumn' | 'CellSummary' | 'Charting' | 'Comment' | 'CustomSort' | 'Dashboard' | 'DataChangeHistory' | 'DataSet' | 'Export' | 'Fdc3' | 'ColumnFilter' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'GridInfo' | 'ColumnInfo' | 'IPushPull' | 'Layout' | 'OpenFin' | 'PlusMinus' | 'QuickSearch' | 'Schedule' | 'SettingsPanel' | 'Shortcut' | 'SmartEdit' | 'StyledColumn' | 'StateManagement' | 'StatusBar' | 'SystemStatus' | 'TeamSharing' | 'Theme' | 'ToolPanel' | 'Note' | 'DataImport' | 'GridFilter' | 'NamedQuery';
 export declare const ALL_MODULES: AdaptableModule[];

package/src/{PredefinedConfig → AdaptableState}/ConfigState.d.ts

@@ -3,7 +3,7 @@
  */
 export interface ConfigState {
     /**
-     * Version number of the Item - allows developers to update one section in Predefined Config while keeping others unchanged
+     * Version number of the Item - allows developers to update one section in Initial Adaptable State while keeping others unchanged
      */
     Revision?: number | {
         Key: number;

package/src/{PredefinedConfig → AdaptableState}/CustomSortState.d.ts

@@ -1,7 +1,7 @@
 import { ConfigState } from './ConfigState';
 import { SuspendableObject } from './Common/SuspendableObject';
 /**
- * Predefined Configuration for Custom Sort Module
+ * Adaptable State Section for Custom Sort Module
  */
 export interface CustomSortState extends ConfigState {
     /**