@adaptabletools/adaptable-cjs 20.0.0-canary.9 → 20.0.1

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

@@ -2,19 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SystemBadgeStylePredicateIds = exports.SystemFlashingCellPredicateIds = exports.SystemFormatColumnPredicateIds = exports.SystemAlertPredicateIds = exports.SystemFilterPredicateIds = exports.SystemPredicateDefs = void 0;
 const tslib_1 = require("tslib");
-const isAfter_1 = tslib_1.__importDefault(require("date-fns/isAfter"));
-const isBefore_1 = tslib_1.__importDefault(require("date-fns/isBefore"));
-const isEqual_1 = tslib_1.__importDefault(require("date-fns/isEqual"));
-const isFuture_1 = tslib_1.__importDefault(require("date-fns/isFuture"));
-const isPast_1 = tslib_1.__importDefault(require("date-fns/isPast"));
-const isSameDay_1 = tslib_1.__importDefault(require("date-fns/isSameDay"));
-const isThisMonth_1 = tslib_1.__importDefault(require("date-fns/isThisMonth"));
-const isThisQuarter_1 = tslib_1.__importDefault(require("date-fns/isThisQuarter"));
-const isThisWeek_1 = tslib_1.__importDefault(require("date-fns/isThisWeek"));
-const isThisYear_1 = tslib_1.__importDefault(require("date-fns/isThisYear"));
-const isToday_1 = tslib_1.__importDefault(require("date-fns/isToday"));
-const isTomorrow_1 = tslib_1.__importDefault(require("date-fns/isTomorrow"));
-const isYesterday_1 = tslib_1.__importDefault(require("date-fns/isYesterday"));
+const date_fns_1 = require("date-fns");
+const date_fns_2 = require("date-fns");
+const date_fns_3 = require("date-fns");
+const date_fns_4 = require("date-fns");
+const date_fns_5 = require("date-fns");
+const date_fns_6 = require("date-fns");
+const date_fns_7 = require("date-fns");
+const date_fns_8 = require("date-fns");
+const date_fns_9 = require("date-fns");
+const date_fns_10 = require("date-fns");
+const date_fns_11 = require("date-fns");
+const date_fns_12 = require("date-fns");
+const date_fns_13 = require("date-fns");
 const StringExtensions_1 = tslib_1.__importDefault(require("../../Utilities/Extensions/StringExtensions"));
 const DateHelper_1 = require("../../Utilities/Helpers/DateHelper");
 const Helper_1 = tslib_1.__importDefault(require("../../Utilities/Helpers/Helper"));
@@ -29,8 +29,8 @@ exports.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);
@@ -56,10 +56,10 @@ exports.SystemPredicateDefs = [
             if (column.dataType === 'date') {
                 return inputs.some((input) => {
                     if (adaptableApi.optionsApi.getPredicateOptions().evaluateValuesPredicateUsingTime) {
-                        return (0, isEqual_1.default)(input, value);
+                        return (0, date_fns_3.isEqual)(input, value);
                     }
                     else {
-                        return (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(input), (0, DateHelper_1.parseDateValue)(value));
+                        return (0, date_fns_6.isSameDay)((0, DateHelper_1.parseDateValue)(input), (0, DateHelper_1.parseDateValue)(value));
                     }
                 });
             }
@@ -116,12 +116,12 @@ exports.SystemPredicateDefs = [
             if (column.dataType === 'date') {
                 if (adaptableApi.optionsApi.getPredicateOptions().evaluateValuesPredicateUsingTime) {
                     return inputs.every((input) => {
-                        return !(0, isEqual_1.default)(input, value);
+                        return !(0, date_fns_3.isEqual)(input, value);
                     });
                 }
                 else {
                     return inputs.every((input) => {
-                        return !(0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(input), (0, DateHelper_1.parseDateValue)(value));
+                        return !(0, date_fns_6.isSameDay)((0, DateHelper_1.parseDateValue)(input), (0, DateHelper_1.parseDateValue)(value));
                     });
                 }
             }
@@ -398,7 +398,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isToday_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_11.isToday)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'Yesterday',
@@ -406,7 +406,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isYesterday_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_13.isYesterday)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'Tomorrow',
@@ -414,7 +414,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isTomorrow_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_12.isTomorrow)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'ThisWeek',
@@ -422,7 +422,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isThisWeek_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_9.isThisWeek)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'ThisMonth',
@@ -430,7 +430,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isThisMonth_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_7.isThisMonth)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'ThisQuarter',
@@ -438,7 +438,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isThisQuarter_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_8.isThisQuarter)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'ThisYear',
@@ -446,7 +446,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isThisYear_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_10.isThisYear)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'InPast',
@@ -454,7 +454,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isPast_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_5.isPast)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'InFuture',
@@ -462,7 +462,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value }) => (0, isFuture_1.default)((0, DateHelper_1.parseDateValue)(value)),
+        handler: ({ value }) => (0, date_fns_4.isFuture)((0, DateHelper_1.parseDateValue)(value)),
     },
     {
         id: 'After',
@@ -471,7 +471,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => (0, isAfter_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
+        handler: ({ value, inputs }) => (0, date_fns_1.isAfter)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `> ${inputs[0] ?? ''}`,
     },
     {
@@ -481,7 +481,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => (0, isBefore_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
+        handler: ({ value, inputs }) => (0, date_fns_2.isBefore)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `< ${inputs[0] ?? ''}`,
     },
     {
@@ -491,7 +491,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
+        handler: ({ value, inputs }) => (0, date_fns_6.isSameDay)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `= ${inputs[0] ?? ''}`,
     },
     {
@@ -501,7 +501,7 @@ exports.SystemPredicateDefs = [
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
         inputs: [{ type: 'date' }],
-        handler: ({ value, inputs }) => !(0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
+        handler: ({ value, inputs }) => !(0, date_fns_6.isSameDay)((0, DateHelper_1.parseDateValue)(value), (0, DateHelper_1.parseDateValue)(inputs[0])),
         toString: ({ inputs }) => `!= ${inputs[0] ?? ''}`,
     },
     {
@@ -510,7 +510,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value, adaptableApi }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), adaptableApi.calendarApi.getNextWorkingDay()),
+        handler: ({ value, adaptableApi }) => (0, date_fns_6.isSameDay)((0, DateHelper_1.parseDateValue)(value), adaptableApi.calendarApi.getNextWorkingDay()),
     },
     {
         id: 'LastWorkDay',
@@ -518,7 +518,7 @@ exports.SystemPredicateDefs = [
         icon: { name: 'calendar' },
         columnScope: { DataTypes: ['date'] },
         moduleScope: ['columnFilter', 'alert', 'flashingcell', 'formatColumn'],
-        handler: ({ value, adaptableApi }) => (0, isSameDay_1.default)((0, DateHelper_1.parseDateValue)(value), adaptableApi.calendarApi.getPreviousWorkingDay()),
+        handler: ({ value, adaptableApi }) => (0, date_fns_6.isSameDay)((0, DateHelper_1.parseDateValue)(value), adaptableApi.calendarApi.getPreviousWorkingDay()),
     },
     {
         id: 'WorkDay',

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

@@ -2,10 +2,16 @@
  * Defines which Columns in a Layout display Aggregated values when Row-Grouped
  */
 export type AggregationColumnValue = string | true | WeightedAverageAggregation;
+/**
+ * Defines an Aggregated Column in a Table Layout
+ */
 export type TableAggregationColumns = {
     ColumnId: string;
     AggFunc: AggregationColumnValue;
 }[];
+/**
+ * Defines an Aggregated Column in a Pivot Layout
+ */
 export type PivotAggregationColumns = TableAggregationColumns;
 export declare const WEIGHTED_AVERAGE_AGG_FN_NAME = "weightedAvg";
 /**

package/src/{PredefinedConfig → AdaptableState}/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 → AdaptableState}/Common/Menu.d.ts

@@ -178,5 +178,11 @@ export interface AgGridMenuItem<MENU_TYPE> {
      */
     name: MENU_TYPE;
 }
+/**
+ * Defines the Category of for a Menu Item
+ */
 export type MenuCategory = AdaptableModule | 'General' | 'CustomSettingsPanel' | 'Group';
+/**
+ * A separator to add to Column or Context Menu
+ */
 export type MenuSeparator = '-';

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}/CustomSortState.d.ts

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

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

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableDashboardToolbars, AdaptableModuleButtons } from './Common/Types';
 import { AdaptableObject } from './Common/AdaptableObject';
 /**
- * Predefined Configuration for the AdapTable Dashboard
+ * Adaptable State Section for the AdapTable Dashboard
  */
-export interface DashboardState extends ConfigState {
+export interface DashboardState extends BaseState {
     /**
      * Named group of Toolbars
      * @defaultValue Empty Array

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

@@ -1,4 +1,4 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { BaseSchedule } from './Common/Schedule';
 import { ColumnScope } from './Common/ColumnScope';
 import { AdaptableColumnBase } from './Common/AdaptableColumn';
@@ -7,9 +7,9 @@ import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
 import { ExportDestinationType } from '../AdaptableOptions/ExportOptions';
 /**
- * Predefined Configuration for Export Module
+ * Adaptable State Section for Export Module
  */
-export interface ExportState extends ConfigState {
+export interface ExportState extends BaseState {
     /**
      * Selected Report Type - in Export Toolbar & Tool Panel
      */
@@ -65,6 +65,9 @@ export interface ReportSchedule extends BaseSchedule {
      */
     ExportDestination?: ExportDestinationType;
 }
+/**
+ * A Column exported in a Report
+ */
 export interface ReportColumn extends AdaptableColumnBase {
     /**
      * Field in the row to get cell data from; defaults to `columnId`
@@ -140,5 +143,11 @@ export type ReportRowScope = 'AllRows' | 'VisibleRows' | 'ExpressionRows' | 'Sel
  * Array containing all System Report names
  */
 export type SystemReportNames = SystemReportName[];
+/**
+ * Type of Report Name
+ */
 export type ReportNameType = TypeHint<string, SystemReportName>;
+/**
+ * Type of Report Format
+ */
 export type ReportFormatType = TypeHint<string, SystemReportFormat>;

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

@@ -1,10 +1,22 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableColumnPredicate, ColumnScope } from '../types';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
 import { SuspendableObject } from '../../types';
+/**
+ * Adaptable State Section for Flashing Cell module
+ */
+export interface FlashingCellState extends BaseState {
+    /**
+     * Flashing Cell Definitions - will flash cells/rows when rule is met
+     */
+    FlashingCellDefinitions?: FlashingCellDefinition[];
+}
+/**
+ * Predicates available when using Flashing Cells
+ */
 export interface FlashingCellDefinitionPredicate extends AdaptableColumnPredicate {
     PredicateId: TypeHint<string, SystemFlashingCellPredicateId>;
 }
@@ -14,15 +26,6 @@ export interface FlashingCellDefinitionPredicate extends AdaptableColumnPredicat
 export type FlashingCellRule = XOR<{
     Predicates: FlashingCellDefinitionPredicate[];
 }, AdaptableBooleanQuery>;
-/**
- * Predefined Configuration for Flashing Cell module
- */
-export interface FlashingCellState extends ConfigState {
-    /**
-     * Flashing Cell Definitions - will colour cells/rows when rule is met
-     */
-    FlashingCellDefinitions?: FlashingCellDefinition[];
-}
 /**
  * What should flash? row, cell or aggregated cell
  */
@@ -32,7 +35,7 @@ export type FlashTargetTypes = 'row' | 'cell' | 'aggFuncCell';
  */
 export interface FlashingCellDefinition extends SuspendableObject {
     /**
-     * Where Flashing Cell can display: Column[s] or DataType[s]
+     * Which Columns, DataTypes or Column Types can Flash
      */
     Scope: ColumnScope;
     /**

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

@@ -1,4 +1,4 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { AdaptableFormat } from './Common/AdaptableFormat';
 import { ColumnScope } from './Common/ColumnScope';
@@ -9,9 +9,9 @@ import { TypeHint } from './Common/Types';
 import { AdaptableBooleanQuery } from '../types';
 import { AdaptableColumnPredicate } from './Common/AdaptablePredicate';
 /**
- * Predefined Configuration for Format Column Module
+ * Adaptable State Section for Format Column Module
  */
-export interface FormatColumnState extends ConfigState {
+export interface FormatColumnState extends BaseState {
     /**
      * Collection of Format Columns
      */

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

@@ -1,10 +1,10 @@
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 import { AdaptableObject } from './Common/AdaptableObject';
 import { SpecialColumnSettings } from './Common/SpecialColumnSettings';
 /**
- * Predefined Configuration for the Free Text Column Module
+ * Adaptable State Section for the Free Text Column Module
  */
-export interface FreeTextColumnState extends ConfigState {
+export interface FreeTextColumnState extends BaseState {
     /**
      * Collection of Free Text Columns
      */

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

@@ -1,10 +1,10 @@
 import { BaseSchedule } from './Common/Schedule';
 import { AdaptableObject } from './Common/AdaptableObject';
-import { ConfigState } from './ConfigState';
+import { BaseState } from './BaseState';
 /**
  * Internal State used by AdapTable for managing the ipushpull plugin
  */
-export interface IPushPullState extends ConfigState {
+export interface IPushPullState extends BaseState {
     IsIPushPullRunning?: boolean;
     IPushPullDomainsPages?: IPushPullDomain[];
     IPushPullLoginErrorMessage?: string;

package/src/AdaptableState/InitialState.d.ts

@@ -0,0 +1,200 @@
+import { ApplicationState } from './ApplicationState';
+import { AlertState } from './AlertState';
+import { CalculatedColumnState } from './CalculatedColumnState';
+import { ChartingState } from './ChartingState';
+import { CustomSortState } from './CustomSortState';
+import { DashboardState } from './DashboardState';
+import { ExportState } from './ExportState';
+import { FlashingCellState } from './FlashingCellState';
+import { FormatColumnState } from './FormatColumnState';
+import { FreeTextColumnState } from './FreeTextColumnState';
+import { LayoutState } from './LayoutState';
+import { NamedQueryState } from './NamedQueryState';
+import { NoteState } from './NoteState';
+import { PlusMinusState } from './PlusMinusState';
+import { QuickSearchState } from './QuickSearchState';
+import { ScheduleState } from './ScheduleState';
+import { ShortcutState } from './ShortcutState';
+import { StatusBarState } from './StatusBarState';
+import { StyledColumnState } from './StyledColumnState';
+import { ThemeState } from './ThemeState';
+import { ToolPanelState } from './ToolPanelState';
+/**
+ * The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout.
+ */
+export interface InitialState {
+    /**
+     * Collection of `AlertDefinitions` which will fire Alerts when the rule is met
+     */
+    Alert?: AlertState;
+    /**
+     * Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
+     */
+    Application?: ApplicationState;
+    /**
+     * Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)
+     */
+    CalculatedColumn?: CalculatedColumnState;
+    /**
+     * Named Charts (wrapping Chart models)
+     */
+    Charting?: ChartingState;
+    /**
+     * Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
+     */
+    CustomSort?: CustomSortState;
+    /**
+     * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
+     */
+    Dashboard?: DashboardState;
+    /**
+     * Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module
+     */
+    Export?: ExportState;
+    /**
+     * Definitions of which cells flash in response to data changes
+     */
+    FlashingCell?: FlashingCellState;
+    /**
+     * Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition
+     */
+    FormatColumn?: FormatColumnState;
+    /**
+     * Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource).  Useful if needing a 'Comments' column.
+     */
+    FreeTextColumn?: FreeTextColumnState;
+    /**
+     * Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
+     */
+    Layout: LayoutState;
+    /**
+     * Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up
+     */
+    NamedQuery?: NamedQueryState;
+    /**
+     * Collection of personal Notes that are edited at Cell level
+     */
+    Note?: NoteState;
+    /**
+     * Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
+     */
+    PlusMinus?: PlusMinusState;
+    /**
+     * Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
+     */
+    QuickSearch?: QuickSearchState;
+    /**
+     * Collection of *Schedule* objects
+     */
+    Schedule?: ScheduleState;
+    /**
+     * Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues
+     */
+    Shortcut?: ShortcutState;
+    /**
+     * Configures the Adaptable Status Bar
+     */
+    StatusBar?: StatusBarState;
+    /**
+     * Collection of Special Column Styles
+     */
+    StyledColumn?: StyledColumnState;
+    /**
+     * Specifies current Theme and lists User and System themes available for selection
+     */
+    Theme?: ThemeState;
+    /**
+     * Sets order & visibility of Tool Panel controls in AdapTable ToolPanel (on right of grid)
+     */
+    ToolPanel?: ToolPanelState;
+}
+/**
+ * Deprecated initial state object (now replaced by InitialState)
+ * @deprecated Use `InitialState` instead - it has the same structure but is more accurately named
+ */
+export interface PredefinedConfig {
+    /**
+     * Collection of `AlertDefinitions` which will fire Alerts when the rule is met
+     */
+    Alert?: AlertState;
+    /**
+     * Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.
+     */
+    Application?: ApplicationState;
+    /**
+     * Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)
+     */
+    CalculatedColumn?: CalculatedColumnState;
+    /**
+     * Named Charts (wrapping Chart models)
+     */
+    Charting?: ChartingState;
+    /**
+     * Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways
+     */
+    CustomSort?: CustomSortState;
+    /**
+     * Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons
+     */
+    Dashboard?: DashboardState;
+    /**
+     * Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module
+     */
+    Export?: ExportState;
+    /***
+     * Objects which define which cells flash in response to data changes
+     */
+    FlashingCell?: FlashingCellState;
+    /**
+     * Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition
+     */
+    FormatColumn?: FormatColumnState;
+    /**
+     * Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource).  Useful if needing a 'Comments' column.
+     */
+    FreeTextColumn?: FreeTextColumnState;
+    /**
+     * Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.
+     */
+    Layout: LayoutState;
+    /**
+     * Named Queries available for use across multiple AdapTable Modules
+     */
+    NamedQuery?: NamedQueryState;
+    /**
+     * Collection of personal Notes that are edited at Cell level
+     */
+    Note?: NoteState;
+    /**
+     * Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell
+     */
+    PlusMinus?: PlusMinusState;
+    /**
+     * Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows
+     */
+    QuickSearch?: QuickSearchState;
+    /**
+     * Collection of *Schedule* objects
+     */
+    Schedule?: ScheduleState;
+    /**
+     * Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues
+     */
+    Shortcut?: ShortcutState;
+    /**
+     * Configures the Adaptable Status Bar
+     */
+    StatusBar?: StatusBarState;
+    /**
+     * Collection of Special Column Styles
+     */
+    StyledColumn?: StyledColumnState;
+    /**
+     * Specifies the current Theme and lists the User and System themes available for selection.
+     */
+    Theme?: ThemeState;
+    /**
+     * Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)
+     */
+    ToolPanel?: ToolPanelState;
+}

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

@@ -24,7 +24,7 @@ export type SystemRowSummary = {
     RowData: Record<string, any>;
 };
 /**
- * Internal state, used by Adaptable during a session; none of it is provided through Predefined Config, nor is it persisted
+ * Internal state, used by Adaptable during a session; none of it is provided through Initial Adaptable State, nor is it persisted
  */
 export interface InternalState extends IPushPullState, OpenFinState {
     Columns: AdaptableColumn[];