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

package/src/Api/{ConfigApi.d.ts → StateApi.d.ts}

@@ -8,7 +8,7 @@ import { DashboardState } from '../AdaptableState/DashboardState';
 import { CustomSortState } from '../AdaptableState/CustomSortState';
 import { CalculatedColumnState } from '../AdaptableState/CalculatedColumnState';
 import { AlertState } from '../AdaptableState/AlertState';
-import { ConfigState } from '../AdaptableState/ConfigState';
+import { BaseState } from '../AdaptableState/BaseState';
 import { PlusMinusState } from '../AdaptableState/PlusMinusState';
 import { ApplicationState } from '../AdaptableState/ApplicationState';
 import { AdaptablePersistentState, AdaptableState } from '../AdaptableState/AdaptableState';
@@ -19,7 +19,7 @@ import { AdaptableSearchState, AdaptableSortState, ChartingState, FlashingCellSt
 /**
  * Range of functions to access Initial and Full Adaptable State
  */
-export interface ConfigApi {
+export interface StateApi {
     /**
      * Changes the key used for persisting the AdaptableState into localStorage. Optionally provides a initialState to load.
      * @param adaptableStateKey - key for persisting the AdaptableState into localStorage
@@ -62,7 +62,7 @@ export interface ConfigApi {
      * Loads supplied user state, replacing (NOT merging) existing User(persisted) State.
      * @param state
      */
-    loadUserState(config: InitialState): void;
+    loadUserState(state: InitialState): void;
     /**
      * Retrieves ALL state which is currently stored by Adaptable (both persistent and transient/internal)
      */
@@ -94,7 +94,7 @@ export interface ConfigApi {
      * @param stateKey section of State to return
      * @param returnJson whether to return section as JSON or object
      */
-    getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): ConfigState | string;
+    getUserStateByStateKey(stateKey: AdaptableStateKey, returnJson?: boolean): BaseState | string;
     /**
      * Adds '1' to current revision number of State element
      * @param stateKey Adaptable State Key to update

package/src/Redux/Store/AdaptableReduxMerger.d.ts

@@ -1,4 +1,4 @@
-import { ConfigState } from '../../AdaptableState/ConfigState';
+import { BaseState } from '../../AdaptableState/BaseState';
 import { AdaptableState } from '../../AdaptableState/AdaptableState';
 export declare function AddStateSource(stateObject: any, source: 'Config' | 'User'): any;
 export declare function ProcessKeepUserDefinedRevision(configState: any, currentUserState: any): any;
@@ -7,7 +7,7 @@ export declare function MergeState(oldState: any, newState: any): any;
 type TypeReducer = (state: AdaptableState, action: {
     type: string;
     State?: {
-        [s: string]: ConfigState;
+        [s: string]: BaseState;
     };
 }) => AdaptableState;
 export declare const mergeReducer: (rootReducer: TypeReducer, LOAD_STATE_TYPE: string) => TypeReducer;

package/src/Redux/Store/AdaptableStore.d.ts

@@ -1,7 +1,7 @@
 import * as Redux from 'redux';
 import { IAdaptable } from '../../AdaptableInterfaces/IAdaptable';
 import { AdaptableState } from '../../AdaptableState/AdaptableState';
-import { ConfigState } from '../../AdaptableState/ConfigState';
+import { BaseState } from '../../AdaptableState/BaseState';
 import { IAdaptableStore, LoadStoreConfig } from './Interface/IAdaptableStore';
 type EmitterCallback = (data?: any) => any;
 type EmitterAnyCallback = (eventName: string, data?: any) => any;
@@ -13,12 +13,12 @@ export interface InitStateAction extends Redux.Action {
 }
 export interface LoadStateAction extends Redux.Action {
     State: {
-        [s: string]: ConfigState;
+        [s: string]: BaseState;
     };
 }
 export declare const InitState: () => ResetUserDataAction;
 export declare const LoadState: (State: {
-    [s: string]: ConfigState;
+    [s: string]: BaseState;
 }) => LoadStateAction;
 export declare class AdaptableStore implements IAdaptableStore {
     TheStore: Redux.Store<AdaptableState, Redux.Action>;

package/src/Strategy/AdaptableModuleBase.js

@@ -17,7 +17,7 @@ export class AdaptableModuleBase {
         this.api = api;
         this.api.eventApi.on('AdaptableReady', () => {
             this.onAdaptableReady();
-            this.api.configApi.dispatchStateReadyAction(this.moduleInfo.ModuleName);
+            this.api.stateApi.dispatchStateReadyAction(this.moduleInfo.ModuleName);
         });
         this.api.eventApi.on('AdaptableStateReloaded', (adaptableStateReloadedInfo) => {
             this.onAdaptableStateReloaded(adaptableStateReloadedInfo);
@@ -67,8 +67,7 @@ export class AdaptableModuleBase {
         // override where necessary in base classes
     }
     setModuleEntitlement() {
-        this.AccessLevel = this.api.entitlementApi
-            .getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
+        this.AccessLevel = this.api.entitlementApi.getEntitlementAccessLevelForModule(this.moduleInfo.ModuleName);
     }
     createModuleMenuItem(source) {
         if (this.isModuleAvailable() && this.moduleInfo.Popup) {

package/src/View/StateManagement/StateManagementPopup.js

@@ -11,11 +11,11 @@ export const StateManagementPopup = (props) => {
         React.createElement(Panel, { className: `${baseClassName}__panel`, "data-name": "user-state", header: 'User State', style: { height: 'auto' }, variant: "default", borderRadius: "none", marginRight: 2, mb: 2 },
             React.createElement(HelpBlock, { marginBottom: 2 }, 'Clear all current user state that has been persisted'),
             React.createElement(HelpBlock, { style: { color: 'var(--ab-color-warn)' } }, 'This will cause this window to close and any State you have previously created will be lost, and the Initial Adaptable State will be reapplied'),
-            React.createElement(ClearButton, { "data-name": "clear-user-state-button", tone: "info", variant: "raised", marginTop: 2, accessLevel: props.accessLevel, onClick: () => props.api.configApi.reloadInitialState() }, "Clear User State")),
+            React.createElement(ClearButton, { "data-name": "clear-user-state-button", tone: "info", variant: "raised", marginTop: 2, accessLevel: props.accessLevel, onClick: () => props.api.stateApi.reloadInitialState() }, "Clear User State")),
         React.createElement(Panel, { className: `${baseClassName}__panel`, "data-name": "predefined-config", header: 'Initial Adaptable State', style: { height: 'auto' }, variant: "default", borderRadius: "none", marginTop: 3, marginRight: 2, mb: 2 },
             React.createElement(HelpBlock, { marginTop: 2 }, 'Load Initial Adaptable State (from a .json file) - this will cause this window to close'),
             ' ',
-            React.createElement(LoadButton, { tone: "info", variant: "raised", marginTop: 2, accessLevel: props.accessLevel, onLoad: (json) => props.api.configApi.reloadInitialState(json), "data-name": "load-predefined-config-button" }, "Load Initial Adaptable State")),
+            React.createElement(LoadButton, { tone: "info", variant: "raised", marginTop: 2, accessLevel: props.accessLevel, onLoad: (json) => props.api.stateApi.reloadInitialState(json), "data-name": "load-predefined-config-button" }, "Load Initial Adaptable State")),
         React.createElement(Panel, { className: `${baseClassName}__panel`, "data-name": "adaptable-state", header: 'Export Adaptable State', style: { height: 'auto' }, variant: "default", borderRadius: "none", marginTop: 3, marginRight: 2, mb: 2 },
             React.createElement(HelpBlock, { marginTop: 2, marginBottom: 2 }, 'Exports the currently persisted Adaptable State'),
             ' ',

package/src/View/StateManagement/StateManagementViewPanel.js

@@ -10,8 +10,8 @@ export const StateManagementViewPanel = (props) => {
     const elementType = isToolbar ? 'DashboardToolbar' : 'ToolPanel';
     return (React.createElement(Flex, { flexDirection: isToolbar ? 'row' : 'column', className: join(props.accessLevel == 'ReadOnly' ? GeneralConstants.READ_ONLY_STYLE : '', `ab-${elementType}__StateManagement__wrap`) },
         React.createElement(Flex, { flexDirection: "row" },
-            React.createElement(LoadButton, { tooltip: "Load Initial Adaptable State", variant: "text", icon: "upload", onLoad: (json) => props.api.configApi.reloadInitialState(json), accessLevel: props.accessLevel }, !isToolbar && 'Load'),
-            React.createElement(ClearButton, { icon: "delete", tooltip: "Clear User State", variant: "text", onClick: () => props.api.configApi.reloadInitialState(), accessLevel: props.accessLevel }, !isToolbar && 'Clear')),
+            React.createElement(LoadButton, { tooltip: "Load Initial Adaptable State", variant: "text", icon: "upload", onLoad: (json) => props.api.stateApi.reloadInitialState(json), accessLevel: props.accessLevel }, !isToolbar && 'Load'),
+            React.createElement(ClearButton, { icon: "delete", tooltip: "Clear User State", variant: "text", onClick: () => props.api.stateApi.reloadInitialState(), accessLevel: props.accessLevel }, !isToolbar && 'Clear')),
         React.createElement(ExportDropdown, { api: props.api, type: "adaptableState" }, "All State"),
         React.createElement(ExportDropdown, { api: props.api, type: "initialState" }, "Initial Adaptable State")));
 };

package/src/View/StateManagement/components/ExportDropdown.js

@@ -5,11 +5,11 @@ export const ExportDropdown = (props) => {
     const handleChange = (destination) => {
         switch (props.type) {
             case 'adaptableState':
-                const adaptableState = props.api.configApi.getPersistedState();
+                const adaptableState = props.api.stateApi.getPersistedState();
                 handleExportState(destination, 'adaptableState', adaptableState);
                 break;
             case 'initialState':
-                const initialState = props.api.configApi.getInitialState();
+                const initialState = props.api.stateApi.getInitialState();
                 handleExportState(destination, 'initialState', initialState);
                 break;
         }

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: 1742557782744 || Date.now(),
-    VERSION: "20.0.0-canary.23" || '--current-version--',
+    PUBLISH_TIMESTAMP: 1742562389225 || Date.now(),
+    VERSION: "20.0.0-canary.24" || '--current-version--',
 };

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

@@ -1525,6 +1525,17 @@ export declare const ADAPTABLE_METAMODEL: {
             isOpt?: undefined;
         })[];
     };
+    BaseState: {
+        name: string;
+        kind: string;
+        desc: string;
+        props: {
+            name: string;
+            kind: string;
+            desc: string;
+            isOpt: boolean;
+        }[];
+    };
     BroadcastConfig: {
         name: string;
         kind: string;
@@ -2106,17 +2117,6 @@ export declare const ADAPTABLE_METAMODEL: {
             ref: string;
         })[];
     };
-    ConfigState: {
-        name: string;
-        kind: string;
-        desc: string;
-        props: {
-            name: string;
-            kind: string;
-            desc: string;
-            isOpt: boolean;
-        }[];
-    };
     ContainerOptions: {
         name: string;
         kind: string;